Path Search function

  • Release version: Zurich
  • Updated July 31, 2025
  • 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 Path Search function

    The Path Search function in the Telecommunications Network Inventory application enables ServiceNow customers to compute network paths between starting and ending sites. It helps identify possible paths for network inventory design and assignment by calculating logical connections between network elements. When no direct path is found, it creates a logical connection using available inputs without adding connection elements. The function can automatically select equipment or interfaces when not explicitly provided, facilitating flexible path computation.

    Show full answer Show less

    This function is integrated as a Workflow Studio action within the Telecommunications Network Inventory workflows, allowing administrators to automate inventory-related data operations efficiently.

    Key Features

    • Path Computation: Calculates paths between specified start and end sites or equipment within the network inventory.
    • Automatic Selection: If end equipment or interfaces are not specified, the function selects appropriate equipment by type or interfaces marked as available.
    • Logical Connection Creation: Creates logical connections with port assignments based on start and end interfaces or defaults.
    • Fail Action Options: Allows configuration of actions to take when path computation fails, defaulting to creating logical connections without path elements.
    • Workflow Integration: Available as a Workflow Studio action, enabling use within automated network inventory workflows by users with the admin role.

    Input Parameters

    The function requires specific inputs to perform path search and connection creation:

    • Start Site and End Site: sysids of the network sites defining the path boundaries.
    • Start Equipment and End Equipment: sysids of the network equipment at the start and end points (optional for end equipment).
    • Start Interface and End Interface: sysids of interfaces to define connection ports; if omitted, interfaces are auto-selected.
    • End Equipment Type: Used to select appropriate end equipment if not specified.
    • Logical Connection Model and Bandwidth: Define the model and bandwidth attributes of the logical connection.
    • Allowed Logical and Physical Connection Models: Arrays specifying supported connection models.
    • Fail Action: Defines behavior on failure, with selectable options.

    Output

    The primary output of the Path Search function is the Connection id, which is the sysid of the created logical connection record. This allows customers to track and reference the new logical connections within their network inventory.

    Practical Use for ServiceNow Customers

    ServiceNow customers leveraging the Telecommunications Network Inventory application can use the Path Search function to automate and simplify network path computations and logical connection creation. By integrating this function into workflows, administrators can ensure accurate network design and inventory assignment without manual path identification, supporting efficient network management and reducing errors in connection data.

    The Path Search function enables you to execute the path computation function between the starting and ending sites in the Telecommunications Network Inventory application. You can use this function for the path computation when you process the network inventory design and assign.

    You can use the Path Search function to identify the possible paths between your network sites.

    If no path is found, the Path Search function uses the available input to create a logical connection without adding any connection elements. If you don’t enter the end equipment, it selects any equipment that matches the Type attribute that belongs to the end site. The function uses the start and end interfaces in the input to set the Port A and Port Z of the logical connections. Otherwise, it selects any interface in the Availability field, which is marked as Available.

    You can use this function as a Workflow Studio action in the Telecommunications Network Inventory workflow.

    Roles and availability

    Users with the admin role can add an action to a flow and define the configuration details of the flow. This function is available as a Workflow Studio action in the Telecommunications Network Inventory application so that you can perform inventory-related data operations.

    Input fields

    The following table lists the input fields in the Path Search function and their description.

    Table 1. Input fields of Path Search function
    Name Description Data Type
    Start Site sys_id of the starting network site where this connection is configured. String
    End Site sys_id of the ending network site where this connection is configured. String
    Start Equipment sys_id of the starting network equipment where this connection is configured. String
    End Equipment sys_id of the ending network equipment where this connection is configured. String
    Start Interface sys_id of the starting network interface where this connection is configured.
    Note:
    If this field is left empty, it automatically selects the interface by using the path computation to create a logical connection.
    		 String
    End Interface sys_id of the ending network interface where this connection is configured.
    Note:
    If this field is left empty, it automatically selects the interface by using the path computation to create a logical connection.
    		 String
    End Equipment Type sys_id of the ending network equipment type where this connection is configured. String
    Logical Connection Model sys_id of the logical connection model where this connection is configured. String
    Bandwidth sys_id of the bandwidth of the connection. String
    Allowed Logical Connection Model sys_id of the supported models for the logical connection. Click the add icon (Add icon.) to add a logical connection model. Array.String
    Allowed Physical Connection Model sys_id of the supported models for the physical connection. Click the add icon (Add icon.) to add a physical connection model. Array.String
    Fail Action Option to select the action when the function fails. You can select an action from the list. By default, the Create logical connection without path elements is selected. Choice

    To learn more about the variable data types, see Flow Designer input and output data variables.

    Output

    The following table lists the information about the function's output.

    Table 2. Output of function
    Name Description Data Type
    Connection id Returns the sys_id of the logical connection record. String