Custom Time Series Data Store

The Custom Time Series Data Store object allows the user to create and configure multiple time series data stores in addition to the already existing "Test" and "Production" time series data stores available as default. The object can be created in the I/O Model beneath the Core or a Data Store Group object.

Once created, the Custom Time Series Data Store exists as a separate MongoDB database instance in the connected MongoDB component. The data store can then be selected to archive Time Series data when configuring the Archive Selector property of an I/O item or other object that produces time series data.

Quick Configuration

  1. Right click on the Core or a Data Store Group object and select Admin  New  Data Stores  Custom Time Series Data Store from the context menu to open the Create Object wizard.

  2. Give the object a unique name and enter a description if necessary.

    The properties that configure the time series buffer (buffer size, latency etc.) can be changed here, however, the default settings are usually sufficient for most cases.
  3. Click on the Custom Time Series Data Store options from the wizard sidebar to view the data store settings.

  4. The default database and collection names can be changed here, along with data retention period and purge settings (what happens to the object data if the object is deleted). If the retention period is set to <null> then the time series data store will be retained permanently.

  5. If necessary, the MongoDB connection settings can also be changed (for example, if you wish to connect to a remote MongoDB instance or configure replication sets).

  6. Click Create to create the object in the I/O model tree.

  7. To add the new Time Series Data Store as an archive option for the Archive Selector property for I/O items under the Core, it is also necessary to configure the Data Store Sets table property in the Core object.

  8. Select the Core in the I/O Model tree and open the Data Store Configuration property compound in the Object Properties panel.

  9. Open the Data Store Sets table property (the property grid should be empty if this is the first data source being configured).

  10. Enter a unique name in the 'Name' column. This is the name that will be displayed in the drop down menu of the Archive Selector property for I/O items.

  11. From the drop down menu in the 'Data Stores' column, select the name of the Time Series Data Store object that you just created. You can also select the System Production/Test archive, to archive the data in the centralized System archives (this is particularly important when using a Master and Local Core setup for Autonomous Site Operation)

  12. Add a description to the 'Description' column if required.

  13. Click OK to close the property grid.

  14. Click Apply in the Core Object Properties panel to apply the changes.

  15. To check that the new Time Series Data Store is now available, select an I/O item (or other time series data producing object) in the namespace below the respective Core and navigate to the Archive Selector property in the Object Properties panel.

  16. Select the data store from the drop-down menu and click Apply to archive the data for that object in the new Time Series Data Store.

Custom Data Stores are available from system:inmation version 1.62 and above. If you have components in your system that are an older version than 1.62 (Connector for instance) then you will not be able to use the Custom Time Series Data Store to archive data for objects below that Connector. This is the case even if your Core component is version 1.62 and the Connector is of an older version. It is not recommended to use Custom Time Series Data Stores to archive data for any objects that are located below and older version of a Connector until that component has been updated to version 1.62 or higher.

Object Properties

Common

Object Name

The user-modifiable object name. This name overrides the name which has been supplied by the external system. It must be unique within the collection of objects of the parent object.

Object Description

This is the user-modifiable object description. This name overrides the description which has been supplied by the external system.

Display Alias

Alternate label for objects to be used for easier identification in the displays.

Time Series Buffer

Custom time series buffer configuration.

Latency

The maximum duration to buffer time-series data in memory.

Minimum Buffer Size

The minimum size of the time-series buffer, in data values, eligible for immediate writing.

Maximum Buffer Size

The maximum size of the time-series buffer, in data values.

Parallelism

The number of threads used when writing time-series data.

Maximum Future Offset

Data with timestamps beyond the specified offset from the current time will be rejected. Data with significant future offsets degrade the purge performance of the test store, potentially causing it to keep data longer than the configured retention time.

Allocation Step

A value used internally by the time-series buffer. This should only be changed when advised by Product Support.

Time Series Data Store

Custom time series data store configuration.

Database

The database storing time-series data.

Collection

The collection storing time-series data.

Retention Period

The retention period for the particular custom data store, a value of <null> will set it to unlimited retention.

Purge Size

The maximum number of BSON documents purged in a single batch operation.

Purge Moderation

A delay between successive purge batches.

Purge Mode

Controls what happens to an object’s data in the store after the object’s deletion.

  • Do not purge: Do not purge data of deleted objects from the store.

  • Purge when idle: Purge data of deleted objects from the store, only when it is idle.

  • Purge continuously: Purge data of deleted objects from the store, even if it is busy.

MongoDB Connection

This property compound combines the properties of the MongoDB Connection e.g. the connection strings to the mongoDB.

Connection String

The connection string for the external system; depending on the type of connection.

Replication Set Name

Configuration name for MongoDB Replica Set.

Replication Set 1

The connection string for the core service to replication set 1.

Replication Set 2

The connection string for the core service to replication set 2.

Authentication Mode

Authentication mode to be used connecting the MongoDB instance.

  • No Authentication: No Authentication is performed when the System connects to a certain instance of MongoDB.

  • Challenge-Response: MONGODB-CR is the default authentication mechanism supported by MongoDB. Username and Password needs to be provided.

  • SCRAM-SHA-1 Authentication: Salted Challenge Response Authentication Mechanism (SCRAM) means that the password is never actually sent over the wire, but rather a computed proof that the client password is the same as the password the server knows.

  • X.509 Certificate: MONGODB-X509 mechanism authenticates a username derived from the distinguished subject name of a X.509 certificate.

  • LDAP (Lightweight Directory Access Protocol): Lightweight Directory Access Protocol (LDAP) service is used for MongoDB authentication.

  • SCRAM-SHA-256 Authentication: SCRAM-SHA-256 authentication means that the password is never actually sent over the wire, but rather a computed proof that the client password is the same as the password the server knows (non-ASCII characters in passwords are not supported).

  • Auto: Detect the default authentication mechanism for users with stored SCRAM-SHA-1 and SCRAM-SHA-256 credentials (requires MongoDB 4.0 or newer).

User Name

User Name.

Password

Password.

Compression

Compress MongoDB data on the wire.

Secure connections

Enable TLS for MongoDB connections.

Allow Invalid Hostnames

Allow invalid hostnames in the server certificate for TLS connections.

Allow Invalid Certificates

Allow invalid server certificates for TLS connections.

MongoDB URI

If not empty, the MongoDB URI takes precedence, overriding all other MongoDB connection settings. The string needs to be URL-encoded.

Effective MongoDB URI

The actual MongoDB URI used for current connection.

Retry Period

The time after which an unsuccessful operation shall be retried.

Error Latency

The time during which successive errors are not reported.

Custom Options

Compound to hold various structures to customize the object and to be read and written to by Lua-Script code or external interfaces.

Custom String

A generic string buffer to be used programmatically for custom purposes.

Custom Properties

This is an extensible set of named strings which can be used programmatically for custom purposes.

Property Name

A custom property name which can be used programmatically.

Property Value

The value of the custom property which can be read and written programmatically.

Custom Tables

This is an extensible set of named tables which can be used programmatically for custom purposes.

Table Name

A custom table name which can be used programmatically.

Table Data

Handles an entire table organized in columns and rows. The data can easily (cut, copy and paste) be exchanged with table-oriented data of other software products, e.g. MS Excel.