4 Managing Identities and Comparing Data
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:
This chapter includes the following sections:
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 theOracle GoldenGate Veridata command-line interface and enables you to handle these activities with automated programs. You can easily use the vericom
tool without specifying the actual user name and password.
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.
Managing Identities in a Credential Store
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. The credential store is implemented as an Auto Login wallet within the Oracle Credential Store Framework.
Credential Store contains the following topics:
Alias contains the following topics:
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 Example
vericom.sh -wluser username -wlport veridata server port –addCredentialStore
.
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-2 Example
vericom.sh -wluser username -wlport veridata server port –deleteCredentialStore
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-3 Example
vericom.sh -wluser username-wlport veridata server port –createAlias aliasname (optional)
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 Example
vericom.sh -wluserAlias alias-name -wlport veridata server port –job job name
Display Alias
Use the -displayAlias
argument to list all aliases and user names in the wallet. The password is not displayed.
Example 4-5 Example
vericom.sh –wluser username -wlPort veridata server port -displayAlias
Updating the Alias
Use the -updateAlias
argument to update the password for the valid user.
Example 4-6 Example
vericom.sh -wluser username -wlport veridata server port –updateAlias alias-name (optional)
Deleting the Alias
The -deleteAlias
argument used to delete the alias. Along with the alias, the corresponding user credentials are also removed if, no other alias is referring to the same user.
Example 4-7 Example
vericom.sh -wluser username -wlport veridata server port –deleteAlias aliasname (optional)
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:vericom{.bat|.sh} required_parameter [optional_parameter
.
Required Parameters
Enter one of the following required options; otherwise, an error is returned.
[-wlport port ] | -wluser user_name | -help | -helprun | [-version | -v] | [-job | -j] job |
In this example, the -wluser
option specifies the Oracle GoldenGate Veridata Server (server) user name that is needed to connect to the server. This user should have the veridataCommandLineUser
privilege to access and execute command-line operations. The user should also have the veridataAdministrator
or veridataPowerUser
privilege to successfully run jobs and use the import and export utilities.
See Securing Access to Oracle GoldenGate Veridata by Defining User Roles.
The -version
, -v
, -help
, or -helprun
options, they take precedence over any other option specified.
Optional Parameters
These are the optional parameters:
[ -g group -c compare_pair ] [ -nw ] [ -repair | -norepair] [ -rP profile ] [ -rR ] | -rO ] [ -rN threads ] [ -rD seconds ] [ -rC | +rC ] [ -rOb | -rOx | -rO2 | -rO0 ] [ -rOs records ] [ -rTi ] [ -rTc ] [ -rTs trace_number ] [ -pS source_partition_name | -pSq source_sql_predicate | -pSA1 source_ascii_start_key | -pSA2 source_ascii_end_key | -pSH1 source_hex_start_key | -pSH2 source_hex_end_key ] [ -pT target_partition_name | -pTq target_sql_predicate | -pTA1 target_ascii_start_key | -pTA2 target_ascii_end_key | -pTH1 target_hex_start_key | -pTH2 target_hex_end_key ] [ -pq sql_predicate ] [ -rd0 | -rdN run_ID ] [ -wp ] -addCredentialStore Create a new Credential Store at location defined in the veridata.cfg file -deleteCredentialStore Delete the Credential Store -createAlias Create an alias for user provided in the wluser argument -updateAlias Update the user name and password for the alias with user provided in the wluser argument -deleteAlias Delete the alias -displayAlias Display the alias stored in credential store -wlUserAlias Use the alias in place of wluser
Table 4-1 Vericom Runtime Arguments
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-2 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 ran successfully, but the comparison of some rows are not in sync. |
5 |
There was a communication error with the server. |
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.