Parameters

Updated: October 14, 2020
Contents

Overview

  • Background: Parameters are part of the Product definition
  • Versioned: No (see versions)
  • Localized: Yes (see locales)

Product parameters allow vendors to collect data from customers that ordered their product and store data related to asset fulfillment. Thus, three different phases of Parameters can be configured in the Products > [Product Name] > Parameters configuration:

  • Ordering phase Parameters – set during the ordering phase by the Customer
  • Fulfillment phase Parameters – set during the fulfillment phase by the Vendor
  • Configuration phase Parameters – defined and managed even before any order is placed

IMPORTANT! All of the Configuration-phase-related functionality is applicable to Vendor and Vendor scenarios only. I.e. Providers/Resellers/Customers can NOT modify or even see any of the configuration phase parameters.

How to create a Parameter

In order to create a parameter of a particular product, first use the Products (1) module to navigate to the particular product details (2) screen, then click on Parameters (3) and CREATE PARAMETER (4) at the top-right:

“Create parameter” wizard

Right after clicking on the CREATE PARAMETER button mentioned above you will be offered to go through step-by-step process in order to fill info required for a new parameter creation.

Step 1 – General

  • ID: Unique identifier of the parameter in the context of a product. IDs are required to be able to programmatically identify the parameter using the Assets API.
  • Title: This text will be shown in the different inputs on the system. Please note that in case that of the ordering phase (and not hidden), this title will be visible to a customer.
  • Description: This text allows providing meaningful information for what the parameter is used for.

Step 2 and Step 3 – Phase and Scope

This step has 3 groups of settings, depending on the Phase (Ordering, Fulfillment, or Configuration). All 3 scenarios are described below.

a) Ordering phase:

The customer is asked to provide value for the parameter unless it is hidden. In most cases, such value will be collected by Commerce System.

Ordering phase could cover 3 scopes:

  1. Asset – if the product does not support Tier Configuration.
  2. Tier 1 – if the product supports Tier 1 Configuration.
  3. Tier 2 – if the product supports Tier 2 Configuration.

b) Fulfillment phase:

The vendor is required to provide the value upon request fulfillment.

  • Typical examples of such parameters are service IDs like “tenant id”, “customer id” or any other data being used to identify this particular asset in Vendor’s systems.
  • Additionally, this kind of parameter can be used to store attributes being communicated to the customers (like activation keys, links, etc.). Such parameters would typically be referred to in the Activation Templates.
  • Also, in case of fulfillment automation using the Assets API, such parameters can be used to handle multi-step asynchronous provisioning. A typical scenario would be to create a parameter that stores information about the provisioning stage and corresponding data attributes.

Fulfillment phase could also cover 3 scopes, the same as Ordering phase:

  1. Asset – if the product does not support Tier Configuration.
  2. Tier 1 – if the product supports Tier 1 Configuration.
  3. Tier 2 – if the product supports Tier 2 Configuration.

c) Configuration phase:

The Configuration phase is targeted to give an option of storing a number of custom parameters defined and managed before an order is placed.

Configuration phase parameters could cover 4 scopes:

  1. Product – an example of such a parameter would be a globally unique Constant used by the vendor to automate something.
  2. Marketplace – an example of such a parameter would be Access Credentials or API Endpoint URL that are often different in different Marketplaces.
  3. Item – an example of such a parameter would be Trial, additional IDs that are required for the fulfillment API of the vendor, etc.
  4. Item x Marketplace – an example of this case would be Varying Item IDs in different Marketplaces.

Step 4 – Constraints

The list of constraints offered to be defined on this step – depends on the Phase and Scope chosen on previous steps. Below are all available constraints with descriptions.

  • Required: when selected, the parameter must be filled in order to move the order over the flow:
    • Ordering phase: The customer will need to provide the value in order to transfer the order to the vendor. In most cases, this means that the value of the parameter will be populated by the Commerce Management directly. However, in some cases, Request will transition to the Inquiry state and missing values will be requested from the customer directly by the vendor management system.
    • Fulfillment phase: the parameter value will need to be set in order to be able to approve the request.
  • Hidden: (only available for the ordering phase parameters). When a parameter is hidden, the customer will not see it during the initial ordering experience. However, the vendor can ask for additional information from the customer when required. For example, ask for additional data points in case the customer country is from a particular list of values. Please note that the vendor will need to explicitly mark this parameter as “require changes” either using UI during fulfillment or using the Assets API.
  • Unique: uniqueness is meant within a product scope, i.e. the same value cannot be used by different assets of the same product.
  • Visible by Provider – When there is a need to make some configuration parameters visible for the Provider, this constraint can be used. E.g. “partner code” or similar scenarios.
  • Editable by Provider – When there is a need to make some configuration parameter not only visible but also editable for the Provider, this constraint can be used. E.g. “partner access configuration” and scenarios alike.
  • Primary Vendor Reconciliation ID – The value of this parameter can be used as a primary reconciliation ID for matching with Vendor systems. Only one fulfillment phase parameter can be marked as a reconciliation ID for a given product.

Step 5 – Type

This step just defines how a parameter will be requested in terms of the visual appearance – via text field with an option to input some data, or via drop-down menu with beforehand predefined option.

The CREATE button is available on the screen that means configuring and creating the parameter is completed.

Right after clicking on the CREATE – the parameter appears in the list of the parameters related to the particular Product:

Is this page helpful?
Translate with Google
Copied to clipboard