This topic describes the Mapping node.
This topic contains the following sections:
When you first open or create a message map for the node, if you select This map is called from a message flow node and maps properties and message body, the headers in the input message are always copied to the output message without modification. To modify the message headers in a Mapping node, select This map is called from a message flow node and maps properties, headers, and message body. When you select this property, the map that is created allows additional elements, including MQ, HTTP, and JMS headers, to be mapped.
These components of the output message can be defined using mappings that are based on elements of both the input message and data from an external database. You create the mappings that are associated with this node, in the mapping file that is associated with this node, by mapping inputs (message or database) to outputs. You can modify the assignments made by these mappings using supplied or user-defined functions and procedures; for example, you can convert a string value to uppercase when you assign it to the message output field.
Use the Mapping node to:
The Mapping node is contained in the Transformation drawer of the palette, and is represented in the workbench by the following icon:
You can view samples only when you use the information center that is integrated with the Message Brokers Toolkit.
When you have put an instance of the Mapping node into a message flow, you can configure it; 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.
Configure the Mapping node as follows:
On z/OS systems,
the broker uses the broker started task ID, or the user ID and password that
were specified on the mqsisetdbparms command
JCL, BIPSDBP in the customization data set <hlq>.SBIPPROC.
If you click Browse next to this entry field, a dialog box is displayed that lists all available mapping routines that can be accessed by this node. Select the routine that you want and click OK; the routine name is set in Mapping Module.
To work with the mapping routine that is associated with this node, double-click the node, or 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 a Mapping 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.
You must set this property to reflect accurately the output message format that you need. If you select an option (or accept the default value) that does not include a particular component of the message, that component is not included in any output message that is constructed.
LocalEnvironment was known as DestinationList in some previous versions; it is retained for compatibility.
The Environment component of the message tree is not affected by the mode setting. Its contents, if any, are passed on from this node.
Mode | Description |
---|---|
Message (the default) | The message is generated or passed through by the Mapping node, as modified within the node. |
LocalEnvironment | The LocalEnvironment tree structure is generated or passed through by the Mapping node, as modified within the node. |
LocalEnvironment And Message | The LocalEnvironment tree structure and message are generated or passed through by the Mapping node, as modified by the node. |
Exception | The Exception List is generated or passed through by the Mapping node, as modified by the node. |
Exception And Message | The Exception List and message are generated or passed through by the Mapping node, as modified by the node. |
Exception and LocalEnvironment | The Exception List and LocalEnvironment tree structure are generated or passed through by the Mapping node, as modified by the node. |
All | The message, Exception List, and LocalEnvironment are generated or passed through by the Mapping node, as modified by the node. |
When you select the check box, the node handles all positive return codes from the database as errors and generates exceptions in the same way as it does for the negative, or more serious, errors. If you do not select the check box, the node treats warnings as normal return codes, and does not raise any exceptions. The most significant warning raised is not found, which can be handled safely as a normal return code in most circumstances.
For more details, see Validating messages.
The Mapping 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 propagated if a failure is detected during the computation. If you have selected Treat Warnings as Errors, the node propagates the message to this terminal if database warning messages are returned, even though the processing might have completed successfully. |
Out | The output terminal that outputs the message following the execution of the mappings. |
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 Mapping 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 Mapping node Basic properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Data Source | No | Yes | The ODBC data source name of the database in which reside the tables to which you refer in the mappings that are associated with this node (identified by the Mapping Module property). | |
Transaction | Yes | No | Automatic | The transaction mode for the node. Valid values are Automatic or Commit. |
Mapping Routine | Yes | No | Mapping | The name of the mapping routine that contains the statements to execute against the database or the message tree. The routine is unique to this type of node. |
Mapping Mode | Yes | No | Message | The mode used to process information that is passed
through the Mapping node. Valid
values are:
|
Treat Warnings as Errors | Yes | No | Cleared | If you select the check box, database SQL warnings are treated as errors. |
Throw Exception on Database Error | Yes | No | Selected | If you select the check box, database errors cause the broker to throw an exception. |
The parser options for the Mapping node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Parse Timing | Yes | No | On Demand | This property controls when an input message is parsed.
Valid values are On Demand, Immediate, and Complete. For a full description of this property, see Parsing on demand. |
Use XMLNSC Compact Parser for XMLNS Domain | Yes | No | Cleared | Setting this property causes the outgoing MQRFH2 to specify the XMLNS instead of XMLNSC parser, allowing an external application to remain unchanged. If outgoing messages do not contain MQRFH2 headers, this property has no effect. |
Retain Mixed Content | Yes | No | Cleared | This property controls whether the XMLNSC parser creates elements in the message tree when it encounters mixed text in an input message. If you select the check box, elements are created for mixed text. If you clear the check box, mixed text is ignored and no elements are created. |
Retain Comments | Yes | No | Cleared | This property controls whether the XMLNSC parser creates elements in the message tree when it encounters comments in an input message. If you select the check box, elements are created for comments. If you clear the check box, comments are ignored and no elements are created. |
Retain Processing Instructions | Yes | No | Cleared | This property controls whether the XMLNSC parser creates elements in the message tree when it encounters processing instructions in an input message. If you select the check box, elements are created for processing instructions. If you clear the check box, processing instructions are ignored and no elements are created. |
The Validation properties of Mapping node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Validate | Yes | Yes | None | This property controls whether validation takes place. Valid values are None, Content and Value, Content, and Inherit. |
Failure Action | Yes | No | Exception | This property controls what happens if a validation failure occurs. You can set this property only if Validate is set to Content or Content and Value. Valid values are User Trace, Local Error Log, Exception, and Exception List. |