Administering and Monitoring Business Processes 10.4 | Administering and Monitoring Business Processes | webMethods Monitor Built-in Services Reference | pub.monitor.process.instance Folder | pub.monitor.process.instance:getInstanceCustomData
 
pub.monitor.process.instance:getInstanceCustomData
Retrieves the user-specified document field values that a process instance logged to the logging database.
Note: Whether the search is case-sensitive or case-insensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data.
Input Parameters
The following table lists the input parameters.
instanceID
String Instance ID of the process instance for which to retrieve the user-specified document field values. Specify the complete, exact ID.
recent
String The iterations of the process instance for which to retrieve the user-specified document field values. The code value indicates whether to retrieve document field values logged for all process instances or the most recent process instance iterations:
*0 Default. Retrieve field values only for most recent process instance iteration.
*1 Retrieve field values logged for all process instance iterations.
documentName
String Optional. If values were logged for more than one document, complete name of the document whose logged values you want retrieved. By default, the service returns logged values for all documents. You can retrieve document names using the pub.monitor.process.instance:getDocumentNames service.
Note: Specify the name of the document that was assigned through Designer, not the document type name (for example, not the fully qualified name of an IS document type).
fieldName
String Optional. Complete name of the field whose value you want retrieved. By default, the service returns logged values for all fields. You can retrieve field names using pub.monitor.process.instance:getFieldNames service.
sortBy
String Optional. Value to use to sort the returned list of document field value. This parameter works with the sortOrder parameter.
*STEPLABEL Default. Names of the steps for which the field value was logged.
*INSTANCEITERATION Process instance iteration when the field value was logged.
*STEPITERATION Step iteration when the field value was logged.
*DOCUMENTNAME Name of the document for which values were logged.
*FIELDNAME Name of the document field for which a value was logged.
*STRINGVALUE Values of String type document fields.
*NUMBERVALUE Values of Number type document fields.
*DATEVALUE Values of Date type document fields.
sortOrder
String Optional. Whether to sort the returned list of documents in ascending or descending order. The documents are sorted by the field identified by the sortBy parameter.
*0 Default. Sort in ascending order.
*1 Sort in descending order.
Output Parameters
The following table lists the output parameters.
customData
Document List The list of returned document field values. For each document field value, the following fields are returned:
*STEPLABEL String Step name of the step that logged the field value.
*INSTANCEITERATION Number Process instance iteration when the field value was logged.
*STEPITERATION Number Step iteration when the field value was logged.
*DOCUMENTNAME String Name of the document that contains the field value that was logged.
*FIELDNAME String Name of the field within the document that was logged.
*STRINGVALUE String The value of the field if the logged field value is a string.
*NUMBERVALUE String The value of the field if the logged field value is a number; otherwise the service returns 0.0 in this field.
*DATEVALUE String The value of the field if the logged field value is date.
message
String Error that occurred during the execution of this service if this service encountered an error.
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