Use the Message Filter mediation primitive to selectively route messages.
The Message Filter mediation primitive uses expressions, so you can direct messages that meet certain criteria down different paths of a flow.
The Message Filter mediation primitive has one input terminal and multiple output terminals. The input terminal is wired to accept a message and the output terminals are wired to propagate a message. One output terminal is for failure output and one is the default output terminal. The other output terminals are each associated with a simple, conditional expression. The contents of the message are compared with each expression in turn, and if the condition is met then the message is propagated to the associated output terminal. The primitive can be configured either to use the first matching output terminal, or all matching output terminals. The default output terminal is used if the message meets none of the conditions.
If an exception occurs during the filtering then the fail terminal propagates the original message, together with any exception information.
You can use the Message Filter mediation primitive to check that the inbound message meets some criterion. For example, that a required field is set. If the criterion is not met you can raise a fault using the Fail mediation primitive, or send an error response.
The Message Filter mediation primitive lets different messages take different paths. For example, a message might need forwarding to different service providers based on the request details.
You can use the Message Filter mediation primitive to bypass unnecessary steps. You can test if certain data is in a message, and only perform a Database Lookup operation if the data is missing.
When used in combination with a Database Lookup primitive, the Message Filter can direct messages based on an independently administrable lookup table. For example, you could route a message based on customer status even if the inbound message contained only the customer identifier.
By configuring the primitive to propagate messages to all matching terminals, you can trigger multiple events each requiring different conditions. For example, you could log requests relating to a particular account identifier and send requests relating to a particular product to be audited.
Property | Valid Values | Default | |
---|---|---|---|
Filters | Pattern | String: An XPath expression against which the input message will be tested | |
Terminal name | String | ||
Root | String: An XPath expression representing the root of the transformation | /body | |
Distribution mode | String: All or First | First |
Consider the following when using the Message Filter mediation primitive: