Docs menu
MENU

Marketplace

Marketplace section is used for managing applications available for one-click installation via the Marketplace and Add-Ons dashboard sections. Here, you can find a list of the default JPS packages provided by the platform and add custom ones.

The following information is provided for the solutions in the table:

  • ID is used to point to the particular package (e.g. in widgets for one-click installation)
  • Name of an application
  • Version of an application
  • JPS Type can be either install (package creates a new environment) or update (add-on to be installed over the existing environment)
  • JPS Version shows a release of CS engine used in the solution (should be equal or higher to the corresponding platform version)
  • Rating determines the order of the packages in the JCA and end-user dashboard (solutions with a higher rating are displayed first)
  • Visibility Levels allows showing solutions to the specific groups of users only
  • Published shows if the package is added to the Marketplace in the dashboard

jca marketplace

The platform provides multiple pre-configured solutions out-of-box. These default packages are highlighted in a gray color within the list and cannot be edited or removed. Herewith, you can view their source code, as well as unpublish unrequited ones. Also, it’s possible to override the existing default package by creating a custom one with the same ID.

Below, we’ll show how to:

End-users can find solutions from the platform Marketplace via the locations listed in the appropriate User Experience section.

Add Custom Package

Follow the next steps to add a custom package to the platform Marketplace:

  1. Click the Add button at the tools panel and choose the preferred option from the expandable list to open the code editor:
  • New installation - basic template for a new environment creation
  • Add-ons - basic template for customization of the existing environment

add package to marketplace

  1. In the opened frame, you can choose a Template with a code sample from the appropriate drop-down list.

marketplace application code editor

Additionally, you can use the Reformat (automatically sets proper indentation and line feeds) and Word Wrap (brakes line when it reaches the frame border) buttons.

  1. Provide your application code (both JSON and YAML format can be used) according to the Cloud Scripting documentation.

Follow the best practices for better user experience:

  • use either JSON Editor with automatic formatting and syntax highlighting or YAML parser (depending on the syntax you prefer to work with) for advanced coding possibilities
  • leverage GitHub to store and manage your projects, manifests, and scripts all together
  • explore Samples to benefit on the preliminary composed operation and package examples
  1. After adding all necessary configuration details, apply the changes by clicking the Save button.

While editing the code, the validation of JSON and YAML is used, so if there are any errors you won’t be able to save the manifest.
Your custom package will be added to the list in the unpublished state (i.e. won’t be available for the users yet).

Manage Existing Packages

When working with an existing application, you can perform the following actions:

  1. Select the solution you want to manage (use the Search field to locate the required one) and use the tools panel to:
  • Edit the application source code (or View for the default packages)
  • Remove the application from the list (not available for the default packages)
  • Publish/Unpublish a solution, i.e. to respectively display/hide it in the dashboard Marketplace

marketplace applications management

  1. Configure the Rating (solutions with a higher rating are displayed first) by clicking on the appropriate column. Herewith, regardless of the specified values, custom applications are provided before the default (gray) ones.

marketplace applications rating

  1. Set the Visibility Levels by clicking on the pencil icon for the column. In the opened pop-up, choose from the following options: All Users, Admins with Full Access, Admins with View Rights, Platform Owner, Resellers.

marketplace application visibility levels

In the dashboard, packages, which are not provided to the All Users, are displayed in the additional System tab (hidden from the regular users) and cannot be located via search.

Test Package

It is highly recommended to test the deployment process of your custom package before adding or publishing it within the platform.

Log into user dashboard and add the manifest parameter at the end of the URL, providing the link to your application JSON or YAML manifest as a value:

?manifest=https://example.com/mymanifest.yml

If the manifest file link contains the question mark “?”, you need to use some URL shortener. Otherwise, your installation won’t work correctly.
Package installation will be initiated, allowing to verify the process and test a solution performance afterward.

User Experience

Your clients can access the solutions added to the platform via JCA in the following ways:

What’s next?