Service Catalog variable form fields

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間:14分
  • Fields on the variable help you to define variables for a catalog item.

    Field Description
    Application Read-only field that indicates the application can use this variable.
    Type The variable type that you want to create.
    Catalog item Catalog item associated with the variable.
    Order Order in which the variable is placed on the catalog item page. The variables are organized with lowest order value on the top and greatest order value at the bottom.
    Active Option to make the variable available for use.
    Mandatory Option to mark the variable as required to order the catalog item.
    Read only Option to make the variable read only.
    Hidden Option to hide the variable.
    Question tab
    Question Question to ask when ordering the catalog item.
    Name Name to identify the question.
    注:

    If this field is empty, its value is auto-populated based on the Question field.

    Tooltip Tooltip text to display when you hover over the variable. Enter a brief note to describe the purpose of the Question.
    Example text Hint that is displayed in the question field before you 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 Option to provide additional help and instructions for the variable.
    Help tag Tag to display the Help text. For example, "More information."
    Help text Help information for a service catalog variable.
    Instructions Information that requires rich text formatting or adding images to support help information.
    Type specifications

    The fields in this section vary for each variable type.

    Variable Width Width of the variable on the catalog item page, to specify what percentage of the screen size that it can span.
    Enable also request for Option to allow a catalog item request to be submitted for multiple users. After you select this option, the Also request for field is displayed along with Requested For variable in a catalog item.
    Roles to use also request for Option to specify the roles that can submit a catalog item request for multiple users.
    Choice direction The direction in which the 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.

    Don’t 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.

    This field appears for container start variables.

    List table Table with the values for the list collector.

    The table should have a display column specified. For more 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.

    Summary macro Applicable only for Macro, and Macro with Label type variables.
    Widget Applicable only for Marco, and Macro with Label type variables.
    Price if checked Price of the item.

    This field appears for check box variables.

    Recurring price if checked Price that increments for the item when you request more than one order of the item.

    This field appears for check box variables.

    Reference Reference table for the variable. The table should have a display column specified.

    This field appears for reference variables.

    Reference qual Qualifiers to restrict data that is available in the field. Supports reference qualifiers and advance qualifiers.

    This field appears for list collector, lookup multiple choice, lookup select box, reference, and Requested For variables. The field also 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 can’t 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.

    This field appears for masked variables.

    Use reference qualifier Type of qualifier to use.

    This field appears for reference variables.

    Validation Regex Regular expression that validates the variable value.

    This field is displayed only for Single Line Text and Wide Single Line Text variable types.

    Variable attributes Attributes that define the behavior and restrictions for a variable.
    Default value
    Default value Default value for the variable.
    Auto-populate
    Dependent question Reference type variable for the catalog item. This field is used to auto-populate the variable.
    Reference Reference field for auto-populating the variable.
    Permission

    If no role is specified in this tab for the read, write, or create actions, all users who can access the catalog item can perform these actions irrespective of their role.

    A user with a role that doesn’t match any of the following roles can't set variable values even through scripting.

    These roles aren't available for Label, Break, Container Split, Container End, Macro, Macro with Label, and UI Page variables.

    Read roles Roles that can view the variable before or after requesting the catalog item or record producer. Only a user with the roles specified in this field can view the variable.
    Write roles Roles that can edit the variable in the variable editor after requesting the catalog item. If a user doesn’t have the roles specified in this field, the variable is read-only in the variable editor.
    Create roles Roles that can create values for the variable before requesting the catalog item or record producer. If a user doesn’t have the specified role, the variable is read only before requesting the catalog item or record producer.
    Availability
    Visible Elsewhere If selected, the variable appears on the item form before ordering the item, in the Variable Editor after ordering the item, and in the cart view of the item.
    Visible on Bundles If selected, the variable appears when the item is added to a bundle.
    Visible on Guides If selected, the variable appears when it’s added to an order guide, or when it’s added to a catalog item that is included in the order guide.
    注:
    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 If selected, the variable appears on any variable summarizer of the catalog item.