Validating a Parameter File
The checkprm
validation native command is run from the command line and gives an assessment of the specified parameter file, with a configurable application and running environment. It can provide either a simple PASS
/FAIL
or with optional details about how the values of each parameter are stored and interpreted.
The input to checkprm
is case insensitive. If a value string contains spaces, it does not need to be quoted because checkprm
can recognize meaningful values. If no mode is specified to checkprm
, then all parameters applicable to any mode of the component will be accepted.
The output of checkprm
is assembled with four possible sections:
-
help messages
-
pre-validation error
-
validation result
-
parameter details
A pre-validation error is typically an error that prevents a normal parameter validation from executing, such as missing options or an inaccessible parameter file. If an option value is specified incorrectly, a list of possible inputs for that option is provided. If the result is FAIL
, each error is in the final result message. If the result is PASS
, a message that some of the parameters are subject to further runtime validation. The parameter detailed output contains the validation context, the values read from GLOBALS (if it is present), and the specified parameters. The parameter and options are printed with proper indentation to illustrate these relationships.
Table -1 describes all of the arguments that you can use with the checkprm
commands. When you use checkprm
and do not use any of these arguments, then checkprm
attempts to automatically detect Extract or Replicat and the platform and database of the Oracle GoldenGate installation.
Table -1 checkprm Arguments
Argument | Purpose & Behavior |
---|---|
|
Displays usage information |
|
Displays banner. Cannot be combined with other options. |
|
Displays detailed usage information, include all possible values of each option. Cannot be combine with other options. |
|
Specifies the name of the parameter file, has to be the first argument if a validation is requested. You must specify the absolute path to the parameter file. For example, |
|
Specifies the running component (application) that this parameter file is validated for. This option can be omitted for Extract or Replicat because automatic detection is attempted. Valid values include:
There is no default for this option. |
|
Specifies the mode of the running application if applicable. This option is optional, only applicable to Extract or Replicat. If no mode is specified, the validation is performed for all Extract or Replicat modes. Valid input of this option includes:
When key in the value for this option, the application name is optional, as long as it matches the value of component. For example, |
|
Specifies the platform the application is supposed to run on. The default value is the platform that this The possible values are:
|
|
Specifies the database the application is built against. The default value is the database for your Oracle GoldenGate installation. The database options are (case insensitive):
|
|
Directs It must be the last option specified in a validation. |
Following are some use examples:
checkprm ? checkprm ./dirprm/ext1.prm -C extract -m data pump -p Linux -v checkprm ./dirprm/ext1.prm -m integrated checkprm ./dirprm/rep1.prm -m integrated checkprm ./dirprm/mgr.prm -C mgr -v checkprm GLOBALS -c GLOBALS
Verifying Using CHECKPARAMS
Parameter
An alternative to using the recommended checkprm
utility, is to check the syntax of parameters in an Extract or Replicat parameter file for accuracy using the CHECKPARAMS
parameter. This process can be used with Extract or Replicat.
To Verify Parameter Syntax
For more information about the report file, see Monitoring Oracle GoldenGate Processing.
For more information about CHECKPARAMS
, see Reference for Oracle GoldenGate.
Parent topic: Using Oracle GoldenGate Parameter Files