User GuideReference ManualIntegration Scenarios
 

3.4.1. Tutorial Level 2

Before we start:

  1. Download this file locally: EdifactOrderSample.txt

  2. Download this second file locally: CsvOrderStructureSample.txt

  3. Print the tutorial: click on the printer icon

LET'S MAKE CHANGES

The tutorial level 1 guided you through a fairly straightforward channel. Moreover, probably not very useful to send an email and to receive the same on the other side.

Imagine you need to configure the channel to transform the message into another message format (such that it can be automatically imported by the receiving system for example). The tutorial will now take you through the transformation of an EDIFACT purchase order into a Comma separated value (CSV) order message.

Go back to the channel edition screen: click 'channels' in the top menu and click on your channel.

Click the third tab

Click Open catalogue you are in the Catalogue page.

In the Search field, type (EDIFACT), then click

Spot Edifact : EDIFACT, then click Use it

Enter a name for this message,for example,type (EDIFACT from MyRetailClient), click Apply : you are back to the Edit Channel page.

Click Browse, select the file EdifactOrderSample.txt that you downloaded previously and click Upload: the system displays the message definition tree.

You have now defined the structure of the expected incoming files. If incoming files respect this structure, they will be processed by the channel. Note that you can work on the message definition tree to create validations, make fields mandatory, etc. Refer to the User Guide to explore what you can do.

Let's proceed with our configuration.

Click the fifth tab

Click Open catalogue you are in the Catalogue page.

In the Search field, type (CSV), then click

Spot CSV : CSV, then click Use it

Enter a name for this message,for example,type (My order format), click Apply : you are back to the Edit Channel page.

Click Browse, select the file CsvOrderStructureSample.txt that you downloaded previously and click Upload:

Tick the box (contains headers), then click Save: the system displays the message definition tree.

Click the fourth tab

This tab is not available for clicking because you have defined a Message In and a Message Out. The channel therefore expects a transformation between the 2 message definitions.

Click Open catalogue you are in the Catalogue page.

Spot Drag and Drop Transformation : New Drag and Drop Transformation, then click Use it

Enter a name for this message,for example,type (EDIFACT to CSV orders), click Apply : you are back to the Edit Channel page.

On the left side, use the scroll bar to spot the first Loop segment. A Loop indicates that the underlying list of field can be repeated multiple times in a message. This can be the case for the number of lines in an Order message.

Drag the first Loop segment of the left side and drop it in the Loop segment of the right side.This indicates that for each line of the loop of the incoming message, there should be a corresponding line in the outgoing message.

On the left side, spot the second Loop segment.

Drag the second Loop segment of the left side and drop it in the Loop segment(same as previous)of the right side.

On the left side, spot the segment 'BGM Beginning of message'.

Click to expand.

Drag the segment BGM02 Document/message number and drop it in the (OrderNumber) segment on the right side.

Go down the page, click Save and confirm.Be sure to save your work regularly.

On the left side, scroll down to the bottom of the tree and spot (transformation functions). Right click on Transformation functions and select Format Date. We are going to use this function to reformat the date of the incoming message into another date format.

Enter a name,for example,type (reformatting of the date).

In Date Format In, type (respect cases) 'yyyyMMDDhhmm'.

In Date Format Out, type (respect cases) 'DD/MM/yy'.

Click Save: you created a date transformation function.

On the left side, spot the first DTM_Date/time/period segment and click to expand

Drag the segment DTM0102_Date/time/period and drop it on the name 'reformatting of the date' of the date transformation function at the bottom of the tree. This segment is the order date according to the EDIFACT semantics. By rolling the mouse over the field, you make have explanations as to what the fields. If this is not sufficient, you should seek information about the semantics of the messages from the people creating or requiring them (that part may not be the easiest one).

Drag the function 'reformatting of the date' and drop it in the 'OrderDate' segment on the right side. You have now created a mapping for the date field that reformats the date automatically.

Go down the page, click Save and confirm.

On the left side, spot the second DTM_Date/time/period segment and click to expand.

Drag the segment DTM102_Date/time/period and drop in the segment DeliveryDate on the right side.

On the left side, spot the first NAD_Name and Address segment and click (several times) to expand.

Drag the segment NAD0201_Party id. Identification and drop it in the Buyer segment on the right side.

On the left side, spot the second NAD_Name and Address segment and click (several times) to expand.

Drag the segment NAD0201_Party id. Identification and drop it in the Supplier segment on the right side.

On the left side, spot the Third NAD_Name and Address segment and click (several times) to expand.

Drag the segment NAD0201_Party id. Identification and drop it in the DeliveryPlace segment on the right side.

Go down the page, click Save and confirm.

Keep scrolling down and spot the next Loop segment.Drag it and drop it in the Loop segment(same as previous) of the right side.

Click to expand the LIN_Line Item segment.

Click (again) to expand the LIN_Line Item segment.

Spot the LIN0301_Item number segment.

Drag and drop it in the ItemNumber segment on the right side.

Click to expand the IMD_Item Description segment

Spot the IMD0304_Item description segment.

Drag and drop it in the ItemDescription segment on the right side.

Click to expand the QTY - Quantity segment.

Spot the QTY0102 - Quantity segment.

Drag and drop it in the ItemQuantity segment on the right side.

Go down the page, click Save and confirm.

You have now organised a full transformation between an Edifact message and a CSV message. Let's test if this works.

Click the ninth tab,

If there is already a test case (which is probably true if you did the tutorial from the beginning), delete the exiting case since it relates to the old version of the channel. (this deactivates the channel since a test case is always required for an active channel).

Click Create Test Case

Go down the page and click Run test case

Was your test case successful ?

This submits the Message In of the test case to your transformation. It directs you to the message record with a message (success or failure). You should open the message out to check that it delivered what was expected.

Was your test case successful ?

When it is,you can also set-up email notifications for your channel.

Click the Seventh tab

In the Email edit box enter your email then click "Add".

Go down the page and tick the 2 boxes in front of your username to receive new messages notifications and error alerts.

click Save

Your channel is now ready for deployment.

Click Activate (on top of the testing tab)

Click Back: you are in the List of Channels page

Click Deploy Hub and confirm : your channel is now active in production environment

TEST THIS CHANNEL

Follow the same process as in the first part of the tutorial. Attach the file EdifactOrderSample.txt to your email and monitor it. You can also try with another message to see the result.

Check your email box, you should have received 2 emails from your Babelway hub

  • A notification message

  • The output of the channel with the CSV order attached. Compare the file you received with the file "Message In File Name.dat" to be sure you made the transformation correctly.

You have completed the tutorial level 2.