pub.event.routing:send

Note:

Event Routing is a framework that Software AG provides for applications to communicate using events. For more information about using Event Routing, see Communicating Between Software AG Products Using Event Routing.

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.routing: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.

Note:

You must specify an IS document type for the documentTypeName parameter if createOptions is set to VALIDATE_BODY. The XML structure of the IS document type specified in the documentTypeName parameter must match the XML structure passed as the value of evt:body in the pub.event.eda:event document type.

event

Document A document reference (IData) to the pub.event.eda:event document type containing the event that you want to publish, including the event header and payload.

createOptions

String List Optional. Options that Integration Server passes on to the Event Routing framework during the creation of an event.

Possible values are none or any one or both of the following:

EXTRACT_FILTERABLE_PROPS if you want the Event Routing framework to verify that the workspace name and service name that combine to form the value of evt:type in the pub.event.eda:event document type are valid.

VALIDATE_BODY if you want the Event Routing framework to verify that the XML structure passed as the value of evt:body in the pub.event.eda:event document type matches the XML structure of the IS document type specified as the documentTypeName parameter.

Note:

If you select the VALIDATE_BODY option, you must specify an IS document type for the documentTypeName parameter. Integration Server will issue an error if you do not specify any value for documentTypeName.

isAsync

Boolean Optional. Specifies whether or not the event is sent synchronously or asynchronously. Set to:

true to send the event asynchronously.

If set to true, after sending the event, Integration Server executes the next step in the flow service immediately. Integration Server does not wait for an acknowledgment before continuing service execution.

false to send the event synchronously.

If set to false, after sending the event, Integration Server waits for an acknowledgment before executing the next step in the flow service. This is the default.

If the value of isAsync is set to true, you must specify a callback service in the serviceName input parameter.

service Name

String Optional. The callback service that you want Integration Server to invoke upon receiving an acknowledgment from the Event Routing framework after completing the send operation.

The input signature for the callback service is defined by the document pub.event.routing:eventAcknowledgement. The pub.event.routing:eventAcknowledgement must be provided as an input document to the callback service.

Note:

You must specify a callback service if the value of isAsync parameter is set to true.

runAsUser

String Optional. The name of the user account whose credentials Integration Server uses to execute the callback service. This parameter is required only if the event is being sent asynchronously, that is, if the isAsync parameter is set to true.

You can specify a locally defined user account or a user account defined in a central or external directory. The user account you specify must have the execute ACL associated with the callback service.

If you do not specify any user account for an event that is sent asynchronously, Integration Server uses the name specified in the watt.server.event.routing.runAsUser server configuration parameter. If no user is specified in that parameter, Integration Server uses the Administrator user to execute the service. For more information about watt.server.event.routing.runAsUser, see webMethods Integration Server Administrator’s Guide.

eventID

String The unique identifier of the sent event. The eventID is the same as the evt:EventID in pub.event.eda:event, either supplied by the user who emitted the event or generated by the Event Routing framework.