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 | ||
stepName | String Optional if stepExternalId is provided. Name of the process step. The process step name must match the process step name specified in the model definition for this process. For information about configuring process models, see
Configuring Business Processes 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. Note: If neither the stepName, nor the stepExternalId parameter is specified, the error emitted by the service is not associated with any particular step of the process. | ||
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 here, this parameter will be populated automatically by its corresponding value from the process model, based on the stepName parameter. Note: If neither the stepName, nor the stepExternalId parameter is specified, the error emitted by the service is not associated with any particular step of the process. | ||
stepIteration | Int Optional. Current iteration of the step. | ||
processInstanceId | Document Unique, two-part identifier for the process step. | ||
keyValue | 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 first part of the identifier (for example, ordernumber). | ||
value | Set value to the second part of the identifier (for example, 5). Optimize displays the identifier on the Process Instances page in two separate columns so you can sort by name or by 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. | ||
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. | ||
processInstanceDisplayName | |||
String Optional. A custom name for the process instance. | |||
type | String The type of error that occurred. | ||
message | String A short description of the error. | ||
messageDetail | String Optional. A long description of the error. If a stack trace is available, store it in this field. | ||
processIteration | Int Optional. Current iteration of the business process execution. | ||