Administering and Monitoring Business Processes 10.4 | Administering and Monitoring Business Processes | webMethods Monitor Built-in Services Reference | pub.monitor.process.instance Folder | pub.monitor.process.instance:getInstanceSteps
 
pub.monitor.process.instance:getInstanceSteps
Retrieves information about all steps that were executed within a process instance.
Note: Whether the search is case-sensitive or case-insensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data.
Input Parameters
The following table lists the input parameters.
instanceID
String Instance ID for the process instance for which to retrieve steps. Specify the complete, exact ID.
Output Parameters
The following table lists the output parameters.
instanceSteps
Document List List of the steps that the specified process executed. For each step, the following fields are returned:
*ROOTCONTEXTID String Root context ID.
*PARENTCONTEXTID String Parent context ID.
*CONTEXTID String Context ID for the process step.
*AUDITTIMESTAMP Number Time the step was logged, in epoch time; that is, the number of seconds since January 1, 1970.
*AUDITTIMESTRING String Time the step was logged in string format, YYYY-MM-DD hh:mm:ss.SSS zzz, where:
*YYYY-MM-DD is the date
*hh:mm:ss:SSS is the time, including milliseconds
*zzz is the time zone
*INSTANCEID String Instance ID of the process instance in which the step was executed.
*INSTANCEITERATION Number Instance iteration for the process instance when the step was executed.
*STEPID String ID of the process step.
*STEPITERATION Number Iteration of the process step.
*STATUS String Status of the process step. The service returns the numerical value that represents the status. For a description of the status values, see Status Reference.
*USERNAME String If the step is a Task step, the user name associated with the task.
*ROLENAME String If the step is a Task step, the role name associated with the task.
*SYSTEM String System identified with this step. The service returns a numerical value to represent the system, as follows:
*1 Integration Server
*2Task Engine
*STEPLABEL String Name of the step.
*STATUSDECODE String The keyword value for the process step's status. For the list of keyword values, see Status Reference.
*SYSTEMDECODE String The name of the system upon which the step was executed. If the SYSTEM code is 1, the service returns “Integration Server;” if the SYSTEM code is 2, the service returns “Workflow.”
stepNames
HashMap List of the returned steps executed in the specified process instance. This is a hash map of key/value pairs, where the keys are the step IDs of the steps and values are the names of the steps.
stepCidList
HashMap List of the context IDs for the steps executed in the specified process instance. This is a hash map of key/value pairs, where the keys are the step IDs of the steps and the values are the context IDs for the steps.
cidList
HashSet A list of context IDs that correlate to the steps executed for the specified process instance.
message
String Error that occurred during the execution of this service if this service encountered an error.
Copyright © 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release