User GuideReference ManualIntegration Scenarios
 

2.2.1. Message Definition

See: Managing Channels - Message Edit Functions

All messages are described in a graphical form using a tree structure with multiple nodes and node types that can be further configured.

Once a new message format has been saved or during edition of existing messages, the message tree is rendered in the Visual Editor in a hierarchical and graphical form as illustrated below.

In Visual Editor, you can further configure and set up message format as well as add verification rules as explained in following chapters.

Message edit screen

Figure 2.11. Message edit screen


Nodes

The message tree representing a hierarchical view of the message is based on three node types:

Node types

Figure 2.12. Node types


  • (1) A value node is the representation of a business value in the message.

    • represents a fixed static value defined as an xml element.

    • represents a standard value depending on message file defined as an xml element.

    • represents a fixed static value defined as an xml attribute.

    • represents a standard value depending on message file defined as an xml attribute.

      A message item will be defined as an xml element or attribute depending on xml generation or translation tool that has been used. The main difference for Babelway platform is that an attribute is unique and cannot be repeated inside an element. So you cannot use loops with these attribute items.

  • (2) A structural node has no value, but is used to group nodes or specify a hierachy between nodes. It also has a representation in the message.

    • represents root level message node.

    • represents any other structural node.

  • (3) A virtual node has no representation in the message but brings subsequent information concerning this message, like value multiplicity or possible structure alternatives. There are two different value nodes: Loop and Choice/Option nodes.

    • represents a loop node.

    • represents a choice node.

    • represents an option node, used together with a choice node.

Each value of structural node is either required or not.

Contextuel menu

When you right click on message nodes, a context menu such as the one illustrated below will open. This menu displays a set of commands available for selected node. All possible commands are listed hereunder and described in details in referenced chapters.

Edit screen contextual menu

Figure 2.13. Edit screen contextual menu


Edit Element enables you to modify node name, to add a node description, to define a static value and to tag node as required. Refer to Message Definition for detailled informations.

Duplicate makes a copy of selected node and all its children if any. You should modify duplicated nodes name according to your system to avoid any problem at message processing time.

Hide and Show makes node (and its children if any) visible or not in the transformation tab. This function is used to simplify transformation step by not displaying nodes that do not require mapping. Note that if a hidden node is already mapped, it remains mapped in the transformation tab but cannot be modified.

Delete removes selected node (and its children if any). A confirmation message box is displayed before deletion.

The Add Validations... submenu allows you to select one or more criteria that must be met by a node in order for the message to be properly processed by the system. If any of these criteria is not met, message will not be processed and an error will be raised. Refer to Message Validation for detailled informations.

Create Loop, Remove from Loop, Put in next/previous Loop enables you configure loops in your message. These loops are used to manage repetitive elements such as multiple items lines in a message. Refer to the Managing Loops chapter for detailled informations.

Create Choice, Remove from Choice, Put in next/previous Choice enables you configure choices and options in your message. These choices are used to manage different mutually exclusive message configurations. Refer to the Managing Choice chapter for detailled informations.

Additional commands

  • Save command saves the message format modifications. Until saving, changes will not be available in the transformation tab.

  • Reset removes message definition and comes back to message definition wizard.

  • Show Advanced Properties displays additional message properties including changeable name and description.

Once you have completed this setup, do not forget to save it using the Save command.