Add a Distribution Path

A path is created to send the trail data over the network from the Extract to the Replicat, creating a trail path. Before you begin adding a distribution path, make sure you establish a path connection. To set up a path connection, see Add a Path Connection.

Note: When a distribution path connects to a secured deployment, the target must have the full certificate chain (leaf, intermediate, and root CA) in its certificate store, while the source only needs to trust the Root CA by importing it as a trusted certificate. If the secured deployment’s config.securityDetails.network.inbound.authMode is set to clientOptional_server (default), a client certificate is not required. However, if it is set to client_server, the client must use a certificate for authentication, and that certificate must also be added as an Operator user in the target deployment. If the client certificate is signed by a Root CA certificate that is different than the server’s Root CA certificate, the client’s Root CA certificate also needs to be imported as a trusted certificate in the server’s certificate store.

You can begin adding a distribution service path from the Microservices home page itself or use the left navigation pane to access the Distribution Service Paths page, as mentioned in the following steps:

Click Distribution Service Paths option from the left navigation pane to open the Distribution Service Paths page.
Click the plus (+) sign next to Distribution Service Paths. The Add Path wizard is displayed.
On the Path Information screen, notice the Default and Advanced buttons on the top-right corner of the wizard. The Default button is pre-selected. It allows configuring the path for most of the required configurations.
Specify the following values to configure the distribution service path:
- 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.
- Advanced: Select the Advanced button to enable the Air-Gap Security switch and configure it’s options.
  
  The air-gap security setup is meant for environments where the way that trail files are sent from source to target is not managed by Oracle GoldenGate. Extract writes transactions into a trail file and the distribution path will output a local XML trail file. This XML trail file can then be sent to a different deployment where a distribution path will read that trail file and make it available for a Replicat to apply the transactions.
  
  Select one of the following options for setting up the distribution path for Air-Gap secure data delivery depending on whether you are sending or receiving trail data:
  - From: Unclassified/Low-Side
    
    Select this option to configure an Air Gap Path that receives trail data from a secure source location. Provide a name and the required source and target details.
  - To: Classified/High-Side
    
    Select this option to configure an Air Gap Path that writes trail data to a secure target location. Provide a name and source details. Target configuration is simplified for air-gapped delivery.
- Source
  - 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.
  - Begin: Select the point from where you need to log data. You can select the options, Now, Custom Time, Position Log, and CSN (at or after) from the drop-down list.
  - Source Log: Specify the values for the source log: Sequence Number, RBA Offset,
- Target
  - Select the data transfer protocol. Available options include wss, ws, and ogg.
  - Reverse Proxy Enabled: Select to use reverse proxy.
  - 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 File: Name of the source trail file.
  - Target Authentication Method: Select from the drop-down list for the target authentication when the trail file is received by the distribution path. Options are: OAuth, Certificate, UserIDAlias
Click Next.
Select the Encryption check box to set the following encryption options for the path:

NOTE: The Encryption check box does not appear if you enabled the Air-Gap Security switch.
- Encryption Profile: Select an encryption profile from the drop down list, if required.
- 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.
Select the Enable Filtering check box to apply filters on the Receiver Service Paths and click Next. The Filtering screen appears when you select this check box.
On the Filtering screen, specify the following options on the Filtering Options screen to add the filtering rules:
- 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.
Click Add to add the rule and then click Next.
On the Review screen, check the configured distribution service path details and edit, if required. If using the Default setting, then you can configure the Managed Options, as follows:
- 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
On the Review screen, click the Advanced button to configure trail formatting options and the network options.

Format Options: Expand the section and select the trail type from the Type drop down box. Trail format options are Plain Text, XML, SQL. Depending on the selected trail format, set the following trail format options:
- SQL
  - Use Qualified Name: Select to use the fully qualified name of the parameter file.
  - Include Transaction Info: Enable to include transaction information.
  - Compatible With: You can select the compatibility with Oracle, SQLPlus, SQLLOADER.
  - No PK Update: Disabled by default. Enable this switch to allow PK update.
- XML
  - Include Transaction Info: Enable to include transaction information.
  - Include Large Lob: Enable to include large LOB transactions.
  - Include User Token: Enable to include the user token
  - Close Transaction: Enable to close a transaction after the trail file logging transaction completes.
  - Use Inline Properties?: Enable to include the inline trail format properties.
  - Encoding: Select the encoding from the drop-down list.
- Plain Text
  - 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. Options are: 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 in case 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.
Network Options: Expand the section to set the following network configuration:
- HTTP Proxy: Enable this switch to allow http proxy settings for the distribution path.
- 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 compression threshold value.
- Target Trail Sequence Length: The length of the trail sequence number.
- 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.
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 Path 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 Path home page. You can also see this distribution path from the Receiver Service Path home page.