WebSphere MQ Workflow 3.4.0 Java Generic API Test / Prototyping Tool

[prev][next][parent][TOC]

Running the Tool

On all platforms the tool runs as a "console" application.
To run the tool select one of the following command-line interfaces:
See also:

Invocation Mode 1,
see the following command-line help:
java com.ibm.workflow.api.tool.JGATT <[path]tc fn> <[path]log fn>
or
jre -classpath <path> com.ibm.workflow.api.tool.JGATT <[path]tc fn> <[path]log fn>
or
java com.ibm.workflow.api.tool.JGATT Syntax <FileSpec>
or ...
Abbreviations:
 tc           test case
 log          result
 fn           file name
 path         e.g. d:\data\
 FileSpec     e.g. d:\data\syntax.txt
 [...]        optional

 If no test case file name extension is specified, an extension "dat" is expected.
 If no result file name extension is specified, the tool will create an extension "log".
Invocation Example of the Test Tool as MQ Workflow Client Application :

java com.ibm.workflow.api.tool.JGATT d:\testcase\tc01 d:\result\tc01
Invocation Example to retrieve the Test Tool Syntax:

java com.ibm.workflow.api.tool.JGATT syntax d:\testcase\syntax.txt


Invocation Mode 2
, see the following command-line help:

Note: Only for version 3.2.1 Service Pack 2 or higher.
Usage:
java com.ibm.workflow.api.tool.JGATT [-option [argument] ...]

Some valid option and argument combinations:
  java <ToolName> -i <> -o <> [-u <>] [-p <>] [-g <>] [-s <>] [-y <>] [-l <>] [-n <>] [-f] [-d]
  java <ToolName> -x <>
  java <ToolName> -h

  The following options are valid:
  -i <TestCase>       test case input file name
  -o <Result>         test case output file name
  -u <UserID>         user id
  -p <Password>       password
  -g <SystemGroup>    system group name
  -s <System>         system name
  -y <Configuration>  configuration identifier
  -e <SessionID>      session identifier
  -l <AgentLocator>   agent locator
  -n <AgentName>      agent name
  -h                  help (this help)
  -f                  finish without System.exit(rc)
  -d                  dump arguments
  -c                  dump class/lib path settings
  -x <Syntax>         syntax output file name 
If you use API parameters (for example -uADMIN) also refer to the tool syntax on how to use them within an API template (Keyword: <CL-VALUE>) and see also example API parameter via command line.

NOTE: Flags -e and -c are not features of the tool for MQ Workflow 3.2.2.



Running Parallel Tool Applications:
CAUTION :
When you invoke the Test Tool to carry out test cases in parallel, use different parameters to specify the test cases that are to be run under each invocation.
e.g.   java com.ibm.workflow.api.tool.JGATT tc01a tc01a       (application A)
       java com.ibm.workflow.api.tool.JGATT tc01b tc01b       (application B)



The application ends with one of the following console messages:
====== Test case ended normally ============================================
or
====== Test case ended with error(s) === +++ERROR+++ =======================
or
====== Test case break due to error(s) === +++ERROR+++ =====================

Return values:

Depending on the error type, the tool returns the following return values:

Error type           Return value
---------------------------------
no error                        0
usage error                     4
FmcException                    8
Java exception                  8
userDefinedReturnCode         int