This topic contains the following sections:
Use the Extract node to extract the contents of the input message that you want to be processed by later nodes in the message flow. Using the Extract node, you can create a new output message that contains only a subset of the contents of the input message. The output message comprises only those elements of the input message that you specify for inclusion when configuring the Extract node, by defining mapping statements.
The Extract node is represented in the workbench by the following icon:
You might find this node useful if you require only a subset of the message after initial processing of the whole message. For example, you might want to store the whole message for audit purposes (in the Warehouse node), but propagate only a small part of the message (order information, perhaps) for further processing.
For example, you receive orders from new clients and you want to collect their names and addresses for future promotions. Use the Extract node to get this information from each order, and send it as a new message to head office. These messages are processed at head office so that the customer details can be included in the next marketing campaign.
When you have put an instance of the Extract node into a message flow, you can configure it. To display its properties, right-click the node and click Properties. (If you double-click the Extract node, you open the New Message Map dialog box.)
All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk.
To configure the Extract node:
To work with the mapping routine that is associated with this node, right-click the node and click Open Mappings. If the mapping routine does not exist, it is created for you with the default name in the default file. If the file exists already, you can also open file <flow_name>_<node_name>.mfmap in the Broker Development view.
A mapping routine is specific to the type of node with which it is associated; you cannot use a mapping routine that you have developed for an Extract node with any other node that uses mappings (for example, a DataInsert node). If you create a mapping routine, you cannot call it from any other mapping routine, although you can call it from an ESQL routine.
For more information about working with mapping files, and defining their content, see Developing message mappings.
The Extract 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 input message is routed if a failure is detected during extraction. |
Out | The output terminal to which the transformed message is routed if the input message is processed successfully. |
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 Extract node Description properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | The node type | 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 Extract node Basic properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Mapping Module | Yes | No | Extract | The name of the mapping routine that contains the statements to run against the message tree. The routine is unique to this type of node. |