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:
When you click the Administrator Service link on the Service Manager home page, the login page for the Administration Service is displayed. After logging in, you’re taken to the Administration Service Home page. You can use this page to configure Extract and Replicat processes.
The Administration Service 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 Service 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 |
|
|
Create a Replicat |
|
|
Stop and start Extracts |
|
|
Stop and start Replicats |
|
|
View and search critical events |
Monitor severity of events using the Critical Events table and also search for specific events, if required. |
Parent topic: Working with Data Replications
To create and run Extracts, you must first set up and test database credentials.
Launch the Administration Server interface.
Log in to the server.
Click the Application Navigation icon in the upper left of the Administration Server.
Select Configuration from the exposed left pane.
Click the + sign next to Credentials, and set up your new credential alias, then click Submit.
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.
Parent topic: Working with Data Replications
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.
Launch the Administration Server interface.
Log in to the server.
Click the Application Navigation icon in the upper left of the Administration Server.
Select Configuration from the exposed left pane.
Click the + sign next to Credentials, and set up your new credential alias, then click Submit.
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.
Click + to add your Extract.
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.Enter and select the required information, which is designated with an asterisk (*). For all Extracts the Process Name, Credential Domain, and Credential Alias are required. A Description is optional. The Create new credential option is common to all Extracts. You can configure the following additional required and optional details based on the type of Extract you selected to create:
| Option | Description | Extract Type |
|---|---|---|
|
Intent |
What you want the Extract to be used for, such as High Availability or the Unidirectional default. |
Classic, Integrated, and Initial Load |
|
Begin |
How you want the Extract to start. At a custom time that you select, a database CSN, or the Now default. |
Classic and Integrated |
|
Trail Name |
A two character trail name. |
Classic and Integrated |
|
Trail SubDirectory, Size, Sequence, and Offset |
You can further configure the trail details. |
Classic and Integrated |
|
Remote |
Set if the trail is not on the same server. |
Classic and Integrated |
|
Thread Number |
Set to a specific redo log number. The default is 1. |
Classic |
|
Log Retention |
Set to retain the Extract logs. |
Classic |
Click Next.
You can 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.
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.
Parent topic: Working with Data Replications
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:
|
|
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.
Parent topic: How to Add Extracts
You can add Replicats for the target deployment from the Administration Server.
Parent topic: Working with Data Replications
You can create a parallel Replicat 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 Replicat in Integrated Mode does not support COMMIT_SERIALIZATION.
Creating a Non-Integrated Parallel Replication with the Administration Server
Log into the Administration Server.
Click Application Navigation on the top-left corner.
Select Configuration. Make sure that the database credentials are correct and the database user is connected. See How to Add a Database User
for details.Click the + sign to add a checkpoint table.
Enter the schema.name of the checkpoint table that you would like to create, and then click Submit.
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.
Click Overview to return to the main Administration Server page.
Click the + sign next to Replicats.
Select Nonintegrated Replicat then click Next.
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.
Click Next, and then click Create and Run to complete the Replicat creation.
Creating a Non-Integrated Parallel Replicat with the Admin Client
Go the bin directory of your Oracle GoldenGatehome directory.
cd $OGG_HOME/bin
Start the Admin Client.
adminclient
The Admin Client command prompt is displayed.
OGG (not connected) 12>
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.
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.
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
Parent topic: How to Add Replicats
The following table lists the basic parallel Replicat 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 minimum value is |
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 |
MIN_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 |
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 |
|
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 *.*;
Parent topic: Creating a Parallel Replicat
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:
|
|
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 Stop |
The Replicat is immediately, forcibly 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.
Parent topic: How to Add Replicats
The Administration Server performs the commands that were executed by the GGSCI utility in previous releases. However, the Administration Service provides enhanced capabilities to perform these tasks, while still being compatible with GGSCI.
Starting an Administration Service Task
You can set up various automated operations for Administration Service tasks, such as purging, load balancing, and failover support. To set up this operation:
Select Configuration from the left navigation pane of the Administration Service.
Select the Maintenance tab.
Enter the Operation Name for the Administration Service task in the Create New Auto Start Task section.
Select Enabled to keep the task active.
Enter the process name associated with the task that you need to perform and click Submit.
Restarting an Administration Service Task
Auto Restart allows you to automatically restart a process that has 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.
Select Auto Restart.
Enter the Administration Service task name in the Operation Name field.
Keep the Enabled setting ON to ensure that the operation is active.
Enter the Oracle GoldenGate process name, such as START EXTRACT or STOP REPLICAT, associated with the task.
Specify the Delay time to attempt restarting the task.
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.
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 Manager PURGEOLDEXTRACTS 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 Service purge trail process.
Add a Purge Trail task by clicking the + sign .
Enter the Operation Name of the Administration Service task.
Enter the trail path or trail name in the Trail field.
Click the + sign to add the trail to the Selected Trails list.
If you don’t need to use Checkpoints, disable the option Use Checkpoints.
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.
Specify the number of hours or days when the purge trails task has to run, in the Purge Frequency field and click Submit.
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 Service.
Enter the Operation Name that you need to set up for automatic purging.
Select the Extract or Replicat task (initial load process) Process Name for the operation. The list contains all processes so ensure that you select the correct task.
Select the Extract or Replicat task (initial load) Process Type for the operation.
If you enable Use Stop Status, the status of the task is used to perform the purge task.
Enter the hours or days after which you need to purge the process and click Submit.
Edit or delete the purge process task using the relevant icon from the Purge Tasks table.
Using Master Keys
If you want to encrypt your data, then create a Master Key by clicking the + sign in the Master Key section. 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. .
Parent topic: Working with Data Replications
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:
Select the Configuration option from the Administration Server left-navigation pane.
Select the Parameter Files tab.
A list of existing parameter files is displayed along with the GLOBALS parameter file.
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.
Click + add parameter files.
Enter the file name and the required parameters. Make sure to enter the file name with the .prm extension.
Click Submit. The new parameter file is displayed in the list of parameter files.
Parent topic: Working with Data Replications
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.
Parent topic: Working with Data Replications
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.
Using the Table
An updated log of Extract and Replicat server messages is displayed. You can sort the list by date or severity by clicking on the adjacent arrow. Also, you can refresh this log and choose how many pages you want to view.
To search, you select Date, Severity, or Message, and then select the appropriate options to construct your search.
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.
Parent topic: Working with Data Replications
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.
Click Administrator from the left navigation pane of the Administration Server.
Click + to add a user.
Enter the required credentials in the fields.
Make sure that you select a role from the Role drop-down list. The available roles are: Administrator, Security, User, and Operator.
Click Submit.
The new user is listed in the Users table including the role and information that you supplied.
Parent topic: Working with Data Replications
To successfully link Oracle GoldenGate Microservices Architecture and Classic Architecture, ensure that the Distribution Service knows where to place the remote trail file for reading.
Note:
For this procedure to work, an existing Extract must be running in Microservices Architecture.Parent topic: Working with Data Replications