Path Search function

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 () 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 () 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

Related concepts

• Allocate Free Number function
• Create CI From Template function
• Cascade Update function
• Create and Assign Range/Single Number function
• Create Logical Interface function
• Create Logical Connection function
• Create Physical Connection function
• Create IP subnetwork function
• CIDR to IP range function
• Get Interface Summary function
• Lookup Next Hub function