Thank you for your feedback.
Form temporarily unavailable. Please try again or contact docfeedback@servicenow.com to submit your comments.

Create a variable set and add it to an item

Log in to subscribe to topics and get notified when content changes.

Create a variable set and add it to an item

Create a set of variables and add them to multiple catalog items and order guides for reuse.

Before you begin

Role required: catalog_admin, admin, catalog_editor, or catalog_manager

About this task

  • Variable sets within a catalog item cannot have the same internal name.
  • The name of a variable and the internal name of a variable set cannot be the same within a catalog item.
    Note: This condition is also applicable even if a variable is not part of the variable set.
  • Any catalog client script or catalog UI policy script should refer to the internal name of a variable set instead of its name or title.

Procedure

  1. Navigate to Service Catalog > Catalog Variables > Variable Sets.
  2. Click New.
    The Variable Set Creation page is displayed.
  3. Select any of the following:
    OptionDescription
    Single-Row Variable Set Creates a variable set with variables that are grouped together. Type field is set to Single Row.
    Multi-Row Variable Set Creates a variable set with multiple rows that captures variable data in a grid layout. Type field is set to Multi Row.
  4. Enter details.
    Field Description
    Title Title of a variable set. Appears if the Display title check box is selected.
    Internal name Variable set name for internal use. For example, to access the variable set for the front-end (through the g_form API) and server side scripting.
    Note: If this field is empty, its value is auto-populated based on the Title field for all variable types except break, container split, and container end.
    Order Order number for the variable set.
    Type Type of the variable set. Possible choices are:
    • Single Row
    • Multi Row
    Application Applications that can use this variable set.
    Display title If selected, adds a title and an expandable header to the right of the variable set.
    Note: When a user requests the item, all check box variables are grouped under a default title of Options. To use a custom title, insert a variable of type Label, with an Order value that puts it directly above the check box variables.
    Layout The layout display. Set to 1 Column Wide or 2 Columns Wide, alternating sides or 2 Columns Wide, one side, then the other.
    Description Description of the variable set.
  5. Right-click and select Save.
  6. Create the variables to use in that set.
    1. In the Variables related list, click New.
    2. Follow the steps for creating variables.
      Note: For a multi-row variable set:
      • The included variables are displayed as columns of a table.
      • The column order is the order of variables defined in the variable set.
  7. Click Submit.

Add a variable set to a catalog item or order guide

Service Catalog enables you to add a variable set to one or more catalog items or order guides.

Before you begin

Role required: catalog_admin, admin, catalog_editor, or catalog_manager

Procedure

  1. Open a catalog item or an order guide.
    OptionNavigation path
    Catalog item Service Catalog > Catalog Definition > Maintain Items
    Order guide Service Catalog > Catalog Definition > Order Guides
  2. In the Variable Sets related list, click Edit.

    You can configure the form to add the Variable Sets related list.

  3. Select and add a variable set.
    Note: If the Cascade Variables check box is selected for an order guide, multi-row variable set data should be cascaded to the included items.
  4. Click Save.
  5. Click Try.
    Note: For a multi-row variable set:
    • The associated variables are displayed as columns of a table on a catalog item or record producer. Each row corresponds to a set of data for all variables in the variable set.
    • The column order is the order of variables defined in the variable set.
  6. (Optional) Edit a multi-row variable set.
    1. To add a row, click Add within the variable set, specify the variable information in the Add Row window, and click Add.
      Note:
      • A maximum of 50 rows can be added.
      • Unless default values are provided for variables or On Load scripts are used to pre-populate data, you should add variable data for each row.
    2. To edit a row, click the edit row icon Icon to edit a row in the Actions column, specify the variable information in the Edit Row window, and click Save.
      Note: When you add or edit an existing row, all catalog UI policies and client scripts associated with the multi-row variable set should be honored.
    3. To remove a row, click the remove row icon Icon to remove a rowin the Actions column and click Remove in the confirmation window.
    4. To remove all rows of the table, Click Remove All within the variable set and click Remove in the confirmation window.
Feedback