Skip to main content

Configure the Marketplace solution for composable architecture compatibility

Level: beginner

As part of transition to new architecture, the package architecture was revamped in Creatio version 8.0.6. During the transition period, existing Creatio instances include both composable and classic package architectures after updating to version 8.0.6 and later. Learn more: Composable package architecture. Existing Marketplace solutions are developed based on classic package architecture. During the transition period, existing Marketplace solutions work as intended. After the transition period, new Creatio instances will only include composable architecture. I. e., installing a Marketplace solution into an updated Creatio instance will not work. Configure the Marketplace solution for composable architecture compatibility to ensure the solution operates as expected after the transition to composable architecture.

We recommend configuring the Marketplace solution for composable architecture compatibility during the transition period if your solution meets the following prerequisites:

  • The solution is a complete and independent product. For example, the solution generates requests without using contacts and accounts.
  • The solution adds new features to Freedom UI Designer or extends existing features. For example, the solution adds a new component to the Freedom UI Designer or improves the UX of the Schema Designers.

If your Marketplace solution is based on Classic UI sections that have no Freedom UI section counterparts yet, we recommend waiting for the release of composable apps that include the required Freedom UI sections. After the release, review the new functionality of the composable app, configure your Marketplace solution for composable architecture compatibility, and publish the new version on Creatio Marketplace.

You can configure the Marketplace solution for composable architecture compatibility in the following ways:

  • using Creatio IDE
  • without using Creatio IDE

Configure the Marketplace solution for composable architecture compatibility using Creatio IDE​

  1. Prepare the solution development environment. You can deploy the solution development website on-site or in the cloud. Instructions: Deploy the Creatio development environment.

  2. Install the Marketplace solution into Creatio.

  3. Unlock the package that contains the Marketplace solution functionality using the Clio utility. Instructions: official vendor documentation (GitHub).

  4. Open the Configuration section. Instructions: Open the Configuration section.

  5. Select the package that contains the Marketplace solution functionality.

  6. Select Properties in the package menu.

  7. Edit the package dependencies.

    1. Open the Dependencies tab.

    2. Add packages of composable architecture to the dependencies.

      1. Go to the Depends on Packages block.
      2. Click + Add.
      3. Select the CrtCore package and add a dependency to the package.
      4. If your solution uses the functionality of composable apps, add the package that implements the required functionality to the dependencies. For example, your Marketplace solution uses the functionality of the Customer360 composable app. In this case, select CrtCustomer360App and/or CrtCustomer360Mobile packages and add dependencies to the Marketplace solution package.

    3. Remove dependencies on packages of classic architecture, for example, Base, Platform, NUI, etc.

      Important

      If errors occur while removing package dependencies, debug the Marketplace solution and identify the schemas where you must remove the dependencies on schemas and packages of classic architecture.

    4. Save the changes.

    For example, view the connection chart among Marketplace solution, composable architecture, and Customer 360 composable app packages in the figure below.

  8. Test the Marketplace solution operability. To do this, verify that the functionality operates as expected using a new or existing Creatio instance. Make sure the solution meets the Requirements for Marketplace solution.

Configure the Marketplace solution for composable architecture compatibility without using Creatio IDE​

  1. Download the package that contains the Marketplace solution functionality.

  2. Unpack the *. zip archive that contains the Marketplace solution packages using the Clio utility. Instructions: official vendor documentation (GitHub).

  3. Edit the package dependencies.

    1. Open the ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\SomePackageName\descriptor.json file.

    2. Add packages to the array property of the DependsOn object.

      1. Add the CrtCore package to the array property of the DependsOn object.
      2. If your solution uses the functionality of composable apps, add the package that implements the required functionality to the array property of the DependsOn object. For example, your Marketplace solution uses the functionality of the Customer360 composable app. In this case, add CrtCustomer360App and/or CrtCustomer360Mobile packages to the array property of the DependsOn object.

    3. Remove dependencies on packages of classic architecture, for example, Base, Platform, NUI, etc.

    4. Save the changes.

    View the example of the descriptor.json file below.

    descriptor.json file
    {
        "Descriptor": {
            ...,
            "DependsOn": [
                {
                    "UId": "012e2e14-082b-ac2b-da5a-2fc87bad41d4",
                    "PackageVersion": "7.8.0",
                    "Name": "CrtCore"
                },
                {
                    "UId": "2ecba2bd-b810-47a5-a1b1-08c888529d6c",
                    "PackageVersion": "7.8.0",
                    "Name": "CrtCustomer360App"
                }
            ]
        }
    }

  4. Test the Marketplace solution operability. To do this, install the solution into a new Creatio instance and verify that the functionality operates as expected. Make sure the solution meets the Requirements for Marketplace solution.

Configure the Marketplace solution for backward compatibility​

Freedom UI shell is turned on for new Creatio instances out of the box. Classic UI sections that have Freedom UI section counterparts are no longer displayed in workplaces but remain available during the transition period.

If your Marketplace solution is based on Classic UI sections that were replaced by Freedom UI sections, configure the solution to ensure it operates as expected.

If your Marketplace solution is based on Classic UI sections that are under transition to Freedom UI, take the following actions:

  1. Add Classic UI sections to the Marketplace solution workplace. Instructions: Set up workplaces (user documentation).
  2. Configure exceptions for Classic UI sections. Instructions: Add exceptions for specific Creatio objects (user documentation).
  3. Bind the UI settings to the package. Instructions: Bind UI settings (user documentation), Bind data to the package.

As a result, users will continue to use your Marketplace solution during the transition period as expected.

See also​

Composable package architecture

Steps to develop the Marketplace solution

Creatio IDE overview

Packages overview

Requirements for Marketplace solution

Set up workplaces (user documentation)

Manage form pages in Freedom UI and Classic UI (user documentation)

Bind UI settings (user documentation)

Bind data to the package

Resources​

Official Clio utility documentation

Marketplace updates