Create a service catalog variable

Create service catalogs variables to gather information from users ordering a catalog item, for example, to ask users which options they want for the item.

Procedure

  1. Navigate to Service Catalog > Catalog Definitions > Maintain Items.
  2. Select the catalog item that you want to create a variable for.
  3. In the Variables related list, click New.
  4. Select the variable type.
    Only the applicable fields for the variable type are then displayed.
  5. Fill in the fields.
    Table 1. Variable form
    Field Description
    Type The variable type that you want to create.
    Application Read-only field that indicates which applications can use this variable.
    Catalog item Catalog item using the variable.
    Mandatory Check box to make the variable mandatory as part of the ordering process.
    Active Check box to make the variable available for use
    Selection Required

    Check box to require users to select the check box variable. For example, use this option to require users to select an I agree check box for an agreement form. If users try to submit the agreement form without selecting the check box, an alert message is displayed to tell users that they must select the check box.

    Order Order that the variable is placed on the page for the catalog item. The variables are organized from top to bottom from least to greatest order value. For example, a variable with an order value of 1 is placed above other variables with higher-order values.
    Global If selected, the variable is available for all catalog tasks within service catalog workflows or execution plans by default. If deselected, the variable must be associated with individual catalog tasks.
    Map to field Maps the variable to a specific field on the table for the record producer.

    This field appears if the variable belongs to a record producer.

    Field Field that the variable maps to.

    This field appears if the variable belongs to a record producer.

    Record producer table Table that the record producer creates a record in.

    This field appears if the variable belongs to a record producer.

    Question
    Question Question to ask users ordering the catalog item.
    Name A name to identify the question.
    Tooltip Tooltip text to display when users point to the variable. Enter a brief note to describe the purpose of the 'Question'.
    Example text Hint that is displayed in the question field before a user enters a value.
    Applicable for the following variables:
    • IP Address
    • Email
    • URL
    • Single Line Text
    • Wide Single Line Text
    • Multi Line Text
    • Date
    • Date/Time
    Annotation
    Show help Check box to provide help text for the variable.
    Always Expanded Check box to expand and display Help text when the catalog item page loads. If the check box is cleared, then users must click the Help tag to display the help text.

    This field appears when Show help is selected. It is not available for container, break, and check box variables.

    Instructions Field to enter information that requires rich text formatting or adding images to support help information.
    Note: For HTML tables, use sizes that are within the width of the variable.
    Type Specifications (The fields in this section vary for each variable type)
    Variable Width Width for the variable on the catalog item page, to specify what percentage of the screen size that it can span. For details, see Configure a default width for service catalog variables.

    This field appears for all variable types except for break, container end, container start, container split, container layout, and label variables.

    Choice direction The direction in which the choice list is arranged. Across arranges choices horizontally. Down arranges choices vertically.

    This field appears for lookup multiple choice variables.

    Choice field Table field to populate options for the variable. If no choices are defined for a field, then the variable loads field-related distinct values from the table.

    This field appears for select box variables.

    Choice table Table with values to populate in the Choice field.

    This field appears for select box variables.

    Do not select the first choice Check box to leave all options for the variable cleared on the catalog item page.

    If this check box is selected, the first choice for the variable selected by default.

    This field appears for multiple choice and numeric scale variables.

    Dynamic ref qual Dynamic qualifier. Select a dynamic filter to run a query against the reference field.

    This field appears for reference variables when Use reference qualifier is set to Dynamic.

    Include none Check box to include the None option in a list of choices.

    This field appears for lookup multiple choice, lookup select box, multiple choice, and select box variables.

    Layout Layout for a container, whether one or two columns.

    This field appears for container start variables.

    List table Table with the values for the list collector.

    This field appears for list collector variables.

    Lookup from table Table from which values are obtained for users to select. The values from this table are populated in the Lookup value field.

    This field appears for lookup multiple choice and lookup select box variables.

    Lookup value field Field in the lookup table that populates options for the variable.

    This field appears for lookup multiple choice and lookup select box variables.

    Lookup label field(s) Comma-separated list of fields in the lookup table whose values are used to display options.

    This field appears for lookup multiple choice and lookup select box variables.

    Lookup price field Field in the lookup table whose value is used to modify the price of the item being ordered.

    This field appears for lookup multiple choice and lookup select box variables.

    Lookup recurring price field Field in the lookup table whose value is used to modify the recurring price of the item being ordered.

    This field appears for lookup multiple choice and lookup select box variables.

    Macro UI macro to insert into the catalog item.

    This field appears for macro, macro with label, and UI page variables.

    Price if checked Price of the item.

    This field appears for check box variables. See Check box.

    Recurring price if checked Price that increments for the item, when the user requests more than one order of the item.

    This field appears for check box variables. See Check box.

    Reference Reference table for the variable.

    This field appears for reference variables.

    Reference qual Qualifiers to restrict data that is available in the field.

    Supports reference qualifiers and advanced reference qualifiers.

    Returns all matching results (no maximum).

    Note: For security reasons, the use of scripts in the Reference qual field is restricted to system administrators through the Allow javascript in Default Value business rule.

    This field appears for list collector, lookup multiple choice, and lookup select box variables. reference variables.

    It appears for reference variables when Use reference qualifier is set to Dynamic.

    Reference qualifier condition Options to build conditions.

    This field appears for reference variables when Use reference qualifier is set to Simple.

    Scale max Highest value on the scale of available options for the variable.

    This field appears for numeric scale variables.

    Scale min Lowest value on the scale of available options for the variable.

    This field appears for numeric scale variables.

    Unique values only Check box to require a unique value for the field. When this check box is selected, two records cannot have the same value for that field.

    This field appears for lookup multiple choice, lookup select box, and select box variables.

    Use confirmation Check box to prompt users to reenter data to verify their entries.

    This field appears for masked variables.

    Use encryption Check box to store the answer in encrypted format in the database. If not encrypted, the answer is stored in plain text format. Encryption uses Triple DES with system encryption.

    This field appears for masked variables.

    Use reference qualifier Type of qualifier to use.

    This field appears for reference variables.

    Default Value
    Default value Default value for the variable.
    Variable attributes Attributes for this variable.
    Availability
    Visible Elsewhere Check box to display the variable on other types of catalog items, such as content items and record producers.
    Visible on Bundles Check box to display the variable on bundles.
    Visible on Guides Check box to display the variable on order guides.
    Note: If an order guide has too many items and variables, consider clearing this check box on as many items as possible, to improve loading performance on order guides.
    Visible on Summaries Check box to display the variable on the summary of the catalog item.
  6. Click Submit.

What to do next

If you want to restrict access to the variable, you can specify which roles can create, edit, update, or delete it. For details, see Apply permissions to a service catalog variable.