Configuration

Storage path

Path to the directory where the Store and Forward (S&F) data will be persisted. If left empty (default), a folder named sf is created inside the module data directory.

Memory buffer size

Specifies the maximum amount of memory that the buffer is allowed to use in order to prevent out-of-memory conditions. When this limit is reached, buffered events are flushed to disk and are never discarded. The buffer size should be configured based on the available system RAM

Enable auto-purge

Enables automatic purging of Store and Forward data that is older than the configured maximum retention period. Use this setting to prevent disk space exhaustion.

Retention period (hours)

Specifies the number of hours that Store and Forward data is retained on disk. Data older than the configured retention period is automatically deleted. Ensure sufficient disk space is available to store all Store and Forward data for the duration of this period.

As a guideline, 1 million events require approximately 1 GB of disk space.

Enable auto-purge

Enables automatic purging of historical data that is older than the configured maximum retention period.

Retention period

Specifies the number of days that data is retained in the historian database. Data older than the configured retention period is automatically deleted.

Network interface

Specifies a comma-separated list of network interfaces through which the

embedded database accepts incoming connections.

Examples:

• 0.0.0.0 — Listens on all available network interfaces.

• 127.0.0.1 — Listens only for local connections.

You may also specify one or more individual IP addresses for fine-grained access control (for example, 192.168.1.10, 10.0.0.5).

Note: The database always listens on localhost (127.0.0.1), regardless of the interfaces specified in this setting.

TCP port

Specifies the TCP port used to connect to the embedded database.

The default value is 27017, Valid range: 1 to 65,535

Database path

Specifies the directory where the embedded database files are stored.

You can provide either an absolute or a relative path.

• If a relative path is specified, it is resolved relative to the module’s data folder.

• If left empty, the default path is ./db, relative to the data folder.

Protocol

Specifies the connection string format used to connect to the MongoDB server.

• mongodb — Standard connection format using mongodb://. Requires explicitly specifying the host and port.

• mongodb+srv — DNS Seed List connection format using mongodb+srv://. Automatically resolves the host and connection parameters via DNS. This option requires a properly configured SRV record and does not require a port number.

For additional details, refer to the MongoDB documentation on connection string formats.

Host

Hostname or IP address of the MongoDB server or cluster.

TCP port

Specifies the TCP port used to connect to the MongoDB server.

Default port: 27017

Valid range: 1 to 65535

This parameter is required when using the mongodb connection protocol.

Database name

Name of the database where the data is stored. N3uron creates the database automatically if it does not already exist.

If authentication is enabled, the provided credentials are validated against this database.

Ensure that the user has the appropriate read and write permissions on the specified database.

Parameters

Provide additional parameters in query string format to customize your connection. Use standard MongoDB URI options, such as:

retryWrites=true&w=majority&appName=N3uron

Enabled

Enables or disables authentication when connecting to the MongoDB server.

Username

Username used to authenticate with the database.

Password

Password used to authenticate with the database.

Enabled

Enables or disables the use of Transport Layer Security (TLS) to encrypt communications with the database.

CA certificate

The Certificate Authority (CA) certificate used to validate the certificate presented by MongoDB when establishing a TLS connection. If left empty, N3uron uses the operating system’s certificate store for validation.

Reject unauthorized

Enforces certificate validation and rejects the connection if the TLS certificate presented by the database is not trusted.

Disable this option only for staging or testing environments.

Protocol

Specifies the connection string format used to connect to the MongoDB server.

• mongodb — Standard connection format using mongodb://. Requires explicitly specifying the host and port.

• mongodb+srv — DNS Seed List connection format using mongodb+srv://. Automatically resolves the host and connection parameters via DNS. This option requires a properly configured SRV record and does not require a port number.

For additional details, refer to the MongoDB documentation on connection string formats.

Host

Hostname or IP address of the TimescaleDB server.

TCP port

Specifies the TCP port used to connect to the TimescaleDB instance.

Default port: 5432

Valid range: 1 to 65535

Database name

Name of the database inside TimescaleDB where the data is stored.

Ensure that the user has the appropriate read and write permissions on the specified database.

Parameters

Provide additional parameters in query string format to customize your connection. Use standard PostgreSQL options, such as:

connect_timeout=10&application_name=n3uron

Enabled

Enables or disables authentication when connecting to the TimescaleDB server.

Username

Username used to authenticate with the database.

Password

Password used to authenticate with the database.

Enabled

Enables or disables the use of Transport Layer Security (TLS) to encrypt communications with the database.

CA certificate

The Certificate Authority (CA) certificate used to validate the certificate presented by MongoDB when establishing a TLS connection. If left empty, N3uron uses the operating system’s certificate store for validation.

Private key

Optional private key used for client authentication when TLS is enabled.

Provide the PEM-encoded private key that corresponds to the client certificate. This is required when the server enforces mutual TLS (mTLS) authentication.

Client certificate

Optional client certificate used for authentication when TLS is enabled.

Provide the PEM-encoded certificate that identifies the client to the server. This parameter is required when the server enforces mutual TLS (mTLS) authentication.

Reject unauthorized

Enforces certificate validation and rejects the connection if the TLS certificate presented by the database is not trusted.

Disable this option only for staging or testing environments.

Enabled

Enables or disables historization for the tag.

Module name(s)

Specifies the name or names of the modules that will historize the tag. Multiple modules can be defined using a comma-separated list.

• For local Historian modules, use HistorianModuleName.

• For remote Historian modules, use NodeName/HistorianModuleName.

Deadband

Specifies the deadband used to determine whether an event should be historized. Both absolute and percentage-based deadbands are supported.

Examples:

• 0.1u

• 5%

Minimum

Default Y-axis minimum value, in Engineering units.

Maximum

Default Y-axis Maximum value, in Engineering units.

Interpolation

Specifies the default representation of historical values.

• Step — Tags are displayed as step lines.

• Linear — Tags are displayed as sloped (linear) lines.

Default aggregation method

Specifies the default aggregation method used to retrieve historical values.

• First — Returns the first value in the aggregation period.

• Last — Returns the last value in the aggregation period.

• Minimum — Returns the minimum value in the aggregation period.

• Maximum — Returns the maximum value in the aggregation period.

• Average — Returns the weighted time average over the aggregation period.

• Delta — Returns the difference between the first and last samples in the aggregation period.

• Standard deviation — Returns the standard deviation over the aggregation period.

Minimum

Specifies the minimum historization rate, expressed in milliseconds. It defines the shortest allowed time interval between storing two consecutive change events. Events stored as a result of reaching the Maximum rate setting are not considered when calculating this minimum interval.

Example:
If the minimum rate is set to 500 milliseconds, the Historian ensures that at least 500 milliseconds elapse between the storage of any two consecutive events.

Maximum

Specifies the maximum historization rate, expressed in milliseconds. This interval defines the longest time allowed between storing records when no new events occur. If the time difference between two consecutive values exceeds this interval, virtual values are generated on the fly for each historical request to fill the gap.

Example:
If the maximum rate is set to 1000 milliseconds, the Historian stores a new record with the same value if no new events occur within 1000 milliseconds.