Look Up Records action

  • 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 Look Up Records action

    The Look Up Records action in ServiceNow enables you to search for multiple records on any table by defining specific conditions. This action is available within Workflow Studio as a core ServiceNow action and requires theflowdesigneroradminrole to add and configure in a flow.

    Show full answer Show less

    Key Features

    • Input Parameters:
      • Table: Specify the table containing the records to look up.
      • Conditions: Define field names and values to filter records. For advanced queries, inline scripts using GlideRecord or GlideQueryCondition classes can be used.
      • Order by: Choose the field to sort the results.
      • Sort Type: Select ascending or descending alphabetical order.
      • Max Results: Limit the number of records returned to improve performance.
    • Outputs:
      • Records: List of record Sys IDs matching the lookup criteria.
      • Table: The table name containing the returned records.
      • Count: Number of records retrieved.

    Best Practices and Usage Tips

    • Use For Each flow logic to iterate through the list of records retrieved.
    • Set Max Results to 1000 or fewer to optimize flow performance and reduce system resource consumption.
    • Apply specific conditions to narrow down results and enhance efficiency.

    Example Use Case

    When an emergency change request is opened in the Network category, the Look Up Records action can retrieve configuration items assigned to the requester by querying the Configuration Item [cmdbci] table. The results are sorted by the Name field in ascending order, with outputs displaying the count, record Sys IDs, and the table name.

    Look up multiple records on any table using defined conditions.

    Roles and availability

    Available as a Workflow Studio ServiceNow core action. Users with the flow_designer or admin role can add an action to a flow and define configuration details.

    Inputs

    Provide a value for each input that your flow needs. To add dynamic values, you can also drag pills from the Data panel or select them from the pill picker.

    Table
    Data type: Table Name

    Table name containing the records you want to look up.

    Conditions
    Data type: Conditions

    Field names and field values that you want to use to search for records. To use an inline script to specify conditions, consider using the GlideRecord and GlideQueryCondition classes to build your query. See GlideRecord - Global and GlideQueryCondition - Global.

    Order by
    Data type: Field Name

    Field you want to use to sort results.

    Sort Type
    Data type: Choice

    Option to sort alphabetically in ascending or descending order.

    Max Results
    Data type: Integer

    The maximum number of record results the action can return.

    Outputs

    These outputs appear in the Data panel. You can use them as inputs elsewhere in your flow.

    Records
    Data type: Records

    List of record Sys IDs found based on the lookup criteria that you provided. For more information, see Records.[Table] data type.

    Table
    Data type: Table Name

    Table that contains the list of records.

    Count
    Data type: Integer

    Number of records that the action returned.

    General guidelines

    Use these general guidelines when working with the Look Up Records action.

    Process records with For Each flow logic
    Use For Each flow logic to iterate through a list of records. For more information about using For Each flow logic, see For Each flow logic.
    Set Max Results to improve performance
    Set the Max Results input to 1000 records or lower to improve the performance of your flow. The more records that the system has to look up, the more system resources it takes to identify and process them.
    Use conditions to filter records
    Use conditions to limit the number of records the action returns. The more specific conditions that you can provide, the better performance your flow has.

    Look up configuration items assigned to a change request user

    Configuration of Look Up Records action

    In this example, the flow starts when an emergency change request is opened in the Network category. The Look Up Records action uses the Configuration Item [cmdb_ci] table as the Table input. The Conditions input looks for configuration items assigned to the requester of the change request. The Order by input uses the Name field to perform an ascending alphabetical type sort.

    Execution details of Look Up Records action

    In the execution details, the Count output shows three configuration items that are assigned to the requester of the change request. The Records output shows the configuration items by name in the execution details page, but the data pill contains a series of Sys ID values. The Table output is the Configuration Item [cmdb_ci] table.