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 CHECKPRM executable file can be found in the Oracle GoldenGate installation directory for Classic Architecture and in the /bin directory of Microservices Architecture. 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 8-16 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 8-16 checkprm Arguments

Argument	Purpose & Behavior
`None`	Displays usage information
`-v`	Displays banner. Cannot be combined with other options.
`? \| help`	Displays detailed usage information, include all possible values of each option. Cannot be combine with other options.
`parameter_file`	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, `CHECKPRM ./dirprm/myext.prm`.
`-COMPONENT \| -C`	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: `CACHEFILEDUMP COBGEN CONVCHK CONVPRM DDLCOB DEFGEN EMSCLNT EXTRACT GGCMD GGSCI KEYGEN LOGDUMP` `MGR OGGERR REPLICAT RETRACE` `REVERSE SERVER GLOBALS` There is no default for this option.
`-MODE \| -M`	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: Integrated Extract Initial Load Extract Remote Task Extract Data Pump Extract Passive Extract Classic Replicat Coordinated Replicat Integrated Replicat Parallel Integrated Replicat Parallel Nonintegrated Replicat Special Run Replicat Remote Task When key in the value for this option, the application name is optional, as long as it matches the va lue of component. For example, `"Data Pump Extract"` is equivalent to `"Data Pump"` if the component is Extract. However, it is invalid if the component is Replicat.
`-PLATFORM \| -P`	Specifies the platform the application is supposed to run on. The default value is the platform that this `checkprm` executable is running on. The possible values are: `AIX HP-OSS HPUX-IT HPUX-PA` `Linux OS400 ZOS Solaris SPARC` `Solaris x86 Windows x64 All`
`-DATABASE \| -D`	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): `Generic Oracle 8 Oracle 9i Oracle 10g Oracle 11g Oracle 12c Oracle 18c Oracle 19c Oracle 21c Sybase DB2LUW 9.5 DB2LUW 9.7 DB2LUW 10.5 DB2LUW 10.1 DB2LUW 11.1 DB2 Remote Teradata Timesten Timesten 7 Timesten 11.2.1 MySQL Ctree8 Ctree9 DB2 for i Remote MSSQL MSSQL CDC Informix Informix1150 Informix1170 Informix1210 Ingres SQL/MX DB2 z/OS PostgreSQL`
`-VERBOSE \| -V`	Directs `checkprm` to print out detailed parameter information, to demonstrate how the values are read and interpreted. 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

Include the CHECKPARAMS parameter in the parameter file.
Start the associated process by issuing the START EXTRACT or START REPLICAT command.
```
START {EXTRACT | REPLICAT} group_name
```
The process audits the syntax, writes the results to the report file or the screen, and then stops.
Do either of the following:
- If the syntax is correct, remove the CHECKPARAMS parameter before starting the process to process data.
- If the syntax is wrong, correct it based on the findings in the report. You can run another test to verify the changes, if desired. Remove CHECKPARAMS before starting the process to process data.

For more information about CHECKPARAMS, see Reference for Oracle GoldenGate.