Configuring the Replicator Environment
The replicator process can be configured either via command line options or by setting environment variables. In all cases command line options override the equivalent environment variables.
Command Line Options
The following command line options can be used:
Command Line Option |
Description |
-datadir <data_location> |
The location of the replication instruction file (REPLICATOR.ISM) |
-database <connect_string> |
SQL connection connect string identifying the database to connect to. |
-erroremail <email_address> |
Email address that start, error and stop messages should be sent TO. |
-localexport <export_path> |
The location where bulk export files will be created locally. |
-instance <instance_name> |
The name of this replicator instance. |
-interval <sleep_seconds> |
The number of seconds the replicator should sleep if it finds no instructions to process. |
-keyvalues |
Record the key values being used to relate ISAM records to SQL rows. |
-loaderrors |
Log failing records during a bulk load operation to a file. |
-logdir <log_location> |
The location where the log file should be created. A full or relative path, or an environment variable followed by a colon. |
-mailfrom <email_address> |
The email address that replicator messages should be sent FROM. |
-mailserver <smtp_server> |
The DNS name or IP address of the SMTP mail server that will be used to send messages. |
-maxcolumns <max_columns> |
The maximum number of columns in a database table. Default is 254. |
-maxcursors <max_cursors> |
The maximum number of database cursors. Allow 4 per table. Default is 128. |
-remoteexport <export_path> |
The URI of the instance of FileService that can be used to upload bulk load files to the remote database server (e.g. http://<server_name_or_ip>:8080/FileService). On OpenVMS you must specify the URL within double quotes. |
-stoponerror |
Cause the replicator to stop if an error is encountered. |
-syslog |
Log to the system log in addition to the log file. |
-verbose |
Enable verbose logging. |
Environment Variables
The following environment variables can be set:
Environment Variable |
Description |
REPLICATOR_DATA |
The location of the replication instruction file (REPLICATOR.ISM) |
REPLICATOR_DATABASE |
SQL connection database connection string identifying the SQL Server database to connect to. |
REPLICATOR_ERROR_EMAIL |
The email address that start, error and stop messages should be sent TO. |
REPLICATOR_EXPORT_LOCAL |
The location where bulk export files will be created locally. |
REPLICATOR_EXPORT_REMOTE |
The URI of the instance of "FileService" that can be used to upload bulk load files to the remote database server (e.g. http://<server_name_or_ip>:8080/FileService). On OpenVMS you must specify the URL within double quotes. |
REPLICATOR_INSTANCE |
The name of this replicator instance. |
REPLICATOR_INTERVAL |
The number of seconds the replicator should sleep if it finds no instructions to process. |
REPLICATOR_LOG_KEYS |
Set to YES to cause the key values being used to relate ISAM records to SQL rows. |
REPLICATOR_LOG_BULK_LOAD_EXCEPTIONS |
Set to YES to cause failing records during a bulk load operation to be logged to a file. |
REPLICATOR_LOGDIR |
The location where the log file should be created. A full or relative path, or an environment variable followed by a colon. |
REPLICATOR_EMAIL_SENDER |
The email address that replicator messages should be sent FROM. |
REPLICATOR_SMTP_SERVER |
The DNS name or IP address of the SMTP mail server that will be used to send messages. |
REPLICATOR_MAX_COLS |
The maximum number of columns in a database table. Default is 254. |
REPLICATOR_MAX_CURSORS |
The maximum number of database cursors. Allow 4 per table. Default is 128. |
REPLICATOR_ERROR_STOP |
Set to YES to cause the replicator to stop if an error is encountered. |
REPLICATOR_SYSTEM_LOG |
Set to YES to log to the system log in addition to the log file. |
REPLICATOR_FULL_LOG |
Set to YES to cause more verbose logging to be used. |