Equinor Omnia Plant

JVM AGENT

Overview

The Equinor Omnia Plant connector enables Seeq to access data from Omnia Plant Data Platform via their Timeseries API v1.7.

Prerequisites

The connector uses the OAuth2.0 Client Credentials Grant Flow for authentication. You will need the tenant ID, resource ID, client ID, and client secret. See https://github.com/equinor/OmniaPlant/wiki/Authentication-&-Authorization#service-to-service-using-a-shared-secret for more information.

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.

CODE

{
    "Hostname": "https://api.gateway.equinor.com",
    "ExcludedQualityStatusCodes": [],
    "ConnectTimeoutInSeconds": 10,
    "ReadTimeoutInSeconds": 30,
    "CallTimeoutInSeconds": 30,
    "OauthConfig": {
        "TenantId": "<Insert the directory tenant ID>",
        "ResourceId": "<Insert the resource ID>",
        "ClientId": "<Insert the client ID or a reference to a Secrets file containing it>",
        "ClientSecret": "<Insert the client secret or a reference to a Secrets file containing it>"
    }
}

Equinor Omnia Plant Additional Configuration

Property Name	Default Value	Data Type	Description
`Hostname`	`https://api.gateway.equinor.com`	String	The base Equinor Omnia Plant API URL that is used to make requests.
`ExcludedQualityStatusCodes`	An empty list	A list of integers	Each data point stored in Equinor Omnia Plant has an associated quality status code. This field may be used to exclude data points with certain quality status codes from appearing in Seeq by providing a list of status codes to exclude.
`ConnectTimeoutInSeconds`	`10`	Integer	Determines the length of time in seconds the connector will wait for a response when connecting to Omnia.
`ReadTimeoutInSeconds`	`30`	Integer	Determines the length of time in seconds the connector will wait for a response when reading data from Omnia.
`CallTimeoutInSeconds`	`30`	Integer	Determines the length of time in seconds the connector will wait for a roundtrip call to Omnia (including DNS resolution, connecting, sending the requests, doing the server processing, and reading the response body).
`OauthConfig`	Empty OAuth Configuration	An OAuth Configuration	The information used for authentication via OAuth 2.0 Client Credentials Grant Flow.

OAuth Configuration

Property Name	Default Value	Data Type	Description
`TenantId`	`<Insert the directory tenant ID>`	String	The ID of the directory tenant used for authentication via OAuth 2.0 Client Credentials Grant Flow.
`ResourceID`	`<Insert the resource ID>`	String	The resource ID used for authentication via OAuth 2.0.
`ClientId`	`<Insert the client ID or a reference to a Secrets file containing it>`	String/SecretFile	The client ID used for authentication via OAuth 2.0. It is recommended to leverage a Secrets File to store this information.
`ClientSecret`	`<Insert the client secret or a reference to a Secrets file containing it>`	String/SecretFile	The client secret used for authentication via OAuth 2.0. It is recommended to leverage a Secrets File to store this information.

Known Issues

There are no known issues for the Equinor Omnia Plant connector. Please report any issues you find to our support portal.

Troubleshooting

If you are running into issues with connecting to or access data from Equinor Omnia Plant, view our guide for troubleshooting datasource issues.

Performance considerations

The Equinor Omnia Plant connector does not have any special performance considerations. View our guide on optimizing datasource performance for general guidance.