ProcessControlOperation | |||
Document Container for ProcessControlOperation instance. | |||
businessData | Document List (Optional) Business data about the process instance. | ||
Parameter | Value | ||
attributes | Set name to the label for the data (such as customer number) and set value to the value of the data (such as 138). | ||
event type | 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 | ||
ParentProcess InstanceId | Document List (Optional) A unique, two-part identifier for the parent process instance to which the executing process instance belongs. | ||
Parameter | Value | ||
keyValue | 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). | ||
ParentProcess Name | String (Optional) (Required when ParentProcessInstanceId is specified.) 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 List Set 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 used to push operations to the Process Tracker. | ||
stronglyTypedBusinessData | Document List (Optional) Business data about the process instance. (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). | ||
time | String (Optional) 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 | ||
timestamp | String The time when the event occurred. The time zone parameter of the date must be set to "GMT" in Designer. The time must be in the following format: yyyy-MM-ddTHH:mm:ss.SSSZ | ||
operation | String Type of operation. Note: The following parameters may not appear as options in Designer. They must be entered manually. | ||
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. | ||
suspend | Paused. It is assumed that the process will resume execution at a later time. Time elapsed between suspend and resume operations will not contribute to the overall cycle time for the process. The elapsed time will not contribute to a process timeout action. | ||
resume | Resumed execution. The timeout clock will reset. | ||
cancel | Terminated abnormally. | ||
Note: Process instances in the cancel or suspend state do not contribute to cycle time metrics. If a suspended process resumes and completes successfully, it will not contribute the time spent suspended to the cycle time. |