Path Search function

  • 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 Path Search function

    The Path Search function in the Telecommunications Network Inventory application enables ServiceNow customers to compute network paths between start and end sites. It helps identify possible network paths during inventory design and assignment processes. If no direct path is found, the function can create a logical connection based on available inputs without adding physical connection elements. When the end equipment is not specified, the function selects equipment by type at the end site. It also intelligently sets connection ports by using either specified interfaces or available interfaces marked as available.

    Show full answer Show less

    This function is accessible as an action within Workflow Studio, allowing automation of network inventory-related path computations as part of workflows. It requires users to have the admin role to add and configure this action in flows.

    Input fields

    The function accepts several key inputs to define the network path computation:

    • Start Site and End Site: sysid of the network sites marking the path's start and end points.
    • Start and End Equipment: sysid for network equipment at the start and end sites. If the end equipment is not specified, the function selects equipment matching the specified type at the end site.
    • Start and End Interface: sysid of network interfaces. If left empty, the function auto-selects interfaces based on path computation to create logical connections.
    • End Equipment Type: sysid identifying the type of equipment at the end site to assist in equipment selection.
    • Logical Connection Model and Bandwidth: sysid values defining the model and bandwidth attributes of the logical connection.
    • Allowed Logical and Physical Connection Models: Arrays of sysid values specifying supported models for connections, allowing flexibility in connection configurations.
    • Fail Action: Option to specify the action if the path search fails, defaulting to creating a logical connection without path elements.

    Output

    The function returns the Connection id, which is the sysid of the logical connection record created or identified by the path search.

    Practical Use for ServiceNow Customers

    ServiceNow customers can integrate the Path Search function into their Telecommunications Network Inventory workflows to automate the discovery and creation of network paths and logical connections. This enhances network design accuracy, reduces manual effort, and supports efficient management of network inventories. It ensures that even when direct physical paths are unavailable, logical connections can still be established, maintaining network integrity and continuity.

    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