Use > Sequenced Designs > Subscriber options > Create subscriber option properties

Create subscriber option properties

Note The Subscriber Options tab is read-only if the service design is published.

You can create properties on subscriber options within an option set. The option property can then be copied to the other options in the option set using the Copy Property to All Options icon.

You cannot copy a property to all options in an option set when the Enable Multi-Select setting for that option set is selected.

Create a subscriber option property

To create a subscriber option property:

  1. Select the service design version whose subscriber option properties you want to configure.
  2. Click the Subscriber Options tab.
  3. Select the option set containing the option to which you want to add an option property.
  4. Click Navigate to Option Set.

  5. Select the option to which you want to add an option property.

  6. In the right pane, click Add Property.

  7. In the Add Property dialog, select the property type and details as described in the following table.

  8. Click Done.

  9. Click Save.
Item Description
Property Type

Select one of the following:

  • Boolean — A property whose value is True or False.
  • Integer — A property whose value is a positive or negative whole number or zero.
  • List — A property where you can define a list of values for the subscriber to select.
  • String — A property whose value is a sequence of characters.

Configure the following items for each property type:

  • Name — A unique name for the property.
  • Display Name — The display name for the property.
  • Description — A description of the property.
  • Editable — If selected, indicates the property is editable in a service offering created from the design and can be configured in the offering to be editable in the Marketplace Portal.
  • Required — If the property is Editable, you can select Required to require the service offering or subscriber to provide a value for the property. Boolean properties that are Editable are implicitly Required.

  • Input Validation - If the property is Editable, you can configure an Input Validation script to run and validate user input. This provides an additional level of control to ensure that user supplied values will work properly during provisioning.

    When a script is selected to be used for Input Validation, the script will be run to validate the user supplied value for this option property in the Marketplace Portal.

    You can manage the available set of scripts, and configure parameters to the selected script, using the Manage Scripts and Configure Parameters links:

    • Manage Scripts: To add, download, edit, or delete scripts, click Manage Scripts. For more information on Manage Scripts, see Manage Scripts.
    • Configure Parameters: To configure the parameters that should be supplied when running the selected script, click Configure Parameters. For more information on Configure Parameters, see Configure Parameters for Input Validation.
Property Details

For Boolean properties:

  • Service Offering and Marketplace Portal Settings:

    • Editable - Indicates that this property can be made editable in the Offerings area and in the Marketplace Portal

  • Default Value - Select true or false

    Note Boolean properties are always required, which means that when a subscription is ordered, a value must be provided for this field. This option cannot be changed for Boolean properties.

  •  

    • For Integer properties:

    • Service Offering and Marketplace Portal Settings

      • Editable - Select to make this field editable in the Offerings area and in the Marketplace Portal
      • Required - Integer properties are always required, which means that when a subscription is ordered, a value must be provided for this field.
      • Value Range - If Editable is checked, configure a minimum and maximum allowed value for the property.
      • Default Value - Select or type a positive or negative whole number or zero. If you enter a decimal number, the value will be truncated to the nearest integer. The maximum allowed integer value is 2147483647 and the minimum is -2147483648; if you enter a value outside these bounds the value will be automatically converted to the closest maximum or minimum value.

    For List properties:

    • Service Offering and Marketplace Portal Settings:

      • Editable - Indicates that this property can be made editable in the Offerings area and in the Marketplace Portal. Dynamic entry properties are always editable; this field cannot be changed for dynamic entry properties.
      • Required - Select to indicate that when a subscription is ordered, a value must be provided for this field.

    • List Selection Type:

      • Single-Select - Select to present options as radio boxes in the Marketplace Portal.
      • Multi-Select - Select to present options as check boxes in the Marketplace Portal.

    • List Items:

      • Switch to Static Entry (default) - Enter the name and value for an entry in the list. After the value entry, a new item line is displayed automatically.

      • Switch to Dynamic Entry - Select a script that will determine the values that should be presented to a user in the Marketplace Portal.

        You can manage the available set of scripts, and configure parameters to the selected script, using the Manage Scripts and Configure Parameters links:

        • Manage Scripts - To add, download, edit, or delete scripts, click Manage Scripts. For more information, see Manage Scripts.
        • Configure Parameters - To configure the parameters that should be supplied when running the selected script, click Configure Parameters. For more information on Configure Parameters, see Configure Parameters for Dynamic Entry List.

    For String properties:

    • Service Offering and Marketplace Portal Settings:

      • Editable - Select to make this field editable in the Offerings area and in the Marketplace Portal.
      • Required – Select to indicate that when a subscription is ordered, a value must be provided for this field.

    • Input Type:

      • Single-Line - The input area is presented as and accepts only one line of text.

      • Multi-Line - The input area is presented as a text box and can accept one or more lines of content.

      • Number of Characters - Configure the minimum and maximum number of characters that can be entered for this property. These fields are available only when the Editable and Single-Line options are selected.

      • Input Restriction - Choose an Input Restriction from the following list. These fields are available only when the Editable and Single-Line options are selected.

        • (none) - No input restriction will be performed. A minimum and maximum length can still be configured.
        • Custom Regular Expression - Validates the value based on a regular expression, as specified in the Regular Expression text box.
        • Email Address - Checks that a valid email format is entered.
        • IPV4 Address - Checks that a valid IPV4 address is entered.
        • IPV6 Address - Checks that a valid IPV6 address is entered.
        • Non-Numeric Characters - Checks that no numeric characters are entered.
        • URL Address - Checks that a valid URL format is entered. The regular expression used for validating the URL values may allow creating some invalid URL values such as http, http:/, http:// or hhh:////. This is because the regular expression validates a wide range of official IANA-registered schemes, which may not detect some invalid URL values.
      • Default Value - Type a string of characters.
      • Confidential - Select this box to mask the values so that they cannot be read in the user interface; no encryption of the value is performed. Note that this field is available only when the Single-Line option is selected.

    For descriptions of the additional icons available on the Subscriber Options tab, see Sequenced design subscriber options.

    Send Help Center feedback