Configuring the CDC Replication Engine for Oracle XStream using the graphical user interface on UNIX and Windows

There are two modes in which the configuration program runs. If an X Window System is configured on Linux or UNIX or if running on Windows, the program runs in a graphical user interface. If running on Linux or UNIX without windows capability, an interactive format of the program runs – see previous sections.

About this task

CDC Replication relies on Oracle XStream to provide a sequence of Logical Change Records (LCR) for database DML and DDL. As such, CDC Replication does not directly interact with either online or archive redo logs.

If you are configuring the CDC Replication Engine for Oracle XStream on Windows, be aware that the tnsnames.ora file that is used during the configuration of the instance should reside on a local Windows drive. Specifying a tnsnames.ora file that is located on a Windows networks drive is not supported.

Procedure

  1. Launch the configuration tool. If you just installed the replication engine, you can launch the configuration tool from the from the last page of the installation program. To launch the configuration tool later to add or modify an instance, issue the following command:
    Linux and UNIX
    \CDC_installation_directory\bin\dmconfigurets
    Windows
    \CDC_installation_directory\bin\dmconfigurets.exe
  2. At the welcome message, click Enter to continue.
  3. Click Add....
  4. Enter the name of the instance that you want to add. The instance name must be unique.
  5. Enter the port number that CDC Replication uses for communication with client workstations that run Management Console and other servers. CDC Replication displays a default port of 11001.

    This port number cannot be used by other applications that are installed on the same server. You use this port number when you specify access parameters for your datastore in the Access Manager perspective in Management Console.

  6. Enter the maximum amount of disk space that will be utilized by the CDC Replication staging store on your source system. The default value is 100 GB.

    Specify 1 GB if you are creating an instance that will be used as a target of replication. This reduces the disk resources that CDC Replication requires on your target system.

  7. Enter the amount of physically available RAM that you want to allocate for this instance of CDC Replication. By default, the configuration tool allocates 1024 MB of RAM for each instance.

    Using values other than the defaults or allocating more RAM than is physically available on your server should only be undertaken after considering the impacts on product performance.

  8. Select the encryption profile from the list.
    If you would like to enable TLS for communication between source and target, you must select an encryption profile with encryption enabled. Click Manage to view and manage the available encryption profiles. Encryption profiles can be shared between multiple instances of CDC Replication.
  9. Windows only: Select the account under which the service will run. You can specify the account or use the local system account. If you choose to use a specific account, enter the domain name as well as the user account name, for example: username. (If you are running on a disconnected machine in a test environment, you can specify the machine name in place of the domain). ClickEnter and then confirm the password.
  10. Enter the path of the Oracle database (ORACLE_HOME environment variable) that you want to replicate data to or from and that contains all of the tables for replication. This is the database that you configured as part of the pre-installation tasks.
  11. Select the TNS name for your Oracle database from the drop-down list (select the one that you defined for CDC Replication in the tnsnames.ora file). You can specify any TNS name except those in use by other installed instances of CDC Replication for the given database.
  12. If you want to specify extra JDBC parameters, click Advanced to the right of the TNS Name field. Click Add for each parameter that you want to add, enter the parameter name and value, and click OK.
  13. Type in the schema for CDC Replication metadata. You can specify any schema except those in use by other installed instances of CDC Replication for the given database.
  14. In the Authentication area, you can specify the type of authentication that will be used for connections to the Oracle database:
    Option Description
    Kerberos Authentication Connections to the Oracle database are authenticated through Kerberos.
    SQL Authentication Connections to the Oracle database are authenticated through a user name and password.

    Below the Kerberos Authentication area you can enter additional JVM parameters that are required for Kerberos authentication. The following example shows a JVM parameter that you might be prompted to enter:

    -Djava.security.auth.login.config=JAAS-conf-file-location

    The JAAS-conf-file-location must have the following format:

    JDBC_DRIVER_01 {
    com.ibm.security.auth.module.Krb5LoginModule required
    useDefaultCcache=true
    credsType=both
    useKeytab="/IIDRForOracle/krboracle.tab"
    principal="krboracle@KERBEROS.DOMAIN.COM";
    };

    JDBC_DRIVER_01 is the required entry name. Because the CDC Replication Engine for Oracle databases bundles the IBM JVM with the product, the parameter and format must follow IBM Java format.

  15. To use an external secret through Java user exit authentication, select the Would you like to retrieve database login credentials from an external secret store Java User Exit? option. You are prompted to enter the Java class name of the external secret store user exit, for example com.datamirror.ts.external.keystore.VaultExternalSecretStoreTest. Enter the case-sensitive database user key from the external secret store for the specified database and the case-sensitive database password key from the external secret store for the specified database.
  16. Enter the user name for the specified database if SQL authentication is used.
  17. Enter the case-sensitive password for the specified database if SQL authentication is used.
    Note: CDC Replication metadata tables contain important configuration information and should be backed up as part of your database backup strategy.
  18. Provide the Log Processing Database TNS name. It can be the same as the source database TNS name. If the configuration is against Oracle RAC, review Oracle RAC requirements for TNS name.
  19. Type the user name to connect to the Log Processing database if SQL authentication is used.
  20. Type the password to connect to the Log Processing database if SQL authentication is used.
  21. Skip over the two steps above is Kerberos authentication is used. Make sure that you complete all Kerberos prerequisites if Kerberos authentication is used.
    Note: The Log Processing Database TNS name along with the authentication method that you chose are used by CDC Replication to manage Oracle XStream objects to obtain changed data from the database.
  22. Click OK to create the CDC Replication instance.

    If CDC Replication detects an unsupported encoding, an error message is displayed and you are asked to choose an alternate encoding.

  23. The configuration tool creates the CDC Replication instance and prompts you to start the instance. Click Yes to start the instance.

    The configuration tool prompts you if your configuration is about to overwrite the metadata for an existing instance.