Lookup Next Hub function
Summarize
Summary of Lookup Next Hub Function
The Lookup Next Hub function allows users to retrieve details related to physical connection records based on a network interface record input. This function is particularly useful for obtaining information about physical connections and interconnected ports within the Telecommunications Network Inventory application when utilized in the Workflow Studio application.
Show less
Key Features
- Returns physical connections related to a specified port, or an empty response if none exist.
- Provides sysid and names of front and back ports if there is a CI relationship.
- Delivers details about the NextHub interface and interconnected interfaces at the other end of the physical connection.
- Available as an action in Workflow Studio for inventory-related data operations.
Roles and Availability
The function is accessible to users with admin roles, allowing them to add the action to workflows and configure the necessary details.
Input Fields
The key input fields include:
- Network Interface: The network interface record to be referenced.
- Action Option: Allows selection of an action when multiple records are found, such as returning only the first record.
Output
The function outputs various data types, including:
- Physical Connections: List of sysids for physical connection records related to the network interface.
- Interconnected Port: List of sysids for ports interconnected with the network interface.
- NextHub Interface: List of sysids for interfaces connected to the physical connection's other end.
- NextHub Interconnected Interface: List of sysids for interconnected interfaces at the other end of the physical connection.
Example Use Cases
- Use Case 1: Inputting a network interface with no connections returns empty records.
- Use Case 2: Inputting a network interface returns the record of another interface.
- Use Case 3: Inputting a network interface returns related network interface and physical connection records.
- Use Case 4: Inputting a network interface provides information about NextHub and interconnected interfaces.
The Lookup Next Hub function enables you to take the network interface record as input and return the details of the related physical connection record. You can automatically get the details of the physical connection and interconnected ports of the equipment in the Telecommunications Network Inventory application when you use the Workflow Studio application.
- Physical connection that is related to the port.
- Empty response if no physical connection is related to the port.
- sys_id of the front and back ports, and the port name, if there’s a configuration item (CI) relationship between the front and back ports.
- NextHub interface and the interfaces that are connected to the other end of the physical connection.
- NextHub interconnected interface and the interconnected interfaces that are connected to the other end of the physical connection.
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 Lookup Next Hub action and their descriptions.
| Field Name | Description | Data Type |
|---|---|---|
| Network Interface | Network interface record. | Reference.Network Interface |
| If multiple records are found action | Option to select the action when multiple records are found. You can select Return only the first record from the list to return the details of the first physical connection record. | 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 output.
| Name | Description | Data Type |
|---|---|---|
| Physical Connections | Returns the list of sys_ids of the physical connection records that are related to the network interface. | Array.String |
| Interconnected Port | Returns the list of sys_ids of the ports that are interconnected to the network interface. | Array.String |
| NextHub Interface | Returns the list of sys_ids of the interfaces that are connected to the other end of the physical connection. | Array.String |
| NextHub Interconnected Interface | Returns the list of sys_ids of the interconnected interfaces that are connected to the other end of the physical connection. | Array.String |
Example
- Use Case 1
- If the input is passed as Interface-1 of Equipment-1 as shown in the following example, the function returns empty records, because the network inventory has no physical or internal connections in the network inventory.
- Use Case 2
- If the input is passed as Interface-1 of Equipment-1 as shown in the following example, the function returns the network interface record of Interface-2.
- Use Case 3
- If the input is passed as Interface-1 of Equipment-1 as shown in the following example, the function returns the network interface record of Interface-2 and the physical connection record of PC-1.
- Use Case 4
- If the input is passed as Interface-1 of Equipment-1 as shown in the following example, the NextHub Interface is 3 and the NextHub Interconnected Interface is 4.