Event Repository Configuration

Table 1. Event Repository Configuration Parameters
Parameter	Description	Default Value
Enable Event Loader	Accepted value is `y` or `n`. Note: Choosing `y` also enables the Event Stream Server. create_config.info question: `EventLoader:Do you want to enable MATRIXX event loader (y/n)?`	n
Cluster for Running Event Loader	Specifies that the Event Loader is to run on the publishing cluster. Note: In this release, running the Event Loader is supported on the publishing cluster. Use the default value. create_config.info question: `EventLoader:Do you want MATRIXX event loader to run on processing cluster or publishing cluster?`	auxiliary_cluster
Type of Database for Event Repository	Accepted value is `mongodb`. create_config.info question: `EventLoader:What is the Event Repository type?`	mongodb
Event Repository Database Server Connection String	MongoDB server address. For information about setting the value of this property, see the discussion about setting the MongoDB connection string for Event Loader. Important: The default value `localhost` is only suitable for testing on an environment where the `mongod` runs on the same machine as the Event Loader. If that is not your intended setup, do not use `localhost` (or `127.0.0.1`). create_config.info question: `EventLoader:What is the address or connection string for the Event Repository?` This property also supports MongoDB Atlas SRV-style addresses, for example, `mongodb+srv://host/dbname/options`	mongodb://localhost:27017/MtxEventDatabase The default value must be replaced. This is a required value that must be set by the database administrator.
Format for Storing Event Objects	The format to use for storing the event objects in the Event Repository. Accepted values are `compact_mdc`, `bson`, and `compact_mdc_and_bson`. create_config.info question: `EventLoader:What is the format to use for loading the event objects to the Event Repository?`	compact_mdc
Maximum Batch Size of Event Objects	Maximum batch size of event objects that Event Loader loads into the Event Repository. The minimum acceptable value is 100. create_config.info question: `EventLoader:What is the maximum batch size for loading event objects into the Event Repository?`	10000
Write Concern for Event Loading	Set the write concern option on the MongoDB server for controlling the acknowledgment of write operations. The write concern option is the number of mongod instances in the replica set that must be confirmed before the write is successful. For example, when set to 1, the MEF is written to the primary repository only, allowing MongoDB to handle replication thereafter. When set to 2, the MEF is written to both the primary and secondary repositories, which sometimes can cause a timeout. Accepted value is any number. MATRIXX Support recommends setting the value to 1. Note: After a successful write, files are removed based on the value set in the create_config.info question Delay for Removing Processed MEF Files. Refer to MongoDB product documentation for information about write concern. create_config.info question: `EventLoader:What is the writeconcern for MATRIXX event loading?`	1
Write Concern Timeout for Event Loading	Set the write concern on the MongoDB server for controlling the timeout for acknowledgments of write operations. Accepted value is any number. create_config.info question: `EventLoader:What is the timeout in milliseconds for the writeconcern for MATRIXX event loading?`	1
Interval for Stats Update for Event Loading	Accepted value is any number (of seconds). create_config.info question: `EventLoader:What is the stats update interval in seconds for MATRIXX event loading?`	5
Delay for Removing Processed MEF Files	Time in seconds that the Event Loader service waits before removing processed MEFs. Accepted value is any number (of seconds). Note: The Event Loader service logs a warning if the sync time of the slowest mongo participant is more than this value, and an error is logged if the sync time of the slowest mongo participant is more than twice that duration behind the current time. In either case, the slow mongo time prevents MEF files from being removed. Set the delay time to enough time for system administrators to respond to a MongoDB failover in which a manual restart of the publishing server might be needed. For information about responding to a MongoDB failover, see the discussion about handling Event Repository loading issues. create_config.info question: `EventLoader:How long in seconds do you want to delay before event_loader can remove the processed MEF files?`	3600
Maximum Backlog MEF Files	Maximum number of MEFs that can be in the backlog before Event Loader starts to log errors. Accepted value is any number. create_config.info question: `EventLoader:What is the number of MEF files in the backlog before event loader starts to log an error?`	1000
Number of Event Loader Worker Threads	Accepted value is any number. create_config.info question: `EventLoader:How many worker threads do you want to configure?`	10
Event Repository Database Username	Accepted value is `MtxEventLoader`. create_config.info question: `EventLoader:What is the username for the Event Repository?`	`MtxEventLoader`
Event Repository Database Password	The password Event Loader uses for connecting to MongoDB. This password must match the password that is set for the `MtxEventLoader` user on your MongoDB system. Important: Do not enter an encrypted password. The password you enter is encrypted by MATRIXX. If you used special characters, such as a colon (:) or an at-sign (@), in the password given to the `MtxEventLoader` user as defined in MongoDB, you must encode each special character to URL encoded format (percent encoding) when you enter the password here. For more information, see the discussion about URL encoding for special characters in MongoDB user names and passwords. create_config.info question: `EventLoader:What is the password for the Event Repository?` The password is set in both the create_config.info file and `mtx_config.xml` file in encrypted form. For information about resetting the password on an online engine, see the discussion about resetting the MongoDB password used by the Event Loader.	Your password for the `MtxEventLoader` user as defined in MongoDB.
Maximum Idle Time for Log Files	Accepted value is any number (of seconds). Set to 0 to disable. create_config.info question: `EventLoader:What is the maximum idle time for log files in seconds?`	30
Maximum Open Time for Log Files	Accepted value is any number (of seconds). Set to 0 to disable. create_config.info question: `EventLoader:What is the maximum open time for log files in seconds?`	600
Configure Event Purging	Configure event purging. Accepted value is `y` or `n`. create_config.info question: `EventLoader:EventPurge:Configure rules for purging expired events (y/n)?`	n
Run Event Purge as Task	Accepted value is `y` or `n`. create_config.info question: `EventLoader:EventPurge:Run automatically as a task in the event loader system (y/n)?`	n
How Long Task Waits Between Runs	Asked if you answered `y` to run purging as a task. Accepted value is any number (of seconds). Set to 0 to disable. create_config.info question: `EventLoader:EventPurge:What is the delay in seconds between purge tasks?`	3600
Instruct Task to Drop Empty Collections	Asked if you answered `y` to configure event purging. Accepted value is `y` or `n`. create_config.info question: `EventLoader:EventPurge:Remove empty collections (y/n)?`	n
Allow Task to Remove Individual Expired Events	Asked if you answered `y` to configure event purging. Accepted value is `y` or `n`. create_config.info question: `EventLoader:EventPurge:Remove individual expired events (y/n)?`	n
Delete Code Values	Asked if you answered `y` to configure event purging. Accepted value is a semicolon separated list of integer values. (Optional) use "null" for event records without a DeleteCode field. For example, "null;1;2". create_config.info question: `EventLoader:EventPurge:What delete code values will be used for expired event purging?`	None
Delete Code Duration Expiration	Asked for each configured delete code. Specify as a number followed by `d` (day), `w` (week), `m` (month), or `y` (years). For example, `6m` for 6 months. create_config.info question: `EventLoader:EventPurge:DeleteCode {}: What is the expiration duration?`	100y
Number of Purge Query Threads	The number of concurrent MongoDB connections. You can increase this value to allow the task to finish faster by putting more load on the Event Repository. create_config.info question: `EventLoader:EventPurge:How many purge query threads to run concurrently?` Note: This number is specifically for defining event purge queries and not for defining the number of threads or MongoDB connections in other contexts.	1
Purge Query Time in Seconds	The query time slice in seconds. create_config.info question: `EventLoader:EventPurge:How long for each subquery time span, in seconds?`	3600
Percentage Interval for Purge Status Updates	The completion percentage interval at which to post status updates. The default is after every 5% of completion. create_config.info question: `EventLoader:EventPurge:Percent threshold for purge status update?`	5
Start Time of Purge Task	The time of day, in HH:MM:SS format, when the purge task is allowed to start. create_config.info question: `EventLoader:EventPurge:Time purge task is allowed to start?`	00:00:00
Stop Time of Purge Task	The time of day, in HH:MM:SS format, when the purge task stops. create_config.info question: `EventLoader:EventPurge:Time purge task should stop if it is still running?`	23:59:59

Enable Event Loader

Accepted value is y or n.

Note: Choosing y also enables the Event Stream Server.

create_config.info question: EventLoader:Do you want to enable MATRIXX event loader (y/n)?

n

Cluster for Running Event Loader

Specifies that the Event Loader is to run on the publishing cluster.

Note: In this release, running the Event Loader is supported on the publishing cluster. Use the default value.

create_config.info question: EventLoader:Do you want MATRIXX event loader to run on processing cluster or publishing cluster?

auxiliary_cluster

Type of Database for Event Repository

Accepted value is mongodb.

create_config.info question: EventLoader:What is the Event Repository type?

mongodb

Event Repository Database Server Connection String

MongoDB server address.

For information about setting the value of this property, see the discussion about setting the MongoDB connection string for Event Loader.

Important: The default value localhost is only suitable for testing on an environment where the mongod runs on the same machine as the Event Loader. If that is not your intended setup, do not use localhost (or 127.0.0.1).

create_config.info question: EventLoader:What is the address or connection string for the Event Repository?

This property also supports MongoDB Atlas SRV-style addresses, for example, mongodb+srv://host/dbname/options

mongodb://localhost:27017/MtxEventDatabase

The default value must be replaced. This is a required value that must be set by the database administrator.

Format for Storing Event Objects

The format to use for storing the event objects in the Event Repository.

Accepted values are compact_mdc, bson, and compact_mdc_and_bson.

create_config.info question: EventLoader:What is the format to use for loading the event objects to the Event Repository?

compact_mdc

Maximum Batch Size of Event Objects

Maximum batch size of event objects that Event Loader loads into the Event Repository.

The minimum acceptable value is 100.

create_config.info question: EventLoader:What is the maximum batch size for loading event objects into the Event Repository?

10000

Write Concern for Event Loading

Set the write concern option on the MongoDB server for controlling the acknowledgment of write operations.

The write concern option is the number of mongod instances in the replica set that must be confirmed before the write is successful. For example, when set to 1, the MEF is written to the primary repository only, allowing MongoDB to handle replication thereafter. When set to 2, the MEF is written to both the primary and secondary repositories, which sometimes can cause a timeout.

Accepted value is any number. MATRIXX Support recommends setting the value to 1.

Note: After a successful write, files are removed based on the value set in the create_config.info question Delay for Removing Processed MEF Files.

Refer to MongoDB product documentation for information about write concern.

create_config.info question: EventLoader:What is the writeconcern for MATRIXX event loading?

1

Write Concern Timeout for Event Loading

Set the write concern on the MongoDB server for controlling the timeout for acknowledgments of write operations.

Accepted value is any number.

create_config.info question: EventLoader:What is the timeout in milliseconds for the writeconcern for MATRIXX event loading?

1

Interval for Stats Update for Event Loading

Accepted value is any number (of seconds).

create_config.info question: EventLoader:What is the stats update interval in seconds for MATRIXX event loading?

5

Delay for Removing Processed MEF Files

Time in seconds that the Event Loader service waits before removing processed MEFs.

Accepted value is any number (of seconds).

Note: The Event Loader service logs a warning if the sync time of the slowest mongo participant is more than this value, and an error is logged if the sync time of the slowest mongo participant is more than twice that duration behind the current time. In either case, the slow mongo time prevents MEF files from being removed.

Set the delay time to enough time for system administrators to respond to a MongoDB failover in which a manual restart of the publishing server might be needed. For information about responding to a MongoDB failover, see the discussion about handling Event Repository loading issues.

create_config.info question: EventLoader:How long in seconds do you want to delay before event_loader can remove the processed MEF files?

3600

Maximum Backlog MEF Files

Maximum number of MEFs that can be in the backlog before Event Loader starts to log errors.

Accepted value is any number.

create_config.info question: EventLoader:What is the number of MEF files in the backlog before event loader starts to log an error?

1000

Number of Event Loader Worker Threads

Accepted value is any number.

create_config.info question: EventLoader:How many worker threads do you want to configure?

10

Event Repository Database Username

Accepted value is MtxEventLoader.

create_config.info question: EventLoader:What is the username for the Event Repository?

MtxEventLoader

Event Repository Database Password

The password Event Loader uses for connecting to MongoDB. This password must match the password that is set for the MtxEventLoader user on your MongoDB system.

Important: Do not enter an encrypted password. The password you enter is encrypted by MATRIXX.

If you used special characters, such as a colon (:) or an at-sign (@), in the password given to the MtxEventLoader user as defined in MongoDB, you must encode each special character to URL encoded format (percent encoding) when you enter the password here. For more information, see the discussion about URL encoding for special characters in MongoDB user names and passwords.

create_config.info question: EventLoader:What is the password for the Event Repository?

The password is set in both the create_config.info file and mtx_config.xml file in encrypted form. For information about resetting the password on an online engine, see the discussion about resetting the MongoDB password used by the Event Loader.

Your password for the MtxEventLoader user as defined in MongoDB.

Maximum Idle Time for Log Files

Accepted value is any number (of seconds). Set to 0 to disable.

create_config.info question: EventLoader:What is the maximum idle time for log files in seconds?

30

Maximum Open Time for Log Files

Accepted value is any number (of seconds). Set to 0 to disable.

create_config.info question: EventLoader:What is the maximum open time for log files in seconds?

600

Configure Event Purging

Configure event purging. Accepted value is y or n.

create_config.info question: EventLoader:EventPurge:Configure rules for purging expired events (y/n)?

n

Run Event Purge as Task

Accepted value is y or n.

create_config.info question: EventLoader:EventPurge:Run automatically as a task in the event loader system (y/n)?

n

How Long Task Waits Between Runs

Asked if you answered y to run purging as a task. Accepted value is any number (of seconds). Set to 0 to disable.

create_config.info question: EventLoader:EventPurge:What is the delay in seconds between purge tasks?

3600

Instruct Task to Drop Empty Collections

Asked if you answered y to configure event purging. Accepted value is y or n.

create_config.info question: EventLoader:EventPurge:Remove empty collections (y/n)?

n

Allow Task to Remove Individual Expired Events

Asked if you answered y to configure event purging. Accepted value is y or n.

create_config.info question: EventLoader:EventPurge:Remove individual expired events (y/n)?

n

Delete Code Values

Asked if you answered y to configure event purging. Accepted value is a semicolon separated list of integer values. (Optional) use "null" for event records without a DeleteCode field. For example, "null;1;2".

create_config.info question: EventLoader:EventPurge:What delete code values will be used for expired event purging?

None

Delete Code Duration Expiration

Asked for each configured delete code. Specify as a number followed by d (day), w (week), m (month), or y (years). For example, 6m for 6 months.

create_config.info question: EventLoader:EventPurge:DeleteCode {}: What is the expiration duration?

100y

Number of Purge Query Threads

The number of concurrent MongoDB connections. You can increase this value to allow the task to finish faster by putting more load on the Event Repository.

create_config.info question: EventLoader:EventPurge:How many purge query threads to run concurrently?

Note: This number is specifically for defining event purge queries and not for defining the number of threads or MongoDB connections in other contexts.

1

Purge Query Time in Seconds

The query time slice in seconds.

create_config.info question: EventLoader:EventPurge:How long for each subquery time span, in seconds?

3600

Percentage Interval for Purge Status Updates

The completion percentage interval at which to post status updates. The default is after every 5% of completion.

create_config.info question: EventLoader:EventPurge:Percent threshold for purge status update?

5

Start Time of Purge Task

The time of day, in HH:MM:SS format, when the purge task is allowed to start.

create_config.info question: EventLoader:EventPurge:Time purge task is allowed to start?

00:00:00

Stop Time of Purge Task

The time of day, in HH:MM:SS format, when the purge task stops.

create_config.info question: EventLoader:EventPurge:Time purge task should stop if it is still running?

23:59:59