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
SET APPLY.INSTANTIATE_SCN NOW

If the variable needs to be set back to the global "*" setting, use RESET command.


Variables can also be set with MEMORY_SET, which only sets it in memory and not the DDC file. After a restart of the process the setting will no longer take affect (unless MEMORY_SET is specified in the DDC file).

Variable reference


Internal VariableDescription
APPLY_CASE_CONVERT

When a table is prepared, should the name from MINE be kept as-is, made uppercase, or lowercase? This is honored for case-sensitive databases only (MySQL and MSSQL).

APPLY_COLUMN_NAMES_MAP

Allows global rename of columns. Translates column names on source database to new column names on target database. This is handy if replicating from one database to another type of database (eg MySQL) where a specific column cannot be used because it is a reserved word.

Example: set APPLY_COLUMN_NAMES_MAP PRIMARY=PRIMARY_VALUE

This will rename the column PRIMARY to PRIMARY_VALUE on the target database. 

Multiple columns pairs can be separated with commas: 

set APPLY_COLUMN_NAMES_MAP PRIMARY=PRIMARY_VALUE, ALTER=ALT

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_DATABASE_DBIDDBID (see v$database) of databases where apply connects. The default is empty and the variable is optional; however, it's always set by setup wizard. This helps to check that the connection strings resolve to correct databases as the apply server.
APPLY_DATE_FORMAT 
The output format for dates, timestamps and intervals when using flatfiles. YMD is human-readable like YYYY.MM.DD (+time portion, time zones) or Oracle-like for intervals (+3-2 for year-day). ISO8601 is Java-like 2014-12-05T12:34:56 or P12Y2M.
  • AUTO (default) (Auto is YMD for CSV)
  • YMD
  • ISO8601 (for Avro)

APPLY_FILEOUT_FILE_BATCH_SIZE

The file size for the output file. The file will be closed then this size is reached and the transaction is completed.

Values: integer

Default: 0

Note that file is closed when we get over this size (and then we complete the transaction).

APPLY_FILEOUT_FILE_CSV_COMMA

The field separator for CSV output files.

Default: (empty)

Value: string, with support for escaped chars:

\0 \a \b \t \n \v \f \r \x00 (arbitrary hex number ) \\ (backslash)

APPLY_FILEOUT_FILE_CSV_NEWLINE

The row separator for CSV output files.

Default: (empty)

Value: string, with support for escaped chars:

\0 \a \b \t \n \v \f \r \x00 (arbitrary hex number ) \\ (backslash)

APPLY_FILEOUT_FILE_FORMAT

The file type for the output file.

  • OFF (default)
  • NONE (OFF)
  • CSV
 

APPLY_FILEOUT_FILESYSTEM

The type of filesystem to be written to.

  • FS (Filesystem) (default)
  • HFDS (Hadoop)
APPLY_FILEOUT_HDFS_NAMENODE

The namenode of the Hadoop HDFS. This is the standard protocol how HDFS clients connect.

Default: localhost:9000

Values: host:port

APPLY_FILEOUT_STAGING_DIR

The directory where output files are stored while they are in progress.

Default: OFF

Value: directory + file mask.

Wildcards:

%O table owner

%A table name

%C transaction start SCN

%I object=table id

%X transaction id

%N apply process name

%T process type (=APPLY)

%H thread id

%S plog id

%D ddc name

%E file type (csv/avro)

Note that one file can contain multiple transactions. So %C/%X/%H/%S are determined based on first transaction in the file.

We recommend to use %C to order the output files and add %X for cases when %C is non-unique.

APPLY_FILEOUT_TARGET_DIR 

The directory where output files are stored when they are completed.

Default: OFF

Value: directory + file mask.

Wildcards:

%O table owner

%A table name

%C transaction start SCN

%I object=table id

%X transaction id

%N apply process name

%T process type (=APPLY)

%H thread id

%S plog id

%D ddc name

%E file type (csv/avro)

Note that one file can contain multiple transactions. So %C/%X/%H/%S are determined based on first transaction in the file.

We recommend to use %C to order the output files and add %X for cases when %C is non-unique.

APPLY_IGNORE_ERROR_CODES

Automatically ignore specified Oracle errors (ORA- ).

Values: string (delimited by :)

Default: (empty)

For example, if there is a parent-child relationship and only the parent table is being replicated because the child table does not exist on target, any foreign key constraints being created on the parent-child relationship will be replicated and will result in an ORA-942 table or view does not exist error because the because the add constraint command doesn't find child table it wants to reference to.

Example:

APPLY_IGNORE_ERROR_CODES 942

This will make Apply ignore all ORA-00942 error codes.

Multiple error codes can be delimited by :

Example:

APPLY_IGNORE_ERROR_CODES 942:955

This setting requires a restart of the Apply process.

APPLY_LISTEN_INTERFACENetwork interface on which APPLY listens for commands (hostname:port).

APPLY_MSSQL_USER_DB

Deprecated.

Values: string

Default: (empty)

APPLY_PASSWORD

Encrypted APPLY database password. (Use ENCRYPT command to get encrypted password from the plain text password.)

APPLY_PEERWhat is the corresponding APPLY for this process? If SIMPLE_CONFIG = YES, this is simply set to APPLY.
APPLY_POSTPONE_LAST_LCR
  • YES (default) *
  • NO

If set to YES, then APPLY will postponing the last LCR or SQL until the next SQL for the same object is found. This can sometimes help with (deadlock) locking issues or "APPLY hung" issues. This can also assist if there are killed sessions on the source database and the APPLY is waiting on the detection of the killed process to rollback (or commit).

By setting to YES it means that APPLY is always one SQL behind. This means APPLY always keeps one SQL in each open transaction unapplied. It processes the changes it gets from MINE, but stops short of the last one available so far.

As soon as APPLY receives the commit, it applies even the last SQL. So there is never any data loss, although it can be noticed that APPLY lags behind MINE until the commit arrives. But this is probably most visible for manual test cases (like insert 10.000 rows and see that 9.999 has been applied) because in production systems there is always some activity from the source (and with commits), so this situation is rarely seen.

*The default changed to YES in version 2.8 release only if you rerun the *all.sh script again in 2.8. Otherwise the default will stay NO from the previous run of *all.sh script from 2.5, 2.6, 2.7. The parameter should be changed manually if that is the case.

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_SCHEMAAPPLY database schema (Oracle, usually same as APPLY_USER), schema=database (MySQL), database (MS SQL).
APPLY_SCHEMA2APPLY database schema (SQL Server only).
APPLY_STAGING_DIRDirectory to store received PLOGS on APPLY server.
APPLY_TRACE

OFF (default) or pattern for trace file name. The trace file contains all SQL applied as well as further debugging info.

 

Wildcards:

 

%N apply process name

 

%S plog sequence

 

%E file type extension

Example:

APPLY_TRACE=/home/oracle/d112f/log/trace/%N_%S.%E

This requires a restart of the Apply process.

APPLY_USERAPPLY database login username.
CHECKVARSDisable/enable checking of variable values. Can be: ON (default), OFF, or comma-separated list of variables NOT to check.
DDC_DATABASE_DBID

DBID is the Oracle Database ID that is storing the DDC metadata tables for Dbvisit Replicate. This is checked to make sure that Dbvisit connects to the correct database.

Values: string (something that a user would not normally set)

DDC_BACKUP_DIRIf 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_DATABASETNS 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_IDUnique id of the DDC. This must not change after configuration is complete. Default: 1.
DDC_NAMEName 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_PASSWORDEncrypted ddc db database password. (Use ENCRYPT command to get encrypted password from the plain text password.)
DDC_SCHEMADDC database schema, usually same as DDC_USER.
DDC_USERDDC DB database login username.
DDL_IGNORE_USERAny DDL issued by this user will be ignored. Default: empty. Users are separated by colons. This requires an APPLY restart.
DDL_REPLICATE_GRANTS

If set to YES all grants on the prepared tables will be replicated to the target database. Default value is NO.
Note that dbvrep user on the target database needs to have sufficient privileges to replicate grants, e.g. GRANT ANY OBJECT PRIVILEGE.

DEBUG_LEVEL

Set debugging level. This is bit field. Example 2^32-1 means all bits are enabled.

Example:

DEBUG_LEVEL = 4294967295

 Contact support for possible values.

DELETE_OBSOLETE_PLOGS_AGE

Delete PLOGS after specific time period. Time period can be days (d) or hours(h).

Default: 3d

DELETE_OBSOLETE_PLOGS_SIZE_MB

Delete PLOGS are total size of all PLOGS exceeds size in MB.

Default: 1024

DELETE_OBSOLETE_PLOGS_GZIP

Compress the PLOGS as soon as they are not needed by Dbvisit Replicate anymore.

Default: Yes

DELETE_OBSOLETE_RLOGS_AGE

Delete the redo logs transferred from FETCHER after specific time period. Time period can be days (d) or hours(h).

Default: 3d

DELETE_OBSOLETE_RLOGS_SIZE_MB

Delete the redo logs transferred from FETCHER after total size of all PLOGS exceeds size in MB.

Default: 1024

DELETE_OBSOLETE_RLOGS_GZIP

Compress the redo logs transferred from FETCHER as soon as they are not needed by Dbvisit Replicate anymore.

Default: Yes

DISKSPACE_CHECK_BYTE_LIMIT

Sends a email notification as well as a warning message in the log file when free space on the filesystem goes below this threshold.

Values: integer

Default: 1073741824 (1GB)

DISPLAY_ALL_OBJECTS_IN_LIST_PROGRESS

Show all objects. By default only tables will be shown.

  • NO (default)
  • YES (This may cause all objects to display. Certain objects may still not appear in the console)
DISPLAY_TABLE_NAME_IN_LIST_PROGRESS

What table name to show when rename is used. The valid values are:

  • BOTH (default)
  • SOURCE
  • TARGET
DPUMP_EXCLUDE_STATS

When generating the scripts for export this parameter allows the option to exclude or include statistics.

  • NO (default)
  • YES
DROP_SUPPLEMENTAL_LOG_DATASupplemental logging is dropped by default when UNPREPARING tables. If the parameter is set to NO then supplemental logging will remain on the table after the table is unprepared.
  • YES (default)
  • NO
FETCHER_DATABASEMINE database TNS (when connecting from FETCHER).
FETCHER_DATABASE_DBIDDBID (see v$database) of databases where fetcher connects. The default is empty and the variable is optional; however, it's always set by setup wizard. This helps to check that the connection strings resolve to correct databases = the same ones as the fetcher server.
FETCHER_ENABLEDFETCHER (downstream capture) enabled, this means MINE waits for redologs from FETCHER.
FETCHER_LISTEN_INTERFACENetwork interface on which FETCHER listens for commands (hostname:port).
FETCHER_PASSWORDEncrypted FETCHER database password. (Use ENCRYPT command to get encrypted password from the plain text password.)
FETCHER_PEERWhat is the corresponding FETCHER for this process? If SIMPLE_CONFIG = YES, this is simply set to FETCHER.
FETCHER_REMOTE_INTERFACEWhere 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.
FETCHER_SCHEMASchema of MINE repository (when connecting from FETCHER). Virtually always same as MINE_SCHEMA.
FETCHER_THREADSOn 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_USERMINE database login username (when connecting from FETCHER).

IGNORE_APPLY_DDL_DIFFERENCES

Will ignore differences in the table definition (or if it is missing) between source and target during the prepare phase.

  • NO (default) However this can changed to YES depending on options used in the Setup Wizard
  • YES
INSTANTIATE_SCNDetermines where to initiate the replication from. The valid values are:
  • NOW
  • RESETLOGS (selects the SCN from v$database.resetlogs_scn on the target database)
  • Manually entered SCN number
LICENSE_BAR

Show license info and product version in console

  • ON (default)
  • OFF
LICENSE_KEYLicense key, as obtained by your purchase.
LOG_FILEGeneral process log file location template.
LOG_FILE_TRACEGeneral trace file location template.
LOG_FILE_COUNTThe number of copies of the log that should be kept. The active log will always be called *.log. Once the file is full (see LOG_FILE_SIZE parameter) then a copy of the log will be rotated and saved as *log.1. Any contents saved in *log.1 will be saved as *log.2. The process will continue determined by the value that this parameter is set to. When the default number is reached the last one will be rotated off.

Default: 2
LOG_FILE_DATE_ROTATEIf 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

Note: The values provided above are CASE SENSITIVE, so make sure you provide the values same as above.

LOG_FILE_SIZEApproximate maximum log size in bytes. Once the log exceeds this size the log file will rotate.
Default: 10MB  Set in bytes.
LOG_OBSOLETE_AGE_PLOGWhen 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_RLOGWhen 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.

LOG_PACKAGE_CSV_MAX_AGE

Limits the amount of data from metadata tables for the support package. Data older than (N) days will not be included.

Values: integer (days)

Default: 10

LOG_PACKAGE_TRC_MAX_AGE 

Limits the amount of data from trace files for the support package. Trace files older than (N) days will not be included.

Values: integer (days)

Default: 30

MAILCFG_AUTH_PASSWD
  • 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.
MAILCFG_FROMThe From address to be used in outgoing emails
MAILCFG_PORTThe SMTP port to be used (default is the usual 25; however, the usual value for SSL-enabled SMTP server is 465).
MAILCFG_SMTP_SERVERSets SMTP mail server to be used for sending emails.
MAILCFG_USE_SSLUse SSL protocol for the SMTP server (yes/no, default no).
MEMORY_LIMIT_MINE_MBMemory limit for MINE, specified in megabytes. Note that these figures do 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_MBMemory limits for APPLY, specified in megabytes. Note that these figures do 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_ARCH_DESTDefault is empty. MINE will ONLY look in this directory for archivelogs. This parameter will be used in conjunction with the REDO_READ_METHOD set to ARCHONLY
MINE_ARCH_DEST_FORMATDefault is empty.
Available options: %T_%S_%R %E for standby 
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_ASM OFF

This instructs Dbvisit Replicate to ignore redo logs in ASM and uses the redo logs on the file system (when they are multiplexed). This is useful when using older versions of ASM such as 10.1 as Dbvisit Replicate only supports ASM version 10.2 and higher. 

MINE_DATABASEMINE database TNS connection string.
MINE_DATABASE_DBIDDBID (see v$database) of databases where mine connects. The default is empty and the variable is optional; however, it's always set by setup wizard. This helps to check that the connection strings resolve to correct databases = the same ones from mine server.
MINE_HEARTBEAT_TIME
  • 10 (seconds) (default)
  • If you want to disable this feature set to 0

This parameter determines the frequency of how often an update happens to the DBRSCOMMON_HEARTBEAT table in the dbvrep schema. This table can be used to monitor the state of replication.

MINE_LISTEN_INTERFACENetwork interface on which MINE listens for commands (hostname:port).
MINE_PASSWORDEncrypted FETCHER database password. (Use ENCRYPT command to get encrypted password from the plain text password.)
MINE_PEERWhat is the corresponding MINE for this process? If SIMPLE_CONFIG = YES, this is simply set to MINE.
MINE_PLOGTemplate for PLOG files generated on MINE.
MINE_REMOTE_INTERFACEWhere 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_SCHEMADatabase schema containing the repository tables (usually same as MINE_USER).
MINE_STAGING_DIRDirectory where to store redologs received from FETCHER.
MINE_TRACEOFF (default) or trace file name template. Trace file can be compared with trace file generated by Oracle alter system dump logfile.
MINE_UNIQUE_IDUnique 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_USERMINE database login username.
NCHARSETThis is the national character set of the source database. This is relevant only for NCHAR/NVARCHAR2 columns. Only UTF8 and AL16UTF16 values are supported; Oracle expects Unicode values to be specified in UTF16, so if the source database is using UTF8 (specified by this setting), APPLY does the necessary conversion to UTF16. Any other (legacy) mutlibyte character sets are currently not supported.
NETWORK_QUALITY(wan/LAN) – autoconfigure network timeouts, compression, transfer block size, etc. to suit slow or fast network.
NETWORK_TRAFFIC_KEYCommon key for network authorization among FETCHER, MINE, APPLY and console.
NLS_LANG

The NLS_LANG variable is set at the APPLY environment and behaves like the NLS_LANG environment does: it sets the language, territory and character set of the APPLY session. The language and territory are not very important (they affect things like Oracle error messages shown), the character set must be set to the source database character set, so the any character strings applied are treated correctly according the character set they are in.

Apart from setting the NLS_LANG to a character set. The values of NLS_LANG can also be:

  • KEEP_UNDEF - ignore the NLS_LANG environment setting
  • KEEP - use the NLS_LANG environment setting

Note: These above 2 settings should be set using the "memory_set" and not the "set" command. Example:

memory_set MINE.NLS_LANG=KEEP_UNDEF

This can be set in the MINE ddc file.

Also see NLS Considerations

NOTIFY_ALERT_EMAILThe error notification emails (=all except list progress and heartbeat) are sent to these addresses. Separate multiple addresses by comma.
NOTIFY_ALL_EMAILAll notifications emails are sent to these addresses. Separate multiple addresses by comma.

NOTIFY_CONFLICT_THRESHOLD

If the number of conflicts on APPLY equals or exceeds this threshold, an SNMP trap and/or email is sent. This setting only applies to the number of conflicts since the last restart of the Apply process.

Restarting the Apply process resets the number of conflicts to 0.

Example:

Before restarting the Apply process the number of conflicts is 250

Conflicts:250/250 

After restarting of the Apply process, the number of conflicts is 0

Conflicts:250/0

Value 0 is turning that notification off.

NOTIFY_CONFLICT_CURRENT_PAUSEIf APPLY is waiting on conflict (PAUSE handler), should a notification be sent? (YES/no)
NOTIFY_CONFLICT_CURRENT_RETRYIf APPLY is waiting on conflict (RETRY handler), after how many retries should a notification be sent? (default: 2)
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). This parameter requires a MINE/APPLY restart to take effect.

NOTIFY_EXCEEDED_CYCLE_NUMHow many times must be a notification condition be met before the SNMP trap / email is actually sent. (default:2)
NOTIFY_INCIDENT_LIMIT
  • 10 default
    How many times a notification will be sent out via email for a given incident.
NOTIFY_INTERVAL_BETWEEN_CHECKHow often the notification checks are performed. (Specify seconds, minutes, hours, days, as needed, e.g. 5m or 1h20m30s). Default is 5m.

NOTIFY_ON_DDL

Sends an email when apply replicates a DDL statement.

  • YES (default)
  • NO
NOTIFY_PEER_DOWN

ALL or colon-separated list. If the specified peer is down, sends an SNMP trap and/or email.

Example:

MINE:APPLY:APPLY1

NOTIFY_PROGRESS_DIFFERENCE_PERCIf 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_DIFFERENCESCN difference: if the lag between APPLY and MINE exceeds this threshold, an SNMP trap and/or email is sent. Default is 1000.
NOTIFY_SEND_HEARTBEAT_TIME24Times 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_DIFFERENCENumber 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.
NOTIFY_SUCCESS_EMAILThe list progress and heartbeat emails are sent to these addresses. Separate multiple addresses by comma.
NOTIFY_TIME_DIFFERENCEThe time, in seconds, between MINE and APPLY. If the lag between APPLY and MINE or MINE and FETCHER exceeds this threshold, an SNMP trap and/or email is sent.
OCI_COMMIT_MODE

Commit options for APPLY sessions (target). Can be either 

  • DEFAULT (default)
  • WAIT IMMEDIATE
  • WAIT BATCH
  • NOWAIT IMMEDIATE
  • NOWAIT BATCH 

The default value is DEFAULT, which is the usual behaviour of commit on Oracle. DEFAULT is the only valid option for Oracle 9i. Option is ignored for non-Oracle databases. Consult with support before setting, as some of the non-default values may lead to data loss in some special cases such as RAC. Setting to NOWAIT BATCH means APPLY will not wait for commit redo to be written to disk. This may improve performance of APPLY, but is not recommended for RAC target systems because during a crash of one of the nodes not all the SCN information of the replication will be up to date. And this may cause data loss in the replication. For RAC target systems set to WAIT IMMEDIATE which means commit wait. For Oracle current versions, DEFAULT is the same as WAIT IMMEDIATE.

ON_ERROR

Should errors be treated fatal? Usually used in DDC file so that failed variable checks are clearly pointed out.

  • SKIP (default): continue
  • EXIT: fatal error and stop
ON_WARNING

Should warnings be treated fatal?

  • SKIP (default): continue
  • EXIT: fatal error and stop
ORACLE_HOMESet 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_SIDSet 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 (default)
  • BOTH

BIND = show SQL statements with bind variables

NOBIND = show SQL statements with literals

BOTH = show both

PREPARE_CHECK_APPLY

Should PREPARE command check that the table exists on target database? 

  • NO (default)

  • YES
PREPARE_CHECK_MINE

Should PREPARE command check that the table exists on target? Default: YES. Note that both mine and apply checks also include supported datatypes, for apply we check that the datatypes match with source.

  • YES (default)

  • NO
PREPARE_CHECK_MINE_TABLE_TYPE

Global Temporary Tables will be checked when the PREPARE command is run. Global Temporary Tables will be ignored. If you have a large number of tables you may wish to set the parameter to NO to speed up the PREPARE command, however this may mean that Global Temporary Tables are replicated.

  • YES (default starting in 2.7.12)

  • NO

PREPARE_SCHEMA_EXCEPTIONS

The list of schema.tables to be skipped in PREPARE SCHEMA. This is part of Step 3 in the Setup Wizard if you specify exceptions.

Values: string

Default: (empty)

PROCESS_TYPESet 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. This will generate extra trace files with profiling information that can be used by support to further diagnose issues. This can be turned on for the MINE or APPLY process or both.

Example:
SET PROFILER /home/oracle/..../prof_%S.%E in the DDC file.

Restart the process and wait for a few log switches, then zip and upload the resulting files to support.                       

The specified path can be arbitrary but ensure to include %S in the name so a new file is generated for each log switch. 

Please see Dbvisit Replicate Profile Performance Statistics for more information.

REDO_READ_METHOD

Specify if both online redo logs and archive logs should be used or archive log only (archivelogs only) files exclusively.

  • REDOFIRST (default, use both online redo and archive logs)
  • ARCHONLY (use only archive logs)

Set this in the *MINE.ddc only.

Changing this requires a restart of the MINE process.

RETRY_TIMESeconds between retries if conflict handling is RETRY. (default: 5 seconds)
SESSION_TIMEZONE

This is relevant only if columns of type TIMESTAMP WITH LOCAL TIME ZONE are replicated.

When data is applied, the session time zone is set to the SESSION_TIMEZONE value, so that any TIMESTAMP WITH LOCAL TIME ZONE are properly understood by the target database. The default is auto-detected using “SELECT dbtimezone FROM DUAL” on the source database and thus should be always correct, unless there is a mismatch of timezone files between the databases, when entering an offset from GMT instead of symbolic name might be necessary.

If this value is incorrect, the replicated TIMESTAMP WITH LOCAL TIME ZONE will be off by the timezone difference.

SETUP_SCRIPT_PATHPath to setup scripts. Used when packing scripts for support.
SIMPLE_CONFIGIf set to YES, configures processes MINE, FETCHER (if fetcher_enabled) and APPLY. Use for a single one-way configuration.
STATUS_SHOW_PAST_CONFLICTS

If set to YES, then the APPLY status line in the status bar will show the number of past conflicts even when they are resolved. This is the default.

Example: 
APPLY IS running. Currently at PLOG 2453 and SCN 14696300 (08/16/2012 16:19:17) and 2 APPLY conflicts so far (last at 16/08/2012 15:07:37). 

If set to No, then the APPLY status line in the status bar will only show the current conflict. When they are resolved it will not show past conflicts.

Example:
APPLY IS running. Currently at PLOG 2453 and SCN 14696300 (08/16/2012 16:19:17) 

SNMP_INDEXDisables/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_COMMUNITYSets community (=password) for sending of SNMP traps.
SNMP_TRAP_DESTINATION

Sets destination for SNMP traps (notifications).

  • OFF
  • hostname
  • hostname:port
SOURCE_TIMEZONE

Variable is set automatically when the Setup Wizard is run. This is to determine Oracle datatype Timestamp with LOCAL TIMEZONE.

SQL_QUOTE_IDENTIFIERS

Quote owner/table/column name in apply SQL. Uses "" for Oracle, [] for MSSQL.

  • AUTO (default) Auto means YES for Oracle and MSSQL and NO for MYSQL.
  • YES
  • NO
STATUS_BAR

Show status bar in console

  • OFF: no status bar
  • ON or STATUS: show SCNs and time 
  • LIST: show "list progress"
  • LISTALL: show "list progress all"
  • STATUS+LIST: show both STATUS and LIST (default setting by setup wizard)
  • STATUS+LISTALL: show both STATUS and LISTALL
STATUS_BAR_ACTIVE_TABLESThis is set to a number to limit the number of active tables shown in the status bar. Example: STATUS_BAR_ACTIVE_TABLES = 20
STATUS_BEAT_LCRHow often should be a log message written to log showing number of processed LCRs (in LCR count) (use 0 to disable). As of Dbvisit Replicate 2.3.14 the default is 10,000. Previous default was 1,000. For high volume configurations consider increasing to higher number.
STATUS_BEAT_TIMEHow often should be a log message written to log showing number of processed LCRs (in seconds) (use 0 to disable).
STATUS_SORTSet 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_ADMINMandatory parameter that is set in the wizard. Points to tnsnames.ora/sqlnet.ora to be used to resolve connection strings.
TNS_NAMESSet this variable for Dbvisit Replicate with the same affect as setting them in the shell environment for any Oracle client.
TWO_TASKSet this variable for Dbvisit Replicate with the same affect as setting them in the shell environment for any Oracle client.
WATCHDOG_NOBIND_SQLWatchdog will show SQL with actual values instead of just bind variables
WATCHDOG_TIMEOUTTimeout 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)