5 Working with Paths

The path between a source and target deployment can be set using the Distribution Server. You can also create target-initiated distribution paths from the Receiver Server.

This section discusses the steps to create a path once the Extracts and Replicats are configured in the Administration Server.

Topics:

• Quick Tour of the Distribution Server Home Page
  The Distribution Server is accessible from the Service Manager home page.
• How to Add a Distribution Path
  A path is created to send the transaction of data from the Extract to the Replicat. You can create a new path from the Distribution Service.
• How to Add a Target-Initiated Distribution Path
  A target-initiated distribution path is created from the Receiver Server.
• Using the Path Actions
  Once a new path is added, you can perform actions such as stop or pause a path, view reports and statistics, reposition the path, change its filtering, and delete a path, if required.
• Repositioning a Path
  You can reposition a path whenever it’s necessary.
• Changing Path Filtering
  If you want to change the filter settings for an existing path, the steps are mostly the same as those for creating the filtering for a new path.
• Reviewing the Distribution Server Path Information
  

5.1 Quick Tour of the Distribution Server Home Page

The Distribution Server is accessible from the Service Manager home page.

From the Service Manager home page, click the Distribution Server. The Distribution Server Overview page is displayed where you can view the path that connects the extract and replicat.

You can add paths from the Distribution Server home page. It also offers a dashboard view of the paths, where you can perform various actions.

Action	Task
Add paths	See Adding New Paths
View path details	See Using the Path Actions
Start or Stop the path	See Using the Path Actions
Reposition the path	See Using the Path Actions
Enable sharding using filters	See Using the Path Actions and also Adding New Paths
Set or customize the DML filtering	See Using the Path Actions and also Adding New Paths
Set the DDL filtering	See Using the Path Actions and also Adding New Paths
Set or customize Procedure filtering	See Using the Path Actions and also Adding New Paths
Customize Tag filtering	See Adding New Paths
Delete a Path	See Using Path Actions

5.2 How to Add a Distribution Path

A path is created to send the transaction of data from the Extract to the Replicat. You can create a new path from the Distribution Service.

To add a path to set the trail for the source deployment:

1. Log in to the Distribution Service.
2. Click the plus (+) sign next to Path on the Distribution Service home page.
   The Add Path page is displayed.
3. Enter the details as follows:

   Options	Description
   Path Name	Select a name for the path.
   Description	Provide a description. For example, the name of the Extract and Replicat names.
   Reverse proxy enabled?	Select to use reverse proxy. To know more about configuring you reverser proxy servers, see Reverse Proxy Support in Securing the Oracle GoldenGate Environment
   Use Basic Authentication	Select to add a credential to the target URI creating basic MA authentication.
   Use Digest Authorization	Select this option to set the Distribution Service to use digest authorization to communicate with the Receiver Service. Note: Both the Distribution Service and Receiver Service must have Digest Authorization for the path, otherwise the path is killed.
   Source: Trail Name	Select the Extract name from the drop-down list, which populates the trail name automatically. If it doesn’t, enter the trail name that you provided while adding the Extract.
   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.
   Target Authentication Method	Select the authentication method for the target URI. Authentication options are OAuth, Certificate, UserID Alias. Use the OAuth if the source and target deployments are IDCS-enabled. This option uses the client credentials for authentication from the Distribution Service to the Receiver Service.
   Target	Enter the target endpoint of the path. From the drop-down list, select your data transfer protocol. The default option is wss (secure web socket). Specify the following details when you select this option: Target Host: Enter the URL of the target host, for example, localhost, if the target is on the same system. Port Number: You may enter the port number of the Receiver Service and the trail name of the Replicat you created earlier. However, it’s not mandatory. The port is the Manager port number for Classic Architecture. Trail Name: Path takes the source trail and sends the date to a target trail given here, which can be consumed by any Replicats created later. Domain: Name of the target domain. Alias: User alias of the target domain. You can also choose ogg or ws (web socket) protocol. For the ogg protocol, you need to specify only the target host, port number, and trail file name. For the ws protocol, the options are the same as the wss protocol.
   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.
   Target Encryption Algorithm	Select the encryption algorithm for the target trail. Options include NONE, AES128, AES192, AES256.
   Target Encryption Keyname	Specify a logical name for the encryption key based on the specified type of target encryption algorithm.
   Enable Network Compression	Set the compression threshold value if you enable this option.
   Compression Threshold	Option appears when you enable the network compression. Specify the compresion threshold value.
   Sequence Length	The length of the trail sequence number.
   Trail Size (MB)	The maximum size of a file in a trail.
   Encryption Profile	Name of the encryption profile associated with the path.
   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 restarts automatically if it's terminated.
   Auto Restart Options	Section
   Retries	The number of times to try an restart the task (path process).
   Delay	The duration interval to wait between retries.

   Rule Configuration

   Description

   Enable filtering

   If you enable filtering by selecting it from the toggle button and click the Add Rule button, 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 (cent sec)	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.

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

Once the path is created, you’ll be able to see the new path in the Overview page of the Distribution Service.

5.3 How to Add a Target-Initiated Distribution Path

A target-initiated distribution path is created from the Receiver Server.

To know more about target-initiated distribution paths, see Using Target-Initiated Distribution Paths in MA.

To create a target-initiated distribution path, perform the following steps:

1. Log in to the Receiver Server.

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

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

Options	Description
Path Name	Select a name for the path.
Description	Provide a description. For example, the name of the Extract and Replicat names.
Reverse proxy enabled?	Select to use reverse proxy. To know more about configuring you reverser proxy servers, see Reverse Proxy Support in Securing the Oracle GoldenGate Environment
Use Basic Authentication	Select to add a credential to the target URI creating basic MA authentication.
Use Digest Authorization	Select this option to set the Distribution Service to use digest authorization to communicate with the Receiver Service. Note: Both the Distribution Service and Receiver Service must have Digest Authorization for the path, otherwise the path is killed.
Source: Trail Name	Select the Extract name from the drop-down list, which populates the trail name automatically. If it doesn’t, enter the trail name that you provided while adding the Extract.
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.
Target Authentication Method	Select the authentication method for the target URI. Authentication options are OAuth, Certificate, UserID Alias. Use the OAuth if the source and target deployments are IDCS-enabled. This option uses the client credentials for authentication from the Distribution Service to the Receiver Service.
Target	Enter the target endpoint of the path. From the drop-down list, select your data transfer protocol. The default option is wss (secure web socket). Specify the following details when you select this option: Target Host: Enter the URL of the target host, for example, localhost, if the target is on the same system. Port Number: You may enter the port number of the Receiver Service and the trail name of the Replicat you created earlier. However, it’s not mandatory. The port is the Manager port number for Classic Architecture. Trail Name: Path takes the source trail and sends the date to a target trail given here, which can be consumed by any Replicats created later. Domain: Name of the target domain. Alias: User alias of the target domain. You can also choose ogg or ws (web socket) protocol. For the ogg protocol, you need to specify only the target host, port number, and trail file name. For the ws protocol, the options are the same as the wss protocol.
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.
Target Encryption Algorithm	Select the encryption algorithm for the target trail. Options include NONE, AES128, AES192, AES256.
Target Encryption Keyname	Specify a logical name for the encryption key based on the specified type of target encryption algorithm.
Enable Network Compression	Set the compression threshold value if you enable this option.
Compression Threshold	Option appears when you enable the network compression. Specify the compresion threshold value.
Sequence Length	The length of the trail sequence number.
Trail Size (MB)	The maximum size of a file in a trail.
Encryption Profile	Name of the encryption profile associated with the path.
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 restarts automatically if it's terminated.
Auto Restart Options	Section
Retries	The number of times to try an restart the task (path process).
Delay	The duration interval to wait between retries.

Rule Configuration

Description

Enable filtering

If you enable filtering by selecting it from the toggle button and click the Add Rule button, 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 (cent sec)	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.

Note:

The the protocol options in Use Basic Authentication are wss and ws only for target-initiated distribution paths, unlike regular distribution paths, which provide ogg and udt options.

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

X	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 Server 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 Server host) has disabled security.

Limitations

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

• There is no support for interaction between legacy and secure deployments using this mode of operation.

• No support for ogg nor udt protocols. Only ws and wss protocols are supported.

• It is possible to only get information and stop a target-initiated distribution path on Distribution Server and after the path stops, it is not be visible on the Distribution Server.

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 in Admin Client Command Line Interface Commands.

5.4 Using the Path Actions

Once a new path is added, you can perform actions such as stop or pause a path, view reports and statistics, reposition the path, change its filtering, and delete a path, if required.

On the Overview page of the Distribution Server, click the Action button adjacent to the path. From the drop-down list, use the following path actions:

• Details: Use this option to view details of the path. You can view the path information including the source and target. You can also edit the description of the path. Statistical data is also displayed including LCR Read from Trails, LCR Sent, LCR Filtered, DDL, Procedure, DML inserts, updates, and deletes, and so on. You can also update the App Options and TCP Options.

• Stop: Use this option to stop a path. If the path isn’t started, the Start option is displayed rather than the Stop option. You can stop a target-initiated distribution path only from the Distribution Server. Once you stop the path, it'll not be avaiable on the Distrbution Server.

• Stop (in the background): This option stops the path in the background, without engaging the interface. For this option also, the Start (in background) option is displayed incase the path isn’t started.

• Delete: Use this option to delete a path. Click Yes on the confirmation screen to complete path deletion.

• Reposition: Use this option to change the Source Sequence Number and Source RBA Offset

• Change Filtering: Use this option to enter sharding, DML filtering, DDL filtering, Procedure filtering, and Tag filtering options.

Depending on the action you select, you can see the change in status at the bottom of the Overview page.

5.5 Repositioning a Path

You can reposition a path whenever it’s necessary.

On the Overview page of the Distribution Server, click Action adjacent to the path of interest. From the drop-down list, click Reposition.

Change one or both of the source database options to reposition the path, then apply the changes.

5.6 Changing Path Filtering

If you want to change the filter settings for an existing path, the steps are mostly the same as those for creating the filtering for a new path.

On the Overview page of the Distribution Server, click Action adjacent to the path of interest. From the drop-down list, click Change Filtering.

Rule Configuration

Description

Enable filtering

If you enable filtering by selecting it from the toggle button and click the Add Rule button, 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.

After you add a rule, it is listed in Inclusion Rules. You can delete rules or edit them. When you edit a rule, you have the same options as adding a rule with the following added filters:

Option	Description
OR AND	Select one logical operator.
Chunk ID	Edit or delete the database shard settings if sharding is used.
Object Type:	Edit or delete the type of object for the rule.

5.7 Reviewing the Distribution Server Path Information

You can constantly monitor the activity of the path on the Distribution Server Process Information page.

• The path details that you configured. You can change the Description and change the trail format type. When changing the trail format, be sure to apply your changes.

• The advanced options are the delay, flush, and TCP that you configured. You can change any or all of these options, then apply to the path.

The Statistics tab shows you detailed information about the path, such as the different path types and tables. You can use the arrows to sort the tables and the search to quickly locate a specific table. The search is case insensitive and starts searching as you type to update the table.