Software AG Products 10.7 | Administering and Monitoring Business Processes | webMethods Monitor Built-in Services Reference | pub.monitor.integrationProcessLogging Folder | pub.monitor.integrationProcessLogging:createLoggedFieldInstance
 
pub.monitor.integrationProcessLogging:createLoggedFieldInstance
Creates an instance of a logged field, setting the field's value to the value that you specify and associating the logged field with the step in the process instance that you specify.
Input Parameters
The following table lists the input parameters.
processKey
String The internal identifier (that is, process key) of the integration process definition with which the logged field is associated. You define the process key when you add the process definition to the Process Audit Log using the pub.monitor.integrationProcessLogging:createProcessMetadata service.
A process key is 1 to 64 alphanumeric characters.
processInstanceID
String The identifier of the process instance for which you are logging a field. You assign the process instance an identifier when you create the process instance using the pub.monitor.integrationProcessLogging:createProcessInstance service.
A process instance ID is 1 to 32 alphanumeric characters.
stepID
String The internal identifier of the process step with which the logged field is associated. You define the step identifier and associate it with a process step when you add the step definition to the Process Audit Log using the pub.monitor.integrationProcessLogging:createStepMetadata service.
A step identifier is 1 to 128 alphanumeric characters.
stepIteration
Number Optional. The iteration of the step. Specify an iteration count if the step is executed multiple times within a single process instance, for example, if the step is within a loop or is an error handling step that can be executed more than one time. By default, the service uses a value of 1 for stepIteration.
documentName
String Optional. The name of the document that contains the logged field. The value you specify for documentName must be 1 to 128 characters and can include characters that are valid in IS service names. See the webMethods Service Development Help for information about allowed characters.
fieldName
String The internal name of the logged field for which you want to create an instance. You define the internal name when you add the logged field definition to the Process Audit Log using the pub.monitor.integrationProcessLogging:createLoggedFieldMetadata service.
A field name is 1 to 512 alphanumeric characters.
fieldValue
Object Optional. The BLOB value of the logged field. Use fieldValue if Blob is specified for the input parameter fieldType of the pub.monitor.integrationProcessLogging:createLoggedFieldMetadata service when the logged field definition is added.
stringValue
String Optional. The string value of the logged field. Use stringValue if String is specified for the input parameter fieldType of the pub.monitor.integrationProcessLogging:createLoggedFieldMetadata service when the logged field definition is added. This value can be 1 to 255 characters.
numberValue
Number Optional. The number value of the logged field. Use numberValue if Number is specified for the input parameter fieldType of the pub.monitor.integrationProcessLogging:createLoggedFieldMetadata service when the logged field definition is added.
dateValue
Date Optional. The date value of the logged field. Use dateValue if Date is specified for the input parameter fieldType of the pub.monitor.integrationProcessLogging:createLoggedFieldMetadata service when the logged field definition is added.
Output Parameters
The following table lists the output parameters.
result
String The outcome of creating the logged field instance. If the service successfully created the logged field instance, result is “success.” If the service encountered an error attempting to create the logged field instance, result contains the exception.
Usage Notes
*This service uses a combination of the values you specify for processInstanceID, stepID, stepIteration, and fieldName to locate the logged field definition for which you want create a field instance and supply a value.
*The service requires that you specify a value for the logged field using one of fieldValue, stringValue, numberValue, or dateValue. Use the variable that matches the data type used in the logged field definition. The data type is defined using the fieldType input parameter of the pub.monitor.integrationProcessLogging:createLoggedFieldMetadata service.
*If you specify values in more than one parameters (for example, if you specify values for both fieldValue and stringValue), the service uses the value that is associated with the data type of the logged field definition.
*If the service encounters an error, it logs an error to the PRA_ERROR table. You can view the error using Monitor with the Step Instance Detail page for the step instance.