Overview
The IO-Base connector enables Seeq to access data from your IO-Base instance. This includes live data and asset tree data.
Prerequisites
As IO-Base is a full SaaS solution, we guarantee the operations of this connector.
To be able to use this connector, you need two prerequisites:
Service account:
Before configuring the connector, you have to create a service account in IO-Base.
We use an advanced authentication method to ensure security: Device Access Proxy → please follow this procedure to create a correct authentication token:
This authentication method ensures that no one can leak and reuse these credentials to connect to your data.
SeeQ Agent :
You have to deploy a SeeQ agent on an instance which has access to both IO-Base and your SeeQ Instance.
IO-Base being a SaaS solution, you need to open the port 443 from your instance.
Please refer to SeeQ documentation on Agents:
Once the agent is ready, please follow the steps below to install the connector :
1 - Download the connector file from the IO-Base interface
2 - Shut down the Seeq Remote Agent - execute seeq stop in the Seeq CLI`
3 - Copy the connector zip file to the plugins/connectors folder within Seeq's data folder (The data folder is usually C:\ProgramData\Seeq\data)
4 - Extract the contents of the zip file.
5 - Start the Seeq Remote Agent - execute seeq start in the Seeq CLI
Configuration
This is an example configuration template that is displayed in the Additional Configuration box that appears when you click Configure for an existing datasource (or if a new datasource is being created, in the Create new datasource connection modal that appears after clicking Add Datasource) on the Datasources administration page.
{ "IndametaUrl": 10000, "IndabaUrl": "historian-server.somecloud.server.com", "AccessToken": "exampleUsername", "RefreshToken": "examplePassword", "RefreshTokenUrl": "aaUser", "ApiKey": "pwUser", "DeviceId": 32568 } |
IO-Base additional configuration
Property Name | Default Value | Data Type | Description |
IndametaUrl | null | String | The URL used to connect to IO-Base API for the asset tree data. For example : https://example.meta.api.indasuite.io-base.com/v2 |
IndabaUrl | null | String | The URL used to connect to IO-Base API for the live data. For example : https://example.indaba.api.indasuite.io-base.com/v1 |
AccessToken | null | String | Access token generated by the initial token request.
Use the Access Token generated following the DAP procedure. |
RefreshToken | null | String | Refresh token generated by the initial token request. This will be updated automatically each time a new refresh token is fetched.
Use the Refresh Token generated following the DAP procedure. |
RefreshTokenUrl | null | String | DAP API refresh token url
Example: |
ApiKey | null | String | The APIKey for the connection of this service. |
DeviceId | null | String | Id of the device as registered by the DAP API (also referred to as client_id in the DAP API) in IO-Base.
This is the name of the service account configured in IO-Base on this page: https://<your IO-Base url>/app/devices/list |
Except for the Refresh token, all of these credentials can be found in IO-Base, in the Devices page:
https://<Your IO-Base url>/app/devices/list
Known Issues
There are no known issues for the IO-Base Connector. Please report any issues you find to our support portal.
Troubleshooting
The authentication can fail if you have done several API calls with the same Refresh Token. In that case, you need to create a new device and go through the DAP (Device Access Proxy) procedure once more.