Setting the Encoding Type for a Publishable Document Type

The encoding type determines the format that Integration Server uses to encode and decode instances of this publishable document type. Keep the following points in mind when setting the encoding type:

You can only set the encoding type for publishable document types that use Universal Messaging 9.7 or later as the messaging provider. Integration Server always encodes publishable document types that use Broker as the messaging provider as a Broker Event. Integration Server encodes locally published documents as IData.

Integration Server and Designer must be version 9.7 or later.

The encoding type that you specify affects the scope of filtering that Universal Messaging performs and affects the provider filters you can create for webMethods Messaging Triggers that subscribe to the publishable document type. If you change the encoding type for a publishable document type for which there are already subscribers, the provider filters created in webMethods Messaging Triggers might not work properly.

For more information about encoding type and filters, see Universal Messaging Provider Filters and Encoding Type.

If you want to use protocol buffers as the encoding type and use a provider filter, the Universal Messaging configuration properties must be set to true, the defaults, on Universal Messaging:

Use Universal Messaging Enterprise Manager to view and edit the configuration properties for the realm to which Integration Server connects.

Changing the encoding type causes the publishable document type to be out of sync with the provider definition on Universal Messaging.

An IS document type that contains a Document Reference field or Document Reference list field named “group” cannot become a publishable document type with an encoding type of protocol buffers. The document type can only use the IData encoding type. The name “group” is a reserved name for protocol buffers.

You can only set the encoding type for a publishable document type if you own the lock on the IS document type (or you have it checked out) and you have write permission to the IS document type.

1. In the Package Navigator view of the Service Development perspective, double-click the document type for which you want to set the encoding type.

2. In the Properties view, under webMethods Messaging, next to Encoding type, select one of the following:

Select...	To encode and decode published documents as...
IData	A serialized IData object. An IData object is the universal container that Integration Server uses to receive input and deliver output. An IData object contains an ordered collection of key/value pairs.
Protocol buffers	A protocol buffer. Protocol buffers is an approach to encoding and decoding structured data developed by Google. This is the default.

4. If you selected protocol buffers as the encoding type and a field in the publishable document type cannot be represented in protocol buffers, Designer displays a warning message to that effect. Click OK to dismiss the message.

For information about synchronizing document types, see About Synchronizing Publishable Document Types