Time Series Data Sources | Predix Essentials

About Time Series Data Sources

The Time Series Data Source Configuration provides methods to configure connections to the time series data sources, and to manage and retrieve connection information. Currently, for Predix and SmartSignal data source types, this service supports connections to Predix Essentials instances of Predix and SmartSignal (instances that are deployed along with Predix Essentials). This service supports Proficy Historian and External Predix Data as its external data source connection.

To ensure that connectivity and resources can be accessed as needed, make sure the following JSON fields are configured correctly:

Table 1. Proficy Configuration Fields
JSON Field	Description
alias	A unique alias name to save the data source configuration for the tenant. The alias name field in the application and JSON field must match.
precisionLevel	The default precision level for the time-series data points. If no precision level is indicated during retrieval, the default value is used.
authHost	The authorization host URL of the data source, for example, `https://fssfed.stage.ge.com.`
auth	The authorization token URI to retrieve the authorization token to connect to the data source host, for example, `/fss/as/token.oauth2.`
authRequired	The boolean value to indicate if authorization is required to connect to the data source host.
clientId	The OAuth client ID required to access the OAuth client.
clientPwd	The OAuth password required to access the OAuth client.
grantType	The authorization grant type. The default value is `client_credentials.`
authHeaderParams	Header parameters required to retrieve the authorization token.
authQueryParams	Query parameters required to retrieve the authorization token, for example, `scope:api.`
serviceHost	The service URL to retrieve time series data.
interpolated	The URI to retrieve interpolated data, for example, `/osmdatalayer/data/interpolated`.
raw	The URI to retrieve raw data, for example, `/osmdatalayer/data/interpolated.`
current	The URI to retrieve sample data, for example, `/osmdatalayer/data/sampled.`
write	The URI to write back time series data into the Proficy data source.
serviceHeaderParams	Header parameters required to pass to the service URL to retrieve the time series data. Note: Only define the service headers in the configuration if it is applicable to all types of time series data retrieval such as raw, current, and interpolated.
serviceQueryParams	Query parameters required to pass to the service URL to retrieve the time series data. Note: Only define the query parameters in the configuration if it is applicable to all types of time series data retrieval such as raw, current, and interpolated. If not properly defined, data retrieval may fail.
asyncFetchMode	Indicates whether the data source supports asynchronous queries. The default value that appears is false. Any value other than true is false. If your data source supports asynchronous queries, change the value to true. Attention: If you are unsure about the configuration, do not change the value.

Table 2. External Predix Data Time Series Configuration Fields
JSON Field	Description
alias	A unique alias name to save the data source configuration for the tenant. The alias name field in the application and JSON field must match.
precisionLevel	The default precision level for the time-series data points. If no precision level is indicated during retrieval, the default value is used.
ingestURI	The ingestion endpoint of the data source.
ingestUserName	The user name to connect to the ingestion endpoint. This is not the Time Series Data ingestion credential. The value of ingestUserName is specific to the External Predix Time Series data source being configured.
ingestPassword	The password to connect to the ingestion endpoint. This is not the Time Series Data ingestion credential. The value of ingestPassword is specific to the External Predix Time Series data source being configured.
interpolationMode	The modes for interpolating data. These modes are initiated by entering either of these case-sensitive values: `Math` or `Historian.` In Math mode, Time Series Data returns empty data when interpolating a time period. Time Series Data returns zeros for Historian. You do not have to enter a value for this field if you prefer Math mode.
authUrl	The URL to access the resource.
authClientId	The OAuth client ID required to access the OAuth client.
authClientSecret	The OAuth password required to access the OAuth client.
authHeader	The authorization header type. The default value is `Bearer.`
authType	The authorization type. The default value is `ZAC.`
predixTsZoneID	The Predix Time Series service zone ID.
zoneTokenScopes	The Predix Time Series service zone token scope. Scopes are permissions associated with an OAuth Client to determine user access to the resource through the application.
queryURI	The query URI for retrieving time series data.
extension	(Optional) This numeric value is represented in milliseconds. When configured, the interpolation query uses this time to control the start and end of the query bound intervals. If not configured or the value is configured as 0, then this parameter is ignored and the interpolation will look to fetch the start and end time data from infinite time. Note: This feature is currently not available in any Predix Essentials tenants in the US East.
asyncFetchMode	Indicates whether the data source supports asynchronous queries. The default value that appears is false. Any value other than true is false. If your data source supports asynchronous queries, change the value to true. Attention: If you are unsure about the configuration, do not change the value.

Assign a Default Time Series Data Source

Before You Begin

You have permission to perform the task.

Procedure

In the module navigation menu, select Administration > Time Series Data Sources.
In the Time Series Data Sources section, select the radio button next to the name in the Default column.
The changes will be saved automatically.

Modify an Existing Time Series Data Source

Use the Time Series Data Source page to modify an existing time series data source.

Before You Begin

You have permission to perform the task.

Procedure

In the module navigation menu, select Administration > Time Series Data Sources.
In the Time Series Data Sources section, select next to the name you want to modify.
Modify the JSON file. Make sure you have provided all the required key value pairs for a successful configuration of the data source you are modifying.
Select Save to permanently save your changes. Or, select Cancel to return to the Time Series Data Sources page without any changes.

Modify an Existing Time Series Data Source with Incorrect Value

Use the Time Series Data Source page to modify an existing time series data source with incorrect value.

Before You Begin

You have permission to perform the task.

Procedure

In the module navigation menu, select Administration > Time Series Data Sources.
In the Time Series Data Sources section, select Edit next to the name that has the incorrect values.
Modify the JSON file that displays in the text box.
Entering an invalid key-value pair generates a message that the alias does not match the Data Source name. Select OK, and enter the correct alias name.
Entering a mismatched JSON alias value generates a message that the information will be saved with the JSON alias you are entering. Select OK to continue. Or, select Cancel to return to the previous screen.
Select Save to permanently save your changes. Or, select Cancel to return to the Time Series Data Sources page without any changes.

Delete a Time Series Data Source

Before You Begin

You have permission to perform the task.

You cannot delete SmartSignal or Predix Time Series data source types.

Procedure

In the module navigation menu, select Admin, select Operations Managers, and then select Time Series Data.

Note: In the module navigation menu of Predix Essentials, select Time Series Data Sources.
In the Time Series Data Sources section, select X next to the time series data source you want to delete.
Select OK to permanently delete the selected data source configuration from the system. Or, select Cancel to return to the Time Series Data Sources page without any changes.