Administering and Monitoring Business Processes 10.4 | Administering and Monitoring Business Processes | webMethods Monitor Built-in Services Reference | pub.monitor.document Folder | pub.monitor.document:getDetails
 
pub.monitor.document:getDetails
Gets the most recently logged details about a specified document.
Input Parameters
The following table lists the input parameters.
documentID
String Document ID of the document for which to get logged details. Specify the complete, exact ID. If there are multiple entries with the same document ID, the service returns all the entries.
Note: Whether the documentID is treated as case-sensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data.
Output Parameters
The following table lists the output parameters.
details
Document List The retrieved details. For each document that matches the specified document ID, the service returns the following logged details:
*DOCUMENTID String Document ID you specified; that is the document ID to which these details apply.
*DOCUMENTNAME String Document name of the document.
*STATUS Number Document type of the document. The service returns the numerical value that represents the type, as follows:
*0 webMethods Broker (deprecated)
*4 Failed
*512 Retries Exceeded
*32770 In question
*STATUSDECODE String The localized keyword value for the document type. The keyword (in English) will be one of: webMethods Broker(deprecated), Retries Exceeded, In Doubt, or Failed.
*ENQUEUETIMESTAMP String If a webMethods Broker (deprecated) logged the document, the time webMethods Broker(deprecated) first enqueued the document; otherwise it is null. The timestamp is in string format, YYYY-MM-DD hh:mm:ss.SSS zzz, where:
*YYYY-MM-DD is the date
*hh:mm:ss:SSS is the time, including milliseconds
*zzz is the time zone
*SERVERID String The server ID associated with the document:
*For webMethods Broker(deprecated)-logged documents, ID of the publishing webMethods Broker(deprecated).
*For in doubt documents, documents that failed during delivery or retrieval, and documents where the retries were exceeded and could not be delivered, ID of the intended recipient.
*For failed documents that failed during publishing and for retries exceeded documents that could not be published, no server ID is listed.
*AUDITTIMESTAMP Number Time this document was logged, in epoch time; that is, the number of seconds since January 1, 1970.
*AUDITTIMESTRING String Time this document was logged in string format, YYYY-MM-DD hh:mm:ss.SSS zzz, where:
*YYYY-MM-DD is the date
*hh:mm:ss:SSS is the time, including milliseconds
*zzz is the time zone
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