Cognite

JVM AGENT

Overview

The Cognite connector enables Seeq to access data from Cognite Data Fusion projects. It is able to index Cognite assets and their relationships as a Seeq asset tree and Cognite time series as signals.

Seeq indexes time series that are labeled as On this asset not Related to this asset.

Prerequisites

There are no prerequisites for connecting to Cognite.

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

{
    "BaseUrl" : "https://api.cognitedata.com",
    "OpenIdAuthentication" : {
        "TokenUrl" : "<Insert the OpenID identity provider URL used to get access tokens. This might look like https://login.microsoftonline.com/${YOUR-TENANT-ID}/oauth2/v2.0/token for Azure AD, for example>",
        "ClientId" : "<Insert the OpenID Client ID used to get access tokens or a reference to a Secrets file containing it>",
        "ClientSecret" : "<Insert the OpenID Client Secret used to get access tokens or a reference to a Secrets file containing it>"
    },
    "ApiKey": null,
    "Projects" : [ {
      "ProjectName" : "publicdata",
      "Enabled" : false
    } ]
}

Cognite Additional Configuration

Property Name	Default Value	Data Type	Description
`BaseUrl`	`https://api.cognitedata.com`	String	This is the URL for accessing Cognite.
`OpenIdAuthentication`	Empty OpenIdAuthenticationDefinition	An OpenIdAuthenticationDefinition	Authentication information for accessing Cognite. See also: https://docs.cognite.com/cdf/access/concepts/authentication_flows_oidc/#client-credentials-grant https://docs.cognite.com/cdf/access/
`Projects`	A disabled publicdata project	A list of ProjectDefinitions	A list of Cognite projects to sync data from.
`ApiKey`	null	String/SecretFile	NOT RECOMMENDED. An API key to use for authentication to Cognite. It is recommended to leverage a Secrets File to store this information. Note that API keys are deprecated by Cognite and may not work.

OpenIdAuthenticationDefinition Configuration

Property Name	Default Value	Data Type	Description
`TokenUrl`	`<Insert the OpenID identity provider URL used to get access tokens>`	String	The URL of the identity provider used to get access tokens. For example, if your identity provider is Azure AD the URL might look like `https://login.microsoftonline.com/${YOUR-TENANT-ID}/oauth2/v2.0/token`.
`ClientId`	`<Insert the OpenID Client ID used to get access tokens or a reference to a Secrets file containing it>`	String/Secret File	The OpenID Client ID used to get access tokens. It is recommended to leverage a Secrets File to store this information.
`ClientSecret`	`<Insert the OpenID Client Secret used to get access tokens or a reference to a Secrets file containing it>`	String/Secret File	The OpenID Client Secret used to get access token. It is recommended to leverage a Secrets File to store this information.
`Scope`	null	String	The optional access token scope, see https://docs.cognite.com/cdf/access/concepts/access_token_scopes . If `null` or missing defaults to `${BaseUrl}/.default`.

ProjectDefinition Configuration

Property Name	Default Value	Data Type	Description
`ProjectName`	`publicdata`	String	The name of the Cognite Data Fusion project.
`Enabled`	`false`	Boolean	Whether the project is synced with Seeq or not.

Known Issues

There are no known issues for the Cognite 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 Cognite, view our guide for troubleshooting datasource issues.

Performance considerations

The latency between Seeq and Cognite is an important consideration. The Seeq connector to Cognite requires frequent HTTP calls that will be impacted by highly latent connections. In cases where your Seeq deployment is substantially geographically separated, or on a latent network, deploying a Seeq Remote Agent closer to the Cognite deployment could alleviate some of the performance implications due to network latency.

Additionally, view our guide on optimizing datasource performance for general guidance.