Add a Target-initiated Path

A Target-initiated path enables the target deployment's Receiver Service to initiate a path connecting to the source deployment's Distribution Service to pull trail files from the source.

Note:

This article applies only to GoldenGate 23ai deployments.

When to use target-initiated Paths

Use target-initiated paths when the network security policies prevent Deployment A's Distribution service from opening network connections to Deployment B's Receiver service. If Deployment A's Distribution server is unable to initiate connections to Deployment B's Receiver service, but the Receiver service can initiate a connection to Deployment A's Distribution service, then you can create and run a target-initiated path on Deployment B to pull Trail files from Deployment A.

The source deployment is the deployment where you create the target initiated Path. The target deployment is the remote deployment from which you are extracting data (where your Extract runs and produces Trails).

Before you begin

  • Ensure that you create GoldenGate connections for each deployment you want to connect to, and then assign them to the deployment from which the path originates. For example, the deployment where you create the Distribution Path or Target-initiated Receiver Path.

    Otherwise, in IAM-enabled deployments, you'll encounter the error:

    The network connection could not be established: 'OGG-08654' - 'Invalid or missing OAuth
          resource - audiencescope in Client application'.
  • Add a Credential that allows the target deployment (the deployment where you create this Path) to connect to the source deployment:
    1. In the source deployment's navigation menu, select User Administration.
    2. Click Add New User, and then complete the following:
      • Authenticated By: Select Password from the dropdown.
      • Role: Select Operator from the dropdown.
      • Username: Enter your username.
      • Password and Verify Password: Enter the password associated with this user.
    3. In the target deployment console, select Path Connections in the navigation menu.
    4. Click Add Path Connection, and then complete the following:
      • Credential Alias: Enter an alias.
      • User ID: Enter the name of the user created in step 2.
      • Password and Verify Password: Enter the password associated with this user from step 2.
    5. Click Submit.

Create and run a Target-initiated Path (23ai)

To add a Target-initiated Path in GoldenGate 23ai:
  1. In the OCI GoldenGate deployment console, click Receiver Service.
  2. On the Home page, click Add Target-initiated Path (plus icon).
  3. In the Add Path panel, complete the Path Information fields as needed, and then click Next:
    1. Enter the Path Name, enter a name for the path.
    2. (Optional) Enter a Description, to describe this path's purpose and list the Extract and Replicats involved.
  4. On the Source Options page, enter the fields as needed, and then click Next:
    • Select the Source Extract from the dropdown.
    • Enter the Trail Name
    • Enter the Subdirectory, if you expect the Trail to be in a location other than the default.
    • The Generated Source URI is automatically generated based on the information provided. Click Edit (pencil icon) to modify the URI, if needed.
    • Select an Encryption Profile. The Local Wallet profile is selected by default if an encryption profile wasn't created.
    • For Begin, select the starting point for data processing:
      • Position in Log
      • Now
      • Custom Time
      • CSN (at or after)
    • Enter the Sequence Number.
    • Enter the RBA Offset.
  5. On the Target Options page, complete the fields as needed, and then click Next:
    • Select a Target Protocol:
      • ws
      • wss
      • ogg
    • (Optional) Enable Reverse proxy enabled to connect to the target using a reverse proxy.
    • Target type (ogg Target Protocol only)
      • Manager
      • Collector
      • Receiver Service
    • Enter the Target Host.
    • Enter the Port Number of the target deployment.
    • Enter the Trail Name for the target Trail file.
    • Enter the Subdirectory, if the Trail is located somewhere other than the default location.
    • Enter the maximum Trail Size.
    • Select a Target Encryption Algorithm used to send the Trail to the target deployment:
      • NONE
      • AES128
      • AES192
      • AES256
    • Enable Change Encryption to allow changes the encryption algorithm.
    • Generated Target URI is automatically generated based on the information provided. Click Edit (pencil icon) to modify the URI, if needed.
    • Select a Target Authentication Method (wss Target Protocol only)
      • UserID Alias

        Note:

        Create a credential using the IAM user when connecting to an IAM-enabled deployment from a GoldenGate credential store deployment. Ensure that the user exists in the IAM Identity Stripe.
      • OAuth

        Note:

        In IAM enabled tenancies, select OAuth when connecting to another IAM-enabled deployment.
      • Certificate
    • Select a Domain.
    • Select the Alias that has the Oracle GoldenGate UserID and Password.
    • Select a Target Type:
      • GGFormat (default)
      • SQL
      • XML
      • Plain Text
  6. On the Advanced Options page, complete the fields as needed, and then click Next:
    • Enable Enable Network Compression, to set the Compression Threshold.
    • Select EOF Delay.

      Note:

      On Linux platforms, the default settings can be retained. However, on non-Linux platforms, you may need to adjust this setting for high bandwidth, high latency networks, or for networks that have Quality of Service (QoS) settings (DSCP and Time of Service (ToS))
    • Select the Checkpoint Frequency to set the frequency of the path that is taking the checkpoint (in seconds).
    • Enter the TCP Flush Bytes (in bytes).
    • Enter the TCP Flush Seconds (in seconds).
    • Select the Differentiated Services Code Point (DSCP).
    • Select the Type of Service (TOS).
    • Enable TCP_NODELAY, to prevent delay when using the Nagle’s option.
    • Enable Quick ACK, to send quick acknowledgment after receiving data.
    • Enable TCP_CORK, to allow using the Nagle’s algorithm cork option.
    • Enter the System Send Buffer Size to set the value for the send buffer size for flow control.
    • Enter the System Receive Buffer Size, to set the value for the receive buffer size for flow control.
    • Set the timeout for Keep Alive.
  7. On the Filtering Options page, complete the following fields as needed, and then click Next:
    • Enter a Rule Name.
    • Select a Rule Action:
      • Exclude filters out data based on the selected options.
      • Include include data based on specified options.
    • Select a Filter Type:
      • Object Type: Select from three object types: DML, DDL, and Procedure
      • Object Names: Select this option to provide an existing object name. A 3–part naming convention depends on whether you are using CDB. With CDB, you need to use a 3–part naming convention, otherwise a 2–part convention is mandatory. 3–part convention includes container, schema, object. 2–part convention includes schema, object name.
      • Procedure Feature Name: Select this option to filter, based on existing procedure feature name.
      • Column Based: If you select this option, you are presented with the option to enter the table and column name to which the rule applies. You can filter out using column value with LT, GT, EQ, LE, GE, NE conditions. You can also specify if you want to have before image or after image in filtered data.
      • Tag: Select this option to set the filter based on tags.
      • Chunk ID: Displays the configuration details of database shards, however, the details can’t be edited.
    • Select Negate, to negate any existing rule.
    • Click Add to add the rule.
  8. On the Managed Options page, complete the optional fields as needed.
    • Enable Critical to configure this Path for high availability.
    • Enable Auto Restart to adjust Auto restart retries and Auto restart delay options.
  9. Click Create and Run to run your Path immediately. Click Create to run your Path manually at a later time.
You return to the Home page where you can view the status of the Path process.