App versioning
Release apps in sequential versions incremented when you develop new functionality or fix bugs to ensure maximum compatibility. We recommend using the following three-digit version structure:
- Patch (X.X.1). Use it for backward-compatible bug fixes. A bug fix is an internal change that corrects incorrect behavior.
- Minor (X.1.X). Use it for introducing new backward-compatible functionality or substantial improvements. Patch-level changes can also be included.
- Major (1.X.X). Use it for any backward-incompatible changes applied. Minor and patch-level changes can also be included.
You can also specify the Creatio versions with which the app version is compatible. Learn more: Set up the app properties. Creatio checks for app compatibility as part of the installation flow and blocks the installation if the app is considered incompatible. Learn more: Ensure app compatibility. Make sure to specify the correct compatible Creatio version as part of development. Creatio also compares the app version to install with the installed version. If a newer version of the app is already installed, Creatio displays a warning or skips the app, except for apps whose version is the technical "0.0.0" version. Learn more: Install an app from a file.
We recommend versioning apps only on a development environment. New apps start from version 1.0.0.
Before you update an app, make sure you are set as the publisher of the app and the app package is unlocked. If it is locked, turn on the "Allow to edit your own apps from an archive" (CanEditOwnAppsFromArchive code) system setting. Learn more: Manage system settings.
To set an app version:
- Click
to open the System Designer. - Go to the Application management block → Application Hub section.
- Open the relevant app.
- Open the app properties. To do this, click
. - Go to the Version tab.
- Set the new app version in the Version field, for example, "1.1.0." Use numbers in the X.Y.Z or X.Y format, up to 4 digits each. You cannot save the app properties if the version does not match the format.
- Update the app and save the changes.
As a result, the app will be updated and the new version will be set. You will be able to transfer the new version between environments. If an environment already has an older app version, install the new version over it. Creatio updates the installed app. Learn more: Ensure app compatibility.
Ensure app compatibility
Creatio checks app compatibility when you install an app from Marketplace or from a file, including a file that contains several apps. Creatio checks the following:
- Compatibility with the Creatio version. The Creatio version of the environment must meet the Required Creatio version app property. If the property contains a single version, for example, "8.3.0," the app is compatible with this and later Creatio versions. If the property contains a version range, for example, "8.3.0 - 8.4.3," the app is compatible only with Creatio versions within the range. Learn more: Set up the app properties.
- Compatibility with dependencies. The environment or the installation file must contain all apps and packages the app depends on, in the versions the app requires. The required version of a dependent app is either a single version, which means this and later versions, or a version range. Learn more: Set up the app properties.
- Compatibility with installed apps. When you update or downgrade an installed app, the version to install must meet the required version that other installed apps specify for this app in their dependencies. For example, the installed App 2 app requires App 1 version 3.0.0 or later. In this case, you cannot install App 1 version 2.0.0.
If the app is incompatible, Creatio blocks the installation and displays the reason in the installation window.
Window message | Reason | What to do |
|---|---|---|
Incompatible platform version | The Creatio version of the environment does not meet the required Creatio version of the app. | Update Creatio to the version the message lists. If you use Creatio in the cloud, contact Creatio support. If the app works on your Creatio version, contact the app developer to correct the required Creatio version. |
Conflicting Creatio versions | Apps in the installation file require conflicting Creatio versions. | Contact the developer of the conflicting apps. |
Conflicting platform requirements | Dependencies that Creatio must install together with the app require Creatio versions that cannot be used together in the same environment. | Review the list of conflicting apps in the window or contact the app developer. |
Can't retrieve required dependencies | The environment lacks dependencies, and Creatio cannot install them automatically. | Install the apps or packages that the message lists, then install the app again. |
Conflicting application versions | Apps in the installation file conflict with each other, for example, they require incompatible versions of the same dependent app. | Update the conflicting apps in the installation file or contact the app developer. |
Installed application dependency conflict | The app version to install does not meet the required version that installed apps specify for it. The message lists the installed apps and the versions they require. | Install a version of the app that meets the required versions. |
See also
Overview of Freedom UI Designer and its elements
Development for Creatio Marketplace (developer documentation)