2.3 ADD DEFINE
Valid for
GLOBALS
Description
ADD DEFINE
provides the ability to specify valid DEFINE
statements to help with resolution of default locations, file names, or anything that can be set using a standard DEFINE
.
Oracle GoldenGate recommends that you use the defaults, however, if your installation requires that you use other definitions, you can define them in the GLOBALS
parameter file using ADD DEFINE
. By specifying defines in the GLOBALS
parameter file, they are established for all the affected components you install; you don't have to specify them in other parameter files.
Default
ADD DEFINE
changes the following defaults:
-
The default for the Oracle GoldenGate environment prefix,
GGS
. -
The default volume and subvolume for
AUDCFG
,$SYSTEM.GGS.AUDCFG
. -
The default number of seconds the Logger process delays before closing the old file when rolling to a new file.
-
The default volume and subvolume for parameter files,
$VOL.GGSPARM
. -
The default volume and subvolume for report files,
$VOL.GGSRPT
.Note:
Defaults set by
ADD DEFINE
for=GGS_PARAMS
or=GGS_REPORT
can be overridden by the appropriate GGSCIADD
orALTER
command. -
The default TCPIP process name,
$ZTC0
Note:
Defaults set by the
ADD DEFINE
for=TCPIP^PROCESS^NAME
can be overridden by using theTCPIPPROCESSNAME
parameter for Manager or Extract or using theRMTHOST
TCPIPPROCESSNAME
option.
When you create a new volume, subvolume, or file name, you need to specify the new location and file name in the appropriate places, such as when you execute a GGSCI ADD
or ALTER
command, or in any parameter file where you specified a location or file name.
Syntax
ADD DEFINE {define
}, [class_node_vol_spec
]
-
define
-
The
define
must be one of the following:-
=GGS_AUDCFG
-
Changes the default file name of the
AUDCFG
file. -
=GGS_DB_SUBVOL
-
Defines the subvolume location of the Oracle GoldenGate database.
-
=GGS_LOGFILE_CLOSE_DELAY
-
Changes the delay before Logger closes the old file when rolling to a new one. The default is 120 seconds.
-
=GGS_PARAMS
-
Changes the default subvolume used to store parameter files.
-
=GGS_PREFIX
-
Lets you define a different Oracle GoldenGate prefix for process names and subvolumes.
-
=GGS_REPORT
-
Changes the default subvolume used to store the report file.
-
=TCPIP^PROCESS^NAME
-
Changes the default TCPIP process name.
-
-
class_node_vol_spec
-
If you are defining a new volume and subvolume or a file name enter
class_node_vol_spec
as follows:-
To specify a file name, enter:
ADD DEFINE =GGS_
type
, CLASS MAP, FILE \NODE.$volume
.subvolume
.file_name
-
To specify a new default volume and subvolume, enter:
ADD DEFINE =GGS_
type
, CLASS DEFAULTS, VOLUME \NODE.$volume
.subvolume
-
To specify a new prefix, enter:
ADD DEFINE =GGS_PREFIX, CLASS MAP, FILE $
prefix
-
To specify a delay time for closing the log file, enter:
ADD DEFINE =GGS_LOGFILE_CLOSE_DELAY, CLASS MAP, FILE $
x
seconds
Where
FILE
is up to five digits forseconds
andx
can be any character a to z.
-
Examples
- Example 1
-
This example changes the default subvolume used to store parameter files to
$GGSPROD.
ADD DEFINE =GGS_PARAMS, CLASS DEFAULTS, VOLUME \PROD.$DATA3.GGSPROD
- Example 2
-
This example changes the default subvolume used to store the report files.
ADD DEFINE =GGS_REPORT, CLASS DEFAULTS, VOLUME \PROD.$DATA3.NEWRPT
- Example 3
-
This example changes the location of the audit configuration file.
ADD DEFINE =GGS_AUDCFG, CLASS MAP, FILE \NODE.$DATA1.GGS.AUDCFG
- Example 4
-
This example identifies the subvolume where the default database is installed. This is not recommended because moving the database can cause problems when migrating to a new release of Oracle GoldenGate. If Extract, Replicat, or Syncfile are moved to a different subvolume it may be necessary to use the defines since they must know where to find checkpoint files.
ADD DEFINE =GGS_DB_SUBVOL, CLASS DEFAULTS, VOLUME, \PROD.$DATA6.GGS
- Example 5
-
This example sets a delay of 240 seconds for Logger to wait before closing the old file when rolling to a new file.
ADD DEFINE =GGS_LOGFILE_CLOSE_DELAY, CLASS MAP, FILE $a240
- Example 6
-
This example changes the default
$ZTC0
TCPIP process name to$ZTC3
.ADD DEFINE =TCPIP^PROCESS^NAME, FILE $ZTC3
Note:
For more information on working with defines, see Changing Default Component Names.