Check node
Use the Check node to compare the template of a message that is arriving on its input terminal with a message template that you supply when you configure the Check node.
- Developer
- Application Integration Suite
- Standard
- Advanced
- Express
- Scale
This topic contains the following sections:
Purpose
The message domain, message model, and message type of the message are collectively called the message template. The domain defines the parser that is used for the message. The message model is the message set to which the message belongs. The type is the structure of the message itself. You can check the incoming message against one or more of these properties. The message property is checked only if you select its corresponding Check property, which means that a message property that contains a null string can be compared.
If the message properties match the specification, the message is propagated to the Match terminal of the node. If the message properties do not match the specification, the message is propagated to the Failure terminal. If the Failure terminal is not connected to some failure handling processing, an exception is generated.
The Check node is contained in the Validation drawer of the palette, and is represented in the IBM® Integration Toolkit by the following icon:
Using this node in a message flow
Use the Check node to ensure that the message is routed appropriately through the message flow. For example, you can configure the node to direct a message that requests stock purchases through a different route from that required for a message that requests stock sales.
Another example of this node's use is for the receipt of electronic messages from staff at your head office. These messages are used for multiple purposes; for example, to request technical support or stationery, or to advise you about new customer leads. These messages can be processed automatically because your staff complete a standard form. If you want these messages to be processed separately from other messages received, use the Check node to ensure that only staff messages with a specific message type are processed by this message flow.
Terminals and properties
When you have put an instance of the Check node into a message flow, node into a message flow, you can configure it. For more information, see Configuring a message flow node. The properties of the node are displayed in the Properties view. All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk.
The Check node terminals are described in the following table.
| Terminal | Description |
|---|---|
| In | The input terminal that accepts a message for processing by the node. |
| Failure | The output terminal to which the message is routed if the incoming message does not match the specified properties. |
| Match | The output terminal to which the message is routed if the incoming message matches the specified properties. |
The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the BAR file to deploy it).
The Check node Description properties are described in the following table.
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Node name | No | No | Check | The name of the node |
| Short description | No | No | A brief description of the node. | |
| Long description | No | No | Text that describes the purpose of the node in the message flow. |
The Check node Basic properties are described in the following table.
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Domain | No | No | The name of the domain. | |
| Check domain | Yes | No | Cleared | This property checks that a message belongs to a particular domain. To check the parser that is to be used for the incoming message, select this check box and select one of the values from the Domain list. |
| Message model | No | No | The message set to which the incoming message belongs. If you are using the XMLNSC, IDOC, or MRM, check that the incoming message belongs to a particular message set by selecting Check message model and entering the name of the message set in Message model. Leave Message model clear for other parsers. If you set this property, then subsequently update the project dependencies to remove this message set reference, a warning is issued. Either update the Message model property, or restore the reference to this message set project. |
|
| Check message model | Yes | No | Cleared | If you select this check box, the incoming message is checked against the Set property. |
| Message | No | No | The message name. If you are using the MRM parser, check that the incoming message is a particular message type by selecting Check message and entering the name of the message in Type. Leave Message clear for other parsers. |
|
| Check message | Yes | No | Cleared | If you select this check box, the incoming message is checked against the Type property. |
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Events | No | No | None | Events that you have defined for the node are
displayed on this tab. By default, no monitoring events are defined
on any node in a message flow. Use Add, Edit,
and Delete to create, change or delete monitoring
events for the node; see Configuring monitoring event sources by using monitoring properties for details. You can enable and disable events that are shown here by selecting or clearing the Enabled check box. |