Integration Server 10.7 | Publish-Subscribe Developer’s Guide | Publishing Documents | Setting Fields in the Document Envelope
 
Setting Fields in the Document Envelope
 
About the Activation ID
About UUID, EventIds, and Digital Event Services
The document envelope contains information about the published document, such as the publisher’s client ID, the client to which error notifications should be sent, a universally unique identification number, and the route the document has taken through the system. The document envelope contains read/write fields as well as read-only fields.
The following table identifies the read/write envelope fields that you might want to set when building a service that publishes documents.
Field name
Description
activation
A String that specifies the activation ID for the published document. If a document does not have an activation ID, Integration Server automatically assigns an activation ID when it publishes the document.
Specify an activation ID when you want a trigger to join together documents published by different services. In this case, assign the same activation ID to the documents in the services that publish the documents. For more information about how Integration Server uses activation IDs to satisfy join conditions, see Understanding Join Conditions.
errorsTo
A String that specifies the client ID to which Integration Server sends an error notification document (an instance of pub.publish.notify:error) if errors occur during document processing by subscribers.
If you do not specify a value for errorsTo, error notifications are sent to the document publisher.
Note:
The errorsTo field is not supported by Universal Messaging.
priority
Specifies the priority level of the message. The priority level 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 level in the document envelope when publishing the document. The default priority is 4.
Note:
Priority messaging does not apply to locally published documents.
For more information about priority messaging, see webMethods Service Development Help.
replyTo
A String that specifies which client ID replies to the published document should be sent to. If you do not specify a replyTo destination, responses are sent to the document publisher.
Important:
When you create a service that publishes a document and waits for a reply, do not set the value of the replyTo field in the document envelope. By default, Integration Server uses the publisher ID as the replyTo value. If you change the replyTo value, responses will not be delivered to the waiting service.
uuuid
Universally unique identifier for the document. Integration Server assigns a UUID when publishing the document. However, if a service publishes a document to Universal Messaging using pub.publish:publish, 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 not begin with the sequence “wm:” in any case combination. The “wm:” prefix is reserved for UUIDs generated by Integration Server.
If you do not specify a valid uuid value, Integration Server assigns one.
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 Broker, Integration Server ignores any assigned uuid value.
For information about how UUIDs are generated for documents published to Digital Event Services, see About UUID, EventIds, and Digital Event Services .
For more information about the fields in the document envelope, see the description of the pub.publish:envelope document type in the the section pub.publish:envelope in the webMethods Integration Server Built-In Services Reference. pub.publish:envelope.