Optimize 10.3.0 | webMethods Optimize Documentation | Administering webMethods Optimize | Built-In Services | pub.optimize.monitoring:pushStepControlOperation (StepControlOperation) | Input Parameters
 
Input Parameters
The following table describes the input parameters.
Connection
String Optional. Specifies the JMS server to which information will be sent. If no JMS server is specified, the service uses Software AG Universal Messaging as the default. The Software AG Universal Messaging URL format is as follows:
nsp://{host}:{port}
The Broker URL format is as follows:
broker://{host}:{port}/{brokerName}/analysis
Note:
Before you can use this parameter, you must ensure that the specified connection is available on the Connection Settings page as described in Configuring the WmOptimize Package. If the connection does not exist, you can create a connection to the broker URL using the pub.optimize.monitoring:createNewConnection service.
timestamp
String Optional. 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
For input from Optimize, the time must be in one of the following formats:
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
operation
String (Required) 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.
stepName
String Optional if stepExternalId is provided. 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. Use the stepExternalId parameter instead, and mark this parameter “optional” in Designer.
Note:
If you do not provide a value for this parameter, WmOptimize populates it automatically by correlating the value of the stepExternalId with the process model information obtained from the Analytic Engine.
stepExternalId
String Optional if stepName is provided. Optimize identifier of the process step. Use this parameter instead of stepName if the application can access the process metadata.
Note:
If you do not provide a value for this parameter, WmOptimize populates it automatically by correlating the value of the stepName with the process model information obtained from the Analytic Engine.
sourceStepExternalID
String Optional. Optimize identifier of the process source step. Use this parameter instead of sourceStepName if the application can access the process metadata.
sourceStepName
StringOptional. Use this parameter to provide process tracker with info about transitional path between source and target steps. It is useful if target step has more than 1 inbound transition from multiple source steps and user wants to track transitions between source and target step.
stepIteration
Int Optional. Current iteration of the step.
parentProcessInstanceId
Document List Optional. (If provided, requires parentProcessName) A unique, two-part identifier for the parent process instance to which the executing process instance belongs.
keyValue
Record List
Parameter
Value
name
Set name to the label for the data (for example, customer number) and set value to the value of the data (for example, 138).Set value to the value of the data (for example, 138).
value
processInstanceId
Document List Unique, two-part identifier for the process instance.
keyValue
Document List
Parameter
Value
name
Set name to the first part of the identifier (for example, ordernumber).
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.
Set value to the second part of the identifier (for example, 5).
Value
Note:
ProcessInstanceID and event data share the same key value pairs.
processName
String Optional if processExternalId is provided. Name of the process. The process name must be unique if it is to be used to push operations to Optimize, but this practice is supported only for backward compatibility. Use processExternalId instead, and mark this parameter “optional” in Designer.
Note:
If you do not provide a value for this parameter, WmOptimize populates it automatically by correlating the value of the processExternalId with the process model information obtained from the Analytic Engine.
parentProcessName
String Optional. The name of the parent process to which the executing process belongs. If parentProcessInstanceId is not provided, this parameter is ignored.
processExternalId
String Optional if processName is provided. Optimize identifier of the business process. Use this parameter instead of processName if the application can access the process metadata. In Designer, this is referred to as ProcessID.
Note:
If you do not provide a value for this parameter, WmOptimize populates it automatically by correlating the value of the processName with the process model information obtained from the Analytic Engine.
processIteration
IntOptional. Current iteration of the business process execution.
globalBusinessData
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.
businessData
Document List Optional. Business data about the process step.
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-ddTHH:mm:ss.SSSZ
For input from Optimize, the time must be in one of the following formats:
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
eventType
String Unique identifier for event data type in Optimize.
attributes
Document List
Parameter
Value
name
Set name to the label for the data (for example, customer number) and
value
Set value to the value of the data (for example, 138).