Skip to main content
Version: 8.3All Creatio products

Set up the app properties

Level: beginner

App properties is details stored within the app itself regardless of an environment.

App properties includes the following data:

  • icon
  • icon color
  • name
  • description
  • code
  • app default page
  • version
  • developer
  • required Creatio version
  • dependencies
  • packages

Set up the parameter values in the Application Hub. You can fill out the parameters only when you create an app, but you can change them at any moment.

Important

The code is generated on app creation and cannot be changed later.

Fill out the app properties​

Fill out the corresponding app properties when you create an app. Learn more in a separate article: Create a custom app.

The app name can contain between 3 and 100 characters. You can use any alphanumeric and special characters.

The app code is used as the app ID. Also, the code is used in app schema names.

Creatio generates the code based on the app name. Code generation has the following special features:

  • Use at least one Latin word in the title since the code can contain only digits and Latin characters.
  • To generate the code, at least 3 characters from the app name suitable for code generation are required. If the app name contains multiple spaces, Creatio removes them from the code and formats the code in camelcase. For example, the code of the Financial benefits app is "UsrFinancialBenefits."
  • If the app name contains fewer than 3 characters suitable for code generation, Creatio generates the code in the format of "AppUsr_gfgvd08j."
  • If you change the app name, Creatio updates the code accordingly. You can edit the code manually when you create an app. In this case, Creatio does not update the code on further name changes. After you create an app, it is not possible to change its code.

If the code and unique ID of the app to install matches the code and unique ID of an existing app, Creatio updates the existing app. If the code of the app to install matches the code of an existing app but the unique ID differs, the app installation ends with an error. For example, if you have the Test ("UsrTest" code) app created on your Creatio instance, the Test ("UsrTest" code) app created on another Creatio instance will not be installed to your instance.

Creatio displays the specified parameter values both in the development environment and any other environment where you install the app (Fig. 1).

Fig. 1 Properties of the Financial benefits app
Fig. 1 Properties of the Financial benefits app

Change the app properties​

You can change the app properties only in the development environment. To do this:

  1. Open the Application Hub. To do this, click in the top right → Application Hub.

  2. Open the app. For example, Financial benefits app.

  3. Open the app properties. To do this, click .

  4. Edit the app properties. For example, name and icon color (Fig. 2).

    Fig. 2 Change the properties of the Financial benefits app
    Fig. 2 Change the properties of the Financial benefits app

  5. Save the changes.

As a result, the app will display the changed parameter values in the development environment. The Developer parameter is non-editable. If you need to change it, edit the Maintainer parameter in the app-descriptor.json file of the app.

When you install the app into or update it in any environment, Creatio updates the app properties (Fig. 3).

Fig. 3 Properties of the Payroll app
Fig. 3 Properties of the Payroll app

Change the app start page​

note

This functionality is available for Creatio 8.1.2 and later.

Creatio lets you change the start page to open in a self-developed app when you click the Run app button in the No-Code Designer. You can use a list page or homepage as the start page. You can use schemas only from the current app when configuring the start page.

If you configure the app start page, Creatio opens it when you click the Run app button. Otherwise, Creatio uses the following priority to open pages:

  • homepage
  • section list page
  • Classic UI page or desktop page

To change the app start page:

  1. Open the Application Hub. To do this, Click in the top right → Application Hub.

  2. Open the app. For example, Financial benefits app that includes Financial benefits and Payroll sections.

  3. Open the app properties. To do this, click .

  4. Change the app start page in the App default page field. For example, "Payroll (Freedom UI)" (Fig. 4).

    Fig. 4 Properties of the Financial benefits app
    Fig. 4 Properties of the Financial benefits app

  5. Save the changes.

As a result, when you click the Run app button in the No-Code Designer for the Financial benefits app, Creatio will open the Payroll section list page (Fig. 5).

Fig. 5 Start page of the Financial benefits app
Fig. 5 Start page of the Financial benefits app

Specify the required Creatio version​

You can specify the required Creatio version or version range into which the app can be installed. If the version of the target environment does not match, Creatio will not install the app.

To specify the required Creatio version:

  1. Open the Application Hub. To do this, Click in the top right → Application Hub.
  2. Open the app. For example, Financial benefits app.
  3. Open the app properties. To do this, click .
  4. Go to the Dependences tab.
  5. Fill out the Required Creatio version field. If you specify only one required version, the application can be installed on that version and later versions of Creatio. You can also specify a compatible version range using a hyphen, for example: "8.3.0 - 8.4.3".
    Fig. 6 Specify the required Creatio version
    Fig. 6 Specify the required Creatio version
  6. Save the changes.

As a result, the app will be able to be installed only into Creatio instances that have the same or later version or are within the specified version range.

Set dependencies​

Dependencies are other apps or packages that are not part of the app itself but whose content the app requires. Specify dependencies to add their contents to the app. To do this:

  1. Open the Application Hub. To do this, Click in the top right → Application Hub.
  2. Open the app. For example, Financial benefits app that includes Financial benefits and Payroll sections.
  3. Open the app properties. To do this, click .
  4. Go to the Dependences tab.
  5. Click Add → App or Package. For example, App. This adds a record to dependency list.
  6. Specify the app name in the Name field. For example, Customer 360.
    Fig. 7 Add a dependency
    Fig. 7 Add a dependency
  7. Save the changes.

As a result, you will be able to use the contents of the dependent app in your app. Learn more: Manage app elements in the No-Code Designer.

Creatio checks for dependencies before you install an app from the file into a different Creatio instance, thus ensure the target environment has the dependencies as well if you want to transfer the app. If the environment lacks dependencies, move them there manually before installation.

See also​

Manage apps

Environments (developer documentation)

Store app data