Monitor 10.15 | pub.monitor.process.modelSteps Folder | pub.monitor.process.modelSteps:getModelSteps
 
pub.monitor.process.modelSteps:getModelSteps
Retrieves information for each step in a specified webMethods-executed or externally executed process model.
Input Parameters
The following table lists the input parameters.
modelID
String Complete model ID of the process model that contains the step information you want to obtain. You can retrieve available model IDs by running the pub.monitor.process.model:getModelNames service. Use the value returned in the modelNames()/PROCESSKEY output parameter. For example: MyProcessProject/MyProcess.
Note:
Whether Monitor treats modelID as case-sensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data.
deployVersion
String The version of the process model. The model version for externally executed and integration processes is always 1. There is no image associated with integration processes.
Output Parameters
The following table lists the output parameters.
modelSteps
Document List List of the steps in the specified process. The following fields are returned for each step:
*PROCESSKEY String Model ID of the process model for which the visual elements were retrieved. For example: projectName/processName
*STEPID String Step ID of the step.
*STEPLABEL String Step label of the step.
*DESCRIPTION String Description for the step.
*TYPE String The keyword that describes the type of step. Valid values are:
*Abstract Task A BPMN abstract task activity.
*webMethods Subprocess A webMethods subprocess.
*Referenced Process A webMethods referenced process step (deprecated).
*Boundary Timer Event A BPMN boundary timer event.
*BPMN Subprocess A BPMN subprocess.
*Call Activity A BPMN call activity.
*Service Task A BPMN service task activity.
*User Task A BPMN user task activity.
*Manual Task A BPMN manual task activity.
*Rule Task A BPMN rule task activity.
*Send Task A BPMN send task activity.
*Receive Task A BPMN receive task activity.
*Gateway A BPMN gateway.
*Start Event A BPMN start event.
*Intermediate Event A BPMN intermediate event.
*End Event A BPMN end event.
*STEPINTTYPE String Numerical representation of the type of visual element. The service returns one of the following numerical values as described below:
*1 Abstract task
*2 webMethods subprocess
*3 Referenced process ( webMethods referenced process, deprecated)
*12 Boundary timer event
*13 BPMN subprocess
*14 Call activity
*30 Service task
*31 User task
*32 Manual task
*33 Rule task
*34 Send task
*35 Receive task
*40 Gateway
*50 Start event
*80 Intermediate event
*110 End event
*ICON String URL to the image file that is used for the icon of the step. This will either be a URL to the file provided with Designer or if the model uses a non-standard image, the URL provided for that image when the model was created. Null for an abstract task.
*ICONBYTE String Byte array that contains the icon of the step.
*ICON_X String X coordinate of the top, left corner for where the icon is placed within the model image.
*ICON_Y String Y coordinate for of the top, left corner for where the icon is placed within the model image.
*ICON_WIDTH String Width of the icon used for the step.
*ICON_HEIGHT String Height of the icon used for the step.
*SUBPROCESSKEY String If the visual element represents a referenced process, SUBPROCESSKEY contains the model ID for the referenced process model. Otherwise, SUBPROCESSKEY will be null.
*INLINESTEPID String If visual element represents an inline subprocess, INLINESTEPID contains the model ID for the parent process model in which the subprocess resides. Otherwise, INLINESTEPID will be null.
*REFSTEPID String An internal identifier that the Integration Server uses.
*SERVER String Logical server name of the server that is to execute the step.
*IS_START String Whether the step is a start step. The service returns the following values for steps:
*1 A start step
*0 Not a start step
*IS_STOP String Whether the step is a stop step. The service returns the following values:
*1 A stop step
*0 Not a stop step
message
String Error that occurred during the execution of this service if this service encountered an error.