Oracle® Enterprise Data Quality Command Line Reference

Release 11g R1 (11.1.1.7)

E40037-02

Oracle® Enterprise Data Quality

Command Line Reference

Release 11g R1 (11.1.1.7)

E40037-02

October 2013

Oracle Enterprise Data Quality (EDQ) provides a command line tool, jmxtools.jar, that provides access to a number of EDQ facilities. This document contains details of how to use this tool.

1 Running the Command Line Tool

The tool is distributed as a self contained .jar file in the tools directory, and is executed by the following command line invocation:

java -jar jmxtools.jar commandname arguments

The command and arguments are described in the following section.

2 Commands and Arguments

The command line tool can run a number of commands. The tool provides functionality such as:

- Running jobs

- Listing and dropping orphaned results tables

- Showing user session logs

- Shutting down real-time jobs

- Checking the EDQ version number

The following provides a full guide to the commands, arguments and options available.

2.1 runjob

The runjob command runs a named job in the same way as if running the job using the Director UI. The runjob command takes several additional arguments as follows:

Argument

Use

-job job name

The -job argument specifies the name of the job to run.

-project project name

The -project argument specifies the name of the project that contains the job

-u user name

The -u argument specifies the user name to use to connect to the EDQ server. The user must have permission to run jobs and must have permission to the project containing the job.

-p password

The -p argument is used to specify the connecting user's password. If the -p option is not set, EDQ will prompt the user for the password.

-nolockwait

The -nolockwait argument takes no extra values. It indicates that if any of the resources used by the job are locked, the job should not wait for them to become available. Instead, it should terminate with a failure code and return control to the command line.

-nowait

The -nowait argument takes no extra values, and indicates that the command line should not wait for the job to complete.

server:port

The server and port values are the server name, and the port number of the JMX (management) interface, respectively.

2.2 runopsjob

The runopsjob command runs a named job in the same way as if running the job using the Server Console UI. This provides additional functionality to the runjob command - specifically the use of Run Labels and Run Profiles. Run Labels may be used to store results separately from other runs of the same job. Run Profiles may be used to override externalized configuration settings at runtime.

The runopsjob command takes several additional arguments as follows:

Argument

Use

-job job name

The -job argument specifies the name of the job to run.

-project project name

The -project argument specifies the name of the project that contains the job

-u user name

The -u option specifies the user name to use to connect to the EDQ server. The user must have permission to run jobs and must have permission to the project containing the job.

-p password

The -p argument is used to specify the connecting user's password. If the -p option is not set, EDQ will prompt the user for the password.

-nolockwait

The -nolockwait argument takes no extra values. It indicates that if any of the resources used by the job are locked, the job should not wait for them to become available. Instead, it should terminate with a failure code and return control to the command line.

-nowait

The -nowait argument takes no extra values, and indicates that the command line should not wait for the job to complete.

-runlabel run label name

The -runlabel argument specifies the name of the run label under which you wish to store staged output results. Note that this will override any run label that is specified in a run profile or by -D runlabel = run label name.

-props run profile name

The -props argument specifies the full path to a run profile properties file containing override settings for externalized configuration options in the job.

-D externalized option=value

The -D argument allows you to override specific externalized options for the job individually. The syntax for the externalized options and values is the same as used in run profile properties files, though note that characters will be interpreted by the command line, so some characters will need to be escaped according to the shell conventions of your environment. Note that any individually specified externalized option settings will override any settings for the same option if these are specified in a run profile used in the same run.

server:port

The server and port values are the server name, and the port number of the JMX (management) interface, respectively.

2.3 droporphans

The droporphans command is used to remove any orphaned results tables that may be created when processes are terminated unexpectedly. It should not be run when any jobs or processes are running on the EDQ server.

The droporphans command takes several additional arguments as follows:

Option

Use

-u user name

The -u argument specifies the user name to use to connect to the EDQ server. The user must have permission to cancel jobs and must have permission to the project containing the job.

-p password

The -p argument is used to specify the connecting user's password. If the -p option is not set, EDQ will prompt the user for the password.

server:port

The server and port values are the server name, and the port number of the JMX (management) interface, respectively.

2.4 listorphans

The listorphans command is used to identify any orphaned results tables. The listorphans command takes the same arguments as the droporphans command.

2.5 scriptorphans

The scriptorphans command creates a list of SQL commands for dropping orphaned results tables. This is useful if you wish to review exactly which commands will run on the Results database when you drop tables, or if you wish to drop the tables yourself manually.

2.6 list

The list command lists all the available commands.

2.7 showlogs

The showlogs command starts a small GUI application that allows user session logs to be retrieved.

2.8 shutdown

The shutdown command shuts down all real-time jobs; that is jobs that are running from real-time record providers (web services or JMS).

This takes several additional arguments as follows:

Option

Use

-u user name

The -u argument specifies the user name to use to connect to the EDQ server. The user must have permission to cancel jobs and must have permission to the project containing the job.

-p password

The -p argument is used to specify the connecting user's password. If the -p option is not set, EDQ will prompt the user for the password.

-nowait

The -nowait argument takes no extra values, and indicates that the command line should not wait for the job to complete.

server:port

The server and port values are the server name, and the port number of the JMX (management) interface, respectively.

2.9 version

The version command is used to identify the version of the currently installed instance of EDQ.

Enter the following at the command line:

java -jar jmxtools.jar version

The version number is returned.

3 Examples

This section lists several possible invocations of the command line tool:

3.1 Listing All the Available Commands

The following invocation of the command line tool lists all the available commands:

java -jar jmxtools.jar -list

The output will be as follows:

Available launch names:
<Job tools>
runjob Run named job
shutdown Shutdown realtime jobs
runopsjob Run named job in operations mode

<Logging>
showlogs Show session logs

<Database Tools>
listorphans List orphaned results tables
droporphans Drop orphaned results tables
scriptorphans Create script for dropping orphaned results tables

<System Information>
version Display version number of tools

3.2 Listing the Available Parameters for a Command

If the command line tool is invoked by specifying a command without the corresponding parameters, it will output detailed help for the command. For example, to get detailed help on the runjob command, invoke the command line tool as follows:

java -jar jmxtools.jar runjob

The output will be as follows:

Usage: runjob -job jobname -project project [-u user] [-p pw] [-nowait] [-nolockwait] [-sslprops props | -ssltrust store] server:port

3.3 Running a Named Job

This example illustrates how to run a named job in a named project on a specific EDQ instance (as specified by machine name and port).

To run a job called ”rulecheck” in a project called ”Audit” on the local machine with a JMX server on port 8090, the command is as follows:

java -jar jmxtools.jar runjob -job rulecheck-project audit -u dnadmin localhost:8090

The application will prompt the user to enter the password for the dnadmin user.

3.4 Running a Named Job in Operations Mode

This final example illustrates how to run a named job in 'operations mode' in a Windows environment - that is, with access to the Run Label and Run Profile capabilities so that the configuration of the job can be specified dynamically, and so that the results of the job can be stored by Run Label.

So, to run a job called "profiling" in a project called "MDM" on a server called "prod01", with a run label of "Nov2011" and a run profile file called File1.properties, with a JMX server on port 8090, the command is as follows:

java -jar jmxtools.jar runopsjob -job profiling-project MDM -runlabel Nov2011 -props c:\ProgramData\Oracle\Enterprise Data Quality\oedq_localhome\File1.properties -u dnadmin prod01:8090

4 Related Documents

For more information, see the following documents in the documentation set:

- Oracle Enterprise Data Quality Installation Guide

- Oracle Enterprise Data Quality Java Management Extensions Configuration Guide

- Oracle Enterprise Data Quality Architecture Guide

See the latest version of this and all documents in the Oracle Enterprise Data Quality Documentation website at:

http://download.oracle.com/docs/cd/E48549_01/index.htm

Also, see the latest version of the EDQ Online Help, bundled with EDQ.

5 Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Oracle Enterprise Data Quality Command Line Reference, Release 11g R1 (11.1.1.7)

E40037-02

Copyright © 2006, 2013, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate failsafe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Copyright © 2006, 2013, Oracle and/or its affiliates. All rights reserved.