List.[Table] data type

  • Release version: Xanadu
  • Updated August 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of List.[Table] data type

    The List.[Table] data type in ServiceNow stores a list of record Sys IDs associated with a specific table. It is designed to support the ServiceNow AI Platform List field options, including default records and reference qualifiers. This data type is commonly used in workflows and actions within the Workflow Studio to manage and manipulate multiple records efficiently.

    Show full answer Show less

    Key Features

    • Basic Options:
      • Label: Identifies the data variable in Workflow Studio with any text.
      • Name: Used for script calls; auto-generated from the label with only alphanumeric and underscore characters.
      • Type: Indicates the data type stored.
      • Mandatory: Specifies if the variable must have a value in an action.
    • Advanced Options:
      • Hint: Provides configuration guidance to flow or action designers.
      • Default Value: Sets the default records used if no value is provided by the flow designer.
      • Add [Record Label]: Allows selection of one or more default records, filtered by reference qualifiers if applied.
      • Reference Qualifier Conditions: Filters the list of selectable records to match specified conditions, ensuring only valid records appear for selection.

    Practical Guidance for Use

    • Reference Qualifiers: Use these to filter the records displayed by the list variable, for example, limiting to active incidents by applying a condition like [Active][is][true]. This ensures only relevant records are selectable.
    • Avoid Default Records in Store Actions: When creating actions intended for the ServiceNow Store, avoid selecting default records unless all instances have access to those records to prevent data access issues. Spoke developers typically do not have customer data access, so default records should only be used as demo data if publishing on the Store.
    • For Each Flow Logic: List variables can be used to specify records for processing in For Each loops. Note that any non-record sysid values (e.g., email addresses) are ignored within this logic, ensuring only valid records are processed.

    Stores a list of record Sys IDs associated to a specific table. This variable supports ServiceNow AI Platform List field options such as default records and reference qualifiers.

    Basic options

    Option Description
    Label Displays the label used to identify the data variable in the Workflow Studio interface. The label can consist of any text.
    Name Displays the name used to identify the data variable in script calls. The name can only consist of alphanumeric and underscore characters. The system automatically converts the label into a valid name by removing or replacing any special characters.
    Type Indicates the type of data stored by the data variable.
    Mandatory Indicates whether the data variable must contain a value when configured in an action.

    Advanced options for List variables

    Option Description
    Hint Provides guidance to flow or action designers on how to configure the data.
    Default value Specifies the value used when a flow or action designer does not provide a value.
    Add [Record Label] Select one or more records to include as default values for the list. If you filter the list with a reference qualifier, you can only select records that match the reference qualifier conditions.
    Reference qualifier conditions Select the filter conditions applied to the list of records. Flow designers can only select records that match the reference qualifier conditions.

    General guidelines

    Add a reference qualifier to filter list records
    Filter the records the list variable displays as valid options by adding a reference qualifier. The reference qualifier acts as a required list filter and causes the list variable to display only records that match the reference qualifier conditions. For example, to only displays active incident records add the reference qualifier condition [Active][is][true].
    Avoid selecting default records for actions intended for ServiceNow Store
    Avoid selecting default records for a list unless you know that all instances have access to the selected records. Spoke developers typically do not have access to the data of the customers who install their custom action. If you want to publish a custom action on the ServiceNow Store, you may need to provide default records as demo data.
    Use List variables in For Each flow logic
    You can use a List variable to specify the records to process within For Each flow logic. The For Each flow logic ignores any non-record sys_id present in the data. For example, if the List variable contains an email address, the flow logic ignores it.