Skip to main content

Share components on Marketplace

To make a piece of functionality available to other Grexx Platform developers or reuse it in another project, you need to create a component in your Studio and then add it as a product to a store on Grexx Marketplace.

A component can be based on a casetype (including a system service), dataset, plugin, template, picklist, role, or platform attribute. When you create a component, you can choose whether to include any other elements as dependencies.

You can choose whether to make individual products visible in a store, and you can control whether a store is publicly visible, only visible to Grexx Platform users, or only visible to those you have invited.

Create a component​

You can create and manage components from your Studio under Products > Components.

When you create a new component, Grexx Platform automatically identifies any dependencies and includes them when you add the component to Grexx Marketplace. For example, if the Start activity for a casetype includes a trigger to create a case of another casetype, that casetype is included as a dependency.

Select a component from the Components list to view its dependencies. By default, all dependencies are included when you add the component as a product to Grexx Marketplace. If you want to control which dependencies are included, click the pencil icon to edit the component and configure one of the following options:

  • Cases to ignore: Specify any elements from your Studio that you do not want to include in the component.
  • Casetypes to include: To manage dependencies explicitly, select the elements you want to include. Any elements you specify (and their dependencies) are included; all other dependencies are excluded.
Tip:

Excluding dependencies can result in a product that does not work immediately after being downloaded and imported. When you add a product to a store, you can use the documentation options to provide more information about dependencies that users need to add manually.

Add products to Grexx Marketplace​

Your Studio is connected to Grexx Marketplace through a storespace. From your storespace, you can manage your stores, the products you make available, and user permissions to share and download products.

Add stores​

Before you can share a product on Grexx Marketplace, you must have at least one store. You can configure the visibility of each store, and use different stores to make some products available to anyone while restricting access to others.

When you create or edit a store, you can specify:

  • State:
    • Select Open to make the store available to users with permission to see it.
    • Select Closed to hide the store from everyone other than your storespace's Owners and Sellers, regardless of the visibility setting.
  • Visibility: Use this option to control who can see any products in this store.
    • Select Public to make all products in the store visible to anyone.
    • Select Logged in users to allow only users that have logged in to Grexx Platform to view products in your store.
    • Select Only invitee to allow only users in a role on your storespace to view products in your store. This is useful if you want to reuse a component in another project that is managed from another Studio, but you do not want to share it more widely with the Grexx community.

Add products to stores​

You can add components to one or more of your stores. The store settings determine who can download your products for use in their own applications.

When you add a store product:

  • Use the Description field to provide an overview of the product. This is displayed on the product page.
  • Use the Category, Industry, and Tags to provide metadata to help users when searching for products.
  • Use the Manual options to provide guidance to users downloading the product. You can include information for display on the product page and a link to product manual hosted elsewhere.
  • Use the Visibility setting to control whether the product is listed on the Marketplace Products page and discoverable via search. If the product is not visible, users that have permission to view the store will not be able to find the product by browsing or searching Grexx Marketplace. However, users with the link to the product will still be able to view and download it.

Update a component and store product​

If you have made changes to a component and you want to update the product that is shared on Grexx Marketplace:

  1. From your Studio, navigate to Products > Components and select the relevant component.
  2. From the bottom right-hand corner, expand the hamburger menu and select Update component.
  3. Update the settings if required and click Submit.

The store product based on this component is updated automatically. Users downloading the product will receive the latest version. Existing users can update to the latest version by downloading the product again and re-importing it to their Studio.