Events are published by
using XML documents. The following XML specification is used for generic
events, that is, events that are generated explicitly by using the
event publishing CALL routines.
The EVENT_PUBLISH CALL
routine automatically generates the header portion of the document
by using information that you provide in the EVENT_BEGIN CALL routine
properties. It creates the body portion of the document using information
that you provide in the EVENT_BODY CALL routine properties.
<?xml version="1.0" encoding="UTF-8"?>
<sas-event:Event
xmlns:sas-event=
"http://support.sas.com/xml/namespace/services.events-1.1"
sas-event:name="event_name">
<sas-event:Header>
<sas-event:Version>1.0</Version>
<sas-event:Identity>guid</sas-event:Identity>
<sas-event:Credentials
sas-event:name="userid"
sas-event:password="password"
sas-event:domain="domain"/>
<sas-event:Priority>priority</sas-event:Priority>
<sas-event:SentFrom>originator_description</sas-event:SentFrom>
<sas-event:SentAt>timestamp</sas-event:SentAt>
<sas-event:Response
sas-event:type="none|ack|result"/>
<sas-event:Properties>
<PropertyName>property_value</PropertyName>
....
</sas-event:Properties>
</sas-event:Header>
<sas-event:Body>
body content
...
</sas-event:Body>
</sas-event:Event>
The following table
explains the elements:
Elements
|
|
|
Specifies the root element
that names the event. The sas-event namespace is defined in this element.
|
|
Begins the event header
properties.
|
|
Specifies the version
of the event message that is required to support multiple specifications
as the service matures.
|
|
Specifies the unique
identifier. Responses echo this identifier so that the originator
can use it for correlation.
|
|
Specifies the credentials
that are used for authentication and authorization checks. Events
that are defined at a broker can be configured so that the sender
of the event must be authenticated and authorized to run the event.
A configured event can also specify a security context under which
it should be run.
|
|
Is mapped to a Java
thread priority so that process flows and listener dispatchers can
be run at different priority levels.
|
|
Specifies the description
of event originator that is used for logging purposes if available.
|
|
Specifies the time that
the event was sent. This information is echoed to the sender along
with completion times. All times should be formatted according to
the International Standard ISO 8601 standard. A brief summary is available
on the W3C Web site at: http://www.w3.org/TR/NOTE-datetime.html .
|
|
Specifies the type of
response that the sender of an event wants. The supported types are
no response (NONE), acknowledgment (ACK), and request/response (RESULT).
Both NONE and ACK act as broadcast events.
|
|
Specifies user-defined
properties that the originator can send to be used during event execution.
|
|
Specifies the value
assigned to the property called PropertyName.
|
|
Specifies the actual
message content to be acted upon.
|