Add fields to a cloud catalog item order form

  • Release version: Xanadu
  • Updated August 1, 2024
  • 2 minutes to read
  • You can add fields to a cloud catalog form if you want the user to enter additional information beyond what a default blueprint provides.

    Before you begin

    • You need a blueprint that you published to the catalog. The blueprint should be in the draft state. See Build a Cloud Provisioning blueprint if you did not complete this prerequisite.
    • By default, cloud items appear in the Cloud Catalog, rather than the standard service catalog that comes with your instance. However, Blueprints utilize several features from the standard service catalog. It is suggested that you familiarize yourself with how the service catalog works. See Service Catalog to get started.
    • Role required: sn_cmp.cloud_service_designer

    About this task

    Fields are represented as variables in blueprints. To add a field, you add a variable to an operation in the blueprint.

    Procedure

    1. Open a blueprint that you already created.
    2. Click the Catalog tab, and then click the operation, such as Provision, that you want to add the variable to.

      Provision operation

      The Cloud Catalog Item form opens.
    3. In the Variable Sets related list at the bottom, click the set in which you want the variable to belong.
      For example, click General Info, which is a default variable set for all blueprints, to have the field appear in the first tab on the catalog order form.
      The Variable Set form opens.
    4. In the Cloud Variables related list at the bottom, click New.
    5. Fill in the important form fields, such as:
      Field Description
      Type Select the type of variable, such as Single Line Text for a text field, CheckBox, or Date, for example.
      Question tab In Question, which is the value the user sees for the field on the catalog order form, enter a name. The Name field, which is the actual name of the variable, is automatically populated with the same value in lower case.
      Other tabs Fill in other fields on the remaining tabs to control the field's visibility, form help text, default value, and access rights.
      Note:
      This variable will not be available for orchestration. If you intend to use this variable for orchestration, please add it through Cloud Template or Blueprint instead.
      Figure 1. An example variable for an email address
      Example email variable
    6. Click Submit.

      The Variable Set form opens, showing the new variable in the Cloud Variables related list.

    7. To control the position of the field on the form, change the value in the Order column.
      Note:
      A lower order value moves the field higher up on the form, and vice versa.

      Example email variable order number

      In this example, the order is set to 1, which means the Email address field appears after the Logical Datacenter field and before the Cloud Account field.

    8. On the form banner in the upper-left, click Try It to preview the order form as it would look to a user from the Cloud Catalog.
      The form appears with the new field that you created.

      Email address field

    9. Click the back arrow on the upper-left of the form.
    10. Toggle the catalog item to Publish.

      Publish the blueprint