Path Search function

  • Release version: Yokohama
  • Updated January 30, 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 specified starting and ending sites. This function is essential for processing network inventory design and assignment by identifying possible paths between network sites. If no direct path is found, it logically creates a connection without adding new connection elements. It automatically selects appropriate equipment or interfaces if inputs are partially specified, ensuring flexibility in path computation.

    Show full answer Show less

    Key Features

    • Automatic equipment and interface selection: If the end equipment or interfaces are not specified, the function selects matching equipment types or available interfaces to establish logical connections.
    • Workflow Studio integration: Available as an action in Workflow Studio within the Telecommunications Network Inventory application, allowing automated inventory-related data operations in workflows.
    • Role-based access: Only users with the admin role can add this function as a flow action and configure its details, ensuring controlled usage.
    • Configurable input parameters: Inputs include identifiers for start/end sites, equipment, interfaces, equipment types, logical and physical connection models, bandwidth, and fail action options.
    • Fail action option: Defines behavior if path computation fails, defaulting to creating a logical connection without path elements.

    Input Parameters

    The function requires various inputs to define the network path computation, such as the sysid of start/end sites, equipment, interfaces, equipment types, connection models, and bandwidth. These inputs enable precise path calculation and logical connection creation according to your network inventory design.

    Output

    The function outputs the sysid of the logical connection record representing the computed path, which can be used for tracking and further processing within the ServiceNow platform.

    Practical Benefits for ServiceNow Customers

    • Streamlines network path computation during inventory design and assignment.
    • Supports automated workflows for managing telecommunications network inventory.
    • Ensures logical connections are created even when direct paths do not exist, maintaining network continuity.
    • Provides customization and control over connection models and failure handling.

    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