Optimize 10.5 | webMethods Optimize Documentation | Administering webMethods Optimize | For Developers | Configuring and Using the Web Service Data Collector | Sending Process Data | pushStepControlOperation (StepControlOperation)
 
pushStepControlOperation (StepControlOperation)
Pushes step state change events to the Process Tracker.
The input parameter is an instance of StepControlOperation.
Input Parameters (all parameters are required unless specified as optional)
The following table describes the input parameters.
StepControlOperation
Document Container for StepControlOperation instance.
businessData
Document List (Optional) Business data about the process step.
Parameter
Value
attributes
Document List Set name to the label for the data (such as customer number) and set value to the value of the data (such as 138).
eventType
String Unique identifier for event datatype in Optimize.
time
String Timestamp passed with event into Optimize for analysis. The time zone parameter of the date must be set to "GMT" in Designer. For input from Integration Server or Designer, the time must be in the following format:
yyyy-MM-dd’T’HH:mm:ss.SSS’Z’
yyyy-MM-dd’T’HH:mm:ss.SSSZ
yyyy-MM-dd’T’HH:mm:ss.SSS
yyyy-MM-dd HH:mm:ss.SSS
ParentProcessInstanceId
Document List (Optional) A unique, two-part identifier for the parent process instance to which the executing process instance belongs.
Parameter
Value
keyValue
Record List Set name to the label for the data (such as customer number) and set value to the value of the data (such as 138).
ParentProcessName
String (Optional) (Required when parentProcessInstanceId is enabled.) The name of the parent process to which the executing process belongs.
processExternalId
String (Optional) Optimize identifier of the business process.
processInstanceDisplayName
String (Optional) A custom name for the process instance.
processInstanceId
Document List Unique, two-part identifier for the process instance.
Parameter
Value
keyValue
Document ListSet name to the first part of the identifier (such as ordernumber) and set value to the second part of the identifier (such as 5).
Optimize displays the identifier on the Process Instances page in two separate columns so you can sort by name or by value. The complete set of keys you supply constitutes the unique name Optimize uses internally for the process.
Note:
ProcessInstanceID and event data share the same key value pairs.
processIteration
Int (Optional) Current iteration of the business process execution.
processName
String Name of the process. The process name must be unique if it is to be used to push operations to the Process Tracker.
stronglyTypedBusinessData
Document List (Optional) Business data about the process step. (Deprecated. Provided only for backward compatibility. Use businessData instead.)
Parameter
Value
eventType
String Unique identifier for event datatype in Optimize.
pairs
Document List Set attribute to the label for the data (such as customer number) and set value to the value of the data (such as 138).
timeStamp
String (Optional) Timestamp passed with event into Optimize for analysis. Default value is the Optimize clock time when the event was received. Must match timestamp below.
timestamp
String The time when the event occurred. The time zone parameter of the date must be set to "GMT" in Designer. For input from Integration Server or Designer, the time must be in the following format:
yyyy-MM-ddTHH:mm:ss.SSSZ
operation
String Type of operation.
Set to
To indicate that a business process has
start
Starts step. Business data can be passed with this operation.
stop
Stops step. Business data can be passed with this operation.
log_
business_data
Sends business data. Does not affect execution or state of the step. This operation needs to have a timestamp that is greater than the start operation timestamp and less than the stop operation timestamp in order for dimensional intrinsic metrics to be captured properly. Business data still will be captured, just without the additional intrinsic metrics (if configured).
stepExternalId
String (Optional) Optimize identifier of the process step.
stepIteration
Int (Optional) Current iteration of the step.
stepName
String Name of the step. The name of the step must match the step name specified in the process model. If two processes share the same name, neither can be tracked.
isGlobalBusinessData
String (True or False) Indicates whether the data being passed in by the server refers to all future steps or only to specified steps in the process.