{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":4055,"path":"build-workflows/workflow-studio/create-flow-catalog-variables.md","title":"Create flow Service Catalog variables","bundle":null,"doc_type":null,"release":"australia","body":"\n# Create flow Service Catalog variables\n\nCreate Service Catalog variables that are only available to a specific Service Catalog flow. Flow-specific variables are available to catalog tasks and actions in the flow.\n\n## Before you begin\n\nRole required: flow\\_designer or admin\n\n## About this task\n\nFlow Service Catalog variables display in the **Catalog Variables** field of the Create Catalog Task and Get Catalog Variables actions. They display in the **Flow:variablename** format and are only available to the flow in which they are defined.\n\nFor more information about Service Catalog actions, see [Create Catalog Task action](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/build-workflows/workflow-studio/create-catalog-task-flow-designer.md) and [Get Catalog Variables action](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/build-workflows/workflow-studio/get-cat-variables-flow-designer.md).\n\n## Procedure\n\n1. Open or create a flow with a Service Catalog trigger.\n\n2. Click \\[Omitted image \"more-actions-menu-icon.png\"\\] Alt text: The More Actions icon and select **Manage flow catalog variables**.\n\n The Flow catalog variables table opens.\n\n3. Click **New** to add a new variable available to the flow.\n\n4. Complete the form.\n\n\n
\n\nField\n\n\n\nDescription\n\n
\n\nApplication\n\n\n\nRead-only field that indicates which applications can use this variable.\n\n
\n\nMap to field\n\n\n\nMaps the variable to a specific field on the table for the record producer.This field appears if the variable belongs to a record producer.\n\n
\n\nType\n\n\n\nThe variable type that you want to create. For more information, see [Types of service catalog variables](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/r_VariableTypes.md).\n\n
\n\nCatalog item\n\n\n\nCatalog item using the variable.\n\n
\n\nOrder\n\n\n\nOrder 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.\n\n
\n\nActive\n\n\n\nCheck box to make the variable available for use\n\n
\n\nMandatory\n\n\n\nCheck box to make the variable mandatory as part of the ordering process.**Note:** This behavior is applicable only on page load, and can be changed via client APIs.\n\n
\n\nRead only\n\n\n\nOption to make a variable read only or editable.\n\n
\n\nHidden\n\n\n\nOption to hide a variable.\n\n
\n\nUnique\n\n\n\nOption to disallow duplicate values for this variable within a multi-row variable set.**Note:**\n\n- This field appears only for a variable created in a multi-row variable set.\n- This behavior is applicable only in ServiceNow AI Platform, Service Portal, and variable editor in Agent Workspace.\n\n\n
\n\nDisable initial slot fill\n\n\n\nCheck box to determine whether to activate usage of caller-provided key-value pairs that pre-fill catalog item forms.\n\n
\n\nSelection Required\n\n\n\nCheck 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.\n\n
\n\nGlobal\n\n\n\nIf 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.\n\n
\n\nField\n\n\n\nField that the variable maps to.This field appears if the variable belongs to a record producer.\n\n
\n\nRecord producer table\n\n\n\nTable that the record producer creates a record in.This field appears if the variable belongs to a record producer.\n\n
\n\nHide on grid\n\n\n\nConfigure the visibility of a variable on the grid layout within a multi-row variable set \\(MRVS\\) for a catalog item. By default, the check box is not selected.\n\n If you select it, the variable doesn’t appear on the MRVS grid, but it still appears on the MRVS form.\n\n
\n\nQuestion\n\n
\n\nQuestion\n\n\n\nQuestion to ask users ordering the catalog item.\n\n
\n\nName\n\n\n\nA name to identify the question.**Note:** If this field is empty, its value is auto-populated based on the **Question** field for all variable types except break, container split, and container end.\n\n
\n\nTooltip\n\n\n\nTooltip text to display when users point to the variable. Enter a brief note to describe the purpose of the 'Question'.\n\n
\n\nExample text\n\n\n\nHint that is displayed in the question field before a user enters a value.Applicable for the following variables:\n\n- IP Address\n- Email\n- URL\n- Single Line Text\n- Wide Single Line Text\n- Multi Line Text\n- Date\n- Date/Time\n\n\n
\n\nRich Text\n\n\n\nFormatted label to be displayed on a catalog item form.Applicable for the Rich Text Label variable.\n\n
\n\nAnnotation\n\n
\n\nShow help\n\n\n\nIf selected, displays the [help text](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/t_DefineHelpInformation.md) and instructions for the variable.**Note:**\n\n- It is not available for break and check box variables.\n- Help text and instructions are not available for a variable set.\n\n\n
\n\nAlways Expanded\n\n\n\nIf selected, the **Help text** and **Instructions** field value are expanded by default when the catalog item page loads. This check box appears only when the **Show help** check box is selected.\n\n **Note:**\n\n- This field is also applicable in Service Portal.\n- This field is not applicable in the variable editor in Workspace and Catalog Item UIB component.\n- If the **Expand help for all questions** check box is selected at the catalog item level, then the **Always Expanded** field setting at the variable level is overridden.\n- If the **Expand help for all questions** check box is deselected at the catalog item level, then the **Always Expanded** field setting at the variable level is applicable.\n\n\n
\n\nHelp tag\n\n\n\nIf the **Always Expanded** check box is deselected, click the value specified in this field to display the **Help text** and **Instructions** field values.This field is not applicable in the variable editor in Workspace and Catalog Item UIB component.\n\n
\n\nHelp text\n\n\n\nHelp information for a service catalog variable.This field is applicable in ServiceNow AI Platform, Service Portal, and variable editor in Workspace, and Catalog Item UIB component.\n\n However, in Workspace and Catalog Item UIB component, you can view either help text or instructions. If both instructions and help text are available, you can view only the instructions.\n\n This field is not applicable for Break, CheckBox, Container End, Container Split, Macro, and UI Page variables. In Workspace and Catalog Item UIB component, this field is additionally not applicable for a Masked variable.\n\n
\n\nInstructions\n\n\n\nInformation that requires rich text formatting or adding images to support help information. This field is applicable in ServiceNow AI Platform, Service Portal, and variable editor in Workspace, and Catalog Item UIB component.\n\n However, in Workspace and Catalog Item UIB component, you can view either help text or instructions. If both instructions and help text are available, you can view only the instructions.\n\n In Workspace and Catalog Item UIB component, this field is additionally not applicable for a Masked variable.\n\n **Note:** For HTML tables, use sizes that are within the width of the variable.\n\n
\n\nType Specifications \\(The fields in this section vary for each variable type\\)\n\n
\n\nVariable Width\n\n\n\nWidth 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/configure-variable-width.md).This field appears for all variable types except for break, container end, container start, container split, container layout, and label variables.\n\n
\n\nEnable also request for\n\n\n\nOption 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. - This functionality is only applicable in Service Portal.\n- This field is applicable only for the Requested For variable.\nFor information about delegated request experience, see [Delegated request experience](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/delegated-request-exp.md).\n\n
\n\nRoles to use also request for\n\n\n\nOption to specify the roles that can submit a catalog item request for multiple users. - This functionality is only applicable in Service Portal.\n- This field is applicable only for the Requested For variable.\n- This field appears only when the **Enable also request for** check box is selected.\n **Note:** If no role is specified, anyone who has access to the catalog item can submit the request.\n\nFor information about delegated request experience, see [Delegated request experience](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/delegated-request-exp.md).\n\n
\n\nChoice direction\n\n\n\nThe direction in which the choice list is arranged. - **Across**: Arranges choices horizontally.\n- **Down**: Arranges choices vertically.\n This field appears for lookup multiple choice variables.\n\n **Note:** The selected direction is also applicable in Service Portal.\n\n
\n\nChoice field\n\n\n\nTable 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.\n\n
\n\nChoice table\n\n\n\nTable with values to populate in the **Choice field**.This field appears for select box variables.\n\n
\n\nDo not select the first choice\n\n\n\nCheck 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.\n\n This field appears for multiple choice and numeric scale variables.\n\n
\n\nDynamic ref qual\n\n\n\nDynamic 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**.\n\n
\n\nInclude none\n\n\n\nCheck 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.\n\n
\n\nLayout\n\n\n\nLayout for a container, whether one or two columns.This field appears for container start variables.\n\n
\n\nList table\n\n\n\nTable with the values for the list collector. The table should have a display column specified. This field appears for list collector variables.\n\n
\n\nLookup source\n\n\n\nThe lookup source. Select `Table` or `Choices`. By default, Table is selected.\n\n
\n\nLookup from table\n\n\n\nTable 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, and when a **Table** lookup source is selected.\n\n
\n\nLookup value field\n\n\n\nField in the lookup table that populates options for the variable.This field appears for lookup multiple choice and lookup select box variables, and when a **Table** lookup source is selected.\n\n
\n\nLookup label field\\(s\\)\n\n\n\nComma-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, and when a **Table** lookup source is selected.\n\n
\n\nLookup price field\n\n\n\nField 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, and when a **Table** lookup source is selected.\n\n
\n\nLookup recurring price field\n\n\n\nField 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, and when a **Table** lookup source is selected.\n\n
\n\nChoice table\n\n\n\nUse this field to specify the table that contains the desired choice list. It is only active when the **Lookup source** is set to `Choices`. The system queries the central choice table \\(sys\\_choice\\) for all choice lists associated with the table you select here.\n\n
\n\nChoice field\n\n\n\nUse this field to select the specific field \\(or \"element\"\\) from the Choice table whose options you want to display. For instance, if your Choice table is Incident \\[incident\\], you could select the **Priority**, **State**, or **Category** field to display the choices defined for it.\n\n
\n\nChoices depend on\n\n\n\nSelect another variable from the same catalog item to make this variable's choices dependent on it. This creates a dynamic filtering effect. The choices shown in the current variable will be filtered in real-time based on the value the user selects in the variable specified here. For example, if this field is for \"City\", you might select a \"Country\" variable here, ensuring only relevant cities are shown based on the selected country.\n\n
\n\nMacro\n\n\n\n[UI macro](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/api-reference/scripts/c_UIMacros.md) to insert into the catalog item.This field appears for macro, macro with label, and UI page variables.\n\n
\n\nSummary macro\n\n\n\nApplicable only for Marco, and Macro with Label type variables.\n\n
\n\nWidget\n\n\n\nApplicable only for Marco, and Macro with Label type variables.\n\n
\n\nPrice if checked\n\n\n\nPrice of the item.This field appears for check box variables.\n\n
\n\nRecurring price if checked\n\n\n\nPrice that increments for the item, when the user requests more than one order of the item.This field appears for check box variables. For more information about prices and recurring prices, see [Using variables for price setup](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/c_ServiceCatalogVariablePricing.md).\n\n
\n\nReference\n\n\n\nReference table for the variable. The table should have a display column specified.This field appears for reference variables.\n\n
\n\nReference qual\n\n\n\nQualifiers to restrict data that is available in the field.Supports reference qualifiers and advance qualifiers. For more information, see [Reference qualifiers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/c_ReferenceQualifiers.md).\n\n Returns all matching results \\(no maximum\\).\n\n **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.\n\n This field appears for list collector, lookup multiple choice, lookup select box, reference and Requested For variables.\n\n It appears for reference variables when **Use reference qualifier** is set to **Dynamic**.\n\n
\n\nReference qualifier condition\n\n\n\nOptions to build conditions.This field appears for reference variables when **Use reference qualifier** is set to **Simple**.\n\n
\n\nScale max\n\n\n\nHighest value on the scale of available options for the variable. This field appears for numeric scale variables.\n\n
\n\nScale min\n\n\n\nLowest value on the scale of available options for the variable. This field appears for numeric scale variables.\n\n
\n\nUnique values only\n\n\n\nCheck 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.\n\n
\n\nUse confirmation\n\n\n\nCheck box to prompt users to reenter data to verify their entries.This field appears for masked variables.\n\n
\n\nUse encryption\n\n\n\nCheck 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.\n\n
\n\nUse reference qualifier\n\n\n\nType of qualifier to use.This field appears for reference variables.\n\n
\n\nValidation Regex\n\n\n\nRegular expression that validates the variable value. This field is displayed only for Single Line Text and Wide Single Line Text variable types.To define regular expressions, see [Define a regular expression for a variable](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/define-regex-vrble.md).\n\n **Note:**\n\n- This field is also applicable in Service Portal.\n- The max\\_length attribute value is valid even when the validation regex is set.\n- You cannot add a catalog item with regex validation errors to the wishlist.\n\n\n
\n\nVariable attributes\n\n\n\nAttributes that define the behavior and restrictions for a variable. For information on variable attributes, see [Service catalog variable attribute](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/variable-attributes.md).\n\n
\n\nTopic block\n\n\n\nSpecify the topic block similar to configured UI macros or widgets used in the custom or custom with label variables to replicate the same behavior in a Virtual Agent conversation.\n\n **Note:** This field is available only for the \"Custom\" and \"Custom with Label\" variable types.\n\n
\n\nDefault Value\n\n
\n\nDefault value\n\n\n\nDefault value for the variable.\n\n
\n\nPermissionIf 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. For example, if no role is specified for the **Write roles** field, all users who can access the catalog item can edit the variable value in the variable editor.\n\n A user with a role that does not match any of the following roles cannot set variable values even through scripting.\n\n These roles are not available for Label, Break, Container Split, Container End, Macro, Macro with Label, and UI Page variables.\n\n
\n\nRead roles\n\n\n\nRoles 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.\n\n
\n\nWrite roles\n\n\n\nRoles that can edit the variable in the variable editor after requesting the catalog item or record producer. If a user does not have the roles specified in this field, the variable is read-only in the variable editor.\n\n
\n\nCreate roles\n\n\n\nRoles that can create values for the variable before requesting the catalog item or record producer. If a user does not have the specified role, the variable is read-only before requesting the catalog item or record producer.\n\n
\n\nAvailability\n\n
\n\nVisible Elsewhere\n\n\n\nIf selected, the variable is visible in the item form before ordering the item, in VEditor after ordering the item, and in the cart view of the item.\n\n
\n\nVisible on Bundles\n\n\n\nIf selected, the variable is visible when the item is added to a bundle.\n\n
\n\nVisible on Guides\n\n\n\nIf selected, the variable is visible when it is added to an order guide, or when it is added to a catalog item that is included in the order guide.**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.\n\n
\n\nVisible on Summaries\n\n\n\nIf selected, the variable is visible on any variable summarizer of the catalog item. In Service Portal, the variable is visible in the RITM ticket page and the Approval page.\n\n In Now Mobile, the variable is visible in the RITM and the Approval records.\n\n
\n\nRemove from Conversational Interfaces\n\n\n\nIf the catalog item has a variable that's making the item non-conversational, for example, a variable about pricing, then select the check box so that the catalog item becomes conversational.**Note:** This option doesn't apply to the a multi-row variable set \\(MRVS\\).\n\n
5. Click **Submit.**\n\n\n## Result\n\nAccess the variable in the flow by adding a Create Catalog Task or Get Catalog Variables action.\n\n**Parent Topic:**[Create a flow in Workflow Studio](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/build-workflows/workflow-studio/create-flow.md)\n\n"}}