pub.publish:envelope
WmPublic. Document type that defines the content and structure of the envelope that accompanies a published document.
The envelope records information such as the sender's address, the time the document was sent, password and certificate information, and other useful information for routing and control. Every publishable document type contains a document reference to this document type.
Read/Write Parameters
You can set the following parameters within your service. Broker supports all of the read/write parameters. However, webMethods Universal Messaging supports only activation, businessContext, priority, replyTo, and tag. Universal Messaging ignores the values of any other read/write parameters set in the document envelope and passes them through to subscribers.
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 | 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." |
Read-only Parameters
webMethods Universal Messaging, webMethods Broker, or Integration Server set the following parameters. You cannot set these parameters within your service, but you can retrieve their values from published documents.
Note: | Of the read-only parameters listed below, webMethods Universal Messaging supports the destID, pubID, and uuid parameters only. |
age | java.lang.Integer Optional. The cumulative time, in seconds, that the document spends on all webMethods Brokers. The webMethods Broker starts tracking the document age when it receives the document from the publishing client. The 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 webMethods Brokers, age also includes the length of time the document spends on the other 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 webMethods Broker placed the document into the client queue. |
logBroker | String Optional. The name of the webMethods Broker that contains the document in its document log. The webMethods Broker sets this parameter when webMethods Broker-based document logging and the logging utility are enabled. |
logHost | String Optional. The host name and port number of the webMethods Broker that contains the document in its document log. The webMethods Broker sets this parameter when webMethods Broker-based document logging and the logging utility are enabled. |
pubDistinguishedName | String Optional. The distinguished name of the publisher's SSL certificate. The webMethods Broker sets this parameter when the publisher has an SSL connection to the 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 webMethods Brokers through which a document passed. When a webMethods Broker receives a document, the webMethods Broker sets the broker and recvTime keys. When the webMethods Broker places the document in the queue for the next webMethods Broker, the first webMethods Broker sets enqueueTime. The webMethods Broker only sets these fields when document is forwarded from one webMethods Broker to another. The webMethods Broker does not set these fields when the publishing and receiving clients are connected to the same webMethods Broker. |
| Key | Description |
| broker | String Optional. The name of the webMethods Broker. |
| recvTime | java.util.Date Optional. The time the webMethods Broker received the document from the publishing client or another webMethods Broker. |
| enqueueTime | java.util.Date Optional. The time the webMethods Broker placed the document in the queue for the next webMethods Broker. |
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. |
Output Parameters
None.
Usage Notes
For more information about setting and using a document's envelope parameters, see webMethods Broker Java Client API Reference, webMethods Broker Client C API Programmer’s Guide, and Publish-Subscribe Developer’s Guide.
See Also
