Administering and Monitoring Business Processes 10.4 | Administering and Monitoring Business Processes | webMethods Monitor Built-in Services Reference | pub.monitor.integrationProcessLogging Folder | pub.monitor.integrationProcessLogging:createLoggedFieldMetadata
 
pub.monitor.integrationProcessLogging:createLoggedFieldMetadata
Adds a definition for a logged field (known as logged field metadata) to the Process Audit Log database. The logged field definition is associated with a specific step definition that is part of a specific integration process definition.
The logged field definition is comparable to custom data for a process model that was created with Designer. In the same way you need to create a field defined in a document before you can specify a value for that field, you need to define a logged field definition for an integration process before you can specify a value for the field.
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 to be associated. You defined the process key when you added the process definition to the Process Audit Log using the pub.monitor.integrationProcessLogging:createProcessMetadata service.
A process key is 1 to 64 alphanumeric characters.
stepID
String The internal identifier of the process step with which the logged field is to be associated. You defined the step identifier and associated it with a process step when you added the step definition to the Process Audit Log using the pub.monitor.integrationProcessLogging:createStepMetadata service.
A step identifier is 1 to 128 alphanumeric characters.
documentType
String A name that identifies the type of document with which the logged field is to be associated. For example, you might specify a name like “purchaseOrder” or you might specify the fully qualified name of an existing IS document type. The document type you specify does not have to be an existing document defined in a webMethods component, such as a webMethods Broker (deprecated) document type, IS document type, or TN document type. The value you specify for documentType must be 1 to 512 characters and can include characters that are valid in IS service names. See webMethods Service Development Help for information about allowed characters.
fieldName
String The internal name you want to assign to the logged field. The value you specify for fieldName must be 1 to 512 alphanumeric characters. Use this name in subsequent services when you want to reference this logged field definition. It is an internal name only; Monitor does not display this value.
fieldAlias
String The external name you want to assign to the logged field. The value you specify for fieldAlias must be 1 to 640 alphanumeric characters. Monitor displays this value when listing information about the logged field.
fieldType
String The data type of the logged field. Specify one of the following: String, Number, Date, or Blob.
Output Parameters
The following table lists the output parameters.
result
String The outcome of adding the logged field definition. If the service successfully added the logged field definition, result is “success.” If the service encountered an error attempting to add the logged field definition, result contains the exception.
Copyright © 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release