Before we start:

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

You have completed the tutorial level 2.

With an Email Gateway, incoming messages are attached to email messages and sent to a specific Babelway email address and processed as soon as they arrive.

To create an email gateway, select an existing template or make a copy of the generic Email template in the catalogue and following screen will be displayed.

Figure 1.10. Email Gateway configuration

There is only one field to enter if a value has not been defined yet in selected template:

If the address you try to create already exists, you will receive the following message and you will have to enter a new address.

Figure 1.11. Error message if entered email address already exists

With a Fetch Mail Gateway, incoming messages are attached to email messages and sent to an external email address. Babelway platform polls this address at regular intervals and retrieves incoming mails to process them.

To create a fetch email gateway, select an existing template or make a copy of the generic Fetch Mail template in the catalogue and following screen will be displayed.

Figure 1.12. Fetch Mail Gateway configuration

The following fields should be defined in order to configure your incoming gateway:

With a Ftp Client Input Gateway, incoming messages are transfered to an external Ftp server. Babelway platform polls this server at regular intervals and retrieves incoming files to process them.

To create a ftp client gateway, select an existing template or make a copy of the generic Ftp client template in the catalogue and following screen will be displayed.

Figure 1.13. Ftp client gateway in configuration

The following fields should be defined in order to configure access to your external ftp server:

After channel deployment, your ftp server will be available to send messages. You can access this ftp server using any ftp client software set up with the previous account parameters.

With a SFTP Client Input Gateway, incoming messages are transfered to an external SFTP server. Babelway platform polls this server at regular intervals and retrieves incoming files to process them.

To create a SFTP client gateway, select an existing template or make a copy of the generic SFTP Client template in the catalogue and following screen will be displayed.

Figure 1.14. SFTP client gateway in configuration

The following fields should be defined in order to configure access to your external sftp server:

After channel deployment, your ftp server will be available to send messages. You can access this ftp server using any ftp client software set up with the previous account parameters.

With a Ftp Server Input Gateway, incoming messages are received on a Babelway specific server and processed as soon as they arrive.

To create a ftp server gateway, select an existing template or make a copy of the generic Ftp server template in the catalogue and following screen will be displayed.

Figure 1.15. Ftp server gateway in configuration

The following fields should be defined in order to configure your ftp server on Babelway platform:

After channel deployment, your ftp server will be available to send messages. You can access this ftp server using any ftp client software set up with the previous account parameters.

Using the SFTP Server Input Gateway,incoming messages are received on a Babelway specific server and processed as soon as they arrive. The SFTP server gateway supports SFTP version 3 and password and/or publickey user authentication mechanisms.

To create a SFTP server gateway, open the catalogue and select an existing template or make a copy of the generic SFTP server template in the catalogue. The following screen will be displayed.

Figure 1.16. SFTP server gateway in configuration

The following fields should be defined in order to configure your SFTP server on the Babelway platform:

After channel deployment, your SFTP server will be available to send messages. You can access this SFTP server using any SFTP (version 3) client software set up with the previous account parameters.

Public key generation

The public key is expected to be in a RSA format (OpenSSH, Putty or DER). If you don’t already have a public/private key, you can generate one using ssh-keygen from OpenSSH :

C:\cygwin\bin>ssh-keygen.exe
Generating public/private rsa key pair.
Enter file in which to save the key (/.ssh/id_rsa): /tmp/identity
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in /tmp/identity.
Your public key has been saved in /tmp/identity.pub.
The key fingerprint is:
f0:e4:2f:(...) user@computer

With an AS2 Gateway, incoming messages are received using an AS2 connection. Incoming files are processed as soon as they are received.

AS2 (Applicability Statement 2) is a specification about how to transport data securely and reliably over the Internet. Security is achieved by using digital certificates and encryption.

To create AS2 gateway, select an existing template or make a copy of the generic AS2 template in the catalogue and following screen will be displayed.

Figure 1.17. AS2 gateway configuration

The following fields should be defined in order to configure your AS2 access:

After channel deployment, your AS2 connection will be available to receive messages.

Report AS2 parameters to the other party

Click on GenericAS2Specifications.doc command to download a Word file including all parameters values required to establish AS2 communication. In this file, you should change Identity field to match the To field value (see above) as automatically attributed by Babelway interface, this value follows " BABELWAY_AS2_xxxxx " form.

Once this parameter has been changed to match your settings, you can send the file to the other party to give him all parameters he will require to establish a communication with your channel.

Figure 1.18. GenericAS2Specifications Word file example

With a web gateway, incoming messages are manually uploaded on a specific Babelway webpage. They are processed as soon as they are uploaded.

To create a web gateway, select an existing template or make a copy of the generic Web template in the catalogue and following screen will be displayed.

Figure 1.19. Web Gateway configuration

There is no parameter to define in this template. The web gateway will be automaticaly created using the gateway name you entered.

You can access your specific web server via your Account Management screen, in Access and Notifications part. Click on the link next to the Message Upload via Web Gateway field. The web link is listed with the same name as the web gateway you created.

Figure 1.20. Web gateway access via my account management

Once you open your web gateway, following screen is displayed. Click on Upload tab if it is not open by default.

Figure 1.21. Web gateway Upload screen

Figure 1.22. Upload confirmation message

The internal gateway in / out are used for internal transfer of messages between channels inside the same account environment.

To create an internal gateway, select an existing template or make a copy of the generic Babelway Internal template in the catalogue and following screen will be displayed.

Figure 1.23. Internal Gateway configuration

There is no parameter to define in this template. The internal gateway will be automaticaly created using the gateway name you entered. You will then be able to select it as an Internal Gateway Out in another channel configuration.

With an OFtp server Gateway in, Incoming messages are received on a Babelway specific OFTP server and processed as soon as they arrive.

To create an OFtp server Gateway in, select an existing template or make a copy of the generic OFtp server template in the catalogue and following screen will be displayed.

Figure 1.24. OFtp server gateway in configuration

The following fields should be defined in order to configure your OFTP Server on Babelway platform:

After channel deployment, your Oftp server will be available to send messages. You can access this ftp server using any Oftp client software set up with the previous account parameters.

With an OFTP Client Input Gateway, incoming messages are transferred from an external OFTP server. The Babelway platform polls this server at regular intervals and retrieves files to process them.

To create an OFtp client Gateway in, select an existing template or make a copy of the generic OFtp client template in the catalogue and following screen will be displayed.

Figure 1.25. OFtp client gateway in configuration

The following fields should be defined in order to configure your OFTP client on Babelway platform:

After channel deployment, your Oftp server will be available to send messages. You can access this ftp server using any Oftp client software set up with the previous account parameters.

With an Http in Gateway, incoming messages are received on a Babelway specific server and processed as soon as they arrive.

To create a Http in gateway, select an existing template or make a copy of the generic Httpin template in the catalogue and following screen will be displayed.

Figure 1.26. Http in gateway configuration

The following fields should be defined in order to configure your Http in access:

After channel deployment, your connection will be available to send messages.

With a X.400 Input Gateway,allows to receive message from X.400 networks. Your trading partners can reach you to your hub private X.400 address.

To create an X.400 Gateway in, select an existing template or make a copy of the generic X.400 template in the catalogue and following screen will be displayed.

Figure 1.27. X.400 gateway in configuration

After channel deployment, your connection will be available to send messages.

The Scheduler in Gateway allows to create a message based on a time trigger.

To create a SchedulerIn gateway, make a copy of the SchedulerIn template available in the catalogue and the following screen will be displayed.

Figure 1.28. Scheduler in gateway configuration

If no values are provided, the scheduler will create an input message every 90 seconds. The input message will enter the channel and follow the processing steps as in any other channel

The message has the following structure:

<?xml version="1.0" encoding="UTF-8"?>
<simpleScheduler>
	<date>
		<time>1327871680013</time>
		<display>20120129-221440</display>
	</date>
	<gatewayIn>9999999</gatewayIn>
</simpleScheduler>

	

Where the time and display tags provide the current time and the gatewayIn tag provides the gateway Id

The following fields can be defined to customize your Scheduler:

To create another message than the default message, you can specify and upload an Xslt transformation. For instance, the following xslt will use the built-in XPath function used to search for message and message record to retrieve message records for every message since yesterday midnight:

<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="2.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
	xmlns:date-util="java:com.babelway.messaging.transformation.xslt.function.DateUtil"
	xmlns:enrich="java:com.babelway.messaging.transformation.xslt.function.Enrich"
	xmlns:xs="http://www.w3.org/2001/XMLSchema">
	<xsl:output method="xml" version="1.0" encoding="UTF-8" indent="yes" omit-xml-declaration="no"/>
		<xsl:template match="/">
			<xsl:variable name="start" select="date-util:formatDateLenient(concat(date-util:formatDateLenient(date-util:currentDate(), 'yyyy-MM-dd HH:mm:ss.SSS', 'yyyy', 'true'),number(date-util:formatDateLenient(date-util:currentDate(), 'yyyy-MM-dd HH:mm:ss.SSS', 'D', 'true'))-1), 'yyyyD', 'yyyy-MM-dd''T''HH:mm:ss', 'true')"/>
			<xsl:variable name="messages" select="enrich:searchMessage($start)"/>
			<xsl:copy-of select="$messages" />						
		</xsl:template>			
</xsl:stylesheet>

CSV Wizard screen allows you to define your csv message format according to your own file format.

A CSV or comma-separated values file is used for the digital storage of data organized in a table form. Each line in the CSV file corresponds to a row in the table, and within a line, fields are separated by commas (or semicolons, colons or tabs), each field belonging to one column of the source table.

As this is a very common and simple file format, CSV files are often used to move tabular data between different computer programs, such as between a database and a spreadsheet program.

To define a message in CSV format, select an existing template or make a copy of the generic CSV template in the catalogue and following screen will be displayed.

File sample

Following is a sample CSV file.

NAV Date,ISIN,Fund Name,Share Typ,Fund Ccy,NAV in Fund Ccy,Bid Price in Fund Ccy,Offer Price in Fund Ccy,TNA,Outstanding,Publication Ccy,NAV in Publication Ccy,Bid Price in Publication Ccy,Offer Price in Publication Ccy,Equity Profit,WKN Code,Zwischengewinn,TIS,TID
06/13/2008,LU0223208157,HSBC GIF EMERGING EUROPE EQUITY,AC,EUR,15.088,15.088,15.924,12190498.17,807980.236,GBP,11.96,11.96,12.623,37.650,A0ER9A,0.001,,

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.31. CSV Wizard screen

The following parameters must be set up:

Edit screen

Once this message format has been saved, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.32. CSV Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

EDIFACT Wizard screen allows you to define your EDIFACT message format according to your own file format.

United Nations / Electronic Data Interchange for Administration, Commerce and Transport (UN/EDIFACT) is the international EDI standard developed under the United Nations impulse. This standard is maintained and further developed by a UN body. EDIFACT has now been adopted by the International Organization for Standardization (ISO) as the ISO standard ISO 9735.

The EDIFACT standard provides a set of syntax rules to structure data, an interactive exchange protocol (I-EDI), and standard messages which allow multi-country and multi-industry exchange.

As Babelway supports all EDI transaction sets of the EDIFACT standard, you can use any of them in your own gateway setup.

To define a message in EDIFACT format, select an existing template or make a copy of the generic EDIFACT template in the catalogue and following screen will be displayed.

Babelway supports all following EDIFACT documents:

APERAK, AUTHOR, AVLREQ, AVLRSP, BALANC, BANSTA, BAPLIE, BERMAN, BMISRM, BOPBNK, BOPCUS, BOPDIR, BOPINF, BUSCRD, CALINF, CASINT, CASRES, CHACCO, CLASET, CNTCND, COACSU, COARRI, CODECO, CODENO, COEDOR, COHAOR, COLREQ, COMDIS, CONAPW, CONDPV, CONDRA, CONDRO, CONEST, CONITT, CONPVA, CONQVA, CONRPW, CONTEN, CONWQD, COPARN, COPAYM, COPINO, COPRAR, COREOR, COSTCO, COSTOR, CREADV, CREEXT, CREMUL, CUSCAR, CUSDEC, CUSEXP, CUSPED, CUSREP, CUSRES, DAPLOS, DEBADV, DEBMUL, DEBREC, DELFOR, DELJIT, DESADV, DESTIM, DGRECA, DIRDEB, DIRDEF, DMRDEF, DMSTAT, DOCADV, DOCAMA, DOCAMI, DOCAMR, DOCAPP, DOCARE, DOCINF, ENTREC, FINCAN, FINPAY, FINSTA, GENRAL, GESMES, HANMOV, ICASRP, ICSOLI, IFCSUM, IFTCCA, IFTDGN, IFTFCC, IFTICL, IFTMAN, IFTMBC, IFTMBF, IFTMBP, IFTMCA, IFTMCS, IFTMIN, IFTRIN, IFTSAI, IFTSTA, IFTSTQ, IHCEBI, IHCLME, IMPDEF, INFCON, INFENT, INSDES, INSPRE, INSREQ, INSRPT, INVOIC, INVRPT, IPPOAD, IPPOMO, ISENDS, ITRRPT, JAPRES, JINFDE, JOBAPP, JOBCON, JOBMOD, JOBOFF, JUPREQ, LEDGER, LREACT, LRECLM, MEDPID, MEDPRE, MEDREQ, MEDRPT, MEDRUC, MEQPOS, MOVINS, MSCONS, ORDCHG, ORDERS, ORDRSP, OSTENQ, OSTRPT, PARTIN, PASREQ, PASRSP, PAXLST, PAYDUC, PAYEXT, PAYMUL, PAYORD, PRICAT, PRIHIS, PROCST, PRODAT, PRODEX, PROINQ, PROSRV, PROTAP, PRPAID, QALITY, QUOTES, RDRMES, REBORD, RECADV, RECALC, RECECO, RECLAM, RECORD, REGENT, RELIST, REMADV, REPREM, REQDOC, REQOTE, RESETT, RESMSG, RESREQ, RESRSP, RETACC, RETANN, RETINS, RPCALL, SAFHAZ, SANCRT, SKDREQ, SKDUPD, SLSFCT, SLSRPT, SOCADE, SSIMOD, SSRECH, SSREGW, STATAC, STLRPT, SUPCOT, SUPMAN, SUPRES, TANSTA, TAXCON, TIQREQ, TIQRSP, TPFREP, TSDUPD, TUPREQ, TUPRSP, UTILMD, UTILTS, VATDEC, VESDEP, WASDIS, WKGRDC, WKGRRE

File sample

Following is a sample EDIFACT file.

UNA:+.? '
UNB+UNOC:3+000eanpimgest:14+000eanatelier:14+2009-05-26 10:41:34.524 +0200:2009-05-26 10:41:34.524 +0200+1518'
UNH+1+DESADV:D:01B:UN:EAN007'
BGM+351+0000090027+9'
DTM+137:200905190938:203'
DTM+17:200905150000:203'
DTM+2:200905150000:203'
DTM+171:20090519:102'
NAD+BY+000eanatelier::9++LATELIER+Chausse de Lige 477+JAMBES++5100+BE'
NAD+SU+000eanpimgest::9++PmiGest+Parc Scientifique Cralys+LES ISNES++5032+BE'
TDT+1++30'
CPS+1'
PAC+2+:52+201::9'
CPS+2+1'
PAC+1+:52+201::9'
MEA+PD+AAC+KGM:0'
MEA+PD+T+KGM:0'
PCI+33E'
GIN+BJ+p00001'
PCI+34E'
GIN+SRV+05400111005652'

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.33. EDIFACT Wizard screen

An EDIFACT messsage can only be set up using a sample file. Select your sample file using the Browse... button then click on the Upload command.

Edit screen

Once the message format sample has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.34. EDIFACT Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

X12 Wizard screen allows you to define your X12 message format according to your own file format.

ASC X12 (also known as ANSI ASC X12) is the official designation of the U.S. national standards body for the development and maintenance of Electronic Data Interchange (EDI) standards. ASC X12 has sponsored more than 315 X12-based EDI standards for health care, insurance, government, transportation, finance, and many other industries.

Babelway supports all EDI transaction sets. See the full list of X12 supported documents in the X12 Documents List appendix.

To define a message in X12 format, select an existing template or make a copy of the generic X12 template in the catalogue and following screen will be displayed.

Babelway supports all following X12 documents:

Order Series (ORD), Materials Handling Series (MAT), Tax Services Series (TAX), Warehousing Series (WAR), Financial Series (FIN), Government Series (GOV), Manufacturing Series (MAN), Delivery Series (DEL), Engineering Management and Contract Series (ENG), Insurance/Health Series (INS), Miscellaneous ANSI X12 Transactions Series (MIS), Mortgage Series (MOR), Product Services Series (PSS), Quality and Safety Series (QSS), Student Information Series (STU), Transportation (Air and Motor Series (TAM) - Ocean Series (TOS), Rail Series (TRS),Automotive Series (TAS)

File sample

Following is a sample X12 file.

ISA*00*          *00*          *ZZ*SENDERISA      *ZZ*RECEIVERISA    *960807*1548*U*00401*000000020*0*T*>~
GS*IN*SENDERDEPT*007326879*19960807*1548*000001*X*004010~
ST*810*000000001~
BIG*20090927*00027**A00027-01~
N1*ST*CHOCOLATE IMPORT*9*1234567890~
N3*1000 N. NORTH HIGHWAY~
N4*NEW YORK*NY*10310~
N1*BT*RETAILER INC.*9*1098765432~
N3*P.O. BOX 0000~
N4*LAKE*VA*20120~
N1*RE*FOODSELLER*9*12345QQQQ~
N3*P.O. BOX 222222~
N4*FAIRFAX*VA*94978~
ITD*01*3*1**15**16~
FOB*PP~
IT1**16*CA*12.34**UA*006540022222~
PID*F****BELGIUM CHOCOLATE~
IT1**13*CA*12.34**UA*006540033333~
PID*F****SWISS CHOCOLATE~
TDS*35786~
CAD*****FREEFORM~
ISS*29*CA~
CTT*2~
SE*22*000000001~
GE*1*000001~
IEA*1*000000020~

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.35. X12 Wizard screen

A X12 message can only be set up using a sample file. Select your sample file using the Browse... button then click on the Upload command.

Edit screen

Once the message format sample has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.36. X12 Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

XML Wizard screen allows you to define your XML message format according to your own file format.

To define a message in XML format, select an existing template or make a copy of the generic XML template in the catalogue and following screen will be displayed.

File sample

Following is a sample XML file.

<?xml version="1.0"?>
<Document>
<SenderID>5420008199981</SenderID>
<ReceiverID>5400102000086</ReceiverID>
<DocumentDate>20080531170538</DocumentDate>
<DocumentNumber>VK20084010</DocumentNumber>
<TestIndicator>P</TestIndicator>
<DocumentLanguage>NL</DocumentLanguage>
<Version>1.1/Food</Version>
<Invoice>
<MessageReferenceNumber>VK20084010</MessageReferenceNumber>
<InvoiceHeader>
<MessageType>INV</MessageType>
<MessageNumber>VK20084010</MessageNumber>
<MessageFunction>ORI</MessageFunction>
<InvoiceCurrency>EUR</InvoiceCurrency>
<Dates>
<InvoiceDate>20080531170538</InvoiceDate>
<AccountingValueDate>20080531170538</AccountingValueDate>
<DeliveryDate>20080530170738</DeliveryDate>
<OrderDate>20080530170538</OrderDate>
</Dates>
</InvoiceHeader>
<InvoiceDetail>
<InvoiceItem>
<ItemType>GDS</ItemType>
<LineItemNumber>1</LineItemNumber>
<EANArticleNumber>95400102057205</EANArticleNumber>
</InvoiceItem>
</InvoiceDetail>
</Invoice>
</Document>

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.37. XML Wizard screen

An XML messsage can be set up using an XSD or a sample XML file. When uploading an Xsd you will have the possibility to select the root element and to provide additionnal imported Xsd. If you upload a sample XML file, be sure to have the most exhaustive one, it will save you modification on the generated tree. After the upload, click the corresponding Save command.

Edit screen

Once the message format sample has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.38. XML Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

Excel Wizard screen allows you to define your Excel message format according to your own file format.

To define a message in Excel format, select an existing template or make a copy of the MS Excel template in the catalogue.

File sample

Following is a sample Excel file having headers at the first row of the Excel sheet.

Figure 1.39. Excel Sample file

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.40. Excel Wizard screen 1

After uploading the file sample, you should click 'Save' button to let the system build the corresponding message definition for your file sample.

Figure 1.41. Excel Wizard screen 2

Hint: If your file sample contains headers at the first row, so you should check the box "Contains header ?" at the end of the wizard.

Edit screen

Once this message format has been saved, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.42. Excel Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

Multirecord Wizard screen allows you to define your Multirecord message format (delimited or a fixed-length) according to your own file format.

What is mr file?

The mr file is a multirecord definition file which is used by the Self-Service MultiRecord wizard to generate the corresponding message definition and also to build the corresponding servingxml resource file.

How to build mr file?

For fixed-length messages, the mr file header will look like this:

<multirecord name="mymultirecord" type="fixed-length" lineDelimited="true" recordDelimiter="\r\n" quoteSymbol-character="&quot;" quoteSymbol-escapeSequence="\&quot;" xmlns="http://xmlns.babelway.com/2007/multi-record">

For the delimited messages the mr file header will look like this:

<multirecord name="mymultirecord" type="delimited" fieldDelimiter="," recordDelimiter="\r\n" quoteSymbol-character="&quot;" quoteSymbol-escapeSequence="\&quot;" xmlns="http://xmlns.babelway.com/2007/multi-record">

* recordDelimiter defines the delimiter between each record, it is usually the ending line character represented on windows by \r\n, on Unix/Linux by \n and on Macintosh by \r.

* lineDelimited specify if the system use a record delimiter. If set to false, record will be based on the sum of the fields lenght for fixed length or the number of fields for delimited multirecords.

* fieldDelimiter, only used whith a delimited message, defines the field delimiter.

* quoteSymbol-character is the character used to quote a field (often ")

* quoteSymbol-escapeSequence is the sequence that will display the quote symbol character in a quoted field (often \")

Hint:

For multirecord as message in, do not specify recordDelimiter. The system will catch the \r or \n or \r\n. For multirecord as message out, DO specify recordDelimiter as being for instance "\r\n"; this will generate windows compliant file and let you change the delimiter from the advanced properties later on.

You should specify the name for the record and for each of its field. Each record should have at least one field with a static value which will be used to identify the record.

<record name="Record1">
    <field name="recordType" value="R1" width="2"/>
    <field name="field1" width="5"/>
    <field name="field2" width="3"/>
</record>

* the width is only mandatory for fixed-length messages

* value is used to specify that the field has a static value that will never change

By default all first fields with a static value are used to identify a record. But, you can also manually defines which fields must be used to identify a record using the identifier paramter.

<record name="Record1">
    <field name="recordType" value="R1" width="2" />
    <field name="fieldA" width="5"/>
    <field name="fieldB" width="3" value="BBB" identifier="true"/>
    <field name="fieldC" width="7" />
    <field name="fieldD" width="2" value="DD" identifier="true"/>
</record>

In this case, only the third and fifth fields (fieldB & fieldD), with identifier equals to true, will be used to identify the record. The default (without identifier=true) would only use recordType field as the identifier.

Remark:

For fixed-length messages, the fields used to identify a record should have the same position and length in each record. No overlap between identifiers is allowed between records.

If a fixed-length message have variable length identifier per records, the only way to define it in the mr files is to first define the smallest common length identifier for all records and then for each records that have longer identifier, add as many as smaller field needed to unambiguously identify each record.

For example if we have a message where AAAAA, 111 and 2222 are identifier like in the following:

AAAAA contentcontent   anothercontent
1112222  this and that

The following definition is not valid since the fieldA is bigger than field1 and moreover, fieldA also overlaps with field2

<record name="Record1">
    <field name="fieldA" width="5" value="AAAAA" identifier="true"/>
    <field name="fieldB" width="15" />
    <field name="fieldC" width="17" />
</record>

<record name="Record2">
    <field name="field1" width="3" value="111" identifier="true"/>
    <field name="field2" width="4" value="2222" identifier="true"/>
    <field name="field3" width="20" />
</record>

It should be replaced by:

<record name="Record1">
    <field name="fieldA" width="3" value="AAA" identifier="true"/>
    <field name="fieldA" width="2" value="AA" identifier="true"/>
    <field name="fieldB" width="15" />
    <field name="fieldC" width="17" />
</record>
<record name="Record2">
     <field name="field1" width="3" value="111" identifier="true"/>
    <field name="field2" width="2" value="22" identifier="true"/>
    <field name="field2" width="2" value="22" identifier="true"/>
    <field name="field3" width="20" />
</record>

We had to split the fieldA in two in order to have one fieldA with the length 3 (the same as field1) with another fieldA with the remaining length 2.

Then the field2 (length 4) was also bigger than the second fieldA (length 2) so we also need to split it in two field2 of length 2.

All corresponding identifier have now the same length (3 and 2) and there is no overlap between them.

It is also possible to add 4 extra parameters label, description, justify & padCharacters to each field

<field name="myField" label="My Field" description="My field description" justify="right" padCharacter="x" width="10"/>

* label and description are used to display the message tree

* justify can be center, left or right

* padCharacter is the character used to fill empty space in the field width

 <xml>
    <group name="Transaction" maxOccurs="unbounded">
          <group name="headers">
             <record name="header" minOccurs="1" maxOccurs="unbounded"/>
          </group>
          <record name="record1" maxOccurs="unbounded"/>
          <group name="footers">
             <record name="footer" />
          </group>
     </group>
  </xml>

* Each element can define the minOccurs and the maxOccurs parameter with either a 0, a positive number or 'unbounded'.

* Records defined in the records section can only appear once in the message structure.

* Records can be grouped using the group element. The name of the group is mandatory.

* Records in a group should be ordered in the same way they appeared at the message.

Sample multirecord fixed-length message

HH00123  AB
HH00045 CDE
R1one  100
R1two  101
R1four 103
FF3

Sample multirecord definition file

<?xml version="1.0" encoding="UTF-8"?>
<multirecord name="mymultirecord" type="fixed-length" recordDelimiter="\r\n" quoteSymbol-character="&quot;" quoteSymbol-escapeSequence="\&quot;" xmlns="http://xmlns.babelway.com/2007/multi-record">
<records>
<record name="header">
<field name="recordType" value="HH" width="2"/>
<field name="header1" width="5" justify="right" padCharacter="0" />
<field name="header2" width="4" justify="right" padCharacter=" " />
</record>
<record name="record1">
   <field name="recordType" value="R1" width="2"/>
   <field name="field1" width="5" label="My field" description="My field Descritpion" />
   <field name="field2" width="3"/>
</record>
<record name="footer">
<field name="recordType" value="FF" width="2" />
<field name="footer1" width="1"/>
</record>
</records>
<xml>
       <group name="Transaction" maxOccurs="unbounded">
          <group name="headers">
             <record name="header" minOccurs="1" maxOccurs="unbounded"/>
          </group>
          <record name="record1" maxOccurs="unbounded"/>
          <group name="footers">
             <record name="footer" />
          </group>
       </group>
    </xml>
</multirecord>

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.43. Multirecord Wizard screen

A Multi Record messsage can only be set up using a sample file. Select your sample file using the Browse... button then click on the Upload command.

Edit screen

Once the message format sample has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.44. Multirecord Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

						XML Printer Wizard screen allows you to use any document printed using the virtual printer driver
						xmlprinter
						as message in.
					

The xmlprinter is a printer driver generating a xml file containing all the visual information of the document. The text elements are part of that document. So it is possible to "parse the document" to extract an other xml document, more usable in EDI exchanges. xmlprinter provides a tool called the composer to create such parsers definition.

Note that Babelway and xmlprinter are note affiliated. We do not provide any garantie on the xmlprinter but the tool has demonstrated to be very useful when no other extract method is easy to setup or when the output is a PDF enriched whith the data as attachment.

Getting started with xmlprinter

Add a parser step and send it to Babelway

    ;@echo off
    ;(for /f "usebackq delims=" %%A in ("%~f0") do call echo.%%A)>"%temp%\%~n0.ftp"
    ;ftp -i -s:"%temp%\%~n0.ftp"
    ;GOTO:EOF

    open ftp.babelway.net
    your_ftp_user
    your_ftp_password
    !:--- FTP commands below here ---
    cd /
    binary
    put %1
    disconnect
    bye

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.45. XML Printer Wizard screen

An XML Printer messsage is set up using the xml printer definition file (created with the composer) and a sample of the printed output in XML. For both files, select the files using the Browse... button next to the Xml Printer definition and Xml Printer sample output, then click on the Upload command.

Edit screen

Once the files have been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.46. XML Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

See Unwrapping an Incoming Message for more details on the options available to receive message in zip format containing both a PDF and the XML output.

Flat File Wizard screen allows you to define your Flat File message format according to your own file format.

To define a message in Flat File format, select an existing template or make a copy of the generic Flat File template in the catalogue and following screen will be displayed.

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.47. Flat File Wizard screen

A Flat File messsage can only be set up using sample files, either an ServingXml resource file and a XSD file or an XML file. Select your sample file(s) using the Edit... buttons next to the Serving XML, XSD and/or XML file, according to your sample file(s) format, then click on the Upload command(s) then click on Save.

Hint: If you will upload XML sample, you should first refine the sample by keeping only one occurrence of each XML element.

File sample

Following is a sample Flat file.

EE54001340000093012918100700000000000147521
DD0000018713906060109 6011                               3005330101
DD0000028713906061106 6111                               3005250201

This file has a number of properties.

ServingXml resources file

Shown below is the simplest possible resources script that will read this data and output it as XML.

<sx:resources xmlns:sx="http://www.servingxml.com/core">
<sx:service id="csvtoxml">
<sx:serializebuild.bat>
<sx:xsltSerializer>
<sx:outputProperty name="indent" value="yes"/>
</sx:xsltSerializer>
<sx:transform>
<sx:content ref="Sample"/>
</sx:transform>
</sx:serialize>
</sx:service>

<sx:recordContent id="Sample">
<sx:recordStream>
<sx:flatFileReader>
<!--<sx:urlSource url="data/Sample.txt"/>-->
<sx:flatFile ref="SampleFlatFile"/>
</sx:flatFileReader>
</sx:recordStream>
<sx:recordMapping ref="SampleToXmlMapping"/>
</sx:recordContent>

<sx:flatFile id="SampleFlatFile" quote="never">
<sx:flatFileBody>
<sx:flatRecordTypeChoice>
<sx:positionalField name="record_type" width="2"/>
<sx:when test="record_type='EE'">
<sx:flatRecordType name="envelope">
<sx:positionalField name="EEtag" width="2"/>
<sx:positionalField name="Sender" width="13"/>
<sx:positionalField name="Recip" width="13"/>
<sx:positionalField name="Iref" width="14"/>
<sx:positionalField name="Testind" width="1"/>
<sx:positionalField name="Splitref" width="35"/>
</sx:flatRecordType>
</sx:when>
<sx:when test="record_type='DD'">
<sx:flatRecordType name="details">
<sx:positionalField name="DDtag" width="2"/>
<sx:positionalField name="Linenr" width="6"/>
<sx:positionalField name="ArtEAN" width="14"/>
<sx:positionalField name="ArtSA" width="35"/>
<sx:positionalField name="ARTBP" width="35"/>
</sx:flatRecordType>
</sx:when>
</sx:flatRecordTypeChoice>
</sx:flatFileBody>
</sx:flatFile>

<sx:recordMapping id="SampleToXmlMapping">
<csv:csv xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:csv="http://xmlns.babelgom.com/2007/message-format/csv" 
xsi:schemaLocation="http://xmlns.babelgom.com/2007/message-format/csv csv.xsd">
<sx:onRecord recordType="envelope">
<csv:line>
<sx:fieldElementMap field="EEtag" element="csv:field"/>
<sx:fieldElementMap field="Sender" element="csv:field"/>
<sx:fieldElementMap field="Recip" element="csv:field"/>
<sx:fieldElementMap field="Iref" element="csv:field"/>
<sx:fieldElementMap field="Testind" element="csv:field"/>
<sx:fieldElementMap field="Splitref" element="csv:field"/>
</csv:line>
</sx:onRecord>
<sx:innerGroup startTest="sx:current/header">
<csv:order>
<sx:onRecord recordType="details">
<csv:line>
<sx:fieldElementMap field="DDtag" element="csv:field"/>
<sx:fieldElementMap field="Linenr" element="csv:field"/>
<sx:fieldElementMap field="ArtEAN" element="csv:field"/>
<sx:fieldElementMap field="ArtSA" element="csv:field"/>
<sx:fieldElementMap field="ARTBP" element="csv:field"/>
</csv:line>
</sx:onRecord>
</csv:order>
</sx:innerGroup>
</csv:csv>
</sx:recordMapping>
</sx:resources>
 

This resources script produces the following output.

<?xml version="1.0" encoding="UTF-8"?>
<csv:csv xmlns:csv="http://xmlns.babelgom.com/2007/message-format/csv"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.babelgom.com/2007/message-format/csv csv.xsd">
   <csv:line>
      <csv:field>EE</csv:field>
      <csv:field>5400134000009</csv:field>
      <csv:field>3012918100700</csv:field>
      <csv:field>00000000014319</csv:field>
      <csv:field>1</csv:field>
      <csv:field/>
   </csv:line>
   <csv:order>
      <csv:line>
         <csv:field>DD</csv:field>
         <csv:field>000001</csv:field>
         <csv:field>8713906060109</csv:field>
         <csv:field>6011</csv:field>
         <csv:field>3005330101</csv:field>
      </csv:line>
      <csv:line>
         <csv:field>DD</csv:field>
         <csv:field>000002</csv:field>
         <csv:field>8713906061106</csv:field>
         <csv:field>6111</csv:field>
         <csv:field>3005250201</csv:field>
      </csv:line>
   </csv:order>
</csv:csv>

For more information about ServingXML, please visit http://servingxml.sourceforge.net/

Edit screen

Once the message format sample has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.48. Flat File Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

Generic Wizard screen allows you to define your generic message format according to your own file format.

To define a message in Generic format, select an existing template or make a copy of the generic Generic template in the catalogue. Unlike other message formats, there is no wizard screen for generic format.

Edit screen

Once the generic message format has been selected, edit screen appears as follows.

Figure 1.49. Customer Edit screen

This format should be used with your own message parser or converter written in Java code when no adequate format converter is available. Select this converter using ConverterClass property available under Advanced Properties.

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

Not Defined message format is used when in and out message format does not need to be defined because no processing will be performed on it and no change is required.

To define a message in Not defined format, select an existing template or make a copy of the generic Not defined template in the catalogue. There is no setting parameter for this message format.

TRADACOM Wizard screen allows you to define your TRADACOM message format according to your own file format.

Tradacoms is an early standard for EDI (Electronic Data Interchange) primarily used in the UK retail sector. It was introduced in 1982 as an implementation of the UN/GTDI syntax, one of the precursors of EDIFACT, and was maintained and extended by the UK Article Numbering Association (now called GS1 UK).

As Babelway supports all TRADACOM transaction sets of the TRADACOM standard, you can use any of them in your own gateway setup.

To define a message in TRADACOM format, select an existing template or make a copy of the generic TRADACOM template in the catalogue and following screen will be displayed.

Babelway supports all following TRADACOM documents:

1.ACKHDR,ACKMNT,ACKTLR,AVLDET,AVLHDR,AVLTLR,CORDER,CORHDR,CORTLR,CRAHDR,CRAINF,CRATLR,CREDIT,CREHDR,CRETLR,CUSHDR,CUSINF,CUSTLR,DELHDR,DELIVR,DELTLR,DLCDET,DLCHDR,DLCTLR,DRAHDR,DRAINF,DRATLR,EXCHDR,EXCINF,EXCTLR,GENHDR,GENRAL,GENTLR,INVFIL,INVOIC,INVTLR,LPRDET,LPRHDR,LPRTLR,ORDERS,ORDHDR,ORDTLR,PAYHDR,PAYINF,PAYTLR,PICHDR,PICKER,PICTLR,PPRDET,PPRHDR,PPRTLR,PRIHDR,PRIINF,PRITLR,PROHDR,PROINF,PROINF,PROTLR,RSGRSG,SADDET,SADHDR,SADTLR,SNPHDR,SNPHDR,SNPSTS,SNPTLR,SRMHDR,SRMINF,SRMTLR,UCNDET,UCNHDR,UCNTLR,UCNTLR,UPLHDR,UPLIFT,UPLTLR,UTLBIL,UTLHDR,UTLTLR,UVATLR,VATTLR

File sample

Following is a sample TRADACOM invoice file.

STX=ANAA:1+501xxxxxxxxxx:name+501xxxxxxxxxx:NAME SERVICES (U.K.)LTD.+040316:184411+00001++INVTES'
MHD=1+INVFIL:9'
TYP=0700+INVOICES'
SDT=501xxxxxxxxxx:053752CF01STDD+Tenprl Fnsrjnl Sbbqfreivpr+221 UvyyunyyRoad:Yvfohea:Co. Antrim:N.Ireland:OG27 5WQ+412557175'
CDT=501xxxxxxxxx+NAMESERVICES (U.K.) LTD.+Cnexynaqf Pbheg:OvezvatunzTerng Cnex:Ehorel:Birmingham:OG45 9CM'
FIL=1+1+040316'
FDT=040302+040302'
MTR=7'
MHD=2+INVOIC:9'
CLO=0000000100007: ++PNEEVPX GOLF CLUB:ABEGU ROAD:PNEEVPX SRETHF::OG388YC'
IRF=01000589M+040302+040302'
ODD=1+::040302+:040302'
ILD=1+1+:8408++:31266+0+2:2500:KG+54300+135800+Z+0+++SILVERSIDE 1-5 KG'
STL=1+Z+0+0+1358+++++1358++0+0++1358'
TLR=1+1358+++++1358++1358+0++1358'
MTR=8'
MHD=3+VATTLR:9'
VRS=1+Z+0+1358+1358+0+1358+1358'
MTR=3'
MHD=4+INVTLR:9'
TOT=1358+1358+0+1358+1358+1'
MTR=3'
MHD=5+RSGRSG:2'
RSG=00001+501xxxxxxxxxx'
MTR=3'
END=5'

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.50. TRADACOM Wizard screen

An TRADACOM messsage can only be set up using a sample file. Select your sample file using the Browse... button then click on the Upload command.

Edit screen

Once the message format sample has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.51. TRADACOM Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

Drag and Drop transformation visual editor enables to easily define transformation rules and implement transformation functions.

When specifying transformation for the first time or when changing transformation type, click on Open catalogue command and choose a drag and drop transformation from catalogue. Please refer to The Catalogue chapter for more informations about catalogue use and commands.

If you create a copy from a Babelway template you must name this copy before accessing the visual editor screen.

Figure 1.53. Drag and drop transformation visual editor

This transformation visual editor is divided in three panes:

Nodes mapping

To map an incoming message node to an outgoing message node, you only need to click on incoming message node in left pane then to drag it to right pane and drop it on outgoing message node as illustrated by arrow (1) in following figure.

As illustrated by arrow (2), the icon of nodes that are already linked displays a little chain mark.

Figure 1.54. Drag and drop mapping example

All defined mapping are listed in Transformation rules table, one per table line, with following fields:

Multi nodes mapping

Visual mapping is able to map two message definition tree structures. When mapping an element having children to another element having similar children structure, the system will offer you to automatically map children and loops based on their names or uid similarities. This is a very valuable when dealing with complex and often similar XML messages like in soap messages, IDOC or UBL...

Figure 1.55. Multi mapping confirmation box

Transformation functions

In addition to direct mapping, you can add one or more transformation rules. Right-click on Transformation functions in message in left pane. See Message Transformation Functions for a complete list of available functions and how to use them.

In following example, a multiply operator is selected as transformation function.

Figure 1.56. Transformation rule selection example

Once desired function is selected and named, it appears in transformation functions list in message in pane. This specific function, multiply, requires two nodes as arguments. Once again drag and drop both selected nodes on this function as illustrated in next figure with arrows (1) and (2).

Mapped nodes are listed under transformation function and may be removed by right-clicking and selecting Remove command.

Figure 1.57. Transformation rule mapping example

Once the transformation function is defined it can be in turn, mapped to a message out node. See arrow (3) on previous illustration.

Transformation functions may also be cascaded using the same drag and drop mapping. A transformation may be used as argument for another one as illustrated below with a second multiply operation that takes previous result as argument.

Figure 1.58. Transformation rule mapping example

Once all your mapping and transformations are ready and additional filter, if and/or format entered, do not forget to save this transformation with Save button.

Advance properties

Optionally you can set some advanced properties like

Xslt transformation test editor enables to define transformation rules and implement transformation functions directly in Xslt language.

When specifying transformation for the first time or when changing transformation type, click on Open catalogue command and choose an Xslt transformation from catalogue. Please refer to The Catalogue chapter for more informations about catalogue use and commands.

If you create a copy from a Babelway template you must name this copy before accessing the text editor screen.

Xslt mapping and transformation rules can be entered directly using integrated Xslt editor as illustrated hereunder.

Figure 1.59. Xslt transformation editor

Once all your mapping and transformations are ready and additional filter, if and/or format entered, do not forget to save this transformation with Save button.

The No transformation option is used when Babelway interface is used to transfer an unchanged message from one gateway to another.

If you are only transfering messages that do not require transformation from one gateway to another one, for example from a mail server to an FTP serve, you should use the "No transformation" transformation.

When specifying this transformation for the first time or when changing transformation type, click on Open catalogue command and choose an No transformation transformation from catalogue. Please refer to The Catalogue chapter for more informations about catalogue use and commands.

CSV Wizard screen allows you to define your csv message format according to your own file format.

A CSV or comma-separated values file is used for the digital storage of data organized in a table form. Each line in the CSV file corresponds to a row in the table, and within a line, fields are separated by commas (or semicolons, colons or tabs), each field belonging to one column of the source table.

As this is a very common and simple file format, CSV files are often used to move tabular data between different computer programs, such as between a database and a spreadsheet program.

To define a message in CSV format, select an existing template or make a copy of the generic CSV template in the catalogue and following screen will be displayed.

File sample

Following is a sample CSV file.

NAV Date,ISIN,Fund Name,Share Typ,Fund Ccy,NAV in Fund Ccy,Bid Price in Fund Ccy,Offer Price in Fund Ccy,TNA,Outstanding,Publication Ccy,NAV in Publication Ccy,Bid Price in Publication Ccy,Offer Price in Publication Ccy,Equity Profit,WKN Code,Zwischengewinn,TIS,TID
06/13/2008,LU0223208157,HSBC GIF EMERGING EUROPE EQUITY,AC,EUR,15.088,15.088,15.924,12190498.17,807980.236,GBP,11.96,11.96,12.623,37.650,A0ER9A,0.001,,

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.62. CSV Wizard screen

The following parameters must be set up:

Edit screen

Once this message format has been saved, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.63. CSV Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

EDIFACT Wizard screen allows you to define your EDIFACT message format according to your own file format.

United Nations / Electronic Data Interchange for Administration, Commerce and Transport (UN/EDIFACT) is the international EDI standard developed under the United Nations impulse. This standard is maintained and further developed by a UN body. EDIFACT has now been adopted by the International Organization for Standardization (ISO) as the ISO standard ISO 9735.

The EDIFACT standard provides a set of syntax rules to structure data, an interactive exchange protocol (I-EDI), and standard messages which allow multi-country and multi-industry exchange.

As Babelway supports all EDI transaction sets of the EDIFACT standard, you can use any of them in your own gateway setup.

To define a message in EDIFACT format, select an existing template or make a copy of the generic EDIFACT template in the catalogue and following screen will be displayed.

Babelway supports all following EDIFACT documents:

APERAK, AUTHOR, AVLREQ, AVLRSP, BALANC, BANSTA, BAPLIE, BERMAN, BMISRM, BOPBNK, BOPCUS, BOPDIR, BOPINF, BUSCRD, CALINF, CASINT, CASRES, CHACCO, CLASET, CNTCND, COACSU, COARRI, CODECO, CODENO, COEDOR, COHAOR, COLREQ, COMDIS, CONAPW, CONDPV, CONDRA, CONDRO, CONEST, CONITT, CONPVA, CONQVA, CONRPW, CONTEN, CONWQD, COPARN, COPAYM, COPINO, COPRAR, COREOR, COSTCO, COSTOR, CREADV, CREEXT, CREMUL, CUSCAR, CUSDEC, CUSEXP, CUSPED, CUSREP, CUSRES, DAPLOS, DEBADV, DEBMUL, DEBREC, DELFOR, DELJIT, DESADV, DESTIM, DGRECA, DIRDEB, DIRDEF, DMRDEF, DMSTAT, DOCADV, DOCAMA, DOCAMI, DOCAMR, DOCAPP, DOCARE, DOCINF, ENTREC, FINCAN, FINPAY, FINSTA, GENRAL, GESMES, HANMOV, ICASRP, ICSOLI, IFCSUM, IFTCCA, IFTDGN, IFTFCC, IFTICL, IFTMAN, IFTMBC, IFTMBF, IFTMBP, IFTMCA, IFTMCS, IFTMIN, IFTRIN, IFTSAI, IFTSTA, IFTSTQ, IHCEBI, IHCLME, IMPDEF, INFCON, INFENT, INSDES, INSPRE, INSREQ, INSRPT, INVOIC, INVRPT, IPPOAD, IPPOMO, ISENDS, ITRRPT, JAPRES, JINFDE, JOBAPP, JOBCON, JOBMOD, JOBOFF, JUPREQ, LEDGER, LREACT, LRECLM, MEDPID, MEDPRE, MEDREQ, MEDRPT, MEDRUC, MEQPOS, MOVINS, MSCONS, ORDCHG, ORDERS, ORDRSP, OSTENQ, OSTRPT, PARTIN, PASREQ, PASRSP, PAXLST, PAYDUC, PAYEXT, PAYMUL, PAYORD, PRICAT, PRIHIS, PROCST, PRODAT, PRODEX, PROINQ, PROSRV, PROTAP, PRPAID, QALITY, QUOTES, RDRMES, REBORD, RECADV, RECALC, RECECO, RECLAM, RECORD, REGENT, RELIST, REMADV, REPREM, REQDOC, REQOTE, RESETT, RESMSG, RESREQ, RESRSP, RETACC, RETANN, RETINS, RPCALL, SAFHAZ, SANCRT, SKDREQ, SKDUPD, SLSFCT, SLSRPT, SOCADE, SSIMOD, SSRECH, SSREGW, STATAC, STLRPT, SUPCOT, SUPMAN, SUPRES, TANSTA, TAXCON, TIQREQ, TIQRSP, TPFREP, TSDUPD, TUPREQ, TUPRSP, UTILMD, UTILTS, VATDEC, VESDEP, WASDIS, WKGRDC, WKGRRE

File sample

Following is a sample EDIFACT file.

UNA:+.? '
UNB+UNOC:3+000eanpimgest:14+000eanatelier:14+2009-05-26 10:41:34.524 +0200:2009-05-26 10:41:34.524 +0200+1518'
UNH+1+DESADV:D:01B:UN:EAN007'
BGM+351+0000090027+9'
DTM+137:200905190938:203'
DTM+17:200905150000:203'
DTM+2:200905150000:203'
DTM+171:20090519:102'
NAD+BY+000eanatelier::9++LATELIER+Chausse de Lige 477+JAMBES++5100+BE'
NAD+SU+000eanpimgest::9++PmiGest+Parc Scientifique Cralys+LES ISNES++5032+BE'
TDT+1++30'
CPS+1'
PAC+2+:52+201::9'
CPS+2+1'
PAC+1+:52+201::9'
MEA+PD+AAC+KGM:0'
MEA+PD+T+KGM:0'
PCI+33E'
GIN+BJ+p00001'
PCI+34E'
GIN+SRV+05400111005652'

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.64. EDIFACT Wizard screen

An EDIFACT messsage can only be set up using a sample file. Select your sample file using the Browse... button then click on the Upload command.

Edit screen

Once the message format sample has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.65. EDIFACT Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

X12 Wizard screen allows you to define your X12 message format according to your own file format.

ASC X12 (also known as ANSI ASC X12) is the official designation of the U.S. national standards body for the development and maintenance of Electronic Data Interchange (EDI) standards. ASC X12 has sponsored more than 315 X12-based EDI standards for health care, insurance, government, transportation, finance, and many other industries.

Babelway supports all EDI transaction sets. See the full list of X12 supported documents in the X12 Documents List appendix.

To define a message in X12 format, select an existing template or make a copy of the generic X12 template in the catalogue and following screen will be displayed.

Babelway supports all following X12 documents:

Order Series (ORD), Materials Handling Series (MAT), Tax Services Series (TAX), Warehousing Series (WAR), Financial Series (FIN), Government Series (GOV), Manufacturing Series (MAN), Delivery Series (DEL), Engineering Management and Contract Series (ENG), Insurance/Health Series (INS), Miscellaneous ANSI X12 Transactions Series (MIS), Mortgage Series (MOR), Product Services Series (PSS), Quality and Safety Series (QSS), Student Information Series (STU), Transportation (Air and Motor Series (TAM) - Ocean Series (TOS), Rail Series (TRS),Automotive Series (TAS)

File sample

Following is a sample X12 file.

ISA*00*          *00*          *ZZ*SENDERISA      *ZZ*RECEIVERISA    *960807*1548*U*00401*000000020*0*T*>~
GS*IN*SENDERDEPT*007326879*19960807*1548*000001*X*004010~
ST*810*000000001~
BIG*20090927*00027**A00027-01~
N1*ST*CHOCOLATE IMPORT*9*1234567890~
N3*1000 N. NORTH HIGHWAY~
N4*NEW YORK*NY*10310~
N1*BT*RETAILER INC.*9*1098765432~
N3*P.O. BOX 0000~
N4*LAKE*VA*20120~
N1*RE*FOODSELLER*9*12345QQQQ~
N3*P.O. BOX 222222~
N4*FAIRFAX*VA*94978~
ITD*01*3*1**15**16~
FOB*PP~
IT1**16*CA*12.34**UA*006540022222~
PID*F****BELGIUM CHOCOLATE~
IT1**13*CA*12.34**UA*006540033333~
PID*F****SWISS CHOCOLATE~
TDS*35786~
CAD*****FREEFORM~
ISS*29*CA~
CTT*2~
SE*22*000000001~
GE*1*000001~
IEA*1*000000020~

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.66. X12 Wizard screen

A X12 message can only be set up using a sample file. Select your sample file using the Browse... button then click on the Upload command.

Edit screen

Once the message format sample has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.67. X12 Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

XML Wizard screen allows you to define your XML message format according to your own file format.

To define a message in XML format, select an existing template or make a copy of the generic XML template in the catalogue and following screen will be displayed.

File sample

Following is a sample XML file.

<?xml version="1.0"?>
<Document>
<SenderID>5420008199981</SenderID>
<ReceiverID>5400102000086</ReceiverID>
<DocumentDate>20080531170538</DocumentDate>
<DocumentNumber>VK20084010</DocumentNumber>
<TestIndicator>P</TestIndicator>
<DocumentLanguage>NL</DocumentLanguage>
<Version>1.1/Food</Version>
<Invoice>
<MessageReferenceNumber>VK20084010</MessageReferenceNumber>
<InvoiceHeader>
<MessageType>INV</MessageType>
<MessageNumber>VK20084010</MessageNumber>
<MessageFunction>ORI</MessageFunction>
<InvoiceCurrency>EUR</InvoiceCurrency>
<Dates>
<InvoiceDate>20080531170538</InvoiceDate>
<AccountingValueDate>20080531170538</AccountingValueDate>
<DeliveryDate>20080530170738</DeliveryDate>
<OrderDate>20080530170538</OrderDate>
</Dates>
</InvoiceHeader>
<InvoiceDetail>
<InvoiceItem>
<ItemType>GDS</ItemType>
<LineItemNumber>1</LineItemNumber>
<EANArticleNumber>95400102057205</EANArticleNumber>
</InvoiceItem>
</InvoiceDetail>
</Invoice>
</Document>

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.68. XML Wizard screen

An XML messsage can be set up using an XSD or a sample XML file. When uploading an Xsd you will have the possibility to select the root element and to provide additionnal imported Xsd. If you upload a sample XML file, be sure to have the most exhaustive one, it will save you modification on the generated tree. After the upload, click the corresponding Save command.

Edit screen

Once the message format sample has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.69. XML Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

Excel Wizard screen allows you to define your Excel message format according to your own file format.

To define a message in Excel format, select an existing template or make a copy of the MS Excel template in the catalogue.

File sample

Following is a sample Excel file having headers at the first row of the Excel sheet.

Figure 1.70. Excel Sample file

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.71. Excel Wizard screen 1

After uploading the file sample, you should click 'Save' button to let the system build the corresponding message definition for your file sample.

Figure 1.72. Excel Wizard screen 2

Hint: If your file sample contains headers at the first row, so you should check the box "Contains header ?" at the end of the wizard.

Edit screen

Once this message format has been saved, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.73. Excel Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

PDF Wizard screen allows you to define your PDF message format based on your XHTML template file.

To define a message in PDF format, select an existing template or make a copy of the generic PDF template in the catalogue and following screen will be displayed.

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.74. PDF Wizard screen

An PDF messsage can only be set up using a template file in XHTML format. Select your template file using the Browse... button next to the XHTML file, then click on the Upload command.

File sample

Following is a sample PDF file.

		
<?xml version="1.0" encoding="UTF-8"?>
<html xmlns="http://www.w3.org/1999/xhtml">
   <head>
      <title>PDF output</title>
      <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
     
<style>
 @page { size: A4; margin: 3cm 1.5cm 2cm 1.5cm; border: none; padding: 1em; }
 @page { @top-left{content: ""; }}
 @page { @top-right{content: "Page " counter(page) " on " counter(pages);}}
 @page { @bottom-left{content: element(footer);border-top: solid 0.01mm #000; }}

 #footer{display: block; position: running(footer); }
</style>
	 
   </head>
   <body style="font-size: 12pt; font-family: 'Nobile'"> 

      <center>
         <h1 >PDF output example</h1>
      </center>
      <br/>
      <div style="font-size: small">
         <span>Date :</span>
         <span>25-08-2009</span>
      </div>
      <br/>
      <center style="font-size: large">Example</center>
      <br/>
      <table style="width: 100%" >
         <tr>
            <td rowspan="1" style="width: 200px; height: 20px;">
               <span>Invoice number :</span>
               <span>field1</span>
            </td>
            <td style="width: 300px; height: 20px;">
               <span>Contact Name :</span>
               <span>field2</span>
               <span>field3</span>
            </td>
         </tr>
      </table>
      <br/>
      <center>
         <span>Some static info</span>
      </center>
      <center style="page-break-before:always">
         <span>second page</span>
      </center> 
      <br/>
      You can upload images or css sheets as file properties and use a simple relative url in your xhtml.
      <br/>  
      <br/>    
      For specific print css options, see http://www.w3schools.com/css/css_reference.asp for all css options 
      <br/>  
      <br/>  	  
      <h2>Barcode Integration</h2>
        <br/> 
        <barcode style="display: inline-block; width: 300px; height: 200px;" type="EAN13">123456789012345675</barcode>
        <br/>
        <barcode style="display: inline-block; width: 300px; height: 200px;" type="EAN8">123456789012345675</barcode>
        <br/>
        <barcode style="display: inline-block; width: 300px; height: 200px;" type="UPCA">123456789012345675</barcode>
        <br/>
        <barcode style="display: inline-block; width: 300px; height: 200px;" type="UPCE">01234133</barcode>
        <br/>
        <barcode style="display: inline-block; width: 300px; height: 200px;" type="CODABAR">A123456789A</barcode>
        <br/>
        <barcode style="display: inline-block; width: 300px; height: 200px;" type="CODE39">123456789012345675</barcode>
        <br/>
        <barcode style="display: inline-block; width: 300px; height: 200px;" type="CODE39_EXTENDED">123456789012345675</barcode>
        <br/>
        <barcode style="display: inline-block; width: 300px; height: 200px;" type="CODE128">123456789012345675</barcode>
        <br/>
        <barcode style="display: inline-block; width: 300px; height: 200px;" type="CODE128_UCC">123456789012345675</barcode>
        <br/>
        <barcode style="display: inline-block; width: 300px; height: 200px;" type="CODE128_RAW">123456789012345675</barcode>
        <br/>
        <barcode style="display: inline-block; width: 300px; height: 200px;" type="EAN8">123456789012345675</barcode>
        <br/>
        <barcode style="display: inline-block; width: 300px; height: 200px;" type="POSTNET">123456789012345675</barcode>
        <br/>
	  <div id="footer">
		Footer line#1<br/>Footer line#2
	  </div>

   </body>
</html>		
		
		

Edit screen

Once the message format template has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.75. PDF Edit screen

All elements of the resulting message definition will be hidden by default. You should show any element you need in the transformation step.

To ease the search of the fields you need, the values uploaded from your example file are displayed in the field tooltip descriptions.

Additionaly, you should edit and rename the element label for easier management during transformation step.

See Message Definition to change show/hide parameter and edit the element label.

See Signing an Outgoing Message for more details on the options available to control PDF signature and display options.

Multirecord Wizard screen allows you to define your Multirecord message format (delimited or a fixed-length) according to your own file format.

What is mr file?

The mr file is a multirecord definition file which is used by the Self-Service MultiRecord wizard to generate the corresponding message definition and also to build the corresponding servingxml resource file.

How to build mr file?

For fixed-length messages, the mr file header will look like this:

<multirecord name="mymultirecord" type="fixed-length" lineDelimited="true" recordDelimiter="\r\n" quoteSymbol-character="&quot;" quoteSymbol-escapeSequence="\&quot;" xmlns="http://xmlns.babelway.com/2007/multi-record">

For the delimited messages the mr file header will look like this:

<multirecord name="mymultirecord" type="delimited" fieldDelimiter="," recordDelimiter="\r\n" quoteSymbol-character="&quot;" quoteSymbol-escapeSequence="\&quot;" xmlns="http://xmlns.babelway.com/2007/multi-record">

* recordDelimiter defines the delimiter between each record, it is usually the ending line character represented on windows by \r\n, on Unix/Linux by \n and on Macintosh by \r.

* lineDelimited specify if the system use a record delimiter. If set to false, record will be based on the sum of the fields lenght for fixed length or the number of fields for delimited multirecords.

* fieldDelimiter, only used whith a delimited message, defines the field delimiter.

* quoteSymbol-character is the character used to quote a field (often ")

* quoteSymbol-escapeSequence is the sequence that will display the quote symbol character in a quoted field (often \")

Hint:

For multirecord as message in, do not specify recordDelimiter. The system will catch the \r or \n or \r\n. For multirecord as message out, DO specify recordDelimiter as being for instance "\r\n"; this will generate windows compliant file and let you change the delimiter from the advanced properties later on.

You should specify the name for the record and for each of its field. Each record should have at least one field with a static value which will be used to identify the record.

<record name="Record1">
    <field name="recordType" value="R1" width="2"/>
    <field name="field1" width="5"/>
    <field name="field2" width="3"/>
</record>

* the width is only mandatory for fixed-length messages

* value is used to specify that the field has a static value that will never change

By default all first fields with a static value are used to identify a record. But, you can also manually defines which fields must be used to identify a record using the identifier paramter.

<record name="Record1">
    <field name="recordType" value="R1" width="2" />
    <field name="fieldA" width="5"/>
    <field name="fieldB" width="3" value="BBB" identifier="true"/>
    <field name="fieldC" width="7" />
    <field name="fieldD" width="2" value="DD" identifier="true"/>
</record>

In this case, only the third and fifth fields (fieldB & fieldD), with identifier equals to true, will be used to identify the record. The default (without identifier=true) would only use recordType field as the identifier.

Remark:

For fixed-length messages, the fields used to identify a record should have the same position and length in each record. No overlap between identifiers is allowed between records.

If a fixed-length message have variable length identifier per records, the only way to define it in the mr files is to first define the smallest common length identifier for all records and then for each records that have longer identifier, add as many as smaller field needed to unambiguously identify each record.

For example if we have a message where AAAAA, 111 and 2222 are identifier like in the following:

AAAAA contentcontent   anothercontent
1112222  this and that

The following definition is not valid since the fieldA is bigger than field1 and moreover, fieldA also overlaps with field2

<record name="Record1">
    <field name="fieldA" width="5" value="AAAAA" identifier="true"/>
    <field name="fieldB" width="15" />
    <field name="fieldC" width="17" />
</record>

<record name="Record2">
    <field name="field1" width="3" value="111" identifier="true"/>
    <field name="field2" width="4" value="2222" identifier="true"/>
    <field name="field3" width="20" />
</record>

It should be replaced by:

<record name="Record1">
    <field name="fieldA" width="3" value="AAA" identifier="true"/>
    <field name="fieldA" width="2" value="AA" identifier="true"/>
    <field name="fieldB" width="15" />
    <field name="fieldC" width="17" />
</record>
<record name="Record2">
     <field name="field1" width="3" value="111" identifier="true"/>
    <field name="field2" width="2" value="22" identifier="true"/>
    <field name="field2" width="2" value="22" identifier="true"/>
    <field name="field3" width="20" />
</record>

We had to split the fieldA in two in order to have one fieldA with the length 3 (the same as field1) with another fieldA with the remaining length 2.

Then the field2 (length 4) was also bigger than the second fieldA (length 2) so we also need to split it in two field2 of length 2.

All corresponding identifier have now the same length (3 and 2) and there is no overlap between them.

It is also possible to add 4 extra parameters label, description, justify & padCharacters to each field

<field name="myField" label="My Field" description="My field description" justify="right" padCharacter="x" width="10"/>

* label and description are used to display the message tree

* justify can be center, left or right

* padCharacter is the character used to fill empty space in the field width

 <xml>
    <group name="Transaction" maxOccurs="unbounded">
          <group name="headers">
             <record name="header" minOccurs="1" maxOccurs="unbounded"/>
          </group>
          <record name="record1" maxOccurs="unbounded"/>
          <group name="footers">
             <record name="footer" />
          </group>
     </group>
  </xml>

* Each element can define the minOccurs and the maxOccurs parameter with either a 0, a positive number or 'unbounded'.

* Records defined in the records section can only appear once in the message structure.

* Records can be grouped using the group element. The name of the group is mandatory.

* Records in a group should be ordered in the same way they appeared at the message.

Sample multirecord fixed-length message

HH00123  AB
HH00045 CDE
R1one  100
R1two  101
R1four 103
FF3

Sample multirecord definition file

<?xml version="1.0" encoding="UTF-8"?>
<multirecord name="mymultirecord" type="fixed-length" recordDelimiter="\r\n" quoteSymbol-character="&quot;" quoteSymbol-escapeSequence="\&quot;" xmlns="http://xmlns.babelway.com/2007/multi-record">
<records>
<record name="header">
<field name="recordType" value="HH" width="2"/>
<field name="header1" width="5" justify="right" padCharacter="0" />
<field name="header2" width="4" justify="right" padCharacter=" " />
</record>
<record name="record1">
   <field name="recordType" value="R1" width="2"/>
   <field name="field1" width="5" label="My field" description="My field Descritpion" />
   <field name="field2" width="3"/>
</record>
<record name="footer">
<field name="recordType" value="FF" width="2" />
<field name="footer1" width="1"/>
</record>
</records>
<xml>
       <group name="Transaction" maxOccurs="unbounded">
          <group name="headers">
             <record name="header" minOccurs="1" maxOccurs="unbounded"/>
          </group>
          <record name="record1" maxOccurs="unbounded"/>
          <group name="footers">
             <record name="footer" />
          </group>
       </group>
    </xml>
</multirecord>

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.76. Multirecord Wizard screen

A Multi Record messsage can only be set up using a sample file. Select your sample file using the Browse... button then click on the Upload command.

Edit screen

Once the message format sample has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.77. Multirecord Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

Flat File Wizard screen allows you to define your Flat File message format according to your own file format.

To define a message in Flat File format, select an existing template or make a copy of the generic Flat File template in the catalogue and following screen will be displayed.

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.78. Flat File Wizard screen

A Flat File messsage can only be set up using sample files, either an ServingXml resource file and a XSD file or an XML file. Select your sample file(s) using the Edit... buttons next to the Serving XML, XSD and/or XML file, according to your sample file(s) format, then click on the Upload command(s) then click on Save.

Hint: If you will upload XML sample, you should first refine the sample by keeping only one occurrence of each XML element.

File sample

Following is a sample Flat file.

EE54001340000093012918100700000000000147521
DD0000018713906060109 6011                               3005330101
DD0000028713906061106 6111                               3005250201

This file has a number of properties.

ServingXml resources file

Shown below is the simplest possible resources script that will read this data and output it as XML.

<sx:resources xmlns:sx="http://www.servingxml.com/core">
<sx:service id="csvtoxml">
<sx:serializebuild.bat>
<sx:xsltSerializer>
<sx:outputProperty name="indent" value="yes"/>
</sx:xsltSerializer>
<sx:transform>
<sx:content ref="Sample"/>
</sx:transform>
</sx:serialize>
</sx:service>

<sx:recordContent id="Sample">
<sx:recordStream>
<sx:flatFileReader>
<!--<sx:urlSource url="data/Sample.txt"/>-->
<sx:flatFile ref="SampleFlatFile"/>
</sx:flatFileReader>
</sx:recordStream>
<sx:recordMapping ref="SampleToXmlMapping"/>
</sx:recordContent>

<sx:flatFile id="SampleFlatFile" quote="never">
<sx:flatFileBody>
<sx:flatRecordTypeChoice>
<sx:positionalField name="record_type" width="2"/>
<sx:when test="record_type='EE'">
<sx:flatRecordType name="envelope">
<sx:positionalField name="EEtag" width="2"/>
<sx:positionalField name="Sender" width="13"/>
<sx:positionalField name="Recip" width="13"/>
<sx:positionalField name="Iref" width="14"/>
<sx:positionalField name="Testind" width="1"/>
<sx:positionalField name="Splitref" width="35"/>
</sx:flatRecordType>
</sx:when>
<sx:when test="record_type='DD'">
<sx:flatRecordType name="details">
<sx:positionalField name="DDtag" width="2"/>
<sx:positionalField name="Linenr" width="6"/>
<sx:positionalField name="ArtEAN" width="14"/>
<sx:positionalField name="ArtSA" width="35"/>
<sx:positionalField name="ARTBP" width="35"/>
</sx:flatRecordType>
</sx:when>
</sx:flatRecordTypeChoice>
</sx:flatFileBody>
</sx:flatFile>

<sx:recordMapping id="SampleToXmlMapping">
<csv:csv xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:csv="http://xmlns.babelgom.com/2007/message-format/csv" 
xsi:schemaLocation="http://xmlns.babelgom.com/2007/message-format/csv csv.xsd">
<sx:onRecord recordType="envelope">
<csv:line>
<sx:fieldElementMap field="EEtag" element="csv:field"/>
<sx:fieldElementMap field="Sender" element="csv:field"/>
<sx:fieldElementMap field="Recip" element="csv:field"/>
<sx:fieldElementMap field="Iref" element="csv:field"/>
<sx:fieldElementMap field="Testind" element="csv:field"/>
<sx:fieldElementMap field="Splitref" element="csv:field"/>
</csv:line>
</sx:onRecord>
<sx:innerGroup startTest="sx:current/header">
<csv:order>
<sx:onRecord recordType="details">
<csv:line>
<sx:fieldElementMap field="DDtag" element="csv:field"/>
<sx:fieldElementMap field="Linenr" element="csv:field"/>
<sx:fieldElementMap field="ArtEAN" element="csv:field"/>
<sx:fieldElementMap field="ArtSA" element="csv:field"/>
<sx:fieldElementMap field="ARTBP" element="csv:field"/>
</csv:line>
</sx:onRecord>
</csv:order>
</sx:innerGroup>
</csv:csv>
</sx:recordMapping>
</sx:resources>
 

This resources script produces the following output.

<?xml version="1.0" encoding="UTF-8"?>
<csv:csv xmlns:csv="http://xmlns.babelgom.com/2007/message-format/csv"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.babelgom.com/2007/message-format/csv csv.xsd">
   <csv:line>
      <csv:field>EE</csv:field>
      <csv:field>5400134000009</csv:field>
      <csv:field>3012918100700</csv:field>
      <csv:field>00000000014319</csv:field>
      <csv:field>1</csv:field>
      <csv:field/>
   </csv:line>
   <csv:order>
      <csv:line>
         <csv:field>DD</csv:field>
         <csv:field>000001</csv:field>
         <csv:field>8713906060109</csv:field>
         <csv:field>6011</csv:field>
         <csv:field>3005330101</csv:field>
      </csv:line>
      <csv:line>
         <csv:field>DD</csv:field>
         <csv:field>000002</csv:field>
         <csv:field>8713906061106</csv:field>
         <csv:field>6111</csv:field>
         <csv:field>3005250201</csv:field>
      </csv:line>
   </csv:order>
</csv:csv>

For more information about ServingXML, please visit http://servingxml.sourceforge.net/

Edit screen

Once the message format sample has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.79. Flat File Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

Generic Wizard screen allows you to define your generic message format according to your own file format.

To define a message in Generic format, select an existing template or make a copy of the generic Generic template in the catalogue. Unlike other message formats, there is no wizard screen for generic format.

Edit screen

Once the generic message format has been selected, edit screen appears as follows.

Figure 1.80. Customer Edit screen

This format should be used with your own message parser or converter written in Java code when no adequate format converter is available. Select this converter using ConverterClass property available under Advanced Properties.

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

Not Defined message format is used when in and out message format does not need to be defined because no processing will be performed on it and no change is required.

To define a message in Not defined format, select an existing template or make a copy of the generic Not defined template in the catalogue. There is no setting parameter for this message format.

TRADACOM Wizard screen allows you to define your TRADACOM message format according to your own file format.

Tradacoms is an early standard for EDI (Electronic Data Interchange) primarily used in the UK retail sector. It was introduced in 1982 as an implementation of the UN/GTDI syntax, one of the precursors of EDIFACT, and was maintained and extended by the UK Article Numbering Association (now called GS1 UK).

As Babelway supports all TRADACOM transaction sets of the TRADACOM standard, you can use any of them in your own gateway setup.

To define a message in TRADACOM format, select an existing template or make a copy of the generic TRADACOM template in the catalogue and following screen will be displayed.

Babelway supports all following TRADACOM documents:

1.ACKHDR,ACKMNT,ACKTLR,AVLDET,AVLHDR,AVLTLR,CORDER,CORHDR,CORTLR,CRAHDR,CRAINF,CRATLR,CREDIT,CREHDR,CRETLR,CUSHDR,CUSINF,CUSTLR,DELHDR,DELIVR,DELTLR,DLCDET,DLCHDR,DLCTLR,DRAHDR,DRAINF,DRATLR,EXCHDR,EXCINF,EXCTLR,GENHDR,GENRAL,GENTLR,INVFIL,INVOIC,INVTLR,LPRDET,LPRHDR,LPRTLR,ORDERS,ORDHDR,ORDTLR,PAYHDR,PAYINF,PAYTLR,PICHDR,PICKER,PICTLR,PPRDET,PPRHDR,PPRTLR,PRIHDR,PRIINF,PRITLR,PROHDR,PROINF,PROINF,PROTLR,RSGRSG,SADDET,SADHDR,SADTLR,SNPHDR,SNPHDR,SNPSTS,SNPTLR,SRMHDR,SRMINF,SRMTLR,UCNDET,UCNHDR,UCNTLR,UCNTLR,UPLHDR,UPLIFT,UPLTLR,UTLBIL,UTLHDR,UTLTLR,UVATLR,VATTLR

File sample

Following is a sample TRADACOM invoice file.

STX=ANAA:1+501xxxxxxxxxx:name+501xxxxxxxxxx:NAME SERVICES (U.K.)LTD.+040316:184411+00001++INVTES'
MHD=1+INVFIL:9'
TYP=0700+INVOICES'
SDT=501xxxxxxxxxx:053752CF01STDD+Tenprl Fnsrjnl Sbbqfreivpr+221 UvyyunyyRoad:Yvfohea:Co. Antrim:N.Ireland:OG27 5WQ+412557175'
CDT=501xxxxxxxxx+NAMESERVICES (U.K.) LTD.+Cnexynaqf Pbheg:OvezvatunzTerng Cnex:Ehorel:Birmingham:OG45 9CM'
FIL=1+1+040316'
FDT=040302+040302'
MTR=7'
MHD=2+INVOIC:9'
CLO=0000000100007: ++PNEEVPX GOLF CLUB:ABEGU ROAD:PNEEVPX SRETHF::OG388YC'
IRF=01000589M+040302+040302'
ODD=1+::040302+:040302'
ILD=1+1+:8408++:31266+0+2:2500:KG+54300+135800+Z+0+++SILVERSIDE 1-5 KG'
STL=1+Z+0+0+1358+++++1358++0+0++1358'
TLR=1+1358+++++1358++1358+0++1358'
MTR=8'
MHD=3+VATTLR:9'
VRS=1+Z+0+1358+1358+0+1358+1358'
MTR=3'
MHD=4+INVTLR:9'
TOT=1358+1358+0+1358+1358+1'
MTR=3'
MHD=5+RSGRSG:2'
RSG=00001+501xxxxxxxxxx'
MTR=3'
END=5'

Wizard screen

When you create a new message format, you must first configure it using the following wizard.

Figure 1.81. TRADACOM Wizard screen

An TRADACOM messsage can only be set up using a sample file. Select your sample file using the Browse... button then click on the Upload command.

Edit screen

Once the message format sample has been uploaded, or when it is used or copied from a saved format, edit screen appears as follows.

Figure 1.82. TRADACOM Edit screen

See Message Edit Functions for further information on message definition, contextual menu and additional commands available on this screen.

With an Email Gateway Out, Processed messages are attached to email messages and sent to a specific email address.

To create an email gateway out, select an existing template or make a copy of the generic Email template in the catalogue and following screen will be displayed.

Figure 1.86. Email Gateway Out configuration

The following fields should be defined in order to configure your email gateway out:

Figure 1.87. Email Gateway Out Advanced Properties configuration

Enter the value in the Property name field and its value in the Value field as illustrated in the above figure. Click on the   Add command to validate this property or on the Remove command to erase it.

The properties that should be added to complete setup of gateway are:

With a Ftp Client Output Gateway, outgoing messages are transfered to an external Ftp server.

To create a ftp client gateway out, select an existing template or make a copy of the generic Ftp client template in the catalogue and following screen will be displayed.

Figure 1.88. Ftp client gateway out configuration

The following fields should be defined in order to configure access to your external ftp server:

With a SFTP Client Output Gateway, outgoing messages are transfered to an external SFTP server.

To create a SFTP client gateway out, select an existing template or make a copy of the generic SFTP Client template in the catalogue and following screen will be displayed.

Figure 1.89. SFTP client gateway out configuration

The following fields should be defined in order to configure access to your external ftp server:

With a Ftp Server Output Gateway, outgoing messages are transferred to a Babelway FTP server.

To create a ftp server gateway out, select an existing template or make a copy of the generic Ftp server template in the catalogue and following screen will be displayed.

Figure 1.90. Ftp server gateway out configuration

The following fields should be defined in order to configure your ftp server on Babelway platform:

After channel deployment, your ftp server will be available to receive messages. You can access this ftp server using any ftp client software set up with the previous account parameters.

With an AS2 Gateway, outgoing messages are transmitted using an AS2 connection.

AS2 (Applicability Statement 2) is a specification about how to transport data securely and reliably over the Internet. Security is achieved by using digital certificates and encryption.

To create AS2 gateway, select an existing template or make a copy of the generic AS2 template in the catalogue and following screen will be displayed.

Figure 1.91. AS2 gateway configuration

The following fields should be defined in order to configure your AS2 access:

After channel deployment, your AS2 connection will be available to receive messages.

Advanced Properties

Report AS2 parameters to the other party

Click on GenericAS2Specifications.doc command to download a Word file including all parameters values required to establish AS2 communication. In this file, you should change Identity field to match the To field value (see above) as automatically attributed by Babelway interface, this value follows " BABELWAY_AS2_xxxxx " form.

Once this parameter has been changed to match your settings, you can send the file to the other party to give him all parameters he will require to establish a communication with your channel.

Figure 1.92. GenericAS2Specifications Word file example

With an HttpClientOut Gateway, outgoing messages are send using a Http connection.

To create a HttpClientOut gateway, select an existing template or make a copy of the generic HttpClientOut template in the catalogue and following screen will be displayed.

Figure 1.93. HttpClientOut gateway configuration

you can select several http internal in

The following fields should be defined in order to configure your HttpClientOut access:

The properties that may be added to complete setup of gateway are:

Figure 1.94. Http client out Gateway Out Advanced Properties configuration

After channel deployment, your connection will be available to send messages.

With a web gateway, incoming messages are manually uploaded on a specific Babelway webpage. They are processed as soon as they are uploaded.

To create a web gateway, select an existing template or make a copy of the generic Web template in the catalogue and following screen will be displayed.

Figure 1.95. Web Gateway configuration

There is no parameter to define in this template. The web gateway will be automaticaly created using the gateway name you entered.

You can access your specific web server via your Account Management screen, in Access and Notifications part. Click on the link next to the Message Upload via Web Gateway field. The web link is listed with the same name as the web gateway you created.

Figure 1.96. Web gateway access via my account management

Once you open your web gateway, following screen is displayed. Click on Upload tab if it is not open by default.

Figure 1.97. Web gateway Upload screen

Figure 1.98. Upload confirmation message

The generic gateway is used to setup gateway out with features not available at other gateways like transfer of output message to more than one channel.

To create an generic gateway, select an existing template or make a copy of the generic template in the catalogue and following screen will be displayed.

Figure 1.99. Generic gateway configuration

The internal gateway in / out are used for internal transfer of messages between channels inside the same account environment.

To create an internal gateway out, select an existing template or make a copy of the generic Babelway Internal template in the catalogue and following screen will be displayed.

Figure 1.100. Internal Gateway configuration

You can select several http internal in.

You can select multiple gateway in. A copy of the message will be sent to each of them.

There is only one parameter to define in this template.

The null gateway is used for test and development purposes. The outgoing message will not be sent out of Babelway platform.

To create an Null gateway, select an existing template or make a copy of the generic Null template in the catalogue and following screen will be displayed.

Figure 1.101. Null Gateway configuration

This gateway is derived from a generic gateway out. The only parameter is the class definition which is already defined by default.

Outgoing messages will not be forwarded but they are nevertheless created and readable through Tracking Messages interface. You may use this gateway for testing your messages transformation and creation before going to production or for preventing a channel to send messages before deployment.

With an OFtp server Gateway out, Outgoing messages are transferred to an Babelway OFTP server.

To create an OFtp server Gateway out, select an existing template or make a copy of the generic OFtp server template in the catalogue and following screen will be displayed.

Figure 1.102. OFtp server gateway out configuration

The following fields should be defined in order to configure your OFTP Server on Babelway platform:

After channel deployment, your Oftp server will be available to send messages. You can access this ftp server using any Oftp client software set up with the previous account parameters.

With an OFTP Client out Gateway, outgoing messages are transferred to an external OFTP server as soon as they are processed by the Babelway engine.

To create an OFtp client Gateway out, select an existing template or make a copy of the generic OFtp client template in the catalogue and following screen will be displayed.

Figure 1.103. OFtp client gateway out configuration

The following fields should be defined in order to configure your OFTP client on Babelway platform:

After channel deployment, your Oftp server will be available to send messages. You can access this ftp server using any Oftp client software set up with the previous account parameters.

With a HTTP out Output Gateway, outgoing messages are transferred to a Babelway HTTP server.

To create a HttpOut gateway, select an existing template or make a copy of the generic HttpOUT template in the catalogue and following screen will be displayed.

Figure 1.104. Http OUT gateway configuration

The following fields should be defined in order to configure your HttpOut access:

After channel deployment, your connection will be available to send messages.

With an SOAP Gateway, outgoing messages are send using a SOAP connection. Incoming files are process as soon as they are received.

SOAP, originally defined as Simple Object Access Protocol, is a protocol specification for exchanging structured information in the implementation of Web services in computer networks. It relies on XML as message format, and on other application layer protocols (such as RPC and HTTP) for message negotiation and transmission.

To create a SOAP gateway, select an existing template or make a copy of the generic SOAP template in the catalogue and following screen will be displayed.

Figure 1.105. SOAP gateway configuration

The following fields should be defined in order to configure your AS2 access:

After channel deployment, your SOAP connection will be available to send messages.

With an SoapClientOut Gateway, outgoing messages are send using a Soap connection.

To create a SoapClientOut gateway, select an existing template or make a copy of the generic SoapClientOut template in the catalogue and following screen will be displayed.

Figure 1.106. SoapClientOut gateway configuration

The following fields should be defined in order to configure your SoapClientOut access:

After channel deployment, your connection will be available to send messages.

With a X.400 out Gateway, allows to sends the message on the X.400 network. To specify the address from your trading partner.

To create a X.400 Gateway out, select an existing template or make a copy of the generic X.400 template in the catalogue and following screen will be displayed.

Figure 1.107. X.400 gateway out configuration

The aggregator allows to merge messages into one larger file. The aggregation could simply append the messages, use a xslt to merge xml document or merge Edifact or X12 documents. The resulting messages is forwarded to an other channels in the same environment.

To create an internal gateway out, select an existing template or make a copy of the generic Aggregator template in the catalogue and following screen will be displayed.

Figure 1.108. Aggregator Gateway configuration

You can select several internal in.

You can select multiple gateway in. A copy of the message will be sent to each of them.

List of channels available inside the account environment and channels information summary.

The list of channels displays a table with all channels available in current account environment. This table columns are:

Figure 2.1. List of channels

Commands

Two or three commands are available in this screen:

Add a new channel.

To create a new channel, click on Create Channel command below the list of channels table.

This new and empty channel will added in the list of channels. See Channels chapter to configure it according to your needs.