Integration Server 10.15 | Built-In Services Reference Guide | Flow Folder | Summary of Elements in this Folder | pub.flow:setCustomLoggedFields
 
pub.flow:setCustomLoggedFields
WmPublic. Selects the fields of one or more custom services for logging.
Input Parameters
serviceList
Document List. One or more custom services for which you want to select the input and output fields for logging. Set the following parameters for each custom service.
Key
Description
nsName
String. Specify the fully qualified name of the service for which you want to select the fields for logging.
Note:
You can use pub.flow:setCustomLoggedFields to select the fields of a custom service only.
Key
Description
inputFields
Document List. Optional. One or more input fields that you want to log for the custom service.
Key
Description
path
String. Path of the input field that you want to log for the custom service. For example, if the input field is a string (myString) under a document (myDocument), path is myDocument/myString, where myString is the leaf node.
type
String. The data type of the input field.
objectWrapperType
String. Optional. The Java wrapper type for a field of type Object or Object List. The default is UNKNOWN.
alias
String. Optional. A name to easily locate the input field in webMethods Monitor. The default is the leaf node name specified in path.
outputFields
Document List. Optional. One or more output fields that you want to log for the custom service.
Key
Description
path
String. Path of the output field that you want to log for the custom service. For example, if the output field is a string (myString) under a document (myDocument), path is myDocument/myString, where myString is the leaf node.
type
String. The data type of the output field.
objectWrapperType
String. Optional. The Java wrapper type for a field of type Object or Object List. The default is UNKNOWN.
alias
String. Optional. A name to easily locate the output field in webMethods Monitor. The default is the leaf node name specified in path.
Output Parameters
serviceList
Document List.The following parameters are displayed for each custom service in the input.
Key
Description
nsName
String. The fully qualified name of the custom service for which you have specified the fields for logging.
status
String. Indicates whether the specified fields of a custom service are selected for logging or not.
message
String. If the pub.flow:setCustomLoggedFields service execution is successful, the message indicates that the specified fields of a custom service are selected for logging. Otherwise, the message provides the reason for failure.
Usage Notes
In Designer, you can select the custom service fields for logging in the Logged Fields tab. However, you can select the fields only for one service at a time. The pub.flow:setCustomLoggedFields public service enables you to select the fields of multiple custom services at once for logging, with or without Designer.
Consider the following points to run the pub.flow:setCustomLoggedFields service successfully.
*The custom service must be locked for editing. Otherwise, the pub.flow:setCustomLoggedFields service fails. For more information about locking and unlocking elements, see webMethods Service Development Help.
*An invalid or incorrect custom service name in the nsName parameter leads to an error. Similarly, if the service name is not fully qualified or is a system service, the pub.flow:setCustomLoggedFields service fails.
*If there are multiple custom services in serviceList, and a custom service has invalid inputFields or outputFields, the pub.flow:setCustomLoggedFields service fails to set the fields of that service for logging.
*If one or more inputFields or outputFields of a custom service have the incorrect type, pub.flow:setCustomLoggedFields fails to set the fields of that service for logging.
*For a custom service, if you manually select the fields in the Logged Fields tab, and then run the pub.flow:setCustomLoggedFields service without specifying inputFields or outputFields, the pub.flow:setCustomLoggedFields service clears the fields that are already selected.
If you want audit data for the custom fields in the service log, you must enable service auditing for the custom service.
The service logger destination must be a database to log the values of the selected custom fields.