Ensemble Virtual Documents
Settings for Routing Processes
[Home] [Back] [Next]
InterSystems: The power behind what matters   
Class Reference   

Provides reference information for settings of EnsLib.HL7.MsgRouter.RoutingEngine business process, which you use to route most kinds of virtual documents.
EnsLib.HL7.MsgRouter.RoutingEngine has the following settings:
Group Settings
Basic Settings Validation, Business Rule Name
Additional Settings Act On Transform Error, Act On Validation Error, Alert On Bad Message, Bad Message Handler, Response From, Reply Target Config Names, Response Timeout, Force Sync Send
Development and Debugging Rule Logging
The remaining settings are common to all business processes. See Settings for All Business Processes in Configuring Ensemble Productions.
Act On Transform Error
If True, causes errors returned by a transformation to stop rule evaluation and the error to be handled by Reply Code Actions setting.
Act On Validation Error
If True, causes errors returned by validation to be handled by Reply Code Actions setting.
Alert On Bad Message
If True, any document that fails validation automatically triggers an alert.
Bad Message Handler
If the document fails validation, and if the routing process has a configured Bad Message Handler, it sends the bad document to this business operation instead of its usual target for documents that pass validation.
See Defining Bad Message Handlers,” earlier in this book.
Business Rule Name
The full name of the routing rule set for this routing process.
Force Sync Send
If True, make synchronous calls for all “send” actions from this routing process. If False, allow these calls to be made asynchronously. This setting is intended to ensure FIFO ordering in the following case: This routing process and its target business operations all have Pool Size set to 1, and ancillary business operations might be called asynchronously from within a data transformation or business operation called from this routing process.
If Force Sync Send is True, this can cause deadlock if another business process is called by a target that is called synchronously from this routing process.
Note that if there are multiple “send” targets, Force Sync Send means these targets will be called one after another in serial fashion, with the next being called after the previous call completes. Also note that synchronous calls are not subject to the Response Timeout setting.
Reply Target Config Names
Specifies a comma-separated list of configuration items within the production to which the business service should relay any reply documents that it receives. Usually the list contains one item, but it can be longer. The list can include business processes or business operations, or a combination of both.
This setting takes effect only if the Response From setting has a value.
Response From
A comma-separated list of configured items within the production. This list identifies the targets from which a response may be forwarded back to the original caller, if the caller requested a response.
If a Response From string is specified, the response returned to the caller is the first response that arrives back from any target in the list. If there are no responses, an empty “OK” response header is returned.
The Response From string also allows special characters, as follows:
If this setting value is unspecified, nothing is returned.
Response Timeout
Maximum length of time to wait for asynchronous responses before returning a “timed-out error” response header. A value of -1 means to wait forever. Note that a value of 0 is not useful, because every response would time out. This setting takes effect only if the Response From field has a value.
Rule Logging
If logging is enabled controls the level of logging in rules. You can specify the following flags:
For allowed values and basic information, see the Validation setting for business services.
If the document fails validation, the routing process forwards the document to its bad message handler, as specified by the Bad Message Handler setting. If there is no bad message handler, the routing process does not route the document, but logs an error. Also see Alert On Bad Message.