Engine Configuration

Configuration of the store and forward engines is performed in the gateway under Databases > Store and Forward. Store and forward engines are directly correlated to database connections, and are automatically managed so that each connection has an engine defined.

Tip: Create multiple database connections pointing to the same database if you wish to configure multiple store and forward engines for different purposes.

Store and Forward Settings

The settings of a store and forward engine define how and when data is moved through the system. It is advisable to understand these settings and set them carefully in accordance with your goals.

Memory Buffer Settings

Memory Buffer Size

The number of records that can be stored in the memory buffer, the first stage of the store and forward chain. Other settings define when the data will move from the memory buffer forward, this setting only determines the maximum size. If the max size is reached, additional data will error out and be discarded. The memory buffer cannot quarantine data, so if there are errors and the disk cache is not enabled, the data will be lost.

If set to 0, the memory buffer will not be used.

Store Settings

These settings apply to the local disk storage cache.

Enable Disk Cache

Turn on the hard-disk cache. Data will be stored here if it cannot be forwarded in a timely manner. The cache also stores quarantined data (data with errors).

Max Records

The maximum size of the cache. After the max is reached, data will back up into the memory buffer, and once that is full, dropped.

Write Size

The number of records that should be accumulated in the memory store before written to the cache. Writing data in blocks can increase performance, but too large of a size increases the risk of data being lost in the event of a power outage or system failure.

Write Time

The max age of records in the memory buffer before they are stored to the cache. This setting is used in combination with the write size in order to give the forwarder the opportunity to retrieve data directly from the memory store and avoid the write to disk entirely.

Forward Settings

These settings govern when data will be forwarded to the database. The data will be pulled first from the local cache, and then from the memory store. When no data is present in the cache, it is pulled directly from the memory store.

Write Size

Same as disk cache setting above.

Write Time

Same as disk cache setting above.

Schedule Pattern

If enable schedule is selected, the forward engine will only be enabled during the times specified by the pattern. The pattern can specify specific times and ranges using a simple syntax.

Schedule pattern syntax

The schedule is specified as a comma separated list of times or time ranges. You may use the following formats:

Note: when the time period is over, any queued data will remain cached until the next execution period. That is, the forward engine does not run until all data is forwarded.