5 Working with Paths

The path between a source and target deployment can be set using the Distribution Server.

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

Topics:

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

To add a path to set the trail for the source deployment:
  1. From the Service Manager, click Distribution Server.
  2. Click the plus (+) sign next to Path.
    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.

    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.

    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

    Target

    Enter the target endpoint of the path. From the drop-down list, select your data transfer protocol. The default option is wss.

    You also need to enter the URL of the target host, for example, localhost, if the target is on the same system. You may enter the port number of the Receiver Server 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. Path takes the source trail and sends the date to a target trail given here, which can be consumed by any Replicats created later.

    Use Basic Authentication

    Select to add a credential to the target URI creating basic MA authentication.

    Generated Target URI

    A source 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.

    Configure Trail Format

    You can optionally toggle this switch to select one of these types Plain Text, XML, or SQL.

    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 RBA of the record for the source deployment.

    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.

    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.

    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.

    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.

    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 Receiver Buffer Size

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

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

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

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