Add a Replicat for OCI Object Storage

Learn to add and configure a Replicat process for an OCI Object Storage target.

Related Topics

Before you begin

Before you add the Replicat, ensure that you have the following:

  • Compartment OCID

    Tip:

    You can find the compartment OCID on the Compartment details page.
    1. Open the Oracle Cloud console navigation menu, select Identity, and then Compartments.
    2. Select your compartment from the list to access the Compartment details page.
    3. Copy the compartment OCID from the Compartment Information section.

    For more information, see Find the OCID of a Compartment.

  • OCI Object Storage bucket name

    Tip:

    Oracle recommends that you create your own OCI Object Storage bucket.
    1. Open the Oracle Cloud console navigation menu, select Storage, and then Buckets.
    2. Click Create Bucket.
    3. In the Create Bucket panel, enter a name, and then click Create.

    For more information, see Using the Console to create a bucket.

Add a Replicat (23ai)

Before you begin

Ensure that you review prerequisites specific to this target type.

To add a Replicat in GoldenGate 23ai:
  1. In the OCI GoldenGate deployment console, on the Administration Service Home page, click Add Replicat (plus icon).
  2. In the Add Replicat panel, on the Replicat Information page, complete the fields as needed, and then click Next:
    • Select a Replicat Type:
      • Classic Replicat
      • Coordinated Replicat
    • Enter a Process Name, no more than 5 characters long.
    • Enter a Description, to help distinguish this process from others.
  3. On the Replicat Options page, complete the fields as needed, and then click Next:
    • Replicat Trail:
      • Enter a Name.
      • Enter a Subdirectory, if you expect the Trail file to be in a location other than the default.
      • Select an Encryption profile. If an encryption profile wasn't created, the Local Wallet is selected by default.
      • For Begin, select the starting point for data processing:
        • Position in Log (default)
        • Now
        • Custom Time
    • Trail Position:
      • Enter the Sequence Number.
      • Enter the RBA Offset.
      • Select your Target from the dropdown.

        Note:

        Depending on your target selection, you may have additional options to such as Streaming, Stage and Merge, and Staging locations.
    • Target Credentials:
      • Select a Domain.
      • Select an Alias within the specified Domain.
      • Select a Checkpoint Table. Leave the default selection or select the checkpoint table you created for the target deployment.
      • Select the Max Threads Number (Coordinated Replicats only).
  4. On the Managed Options page, complete the optional fields as needed, and then click Next:
    • Select a Profile Name, if one is available.
    • Enable Critical to deployment health.
    • Enable and configure Auto Start settings.
  5. On the Parameter File page, you can add parameters to further configure your Replicat. For example:
    table source.table1;

    If using Coordinated Replicat, add TARGETDB LIBFILE libggjava.so SET property=/u02/Deployment/etc/conf/ogg/your_replicat_name.properties to the parameters file.

    Note:

    GoldenGate uses Greenwich Mean Time (GMT) by default. Use SETENV to override the default setting for this Replicat process. This change doesn't apply to deployments. For example: 

    setenv (TZ="US/Eastern")
setenv (TZ="GMT+5")
  6. On the Properties File page, configure the File Handler and OCI Event Handler properties as needed, and then click Next. Some properties to consider modifying include:
    1. gg.handler.name.format: Select how to format the output data. Available options include:
      • delimitedtext
      • json
      • json_row
      • xml
      • avro_row
      • avro_op
      • avro_row_ocf
      • avro_op_ocf

      For parquet, you must apply additional properties. See Parquet for OCI Object Storage for details.

    2. gg.handler.name.fileNameMappingTemplate: Generates file names dynamically using Template Keywords.
    3. gg.handler.name.inactivityRollInterval: GoldenGate creates a file and keeps it open for writing. This property closes the file after the designated period of inactivity (no incoming transactions) and then loaded into OCI Object Storage.
    4. gg.eventhandler.name.compartmentID: Enter the compartment OCID.
    5. gg.eventhandler.name.bucketMappingTemplate: Enter the Object Storage bucket name.

    Learn more about File Writer Handler and OCI Event Handler configuration properties.

    Note:

    You can also add pluggable formatters as needed. For more information, see Pluggable Formatters.
  7. Click Create and Run. If you click Create, then you can manually start the Replicat later from the Administration Service Home page.

Add a Replicat (21c)

To add a Replicat for an OCI Object Storage target:
  1. In the OCI GoldenGate deployment console, on the Administration Service Overview page, click Add Replicat (plus icon).
  2. On the Add Replicat page, select a Replicat type, and then click Next.
    The types of Replicats are:
    • Classic Replicat
    • Coordinated Replicat
  3. On the Replicat Options page, complete the following fields, and then click Next:
    1. For Process Name, enter a name for the Replicat process.
    2. (Optional) For Description, enter a short description to distinguish this process from others.
    3. For Trail Name, enter two-character trail name.
    4. For Target, select Oracle Object Storage from the dropdown.
    5. For Available aliases for OCI, select your alias from the dropdown.
  4. On the Parameter File page, add and configure Replicat parameters as needed, and then click Next.

    Note:

    • If using Coordinated Replicat, add the following parameters on the second line of the Parameter File:
      TARGETDB LIBFILE libggjava.so SET property=/u02/Deployment/etc/conf/ogg/<replicat
      name>.properties

      Using coordinated replicat will result in multiple files created.

      If omitted, you will encounter the following error:

      OGG-01091 Oracle GoldenGate Delivery, RSNOW.prm: Unable to open file
      "/u02/Deployment/etc/conf/ogg/<replicat name>001.properties" (error 2, No such file or
      directory).
    • GoldenGate uses Greenwich Mean Time (GMT) by default. Use SETENV to override the default setting. For example:
      setenv (TZ="US/Eastern")
setenv (TZ="GMT+5")

      Learn more about SETENV.

  5. On the Properties File page, configure the File Handler and OCI Event Handler properties as needed, and then click Next. Some properties to consider modifying include:
    1. gg.handler.name.format: Select how to format the output data. Available options include:
      • delimitedtext
      • json
      • json_row
      • xml
      • avro_row
      • avro_op
      • avro_row_ocf
      • avro_op_ocf

      For parquet, you must apply additional properties. See Parquet for OCI Object Storage for details.

    2. gg.handler.name.fileNameMappingTemplate: Generates file names dynamically using Template Keywords.
    3. gg.handler.name.inactivityRollInterval: GoldenGate creates a file and keeps it open for writing. This property closes the file after the designated period of inactivity (no incoming transactions) and then loaded into OCI Object Storage.
    4. gg.eventhandler.name.compartmentID: Enter the compartment OCID.
    5. gg.eventhandler.name.bucketMappingTemplate: Enter the Object Storage bucket name.

    Learn more about File Writer Handler and OCI Event Handler properties.

    Note:

    You can also add pluggable formatters as needed. For more information, see Using the Pluggable Formatters.
  6. Click Add and Run.
You're returned to the Administration Service Overview page where you can monitor the status of the Replicat process. Click the process name to view its details and access reports.

Known Issues

OCI Object Storage replication error when using Resource Principal

If a Resource Principal is used for authentication, the Replicat will fail, and encounter the following error:
ERROR 2025-06-12 14:48:16.000489 [main] - An exception has occurred: java.lang.NullPointerException: Cannot invoke "String.startsWith(String)" because "path" is null java.lang.NullPointerException: Cannot invoke "String.startsWith(String)" because "path" is null

User OCID Mismatch in OCI Object Storage connection (Federated users only)

If a federated user selects Use current user when creating an OCI Object Storage connection, their OCID doesn't match the OCID picked up by the system.

Workaround: When you create an OCI Object Storage connection, ensure that you choose Specify another user, and then enter the federated user's OCID.

To find the user OCID, click Profile in the Oracle Cloud console global header, and then select the user name. On the User Details page, under User Information, click Show for OCID.