Configure the Marketplace app for composable architecture compatibility

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 in a separate article: Transition to composable architecture. Existing Marketplace apps are developed based on classic package architecture. During the transition period, existing Marketplace apps work as intended. After the transition period, new Creatio instances will only include composable architecture. I. e., installing a Marketplace app into an updated Creatio instance will not work. Configure the Marketplace app for composable architecture compatibility to ensure the app operates as expected after the transition to composable architecture.

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

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

If your Marketplace app 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 app for composable architecture compatibility, and publish the new version on Creatio Marketplace.

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

• using Creatio IDE
• without using Creatio IDE

Configure the Marketplace app for composable architecture compatibility using Creatio IDE 

1. Prepare the app development environment version 8.0.6 or later. You can deploy the app development website on-site or in the cloud. To do this, follow the instructions in a separate article: Steps to develop the Marketplace app.
2. Install the Marketplace app into Creatio.
3. Unlock the package that contains the Marketplace app functionality using the Clio utility. To do this, follow the instructions in the utility documentation on GitHub.
4. Open the Configuration section and select the package that contains the Marketplace app functionality.

5. Select Properties in the package menu.

   

6. Edit the package dependencies.

   1. Open the Dependencies tab.

   2. Add packages of composable architecture to the dependencies.

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

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

      Attention. If errors occur while removing package dependencies, debug the Marketplace app 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 app, composable architecture, and Customer 360 composable app packages in the figure below.

   
7. Test the Marketplace app operability. To do this, verify that the functionality operates as expected using a new or existing Creatio instance version 8.0.6 or later. Make sure the app meets the requirements listed in a separate article: Requirements for Marketplace app.

Configure the Marketplace app for composable architecture compatibility without using Creatio IDE 

1. Download the package that contains the Marketplace app functionality.
2. Unpack the *. zip archive that contains the Marketplace app packages using the Clio utility. To do this, follow the instructions in the utility documentation on 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 app 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 app 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 app operability. To do this, install the app into a new Creatio instance version 8.0.6 or later and verify that the functionality operates as expected. Make sure the app meets the requirements listed in a separate article: Requirements for Marketplace app.