Creating Event Specification
An event specification defines the structure, topic, and encoding/decoding method for an event.
You can also create an event specification in Designer in the event trigger editor.
Before you create an event specification, the streaming connection alias that will be used to send and retrieve events from the streaming provider must already exist.
To create an event specification
1. Open Integration Server Administrator.
2. Go to Streaming > Event specifications.
3. Click Create Event Specification.
4. In Connection Alias Name, select the streaming connection alias for the streaming server to which events that are instances of this specification will be sent.
5. In Event Specification Name, provide a unique name for the event specification. An event specification name must be unique for the selected streaming connection alias. Multiple event specifications can have the same name if each of the specifications is associated with a different streaming connection alias.
6. In Topic Name, specify the topic on the streaming provider in which events are stored.
7. Specify the data type and additional encoding/decoding information for the event key by doing the following:
a. Under Key, in the Type field, select the data type for the event key. The selected type indicates how Integration Server encodes the key object in a published event to bytes and how Integration Server decodes the bytes in the key object of an event received by an event trigger.
Select one of the following types:
none. A type of none indicates no data will be sent or received for the key object. For example, if you set the key type to "none" and the value type to "String",
Integration Server will send or receive only the value object as String.
Integration Server will not send or receive a key.
raw. A type of raw indicates that no decoding is performed by event triggers that receive the event. The event trigger service receives a byte array for the key. You might use "raw" if you want the trigger service to call a service that decodes the data or if you want the trigger service to simply forward the raw data onto another service. For example, suppose you want an event trigger to forward an event to another topic only if the key = "Canada". Because the trigger processing depends only on the key object, you do not need to decode the value object. You might select String as the type for key and raw as the type for value.
Double Float Integer Long String JSON XML b. If you selected Double, Float, Integer or Long in the Type field, select the Decode as String check box if you want Integration Server to decode the byte array to a String. A String value may be easier to work with in Integration Server.
c. If you selected JSON or XML in the Type field and you want to use a document type to direct encoding and decoding, type the fully qualified name of the IS document type, JSON document type, or XML document type in the Document Type Name field.
d. If you selected String, JSON, or XML in the Type field , in the Charset Name field, type the charset name to use for encoding and decoding. The default is UTF-8.
8. Repeat steps 7 for the Value type.
9. Click Save Changes.
Integration Server saves the event specification in the same package in which the streaming connection alias is saved.