For developers, mapping data during process authoring is a critical capability of the IBM Workflow Designer. In a previous blog post, we covered the latest features of the data mapper. In this blog, we focus on Mapping Suggestions, a feature designed to further increase productivity when authoring data mappings.
We begin with the brief overview of the data mapper and the mapping suggestions feature, then walk through the three available mapping suggestions modes, explaining how each mode works and the types of suggestions it provides.
Figure 1: Mapping data in a process using the data mapper.
Mapping data in processes using mapping suggestions
Mapping suggestions can significantly reduce the time required to define input and output mappings for tasks within a process. Instead of manually configuring mappings one by one, developers can automatically insert mappings in bulk for a selected task – saving time and reducing repetitive clicks.
To use the mapping suggestions feature, click the button located on the top-right corner of the data mapper dialog. Mappings are inserted based on the currently selected mode (indicated by the button description). The incomplete mappings which have a variable match are updated, and a message indicates how many mappings were added.
Figure 2: Inserting mapping suggestions for existing and new variables.
Mapping suggestions modes
The mapping suggestions feature supports 3 modes of operation, allowing developers to control how mappings are created depending on their use case:
- Suggest existing variables
Creates mappings only when an existing variable closely matches the input or output field name and the data types are compatible. Use this mode in established processes where suitable variables already exist, and new variables are not required.
- Suggest new variables
Creates mappings by generating new variables whose initial name match the input or output field names. Use this mode when you want to create a fresh set of variables and reuse of existing variables is unnecessary.
- Suggest existing or new variables
Attempts to map to an existing variable first; if no suitable match is found, a new variable is created. Use this mode when you want to reuse compatible existing variables where possible but still allow new variables when needed.
Figure 3: The three mapping suggestions modes available.
The selected mapping suggestions mode is set by clicking the chevron button and choosing an option from the drop-down menu. All suggestions inserted respect the currently selected mode, and when reopened, the mapper dialog retains the previously selected suggestion mode.
Existing Variable Suggestions
When determining whether an existing variable is a suitable match for an input or output field, the mapping suggestions feature applies two criteria:
- Name similarity – The existing variable’s name must closely resemble the name of the input or output field.
- Type compatibility – The data type of the existing variable must be compatible with type of the input or output field.
For example, an input field named currentPostion of type String would be considered a good match for an existing variable named currPosition1 if it is also of type String.
New Variable Suggestions
When mappings are created using newly generated variables, these variables appear with a edit icon (
) next to their names, indicating that the name can be edited. Clicking the icon allows the developer to change the default variable name provided by the mapper. The new variables are created after the developer clicks the OK button to submit the data mapper dialog.
Figure 4: A new variable mapping with an editable name.
Figure 5: Editing the name of a new variable mapping.
Conclusion
Mapping suggestions is a powerful feature that helps developers work more efficiently by reducing manual variable selection, minimizing repetitive configuration tasks, and accelerating the overall data mapping process. We encourage developers to incorporate mapping suggestions into their everyday authoring workflows and to choose the mode that best fits their scenario to maximize productivity.