Introduction
Vantage is an advanced cloud platform that allows for comprehensive monitoring and management of AV equipment in meeting rooms. An integral part of its functionality is its ability to integrate with various manufacturer platforms, including Poly Lens. This document will guide you on how to integrate Vantage with your Poly Lens platform.
Pre-requisites
Before proceeding with the integration, make sure:
- You have an active Vantage account and licenses for the rooms you wish to monitor.
- Your Poly Lens devices are networked and operational.
- You have administrative access to both your Vantage account and Poly Lens platform.
Steps to Integrate Vantage with Poly Lens
Step 1: Generate API key in Poly Lens
- Log in to your Poly Lens account.
- Click on the 'Account' dropdown and select 'Manage Accounts'.
- Select the account you wish to generate the API key for.
- Navigate to 'Integrations' and click 'Add New'.
- Provide a name for the connection, select the 'Guest' role and 'Confirm'.
- This will generate a connection with a Client ID and Secret which will be used in the next step.
Step 2: Enable Poly Lens Integration
- Log in to your Vantage account.
- Navigate to 'Integrations'.
- Locate 'Poly Lens' and click on 'Add Integration'.
- Enter the Client ID and Client Secret generated in Step 1 and 'Save'.
Data collected by integration
| Label | Key | Description | Data Type | Options | Health | Optional | Usage |
|---|---|---|---|---|---|---|---|
| Name | name | The name of the device. | string | - | ❌ | ❌ | ❌ |
| Serial Number | serialNumber | The serial number of the device. | string | - | ❌ | ❌ | ❌ |
| MAC Address | macAddress | The MAC address of the device. | string | - | ❌ | ❌ | ❌ |
| Call Status | callStatus | The current call status of the device. | enum | IN_CALL, NOT_IN_CALL, UNKNOWN, UNSUPPORTED | ❌ | ❌ | ✔ |
| Manufacturer | manufacturer | The manufacturer of the device. | string | - | ❌ | ❌ | ❌ |
| Internal IP | internalIp | The internal IP address of the device. | string | - | ❌ | ❌ | ❌ |
| External IP | externalIp | The external IP address of the device. | string | - | ❌ | ❌ | ❌ |
| Hardware Model | hardwareModel | The hardware model of the device. | string | - | ❌ | ❌ | ❌ |
| Software Build | softwareBuild | The software build version of the device. | string | - | ❌ | ❌ | ❌ |
| Hardware Family | hardwareFamily | The hardware family of the device. | string | - | ❌ | ❌ | ❌ |
| Software Version | softwareVersion | The software version of the device. | string | - | ❌ | ❌ | ❌ |
| Hardware Revision | hardwareRevision | The hardware revision of the device. | string | - | ❌ | ❌ | ❌ |
| Active Application Name | activeApplicationName | The name of the active application on the device. | string | - | ❌ | ❌ | ❌ |
| Active Application Version | activeApplicationVersion | The version of the active application on the device. | string | - | ❌ | ❌ | ❌ |
| All Peripherals Linked | allPeripheralsLinked | ✔ if all the peripheral devices are linked. | boolean | - | ❌ | ❌ | ❌ |
| Provisioning Status | provisioningStatus | The provisioning status of the device. | string | - | ✔ | ❌ | ❌ |
| Global Directory Status | globalDirectoryStatus | The status of the global directory on the device. | string | - | ✔ | ❌ | ❌ |
| Network Status | networkStatus | The network status of the device. | string | - | ✔ | ❌ | ❌ |
| Trackable Camera Status | trackableCameraStatus | The status of the trackable camera on the device. | string | - | ✔ | ❌ | ❌ |
| Camera Status | cameraStatus | The status of the camera on the device. | string | - | ✔ | ❌ | ❌ |
| Audio Status | audioStatus | The audio status of the device. | string | - | ✔ | ❌ | ❌ |
| Remote Control Status | remoteControlStatus | The status of the remote control on the device. | string | - | ✔ | ❌ | ❌ |
| Log Threshold Status | logThresholdStatus | The log threshold status of the device. | string | - | ✔ | ❌ | ❌ |
| Auto Answer P2P Status | autoAnswerP2pStatus | The auto-answer P2P status of the device. | string | - | ✔ | ❌ | ❌ |
| SIP Server Status | sipServerStatus | The SIP server status of the device. | string | - | ✔ | ❌ | ❌ |
| Gatekeeper Status | gatekeeperStatus | The gatekeeper status of the device. | string | - | ✔ | ❌ | ❌ |
| Calendar Status | calendarStatus | The calendar status of the device. | string | - | ✔ | ❌ | ❌ |
| In a Call Status | inACallStatus | The in-call status of the device. | string | - | ❌ | ❌ | ❌ |
| Microphones Status | microphonesStatus | The status of the microphones on the device. | string | - | ✔ | ❌ | ❌ |
| SoundStation IP 7000 Status | soundstationIp7000Status | The status of the SoundStation IP 7000 on the device. | string | - | ❌ | ❌ | ❌ |
| SoundStructure Status | soundstructureStatus | The status of the SoundStructure on the device. | string | - | ❌ | ❌ | ❌ |
| EagleEye View Status | eagleeyeViewStatus | The status of the EagleEye View on the device. | string | - | ❌ | ❌ | ❌ |
| Time Server Status | timeServerStatus | The time server status of the device. | string | - | ❌ | ❌ | ❌ |
| Cloud Service Status | cloudServiceStatus | The cloud service status of the device. | string | - | ❌ | ❌ | ❌ |
| GS Pairing Status | gsPairingStatus | The GS pairing status of the device. | string | - | ❌ | ❌ | ❌ |
| Poly Server Status | polyServerStatus | The Poly server status of the device. | string | - | ❌ | ❌ | ❌ |
| Meeting Password Status | meetingPasswordStatus | The meeting password status of the device. | string | - | ❌ | ❌ | ❌ |
| EagleEye Director Status | eagleeyeDirectorStatus | The status of the EagleEye Director on the device. | string | - | ❌ | ❌ | ❌ |
| VisualBoard Status | visualboardStatus | The status of the VisualBoard on the device. | string | - | ❌ | ❌ | ❌ |
| Presence Service Status | presenceServiceStatus | The presence service status of the device. | string | - | ❌ | ❌ | ❌ |
| CCE Status | cceStatus | The CCE status of the device. | string | - | ❌ | ❌ | ❌ |
| MCU Status | mcuStatus | The MCU status of the device. | string | - | ❌ | ❌ | ❌ |
| WiFi Status | wifiStatus | The WiFi status of the device. | string | - | ❌ | ❌ | ❌ |