Add an Extract

Set up database credentials to create and run Extracts using the steps in Add and Alter Database Credentials.

  1. Log in to the Administration Server using the Oracle GoldenGate user credentials.

  2. From the Overview page of the Administration Server, click the + sign next to Extract.

  3. Choose the type of Extract to create and click Next. The types of Extract are:

    • Integrated Extract

    • Classic Extract

    • Initial Load Extract

    Note:

    An Initial Load Extract cannot be started from a secure deployment. You can only start it in a non-secure deployment.
  4. Enter and select the required information, which is designated with an asterisk (*). For all Extracts the Process Name, Credential Domain, and Credential Alias are required. A description is optional. The Create new credential option is common to all Extracts.

    You can configure the following additional required and optional details based on the type of Extract you selected to create:
    Options DescriptionDescription Database
    Basic Information

    Process Name

    Name of the Extract process. The name of the Extract process can be up to 8 characters.

    All databases

    Description

    Description of the Extract process being created.

    All databases

    Intent

    Describes the purpose of creating the Extract. The default option is Unidirectional. Other options are High Availability, Disaster Recovery, N-Way, which are informational only.

    All databases

    Begin

    Used to set the beginning location in the redo or transaction log from which the Extract will start to capture data. Available options are Now, Custom Time, CSN or Position in Log, and EOF depending on the supported database.

    All databases

    Trail Name

    A two character trail name.

    All databases

    Trail Subdirectory, Size, Sequence, and Offset

    You can further configure the trail details.

    All databases

    Remote

    Enable this option if the Extract trail is remote.

    For Oracle databases, enable this option if the Extract trail is to be written directly to a remote Oracle GoldenGate Classic installation.

    For MySQL, setting this option enables the TRANLOGOPTIONS ALTLOGDEST REMOTE parameter to support a remote Extract, and is not related to trails.

    Oracle, MySQL

    Registration Information

    CSN

    Commit Sequence Number (CSN) value

    Oracle

    Share

    Choose the method to share the LogMiner data dictionary. Options are:
    • Automatic: This option allows the system to choose the method for sharing the dictionary .

    • None: Choosing this option, will not allow the dictionary to be shared.

    • Extract: Choose this option to allow sharing the logminer dictionary for specific Extract.

    Oracle

    Optimized

    Enable this option to optimize the Extract registration.

    Oracle

    Downstream Capture

    Enable this option to set up a downstream Extract for log mining.

    Oracle

    Register Only

    Use this option to just register the Extract and not add the Extract. The registration creates the replication slot when you register the Extract or use the Register Only option.

    PostgreSQL

    Source Database Credential

    Create new credential

    If you haven't set up your database login credentials, you can create and save the database login credentials from here.

    All

    Credential Domain

    Create a domain for the database.

    All

    Credential Alias

    Specifiy a credential for the database login.

    All

    User ID

    Specify a user name for logging into the database.

    All

    Password, Verify Password

    Enter the password used to login to the database and reenter the password to verify.

    All

    Credential Domain

    Saves the credential user under the specified domain name. Enables the same alias to be used by multiple Oracle GoldenGate installations that use the same credential store. The default domain is Oracle GoldenGate.

    All databases

    Credential Alias

    Specifies an alias for the user name. Use this option if you do not want the user name to be in a parameter file or command. If ALIAS is not used, the alias defaults to the user name, which then must be used in parameter files and commands where a login is required. You can create multiple entries for a user, each with a different alias, by using the ADD USER option with ALIAS.

    All databases

    Downstream Mining

    Mining Credential Domain

    Domain name of the downstream mining database.

    Oracle

    Mining Credential Alias

    Alias for the mining downstream database.

    Oracle

    No UserID

    Enable this option if there is no source database connection. Selecting this option enables the ADG fetch options.

    Oracle

    ADG Fetch Credential Domain

    Domain name for the ADG fetch database.

    Oracle

    ADG Fetch Credential Alias

    Domain alias for the ADG fetch database.

    Oracle

    You must enter the options for Managed Processes while creating all types of Extract processes. The following table provides these options:
    Option Description

    Profile Name

    Provides the name of the autostart and autorestart profile. You can select the default or custom options.

    If you have already created a profile, then you can select that profile also. If you select the Custom option, then you can set up a new profile from this section itself.

    Critical to deployment health

    (Oracle only) Enable this option if the profile is critical for the deployment health. This option can be enabled for High Availability environments.

    Note:

    This option only appears while creating the Extract or Replicat and not when you set up the managed processes in the Profiles page.

    Auto Start

    Enables autostart for the process.

    Startup Delay

    Time to wait in seconds before starting the process

    Auto Restart

    Configures how to restart the process if it terminates

    Max Retries

    Specify the maximum number of retries to try to start the process

    Retry Delay

    Delay time in trying to start the process

    Retries Window The duration interval to try to start the process
    Restart on Failure only If true the task is only restarted if it failes
    Disable Task After Retries Exhausted If true then the task is disabled after exhausting all attempts to restart the process.
  5. Click Next.

  6. You can edit the parameter file in the text area to list the table details that you are interested in capturing. For example, table source.table1;

    You can select Register Extract in the background to register the Extract in the background asynchronously.

  7. You can select Register Extract in the background to register the Extract in the background asynchronously.

  8. Click Create and Run to create and start the Extract. If you select Create, the Extract is created but you need to start it using the Extract drop-down on the Overview page.

    You are returned to the Overview page of the Administration Server. Select the Action list if you want to look at the Extract details such as process information, checkpoint, statistics, parameters, and report.