Message Serialization Application Type

A Message Serialization Application takes a data structure and returns a streaming buffer with a string representation in the formats SWIFT or XML.

Creating a Message Serialization Application Type

To create a Message Serialization Application, select Application in the diagram toolbar palette and choose Message Serialization Application:

Creating a Serialization Application
Figure: Creating a Serialization Application

Properties

The following properties can be set for message serialization applications:

Properties of a Serialization Application
Figure: Properties of a Serialization Application.

Target Message Format

In the Target Message Format entry, you can choose between the following message formats:

Selecting the Target Message Format
Figure: Selecting the Target Message Format.

Source Message Type

In the Source Message Type entry select a source message type in the provided list. All structured types defined for the model will be provided.

Selecting the Source Message Type.
Figure: Selecting the Source Message Type.

Testing and Debugging

In the Testing and Debugging section, you can either manage or select existing test configurations, or create new test configurations.

Select a test configuration

To select a predefined test configuration click the drop-down menu for the Test Configurations entry. All previously created test configurations will be offered, where you can choose the one you want to use:

Choose a Test Configuration
Figure: Choose a Test Configuration

Manage test configurations

Select Manage test configurations to edit existing test configurations in the Run Configurations dialog. Please refer to the section Parsing and Serialization Launch Configuration of the chapter Launching Message Transformations for detailed information on launch configurations for message applications.

Create a new test configuration

Select Create to create a new test configuration matching the settings of the parsing configuration. A dialog opens where you have to select the file containing the test input message:

Select an Input File
Figure: Select an Input File

Please take care that you pass an input file matching the format you selected in the Target Message Format entry and the input file is not empty, otherwise the serialization will fail.

Now a test configuration is created with the name "New Messaging Test<numberOfConfiguration>", which is entered in the Test Configurations entry:

New Test Configuration Entry
Figure: New Test Configurations Entry

The settings of the new configuration are created automatically:

New Test Configuration
Figure: New Test Configuration

To test the configuration, you have to enable the Test Serialization checkbox.

Test configurations can also be created from the main menu's run configuration. Please refer to the section Parsing and Serialization Launch Configuration of the chapter Launching Message Transformations for detailed information on how to create a launch configuration for message serialization applications from the main menu.

Screen Output

In case you enable the Screen Output checkbox, the resulting message will be displayed in the Console view. You can open this view by selecting Window > Show View > Console.

Console View
Figure: The parsed Message displayed in the Console View.

Output in a target message file

To save the result in a target message file, disable the Screen Output checkbox and enter a file or browse to an existing file in the Target Message File entry.

Configuring Retry Mechanism

The configurable retry mechanism provides the facility to retry an operation in case the target service is temporarily unavailable.

For more information, please refer to Retry Mechanism of Non-interactive Applications section of the Applications Concept chapter.

If you enable the Retry functionality for a Message Serialization application, you have to define the number of retries and the time between retries in seconds. Note that the maximum number of retries is 10 and the maximum time between retries is restricted to 60 seconds. Additionally you can enable the retry to be performed on application side and thus disable a retry on engine side.


An application with an enabled retry functionality will retry for the defined number of times with a pause of the defined number of seconds, until it succeeds. If the application still fails after the defined number or time, it will no longer retry.