Dbvisit configuration
variables (DDC)

Variable Name

Meaning

ORACLE_SID

Name of the Oracle database for which these configuration variables apply. In a RAC environment, this will be the name of the instance.

Example:

    ORACLE_SID = w102n

OWNER

Windows account owner that will run Dbvisit.

It is recommended that this be the same user as the Oracle database owner.

This account must also exist on the standby database server.

Example:

    OWNER = oracle

ORATAB

Only used for Unix/Linux

This file lists the databases present on this server. For Solaris and for some Linux this can be /var/opt/oracle/oratab

For others this is /etc/oratab

Example:

    ORATAB = /etc/oratab

CP

External copy method, to transfer the (archive) log files from the source server to the standby server.

It is recommended to use a secure copy method (scp) or secure ftp (sftp).

The external copy method must be configured so that no password or pass phrase is required.

Example:

    CP = C:\Program Files\Bitvise Tunnelier\sftpc.exe

RSH

External remote shell method for Dbvisit operation.

It is recommended to use SSH (secure shell).

The external remote shell method must be configured so that no password or pass phrase is required.

Example:

    RSH = C:\Program Files\Bitvise Tunnelier\sexec.exe

COMPRESS

The compression method used to compress the (archive) log files.

The following compression options are available:

1.     Dbvisit internal compression.  This uses the zlib compression library. Dbvisit will compress the archives on disk first before transferring to the standby server. This will leave the files on the server in a compressed state.

Set COMPRESS=dbvisit

for Dbvisit internal compression.

2.     SSH compression. This uses the zlib compression library to compress the files as they are being transferred to the standby server. This option is only available if ssh (secure shell) is being for the transfer method. This will leave the files uncompressed on the server.

Set COMPRESS=ssh

for ssh compression.

3.     This turns compression off. Use this option if the network speed is sufficiently fast to transfer uncompressed (archive) log files and disk space is sufficient to hold uncompressed files.

Set COMPRESS=No

for no compression.

Unix/Linux:

For Unix and Linux and alternate external compression method (like gzip or compress) can also be specified.

Examples:

   COMPRESS  = /bin/gzip

   COMPRESS  = /usr/bin/compress

NOTE: It is recommended to disable any other compression routines used to compress the Oracle (archive) log files.

If unsure set compression method to Dbvisit internal compression:

Example:

COMPRESS = dbvisit

UNCOMPRESS

The uncompress method used to uncompress the (archive) log files.

The following options are available:

1.     Dbvisit internal compression.  This uses the zlib compression library. Dbvisit will uncompress the archives on disk first before applying to the standby server. After applying to the standby server, the files will be compressed again to save disk space.

 Set UNCOMPRESS=dbvisit

for Dbvisit internal uncompression.

2.     SSH compression. This uses the zlib compression library to uncompress the files as they are being received on the standby server. This option is only available if ssh (secure shell) is being for the transfer method. This will leave the files uncompressed on the server.

Set UNCOMPRESS=ssh

for ssh uncompression.

3.     This turns compression off.  If compression is turned off, Dbvisit will still recognize if a file is compressed and uncompress the file (using the Dbvisit internal method).

Set UNCOMPRESS=No

for no uncompression.

Unix/Linux:

For Unix and Linux and alternate external compression method (like gzip or compress) can also be specified.

Examples:

   COMPRESS  = /bin/gzip

   COMPRESS  = /usr/bin/compress

NOTE: It is recommended to disable any other compression routines used to compress the Oracle (archive) log files.

If unsure set uncompression method to Dbvisit internal compression:

Example:

UNCOMPRESS = dbvisit

Note: The UNCOMPRESS method must match the COMPRESS method.

ZIP_EXTENSION

The extension of the compressed file. This depends on the compression method used. In most cases this is either:

    .gz (for gzip and Dbvisit internal compression)

    .Z (for compress)

Example:

    ZIP_EXTENSION = .gz

SEND_HEARTBEAT_TIME24

The time that the daily heartbeat alert (email) will be sent.

This is a daily email to ensure that emailing from Dbvisit is active. This will be sent from the primary and standby server.

The time is in 24 hour format and should be between 0000 and 2359 and must be 4 digits. If this variable is not present, an email will be sent at the start of each day (midnight).

Also see the E-Mail setup section.

Example:

    SEND_HEARTBEAT_TIME24 = 0700

TMP

The directory where the Dbvisit temporary and trace files will be located.

Example:

    TMP = C:\temp

    TMP = /usr/tmp

PATH

Path to the server environment.

Windows:

Set to the Windows and Windows command directories.

Example:

    PATH = C:\WINDOWS;C:\WINDOWS\system32

Unix/Linux:

Set to the usual bin directories.

Example:

    PATH = /usr/bin:/bin:/usr/sbin:/usr/local/bin:/sbin

ORACLE_HOME

Specify the Oracle Home of the database.

In most cases this setting is not required as Dbvisit can determine the ORACLE_HOME.

RAC

Determines whether Dbvisit is part of a RAC (Real Application Cluster) configuration or not.

Values are Yes or No

Yes = Dbvisit is part of a RAC configuration over several instances and nodes.

No = Dbvisit is configured for a single instance database.

In a RAC environment there will be a DDC file (dbv_instance_name.env) for every primary instance in the Oracle RAC.

Example:

    RAC = Yes

RAC_TAKEOVER

Determines if Dbvisit processing on this RAC instance takes over Dbvisit processing for another RAC instance (or node), if that instance or node is not available.

All archives must be available to all nodes.

The variable RAC_TAKEOVER_SID determines which RAC instance will be taken over.

The standby database may not be kept up to date if an instance is not available and Dbvisit processing is not taken over by another instance.

Values are Yes or No.

Yes   = Dbvisit (on this instance) will take over from another instance when that instance is unavailable.

No   = Dbvisit (on this instance) will NOT take over from another instance when that instance is unavailable.

If you are not sure, set to Yes.

Example:

    RAC_TAKEOVER = Yes

RAC_TAKEOVER_SID

Specify the instance name that Dbvisit processing should take over if that instance is unavailable.

The instance name must be different to the current instance name.

Example:

    RAC_TAKEOVER_SID = RACDB2

RAC_TAKEOVER_FORCE

Determines if Dbvisit processing on this RAC instance take over Dbvisit processing permanently for another RAC instance (or node).

Dbvisit processing on this RAC instance will take over Dbvisit processing on another RAC instance regardless of whether that node is available or not.

All archives must be available to all nodes.

The variable RAC_TAKEOVER_SID determines which RAC instance will be taken over.

Values are Yes or No.

Yes   = Dbvisit (on this instance) will always take over from another instance.

No    = Dbvisit (on this instance) will NOT take over from another instance unless the instance is not available and RAC_TAKEOVER = Yes.

If you are not sure, set to No.

Example:

    RAC_TAKEOVER_FORCE = Yes

SOURCE

Primary server on which the primary database is installed. Dbvisit software must also be installed on this server.

Example:

    SOURCE = dbvisit11

ORACLE_BASE

Optional directory location. Usually the home of Oracle where the Oracle administration files are kept.

Example:

    ORACLE_BASE = c:\oracle\orabase

LOGDIR

Log directory for Dbvisit logfile associated with the database that it is running for on the primary server.

The usual location is:

ORACLE_BASE\admin\ORACLE_SID\dbvisit

Example:

    LOGDIR = C:\oracle\product\10.2.0\admin\w102n\dbvisit

JOBHIST

Name of the Dbvisit logfile associated with the database that it is running for on the primary server.

The default name is:

dbvisit.hist

Example:

    JOBHIST = dbvisit.hist

PFILE

The location of the Oracle pfile or spfile.

Example:

    PFILE = C:\oracle\product\10.2.0\db_1\database\spfilew102n.ora

DBUSER

The Dbvisit database repository (DDR) owner in the Oracle database.

Example:

    DBUSER = dbvisit

DBPASSWD

The password for the Dbvisit database repository (DDR) owner.

Example:

    DBPASSWD = dbvisitpasswd

ENCRYPT_PASSWDS

Specify whether all passwords should be encrypted in the Dbvisit Database Configuration (DDC) file.
Note: To change ENCRYPT_PASSWDS from Yes to No, the DBPASSWD is required.

Values are Yes or No.

This value cannot be manually edited. Use dbvisit_setup and choose option:
Update the Dbvisit Database configuration (DDC) file.

Yes = Encrypt passwords

No = Do not encrypt passwords

Default is No.

If you are unsure, set to No.

Example:

    ENCRYPT_PASSWDS = Yes

LEAVE_COMPRESS_SOURCE

Specifies whether the log files should be left compressed or not on the primary server AFTER having been transferred to the standby server.

If using RMAN, the log files should be left uncompressed, otherwise RMAN cannot find the logs. If using standard backup software, leave the logs compressed.

Note: Log files will always be sent compressed to the standby server. This setting does not influence that.

Values are Yes or No

Yes = Leave compressed AFTER having being transferred

No = Uncompress log file AFTER having being transferred

 If you are not sure, set to Yes.

Example:

    LEAVE_COMPRESS_SOURCE = Yes

SYNCH_DBVISIT_INSTALL

Specifies whether the Dbvisit software and configuration files should automatically be checked and differences synchronized between primary server and standby server every time Dbvisit executes.

If network connection to your standby server is slow or through the internet, consider turning this off.

If turned off (No), then the Dbvisit installation can be manually synchronised with command:

    dbvisit -c <oracle_database>

Values are Yes or No

Yes = Test and synchronise differences

No = Do NOT test and synchronise differences

 If you are not sure, set to Yes

Example:

    SYNCH_DBVISIT_INSTALL = Yes

Also see setting SYNCH_ENV_FILE_ONLY.

CHECKPOINT

Determines if a database checkpoint should be performed every time Dbvisit executes.

A database checkpoint archives the current redo log.

Values are Yes, No or Ignore.

No = Dbvisit will perform a database checkpoint ONLY when there are no new archive logs to transfer.

Yes = Dbvisit will perform a database checkpoint every time it executes.

Ignore = Dbvisit will never perform a checkpoint.  Use this option with caution as Dbvisit will not be able to guarantee how far behind in time the standby database is.  Only when Oracle performs a checkpoint will Dbvisit transfer the redo log to the standby database.

If you are not sure, set to No.

Example:

    CHECKPOINT = No

SYS_LOGON

Dbvisit does not require an Oracle password as it uses OS authentication.

These variables can be used to enable Dbvisit to logon as sysdba WITH a username and password. This may be required when SQLNET.AUTHENTICATION_SERVICES = (NTS) cannot be set or a password file cannot be used.

SYS_LOGON turns this feature on and off.

Values are Yes or No

Default is No.

If you are not sure, set to No or leave blank.

Example:

    SYS_LOGON = Yes

SYS_USER

Name of the user to logon to the database.

Is only affected if SYS_LOGON = Yes

If you are not sure leave blank.

Example:

    SYS_USER = sys

_SYS_PASSWD

Password of SYS_USER.

Is only affective if SYS_LOGON = Yes and SYS_USER is set.

Example:

    _SYS_PASSWD = not_tiger

Note: if ENCRYPT_PASSWDS = Yes, then the password will be encrypted in the DDC file as follows:

    _SYS_PASSWD = ENCRYPT8F87092545A76234

SYS_LOGON_STRING

The logon string to the database.

Is only affective if SYS_LOGON = Yes and SYS_USER is set.

Default is as sysdba

Example:

    SYS_LOGON_STRING = as sysdba

DESTINATION

Name of the standby server (or standby database server)

Example:

    DESTINATION = dbvisit12

ORACLE_SID_DEST

Optional Oracle standby database name. This may be different to the Oracle primary database name.

ORACLE_HOME_DR

Optional Oracle software location for standby database. Can be used if:

Dbvisit is unable to locate ORACLE_HOME for standby server and ORACLE_HOME on standby server is different to ORACLE_HOME on primary server.

ORACLE_BASE_DR

Optional directory location. Usually the home of Oracle where the Oracle administration files are kept on the standby server.

Example:

    ORACLE_BASE_DR = c:\oracle\orabase

BINDIR_DR

Directory for the dbvisit installation location on the standby server.

This directory must exist on the standby server.

Default location is the same as the on the primary server.

Example:

   BINDIR_DR = C:\program files\dbvisit

LOGDIR_DR

Log directory for Dbvisit logfile associated with the database that it is running for on the standby server.

The usual location is:

ORACLE_BASE\admin\ORACLE_SID\dbvisit

Example:

    LOGDIR_DR = C:\oracle\product\10.2.0\admin\w102n\dbvisit

JOBHIST_DR

Name of the Dbvisit logfile associated with the database that it is running for on the standby server.

The default name is:

dbvisit.hist

Example:

    JOBHIST_DR = dbvisit.hist

ARCHDEST

Directory for (archive) log files on standby server. This is where Dbvisit will place the log files. Note this does not have to be the same location as the log_archive_dest or log_archive_dest_<n> parameter in the database.

If using ASM, this will be the directory where Dbvisit will extract the ASM archive log files to.

It is recommended to also create this directory on the primary server.

Please ensure this directory is not used for any other files other than (archive) log files for this specific database.

Example:

    ARCHDEST = /oracle/oraarch/dbvisitp

    Where dbvisitp is the name of the database

MAX_TIMES_TRIED

Specifies the number of times that Dbvisit should attempt to apply the missing log file before raising an error.

Note this number is also used to raise an error if Dbvisit cannot be started in case a previous scheduled Dbvisit is still running.

Ensure that this number is not too low and not too high.

If you are unsure, set to 4

Example:

    MAX_TIMES_TRIED = 4

LEAVE_COMPRESS_DEST

Specifies whether the log files should be left compressed or not on the source server AFTER being applied on the standby server.

If using RMAN, then the log files should be left uncompressed, otherwise RMAN cannot find the logs. If using standard backup software, leave the logs compressed.

Values are Yes or No

Yes = Leave compressed AFTER being applied

No  = Uncompress log file AFTER being applied

If you are not sure, set to Yes.

Example:

    LEAVE_COMPRESS_DEST = Yes

ADD_DATAFILE

If a new datafile is added to the primary database to increase space or when adding a new tablespace, then Dbvisit can automatically add this datafile to the standby database.

Values are Yes or No.

Yes = Dbvisit will automatically add new datafiles

No= Dbvisit will not add new datafiles

If you are unsure, set to Yes.

Example:

    ADD_DATAFILE = Yes

ADMINS

The administrator email address(es) where emails will be sent upon success or failure of Dbvisit. Multiple emails should be separated with a comma (,). Also see SUCCESS_MAILTO.

Example:

    ADMINS = alert@mycompany.com,dba@mycompany.com

SUCCESSMAIL

Specifies when Dbvisit should send an email from the primary server.

Values are Yes or No.

Yes = Every time Dbvisit is run an email will be sent.

No = Only when an error occurs or a threshold is exceeded will an email be sent.

It is advisable to initially set to Yes.

Once everything is stable, this setting can be changed to No.

If you are not sure, set to Yes.

Example:

    SUCCESSMAIL = Yes

SUCCESSMAIL_DR

Specifies when Dbvisit should send an email from the standby server.

Values are Yes or No.

Yes = Every time Dbvisit is run an email will be sent.

No = Only when an error occurs or a threshold is exceeded will an email be sent.

It is advisable to initially set to Yes.

Once everything is stable, this setting can be changed to No.

If you are not sure, set to Yes.

Example:

    SUCCESSMAIL_DR = Yes

MAILCFG_MAIL_CLIENT

Specifies the mail client. Default is to use internal Dbvisit mail client. The Dbvisit internal mail client requires a smtp mail server to send emails.

Other mail clients can be specified. Example: mail, sendmail or javamail.

For sendmail:

Sendmail does not need to be running in order to send mail from this server. Only when receiving mail on this server does it need to be running.

Sendmail does need to be configured to in order to send mail.

If the Dbvisit mail client is to be used, specify "Dbvisit".

Example:

    MAILCFG_MAIL_CLIENT= dbvisit

MAILCFG_FROM

Specifies the FROM email address of the primary server (optional).

If this is not specified, the emails may not arrive.

Example:

    MAILCFG_FROM = server1@dbvisit.com

MAILCFG_FROM_DR

Specifies the FROM email address of the standby server (optional).

If this is not specified, the emails may not arrive.

Example:

    MAILCFG_FROM_DR = server2@dbvisit.com

MAILCFG_SMTP_SERVER

Specifies the smtp server to send the email to. Is only used if the mail client is Dbvisit. Is not required when the mail client is sendmail.

Sample:

- mail.dbvisit.com

- smtp.dbvisit.com

Example:

    MAILCFG_SMTP_SERVER = mail.dbvisit.com

MAILCFG_SMTP_SERVER_DR

Optional smtp mail server for the standby server.

Only used if smtp mail server for the standby server differs from the main smtp mail server (MAILCFG_SMTP_SERVER).

Sample:

- mail.dbvisit.com

- smtp.dbvisit.comExample:

    MAILCFG_SMTP_SERVER = mail-dr.dbvisit.com

ARCHSOURCE_MANAGEMENT

Specifies if the AMM module to manage the archive log files is turned on or off on the primary server.

Values are Yes or No

Yes = Turn on AMM on primary server.

No = Turn off AMM on primary server.

If you are not sure, set to Yes.

Example:

    ARCHSOURCE_MANAGEMENT= Yes

DAYS_TO_KEEP_ARCHSOURCE

Specifies the number of days to keep the Oracle log files on the primary server.

After this the log files will be removed from the server.

To disable this setting, set to 0.

If you are not sure, set to 7.

Example:

    DAYS_TO_KEEP_ARCHSOURCE = 7

NUM_ARCHSOURCE_TO_KEEP

Specifies the number of archive log files to keep on the primary server.

Log files greater than this number will be removed (oldest first).

To disable this setting, set to 0.

If you are not sure, set to 0 (disable).

Example:

    NUM_ARCHSOURCE_TO_KEEP = 0

THRESHOLD_ARCHSOURCE

Specifies the threshold in percentage (%) of how much disk space may be taken up by the Oracle log files on disk before an alert is triggered on the primary server.

80 means at 80% disk space full an alert will be triggered.

Please specify threshold as an integer.

If you are not sure, set to 80.

Example:

    THRESHOLD_ARCHSOURCE = 80

DELETE_ARCHSOURCE

Specifies if (archive) log files should be deleted once the percentage threshold (THRESHOLD_ARCHSOURCE) on the primary server is reached.

Once the threshold is reached oldest (archive) log files are deleted first.

The log files WILL have been transferred to the standby server.

(There is no verification that these log files have been backed up).

Values are Yes or No

Yes = Let Dbvisit delete archive log files once percentage threshold is met.

No = Dbvisit will only alert when percentage threshold is met (no log files will be deleted).

If you are not sure, set to No.

Example:

    DELETE_ARCHSOURCE = No

This setting has no influence whether (archive) log files are deleted for DAYS_TO_KEEP_ARCHSOURCE or NUM_ARCHSOURCE_TO_KEEP.

These settings will delete (archive) log files once the percentage threshold is met.

ARCHDEST_MANAGEMENT

Specifies if the AMM module to manage the archive log files is turned on or off on the standby server.

Values are Yes or No

Yes = Turn on AMM on standby server.

No = Turn off AMM on standby server.

If you are not sure, set to Yes.

Example:

    ARCHDEST_MANAGEMENT= Yes

DAYS_TO_KEEP_ARCHDEST

Specifies the number of days to keep the Oracle log files on the standby server.

After this the log files will be removed from the server.

To disable this setting, set to 0.

If you are not sure, set to 7.

Example:

    DAYS_TO_KEEP_ARCHDEST = 7

NUM_ARCHDEST_TO_KEEP

Specifies the number of archive log files to keep on the standby server.

Log files greater than this number will be removed (oldest first).

To disable this setting, set to 0.

If you are not sure, set to 0 (disable).

Example:

    NUM_ARCHDEST_TO_KEEP = 0

THRESHOLD_ARCHDEST

Specifies the threshold in percentage (%) of how much disk space may be taken up by the Oracle log files on disk before an alert is triggered on the standby server.

80 means at 80% disk space full an alert will be triggered.

Please specify threshold as an integer.

If you are not sure, set to 80.

Example:

    THRESHOLD_ARCHDEST = 80

DELETE_ARCHDEST

Specifies if (archive) log files should be deleted once the percentage threshold (THRESHOLD_ARCHDEST) on the standby server is reached.

Once the threshold is reached oldest (archive) log files are deleted first.

The log files WILL have been applied to the standby database.

(There is no verification that these log files have been backed up).

Values are Yes or No

Yes = Let Dbvisit delete archive log files once percentage threshold is met.

No = Dbvisit will only alert when percentage threshold is met (no log files will be deleted).

If you are not sure, set to No.

Example:

    DELETE_ARCHDEST = No

This setting has no influence whether (archive) log files are deleted for DAYS_TO_KEEP_ARCHDEST or NUM_ARCHDEST_TO_KEEP.

These settings will delete (archive) log files once the percentage threshold is met.

SUCCESS_MAILTO

This is used to separate the success emails from the failure emails. If set, then all successful Dbvisit emails will be sent to this email address. Failure or unsuccessful emails will be sent to the email address specified by ADMINS. If not set, then all emails will go to ADMINS.

Example:

    SUCCESS_MAILTO=success@mycompany.com

DB_CONNECTION_MODE

Determines the type of connection Dbvisit makes to the database on the primary server.

Values are dedicated or shared.

Dedicated is the default.

- Dedicated

By default Dbvisit connects with the dedicated connection mode. The dedicated connection mode initiates a database connection each time information is requested from the database. The connection is closed after each request.

- Shared

A database connection is opened once at the start of Dbvisit. This connection is used (shared) for all information requested from the database.  At the end of Dbvisit processing, the connection is closed.

If the time taken to establish a database connection is too long, Dbvisit may be optimised to improve performance by setting DB_CONNECTION_MODE = shared. The connection to the database is then only made once.

If you are not sure set to dedicated.

Example:

DB_CONNECTION_MODE = shared

DB_CONNECTION_MODE_DR

Determines the type of connection Dbvisit makes to the database on the standby server.

Values are dedicated or shared.

Dedicated is the default.

- Dedicated

By default Dbvisit connects with the dedicated connection mode. The dedicated connection mode initiates a database connection each time information is requested from the database. The connection is closed after each request.

- Shared

A database connection is opened once at the start of Dbvisit. This connection is used (shared) for all information requested from the database.  At the end of Dbvisit processing, the connection is closed.

If the time taken to establish a database connection is too long, Dbvisit may be optimised to improve performance by setting DB_CONNECTION_MODE_DR = shared. The connection to the database is then only made once.

If you are not sure set to dedicated.

Example:

DB_CONNECTION_MODE_DR = shared

IGNORE_ARCH_HIST

Default value: No

Possible values: Yes, No

Yes = Use Dbvisit own internal mechanism to find the next available log to transfer.

No = Use Oracle controlfile information to find the next available log file. If this information is no longer available in the controlfile, default to using Dbvisit’s own internal mechanism.

If you are not sure, set to No.

During initial Dbvisit testing, setting this to Yes is useful, as the archive log file to transfer to the standby database is not always easily available in Oracle, especially if there has been a network outage and the standby database has not been updated for a while.

Example:

    IGNORE_ARCH_HIST=No

USE_STORE_ARCH_SEQ

Graceful Switchover only

Set to Yes if during initial Graceful Switchover testing Oracle cannot find new archives to recover database.

Possible values: No, Yes

Example:

    USE_STORE_ARCH_SEQ=No

FLASH_ARCH_DIRNAME

Name of the directory used by Oracle for flash_recovery area for archive logs.

Default value: archivelog

Example:

    FLASH_ARCH_DIRNAME=archivelog

FLASH_DIR_NUM

How many days to go back to look for archive logs in flash recovery area. Each day will have a new directory in the flash recovery area.

Default value: 40

Example:

    FLASH_DIR_NUM=40

FLASH_DIR_FORMAT

Format of the archive log directory when using flash recovery area. Standard a directory will be created for every day to hold the archives. This variable dictates the date format of the day directory.

Default value: YYYY_MM_DD

Example:

    FLASH_DIR_FORMAT=YYYY_MM_DD

FORCE_FLASH_AREA

Force the use of the flash_area or DB_RECOVERY_FILE area. Only necessary when Dbvisit does not recognize a flash area is in use. 

Yes    = Force flash area.

No     = Let Dbvisit determine to use flash area or not.

Ignore = Ignore flash area when Dbvisit has detected flash area.

Example:

    FORCE_FLASH_AREA=No

FLASH_ARCHIVE_LOG_FORMAT

Default log_archive_format for when flash area is being used.

The log_archive_format specified in v$parameter is ignored and a default is being used. This parameter allows tuning off the default parameter when Dbvisit is not able to determine the default parameter.

Default value: *_%t_%s_%r.arc

Example:

    FLASH_ARCHIVE_LOG_FORMAT=*_%t_%s_%r.arc

ARCHLOG_PREFIX

The archive log may be renamed by another process or in some cases Oracle prefixes the archive with the word "arch". If this happens, Dbvisit may not be able to identify the archive log. Setting this parameter ensures that Dbvisit can identify the archive log name.

Default value: arch

Example:

    ARCHLOG_PREFIX=arch

RESYNCH_SEQ_OFFSET

This determines the archive log sequence offset when Dbvisit resynchs with the standby database. A value of 1, means the standby sequence will be offset with -1 and the first sequence is resent.

Default value: 1

Example:

    RESYNCH_SEQ_OFFSET=1

ALERT_ON_WARNING

Normally Dbvisit will only alert on errors and then stop processing. Dbvisit will not alert on warnings.

Possible values: No, Yes

Yes = Dbvisit will alert on warnings and stop processing.

No = Dbvisit will alert on errors only and stop processing. Warnings will be displayed in the Dbvisit log file.

Default value: No

Example:

    ALERT_ON_WARNING = No

IGNORE_RESETLOG_ID

Ignore the %r parameter in the log_archive_format. This may be used if Dbvisit fails to recognize the log archive format, or Dbvisit is unable to obtain the Resetlogs Id.

Possible values: Yes, No

Default value: No.

Example:

    IGNORE_RESETLOG_ID = No

THREAD_SOURCE

If set to Yes, the THREAD number from the instance is obtained to determine the next archive to send. This may be set to Yes if Dbvisit fails to recognize the archive log sequence.

Default value: No

Possible values: Yes, No

For RAC this is always set to Yes.

Example:

    THREAD_SOURCE=No

THREAD_DEST

If set to Yes, the THREAD number from the instance is obtained to determine the next archive to apply. This may be set to Yes if Dbvisit fails to recognize the archive log sequence. For RAC this is always set to Yes.

Default value: No

Possible values: Yes, No

Example:

    THREAD_DEST=No

SHOW_TRACEFILE_NAME

Determines when to show the tracefile name.

Possible values: Yes, No 

Yes = Will show tracefile name in alerts, errors and success emails.

No  = Will show tracefile name in alerts and errors.

Default value: No

Example:

    SHOW_TRACEFILE_NAME=No

SHOW_TIME_IN_TRACE

Shows the timestamp in the trace file. There is no significant overhead in displaying the timestamp in the trace file.

Possible values: Yes, No

Yes = Will show current timestamp on every line in tracefile.

No = Will not show timestamp in tracefile.

Default value: Yes

Example:

    SHOW_TIME_IN_TRACE=Yes

LOG_SWITCH_WAIT_IN_SEC

Wait in seconds to allow log switch to occur. If it is found that the archives are not yet completely written to when Dbvisit tries to transfer them to the standby server, then this parameter may be increased.

If Oracle has not completed the log switch before Dbvisit attempts to compress and transfer the logs, Dbvisit will raise an error message.

Default value: 3

Example:

    LOG_SWITCH_WAIT_IN_SEC=3

LD_LIBRARY_PATH

Sets the library path. This is needed for some versions of Oracle. Not needed for Windows. Do not include the ORACLE_HOME in the path. This will be done automatically.

Default value: none

Example:

    LD_LIBRARY_PATH=/usr/dt/lib;/usr/openwin/lib

FORCE_SYSDBA

Determines how Dbvisit will connect to the database to perform its actions.

Possible values: Yes, No

Yes = Dbvisit will connect as sysdba. The DBUSER schema will not be used to connect to the database,

No = Dbvisit will connect with Dbvisit database repository (DDR) user.

Dbvisit will always connect to the database as sysdba to stop and start the database and to get the status of the database. Dbvisit will always connect to the standby database with sysdba.

Default value: No

Example:

    FORCE_SYSDBA=No

ALT_ARCH_LOCATION

This may be added if an alternate LOG_ARCHIVE_DEST is required. Standard, Dbvisit uses the Oracle LOG_ARCHIVE_DEST parameters to determine the location of the archive log files.

If ALT_ARCH_LOCATION is set, then a process must be in place to copy the archive log files from the default LOG_ARCHIVE_DEST to the alternate location, otherwise Dbvisit will not be able to find the archive log files.

Default value: None

Example:

    ALT_ARCH_LOCATION=/oracle/oraarch/altlocation/

    ALT_ARCH_LOCATION=c:\oracle\oraarch\altlocation\

SEND_MAIL_FLAG

SEND_MAIL_FLAG_DR

Description: Determines if Dbvisit will use email for alerting.

Default value: Yes

Possible values: Yes, No

Yes = Dbvisit will email.

No = Dbvisit will NOT email.

SEND_MAIL_FLAG is for both primary server and standby servers.

SEND_MAIL_FLAG_DR is only for the standby server.

If SEND_MAIL_FLAG_DR is not set then SEND_MAIL_FLAG will apply to both primary and standby servers.

Warning: If set to No, Dbvisit will not send any notification when an alert is triggered.

Default value: Yes

Example:

    SEND_MAIL_FLAG=Yes

    SEND_MAIL_FLAG_DR=No

SEND_HEARTBEAT

SEND_HEARTBEAT_DR

Determines if a daily heart beat message is sent to ensure Dbvisit is still scheduled.

Possible values: Yes, No

Yes = Dbvisit sends daily heartbeat email.

No = Dbvisit will not send daily heartbeat email.

Warning: If set to No, you must have an alternative method to ensure Dbvisit is processing is active.

SEND_HEARTBEAT is used for the primary server.

SEND_HEARTBEAT_DR is used for the standby server.

Default value: Yes

Example:

    SEND_HEARTBEAT=Yes

    SEND_HEARTBEAT_DR=No

LOGGING_LEVEL

Determines the level of logging for the Dbvisit log file.

Default value: all

The values are:

all = All messages will be logged.

important = Only important messages will be logged, the following messages will NOT be logged:

  - Log not found on standby database

  - Dbvisit still running

   - Dbvisit pre-processing completed

   - Dbvisit post-processing completed

   - Schedular heartbeat message sent

   - Duplicate compressed file found

Example:

LOGGING_LEVEL = important

ARCH_BUSY

Name of lock file to indicate the archive file is in use.

Default value: archive_busy.lck

Example:

    ARCH_BUSY=archive_busy.lck

ARCH_NOT_THERE

Name of file to indicate the archive file is not found.

Default value: arch_not_there.lck

Example:

    ARCH_NOT_THERE=arch_not_there.lck

CHECKFOR_PREV_VERSION

Determines if Dbvisit will perform a check if the database configuration file if from a previous Dbvisit version. Once the database configuration file is updated, this can be set to No.

Possible values: Yes, No

Yes = Dbvisit checks for previous database configuration files every time Dbvisit is executed.

No = Dbvisit will not perform the check.

Default value: Yes

Example:

    CHECKFOR_PREV_VERSION=Yes

COMPARE_CHECKSUM

Determines if Dbvisit will perform a checksum and compare the checksum on the file that has been transferred. If the checksum is not the same, Dbvisit will alert.

Possible values: Yes, No

Yes = Dbvisit will calculate checksum on the file being transferred and will alert if the transferred file  is not the same as the original file. 

No = Dbvisit will not perform a checksum. It is not guaranteed that the transferred file will be the same as the original file. 

Default value: Yes

Example:

    COMPARE_CHECKSUM=Yes

REMOVE_TEMP_FILES

Determines if Dbvisit temporary files should be deleted after Dbvisit processing.

Possible values: Yes, No

Yes = Dbvisit temporary files will be deleted.

No = Dbvisit temporary files will NOT be deleted.

Default value: Yes

Example:

    REMOVE_TEMP_FILES=Yes

TRANSFER_RETRIES

Determines the number of retries when the checksum of the transferred log file does not match the original file. When the checksum does not match, the file will be transferred again. If the checksum does not match after TRANSFER_RETRIES attempts, an alert will be raised.

Default value: 2

Example:

    TRANSFER_RETRIES=2           

SYNCH_ENV_FILE_ONLY

Variable SYNCH_DBVISIT_INSTALL=Yes must be set for this setting to be active.

Possible values: Yes, No

No = Complete Dbvisit installation and configuration (DDC) file will be synchronised everytime Dbvisit executes.

Yes = Only Dbvisit database configurational (DDC) file will be synchronised everytime Dbvisit executes.

Note: The complete Dbvisit installation can be synchronised with the dbvisit -c <database_name> command.

Example:

   SYNCH_ENV_FILE_ONLY=Yes

EMAIL_LOG_GAP_REPORT

Determines if the Dbvisit log gap report will be emailed. When Dbvisit is run with the inspect command (dbvisit -i) the Dbvisit log gap report will be displayed. Setting this to Yes will email this report to the email address specified by ADMINS. The Dbvisit log gap report will always be written to the Dbvisit database repository (DDR).

Possible values: Yes, No

Yes = Email the Dbvisit log gap report to the email address specified by ADMINS.

No = Do not email the Dbvisit log gap report.

Default value: Yes

Example:

    EMAIL_LOG_GAP_REPORT=Yes

SEND_LOG_GAP_WITH_HEARTBEAT

Possible values: Yes, No

Yes = Include the Dbvisit log gap report in the daily heartbeat email that is sent from the primary server.

No = Do not include the Dbvisit log gap report in the daily heartbeat email.

Default value: No

Example:

    SEND_LOG_GAP_WITH_HEARTBEAT=Yes

SEND_HEARTBEAT2_TIME24

Specifies the time at which a second heartbeat message is sent.

This is a second daily email to ensure that emailing from Dbvisit is active. This will be sent from the primary and standby servers. The time is in 24 hour format and should be between 0000 and 2359 and must be 4 digits.

This variable has the same as function as

- SEND_HEARTBEAT_TIME24.

Example:

SEND_HEARTBEAT_TIME24 can be set to 0700 (7 am)

SEND_HEARTBEAT2_TIME24 can be set to 1600 (4 pm)

HOSTNAME_CMD

If Dbvisit is part of a cluster and a different hostname should be used instead of the regular hostname returned by the current server, then this variable can be used to specify a command to set the hostname for Dbvisit.

For example:

When Dbvisit is used in a cluster and the virtual cluster name should be used instead of the physical hostname.

Sample:

HOSTNAME_CMD=/usr/local/bin/hostname.sh

If the HOSTNAME_CMD file is specified but does not exist on the server, then Dbvisit ignores the HOSTNAME_CMD and uses the regular method to obtain the hostname of the server. This is useful if the standby server is a regular server and the default hostname is sufficient.

KEEP_ORIG_FILE_BEFORE_COMPRESS

Only applies if Dbvisit internal compression method is used.              When set to yes, Dbvisit will keep the original file as well as the compressed file after compression. If set to no, Dbvisit will delete the original file after compression and keep the compressed file.

Sample:

KEEP_ORIG_FILE_BEFORE_COMPRESS=Yes

LOCK_MAX_TIME_SEC

If Dbvisit detects a lock on a file that it is trying to process, this parameter specifies the maximum wait in seconds Dbvisit will retry the lock.

If the file is still locked after LOCK_MAX_TIME_SEC, then Dbvisit will raise an alert.

Sample:

LOCK_MAX_TIME_SEC=10

LOCK_RETRY_TIMEOUT_MILLISEC

If Dbvisit detects a lock on a file that it is trying to process, this parameter specifies the wait in milliseconds before Dbvisit will attempt to access the file again. On some platforms the minimum timeout time may be 1 second.

Sample:

LOCK_RETRY_TIMEOUT_MILLISEC=500

NUM_TRACE_TO_KEEP

Specifies the number of Dbvisit trace files to keep. Trace files are generated every time Dbvisit is executed. Trace files are only used for Dbvisit support. Dbvisit will delete trace files greater than this number. Deletes oldest trace file first.  Works in conjunction with DAYS_TO_KEEP_TRACE.

Least restrictive setting applies between DAYS_TO_KEEP_TRACE and NUM_TRACE_TO_KEEP. To turn off, set to 0.

Sample:

NUM_TRACE_TO_KEEP=100

DAYS_TO_KEEP_TRACE

Specifies the number of days to keep Dbvisit trace files. Trace files are generated every time Dbvisit is executed. Trace files are only used for Dbvisit support. Dbvisit will delete trace files that are older. Works in conjunction with NUM_TRACE_TO_KEEP. Least restrictive setting applies between DAYS_TO_KEEP_TRACE and NUM_TRACE_TO_KEEP. To turn off, set to 0.

Sample:

DAYS_TO_KEEP_TRACE=10

SSH_PORT

Used to specify a different ssh port to the default 22.

If no value is supplied then the default of 22 is used.

Sample:

SSH_PORT=2200

CP_OPTIONS

Allow for different secure copy (scp) options.

For example (Unix/Linux):

    -l limit

Limits the used bandwidth, specified in Kbit/s

See man scp in Unix and Linux for scp options.

 See sftpc on Windows for scp options.

Sample:

CP_OPTIONS=-l 100

RSH_OPTIONS

Allow for different secure shell (ssh) options.

For example (Unix/Linux):

    -l login_name

Specifies the user to log in as on the remote machine. 

See man ssh in Unix and Linux for ssh options.

See sexec on Windows for ssh options.

Sample:

RSH_OPTIONS=-l oracle2

INITIATE_DBVISIT_ON_STANDBY

Setting this to Yes will initiate Dbvisit on the standby server as the last step of running Dbvisit on the primary server.

Setting this to Yes, will mean Dbvisit should no longer be scheduled on the standby server (as it is now initiated from the primary server).

Dbvisit will no longer function as two independent processes with independent alerting and a new strategy must be in place to ensure that notification is received in case of a failure.

It is therefore recommended to set ARCHIVE_LOG_GAP_THRESHOLD or TRANSFER_LOG_GAP_THRESHOLD and to schedule the Dbvisit log gap report (dbvisit -i) on the primary to alert if the standby database gets too far behind the primary database.

Warning: Only set this to Yes if you understand the implications.

Sample:

 INITIATE_DBVISIT_ON_STANDBY=Yes

ALERT_IF_STDBY_READ_ONLY

When standby database is in READ ONLY mode, the latest changes cannot be applied. This setting determines the action taken when Dbvisit is run on the standby server.

Yes = Dbvisit will alert if standby database is in READ ONLY mode and Dbvisit is run to apply archive logs (Default).

No = Dbvisit will NOT alert if standby database is in READ ONLY mode and Dbvisit is run to apply archive logs. Dbvisit will exit normally with a message in the Dbvisit log file.

Default value: Yes

Sample:

ALERT_IF_STDBY_READ_ONLY=No

ARCHIVE_LOG_GAP_THRESHOLD

TRANSFER_LOG_GAP_THRESHOLD

Dbvisit will alert if the log gap from the Dbvisit log gap report (dbvisit -i) exceeds these values (set to 0 to turn off).

ARCHIVE_LOG_GAP_THRESHOLD is the difference between the last archived sequence on the primary and the last applied sequence on the standby database. The archive log gap should be near 0 (except when APPLY_DELAY_LAG_MINUTES is used).

TRANSFER_LOG_GAP_THRESHOLD is the difference between the last archived sequence on the primary and the last sequence transferred to the standby server. The transfer log gap should be near 0.

The dbvisit -i <database> command must be scheduled for these settings to be effective.

Sample:

ARCHIVE_LOG_GAP_THRESHOLD = 0

TRANSFER_LOG_GAP_THRESHOLD = 4

LOG_FILE_ROTATE_MAX

LOG_FILE_SIZE_MAX_MB

Dbvisit log files are will automatically according to these settings.

LOG_FILE_ROTATE_MAX indicates how many backups are made of the log files before it is overwritten.

The first backup will be dbvisit_hist.log.1

The second backup will be dbvisit_hist.log.2

etc.

LOG_FILE_SIZE_MAX_MB indicates the size of the log file before the log file is rotated as above.                             

Sample:

LOG_FILE_ROTATE_MAX = 5

LOG_FILE_SIZE_MAX_MB = 5

AUTO_START_STANDBY_DB

Automatically start the standby database if standby database is down and dbvisit -i or dbvisit -R command is given on the primary server. These Dbvisit commands require the standby database to be up. Setting AUTO_START_STANDBY_DB = Yes ensures the standby database will be up.

Default value: Yes

Sample:

AUTO_START_STANDBY_DB=Yes

APPLY_DELAY_LAG_MINUTES

This creates a lag time in minutes between the archiving of a redo log at the primary database and the application of the log on the standby database.

Note that the archive logs are still transferred to the standby          server as normal without delay.

When this variable is > 0, MAX_TIMES_TRIED can no longer            be relied on to alert when there are no new archives to be applied to the standby database. Use TRANSFER_LOG_GAP_THRESHOLD instead for alerting.

To turn off APPLY_DELAY_LAG_MINUTES, set to 0.

Sample:

APPLY_DELAY_LAG_MINUTES=100

MAILSUBJECT_PREFIX_LOG_GAP_REPORT

MAILSUBJECT_PREFIX_SUCCESSFUL

MAILSUBJECT_PREFIX_HEARTBEAT

These variables can be used to set a prefix for the email subject line. This can then be used to set filtering rules for emails.

For example by setting MAILSUBJECT_PREFIX_LOG_GAP_REPORT = 53

The result will be:

"53 - Dbvisit report for PRODB: Transfer log gap: 0 Archive log gap: 0"

MAILSUBJECT_PREFIX_LOG_GAP_REPORT is for the archive log gap report.

MAILSUBJECT_PREFIX_SUCCESSFUL is for the Dbvisit success email.

MAILSUBJECT_PREFIX_HEARTBEAT is for the Dbvisit heartbeat email.

Sample:

MAILSUBJECT_PREFIX_LOG_GAP_REPORT=53

MAILCFG_AUTH_USER

MAILCFG_AUTH_PASSWD

MAILCFG_CC

MAILCFG_BCC

MAILCFG_ATTACH_TRACEFILE

MAILCFG_ATTACH_TRACEFILE_MAX_SIZE_IN_BYTES

MAILCFG_SENDMAIL_CLIENT

MAILCFG_PORT

MAILCFG_DEBUG

MAILCFG_TIME_OUT

MAILCFG_AUTH_USER is for SMTP authentication (username).

MAILCFG_AUTH_PASSWD is for SMTP authentication (password).

MAILCFG_ATTACH_TRACEFILE is to specify whether to attach trace files to error emails so that these can be forwarded to Dbvisit support.

MAILCFG_PORT is to specify another smtp port.

MAILCFG_SENDMAIL_CLIENT is to specify another sendmail client. Full path must be provided. MAILCFG_MAIL_CLIENT must be set to sendmail for this to take effect.

MAILCFG_TIME_OUT is the specify smtp timeout.

MAILCFG_DEBUG is to turn on smtp debug messages.

MAILCFG_ATTACH_TRACEFILE_MAX_SIZE_IN_BYTES is to specify a file size limit to attaching the trace file.

Sample:

           MAILCFG_ATTACH_TRACEFILE = No

           MAILCFG_PORT = 26

           MAILCFG_TIME_OUT = 5

           MAILCFG_DEBUG = 1

           MAILCFG_SENDMAIL_CLIENT =

                                           C:\\programs\\sendmail.exe

SWITCHOVER_TIMEOUT_IN_SEC

SWITCHOVER_WAIT_IN_SEC

SWITCHOVER_TIMEOUT_IN_SEC is the maximum time in seconds that Dbvisit will wait for response from the other server during graceful switchover ONLY.

SWITCHOVER_WAIT_IN_SEC is the time interval in seconds between Dbvisit polling the other server for a response during graceful switchover ONLY.

Default value:

SWITCHOVER_TIMEOUT_IN_SEC = 1500

SWITCHOVER_WAIT_IN_SEC = 5

Sample:

    SWITCHOVER_TIMEOUT_IN_SEC = 3000

    SWITCHOVER_WAIT_IN_SEC = 10

DBV_PRE_PROC

The name of the pre-processing script.  If a different named script should be called, then this variable can be set. If no path name is given the Dbvisit install directory is assumed.

Default value Windows: dbv_pre_processing.cmd

Default value Non Windows: dbv_pre_processing.sh

See the Pre- and post-processing section for more information.

Example:

    DBV_PRE_PROC = rman_backup.cmd

DBV_POST_PROC

If a different named script should be called, then this variable can be set. If no path name is given the Dbvisit install directory is assumed.

Default value Windows: dbv_post_processing.cmd

Default value Non Windows: dbv_post_processing.sh

See the Pre- and post-processing section for more information.

Example:

    DBV_POST_PROC = post_procs_all.cmd

WIN_SERVICE_WAIT

How long in seconds to wait for the Windows Oracle service to start or stop before starting or stopping the database.

Default value: 10

Example:

    WIN_SERVICE_WAIT=10

AMM_PERC_FULL_WAIT_MILLISEC

This is used in the Archive Management Module (AMM) to ensure that the percentage full disk space displays the correct value. For some volume managers it takes a little time to display the correct status after files have been removed. This variables ensures there is some delay before Dbvisit calculates the free space again.

This setting is only used in conjunction with the THRESHOLD_ARCHSOURCE and THRESHOLD_ARCHDEST variables.

Default is 250 milliseconds.

Example:

   AMM_PERC_FULL_WAIT_MILLISEC=250

AMM_START_AFTER_EACH_APPLY

AMM_START_AFTER_EACH_TRANSFER

Use with caution! Archives may be deleted before being applied.

Normally the Archive Management Module (AMM) to manage the        archive log files is started at the end of Dbvisit processing. These variables allow the AMM module to be started during Dbvisit processing. This may be necessary due to space restrictions.

AMM_START_AFTER_EACH_APPLY starts AMM on the standby server after each archive has been applied and not at the end of Dbvisit processing.

AMM_START_AFTER_EACH_TRANSFER starts AMM on the primary server after each archive has been transferred and not at the end of Dbvisit processing.

Important: Normally Dbvisit will apply the archives to the standby database before removing them. By setting   AMM_START_AFTER_EACH_TRANSFER=Yes, this check no longer applies.

Sample:

AMM_START_AFTER_EACH_APPLY=Yes

AMM_START_AFTER_EACH_TRANSFER=No

ORACLE_SID_ASM

ORACLE_HOME_ASM

The ASM instance name and the ORACLE_HOME for the ASM instance name.

Default:
ORACLE_SID_ASM = +ASM

Sample:
ORACLE_SID_ASM = +ASM1
ORACLE_HOME_ASM=/oracle/product/11.2.0/

SWITCHOVER_TIMEOUT_IN_SEC

Graceful switchover timeout period. This is the wait time in seconds between each step (checkpoint) in graceful switchover before a time out occurs.
If there is no response from the other server after this time, then graceful switchover is cancelled with error code 561.

Default:SWITCHOVER_TIMEOUT_IN_SEC = 1500

Sample:
SWITCHOVER_TIMEOUT_IN_SEC = 3000