Creating message maps

You can create a graphical data map, a message map, a submap, or a legacy message map to transform a message without the need to write code, providing a visual image of the transformation, and simplifying its implementation and ongoing maintenance.

About this task

A message map is the IBM® App Connect Enterprise implementation of a graphical data map. It is based on XML schema and XPath 2.0 standards, with additional support for JSON schema draft 4 and Swagger 2.0. You can use a message map to graphically transform, route, and enrich a message, or implement a REST API. For more information, see Implementing a REST API operation by using a message map. You can use a message map to modify data in a database system. You can use drag actions to make connections, select transforms, and build logic to transform your message data without programming.

A submap is a reusable form of graphical data map. Submaps enable you to use a set of mapping functions in multiple graphical data maps to transform a common set of elements in the input object to the output object. You can use a submap to reuse common data transformations. You can reuse submaps in other products that support graphical data maps.

Note: If you plan to reuse data transformations across different products, read Guidelines for developing reusable graphical data mapping assets.

A local map is a subset of data transformations between input elements and output elements that are part of a graphical data map. You define a local map by creating a Local map transform in a message map. A local map is not an independent resource. There is no physical file associated with a local map. The scope of a local map is the message map. A local map is processed with the graphical data map. Local maps provide a way of breaking up a large graphical data map into nested groups of mapping elements. You can use local maps to simplify the overall graphical data map presentation. You can structure complex data transformations into nested groups that are easier to manage and implement.

A legacy message map is a message map that was created as a .msgmap file in earlier versions of WebSphere® Message Broker (for example, in WebSphere Message Broker Version 7). In IBM App Connect Enterprise, you must convert your legacy message maps to .map files before you can deploy or modify them. For more information, see Using or converting legacy resources into message maps.

Procedure

Choose any of the following options to create a graphical data map:

Create a message map to transform your messages graphically. For more information, see Creating a message map.

Use this type of map to create a graphical data map in IBM App Connect Enterprise. You can transform message assembly components, body data, and access a database to retrieve data or modify data, if needed.
Create a graphical data map to share a map across different products that support the Graphical Data Mapping editor. For more information, see Creating a graphical data map in the Eclipse editor.
Use this type of map to create a graphical data map that you can use as a submap in IBM App Connect Enterprise, or that you can use as a main map in other products that support the Graphical Data Mapping editor. You can only transform the body of a message. You cannot access a database when you use this type of map to enrich a message or to modify database content.
Create a submap to reuse common transformation logic. For more information, see Creating a submap.
Use this type of map to create a graphical data map that you can use as a submap in IBM App Connect Enterprise. You can only transform the body of a message. You can access a database to enrich a message or to modify database content.
Create a local map to reduce complexity reading and managing graphical data maps. For more information, see Creating a local map by using the Local map transform.
Use this type of map to reduce the complexity of your maps and submaps. This type of map is local, and you cannot reuse it, unless you convert it to a submap.

Results

You can use the following table to identify the type of map that you must create when transforming data graphically in the Graphical Data Mapping editor:

Table 1. Types of map based on design requirements
	Recommended use	Type of resource	Supported in IBM App Connect Enterprise
Message map	Transform messages graphically	.map file	Yes
Submap	Reuse of common data transformations	.map file	Yes
Local map	Reduce complexity reading and managing a Message map	No file. It is embedded within a Message map	Yes
Graphical data map	Share graphical data maps across different software products	.map file	Yes
Legacy message map	Solutions migrated from earlier versions of WebSphere Message Broker	.msgmap file	These files must be converted into .map files before they can be used in IBM App Connect Enterprise. (See note below.)

Note: Legacy message maps must be converted into .map message map format before they can be deployed or modified by IBM App Connect Enterprise.

You can see the message map in the Application Development view displayed under a Maps category, and organized by namespace.

What to do next

After you create a graphical data map, edit the map, and define transformations between the input message and the output message. For more information, see Editing message maps.