The Integration blog covers the latest in product updates, best practices, customer stories, and more.

User Friendly Names in Mapper

Ishruthilaya Malarvizhi
Technical Lead

In this blog, we will look at a new integration feature, User Friendly Names in the Mapper UI and see how the Mapper UI has changed with the introduction of this feature. The new feature will become available shortly. The Source and Target tree elements displayed in the Mapper UI are based on the application schemas. Many application schemas define their interfaces with extremely cryptic technical names that are not easy to correlate to the user friendly display names you would see in the end point application's UI.
This feature provides the option to show display label instead of the technical name directly in the trees and expression builder.The feature is supported for all types of integration. 

Mapper UI Displaying Technical Names (Developer Mode):

Mapper UI Displaying User Friendly Names (User Friendly Mode):

Toggling the Mapper UI Between User Friendly and Developer Mode

On navigating to the Mapper screen, by default the Mapper is launched in the user friendly mode, with user friendly names displayed in the screen. To view the technical names of the elements, click on the 'Developer' button available on the top panel. To get back to the user friendly mode, to view the user friendly names, toggle the mode by clicking on the 'Developer' button again.

User Friendly Names in Source/Target Tree

In this section we will look at the user friendly names for the tree elements like the root elements and child elements.

Root Elements

The user friendly names for the root elements of the different payloads, help to easily correlate them with the invoke/trigger associated, the adapter used, the type of the payload (request/response). The icon of the root element is the icon corresponding to the adapter associated.

The format of the user friendly names for the root elements differs based on the variable type or the adapter associated. Below is the table which lists the format of the user friendly names for the root elements for different variable types.

Adapter/Variable Type Format of the User Friendly Name Sample
Application Adapter <trigger/invoke action name>  <payload type (request/response)>  <(Name of the Associated Adapter)> SendInventoryAdjustments Request (Soap)
System Adapter For the system adapters, find the user friendly names in the sample field

Schedule - Schedule

$self or the Integration Metadata - Integration Metadata

Tracking Variables

IF user friendly name (the 'Tracking Name' field) is entered for the tracking variable in the Tracking UI (Business Identifiers For Tracking), then that is the user friendly name for the variable

IF the 'Tracking Name' field is not populated for the variable, then the system constructs the user friendly name for the tracking variable in the format: 'Tracking Variable 1/2/3'

My Business Identifier

Tracking Variable 1

Tracking Variable 2

Tracking Variable 3

Other Variables For all other variables, i.e simple variables and root element of the complex variables, the user friendly name is constructed by the system in the format 'Name with which the variable was created, without the '$' prefix'



Child Elements

The user friendly names for the child elements in the Source/Target is derived from the associated Schema files. If the schema files are generated with the user friendly names for the elements, then the elements get rendered with those names in the user friendly mode in Mapper.

If the Schema files do not contain the user friendly names for the elements defined, then the child elements are displayed with the technical name in user friendly as well as the developer mode.

Child Elements Displayed with User Friendly Names

Child Elements Displayed with Technical Names

The attributes of the schema elements are rendered with the '@' prefix followed by the attribute name in the Mapper UI. With the user friendly names introduced, the '@' prefix is not appended to the user friendly name or in the user friendly mode. On turning the 'Developer' mode on and viewing the technical names, the attributes get displayed with the '@' prefix.

The user friendly names do not include the namespace prefix, hence the option to view the element names with prefix 'Show Prefix' available in the View menu of the Mapper UI, is disabled when the Mapper UI is in user friendly mode and the option is enabled once the UI is switched to 'Developer Mode'.

Searching For Data in the Source/Target Tree

The Source/Target tree can be searched with the sub string in user friendly/technical name of an element, in both the modes of Mapper UI.

For example, if the Mapper UI is in user friendly mode and there exist an element whose user friendly name is 'BEG: Beginning Segment for Purchase Order' and the technical name if 'BegSegPO' and the search string which is used to search for the element in the tree is 'SegPO', the search highlights the element irrespective of the current mode

User Friendly Expression for Mapping

Just like how the elements technical names are simplified by their user friendly names, the mapping expression created are represented in a simplified form using 'User Friendly Expression'. The user friendly expression is simple and easy to read and understand.

This is a UI only entity, i.e the user friendly expression for a mapping created, is displayed in the Mapper UI, however it does not get saved in the XSL file that gets saved. This can be noticed by navigating to the 'Code' tab of the Mapper UI, after creating the mapping, the 'Code' tab would display the XSL file that is going to get generated behind the scenes and it contains only the technical mapping and not the user friendly expression. Hence the maps should work as it always used to, at runtime. At design time, the Mapper UI displays the mappings as user friendly expression in the user friendly mode and as technical mappings in the developer mode.

The user friendly expression for a mapping is created by the system when a mapping is constructed in the Mapper UI. The user friendly expression is created based on the user friendly name for the components in the mapping.


Consider a mapping 'concat($EDI-Translate/nsmpr0:executeResponse/ns31:TranslateOutput/ns31:translation-status, $EDI-Translate/nsmpr0:executeResponse/ns31:TranslateOutput/ns31:tracking-info)'. The mapping refers to a concat function whose parameters are two elements from the payload

User Friendly Expression for the above mapping is 'concat( translation-status, tracking-info)'

where 'translation-status' is the user friendly name of the element '$EDI-Translate/nsmpr0:executeResponse/ns31:TranslateOutput/ns31:translation-status'

'tracking-info' is the user friendly name of the element '$EDI-Translate/nsmpr0:executeResponse/ns31:TranslateOutput/ns31:tracking-info'

Expression Builder

The Expression Builder section in the Mapper UI displays the mapping for the target element selected. The Expression Builder also has two modes:

User Friendly Mode:

Developer Mode:

The user friendly mode of the Expression Builder displays the mapping as a user friendly expression. The Expression Builder is view only in this mode, hence the 'Save', 'Erase', 'Shuttle' buttons are not available in this mode. To toggle the Expression Builder between the two modes, click on the toggle button available on the right side of the Expression Builder.

On navigating to the Mapper screen, the expression builder launches in the user friendly mode, by default, on selecting a target element. To edit the existing mapping manually, toggle the Expression Builder to the Developer Mode.

Other Sections of the UI

The other sections of the Mapper UI where the source/target elements are displayed, like the 'Test' tab where the root elements of each source is displayed as the header of the tabs, 'Filter' menu, where one of the criterion to filter the tree data is by 'Source name' shows the root elements of the different sources, all of them display the names in sync with the base screen of Mapper, i.e, if Mapper UI is in user friendly mode, these section of the UI also displays the names in the user friendly mode and if the Mapper UI is in developer mode, these sections displays the technical names of the elements.

Be the first to comment

Comments ( 0 )
Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.