Skip to main content

Set up ingest

info

This section provides a step-by-step guide to setting up the ingest process for the Vista Gateway, but it is highly reusable across all systems that use the ISO19848 standard. If you are able to format your data to ISO19848 packages, any ISO19848 supported system should be able to receive it.

1. Identify a client library​

Identify if a client library is available. The options are:

  • .NET
  • Python

2. Authenticate​

Receive an API key from DNV and use it to authenticate with the Vista Gateway. See the client configuration for more information.

More information​

The API key is a unique identifier that allows you to authenticate with the Vista Gateway. It is essential for ensuring secure data transfer and access control. You can request an API key from your DNV contact, specifying the service you are interested in.

3. Send DataChannelList​

The DataChannelList is typically provided by DNV.

Make sure to send the ISO19848 DataChannelList before sending the timeseries or event data

More information​

The DataChannelList is a crucial component in the ingest process. It has multiple responsibilities:

  1. Defines the scope of the data to be ingested
  2. Provides metadata for each data point, including some:
    • Format type
    • Units
    • Range
    • ... and more
  3. Defines the mapping between the source system ids and the ISO19848 Local Ids.
  4. Used to filter out the data points that are relevant for ingest to the Vista Gateway.

Make sure to send the DataChannelList before sending the timeseries or event data. In theory, this only has to be done once per version of the DataChannelList.

Formatting:

  • The DataChannelList is typically provided by DNV, and already formatted according to ISO19848
  • It is important to review that the ShortId for each DataChannelId is set up correctly. The ShortId is used to identify the data points in the source system, and it should match the IDs used in the source system.

Recommendations:

  • Send the data channel list(s) on application statup, or when the data channel list is updated.

Remarks:

  • The DataChannelList is versioned by ID + Timestamp, and can be found in the DataChannelID field in the DataChannelList json file.

4. Send TimeSeriesData​

Format your data to the ISO19848 TimeSeriesData format and send it to the Vista Gateway. The data should be filtered with the DataChannelList to only include the relevant data points.

More information​

Formatting:

  • Make sure to always reference the correct data channel list in the time series/event data configuration (ID+Timestamp).
  • Values for multiple data points can be sent on the same timestamp. Make sure that the length and index of the DataChannelId-list are consistent with the length and index of the values in each dataset. The same applies for quality too, if you choose to specify it.
  • You can use your system source ids as the DataChannelId in the time series data. The Vista Gateway will map them to the correct ISO19848 Local Ids based on the DataChannelList.

Recommendations:

  • The DataChannelList provides you the list of source system ids. Use this to filter out the data points that are relevant for ingest to the Vista Gateway.

Remarks:

  • The DataChannelList also provides you the format type, units, range, and other metadata for each data point. Some of these properties are enforced upon ingest. These rules are defined in the ISO19848 standard.