WebSphere MQ Workflow 3.4.0 Java Generic API Test / Prototyping Tool

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

Tool Methods


===SYNTAX FOR TOOL METHODS==============================================

Tool.sleep
  sleepTime_ms               long
  [ userText                 "value"         ]
  [ beep                     true | false    ]
End

Tool.waitForUserInput
  [ userText                 "value"         ]
  [ beep                     true | false    ]
End

Tool.commentToOutput
  comment                    "value"
  [ toStandardError          true | false    ]
End

Tool.setReturnCode
  userDefinedReturnCode      int | CurrentLoopCount
End

Tool.terminate

Tool.showElapseTime
  elapseTimeOptions          "Testcase, Section, Method, TimeStamp, PrintApiName"
End

  Remark: Testcase:     Time span indicated by  "+++>"
          Section:      Time span indicated by  "===>"
          Method:       Time span indicated by  "--->"
          PrintApiName: Output: "===> ElapseTime API-NAME",
                        but in conjunction with "Section"
          TimeStamp:    Only in conjunction with "Section"
                        and only at the beginning of a section

Tool.setDateTimeOutputFormat
  timeFormat                        "yyyy-MM-dd HH:mm:ss.SS"
  timeZone                          UTC
                                  | GMT
                                  | ...
End

Time format default:  "yyyy-MM-dd HH:mm:ss.SS"
Time zone default:    local mode
Time zones:           GMT,UTC,ECT,EET,ART,EAT,MET,NET,PLT,IST,BST,VST,
                      CTT,JST,ACT,AET,SST,NST,MIT,HST,AST,PST,PNT,MST,
                      CST,EST,IET,PRT,CNT,AGT,BET,CAT

........................................................................

Tool.loopStart
  noOfLoops                  long
                           | LastRetrievedArraySize
                           | LastRetrievedArraySizeMinus1
  [ toStandardError          true | false    ]
End

Tool.jumpToLoopStart

Tool.loopBreak

Remark: LastRetrievedArraySize / ...Minus1 applies to all
        ...ArraySize()-APIs, including ...Count() APIs.
        ...Minus1 will only be done if ArraySize > 0.

........................................................................

Tool.if
  expressionOperator                AND
End

Tool.then

Tool.else

Tool.endIf

........................................................................

Tool.exec                /* execute a command in a different process */
  command                     "value"
  waitForSubprocessToComplete true | false
End

EXAMPLES for invoking the JGATT in a subprocess (platform dependent):
  OS390:   command "java com.ibm.workflow.api.tool.JGATT sleep2 sleep2"
  WinNT:   command "cmd /C start /WAIT java com.ibm.workflow.api.tool.JGATT sleep2 sleep2"
           command "cmd /C sleep.exe 5"

Tool.exec_com.ibm.workflow.api.tool.JGATT
  waitForSubprocessToComplete false | true
  [ commandProcessorCMD       "value" ]
  javaVM                      "value"
  [ classpathOptions          "value" ]
  -i                          "value"
  -o                          "value"
  [ -u                        "value" | "<CL-VALUE>" ]
  [ -p                        "value" | "<CL-VALUE>" ]
  [ -g                        "value" | "<CL-VALUE>" ]
  [ -s                        "value" | "<CL-VALUE>" ]
  [ -y                        "value" | "<CL-VALUE>" ]
  [ -e                        "value" | "<CL-VALUE>" | "<RT-VALUE>" ]
  [ -l                        "value" | "<CL-VALUE>" ]
  [ -n                        "value" | "<CL-VALUE>" ]
  [ -f ]
End

Tool.memoryJVM           /* returns memory information of the JVM */

Tool.garbageCollector    /* runs the garbage collector */

Tool.runFinalization     /* runs the finalization methods of any objects pending finalization */

........................................................................

Tool.System.getProperties    /* Class java.lang.System: getProperties() */

Tool.System.getProperty      /* Class java.lang.System: getProperty(key) */
  key                        value
End

Tool.System.setProperties    /* Class java.lang.System: setProperties(properties) */
  properties                 UserDefinedProperties
End

Tool.System.setProperty      /* Class java.lang.System: setProperty(key, value) */
  key                        value
  keyValue                   "value"
End

Tool.Properties.list         /* Class java.util.Properties: list(), ... */

Tool.Properties.put          /* Class java.util.Properties: put(key, value) */
  key                        value
  keyValue                   "value"
End