Set up the Marketplace solution properties

Level: intermediate

Solution properties are solution details stored within the solution itself regardless of an environment.

The Marketplace solution properties store the following data:

• icon
• icon color
• name
• description
• code

Set up the property values in the Application Hub. Learn more: Manage apps (user documentation).

Creatio lets you add solution properties to a published or new Marketplace solution. Instructions: Set up the app properties (user documentation). You must fill out the parameters when you create a solution, but you can change them at any moment. The code is generated on solution creation and cannot be changed later.

note

Add properties to Marketplace solutions developed for version 8.0.1 and earlier, i.e., solutions without properties.

Make sure the solution properties meet the Requirements for solution properties.

Add properties to a published Marketplace solution

The procedure to add properties to a published Marketplace solution depends on the number of packages that contain the solution functionality.

Add properties to a published Marketplace solution that has a single package

1. Install the Marketplace solution. Instructions: Install an app from a file (user documentation).

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

3. Unlock the Marketplace solution in the Application Hub. To do this, execute the SQL query to the SysInstalledApp database table.

   Microsoft SQL

   UPDATE SysInstalledApp
   SET Maintainer = (SELECT TextValue FROM SysSettings
       JOIN SysSettingsValue ON SysSettingsValue.SysSettingsId = SysSettings.Id
       WHERE Code = 'Maintainer'
       AND SysSettingsValue.SysAdminUnitId = 'A29A3BA5-4B0D-DE11-9A51-005056C00008')
   WHERE name='SomeMarketplaceSolutionName'

   PostgreSQL

   UPDATE "SysInstalledApp"
   SET "Maintainer" = (SELECT "TextValue" FROM "SysSettings"
       JOIN "SysSettingsValue" ON "SysSettingsValue"."SysSettingsId" = "SysSettings"."Id"
       WHERE "Code" = 'Maintainer'
       AND "SysSettingsValue"."SysAdminUnitId" = '{A29A3BA5-4B0D-DE11-9A51-005056C00008}')
   WHERE "Name" = 'SomeMarketplaceSolutionName'

   Oracle

   UPDATE "SysInstalledApp"
   SET "Maintainer" = (SELECT "TextValue" FROM "SysSettings"
       JOIN "SysSettingsValue" ON "SysSettingsValue"."SysSettingsId" = "SysSettings"."Id"
       WHERE "Code" = 'Maintainer'
       AND "SysSettingsValue"."SysAdminUnitId" = 'A29A3BA5-4B0D-DE11-9A51-005056C00008')
   WHERE "Name" = 'SomeMarketplaceSolutionName'

   SomeMarketplaceAppName is the name of the installed package that contains the Marketplace solution functionality.

4. Change the Marketplace solution properties. Instructions: Change the app properties (user documentation).

5. Lock the package that contains the Marketplace solution functionality. To do this, execute the SQL query to the SysInstalledApp database table.

   Microsoft SQL

   UPDATE SysInstalledApp
   SET Maintainer='SomeMarketplaceSolutionMaintainer'
   WHERE Name='SomeMarketplaceSolutionName'

   PostgreSQL

   UPDATE "SysInstalledApp"
   SET "Maintainer" = 'SomeMarketplaceSolutionMaintainer'
   WHERE "Name" = 'SomeMarketplaceSolutionName'

   Oracle

   UPDATE "SysInstalledApp"
   SET "Maintainer" = 'SomeMarketplaceSolutionMaintainer'
   WHERE "Name" = 'SomeMarketplaceSolutionName'

   SomeMarketplaceSolutionMaintainer is the publisher of the package that contains the Marketplace solution functionality.

   SomeMarketplaceSolutionName is the name of the installed package that contains the Marketplace solution functionality.

6. Export the package that contains the Marketplace solution functionality. Instructions: Download an app.

As a result, the properties will be added to a published Marketplace solution that has a single package. While managing the Marketplace listings, the *.zip archive that contains the Marketplace solution must be uploaded to the Creatio Marketplace Console (Packages and updates tab → Application file property). Learn more: Release details tab.

Add properties to a published Marketplace solution that has multiple packages

If you install a Marketplace solution that comprises multiple packages and has no solution properties in Creatio, Creatio generates solution properties automatically and saves it to an arbitrary package. If Marketplace solutions that have different properties use the same base packages, the package installation ends with an error.

Important

Use the target package that contains properties only in one Marketplace solution.

To add properties to a published Marketplace solution that has multiple packages:

1. Choose a unique package to store the Marketplace solution properties. Do not use this package in other Marketplace solutions.

2. Prepare the unique package before installing it into Creatio.

   1. Install the Clio utility (performed once). Instructions: official vendor documentation (GitHub).
   2. Unpack the *.zip archive that contains the Marketplace solution packages.
   3. Run the Extract package Clio command to unpack the unique package. Instructions: official vendor documentation (GitHub).
   4. Download the solution property file and add it to the ...\[Path to package folder]\Files\ directory.
   5. Add the Marketplace solution packages to the Packages file property. You can modify other property values in the Application Hub.
   6. Run the Compress package Clio command to compress the changed unique package into a *.gz package archive. Instructions: official vendor documentation (GitHub).
   7. Compress the changed unique package and other Marketplace solution packages into a *.zip archive.

3. Install the Marketplace solution that contains properties into Creatio. Instructions: Install an app from a file (user documentation).

4. Unlock the packages that contain the Marketplace solution functionality using the Clio utility. Instructions: official vendor documentation (GitHub).

   Important

   If at least one package is locked, an additional package is created automatically when the properties are changed.

5. Unlock the Marketplace solution in the Application Hub. To do this, execute the SQL query to the SysInstalledApp database table.

   Microsoft SQL

   UPDATE SysInstalledApp
   SET Maintainer = (SELECT TextValue FROM SysSettings
       JOIN SysSettingsValue ON SysSettingsValue.SysSettingsId = SysSettings.Id
       WHERE Code = 'Maintainer'
       AND SysSettingsValue.SysAdminUnitId = 'A29A3BA5-4B0D-DE11-9A51-005056C00008')
   WHERE name='SomeMarketplaceSolutionName'

   PostgreSQL

   UPDATE "SysInstalledApp"
   SET "Maintainer" = (SELECT "TextValue" FROM "SysSettings"
       JOIN "SysSettingsValue" ON "SysSettingsValue"."SysSettingsId" = "SysSettings"."Id"
       WHERE "Code" = 'Maintainer'
       AND "SysSettingsValue"."SysAdminUnitId" = '{A29A3BA5-4B0D-DE11-9A51-005056C00008}')
   WHERE "Name" = 'SomeMarketplaceSolutionName'

   Oracle

   UPDATE "SysInstalledApp"
   SET "Maintainer" = (SELECT "TextValue" FROM "SysSettings"
       JOIN "SysSettingsValue" ON "SysSettingsValue"."SysSettingsId" = "SysSettings"."Id"
       WHERE "Code" = 'Maintainer'
       AND "SysSettingsValue"."SysAdminUnitId" = 'A29A3BA5-4B0D-DE11-9A51-005056C00008')
   WHERE "Name" = 'SomeMarketplaceSolutionName'

   SomeMarketplaceSolutionName is the name of the installed package that contains the Marketplace solution functionality.

6. Change the Marketplace solution properties. Instructions: Change the app properties (user documentation).

7. Lock the package that contains the Marketplace solution functionality. To do this, execute the SQL query to the SysInstalledApp database table.

   Microsoft SQL

   UPDATE SysInstalledApp
   SET Maintainer='SomeMarketplaceSolutionMaintainer'
   WHERE Name='SomeMarketplaceSolutionName'

   PostgreSQL

   UPDATE "SysInstalledApp"
   SET "Maintainer" = 'SomeMarketplaceSolutionMaintainer'
   WHERE "Name" = 'SomeMarketplaceSolutionName'

   Oracle

   UPDATE "SysInstalledApp"
   SET "Maintainer" = 'SomeMarketplaceSolutionMaintainer'
   WHERE "Name" = 'SomeMarketplaceSolutionName'

   SomeMarketplaceSolutionMaintainer is the publisher of the package that contains the Marketplace solution functionality.

   SomeMarketplaceSolutionName is the name of the installed package that contains the Marketplace solution functionality.

8. Export the package that contains the Marketplace solution functionality. Instructions: Download an app.

As a result, the properties will be added to a published Marketplace solution that has multiple packages. While managing the Marketplace listings, the *.zip archive that contains the Marketplace solution must be uploaded to the Creatio Marketplace Console (Packages and updates tab → Application file property). Learn more: Release details tab.

Add properties to a new Marketplace solution

The procedure to add properties to a new Marketplace solution depends on the number of packages that contain the solution functionality.

Add properties to a new Marketplace solution that has a single package

Instructions: Set up the app properties (user documentation).

Add properties to a new Marketplace solution that has multiple packages

Creatio lets you set a target package and create properties in it before you start developing a new Marketplace solution that contains multiple packages.

Important

Before you add properties to a new Marketplace solution that contains multiple packages, make sure that the Marketplace solution packages are unlocked and do not contain any Marketplace solution properties in Creatio.

To add properties to a new Marketplace solution that has multiple packages:

1. Choose a unique package to store the Marketplace solution properties. Do not use this package in other Marketplace solutions.

2. Create a lookup based on the Installed application object.

   1. Click New lookup.

   2. Fill out the lookup properties.

      Property	Property value
      Name	Installed application
      Object	Installed application

   3. Save the changes.

3. Add a lookup value.

   1. Open the Installed application lookup.

   2. Click New.

   3. Fill out the properties of the lookup value.

      Property	Property value
      Name	The solution name to display in the Application Hub.
      Code	The solution code.
      Maintainer	The Marketplace solution developer. The value of the property must match the value of the Publisher (Maintainer code) system setting.
      Description	Brief information about the Marketplace solution.
      App icon	The Marketplace solution icon. The property is populated automatically.
      Icon background color	The background of the Marketplace solution icon. The property is populated automatically.

   4. Save the changes.

4. Create a lookup based on the Package in installed application object.

   1. Click New lookup.

   2. Fill out the lookup properties.

      Property	Property value
      Name	Package in installed application
      Object	Package in installed application

   3. Save the changes.

5. Add a lookup value.

   1. Open the Package in installed application lookup.

   2. Click New.

   3. Fill out the properties of the lookup value.

      Property	Property value
      Package	The Marketplace solution package.
      Installed application	The record of installed solution from the previous step.
      Primary	Select the checkbox for the unique Marketplace solution package and clear the checkbox for other Marketplace solution packages.

   4. Save the changes.

6. Change the Marketplace solution properties. Instructions: Change the app properties (user documentation).

7. Export the package that contains the Marketplace solution functionality. Instructions: Download an app.

As a result, the properties will be added to a new Marketplace solution that has multiple packages. While managing the Marketplace listings, the *.zip archive that contains the Marketplace solution must be uploaded to the Creatio Marketplace Console (Packages and updates tab → Application file property). Learn more: Release details tab.

---

See also

Manage apps (user documentation)

Set up the app properties (user documentation)

Requirements for Marketplace solution

Manage Marketplace listings

---

Resources

Official Clio utility documentation (GitHub)

Marketplace updates