1. Oracle GoldenGate Microservices Documentation
  2. Distribute
  3. Add a Distribution Path

Add a Distribution Path

A path is used to send trail data between two data endpoints of a deployment. You can add, monitor, reposition, and manage these paths using the Distribution Service. This topic discusses the steps to create a distribution path (DISTPATHS).

A distribution path defines the route for the trail to send and receive data for different topologies such as:

  • Path between two secure deployments with USER ID ALIAS target authentication: On the target deployment, a user with Operator role is created and then the credentials of this user are added as credentials in the source Oracle GoldenGate deployment. The target authentication method that is set up which creating the Distribution Path is "Password". The wss (secure web socket) protocol is used for this type of distribution path.

  • Path between two secure deployments with Certificate target authentication: In this case, the distribution path uses trusted CA certificates to access the target deployment. The target authentication method that is set up which creating the Distribution Path is "Certificate". The wss (secure web socket) protocol is used for this type of distribution path.

  • Path between two deployments with OAuth target authentication: In this case, the Oracle GoldenGate user authentication is outsourced to an OAuth service such as IDCS.

Paths can also be initiated from the Receiver Service. In cases where there are network security policies that prevent the Distribution Service to open a network connection in the target endpoint to the Receiver Service, the path is initiated from the Receiver Service to the Distribution Service. These types of paths are called target-initiated paths, which are suitable in environments such as Demilitarized Zone Paths (DMZ) or Cloud to on-premise networks.

A path is created to send the trail data over a network from the Extract to the Replicat. To add a distribution path from the Distribution Service:

A path is created to send the transaction of data from the Extract to the Replicat creating a trail path.

  1. Log in to the Distribution Service.

  2. Click the plus (+) sign next to Distribution Paths on the Distribution Service home page. The Add Path wizard is displayed.

  3. On the Path Information screen, enter the following details:
    Path Information Screen Description

    Path Name

    Select a name for the path.

    Description

    Provide a description. For example, the name of the Extract and Replicat processes associated with the distribution path.

  4. On the Source Options screen, enter the following details:

    Source Options Screen Description

    Source Extract

    Select the source Extract for which the trail distribution will be done by the Distribution Path.

    Trail Name

    Name of the source trail file.

    Subdirectory

    Path of the trail subdirectory.

    Generated Source URI

    A URI is automatically generated for the trail based on the Extract information you provided. You can edit this URI by clicking the pencil, then modifying the source. Typically, you will need to edit the URI if you want to use reverse proxy.

    Encryption Profile

    Select an encryption profile from the drop down list, if required.

    Begin

    Select the point from where you need to log data. You can select the following options from the drop-down list:

    • Now

    • Custom Time

    • Position Log

    Source Log

    Specify the values for the source log:

    • Sequence Number

    • RBA Offset

  5. Click Next.

  6. On the the Target Options screen, specify the following details:
    Target Options Screen Description

    Target Protocol

    Select the data transfer protocol. Available options include wss, ws, and ogg.

    Reverse Proxy Enabled

    Select to use reverse proxy.

    Deployment

    Name of the target deployment.

    URI Path

    The URI path of the target host.

    Target Host

    Enter the URL of the target host, for example, localhost, if the target is on the same system.

    Port Number

    Port number of the target deployment.

    Trail Name

    Name of the source trail file.

    Trail Subdirectory

    Location of the trail subdirectory.

    Trail Size

    Maximum size of the file in the trail.

    Target Encryption Algorithm

    Encryption algorithm used when sending trail to target deployment. Options include AES128, AES192, and AES256.

    Change Encryption

    Enable this option to allow changing the encryption algorithm.

    Generated Target URI

    A target URI is automatically generated for the trail based on the target authentication method and target you provided. You can edit this URI by clicking the pencil, then modifying the target. This field is auto-populated.

    Domain

    The Domain that stores the userid alias, which has the target user id and password. This is used when the Distribution Path used the Target Authentication Method uses the UserID Alias authentication.

    Alias

    UserID alias that has the target Oracle GoldenGate UserID and password.

    Trail Options

    Enable this option to customize the trail options in the next screen.

    Advanced Options

    Enable this option to customize the other advanced options in the next screen.

  7. Click Next.

  8. On the Trail Options screen, enter the following details:

    Trail Options Screen Description

    Type

    Trail is accepted in the following formats:

    Plain Text

    XML

    SQL

    Compatible With

    Select the utility that is compatible with the trail file. Options are:

    • BCP

    • SQLLOADER

    • COMCAST

    Timestamp Precision

    Specify the timestamp precision value for the trail file.

    TS

    Date

    Time

    Extra Columns

    Includes placeholders for additional columns at the end of each record. Use this option when a target table has more columns than the source table.

    Specify a value between 1 and 9.

    Include SYSKEY

    Select this option incase your Replicat configuration includes tables with SYSKEY.

    Quote Style

    Select the quote style depending on the database requirements. Options are:

    single

    none

    embed

    Include Column Name

    Enable this option to include column names in the trail file.

    Null is Space

    Select this option to indicate that any null values in the trail file is a space.

    Include Place Holder

    Outputs a placeholder for missing columns.

    Include Header Fields

    Select to include header fields in the trail file.

    Delimiter

    An alternative delimiter character.

    Include Operation Type

    Enable this option to include the trail operation type in the trail options.

    Include Image Indicator

    Enable this option to include details about the before and after image.

    Include Object Name

    Enable this option to include the object name in the trail details.

    Encoding

    UTF-8

    Use Qualified Name

    Select to use the fully qualified name of the parameter file.

    Include Transaction Info

    Enable to include transaction information.

  9. Click Next.

  10. The Advanced Options screen appears if you enabled Advanced Options in the Target Options screen. On the Advanced Options screen, provide the following details to configure the target network:
    Advanced Options Description

    Target Trail Sequence Length

    The length of the trail sequence number.

    Enable Network Compression

    Set the compression threshold value if you decide enable this option.

    Compression Threshold

    Option appears when you enable the network compression. Specify the compresion threshold value.

    Eof Delay (centiseconds)

    You can specify the Eof Delay in centiseconds. 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) ).

    Checkpoint Frequency

    Frequency of the path that is taking the checkpoint (in seconds).

    TCP Flush Bytes

    Enter the TCP flush size in bytes.

    TCP Flush Seconds

    Enter the TCP flush interval in seconds.

    DSCP

    Select the Differentiated Services Code Point (DSCP) value from the drop-down list, or search for it from the list.

    TOS

    Select the Type of service (TOS) value from the drop-down list.

    TCP_NODELAY

    Enable this option to prevent delay when using the Nagle’s option.

    Quick ACK

    Enable this option to send quick acknowledgment after receiving data.

    TCP_CORK

    Enable this option to allow using the Nagle’s algorithm cork option.

    System Send Buffer Size

    You can set the value for the send buffer size for flow control.

    System Receive Buffer Size

    You can set the value for the receive buffer size for flow control.

    Keep Alive

    Timeout for keep-alive.

    Use Enckeys

    Enable this option to use an Enckey.

    Target Encryption Keyname

    The encryption keyname of the Enckeys method.

  11. Click Next.

  12. On the Filtering Options screen, specify the following:
    Filtering Options Screen Description

    Rule Name

    Name of the rule you need to create.

    Rule Action

    Select from the Exclude or Include rules. Exclude would filter out based on the selected options, while Include would include data based on the specified options.

    Filter Type

    Select from the following list of options:

    • 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.

    Object Names

    Name of the object being filtered.

    Negate

    Select this check box if you need to negate any existing rule.

  13. Click Add to add the rule and then click Next.

  14. On the Managed Options screen, specify the following options:
    Managed Options Screen Description

    Critical

    Enable this option if you want to configure the Distribution Path for high availability.

    Auto Restart
    Enable this toggle switch to adjust the auto restart options:

    • Auto restart Retries

    • Auto restart Delay

  15. Click Create Path or Create Path and Run, as required. Select Cancel if you need to get out of the Add Path page without adding a path.

You are returned to the Distribution Service home page, which now includes your new path.

After the path is created, you’ll be able to see the new path in the Distribution Service home page. You can also see this distribution path from the Receiver Service home page of the target deployment.