Use > Topology Designs > Topology Design Subscriber Options

Topology design subscriber options

Use settings on the Subscriber Options tab to configure option sets and options to present to a user at subscription time. Option sets are configured in a topology design by adding options, creating option properties, and binding option properties to component or group properties in the design.

Option sets, options, and properties offer the subscriber the ability to customize the service that gets provisioned. An option set should contain one or more options and can be configured to allow the subscriber to select one or multiple options within the option set. Option properties can then be defined on an option, with the value for the property provided either by the designer, service offering manager, or subscriber. Bindings configured on option properties map the provided value to component or group properties in the design. In this use case, the user selected options and property values to customize the service that is provisioned.

After options have been entered, you can publish the design. Option Sets and Options cannot be deleted after they are published. After publishing, the option sets are made available in the Offerings area of the Cloud Service Management Console, where they can be further refined and configured. The subscriber options are then exposed to subscribers in the Marketplace Portal, allowing them to select values that customize the service offering for their personal needs.

Add Option Set

Use this functionality to create a hierarchy of option sets that is up to three levels deep:

  • Option Set 1
    • Option
      • Option Set 2
        • Option
          • Option Set 3
            • Option

Click the Add Option Set link or click the button in the upper right panel. You can also click the Copy Option Set and Paste Option Set buttons to copy option sets, both within and across designs.

After an option set has been created, you can configure the following values for the option set on the right side of the window:

  • Image - Clicking the image icon allows you to change the image for the option set.
  • Display Name - Specify a display name for the option set.
  • Description - Specify a description for the option set.
  • Modify Options - Check Modifiable during service modification to allow the subscriber to modify this option set in the Marketplace Portal after a subscription has been ordered. If checked, ensure that all property bindings from options in the option set exclusively target properties that are themselves modifiable during service modification. Unchecking prevents a subscriber from changing the selected values of this option set when modifying the subscription in the Marketplace Portal.

Managing Multiple Option Sets or Options

The selected option set or option is highlighted in blue. With the option set or option selected, you can Use <Ctrl> + the arrow keys to drag the selection up and down the list to reorder. An option set or option can also be reordered by clicking and dragging it.

Delete an Option Set or Option

With the option set or option selected, press the Delete key on the keyboard or click the trash can on the right.

Copy and Paste an Option Set or Option

You can copy and paste option sets or options within a design, between designs, and within a tree within a design. The copy includes the entire structure, including property bindings when copied within the same design. When pasting options or option sets into a new design, bindings will not be copied and you will need to manually configure them.

After copying and pasting an option set or option, changes to the original option set or option do not impact the newly created option set or option or vice versa.

To Add Options to an Option Set and Configure Selection Options

Click the option count button to navigate to the list of options for that option set. The name of the current option set will be displayed above the list of options. Click Add Option to add an option to the option set.

After selecting Add Option, the new Option Display Name is automatically generated to a unique value; you can then customize the Display Name and Description for the option.

An option set can be configured for Single-Select or Multi-Select.

  • Single-Select - Select to present options as radio boxes in the Marketplace Portal. A subscriber is required to select a single value.

    Multi-Select - Select to present options as check boxes in the Marketplace Portal. The subscriber can select 0 or more options for a Multi-Select option set.

Adding Properties to Options

Within an option, the properties panel on the right allows you to view, add, and edit properties, as well as to create bindings.

To Configure Attributes

The following attributes can be configured when creating an option property:

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.
    Property Bindings Select the topology component or group to which you want to push the value of this property. Then select the appropriate property from the list of compatible properties. This is called a target binding.

    Property icons

    • Edit Property - The Property Type cannot be changed, but any other fields related to the property type can be edited.
    • Bind Property - Binding is a link between option model properties and service component properties or groups in a design. A property can have more than one binding. Click the Configure Bindings icon to display a working area where you can view and delete existing bindings and configure new bindings.
    • Delete Property - Click the trashcan icon to delete the property.
    • Copy properties - Click the Copy Property to All Options icon to copy the current property to all options in the current option set. This icon is only present for Single-Select option sets.

    Send Help Center feedback