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. 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 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.
	suspend	Paused. It is assumed that the process will resume execution at a later time. Time elapsed between suspend and resume operations does not contribute to the overall cycle time for the process. The elapsed time will not contribute to a process time-out action.
	resume	Resumed execution. The time-out 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.
parentProcessInstanceId	Document List Optional. (If provided, requires parentProcessName or parentProcessExternalId.) A unique, two-part identifier for the parent process instance to which the executing process instance belongs.
	keyValue	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.
		Parameter	Value
		name	Document List Set name to the label for the data (for example, customer number).
		value	Set value to the value of the data (for example, 138).
processInstanceId	Document List Unique, two-part identifier for the process instance.
	keyValue	Document List 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.
		Parameter	Value
		name	Set name to the first part of the identifier (for example, ordernumber).
		value	Set value to the second part of the identifier (for example, 5).
		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 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.
processInstanceDisplayName
	String Optional. A custom name for the process instance.
parentProcessExternalId	String Optional if parentProcessName is provided. Optimize identifier for the parent process to which the business process belongs. If parentProcessInstanceId is not provided, this parameter is ignored. Note: If you do not provide a value for this parameter, WmOptimize populates it automatically by correlating the value of the parentProcessName with the process model information obtained from the Analytic Engine.
parentProcessName	String Optional if parentProcessExternalId is provided. The name of the parent process to which the executing process belongs. If parentProcessInstanceId is not provided, this parameter is ignored. Note: If you do not provide a value for this parameter, WmOptimize populates it automatically by correlating the value of the parentProcessExternalId with the process model information obtained from the Analytic Engine.
parentStepModelId	String Required for subprocesses. The identifier of the container step in the parent process, which contains the subprocess.
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	Int Optional. Current iteration of the business process execution.
businessData	Document List Optional. Business data about the process instance.
	Parameter	Value
	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
	event type	String Unique identifier for event data type in Optimize.
		Attributes	Document List Optional. Business data about the process instance.
			Parameter	Value
			name	Set name to the label for the data (for example, customer number).
			value	Set value to the value of the data (for example, 138).