Add Receiver Service Paths

Receiver Service Path are used to initiate a path connection to the Distribution Service on the source deployment and pull trail files from the source.

From the left-navigation pane, select Receiver Service Paths.
Click the + sign on the home page to start adding a path. The Add Receiver Service Path wizard is displayed.
On the Path Information Screen screen, provide a name and description for the Receiver Service Path and then enter values for the following Receiver Service Path options:
- Source: Specify the options for the source deployment which will be connected by the target-initiated path.
  - Reverse Proxy Enabled: Select to use reverse proxy. To know more about configuring your reverse proxy servers, see Configure Oracle GoldenGate Reverse Proxy with NGINX.
  - Source Authentication Method: Select the authentication method for the source URI. Authentication options are OAuth 2.0, Certificate, UserID Alias.
  - Source Protocol: From the drop-down list, select your data transfer protocol. The default option is Secure Web Socket Proctocl (wss). Other option is ws.
  - Source 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. Specify the 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 File: Enter the trail file name that you want to read on your source.
    
    NOTE: The Distribution Service Path doesn’t create any trail on source. It can only read the provided trail file. {. infoboxnote}
  - Source Authentication Method: The source authentication method is preselected based on the selection made on the source deployment. Options include OAuth, Certificate, and UserID Alias.
  - Begin: This option allows configuring the position from where the log data is received. The options are:
    - Now: The current position to begin received trail data.
    - Custom Time: Receive trail data between the specified time period.
    - Position in Log (default): Receive trail data based on the position in log.
    - CSN (at or after): Specify a CSN value at which or after which the trail data would be received.
  - Source Log: Specify the sequence number and RBA offset, if required.
- Target: Specify the trail file name on the target server.
- Use Encryption: Select this check box to set up encryption for the Receiver Service Path.
  - Encryption Profile: Enter the name of the the encryption profile.
  - Target Encryption Algorithm: Select the encryption algorithm for the target trail. Options include AES128, AES192, AES256.
  - Change Encryption: To allow changing the encryption algorithm after the path is created, enable this toggle switch.
1. 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.
2. 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.
3. Click Add to add the rule and then click Next.
4. On the Review screen, check the configured distribution 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
5. 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.

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