Add a Receiver Path

A Receiver path handles incoming trail files.

Note:

This article applies only to GoldenGate 21c deployments.

Related Topics

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 a source deployment (the deployment where you create this Path) to connect to a target deployment:
    1. In the target deployment console, log in, and then access the Administrator (or User Administration in 23ai) page from the navigation menu.
    2. Click Add User, and then create a user that the source deployment can use to connect to the target deployment. Assign this user the Operator role.
    3. Open the source deployment console, and then navigate to the Configuration page.
    4. Under the Database tab, click Add Credential, and then complete the following:
      • Credential Domain: Enter a name for this connection
      • 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 Receiver Path

To add a Receiver path:
  1. In the OCI GoldenGate deployment console, click Receiver Service.
  2. On the Overview page, click Add Path (plus icon).
  3. On the Add Path page, complete the fields as follows:
    1. For Path Name, enter a name for the path.
    2. (Optional) For Description, enter a brief description of this path's purpose.
    3. (Optional) Enable Reverse proxy enabled to connect to the target using a reverse proxy.
    4. For Source Authentication Method, select one of the following:
      • OAuth: Select this option if the source and target deployments are IAM with Identity Domains enabled. This option uses the client credentials for authentication from the Distribution Service to Receiver Service.

        Note:

        In IAM enabled tenancies, select OAuth when connecting to another IAM-enabled deployment.
      • UserID Alias: This option uses a UserID Alias that you can create on the target Oracle GoldenGate to establish a connection.

        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.
    5. For Source, select a data transfer protocol from the dropdown:
      • ws: If selected, Source Authentication Method is not required.
      • wss: Web socket secure is the default option.
    6. For Source Host, enter the host name of the source deployment.
    7. For Port Number, enter the source deployment port number.
    8. For Trail Name, enter the name of the source deployment's Extract trail file.
    9. Deployment Name is required if Reverse Proxy is enabled. Enter the source deployment name.
    10. URI Path is required if Reverse Proxy is enabled. Enter the source deployment URI path.
    11. For Domain, enter the source credential domain.
    12. For Alias, enter the source credential alias.
    13. Generated Source URI autopopulates based on the values entered. Click Edit (pencil icon) to modify the URI, if needed.
    14. For Target Trail Name, enter the name of the Trail file as it's received by the target.
    15. For Target Encryption Algorithm, select an encryption algorithm for the target trail:
      • None
      • AES128
      • AES192
      • AES256
    16. For Enable Network Compression, select this option to set the Compression Threshhold.
    17. For Sequence Length, enter the length of the trail sequence number.
    18. For Trail Size (MB), enter the maximum size fo a file in a trail.
    19. For Configure Trail Format, enable this option if you want to configure the trail file format, and then complete the additional fields as needed.
  4. Under the Encryption Profile section, complete the following fields as needed:
    1. Profile Name
    2. Encryption Profile Type
    3. Masterkey Name
    4. For Begin, select where to log data:
      • Now
      • Custom Time
      • Position in Log (default)
    5. For Source Sequence Number, select the sequence number of the trail file source deployment Extract.
    6. For Source RBA Offset, enter the Relative Byte Address (RBA) in the trail file where you want the process to start.
    7. For Critical, set this option to True if the distribution path is critical to the deployment. The default is False.
    8. For Auto Restart, set this option to True if you want the distribution path to restart automatically if it's terminated.
    9. For Auto Restart Options, indicate the number of retries to retart the path process and the delay duration interval between retries.
  5. Under Rule-set Configuration, complete the following fields as needed:
    1. For Enable Filtering, if selected, click Add Rule, and then complete the additional fields.
  6. Under More Options, complete the following fields as needed:
    1. EOF Delay: end of file delay before searching for source data
    2. Checkpoint Frequency: frequency in seconds for routine checkpoints
    3. App Options
      • TCP Flush Bytes: Flush size
      • TCP Flush Seconds: Flush interval
    4. TCP Options
      • DSCP: network differentiated services
      • TOS term of service
      • TCP_NODELAY: disables use of Nagle's algorithm if enabled
      • Quick ACK: sends acknowledgement if enabled
      • TCP_CORK: enables use of Nagle's algorithm
      • System Send buffer Size
      • System Receive Buffer Size
      • Keep Alive: timeout for keep alive
  7. Click Create and Run.
You return to the Overview page, where you can view the status of the path process.

Learn more

Interested in learning how to create and run a target-initiated Receiver Path? Refer to the Send data from OCI GoldenGate to Oracle GoldenGate quickstart or try the LiveLabs version in a sandbox environment.