Creating a Parameter File in GGSCI

To create a parameter file, use the EDIT PARAMS command within the GGSCI user interface or use a text editor directly. When you use GGSCI, you are using a standard text editor, but your parameter file is saved automatically with the correct file name and in the correct directory.

When you create a parameter file with EDIT PARAMS in GGSCI, 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. Once paired with an Extract or Replicat group, a parameter file must remain in its original location for Oracle GoldenGate to operate properly once processing has started.

The EDIT PARAMS command launches the following text editors within the GGSCI interface:

• 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 the GGSCI interface by using the SET EDITOR command. See Reference for Oracle GoldenGate.

1. From the directory where Oracle GoldenGate is installed, run GGSCI.
2. In GGSCI, issue the following command to open the default text editor.

   EDIT PARAMS group_name
   

   Where:

   group_name is either mgr (for the Manager process) or 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 extora.

   EDIT PARAMS extora
   

   The following creates or edits the parameter file for the Manager process.

   EDIT PARAMS MGR
   

3. 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 (--).
4. 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 myext
     USERIDALIAS ogg1
     ENCRYPT AES192 KEYNAME mykey
     ENCRYPTTRAIL AES 192
     EXTTRAIL ./dirdat/c1, PURGE
     CUSEREXIT userexit.dll MyUserExit, INCLUDEUPDATEBEFORES, &
       PARAMS "init.properties"
     TABLE myschema.mytable;
     

   • [, 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

   Note:

   The RMTHOST and RMTHOSTOPTIONS parameters can be specified together; the RMTHOST parameter is not required for RMTHOSTOPTIONS if the dynamic IP assignment is properly configured. When RMTHOSTOPTIONS is used, the MGRPORT option is ignored.

5. Save and close the file.