4 Managing Identities and Comparing Data
The Vericom
command-line interface provides a tool for you to manage
identities in the credential store and run comparisons.
This chapter includes the following sections:
4.1 Overview of the Vericom Tool
You can use the vericom
tool to execute certain comparison
tasks from the command shell of the operating system. The vericom
tool runs the Oracle GoldenGate Veridata command-line interface and enables you to handle
these activities with automated programs.
You can:
-
Run an entire job or a specific compare pair of a job
Note:
You cannot run a group individually. -
Set tracing (only under guidance of an Oracle Support analyst)
For specific compare pairs, you can:
-
Review previous out-of-sync results
-
Generate out-of-sync XML from the previous run
-
Override the same profile and row partition settings that are possible from the web user interface
You can also run comparisons from the Oracle GoldenGate Veridata web user interface. This interface provides greater control for configuring the objects to be compared and for controlling runtime parameter settings.
For more information, see Using the Oracle GoldenGate Veridata Command-line Utilities- Vericom, Veridata GoldenGate Parameter Processing, and Import/Export.
4.2 Running the Vericom Tool
Anyone who has operating system permissions can run the vericom
tool.
- On the system where Oracle GoldenGate Veridata is installed, run the operating system’s command shell.
- Navigate to the
VERIDATA_DOMAIN_HOME
/veridata/bin
directory. - Run the
vericom
tool with the following parameters:
Basic Parameters
- Run the Vericom tool:
/vericom.sh -wluser <wlusername> -wlport <wlport>
. For example:/vericom.sh -wluser vericom -wlport 8830
- Run the command to identify the Oracle GoldenGate Veridata
version:
/vericom.sh -wluser <wlusername> -wlport <wlport> -version
. For example:/vericom.sh -wluser vericom -wlport 8830
- Run a job:
/vericom.sh -wluser <wluser> -wlport <wlport> -job <job name> -g <group name> -c <compare pair>
For example:
Sample output:./vericom.sh -wluser vericom -wlport 8830 -job Vericom -g Vericom -c DP=DP
OGGV-20032: Run ID: (7979,0,0) OGGV-20033: Number of Rows Compared: 5 OGGV-20034: Number of Rows In Sync: 1 OGGV-20035: Number of Rows With Errors: 0 OGGV-20036: Number of Rows Out Of Sync: 4 OGGV-20037: Compare Pair OOSXML Directory: /scratch/username/Oracle_Home/user_projects/domains/base_domain1/veridata/reports/oosxml/Vericom/00007979/Vericom OGGV-20038: Compare Pair OOSXML Filename: OGGV-20039: Job Completion Status: With Out-Of-Sync bash-4.4$
- Purge a job: For example:
/vericom.sh -wluser vericom -wlport 8830 -purgeJobReports job1,job2,job3
The
purgeJobReports all
parameter deletes all the latest jobs and reports. - Run the Help Command:
/vericom.sh -wluser <wlusername> -wlport <wlport> -version -help
For example:
/vericom.sh -wluser vericom -wlport 8830 -help
Sample output:Oracle GoldenGate Veridata Command Line Interface - Version 12.2.1.4.0 190913 release build 19 vericom [-wlport <port> ] -wluser <user Name> { -job | -j } <job> [run_flags] | -help | { -version | -v} | -helprun Where: [-wlport <port> ] Weblogic port number -wluser <user Name> Weblogic User Name to connect { -job | -j } <job> Run job <job> -help Print usage. -version, -v Print version. -helprun Print usage of run_flags run_flags Flags for running a job or compare pair -addCredentialStore Create new Credential Store at location defined in veridata.cfg file -deleteCredentialStore Delete Credential Store -createAlias Create alias for user provided in wluser argument -updateAlias Update username and password for alias with user provided in wluser argument -deleteAlias Delete alias -displayAlias Display alias stored in the credential store -wlUserAlias Use alias inplace of wluser
- Run the Help Run Command:
/vericom.sh -wluser <wlusername> -wlport <wlport> -version -helprun
For example:
/vericom.sh -wluser vericom -wlport 8830 -helprun
Sample output:Oracle GoldenGate Veridata Command Line Interface - Version 12.2.1.4.0 190913 release build 19 vericom [-wlport <port> ] -wluser <user Name> { -job | -j } <job> [run_flags] | -help | { -version | -v} | -helprun Where: [-wlport <port> ] Weblogic port number -wluser <user Name> Weblogic User Name to connect { -job | -j } <job> Run job <job> -help Print usage. -version, -v Print version. -helprun Print usage of run_flags run_flags Flags for running a job or compare pair -addCredentialStore Create new Credential Store at location defined in veridata.cfg file -deleteCredentialStore Delete Credential Store -createAlias Create alias for user provided in wluser argument -updateAlias Update username and password for alias with user provided in wluser argument -deleteAlias Delete alias -displayAlias Display alias stored in credential store -wlUserAlias Use alias inplace of wluser Run Flags Usage: [ -g group_name -c compare_pair_name ] [ -rP profile_name ] [ -rR | -rO ] [ -rN number_of_threads ] [ -rD number_of_seconds ] [ -rC | +rC ] [ -rOb | -rOx | -rO2 | -rO0 ] [ -rOs number_of_rows ] [ -rd0 | -rdN run_id ] [ -pS partition_name | -pSq SQL_predicate | -pSA1 ascii_start_key | -pSA2 ascii_ending_key | -pSH1 hex_start_key | -pSH2 hex_ending_key ] [ -pT partition_name | -pTq SQL_predicate | -pTA1 ascii_start_key | -pTA2 ascii_ending_key | -pTH1 hex_start_key | -pTH2 hex_ending_key ] [ -pq SQL_predicate ] [-nw ] [ -w | -wp interval ] [ -repair ] [ -norepair ] Where: -g group_name Name of the group. Requires -c. -c compare_pair_name Name of the compare pair. Requires -g. -rP profile_name Override the default profile. -rR Review Previous OOS Results. -rO Generate OOS XML from Previous Run. -rd0 Do not use delta base from previous run for this job. Requires -c. -rdN run_id Use delta base from run run_id. Requires -c. -rN number_of_threads Override the number of concurrent threads. -rD number_of_seconds Override the COOS delay for this job. -rC Do not run COOS this job. +rC Do run COOS this job. -rOb Generate binary OOS for this job. -rOx Generate XML OOS for this job. -rO2 Generate both binary and XML OOS for this job. -rO0 Do not generate OOS for this job. -rOs number_of_rows Number of rows in each OOS XML chunk for this job. -pS Use named partition on the source. -pSq Use SQL predicate on the source. -pSA1 Use arg as the starting ascii key the source. -pSA2 Use arg as the ending ascii key the source. -pSH1 Use arg as the starting hexadecimal key the source. -pSH2 Use arg as the ending hexadecimal key the source. -pT Use named partition on the target. -pTq Use SQL predicate on the target. -pTA1 Use arg as the starting ascii key the target. -pTA2 Use arg as the ending ascii key the target. -pTH1 Use arg as the starting hexadecimal key the target. -pTH2 Use arg as the ending hexadecimal key the target. -pq Use SQL predicate on the source and target. -nw Do not wait for job to complete; job is submitted in background. -wp Wait for job to complete, poll at specified interval. -repair Launch a repair job automatically after compare job finishes. ] -norepair Do not launch a repair job automatically, after compare job finishes. ] -repairsql Supports generation of repair sql after the Job comparison is completed. When the compare is complete, a repair sql zip file gets generated if out-of-sync data exists. This flag is valid only for Oracle and SQL Server target databases. ]
See Securing Access to Oracle GoldenGate Veridata by Defining User Groups.
The -version
, -v
, -help
,
or -helprun
options, they take precedence over any other option
specified.
Table 4-1 Explaining the Vericom Basic Parameters
Argument | Description |
---|---|
-wluser |
Specifies the server user name that authenticates and connects to the server. |
-ssl |
Used to connect to Oracle GoldenGate Veridata Server through the SSL. |
-wlport |
Specifies the server port number. |
-help |
Displays the |
-helprun |
Displays run-related syntax components and their descriptions. |
{-version |
-v} |
Displays the version of the Oracle GoldenGate Veridata command-line interface that is being used. |
{-job | -j}
job |
Specifies the job to be run. For
|
-g group -c
compare_pair |
Specifies a group and compare pair. For
|
Table 4-2 Explaining the Vericom Advanced Parameters
4.3 Managing Identities in a Credential Store
The credential store is implemented as an Auto Login wallet within the Oracle Credential Store Framework.
This section shows you how to use a credential store to maintain encrypted database passwords and user IDs and associate them with an alias. It is the alias, not the actual user ID or password, that is specified in a command or parameter file. No user input of an encryption key is required.
Credential Store contains the following topics:
Alias contains the following topics:
4.3.1 Adding a Credential Store
The –addCredentialStore
argument does not accept any input. The default location for credential store is <Domain_home>/veridata/dircrd
. You can change this by specifying a directory in the veridata.cfg
file under the credential.store.location
property. The default value of the credential.store.location
property is veridata/dircrd
which is relative to the domain location. You can create your own credential store location and change this property before running vericom
. The credential store wallet is created with only read and write permissions (-rw-------).
Example 4-1
./vericom.sh -wluser vericom -wlport 8830 -addCredentialStore
4.3.2 Creating an Alias
The -createAlias
argument accepts zero or one as input. If the input is
provided, then it is used as an alias name. If it is not provided, then the user name
provided in the wluser
argument is used as an alias. This alias is used
in place of the user name and password, and you do not have to provide an actual user
name and password.
Example 4-2
./vericom.sh -wluser vericom -wlport 8830 -createAlias
4.3.3 Deleting a Credential Store
The —deleteCredentialStore
argument does not accept any input. This option deletes the credential store. The location for the credential store is credential.store.location
in the veridata.cfg
file. The credential store wallet and its contents are permanently deleted.
Example 4-3
./vericom.sh -wluser vericom -wlport 8830 -deleteCredentialStore
4.3.4 Using the Alias
You must use the -wluserAlias
argument with the alias that you created with -createAlias
. With this option, you are not prompted for a password. You should not use the -wluserAlias
argument with -wluserAlias
. If the alias does not exist in the wallet, then an error is returned.
Example 4-4
./vericom.sh -wluserAlias vericom -wlport 8830 -job Vericom
4.3.5 Display Alias
Use the -displayAlias
argument to list all aliases and user names in the wallet. The password is not displayed.
Example 4-5
vericom.sh –wluser vericom -wlport 8830
-displayAlias
Alias : vericom
Username : vericom
4.4 Vericom Exit Statuses
The vericom
command-line tool exits with one of the following statuses. The examples are for a UNIX or Linux system.
Vericom exits with one of the following statuses. This examples shown are for a UNIX or Linux system.
Table 4-3 Vericom Exit Status
Status | Description |
---|---|
0 |
The command executed successfully. If a job was run, then all rows are in-sync. If you specified |
1 |
Invalid
|
3 |
Provides more granularity for input errors that involve comparison flags. For example, the following mistakes cause this error:
In the preceding example, the
In the preceding example, the |
4 |
The job contains rows that are out of sync. |
5 |
There was a communication error with the server. |
6 |
The job has failed. |
7 |
The job was cancelled. |
4.5 Vericom Output Examples
To view the results of a comparison that you run with the vericom tool, you can use the Oracle GoldenGate Veridata web user interface to view the comparison report. You can also view the output that is returned by the tool to the terminal. If a run finishes successfully, statistics for the job are displayed.
See Viewing Comparison Results.
The following examples use the TestJob
job:
- Example 1
-
This example shows a run on a Windows system without specifying
‐w
. The process exits with status 0, and finished job statistics are not displayed.VERIDATA_DOMAIN_HOME\veridata\bin\vericom.bat -wluser veridata -wlport 8830 -j TestJob Connecting to: localhost:9177 Run ID: (2256, 0, 0) C:\veridata\server\bin> if errorlevel 0 echo EXITED 0 STATUS EXITED 0 STATUS
- Example 2
-
This example shows a run of the
TestJob
with-w
specified. The process exits with status 4 because one of the compare pairs had a validation error. Finished job statistics are displayed.VERIDATA_DOMAIN_HOME\veridata\bin\vericom.bat -wluser veridata -wlport 8830 -j TestJob -w Connecting to: localhost:9177 Run ID: (2257, 0, 0) Job Start Time: 2008-03-21 22:48:05 Job Stop Time: 2008-03-21 22:48:20 Job Report Filename: C:\testjunit\rpt\TestJob\00002257\TestJob.rpt Number of Compare Pairs: 3 Number of Compare Pairs With Errors: 1 Number of Compare Pairs With OOS: 1 Number of Compare Pairs With No OOS: 1 Number of Compare Pairs Cancelled: 0 Job Completion Status: WITH ERRORS C:\veridata\server\bin> if errorlevel 4 echo EXITED 4 STATUS EXITED 4 STATUS
- Example 3
-
This example shows a run of the
TABLE9=TABLE9
in jobTestJob
with-w
specified. The process exits with status 0 because the tables are in sync. Finished job statistics are displayed.VERIDATA_DOMAIN_HOME\veridata\bin\vericom.bat -wluser veridata -wlport 8830 -j TestJob -g TestGroup -c TABLE9=TABLE9 -w Connecting to: localhost:9177 Run ID: (2258, 0, 0) Job Start Time: 2008-03-21 22:51:08 Job Stop Time: 2008-03-21 22:51:11 Job Report Filename: C:\veridata\data\rpt\TestJob\00002258\TestJob.rpt Number of Compare Pairs: 1 Number of Compare Pairs With Errors: 0 Number of Compare Pairs With OOS: 0 Number of Compare Pairs With No OOS: 1 Number of Compare Pairs Cancelled: 0 Compare Pair Report Filename: C:\veridata\data\rpt\TestJob\00002258\TestGroup\CP_ TABLE9=TABLE9.rpt Number of Rows Compared: 21 Number of Rows In Sync: 21 Number of Rows With Errors: 0 Number of Rows Out Of Sync: 0 Number of Inserts Out Of Sync: 0 Number of Deletes Out Of Sync: 0 Number of Updates Out Of Sync: 0 Compare Pair OOSXML Directory: C:\veridata\data\oosxml\TestJob\00002258\TestGroup Compare Pair OOSXML Filename: Job Completion Status: IN SYNC C:\veridata\server\bin> if errorlevel 0 echo EXITED 0 STATUS EXITED 0 STATUS
On UNIX systems, the exit status is in the'$?'
special variable if you use the SH or KSH shells. If you use the CSH shell, then the exit status is in the'$status'
special variable.