Commands accepted by the servlet

The following table lists all the commands with parameters that are accepted by the servlet. The commands can be submitted as follows:
  1. Embedded in an HTML form.

Commands embedded in an HTML form

If a command is embedded inside an HTML form, the command and parameters have to be passed as input fields to the servlet. The fields can be visible (for example, if the user has to enter the required information) or hidden. A typical form for a logon request is shown in the following example (with user ID and password to be entered by the user and SystemGroup and System hardcoded):

<form ACTION="/MQWFClient/servlet/Main" METHOD="POST" NAME="logon">
  <input type="hidden" name="command"      value="logon">
  <input type="hidden" name="group"  value="FMCGRP">
  <input type="hidden" name="system"       value="FMCSYS">
  <table border="0">
    <tr>
      <td align="left"><label for="user">userid</label></td>
      <td align="left"><input NAME="userID" TYPE="text"
        SIZE="32" MAXLENGTH="32"> </td>
    </tr>
    <tr>
      <td align="left"><label for="password">password</label></td>
      <td align="left"><input NAME="password" TYPE="password"
        SIZE="32" MAXLENGTH="32"> </td>
    </tr>
  </table>
  <p>
  <input type="submit" name="logon" value="Logon">&nbsp;&nbsp;
  <input type="reset"  name="clear" value="Clear"></p>
</form>

This form presents two input fields for user ID and password. It also has a 'Submit' and 'Reset' button. If the Submit button is pressed, the information entered in the form is sent to the servlet together with the hidden command field 'logon' as well as the hidden fields for system group and system.

images/green-ball.gif (886 bytes) showTemplateProperties

Parameter Optional? Description
id no The OID for the template on the current template list for which the settings should be displayed. When using the DefaultViewer, the template file forms/TemplateProperties.html gets loaded and its variables get replaced and downloaded to the client.

images/green-ball.gif (886 bytes) deleteTemplate

Parameter Optional? Description
id no The OID of the process template to be deleted.

images/green-ball.gif (886 bytes) createInstance

Parameter Optional? Description
id no The OID of the process template for which an instance should be created.
instanceName yes The desired instance name for a newly created instance.

images/green-ball.gif (886 bytes) showInstanceProperties

Parameter Optional? Description
id no The OID for the instance on the current instance list, for which the settings should be displayed. When using the DefaultViewer, the instance file forms/InstanceProperties.html gets loaded and its variables get replaced and downloaded to the client.

images/red-ball.gif (527 bytes) startInstance

Parameter Optional? Description
Input Container Data yes This is not the name of the parameter, however, it describes that the input container data can be set using this method. The names of the parameters have to be the fully qualified names of the data members that should be set (for example, 'PersonInfo.FirstName'). More than one data member can be set.

images/red-ball.gif (527 bytes) deleteInstance

Parameter Optional? Description
id no The OID of the process instance to suspend.

images/green-ball.gif (886 bytes) resumeInstance

Parameter Optional? Description
id no The OID of the process instance to resume.

images/green-ball.gif (886 bytes) terminateInstance

Parameter Optional? Description
id no The OID of the process instance to terminate.

images/green-ball.gif (886 bytes) showWorkItemProperties

Parameter Optional? Description
id no The OID of the work item on the current worklist, for which the settings should be displayed. When using the DefaultViewer, the template file forms/WorkItemProperties.html gets loaded and its variables get replaced and downloaded to the client.

images/green-ball.gif (886 bytes) checkOutWorkItem

Parameter Optional? Description
id no The OID of the work item on the current worklist, which should be started (checked out). As a result of this call, either the HTML form with the same name as the program registration for this activity or a generated HTML form are displayed.
startAllowed yes If this parameter is set to 'true' and checking out the work item is not allowed, the work item will be started instead. For this to work, a Program Execution Agent for the appropriate user ID must be running on the server. Also, the program should be able to run unattended (this is currently not enforced).

images/red-ball.gif (527 bytes) checkInWorkItem

Parameter Optional? Description
id no The OID of the work item on the current worklist, which should be checked in.
returnCode yes The return code, which should be used when the work item is checked in.
Input Container Data yes This is not the name of the parameter, however, it describes that the output container data can be set using this method. The names of the parameters have to be the fully qualified names of the data members that should be set (for example, 'PersonInfo.FirstName'). More than one data member can be set.

images/green-ball.gif (886 bytes) cancelWorkItem

Parameter Optional? Description
id no The OID of the work item on the current worklist, which should be cancelled.

images/green-ball.gif (886 bytes) finishWorkItem

Parameter Optional? Description
id no The OID of the work item on the current worklist, which should be finished.

images/green-ball.gif (886 bytes) startWorkItem

Parameter Optional? Description
id no The OID of the work item on the current worklist, which should be started.

images/green-ball.gif (886 bytes) forceRestartWorkItem

Parameter Optional? Description
id no The OID of the work item on the current worklist, which should be restarted.

images/red-ball.gif (527 bytes) transferWorkItem

Parameter Optional? Description
id no The OID of the work item on the current worklist, which should be transferred.
userID yes The new user ID, to which the work item should be transferred. If this parameter is not set, the DefaultViewer sends the Transfer.html form to the client. If this parameter is set, it will be used to transfer the work item.

© Copyright IBM Corp. 1999, 2005. All Rights Reserved.