1. Oracle GoldenGate Microservices Documentation
  2. Administer
  3. Admin Client Command Line Interface for Oracle GoldenGate Microservices
  4. Validating a Parameter File

Validating a Parameter File

You can validate the parameter file from the Administration Service web interface. You can validate the Extract and Replicat parameters from the Reports tab. To access the Reports tab:

  1. From Extract or Replicat section of the Administration Service Overview Page, click Action and then click Details.

  2. Click the Reports tab to view the report for Extract and Replicat parameters, error log, and other information.

See Access Extract Details to learn how to check and edit the Extract parameters. See Access Replicat Details to learn about editing Replicat parameter files. Also see Additional Parameters for Integrated Replicat

You can also use the checkprm validation native command is run from the command line and give an assessment of the specified parameter file, with a configurable application and running environment. It can provide either a simple PASS/FAIL or with additional details about how the values of each parameter are stored and interpreted.

The CHECKPRM executable file can be found in the $OGG_HOME/bin directory of Microservices Architecture. See checkprm in the Parameters and Functions Reference for Oracle GoldenGate. 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, and the specified parameters. The parameter and options are printed with proper indentation to illustrate these relationships.

See CHECKPARAMS parameter.