6.2 Vericom

The Vericom command-line interface provides a tool for you to manage identities in the credential store and run comparisons.

This topic includes the following sections:

6.2.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 group within a job or a specific compare pair of a group and job.

For specific compare pairs, you can:

  • Review previous out-of-sync results

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

Note:

If the SSL / TLS Security for Web option is selected during the Oracle GoldenGate Veridata installation, then do the following for Vericom to work:
  • Copy the <VERIDATA_HOME>/config/vdtWebKeystore.p12 to <VERIDATA_HOME>/cli/config/veridata-23c.p12

6.2.2 Supported Commands in Vericom

The following commands are supported in Oracle GoldenGate Veridata:

  1. -u OR -user : Veridata user running veridata job
  2. -host: Veridata helidon hostname, bydefault , it is localhost
  3. -port : Veridata Server port. Optional paramter, if not passed then default port will be taken
  4. -j OR -job <jobname> : Veridata job name to be executed
  5. -j OR -job <jobname> -g OR -group <groupName> : If any specific group within a job to be executed
  6. -j OR -job <jobname> -g OR -group <groupName> -c OR compare_pair <CPName>: If any specific Compare Pair needs to be executed
  7. -repair : If repair has to be run along with Compare
  8. -p OR -profile <profileName> : To override Job profile at runTime.
  9. -pS : Source Partition Name (It takes default partition name)
  10. -pS <source partition name> : To override source manual row partition at runTime
  11. -pT: Target partition Name (It takes default partition name)
  12. -pT <target partition name> : To override target manual row partition at runTime
  13. -delta : Run with delta enabled. When not passed, all rows will be compared in every run
  14. -help:Parameter to provide Vericom usage
  15. -v : Should provide Veridata Server version details.
  16. -monitorStats <runId> : This command is to monitor the Job status. It takes the runId as input.

Examples

  1. When running the Job via Vericom, it is necessary to show the job status as follows: ./vericom.sh -j <jobName>.

    Output:
    Run ID: (2258, 0, 0)
  2. To fetch the Run stats, run the command as follows: ./vericom.sh -monitorStats <runId>:

    Output:
    Run ID: (2257, 0, 0) Job Start Time: 2008-03-21 22:48:05 Job Stop Time: 2008-03-21 22:48:20  Number of Compare Pairs: 3 Number of Compare Pairs With Errors: 0 Number of Compare Pairs With OOS: 1 Number of Compare Pairs With No OOS: 1 Number of Compare Pairs Cancelled: 0 Job Completion Status: SUCCESSFUL
    RUN ID: <CP RUN ID> <CP Name> <Group Name>
    RUN ID: <CP RUN ID> <CP Name> <Group Name>
    RUN ID: <CP RUN ID> <CP Name> <Group Name> and so on.
    
  3. To View Compare Pair details, run ./vericom.sh -monitorStats <comparepair_runId>

    Output

    Run ID: (2257, 0, 0) Job Start Time: 2008-03-21 22:48:05 Job Stop Time: 2008-03-21 22:48:20  Number of Compare Pairs: 3 Number of Compare Pairs With Errors: 0 Number of Compare Pairs With OOS: 1 Number of Compare Pairs With No OOS: 1 Number of Compare Pairs Cancelled: 0 Job Completion Status: SUCCESSFUL
    Compare Pair RUN ID:
    Compare Pair Name:
    Compare Pair ID:
    Phase:
    Status:
    Total Rows Compared:
    Rows In-sync:
    Rows out-of-sync:
    Compare-pair report:
    

Note:

The Vericom utility fails when a special character, such as the $ symbol, is present in the name fields of Job, Group, or Compare Pairs. To resolve this issue, an escape character needs to be added, as follows:

Actual Compare Pair Name: \THOR.$DATA08.IRFASRC.EACCT=\THOR.$DATA08.IRFASRC.BACCT

With Escape Character: \THOR.\$DATA08.IRFASRC.EACCT=\THOR.\$DATA08.IRFASRC.BACCT

Run the command as follows:
./vericom.sh -wluser veridata -j NskTest -g nskENscribeTesting -c \THOR.\$DATA08.IRFASRC.EACCT=\THOR.\$DATA08.IRFASRC.BACCT

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

The following examples use the TestJob job:

Example 1   

The example shows a run on a Linux system. The process exits with status 0, and finished job statistics are not displayed.

./vericom.sh -user veridata -port 8089 -job jobBetaBug
JAVA_HOME is set to: /Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home
Java version:17.0.8
[Enter user password:]
Veridata job submitted successfully!
Run ID: 325865/0/0
Execute ./vericom.sh -user <username> -monitorStats <runId> to fetch the run statistics.
Example 2   

This example shows how to get statistics from the Run Id of a Job.

/vericom.sh -user veridata -monitorStats 325865/0/0
JAVA_HOME is set to: /Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home
Java version:17.0.8
[Enter user password:]
Run ID: 325865,0,0
Job Start Time: 2024-06-19T05:32:42.870Z
Job End Time: 2024-06-19T05:32:42.990Z
Number of Compare Pairs: 1
Number of Compare Pairs With Errors: 1
Number of Compare Pairs With Out-Of-Sync: 0
Number of Compare Pairs With No Out-Of-Sync: 0
Number of Compare Pairs Cancelled: 0
Number of Compare Pairs Running: 0
Job Completion Status: ERRORS
Compare Pair Run ID: 325865,0,0
Compare Pair Name: ETMSP_TIMESTAMPTEST=ETMSP_TIMESTAMPTEST
Compare Pair Id: 1,893
Compare Pair Phase: FINISHED
Compare Pair Status: FAILED
Number of Rows Compared: 0
Number of Rows In Sync: 0
Number of Rows Out Of Sync: 0