Building Your Event-Driven Architecture : Integration Server Built-In Services Reference : Event Folder : Summary of Elements in this Folder : pub.event.nerv:send
pub.event.nerv:send
WmPublic. Deprecated - Replaced by pub.event.routing:send.
Sends an EDA event to the Network for Event Routing and Variation (NERV). Integration Server constructs an EDA event using the parameters defined in the service, and then sends the event to NERV.
Note:  
NERV is a framework that enables applications to communicate using events. It uses the Apache Camel integration framework for event routing, filtering, and variation. By default, NERV uses a Camel component that is configured for JMS as the transport layer and JNDI destinations as the endpoints. For more information about using NERV and configuring other providers, see webMethods Event Processing Help.
Input Parameters
documentType Name
String Optional. Fully qualified name of the IS document type that specifies the structure to impose on the body of the event. By specifying a document type, you can identify:
*The order and dimensionality of elements.
*The prefix associated with each namespace in the instance document.
When field names in a document type include a prefix and specify a value for the XML namespace property, the pub.event.nerv:send service will convert a name/value pair in the event/body IData with the same prefix and name to an XML element with that prefix and with a local name equivalent to the XML namespace property value.
event
Document A document (IData) containing the event that you want to publish, including the event header and payload.
Key
Description
header
Document A document containing the information that you want to set in the event header.
Key
Description
Start
java.util.date Optional. Start date and time of the event. If you do not specify a start value, the pub.event.nerv:send service uses the current date and time.
End
java.util.date Optional. End date and time of the event.
Kind
String Optional. Indicates whether the event is a new event (Event) or a heartbeat event (Heartbeat). A heartbeat event indicates the temporal progress of the stream.
Possible values are Event and Heartbeat. The default is Event.
Type
String The name of the event type for the event.
Version
String Optional. Version of the event type with which the event is compatible. An event should contain a version only if the event type supports versioning.
Uses this regular expression for validation:[0-9]+(.[0-9]+)*
CorrelationID
String Optional. Unique identifier used to associate this event with other events.
EventID
String Optional. The unique identifier of the event. This element can be supplied by the event producer or can be system generated.
Priority
String Optional. The priority of the event to the producer. The value can be Normal or High.
ProducerID
String Optional. The identifier of the event producer. For example, this can be an application identifier or a globally unique identifier for each producer.
UserID
String Optional. The identifier of the user who emitted the event.
CustomHeaders
Document List Optional. Any other name/value parameters that should be included in the header field of the message.
body
Document Optional. A document (IData) containing the payload for the event. If this is a heartbeat event, do not specify a value for body.
endpointUris
String Optional. Endpoint URIs to which the event will be sent.
If this parameter is specified, NERV sends the event to the specified endpoint URIs.
If this parameter is not specified, NERV sends the event to the default endpoint configured for NERV.
encode
String Optional. Flag indicating whether to encode the data. Set this parameter to true if your XML data contains special characters, including the following: < > & " '
Set to:
*true to encode the data.
For example, the string expression 5 < 6 would be converted to <expr>5 &lt; 6</expr>, which is valid.
*false to not encode the data. This is the default.
For example, the string expression 5 < 6would be converted to <expr>5 < 6</expr>, which is invalid.
Output Parameters
None.
Usage Notes
The pub.event.nerv:send service sends an event in the form of a Camel message to NERV. NERV then routes this event to all consumers that have registered a listener for the event type. You can send a regular EDA event or a heartbeat event for the specified event type in header/Type. The pub.event.nerv:send service infers whether the event is a regular event or a heartbeat event based on the presence of the body parameter. To send a heartbeat event, do not specify a value for the body parameter.
Some attribute values might be inserted into the event by NERV if the event producer does not supply one. For example, EventID and Start will be assigned if the event producer does not supply one.
See Also
pub.event.nerv:subscribe
pub.event.nerv:unsubscribe
Copyright © 2016 - 2016 Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback