1. Babelway
  2. Babelway User Guide
  3. Chapter 4. Manage & Build

4.3.2. Common Properties

All Message definitions, whatever their type (XML, CSV, Edifact, ...) have a few common fields, that are explained here. In addition, they can have some other fields specific to their type, and that is explained in message definition formats section.

 

Message Definition

This file is Babelway's internal representation of your message definition tree. You can view and modify its contents through here for troubleshooting purposes. However, we highly recommend you use the graphical editor (tree) as this guarantees that all your changes are supported by the platform.

 

Validation Mode

Upon processing a message, the platform will check that it matches the description configured in your message definition tree. The validation mode describes how strictly messages need to comply with your definition in order to be processed.

By default, loose validation is selected for all new message definitions. The validation modes differ in the way they handle unrecognized fields and loops:

 Strict 

  • Field Values: Mandatory fields and all value restrictions configured in your message definition tree will be checked. 

  • Structure: Unrecognized fields will trigger an error. 

  • Loops: If applicable, checks that there aren't too few or too many elements in the loop. 

 Loose 

  • Field Values: Mandatory fields and all value restrictions configured in your message definition tree will be checked. 

  • Structure: Unrecognized fields will be ignored and the message will be processed. 

  • Loops: The number of elements in loops aren't checked. 

 Compatibility  (Deprecated) 

 This mode is deprecated, please contact support for more information. 

 

Filename out

On all Message definition OUTs, this property will allow you to change the output file name. 

This can be very handy to match any convention required by the receiver. For example, you could want that the file name matches some reference, or include the date, ...

If you leave this field empty, default rules will apply, that consist basically or taking the input file name, and replace the extension to match the type of the Message definition OUT.

File names may not be longer than 255 characters.

 

Input charset

MessageDefinitions IN will have this property to allow you to specify in which charset the input files have been encoded, so that they can be interpreted correctly.

If not filled, UTF-8 will be assumed.

This property will not be present for binary formats (like PDF), where it make no sense, or for textual formats where the charset can be detected automatically (ex: in Edifact, charset is written directly inside the file).

 

Output charset

MessageDefinitions OUT will have this property to allow you to specify in which charset the output file must be encoded.

If not filled, UTF-8 will be assumed.

 

Sample

A sample of messages files that are processed by this MessageDefinition.

If not changed afterwards, this file will be the file that you uploaded in the wizard to create the MessageDefinition.

The property will no impact on the processing of the messages by this MessageDefinition. But it can be used to help when you are working in the SelfService. For example, the Sample of the message IN will be used by default when you create a sample.

 

Id

A unique identifier of the Message definition. This id can for example be very useful to refer to a Message definition when contacting support.

 

Created on & last updated on

When the Message definition was created and edited for the last time..