Nevion VideoIPath Core Integration Configuration
Caution
Compatibility Note: This information is a general guide and may be incomplete, may not match a specific project implementation, and is subject to change as supported products and versions evolve. Confirm the exact implementation and requirements for each project with Riedel and the relevant equipment vendor, then validate the required functions end to end in the target environment before deployment.
Configuration Overview
hi uses two separate VideoIPath accounts. The API account books and cancels connections. The UI account signs in to the session that delivers configuration, status, and booking changes. Configure the connection first. Turn on name following afterwards, because it is a run-time option of the created Node.
|
Configuration |
What hi Sees |
Use When |
|---|---|---|
|
VideoIPath Connection |
Devices, endpoints, junctions, profiles, and bookings from VideoIPath. Crosspoint changes in hi become bookings. |
Always. Configure this first. |
|
Name Following |
hi renames its primary and panel names when the matching name changes in VideoIPath. |
VideoIPath is the authority for names. |
Caution
Accepting an untrusted root SSL certificate is a security risk. Use it only when the certificate is known to be safe and the site approves it.
Before You Begin
-
Use Node admin and open Inventory > Nodes. See Manage Nodes.
-
Confirm the license and minimum hi version in Required Configuration.
-
Use the VideoIPath administration tools to create the accounts. See the Nevion documentation for VideoIPath for account and permission steps.
-
Confirm the network access in Network Requirements.
Configure VideoIPath Connection
Use this configuration to connect hi to VideoIPath. The integration allows one Node.
Device Configuration
-
In the VideoIPath Security app, define the API account as an API user and note its username and password. VideoIPath filters the functions and resources that an API user can reach by the roles assigned to it, so assign roles that cover inventory, status, and bookings.
-
Create a normal user for the UI session with the permissions for configuration, status, and booking subscriptions, and note its username and password. VideoIPath allows Basic authentication only for API users, and an API user cannot sign in to a UI session, so the two accounts cannot be interchanged.
-
Enable the API, configuration, status, and session surfaces that the integration uses.
-
When the API URL uses HTTPS, configure the certificate trust and obtain the root certificate information that your site requires.
hi Configuration
-
Add the VideoIPath Core Integration in Inventory.
-
Enter the API URL, API Username, and API Password.
-
Enter the UI Username and UI Password.
-
When the API URL uses HTTPS, enter the Root SSL certificate. Set Accept Untrusted SSL Root Certificate to
Yesonly when the site approves it. The default isNo. -
Create the Node and wait for it to initialize.
Settings Summary
|
Setting |
Device Side |
hi Side |
|---|---|---|
|
API account |
API user of VideoIPath |
API Username and API Password |
|
UI account |
UI user of VideoIPath |
UI Username and UI Password |
|
Address |
URL of the VideoIPath system |
API URL |
Configure Name Following
Use this configuration after the Node is running and VideoIPath is the source of names.
Device Configuration
-
Rename a device or endpoint in VideoIPath with the vendor tooling, when you need to confirm the behavior.
hi Configuration
-
Open the Node of the VideoIPath integration.
-
Set Follow name changes to
Yes. -
Save the Node.
Common Checks
|
Symptom |
Check |
|---|---|
|
The Node does not initialize. |
Confirm the API URL, both accounts, and the certificate settings. |
|
Connections are created but no changes arrive. |
Confirm the UI account, because it carries the status and booking subscription. |
|
Names do not change in hi. |
Confirm that Follow name changes is |
Verify the Configuration
Confirm that both accounts establish their API and UI sessions, and that the configuration and status subscriptions deliver and acknowledge changes. Confirm that the Node shows the endpoints, junctions, profiles, and current bookings of VideoIPath. Create and cancel one test booking from hi during a maintenance window before you commission production routes.