activation | String Optional. A unique identifier that any messaging client (including the Integration Server) assigns to all documents published as a result of the one-time execution of the integration solution. If a document does not have an activation ID, the Integration Server assigns one when the document is published. If you are using a trigger to join documents published by different services, you must explicitly set the activation ID of the documents. The services that publish the documents must assign the same activation ID to the documents. |
appLastSeqn | java.lang.Integer Optional. This field is provided for backward compatibility. |
appPassword | String Optional. The password of the user specified in appUserName. If the resource that processes the document requires authentication before it begins processing, specify the password in this field. |
appSeqn | java.lang.Integer Optional. This field is provided for backward compatibility. |
appUserName | String Optional. The user name for logging into the application that processes the document. Use the appPassword field to specify the password for this user name. |
businessContext | String Optional. Used by the Integration Server to track business process context and audit context across multiple Integration Servers. Important: The businessContext field is reserved for internal use by the Integration Server. Do not set or overwrite the value of the businessContext field. |
controlLabel | java.lang.Short[ ] Optional. This field is provided for backward compatibility. |
errorsTo | String Optional. The client ID to which the Integration Server sends an error notification document if errors occur during document processing by subscribers. If this parameter is not set, error notifications will be sent to the document publisher. The errors document is an instance of
pub.publish.notification:error. |
errorRequestsTo | String Optional. This field is provided for backward compatibility. |
locale | String Optional. Locale of the publishing client expressed as a URN (Uniform Resource Name). Trigger services examine the locale value to determine the locale to use when processing the document. If the locale field is empty, the locale of the current Integration Server is used instead. |
maxResults | java.lang.Integer Optional. This field is provided for backward compatibility. |
priority | java.lang.Integer Optional. Indicates how quickly the document should be published and processed. A value of 0 is the lowest processing priority; a value of 9 indicates expedited processing. Set a message priority in the document envelope when publishing the document. The default priority is 4. |
replyTo | String Optional. The client ID to which the replies to the published document should be sent. If this parameter is not set, replies will be sent to the document publisher as specified in pubId. |
runLevel | java.lang.Integer Optional. This field is provided for backward compatibility. |
signature | byte[ ] Optional. A byte sequence that holds a digital signature. Specify a digital signature if clients receiving this document requires one. |
signatureType | String Optional. The type of digital signature being used. |
startResult | java.lang.Integer Optional. This field is provided for backward compatibility. |
tag | java.lang.Integer Optional. Used with
pub.publish:publishAndWait and
pub.publish:deliverAndWait to match a request document with its corresponding reply document. Important: The tag field is reserved for internal use by the Integration Server. Do not set or overwrite the value of the tag field in the envelope. |
trackId | String Optional. A unique identifier assigned to a published document by the publishing client application. If no value is specified, Integration Server populates this field with the value of the uuid field. |
transactionId | String Optional. This field is provided for backwards compatibility. |
transformState | String Optional. An indication of a document's current state, set by a publishing client application that transforms data. For example, a client could publish a document with a transformState value of "USEnglish" and a receiving client could translate the document into French and publish it with a transformState value of "French." |
uuid | String Optional. Universally unique identifier for the document. Integration Server assigns the UUID when it publishes the document. The receiving Integration Server uses the UUID to detect duplicate documents. If a service uses the pub.publish:publish service to publish a document toUniversal Messaging, you can specify a value for uuid. The uuid value that you assign must meet the following criteria: Must be a minimum of 1 character in length. Must be a maximum of 96 characters in length. Must begin with the sequence "wm:" in any case combination. The "wm:" prefix is reserved for UUIDs generated by Integration Server. Integration Server accepts a user-defined UUID only for invocations of pub.publish:publish that publish a document to Universal Messaging. That is, the document being published must be an instance of a publishable document type to which a Universal Messaging connection alias is assigned. For any other publishing service in pub.publish or invocations of pub.publish:publish that publish a document locally or to IBM webMethods Broker, Integration Server ignores any assigned uuid value. |
age | java.lang.Integer Optional. The cumulative time, in seconds, that the document spends on all IBM webMethods Brokers. The IBM webMethods Broker starts tracking the document age when it receives the document from the publishing client. The IBM webMethods Broker stops tracking the document age when the subscribing client removes the document from the client queue. If the document is routed to successive IBM webMethods Brokers, age also includes the length of time the document spends on the other IBM webMethods Brokers. | |
connectionIntegrity | String Optional. An indication of whether the received document passed over a link that is not secure. This field can have one of the following values: < empty > indicates that at some point, the document passed through a connection that was not encrypted. U.S Export indicates that all the connections used to transport the event had an encryption strength of ENCRYPT_LEVEL_US_EXPORT or greater. U.S. Domestic indicates that the event traveled exclusively over connections with an encryption strength of ENCRYPT_LEVEL_US_DOMESTIC. | |
destId | String Optional. The ID of the destination to which the document is being delivered. The publisher sets the destID when it publishes the document. For example, the Integration Server uses the destID value specified in the
pub.publish:deliver service or the
pub.publish:deliverAndWait service to populate the destID value in the document envelope. | |
enqueueTime | java.util.Date Optional. The date and time that the IBM webMethods Broker placed the document into the client queue. | |
logBroker | String Optional. The name of the IBM webMethods Broker that contains the document in its document log. The IBM webMethods Broker sets this parameter when IBM webMethods Broker-based document logging and the logging utility are enabled. | |
logHost | String Optional. The host name and port number of the IBM webMethods Broker that contains the document in its document log. The IBM webMethods Broker sets this parameter when IBM webMethods Broker-based document logging and the logging utility are enabled. | |
pubDistinguishedName | String Optional. The distinguished name of the publisher's SSL certificate. The IBM webMethods Broker sets this parameter when the publisher has an SSL connection to the IBM webMethods Broker and clears this parameter when the publisher has a non-SSL connection. | |
pubId | String Optional. An identifier for the document publisher assigned by the messaging provider. | |
pubNetAddr | byte[ ] Optional. The IP address and port number of the document's publisher. | |
pubSeqn | java.lang.Long Optional. This field is provided for backwards compatibility. | |
pubLabel | java.lang.Short[ ] Optional. This field is provided for backwards compatibility. | |
recvTime | java.util.Date Optional. The date and time the document was received by the messaging provider. | |
route | Document List Optional. Information about the IBM webMethods Brokers through which a document passed. When IBM webMethods Broker receives a document, IBM webMethods Broker sets the broker and recvTime keys. When IBM webMethods Broker places the document in the queue for the next IBM webMethods Broker, the first IBM webMethods Broker sets enqueueTime. IBM webMethods Broker only sets these fields when document is forwarded from one IBM webMethods Broker to another. IBM webMethods Broker does not set these fields when the publishing and receiving clients are connected to the same IBM webMethods Broker. | |
Key | Description | |
broker | String Optional. The name of the IBM webMethods Broker. | |
recvTime | java.util.Date Optional. The time the IBM webMethods Broker received the document from the publishing client or another IBM webMethods Broker. | |
enqueueTime | java.util.Date Optional. The time the IBM webMethods Broker placed the document in the queue for the next IBM webMethods Broker. |