Creating a Parameter File for Online Extraction

Follow these instructions to create a parameter file for an online Extract group. A parameter file is not required for an alias Extract group.

  1. In GGSCI on the source system, issue the following command.
    EDIT PARAMS name
    

    Where:

    name is either the name of the Extract group that you created with the ADD EXTRACT command or the fully qualified name of the parameter file if you defined an alternate location when you created the group.

  2. Enter the parameters in the order shown in the following table, starting a new line for each parameter statement. Some parameters apply only for certain configurations.
    Parameter Description
    EXTRACT group
    • group is the name of the Extract group that you created with the ADD EXTRACT command.

    Configures Extract as an online process with checkpoints.

    [SOURCEDB dsn | container | catalog]
    [, USERIDALIAS alias options |
    , USERID user, options]

    Specifies database connection information.

    SOURCEDB specifies the source data source name (DSN). See for more information.

    USERID and USERIDALIAS specify database credentials if required.

    The database connection can be omitted if the group is a data pump on an intermediary system that does not have a database. In this case, there can be no column mapping or conversion performed.

    RMTHOSTOPTIONS host,
    MGRPORT port,
    [, ENCRYPT algorithm KEYNAME key_name]

    Specifies the target system, the port where Manager is running, and optional encryption of data across TCP/IP. Only required when sending data over IP to a remote system (if ADD RMTTRAIL was used to create the trail). Not required if the trail is on the local system (if ADD EXTTRAIL was used).

    Not valid for a passive Extract group.

    ENCRYPTTRAIL algorithm

    Encrypts all trails that are specified after this entry.

    DECRYPTTRAIL

    (For a data pump) Decrypts the data in the input trail. Use only if the data pump must process the data before writing it to the output trail.

    RMTTRAIL pathname |
    EXTTRAIL pathname
    • Use RMTTRAIL to specify the relative or fully qualified name of a remote trail created with the ADD RMTTRAIL command.

    • Use EXTTRAIL to specify the relative or fully qualified name of a local trail created with the ADD EXTTRAIL command (to be read by a data pump or VAM-sort Extract).

    Specifies a trail. If specifying multiple trails, follow each designation with the appropriate TABLE statements.

    EXTTRAIL is not valid for a passive Extract group.

    If trails or files will be of different versions, use the FORMAT option of RMTTRAIL or EXTTRAIL. See EXTTRAILin Parameters and Functions Reference for Oracle GoldenGate

    LOGALLSUPCOLS

    Use when using integrated Replicat for an Oracle target, or when using Conflict Detection and Resolution (CDR) support. Writes the before images of scheduling columns to the trail. (Scheduling columns are primary key, unique index, and foreign key columns.) See LOGALLSUPCOLS in Parameters and Functions Reference for Oracle GoldenGate.

    SOURCECATALOG

    Specifies a default container in an Oracle multitenant container database or SEQUENCE statements. Enables the use of two-part names (schema.object) where three-part names otherwise would be required for those databases. You can use multiple instances of this parameter to specify different default containers or catalogs for different sets of TABLE or SEQUENCE parameters.

    SEQUENCE [container.]owner.sequence;

    Specifies the fully qualified name of an Oracle sequence to capture. Include the container name if the database is a multitenant container database (CDB).

    TABLE [container. | catalog.]owner.object;

    Specifies the fully qualified name of an object or a fully qualified wildcarded specification for multiple objects. If the database is an Oracle multitenant container database, the object name must include the name of the container or catalog unless SOURCECATALOG is used. See Specifying Object Names in Oracle GoldenGate Input for guidelines for specifying object names in parameter files.

    CATALOGEXCLUDE

    SCHEMAEXCLUDE

    TABLEEXCLUDE

    EXCLUDEWILDCARDOBJECTSONLY

    Parameters that can be used in conjunction with one another to exclude specific objects from a wildcard specification in the associated TABLE statement.

  3. Enter any appropriate optional Extract parameters listed in the Oracle GoldenGate Parameters in Parameters and Functions Reference for Oracle GoldenGate.
  4. Save and close the parameter file.
    Parameter Description
    VAM library,
    PARAMS ('param'
    [, 'param'] [, ...])
    

    Supplies the name of the library and parameters that must be passed to the Oracle GoldenGate API, such as the name of the TAM initialization file and the program that interacts with the library as the callback library.

    Example:

    VAM vam.dll, PARAMS ('inifile', 'vamerge1.ini', 'callbacklib', 'extract.exe')
      NA