Dbvisit Replicate Configuration Variable Reference
Per-process setting
Usually, variables are set globally, for all processes. This is done by specifying no process name, or *.
If the variable value needs to be set different for a process, use SET with a process name, e.g.
SET APPLY.LOG_FILE=/home/oracle/log/%N.%E
If the variable needs to be set back to the global “*” setting, use RESET command.
Variable reference
APPLY_CASE_CONVERT
When a table is prepared, should the name from mine be kept as-is, made uppercase, or lowercase? This is honoured for case-sensitive databases only (MySQL and MSSQL).
APPLY_DATABASE
Connection definition for the apply database. This is TNS connection string for Oracle, connection string for
MySQL or DSN (Data Source Name) for MS SQL.
APPLY_LISTEN_INTERFACE
Network interface on which apply listens for commands (hostname:port).
APPLY_PASSWORD
Encrypted apply database password. (Use ENCRYPT command to get encrypted password from the plain text password.)
APPLY_PEER
What is the corresponding apply for this process? If SIMPLE_CONFIG = YES, this is simply set to APPLY.
APPLY_RDBMS
Apply database type: Oracle, MySQL, MSSQL.
APPLY_REMOTE_INTERFACE
Where to connect to reach this apply process. This is usually same as APPLY_LISTEN_INTERFACE, but may be changed if the name resolution works differently among the machines, listen binds to selected interfaces only, etc. Note that this settings is used by the console, too.
APPLY_SET_TRIGGER_FIRE_ONCE
How to make triggers to not fire in apply sessions (YES/NO/AUTO).
Yes = enable the set-trigger-firing property (to honor dbms_ddl.set_trigger_firing_property) and abort if fail.
Auto = try to enable it, if possible.
No = disable it, even the package/variable way.
APPLY_SCHEMA
Apply database schema (Oracle, usually same as APPLY_USER), schema=database (MySQL), database
(MS SQL).
APPLY_SCHEMA2
Apply database schema (MS SQL only).
APPLY_STAGING_DIR
Directory to store received plogs on apply server.
Dbvisit Replicate Installation Guide and User Manual © Dbvisit Software Limited.
Except as specifically set out the Dbvisit license agreement, nothing in this Documentation constitutes a warranty as to the operation of the Dbvisit software.
page 66
APPLY_TRACE
OFF (default) or pattern for trace file name (use sequence number %S). The trace file contains all SQL applied as well as further debugging info.
APPLY_USER
Apply database login username.
DDC_BACKUP_DIR
If DDC DB, on every startup of a process a backup of all DDC settings is made into this directory as a backup, e.g. for use with CREATE DDCDB FROM DDCFILE, or just for reference.
DDC_DATABASE
TNS identifier for the database when the DDC DB is stored. (Setup wizard sets it to mine database for this by default.) Note that just setting this variable will not create the DDC DB tables, these are contained in every dictionary.
DDC_ID
Unique id of the DDC. This must not change after configuration is complete. Default: 1.
DDC_NAME
Name of the configuration (%d in filemask). This can change as you want, as internally only the DDC_ID matters, but beware of all %d references.
DDC_PASSWORD
Encrypted ddc db database password. (Use ENCRYPT command to get encrypted password from the plain text password.)
DDC_SCHEMA
DDC database schema, usually same as DDC_USER.
DDC_USER
DDC DB database login username.
DEBUG_LEVEL
Set debugging level. Contact support for possible values.
FETCHER_DATABASE
Mine database TNS (when connecting from fetcher).
FETCHER_ENABLED
Fetcher (downstream capture) enabled, this means mine waits for redologs from fetcher.
FETCHER_LISTEN_INTERFACE
Network interface on which fetcher listens for commands (hostname:port).
FETCHER_PASSWORD
Encrypted fetcher database password. (Use ENCRYPT command to get encrypted password from the plain text password.)
FETCHER_PEER
What is the corresponding fetcher for this process? If SIMPLE_CONFIG = YES, this is simply set to
FETCHER.
FETCHER_REMOTE_INTERFACE
Where to connect to reach this fetcher process. This is usually same as FETCHER_LISTEN_INTERFACE, but may be changed if the name resolution works differently among the machines, listen binds to selected interfaces only, etc. Note that this settings is used by the console, too.
Dbvisit Replicate Installation Guide and User Manual © Dbvisit Software Limited.
Except as specifically set out the Dbvisit license agreement, nothing in this Documentation constitutes a warranty as to the operation of the Dbvisit software.
page 67
FETCHER_SCHEMA
Schema of mine repository (when connecting from fetcher). Virtually always same as MINE_SCHEMA.
FETCHER_THREADS
On RAC, specify a subset of redo log threads that a particular fetcher should handle; it is necessary to send all threads to mine, but it is possible to use multiple fetchers. Use “ALL” (default) or colon-separated list of threads (e.g. “1:3:5”). Default: ALL.
FETCHER_USER
Mine database login username (when connecting from fetcher).
CHECKVARS
Disable/enable checking of variable values. Can be: ON (default), OFF, or comma-separated list of variables
NOT to check.
LICENSE_KEY
License key, as obtained by your purchase.
LOG_FILE
General process log file location template.
LOG_FILE_TRACE
General trace file location template.
LOG_FILE_COUNT
How many general log file copies to keep (default 2 = 1 active log and 1 copy).
LOG_FILE_DATE_ROTATE
If not OFF (default), specifies how often rotate the general log files. Allowed values: yyyy-MM: every month yyyy-ww: every week yyyy-MM-dd: every day at midnight yyyy-MM-dd-a: every day at noon yyyy-MM-dd-HH: every hour yyyy-MM-dd-HH-MM: every minute
LOG_FILE_SIZE
Approximate maximum log size in bytes, exceeding this size causes logs to rotate.
LOG_OBSOLETE_AGE_PLOG
When plogs are applied and no longer needed even after apply restart, they are eligible for deletion. In addition, they must be at least LOG_OBSOLETE_AGE_PLOG days old.
LOG_OBSOLETE_AGE_RLOG
When redo logs are mined and no longer needed even after mine restart, they are eligible for deletion. In addition, they must be at least LOG_OBSOLETE_AGE_PLOG days old. NOTE: this applies only for redolog copies shipped to mine from fetcher – if mine reads them directly, they are left to be managed by database administrator, using RMAN, backup scripts etc.
MAILCFG_AUTH_PASSWORD
OFF/password: set the password to be used if the SMTP server requires authentication.
MAILCFG_AUTH_USER
OFF/username: set the username to be used if the SMTP server requires authentication.
Dbvisit Replicate Installation Guide and User Manual © Dbvisit Software Limited.
Except as specifically set out the Dbvisit license agreement, nothing in this Documentation constitutes a warranty as to the operation of the Dbvisit software.
page 68
MAILCFG_FROM
The From address to be used in outgoing emails
MAILCFG_PORT
The SMTP port to be used (default is the usual 25; however, the usual value for SSL-enabled SMTP server is 465).
MAILCFG_SMTP_SERVER
Sets SMTP mail server to be used for sending emails.
MAILCFG_USE_SSL
Use SSL protocol for the SMTP server (yes/no, default no).
MEMORY_LIMIT_MINE_MB
Memory limit for mine, specified in megabytes. NB that these figures does not include overhead of Perl and of system malloc(), thus do not set it to consume all of your available memory. It does not use ulimit or other
OS-based limits. Settings this too low will cause mine to abort.
MEMORY_LIMIT_APPLY_MB
Memory limits for apply, specified in megabytes. NB that these figures does not include overhead of Perl and of system malloc(), thus do not set it to consume all of your available memory. It does not use ulimit or other
OS-based limits. Setting this low may cause performance degradation, setting it too low will cause apply to abort.
MINE_ASM
SID for ASM (usually +ASM). Note that on RAC, this must be set to the local ASM node name (e.g. +ASM2).
MINE_DATABASE
Mine database TNS connection string.
MINE_LISTEN_INTERFACE
Network interface on which mine listens for commands (hostname:port).
MINE_PASSWORD
Encrypted fetcher database password. (Use ENCRYPT command to get encrypted password from the plain text password.)
MINE_PEER
What is the corresponding mine for this process? If SIMPLE_CONFIG = YES, this is simply set to MINE.
MINE_PLOG
Template for plog files generated on mine.
MINE_REMOTE_INTERFACE
Where to connect to reach this mine process. This is usually same as MINE_LISTEN_INTERFACE, but may be changed if the name resolution works differently among the machines, listen binds to selected interfaces only, etc. Note that this settings is used by the console, too.
MINE_SCHEMA
Database schema containing the repository tables (usually same as MINE_USER).
MINE_STAGING_DIR
Directory where to store redologs received from fetcher.
MINE_TRACE
OFF (default) or trace file name template. Trace file can be compared with trace file generated by Oracle alter system dump logfile.
Dbvisit Replicate Installation Guide and User Manual © Dbvisit Software Limited.
Except as specifically set out the Dbvisit license agreement, nothing in this Documentation constitutes a warranty as to the operation of the Dbvisit software.
page 69
MINE_UNIQUE_ID
Unique ID of mine, regenerated every time the mine dictionary is recreated, e.g. when scripts created by setup wizard are re-run. This ID uniquely identifies the plogs, so they do not get mixed up between different replications.
MINE_USER
Mine database login username.
NETWORK_QUALITY
(wan/LAN) – autoconfigure network timeouts, compression, transfer block size, etc. to suit slow or fast network.
NETWORK_TRAFFIC_KEY
Common key for network authorization among fetcher, mine, apply and console.
NOTIFY_ALERT_EMAIL
The error notification emails (=all except list progress and heartbeat) are sent to these addresses. Separate multiple addresses by comma.
NOTIFY_ALL_EMAIL
All notifications emails are sent to these addresses. Separate multiple addresses by comma.
NOTIFY_CONFLICT_THRESHOLD
If the number of conflicts on apply exceeds this threshold, an SNMP trap and/or email is sent.
NOTIFY_DAILY_LIST_PROGRESS_TIME24
Times when the overall progress email should be sent. Use 24-hour time format, separate multiple times by colon, e.g. 0700 or 0800:2000. Note that times near to midnight may be skipped, if no check gets scheduled till midnight (see also NOTIFY_INTERVAL_BETWEEN_CHECKS).
NOTIFY_EXCEED_CYCLE_NUM
How many times must be a notification condition be met before the SNMP trap / email is actually sent.
(default:2)
NOTIFY_INTERVAL_BETWEEN_CHECKS
How often the notification checks are performed. (Specify seconds, minutes, hours, days, as needed, e.g.
5m or 1h20m30s).
NOTIFY_PEER_DOWN
ALL/colon-separed list: if the specified peer is down, sends an SNMP trap and/or email.
NOTIFY_PROGRES_DIFFERENCE_PERC
If the lag between apply and mine for any table exceeds this threshold, an SNMP trap and/or email is sent.
(This checks the percentage as shown by the LIST PROGRESS command.)
NOTIFY_SCN_DIFFERENCE
SCN difference: if the lag between apply and mine exceeds this threshold, an SNMP trap and/or email is sent.
NOTIFY_SEND_HEARTBEAT_TIME24
Times when the overall heartbeat email should be sent. Use 24-hour time format, separate multiple times by colon, e.g. 0700 or 0800:2000. Note that times near to midnight may be skipped, if no check gets scheduled till midnight (see also NOTIFY_INTERVAL_BETWEEN_CHECKS).
NOTIFY_SEQUENCE_DIFFERENCE
Number of redo logs / plogs: if the lag between apply and mine or mine and fetcher exceeds this threshold, an SNMP trap and/or email is sent.
Dbvisit Replicate Installation Guide and User Manual © Dbvisit Software Limited.
Except as specifically set out the Dbvisit license agreement, nothing in this Documentation constitutes a warranty as to the operation of the Dbvisit software.
page 70
NOTIFY_SUCCESS_EMAIL
The list progress and heartbeat emails are sent to these addresses. Separate multiple addresses by comma.
ON_ERROR
Should errors be treated fatal? Usually used in DDC file so that failed variable checks are clearly pointed out.
SKIP (default): treat normally, EXIT: fatal error.
ON_WARNING
Should warnings be treated fatal? SKIP (default): treat normally, EXIT: fatal error.
ORACLE_HOME
Set this variable for Dbvisit Replicate with the same affect as setting them in the shell environment. Note that
ASM connection use bequeath connection and thus need same ORACLE_HOME as that when ASM actually resides.
ORACLE_SID
Set this variable for Dbvisit Replicate with the same affect as setting them in the shell environment for any
Oracle client.
PLOG_TRACE_SQL_FORMAT
Format of SQL in conflict log table: BIND / NOBIND / BOTH (show SQL statements with bind variables, show
SQL statements with literals, show both).
PROCESS_TYPE
Set type of process to mine/fetcher/apply (this must be set per-process). With SIMPLE_CONFIG, APPLY process is set to APPLY, MINE to MINE and if fetcher is enabled, FETCHER to FETCHER.
PROFILER
OFF / profiler file name. Use only as instructed by support.
RETRY_TIME
Seconds between retries if conflict handling is RETRY.
SETUP_SCRIPT_PATH
Path to setup scripts. Used when packing scripts for support.
SIMPLE_CONFIG
If set to YES, configures processes MINE, FETCHER (if fetcher_enabled) and APPLY. Use for a single oneway configuration.
SNMP_INDEX
Disables/enables SNMP subagent. Also sets the index in the process table presented by the SNMP agent.
(Set to 0 to disable SNMP, set to 1 if there is just one process of that particular type on the machine, set to unique values for each process type if there are multiple processes of the same type)
On Windows, no SNMP agent is supported and thus the only value supported is 0.
SNMP_TRAP_COMMUNITY
Sets community (=password) for sending of SNMP traps.
SNMP_TRAP_DESTINATION
OFF/hostname/hostname:port. Sets destination for SNMP traps (notifications).
STATUS_BAR
Show status bar in console
OFF: no status bar (default)
ON or STATUS: show SCNs and time (default setting by setup wizard)
LIST: show “list progress”
Dbvisit Replicate Installation Guide and User Manual © Dbvisit Software Limited.
Except as specifically set out the Dbvisit license agreement, nothing in this Documentation constitutes a warranty as to the operation of the Dbvisit software.
page 71
LISTALL: show “list progress all”
STATUS+LIST: show both STATUS and LIST
STATUS+LISTALL: show both STATUS and LISTALL
STATUS_BEAT_LCR
How often should be a log message written to log showing number of processed LCRs (in LCR count) (use 0 to disable).
STATUS_BEAT_TIME
How often should be a log message written to log showing number of processed LCRs (in seconds) (use 0 to disable).
STATUS_SORT
Set for each process to specify sort order in status bar. Simple config does this automatically, setting the order FETCHER.STATUS_SORT=01, MINE.STATUS_SORT=02, APPLY.STATUS_SORT=03.
TNS_NAMES
Set this variable for Dbvisit Replicate with the same affect as setting them in the shell environment for any
Oracle client.
TWO_TASK
Set this variable for Dbvisit Replicate with the same affect as setting them in the shell environment for any
Oracle client.
WATCHDOG_TIMEOUT
Timeout for waiting on lock to be released when applying (most notably for TM/TX locks, i.e. waiting for other sessions modifying the same rows). (Waits ½ of this time before aborting due to internal deadlocks etc., waits full time for other users.)
File templates
Where a template is required, specify a full filename including path, utilizing following placeholders:
• %S – sequence
• %T – thread
• %E – extension (hardcoded per file type – plog, log, ...)
• %P – process type (mine, apply, fetcher)
• %N – process name
• %D – DDC_NAME
• %I - process ID (PID)
• %U - six random characters (letters, numbers, underscore)
Internal variables
Additionally, internal variables exist and are denoted by _ (underscore character), e.g. “_INT_SETTING”.
Use only as instructed by support.
Dbvisit Replicate Installation Guide and User Manual © Dbvisit Software Limited.
Except as specifically set out the Dbvisit license agreement, nothing in this Documentation constitutes a warranty as to the operation of the Dbvisit software.
page 72
