4 Working with Data Replication

You can perform all data replication tasks from the Administration Server home page. You can, add Extracts and Replicats and start the distribution path, once your deployments are created.

Topics:

4.1 Quick Tour of the Administration Server Home Page

When you click the Administrator Server link on the Service Manager home page, the login page for the Administration Server is displayed. After logging in, you’re taken to the Administration Server Home page. You can use this page to configure Extract and Replicat processes.

The Administration Server Home page is used to add Extracts and Replicats and view the current state of them. The table on the home page, displays the severity of critical events. You can also use the left-navigation pane to access various configuration details, a list of severity issues with their diagnosis, and a list of administrators.

Now, that you have an overview of the Administration Server Home page, let’s understand some of the key actions that you can perform from this page.

Action Description
View the home page in tabular format Use the Table Layout swivel to turn the tabular format on and off.
View Extracts and Replicats The statistical representation the home page displays current state of Extracts and Replicats (Starting, Running, Stopped, Abended, Killed)
Add an Extract See How to Add an Extract for a Deployment
Create a Replicat See How to Add a Replicat
Stop and start Extracts Using Extract Actions
Stop and start Replicats See Using Replicat Actions
View and search critical events Monitor severity of events using the Critical Events table and also search for specific events, if required.

4.2 How to Add a Database Credential

To create and run Extracts, you must first set up and test database credentials.

  1. Launch the Administration Server interface.

  2. Log in to the server.

  3. Click the Application Navigation icon in the upper left of the Administration Server.

  4. Select Configuration from the exposed left pane.

  5. Click the + sign next to Credentials, and set up your new credential alias, then click Submit.

  6. Click the Login icon to verify that the new alias can correctly log in to the database.

    If an error occurs, click the Alter Credential icon to correct the credential information, and then test the log in.

You can edit existing credentials to change the user name and password. Delete a credential by clicking the trash icon.

When you successfully log into your database, you can add and manage checkpoint tables, transaction information, and heartbeat tables. All of the tables can be searched using the various search fields. As you type, the table is filtered and you can use the search button with the search text.

4.3 How to Add Extracts

To create and run Extracts, you must first set up database credentials. Once the Extract is running, you can monitor checkpoint table, and the Extract report from the Administration Server.

  1. Launch the Administration Server interface.

  2. Log in to the server.

  3. Click the Application Navigation icon in the upper left of the Administration Server.

  4. Select Configuration from the exposed left pane.

  5. Click the + sign next to Credentials, and set up your new credential alias, then click Submit.

  6. Click the Login icon to verify that the new alias can correctly log in to the database.

    If an error occurs, click the Alter Credential icon to correct the credential information, and then test the log in.

  7. Click + to add your Extract.

  8. Choose the type of Extract to create and click Next. The types of Extract are:

    • Integrated Extract

    • Classic Extract

    • Initial Load Extract

    Note:

    An Initial Load Extract cannot be started from a secure deployment. You can only start it in a non-secure deployment.
  9. Enter or select the required information, which is designated with an asterisk (*), and then click Next.

  10. Edit the parameter file in the text area to list the table details that you are interested in capturing. For example, table source.table1;.

    You can select Register Extract in the background to register the Extract in the background asynchronously.

  11. Click Create and Run to create and start the Extract. If you select Create, the Extract is created but you need to start it using the Extract drop-down on the Overview page.

    You are returned to the Overview page of the Administration Server. You can select the Action list to look at Details of the Extract, such as process information, checkpoint, statistics, parameters, and report. See Using Extract Actions.

4.3.1 Using Extract Actions

Once you create an Extract, you can monitor various details associated with the Extract from the Administration Server home page.

You can change the status of the Extract process using the Action button to:

Action Result

Details

Displays the following tabs:

  • Process Information

  • Statistics: Displays the active replication maps along with replication statistics based on the type of Extract. You can select options Total, Daily, and Hourly to view the entire statistical data, or on a daily or hourly basis.

  • Checkpoint: Displays the checkpoint log name, path, timestamp, sequence, and offset value. You can monitor the input details such as when starting, at recovery, and the current state. The checkpoint output values display the current checkpoint details.

  • Parameters: Displays the parameters configured when the Extract was added. You can edit the parameters by clicking the Edit icon on the Parameters tab.

  • Report: This displays a detailed report of the Extract including parameter settings and a log of the Extract transactions.

Start/Stop

The Extract starts or stops immediately.

Start/Stop (in the background)

The Extract is started or stopped using a background process.

Start with Options

Allows you to change the Extract CSN options, then starts the Extract.

Alter

This option is available only when the Extract is stopped. Allows you to change when the Extract begins, the description, and the intent. It does not start the Extract.

Delete

This option displays only when the Extract is stopped. Deletes the Extract if you confirm the deletion.

When you change the status, the list options change accordingly. As status are changing, the icons change to indicate the current and final status. The events are added to the Critical Events table. Additionally, progress pop-up notifications appear at the bottom of the page.

4.4 How to Add Replicats

You can add Replicats for the target deployment from the Administration Server.

Make sure that you have configured your deployments correctly, checked your database credentials, and created an Extract before you set up your Replicat. For details see Working with Deployments and Services. Once you’ve set up your source and target deployment, you can create and run the Replicat by following these steps:
  1. Click the + sign next to Replicats on the Administration Server home page.
    The Add Replicat page is displayed.
  2. Select a Replicat type and click Next.
    The types of Replicat are:
    • Integrated Replicat

    • Nonintegrated Replicat

    • Coordinated Replicat

    • Parallel Replicat: If you select this option, then select an integrated or nonintegrated parallel Replicat.

  3. Enter the required Replicat options on the Replicat Options page and click Next. To know more about the Replicat options, see the online help.
  4. Click Create and Run to create and run the Replicat or Create to run the created Replicat later.

    You can select Register Replicat in the background to speed the Replicat creation.

    You are returned to the Overview page of the Administration Server. You can select the Action list to look at Details of the Replicat, such as the report file, statistics, and parameters.

4.4.1 Creating a Parallel Replication

You can create a parallel replication using the graphical user interface or the command line interface.

A parallel replicat requires a checkpoint table so both the Administration Server UI and Admin Client issue an error when the parallel replicat does not include a checkpoint table.

Note:

Parallel replication does not support COMMIT_SERIALIZATION in Integrated Mode. To use this apply process, use Integrated Replicat.

Creating a Non-Integrated Parallel ReplicatIon with the Administration Server

  1. Open a browser and connect to the Service Manager that you created with the Configuration Assistant:

    https://server_name:service_manger_port/
    

    For Example, https://localhost:9000/. In an non secured environment, use http instead of https.

    The Oracle GoldenGate Service Manager is displayed.

  2. Enter the username and password you created and click Sign In.

    In the Service Manager, you can see servers that are running.

  3. In the Services section, click Administration Server, and then log in.

  4. Click the Application Navigation icon to the left of the page title to expand the navigation panel.

  5. Create the checkpoint table by clicking Configuration in the right navigation panel.

  6. Ensure that you have a valid credential and log in to the database by clicking the ‘log in database’ icon under Action.

  7. Click the + sign to add a checkpoint table.

  8. Enter the schema.name of the checkpoint table that you would like to create, and then click Submit.

  9. Validate that the table was created correctly by logging out of the Credential Alias using the log out database icon, and then log back in.

    Once the log in is complete, your new checkpoint table is listed.

  10. Click Overview to return to the main Administration Server page.

  11. Click the + sign next to Replicats.

  12. Select Nonintegrated Replicat then click Next.

  13. Enter the required information making sure that you complete the Credential Domain and Credential Alias fields before completing the Checkpoint Table field, and then select your newly created Checkpoint Table from the list.

  14. Click Next, and then click Create and Run to complete the Replicat creation.

Creating a Non-Integrated Parallel Replicat with the Admin Client

  1. Go the bin directory of your Oracle GoldenGate installation directory.

    cd $OGG_HOME/bin
    
  2. Start the Admin Client.

    ./adminclient
    

    The Admin Client command prompt is displayed.

    OGG (not connected) 12>
    
  3. Connect to the Service Manager deployment source:

    connect http://localhost:9500 deployment Target1 as oggadmin password welcome1
    

    You must use http or https in the connection string; this example is a non-SSL connection.

  4. Add the Parallel Replicat, which may take a few minutes to complete:

    add replicat R1, parallel, exttrail bb checkpointtable ggadmin.ggcheckpoint
    

    You could use just the two character trail name as part of the ADD REPLICAT or you can use the full path, such as /u01/oggdeployments/target1/var/lib/data/bb.

  5. Verify that the Replicat is running:

    info replicat R1
    

    Messages similar to the following are displayed:

    REPLICAT   R1        Initialized   2016-12-20 13:56   Status RUNNING
    NONINTEGRATED
    Parallel
    Checkpoint Lag       00:00:00 (updated 00:00:22 ago)
    Process ID           30007
    Log Read 
    Checkpoint  File ./ra000000000First Record  RBA 0
    

4.4.1.1 Basic Parameters for Parallel Replicat

The following table lists the basic parameters and their description.

Parameter

Description

MAP_PARALLELISM

Configures number of mappers. This controls the number of threads used to read the trail file. The default value is 2.

APPLY_PARALLELISM

Configures number of appliers. This controls the number of connections in the target database used to apply the changes. The default value is 4.

MIN_APPLY_PARALLELISM

MAX_APPLY_PARALLELISM

The Apply parallelism is auto-tuned. You can set a minimum and maximum value to define the ranges in which the Replicat automatically adjusts its parallelism. There are no defaults. Do not use with APPLY_PARALLELISM at same time.

SPLIT_TRANS_REC

Specifies that large transactions should be broken into pieces of specified size and applied in parallel. Dependencies between pieces are still honored. Disabled by default.

COMMIT_SERIALIZATION

Enables commit FULL serialization mode, which forces transactions to be committed in trail order.

Advanced Parameters

 
LOOK_AHEAD_TRANSACTIONS

Controls how far ahead the Scheduler looks when batching transactions. The default value is 10000.

CHUNK_SIZE

Controls how large a transaction must be for Parallel Replicat to consider it as large. When Parallel Replicat encounters a transaction larger than this size, it will serialize it, resulting in decreased performance. However, increasing this value will also increase the amount of memory consumed by Parallel Replicat.

Example Parameter File

replicat repA
userid ggadmin, password ***
MAP_PARALLELISM 3
MIN_APPLY_PARALLELISM 2
MAX_APPLY_PARALLELISM 10
SPLIT_TRANS_RECS 1000
map *.*, target *.*;

4.4.2 Using Replicat Actions

Various Replicat actions can be performed from the Administration Server Overview page.

You can change the status of the Replicat process using the Actions button to:

Action Result

Details

Displays the Process Information page that has the following details:

  • Statistics: Displays the active replication maps along with replication statistics based on the type of Replicat.

  • Parameters: Displays the parameters configured when the Replicat was added. You can change these parameters to adjust your Replicat.

  • Report: Displays the details about the Replicat including the parameters with which the replicat is running, and run time messages.

  • Checkpoint: Displays the checkpoint log name, path, timestamp, sequence, and offset value. You can click the Checkpoint Detail icon to view elaborate information about the checkpoint.

Start/Stop

The Replicat starts or stops immediately.

Start/Stop (in the background)

The Replicat is started or stopped using a background process.

Start with Options

Allows you to change the Replicat start point, CSN, filter duplicates, and threads options, then starts the Replicat.

Force Start/Stop

The Replicat is immediately, forcibly started or stopped.

Alter

Allows you to change when the Replicat begins, the description, and the intent. It does not start the Replicat.

Delete

Deletes the Replicat if you confirm the deletion.

When you change the status, the list options change accordingly. As status are changing, the icons change to indicate the current and final status. The events are added to the Critical Events table. Additionally, progress pop-up messages appear in the bottom of your browser.

4.5 Setting Up Automated Tasks

The Administration Server performs the commands that were executed by the GGSCI utility in previous releases. However, the Administration Server provides enhanced capabilities to perform these tasks, while still being compatible with GGSCI.

Starting an Administration Server Task

You can set up various automated operations for Administration Server tasks, such as purging, load balancing, and failover support. To set up this operation:

  1. Select Configuration from the left navigation pane of the Administration Server.

  2. Select the Maintenance tab.

  3. Enter the Operation Name for the Administration Server task in the Create New Auto Start Task section.

  4. Select Enabled to keep the task active.

  5. Enter the process name associated with the task that you need to perform and click Submit.

  6. Create a Master Key by clicking the + sign in the Master Key section, if you need to encrypt the data. The master key is generated automatically. You can change the status of the key to Available or Unavailable, by clicking the edit icon in the Master Key table. You can also delete the Master Key from the table by clicking the delete icon. For details on the Master Key concept, see Encrypting Data with the Master Key and Wallet Method.

Restarting an Administration Server Task

Auto Restart allows you to automatically restart a task that is stopped or abended. It enables you to configure the number of retries to attempt restart and set the delay parameter as well.

You can configure these options from the Auto Restart page on the Maintenance tab.

  1. Select Auto Restart.

  2. Enter the Administration Server task name in the Operation Name field.

  3. Keep the Enabled setting ON to ensure that the operation is active.

  4. Enter the Oracle GoldenGate process name, such as START EXTRACT or STOP REPLICAT, associated with the task.

  5. Specify the Delay time to attempt restarting the task.

  6. Enter the maximum number of retries to attempt restarting the task. You can choose to enable the option to Disable Task After All Retries, to disable auto restart attempts after exhausting the number of retries.

  7. Click Submit.

    The new task is displayed in the Auto Restart task table.

    You can edit or delete a task from the table also, using the Delete and Edit icons for the corresponding task in the table.

Purging Trails

The Purge Trail page works the same way as the ManagerPURGEOLDEXTRACTS parameter in the Classic Architecture. It allows you to purge trail files when Oracle GoldenGate has finished processing them. Automating this task ensures that the trail files are periodically deleted to avoid excessive consumption of disk space.

From the Maintenance tab, when you select the Purge Trail page, it allows you to configure the Administration Server purge trail process.

  1. Add a Purge Trail task by clicking the + sign .

  2. Enter the Operation Name of the Administration Server task.

  3. Enter the trail path or trail name in the Trail field.

  4. Click the + sign to add the trail to the Selected Trails list.

  5. If you don’t need to use Checkpoints, disable the option Use Checkpoints.

  6. Set the Keep Rule value to specify the maximum number of hours, days, or number of files for which the Purge Trails task must be active.

  7. Specify the number of hours or days when the purge trails task has to run, in the Purge Frequency field and click Submit.

  8. Use the Purge Trails task table to edit or delete the task, as required.

Purging Tasks

You can automatically purge processes associated with an Administration Server.

From the Maintenance tab, use the Purge Tasks page.
  1. Enter the Operation Name that you need to set up for automatic purging.

  2. Enter the Process Name for the operation.

  3. If you enable Use Stop Status, the status of the task is used to perform the purge task.

  4. Enter the hours or days after which you need to purge the process and click Submit.

  5. Edit or delete the purge process task using the relevant icon from the Purge Tasks table.

4.6 How to Access the Parameter Files

The Global parameters, Extract, Replicat parameter files are available in the Parameter Files section of the Administration Server.

You use the Administration Server Configuration page and Parameter Files tab to work with your various parameter files.

You use the different parameter file options:

  1. Select the Configuration option from the Administration Server left-navigation pane.

  2. Select the Parameter Files tab.

    A list of existing parameter files is displayed along with the GLOBALS parameter file.

  3. If you select any of the parameter files, you are presented with the option to edit or delete the selected file. If you want to change the GLOBALS parameter file, you need to stop and restart all of the services.

  4. Click + add parameter files.

  5. Enter the file name and the required parameters. Make sure to enter the file name with the .prm extension.

  6. Click Submit. The new parameter file is displayed in the list of parameter files.

4.7 Review Critical Events

You can review and search for critical events from the Administration Server home page, once you set up the distribution path.

Once you set up the Extracts and Replicats along with the Distribution path, you are able to see the critical events associated with them.

Search for Critical Events from the Review Critical Events Table

The Review Critical Events table displays the severity, error code, and error messages for critical events. You can view 20 error messages on a single page and you can also search for specific events.

Additionally, you can examine events in depth from the Performance Metrics Server. For details see Quick Tour of the Performance Metric Server home page.

4.8 How to Access Extract and Replicat Log Information

The diagnosis of Extract and Replicat transactions provides information about the severity of a transaction along with the timestamp. This information is helpful in case you need to determine if and when a particular issue occurred including the cause of the issue.

The Extract and Replicat log information is available on the Diagnosis page of Administration Server. To access the Diagnosis page, click the left navigation page of the Administration Server and select Diagnosis. An updated log of Extract and Replicat server messages is displayed.

Notice the Notifications tab at the bottom of the page. It displays server messages, which are not updated in the log due to transaction errors for example, failure to log in to the database using the database credentials.

4.9 How to Create Users for Oracle GoldenGate MA

Oracle GoldenGate MAusers can be created from the Administration Server, once you log in using the credentials created at the time of configuring the deployment.

To create a user, perform the following tasks:
  1. Click Administrator from the left navigation pane of the Administration Server.

  2. Click + to add a user.

  3. Enter the required credentials in the fields. Make sure to select from the list of roles available using the Role list box. The available roles are: Administrator, Security, User, and Operator.

  4. Click Submit.

    You can see the user listed in the Users table once you create the user successfully.