Configuration-Log Store (System)

Configuration changes on all objects that do not fall under the responsibility of Local Cores, can be logged in the System Configuration-Log Store. For this, the System Configuration-Log store needs to be enabled as it is disabled by default.

If the System Configuration-Log store is enabled, it also records configuration changes on some objects that are already logged on Local Cores. In these cases the same entry can be found in the Configuration-Log Store of one or more Local Cores and the System Configuration-Log Store. The configuration logging behavior depends on the Model Panel to which the changed object belongs and certain configuration settings. For more information see Configuration-Log Store Settings (Local Core).

Activation

By default this functionality is disabled and needs to be enabled, if it is to be used.

To enable the Configuration-Log Store on a Master Core:

Select the System object in the I/O Model.
On the Properties panel, expand the Configuration-Log Data Store compound.
Select the checkbox for the Enabled property.
Deselect the checkbox for the Disable Monitoring property
Then configure the settings in the MongoDB Connection compound according to your MongoDB installation.
Set the Retention Time property to specify for how many days the entries are kept in the log store before they are automatically purged. A value of 0 means that entries will not be removed automatically.

The Master Core ignores the settings in the Local Core Settings property compound, since it is only used by Local Cores.

Accessing the Configuration-Log Store Entries

WebStudio

The Configuration-Log Store entries are easily accessible in WebStudio via the Configuration-Log Store Dashboard. Access is limited to users who are logged in to WebStudio using a Profile with the Administrative Role of Administrator.

Lua Scripting

In Lua scripting the getconfiglog function provides access to these entries.

Entry Format

The format of the Configuration-Log Store entries is the same as for Audit Trail entries of type CONFIG_CHANGE.

Object Properties

Enabled: Enable the Configuration-Log Store.

Disable Monitoring: Disable monitoring of the Configuration-Log Store MongoDB connectivity.

Retention Time: This value specifies the number of days the system will keep Configuration-Log entries. A value of 0 will set it to unlimited retention.

Generated Database Name: If not empty, this value will be used as the database name.

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

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.