Creating a Parameter File Using Admin Client

To create a parameter file, run the EDIT PARAMS command from the Admin Client. When you create a parameter file with EDIT PARAMS, it is saved to the dirprm sub-directory of the Oracle GoldenGate directory.

You can create a parameter file in a directory other than dirprm, but you also must specify the full path name with the PARAMS option of the ADD EXTRACT or ADD REPLICAT command when you create your process groups. After pairing with an Extract or Replicat group, a parameter file must remain in its original location for Oracle GoldenGate to operate properly after processing has started.

The EDIT PARAMS command launches the following text editors in Admin Client:

• Notepad on Microsoft Windows systems.

• The vi editor on UNIX and Linux systems. Db2 for i only supports vi when connected with SSH or xterm. For more information, see Creating a Parameter File with a Text Editor.

  Note:

  You can change the default editor through Admin Client by using the SET EDITOR command.

1. Run the Admin Client.

2. Connect to the Admin Client using the CONNECT command.

3. In Admin Client, issue the following command to open the default text editor:

   EDIT PARAMS group_name

   In this code snippet:

   group_name is the name of the Extract or Replicat group for which the file is being created. The name of an Extract or Replicat parameter file must match that of the process group.

   The following creates or edits the parameter file for an Extract group named exte:

   EDIT PARAMS exte

4. Using the editing functions of the text editor, enter as many comment lines as you want to describe this file, making certain that each comment line is preceded with two hyphens (--).

5. On non-commented lines, enter the Oracle GoldenGate parameters, starting a new line for each parameter statement.

   Oracle GoldenGate parameters have the following syntax:

   PARAMETER_NAME argument [,option] [&]

   Where:

   • PARAMETER_NAME is the name of the parameter.

   • argument is a required argument for the parameter. Some parameters take arguments, but others do not. Commas between arguments are optional.

     EXTRACT exte
      USERIDALIAS ggadmin 
      ENCRYPT AES192 KEYNAME mykey ENCRYPTTRAIL AES 192 
      EXTTRAIL /north/ea, PURGE CUSEREXIT userexit.dll MyUserExit, INCLUDEUPDATEBEFORES, & PARAMS "init.properties" 
      TABLE hr.employees;

   • [,option] is an optional argument.

   • [&] is required at the end of each line in a multi-line parameter statement, as in the CUSEREXIT parameter statement in the previous example. The exceptions are the following, which can accept, but do not require the ampersand because they terminate with a semicolon:

     • MAP

     • TABLE

     • SEQUENCE

     • FILE

     • QUERY

6. Save and close the file.

Creating a Parameter File with a Text Editor

You can create a parameter file outside Admin Client by using a text editor, but make certain to:

• Save the parameter file with the name of the Extract or Replicat group that owns it. Use the .prm file extension. For example: exte.prm.
• Save the parameter file in the dirprm directory of the Oracle GoldenGate home directory.