Embedding

Overview

The Embedding section within the product profile page enables Vendors to customize self-service embedding experience of the customers and resellers (in case your product supports tier configuration). Note that the embedding attributes are versioned and localizable.

In general, embedding configuration is essential for customizing user experience once a generated subscription is processed successfully. This includes your product description, getting started instructions, download links, message templates, and your configured actions that will be available for your customers. Such attributes are also available for your business partners to preview:

Note that embedding configuration allows customizing messages in case tier configuration is approved, certain information is inquired, and so on.

The following introduces and describes all available attributes within the Embedding section.

General

The General tab provides general embedding customization settings, such as a product description, getting started instructions, download links, and documentation links.

Presentation

Description: Enter your product description. The description text has to be less than 256 characters long.

Getting Started: Provide your getting started material. This field supports up to 4096 characters.

Download Links

Use the provided interface to specify static download links required for your customers:

• Title: Type your download link title.
• URL: Enter your download link.

Documentation Links

Use the provided interface to specify static links to your documentation:

• Title: Type your documentation title.
• URL: Enter your documentation link.

Templates

Access the Embedding tab to customize messages that will be shown to users during various states. This includes a pending templates, inquiring templates, subscription approved templates, and templates that are associated with your available tier configuration.

The system allows editing such messages by using the Edit button next to your selected template:

Use the following overviews to familiarize yourself with provided templates and their features:

Pending Templates

Customize a “pending” state message by editing this template. Namely, this message will be displayed to users that ordered a product and created a fulfillment request.

Inquiring Templates

Provide an “inquiring” state message with this template. Therefore, this message will be displayed to users that are required to provide necessary parameter information and fill out your provided activation form.

Subscription Approved Templates

Customize a “subscription approved” message with this template. This message will be displayed to users in case a fulfillment request is approved, and its corresponding subscription is activated.

Tier Templates

The following templates allows editing messages in case tier configuration is in process or it is completed successfully. Note that these templates will be displayed in case corresponding Tier Config capabilities are enabled for your product. The system also enables to specify different messages for your Tier 1 and Tier 2 configuration operations.

Tier Pending Template

This message will be displayed in case tier configuration for your subscription is in progress. Therefore, the system generates a new tier configuration and its corresponding request in the Tier Config module.

Tier Approved Template

Use this template to create a message that is displayed once all required specifications for a tier configuration object are provided, and its tier config request is successfully approved.

Adding Templates

It is important to note that the system allows adding configuring available templates for a specific locale in case multiple translations are added by using the Localization functionality. Therefore, in case a template for a specific locale is required, add a new template and enter your message by using the provided interface:

1. Switch to your required translation by using an icon at the top-right corner of the screen.
2. Select a template type (e.g., the pending template) and click the Add Template button.
3. Specify a name for your new template and click Save.
4. Provide a new message for your template and click the Save button.

As a result, your specified template will be associated with your selected locale. The system also allows previewing your provided messages and compare it with the system template by using the locale switch:

Actions

The Actions tab enables Vendors to define and customize required actions for the embedding experience. Furthermore, this tab also allows accessing endpoint URL configuration and JWT secret.

Actions list

The Actions list displays your customized buttons on the customer embedding service screen. Follow the steps below to successfully create a new action button.

1. Click Create Action to create a new action button.

2. Fill out the action creation form:

• ID: Enter a unique identifier for this action button.
• Title: Type a title for your action button.
• Description: Enter a short action button description in this field.
• Scope: Select a scope for your action button.

3. Click Create to finalize your action button creation.

Thus, your action button will be successfully created, and it will be displayed on the Actions list.

Endpoint URL

Use this setting to customize redirect URL of the product API.

Click on the Edit icon to edit your endpoint URL.

JWT secret

Use this setting to view or generate your JSON Web Token secret.

Click on the Show Secret icon to display a JWT secret.
Click on the Refresh icon to generate a new JWT secret.