Add Target-Initiated Distribution Paths

A target-initiated distribution path is created from the Receiver Service. These paths can be used when communication must be initiated from the target.

To create a target-initiated distribution path:

1. Log in to the Receiver Service.

2. Click the + sign on the Overview page to start adding a path.

3. The following table lists the options to set up the path:

Options	Description
Path Name	Name of the target-initiated distribution path
Description	Provide a description of the path.
Reverse Proxy Enabled	Select to use reverse proxy. To know more about configuring your reverse proxy servers, see Configure Reverse Proxy with NGINX to Access Oracle GoldenGate Microservices.
Source Authentication Method	Select the authentication method for the source URI. Authentication options are OAuth 2.0, Certificate, UserID Alias.
Source	From the drop-down list, select your data transfer protocol. The default option is Secure Web Socket Proctocl (wss). Other option is ws. You also need to enter the following details: Source Host: URL of the source host for example, localhost, if the source is on the same system. Port Number: Enter the port number of the Distribution Service. Trail Name: Enter the trail name you want to read on your source. Note: The Distribution Service doesn't not create any trail on source. It can only read the provided trail name. Domain: Enter the domain for the host. Alias: Provide an alias for this host. Path takes the source trail and sends the data to a target trail given here, which can be consumed by any Replicats created later.
Generated Source URI	A URI is automatically generated for the trail based on the source information you provided.
Target	Name of the target trail of the Replicat you created earlier.
Generated Target URI	A Target URI is automatically generated for the trail based on target trail information you provided.
Target Encryption Algorithm	Select the encryption algorithm for the target trail. Options include AES128, AES192, AES256.
Enable Network Compression	Set the compression threshold value if you decide enable this option.
Sequence Length	The length of the trail sequence number.
Trail Size	The maximum size of a file in a trail.
Configure Trail Format	Toggle this switch to enable and configure the trail file format.
Type	Select one of these types of trail file 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.
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.
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.
Use Qualified Name?	Select to use the fully qualified name of the parameter file.
Include Transaction Info?	Enable to to include transaction information.
Encryption Profile	Section
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 is Log (default)
Source Sequence Number	Select the sequence number of the trail from source deployment Extract.
Source RBA Offset	This setting provides the Relative Byte Address (RBA) offset value which is the point in the trail file (in bytes) from where you want the process to start.
Critical	The default value is false. If set to true, this indicates that the distribution path is critical to the deployment.
Auto Restart	The default value is false. If set to true, the distribution path is restarted automatically when killed.
Auto Restart Options	Set up the auto restart option in this section.
Retries	The number of times to try an restart the task (path process).
Delay	The duration interval to wait between retries.

Role Configuration

Description

Enable filtering

If you enable filtering by selecting it from the toggle button and click Add Rule, you’ll see the Rule Definition dialog box. Rule Name Rule Action: Select either Exclude or Include 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. Negate: Select this check box if you need to negate any existing rule. You can also see the JSON script for the rule by clicking the JSON tab.

Additional Options	Description
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.
TCP Options	Section
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.

For target-initiated distribution paths, the use case for the ws and wss protocols is explained in the following table:

Deployment Type	Target Deployment (Non Secure)	Target Deployment (Secure)
Source Deployment (Non-secure)	ws	ws
Source Deployment (Secure)	wss	wss

The wss protocol must be specified whenever the source deployment (Distribution Service host) has been configured with security enabled. The secured communication channel can be created using an SSL certificate in a client Wallet, even if the target deployment (Receiver Service host) has disabled security.

Features and Limitations for Using Target-initiated Distrbution Paths

Here are the limitations when working with target-initiated distribution paths:

• There is no support for interaction between legacy and secure deployments using this mode of operation for target-initiated distribution paths.
• No support for ogg protocol. Only ws and wss protocols are supported.
• It is possible to only get information and stop a target-initiated distribution path on Distribution Service and after the path stops, it is not be visible on the Distribution Service.

You can also set up target-initiated distribution paths using the Admin Client.

For command options, see the Admin Client commands ADD RECVPATH, ALTER RECVPATH, INFO RECVPATH, DELETE RECVPATH, START RECVPATH.