324
1 EZConnect How To 2850 E. 29th Street, Long Beach, California, 90806, USA 800.347.3638 www.acom.com

EZConnect HowTo

Embed Size (px)

Citation preview

Page 1: EZConnect HowTo

1

EZConnect

How To

2850 E. 29th Street, Long Beach,

California, 90806, USA

800.347.3638

www.acom.com

Page 2: EZConnect HowTo

Introduction

2

EZCONNECT ................................................................................................................................................ 1

HOW TO ........................................................................................................................................................ 1

1. INTRODUCTION................................................................................................................................ 5

2. HOW TO MAP .................................................................................................................................... 6

2.1. DATABASE TO XML ..................................................................................................................... 7 2.1.1. Setting up Trading Partner ..................................................................................................... 7 2.1.2. Setting up Database Schema .................................................................................................. 9 2.1.3. Setting up XML Schema .........................................................................................................10 2.1.4. Setting up new Database to XML map ...................................................................................11 2.1.5. Setting up Document for Trading Partner .............................................................................20 2.1.6. Setting up Database to XML process .....................................................................................26

2.2. XML TO DATABASE ....................................................................................................................28 2.2.1. Setting up Trading Partner ....................................................................................................28 2.2.2. Setting up Database Schema .................................................................................................30 2.2.3. Setting up XML Schema .........................................................................................................31 2.2.4. Setting up new XML to Database map ...................................................................................32 2.2.5. Setting up Document for Trading Partner .............................................................................41 2.2.6. Setting up XML to Database process .....................................................................................46

2.3. DATABASE TO EDI ......................................................................................................................49 2.3.1. Setting up Trading Partner ....................................................................................................49 2.3.2. Setting up Database Schema .................................................................................................51 2.3.3. Setting up new Database to EDI map ....................................................................................52 2.3.4. Setting up Document for Trading Partner .............................................................................63 2.3.5. Setting up Database to EDI process ......................................................................................68

2.4. EDI TO DATABASE ......................................................................................................................71 2.4.1. Setting up Trading Partner ....................................................................................................71 2.4.2. Setting up Database Schema .................................................................................................73 2.4.3. Setting up new EDI to Database map ....................................................................................74 2.4.4. Setting up Document for Trading Partner .............................................................................85 2.4.5. Setting up EDI to Database Process ......................................................................................91

2.5. FLAT FILE TO EDI .......................................................................................................................94 2.5.1. Setting up Trading Partner ....................................................................................................94 2.5.2. Setting up Flat File Schema ...................................................................................................96 2.5.3. Setting up new Flat File to EDI map .....................................................................................97 2.5.4. Setting up Document for Trading Partner ...........................................................................106 2.5.5. Setting up Flat File to EDI process .....................................................................................113

2.6. EDI TO FLAT FILE .....................................................................................................................116 2.6.1. Setting up Trading Partner ..................................................................................................116 2.6.2. Setting up Flat File Schema .................................................................................................118 2.6.3. Setting up new EDI to Flat File map ...................................................................................119 2.6.4. Setting up Document for Trading Partner ...........................................................................130 2.6.5. Setting up EDI to Flat File Process .....................................................................................137

2.7. XML TO EDI.............................................................................................................................140 2.7.1. Setting up Trading Partner ..................................................................................................140 2.7.2. Setting up XML Schema .......................................................................................................142 2.7.3. Setting up new XML to EDI map .........................................................................................143 2.7.4. Setting up Document for Trading Partner ...........................................................................153 2.7.5. Setting up XML to EDI Process ...........................................................................................160

2.8. EDI TO XML.............................................................................................................................163 2.8.1. Setting up Trading Partner ..................................................................................................163 2.8.2. Setting up XML Schema .......................................................................................................165 2.8.3. Setting up new EDI to XML map .........................................................................................166 2.8.4. Setting up Document for Trading Partner ...........................................................................176 2.8.5. Setting up EDI to XML Process ...........................................................................................182

Page 3: EZConnect HowTo

Introduction

3

2.9. XML TO XML ..........................................................................................................................184 2.9.1. Setting up Trading Partner ..................................................................................................185 2.9.2. Setting up XML Schema .......................................................................................................186 2.9.3. Setting up new XML to XML map ........................................................................................187 2.9.4. Setting up Document for Trading Partner ...........................................................................188 3.9.1. Setting up XML to XML Process..........................................................................................194

2.10. FLAT FILE TO DATABASE ..........................................................................................................197 2.10.1. Setting up Trading Partner .............................................................................................197 2.10.2. Setting up Flat File Schema ............................................................................................198 2.10.3. Setting up new Flat File to Database map ......................................................................199 2.10.4. Setting up Document for Trading Partner ......................................................................211 2.10.5. Setting up Flat File to Database process ........................................................................217

2.11. DATABASE TO FLAT FILE ..........................................................................................................220 2.11.1. Setting up Trading Partner .............................................................................................220 2.11.2. Setting up Database Schema ...........................................................................................221 2.11.3. Setting up Flat File Schema ............................................................................................223 2.11.4. Setting up new Database to Flat File map ......................................................................223 2.11.5. Setting up Document for Trading Partner ......................................................................237 2.11.6. Setting up Database to Flat File process ........................................................................243

2.12. EDI RESPONSE ..........................................................................................................................244 2.12.1. Setting up Trading Partner .............................................................................................245 2.12.2. Setting up new EDI Response map .................................................................................246 2.12.3. Setting up Document for Trading Partner ......................................................................257

3. HOW TO MANAGE SCHEMA ..................................................................................................... 264

3.1. DATABASE ................................................................................................................................264 3.1.1. Adding a Database Schema .................................................................................................264 3.1.2. Editing a Database Schema .................................................................................................265 3.1.3. Deleting a Database Schema ...............................................................................................266 3.1.4. How to create a new Data Source .......................................................................................267

3.2. XML .........................................................................................................................................271 3.2.1. Deleting an XML Schema ....................................................................................................271 3.2.2. Exporting an XML Schema ..................................................................................................272 3.2.3. Importing an XML Schema ..................................................................................................272 3.2.4. Replacing new XML Schema ...............................................................................................273

3.3. FLAT FILE .................................................................................................................................275 3.3.1. Adding a Flat File Schema ..................................................................................................275 3.3.2. Deleting a Flat File Schema ................................................................................................276 3.3.3. Editing a Flat File Schema ..................................................................................................277 3.3.4. Loading IDOCs Lib .............................................................................................................279 3.3.5. Importing a Flat File Schema ..............................................................................................280 3.3.6. Exporting a Flat File Schema ..............................................................................................280 3.3.7. Configuring a Flat File Schema ..........................................................................................280

4. HOW TO MANAGE MAP ............................................................................................................. 282

4.1. EDITING A MAP TYPE ................................................................................................................282 4.2. DELETING A MAP TYPE .............................................................................................................283 4.3. OPENING A MAP TYPE ...............................................................................................................283 4.4. EXPORTING A MAP TYPE ...........................................................................................................284 4.5. IMPORTING A MAP TYPE ...........................................................................................................285

5. HOW TO MANAGE TRADING PARTNER ............................................................................... 286

5.1. ADDING A TRADING PARTNER ..................................................................................................286 5.2. EDITING A TRADING PARTNER ..................................................................................................287 5.3. DELETING A TRADING PARTNER ...............................................................................................288 5.4. IMPORTING A TRADING PARTNER..............................................................................................289

Page 4: EZConnect HowTo

Introduction

4

5.5. EXPORTING A TRADING PARTNER .............................................................................................290

6. HOW TO MANAGE DOCUMENT ............................................................................................... 291

6.1. ADDING DOCUMENT .................................................................................................................291 6.2. EDITING DOCUMENT .................................................................................................................293 6.3. DELETING DOCUMENT ..............................................................................................................294 6.4. IMPORTING DOCUMENT.............................................................................................................294 6.5. EXPORTING DOCUMENT ............................................................................................................294

7. HOW TO MANAGE JOB ............................................................................................................... 296

7.1. ADDING A JOB ...........................................................................................................................296 6.1. OPENING A JOB .........................................................................................................................297 6.2. RUNNING A JOB .........................................................................................................................297 6.3. EDITING A JOB ...........................................................................................................................299 6.4. DELETING A JOB ........................................................................................................................300 6.5. CREATE DEPLOYMENT PACKAGE ..............................................................................................301

8. HOW TO MANAGE PROCESS .................................................................................................... 304

8.1. ADDING A PROCESS ...................................................................................................................304 8.2. EDITING A PROCESS ..................................................................................................................305 8.3. RUNNING A PROCESS.................................................................................................................306 8.4. DELETING A PROCESS ...............................................................................................................307 8.5. OPENING LOG FILE....................................................................................................................308 8.6. SHOWING TRACKING .................................................................................................................308 8.7. SETUP AN EXTERNAL PROCESS .................................................................................................309 8.8. SETUP EZCONNECT COMPONENTS ............................................................................................310

9. HOW TO MANAGE USER ACCOUNT ....................................................................................... 312

9.1. VIEWING ALL EXISTING USERS ..................................................................................................312 9.2. CREATING NEW USER ................................................................................................................312 9.3. DELETING A SELECTED USER .....................................................................................................313

10. HOW TO SETUP EMAIL CONFIGURATIONS ........................................................................ 314

11. HOW TO TRACK DOCUMENT................................................................................................... 316

12. HOW TO MANAGE REPORT ...................................................................................................... 318

12.1. VIEW REPORTS ..........................................................................................................................318 12.2. PRINT REPORTS .........................................................................................................................319 12.3. EXPORT REPORTS ......................................................................................................................320

13. HOW TO CREATE GLOBAL FUNCTION ................................................................................. 321

14. HOW TO MANAGE EMAIL TEMPLATE .................................................................................. 322

15. USING THE TOOLBOX ................................................................................................................ 323

Page 5: EZConnect HowTo

Introduction

5

1. Introduction This document includes the following topics:

How to Map Using EZConnect

How to Manage Schema

How to Manage Map

How to Manage Trading Partner

How to Manage Document

How to Manage Chart

How to Manage Process

How to Set up Email Configuration

How to Manage User Account

How to Track Documents

How to Manage Reports

How to Create Global Function

How to Manage Email Template

Using Toolbox

Page 6: EZConnect HowTo

How to map

6

2. How to map

EZConnect now supports visual mapping between source schema and target schema. The

contents of one schema are mapped, or transformed, to another schema. An XML, or Flat File, a

database, or EDI file, can be mapped to a different target XML document, Flat File text

document, EDI file, or database. Thus nodes/elements/attributes in the source schema are

connected to other nodes/elements/attributes in the target schema.

This section will guide you how to map from a source data to target data using EZConnect.

Specifically this section will address the basics of mapping:

Database to XML

XML to Database

Database to EDI

EDI to Database

Flat File to EDI

EDI to Flat File

XML to EDI

EDI to XML

XML to XML

Flat File to Database

Database to Flat File

EDI Response

Back to Top

Page 7: EZConnect HowTo

How to map

7

2.1. Database to XML

Select this map type when the data to be translated originates from a database and is destined

for an XML file.

This map type allows you visually mapping relational data and XML file based on industry-

standard W3C XQuery technologies. You can execute your newly created Database to XML

mapping to verify that it produces the desired XML data output from your relational data.

Preparation for Mapping Database to XML

It is a requirement that a Database and XML schema should be linked prior mapping.

The following steps must be followed to successfully complete the data mapping process:

(click on each step to see the details)

Step 1: Setting up Trading Partner

Step 2: Setting up Database Schema

Step 3: Setting up XML Schema

Step 4: Setting up new Database to XML map

Step 5: Setting up Document for Trading Partner

Step 6: Setting up Database to XML process

Mapping Database to XML

2.1.1. Setting up Trading Partner

To begin sending and receiving files with a trading partner, you must first create Trading Partner in

EZConnect. To do this, complete the following steps:

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item

in the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed. This is a template for all of the

trading partner information that will be entered.

3. Click Add Trading Partner button on the Trading Partner Manager Toolbar or highlight

Page 8: EZConnect HowTo

How to map

8

the available Trading Partner and right mouse click on it and then choose Add Trading

Partner in drop down list.

4. The Trading Partner Information window opens.

5. Enter the important Trading Partner Information including Customer Name, Customer

Number.

6. Provide the related EDI information you want to include for the Trading Partner.

7. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

8. Enter the contact information you want to include for the Trading Partner in Contacts tab.

9. Enter the notes information you want to include for the Trading Partner in Notes tab.

10. Click on Save button on Action Menu to save the settings.

11. Click on Close to close the Trading Partner Information window and return to Trading Partner

Manager workspace.

Page 9: EZConnect HowTo

How to map

9

2.1.2. Setting up Database Schema

1. Select Schemas and then choose Database in the Toolbar or go to Schemas > Database on

Main Menu bar or click Database on Schemas section of Main Menu Tree to open

Database Connection workspace.

2. Click Add button on the Toolbar menu or right click on the database connection and choose

Add.

3. The Database Connection Interface opens

4. Fill in the database connection name in Name field.

5. In Connection Information panel, choose the appropriate DB Type. Choices are Microsoft

SQL Server, Generic ODBC (using DSN).

Note: If the required data source was previously created for Generic (ODBC), select

it. If you do not have a data source setup, create new a data source. After completing

the data source setup, the new connection will be displayed in DSN drop down list

(Generic ODBC).

6. Enter the appropriate information associated with the database type you want to establish a

connection with a specific database on a specific server.

Page 10: EZConnect HowTo

How to map

10

7. Select some desired tables and then click Save in Action menu to save changes.

8. Click Close in Action menu to close the Database Connection window and return to

Database Connection workspace.

2.1.3. Setting up XML Schema

1. Select Schemas and then choose XML in the Toolbar or go to Schemas > XML on Main

Menu Bar or click XML on Schemas section of Main Menu Tree to open XML Schemas

workspace.

2. Click Import button on the Toolbar or right mouse click on XML Schemas workspace and

then choose Import.

3. The Import XML Schema window opens.

4. Fill in the schema name in Schema Name field.

5. In Schema file field, browser and choose the appropriate XML schema.

6. Fill in the Note.

7. Click on Save in Action menu to save changes.

Page 11: EZConnect HowTo

How to map

11

2.1.4. Setting up new Database to XML map

Setup Map

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the workspace or available map type and

choose Add or click Add button on the Map Manager Toolbar.

3. The Map Manager - Map Setup Wizard window opens.

Page 12: EZConnect HowTo

How to map

12

4. In the Choose Map Type panel, select the Database item in Source Type and the XML item

in the Target Type.

5. Click Next. The Setup Map Database to XML Details interface opens.

6. In the Map Information, fill in the Map Name and Notes for this map type.

7. In the Database Information, select the database in DB Connection drop down list and click

on Test button to test connection.

Or

Click the Add New button to add new database connection. Note that this button allows

creating a new database connection but the selected tables haven't yet performed. In order to

Page 13: EZConnect HowTo

How to map

13

select tables, the user must go to Database Schema to select.

8. In the Schema Information, select a XML schema from the XML Schemas List.

9. Click Finish to save the new map definition and close the Map Manager - Map Setup

Wizard window.

10. Click Cancel to close the interface without creating the new map.

Start Mapping

After successfully added new Database to XML map, you can start mapping by following steps:

1. To open the map:

Double click on the selected map to open.

Or

Right click on the selected map and then choose Open or click Open button on the Map

Manager Toolbar. The Map Editor workspace opens.

2. EZConnect 9 supports Database as the source or target of data mapping. To create Database to

XML mapping, simply drag and drop the appropriate columns from source Database tree to the

XML nodes from target XML tree or vice versa, connecting the data sources to the desired data

output. This feature allows you to quickly create expressions, for example, without writing any

code or introducing typographical errors to the source.

3. One of the great features of Map Editor is the synchronized source code pane allows you to

immediately see the code that EZConnect 9 has composed for you, based on the source target

relationship defined by your drag and drop mapping operations. Similarly, you can edit the

Map Editor code manually. As illustrated below, the Country column in OrdList table drags

and drops to the country node in Purchase Order Schema and the appropriate code is

generated automatically in Code Pane window.

In addition, EZConnect 9 now supports the Toolbox panel in the left hand side of Map Editor.

The Toolbox displays icons for code macro items that you can add to Code Pane window.

Each code macro in Code Pane can be dragged and dropped into Toolbox panel or vice versa.

Each time you return to Map Editor, the Toolbox automatically scrolls to the group and item

most recently selected.

Page 14: EZConnect HowTo

How to map

14

4. To navigate through the elements/nodes, just click on elements/nodes in the target pane. the

appropriate codes associated with them are generated in the Code Pane.

For example, in the illustrative figure below, the user is clicking on an „Name‟ element in the

Purchase Order Schema, and the appropriate code generation appears in the Code Pane Window.

5. EZConnect 9 also provides tools, Query Builder (illustrated below), that lets you create, edit,

Page 15: EZConnect HowTo

How to map

15

and testing the SQL statements used to define any relational database tables and views as a

customized XML data source.

The Variable Editor is used to add, remove the defined variable associated with the

selected map.

As illustrated below, the variables are defined globally. We can access them through Code

Pane window with the syntax:

GLOBAL.VariableName

Page 16: EZConnect HowTo

How to map

16

The Function Editor is used to create definitions of new functions associated with the

selected map. The functions are defined globally and then access them through Code Pane

window with the syntax: GLOBAL.FunctionName

The Local Translation Editor is used to translate the value. The variables are defined

globally and then access them through Source Code Pane window with the syntax:

FUNC.LocalTranslation("Value Name")

The Auto Convert Setting is used to convert the source objects to specific converted

strings. The strings are defined in Auto Convert Setting and drag and drop between source

and target tree view nodes.

Page 17: EZConnect HowTo

How to map

17

6. Additionally, Map Editor includes a code completion feature – a pop up list of methods and/or

properties available for objects typed into the code pane. The list appears after you enter a

period for the object, signaling method or property selection. Figure below shows the available

list for the DB object.

Tip: Just type as usual in the Code Pane and EZConnect 9 will automatically sense what

the function you are trying to type and provide a drop down box of matching functions and their

method signatures.

7. Furthermore, you can execute your newly created Database to XML mapping to verify that it

produces the desired XML data output from your relational data. To run map, simply click the

Run Map button or press F6. The Input Parameters window opens and then choose the

appropriate Trading Partner and document to start mapping.

Page 18: EZConnect HowTo

How to map

18

Note: In order to run the map, setting up Trading Partner and Document are required. For

more information, see Adding Trading Partner and Adding Document.

Figures below show the compile options. Any build errors encountered are displayed in the

Output Pane window.

Page 19: EZConnect HowTo

How to map

19

The XML results are displayed in Check Output Pane window

8. Once you are satisfied with the results, save the map. Database to XML data sources store both

the database connection properties you have specified, as well as the SQL statements and the

codes that you have created.

Page 20: EZConnect HowTo

How to map

20

2.1.5. Setting up Document for Trading Partner

1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar.

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document “Database to XML” by selecting Database item from the

Source Type and XML item from Target Type to add to the Trading Partner and click

Next.

Page 21: EZConnect HowTo

How to map

21

6. Highlight the map (document) to assign to this Trading Partner and click Next.

Page 22: EZConnect HowTo

How to map

22

7. In Settings panel, provide basic settings for documents.

Page 23: EZConnect HowTo

How to map

23

Choose appropriate File Extension dropdown list. Available choices are .txt, .doc, .rtf

and .xml.

Enter File Count number.

Fill in the XML File prefix.

Note: All field noted with “*” are required.

8. In Communication panel, select a communication type for your document.

Page 24: EZConnect HowTo

How to map

24

9. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The

Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 25: EZConnect HowTo

How to map

25

Page 26: EZConnect HowTo

How to map

26

2.1.6. Setting up Database to XML process

1. Open a job to add process.

2. The Job workspace opens. Right-click anywhere in the Process Configuration pane, click

Add Process

3. The Add Process window opens.

4. Fill in the process name in Process Name field.

5. Choose the type of process “Database to XML” by selecting Database item from the Source

Type and XML item from Target Type.

6. Click Save on Action menu to continue process configuration.

Page 27: EZConnect HowTo

How to map

27

Note: The type selected determines the number of predefined configuration steps that will

be available when the new process is saved. Each Tab provides additional options for further

defining the process being created or modified.

7. Configure the process by clicking on each tab to fill the appropriate information.

8. Click on Save in the Action menu to save the information.

Back to How to Map

Page 28: EZConnect HowTo

How to map

28

2.2. XML to Database

Select this map type when the data to be translated originates from a XML file that is destined

to a database.

This map type allows you visually mapping between XML file based on industry-standard

W3C XQuery technologies and relational data. You can execute your newly created XML to

Database mapping to verify that it produces the desired rational data output from your XML

file.

Preparation for Mapping XML to Database

It is a requirement that a Database and XML schema should be linked prior mapping.

The following steps must be followed to successfully complete the data mapping process:

(click on each step to see the details)

Step 1: Setting up Trading Partner

Step 2: Setting up Database Schema

Step 3: Setting up XML Schema

Step 4: Setting up new XML to Database map

Step 5: Setting up Document for Trading Partner

Step 6: Setting up XML to Database process

Mapping XML to Database

2.2.1. Setting up Trading Partner

To begin sending and receiving files with a trading partner, you must first create Trading Partner in

EZConnect. To do this, complete the following steps:

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item

in the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed. This is a template for all of the

trading partner information that will be entered.

Page 29: EZConnect HowTo

How to map

29

3. Click Add Trading Partner button on the Trading Partner Manager Toolbar or highlight

the available Trading Partner and right mouse click on it and then choose Add Trading

Partner in drop down list.

4. The Trading Partner Information window opens.

5. Enter the important Trading Partner Information including Customer Name, Customer

Number.

6. Provide the related EDI information you want to include for the Trading Partner.

7. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

8. Enter the contact information you want to include for the Trading Partner in Contacts tab.

9. Enter the notes information you want to include for the Trading Partner in Notes tab.

10. Click on Save button on Action Menu to save the settings.

11. Click on Close to close the Trading Partner Information window and return to Trading Partner

Manager workspace.

Page 30: EZConnect HowTo

How to map

30

2.2.2. Setting up Database Schema

1. Select Schemas and then choose Database in the Toolbar or go to Schemas > Database on

Main Menu bar or click Database on Schemas section of Main Menu Tree to open

Database Connection workspace.

2. Click Add button on the Toolbar menu or right click on the database connection and choose

Add.

3. The Database Connection Interface opens

4. Fill in the database connection name in Name field.

5. In Connection Information panel, choose the appropriate DB Type. Choices are Microsoft

SQL Server, Generic ODBC (using DSN).

Note: If the required data source was previously created for Generic (ODBC), select

it. If you do not have a data source setup, create new a data source. After completing

the data source setup, the new connection will be displayed in DSN drop down list

(Generic ODBC).

6. Enter the appropriate information associated with the database type you want to establish a

connection with a specific database on a specific server.

7. Select some desired tables and then click Save in Action menu to save changes.

8. Click Close in Action menu to close the Database Connection window and return to

Page 31: EZConnect HowTo

How to map

31

Database Connection workspace.

2.2.3. Setting up XML Schema

1. Select Schemas and then choose XML in the Toolbar or go to Schemas > XML on Main

Menu Bar or click XML on Schemas section of Main Menu Tree to open XML Schemas

workspace.

2. Click Import button on the Toolbar or right mouse click on XML Schemas workspace and

then choose Import.

3. The Import XML Schema window opens.

4. Fill in the schema name in Schema Name field.

5. In Schema file field, browser and choose the appropriate XML schema.

6. Fill in the Note.

7. Click on Save in Action menu to save changes.

Page 32: EZConnect HowTo

How to map

32

2.2.4. Setting up new XML to Database map

Setting up map

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the workspace or available map type and

choose Add or click Add button on the Map Manager Toolbar.

3. The Map Manager - Map Setup Wizard window opens.

4. In the Choose Map Type panel, select the XML item in Source Type and the Database item in

Page 33: EZConnect HowTo

How to map

33

the Target Type.

5. Click Next. The Setup Map XML to Database Details interface opens.

6. In the Map Information, fill in the Map Name, Map ID and Notes for this map type.

7. In the Schema Information, select a XML schema from the XML Schemas List.

8. In the Database Information, select the database in DB Connection drop down list and click

on Test button to test connection

Or

Click the Add New button to add new database connection. Note that this button allows

creating a new database connection but the selected tables haven't yet performed. In order to

Page 34: EZConnect HowTo

How to map

34

select tables, the user must go to Database Schema to select.

9. Click Finish to save the new map definition and close the Map Manager - Map Setup

Wizard window.

10. Click Cancel to close the interface without creating the new map.

Start mapping

After successfully added new XML to Database map, you can start mapping by following steps:

1. To open the map:

Double click on the selected map to open.

Or

Right click on the selected map and then choose Open or click Open button on the Map

Manager Toolbar. The Map Editor workspace opens.

2. To create XML to Database mapping, simply drag and drop the XML nodes from the source

XML tree to the appropriate columns from the target Database tree or vice versa, connecting

the data sources to the desired data output. This feature allows you to quickly create

expressions, for example, without writing any code or introducing typographical errors to the

source.

3. One of the great features of Map Editor is the synchronized source code pane allows you to

immediately see the code that EZConnect 9 has composed for you, based on the source target

relationship defined by your drag and drop mapping operations. Similarly, you can edit the

Map Editor code manually. As illustrated below, the country node in Purchase Order Schema

drag and drop to the ShipCountry in Ord table and the appropriate code is generated

automatically in Code Pane window.

In addition, EZConnect 9 now supports the Toolbox panel in the left hand side of Map Editor.

The Toolbox displays icons for code macro items that you can add to Code Pane window.

Each code macro in Code Pane can be dragged and dropped into Toolbox panel or vice versa.

Each time you return to Map Editor, the Toolbox automatically scrolls to the group and item

most recently selected.

Page 35: EZConnect HowTo

How to map

35

4. To navigate through the elements and appropriate codes that associated with them, just click on

elements in the Source Pane.

5. EZConnect 9 also provides tools, Query Builder (illustrated below), that lets you create, edit,

and testing the SQL statements used to define any relational database tables and views as a

customized XML data source.

Page 36: EZConnect HowTo

How to map

36

The Variable Editor is used to add, remove the defined variable associated with the

selected map.

As illustrated below, the variables are defined globally. We can access them through

Source Code Pane window with the syntax:

GLOBAL.VariableName

Page 37: EZConnect HowTo

How to map

37

The Function Editor is used to create definitions of new functions associated with the

selected map. The functions are defined globally and then access them through Code

Pane window with the syntax: GLOBAL.FunctionName

The Local Translation Editor is used to translate the value. The variables are defined

globally and then access them through Source Code Pane window with the syntax:

FUNC.LocalTranslation("Value Name")

The Auto Convert Setting is used to convert the source objects to specific converted

strings. The strings are defined in Auto Convert Setting and drag and drop between

source and target tree view nodes.

Page 38: EZConnect HowTo

How to map

38

6. Additionally, Map Editor includes a code completion feature – a pop up list of methods and/or

properties available for objects typed into the code pane. The list appears after you enter a

period for the object, signaling method or property selection. Figure below shows the available

list for the FUNC object.

Tip: Just type as usual in the Source Code pane and EZConnect 9 will automatically sense

what the function you are trying to type and provide a drop down box of matching

Page 39: EZConnect HowTo

How to map

39

functions and their method signatures.

7. Furthermore, you can execute your newly created XML to Database mapping to verify that it

produces the desired data output from your XML data. To run map, simply click the Run Map

button or press F6. The Input Parameters window opens and then choose the appropriate TP,

document and browser the XML file to start mapping.

Note: In order to run the map, setting up Trading Partner and Document are required.

Figures below show the compile options. Any build errors encountered are displayed in the

Output Pane window.

Page 40: EZConnect HowTo

How to map

40

8. Once you are satisfied with the results, save the map. XML to Database data sources store the

database connection properties you have specified, as well as the SQL statements and the codes

that you have created.

Page 41: EZConnect HowTo

How to map

41

2.2.5. Setting up Document for Trading Partner

1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar.

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document “XML to Database” by selecting XML item from the Source

Type and Database item from Target Type to add to the Trading Partner and click Next.

6. Highlight the map (document) to assign to this Trading Partner and click Next.

Page 42: EZConnect HowTo

How to map

42

7. In Settings panel, provide basic settings for documents

Page 43: EZConnect HowTo

How to map

43

Choose appropriate Cust Number XPath and Doc Type XPath by selecting the node to

fill in the Cust Number XPath and Doc Type XPath textbox

Fill in the Document Type Value.

Fill in the XML File prefix and set the file count in the File Count scroll control.

Note: All field noted with “*” are required.

8. Configure for Functional Acknowledgement.

Page 44: EZConnect HowTo

How to map

44

Choose path for placing the file of Functional Acknowledgement on server or client

machine.

In the Select doc to run, select a DB2XML map for Functional Acknowledgement.

9. In Communication panel, select a communication type for your document

Page 45: EZConnect HowTo

How to map

45

10. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The

Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 46: EZConnect HowTo

How to map

46

2.2.6. Setting up XML to Database process

1. Open the job to add process

2. The Job workspace opens. Right-click anywhere in the Process Configuration pane, click

Add Process.

3. The Add Process window opens.

Page 47: EZConnect HowTo

How to map

47

4. Fill in the process name in Process Name field.

5. Choose the type of process “XML to Database” by selecting XML item from the Source

Type and Database item from Target Type.

6. Click Save on Action menu to continue process configuration. <Show Figure>

Page 48: EZConnect HowTo

How to map

48

Note: The type selected determines the number of predefined configuration steps that will

be available when the new process is saved. Each Tab provides additional options for further

defining the process being created or modified.

9. Configure the process by clicking on each tab to fill the appropriate information.

10. Click on Save in the Action menu to save the information.

Back to How to Map

Page 49: EZConnect HowTo

How to map

49

2.3. Database to EDI

Select this map type when the data to be translated originates from a database and is destined

an EDI formatted document.

This map type allows you visually mapping rational data and EDI file. You can execute your

newly created Database to EDI mapping to verify that it produces the desired EDI data output

from your rational data.

You can obtain information about an EDI format, from its associated document called

the implementation guideline. The implementation guideline is probably the only

document that you would ever need for obtaining instructions about how to process EDI

files of your trading partner. Before EDI files are exchanged, trading partners have to

agree on the EDI format and mapping. These rules and instructions are entered into the

implementation guideline document. Depending on your trading partner, the

implementation guidelines can come in many formats.

Preparation for Mapping Database to EDI

It is a requirement that a Database schema should be linked prior mapping.

The following steps must be followed to successfully complete the data mapping process:

(click on each step to see the details)

Step 1: Setting up Trading Partner

Step 2: Setting up Database Schema

Step 3: Setting up new Database to EDI map

Step 4: Setting up Document for Trading Partner

Step 5: Setting up Database to EDI process

Mapping Database to EDI

2.3.1. Setting up Trading Partner

To begin sending and receiving files with a trading partner, you must first create Trading Partner in

Page 50: EZConnect HowTo

How to map

50

EZConnect. To do this, complete the following steps:

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item

in the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed. This is a template for all of the

trading partner information that will be entered.

3. Click Add Trading Partner button on the Trading Partner Manager Toolbar or highlight

the available Trading Partner and right mouse click on it and then choose Add Trading

Partner in drop down list.

4. The Trading Partner Information window opens.

5. Enter the important Trading Partner Information including Customer Name, Customer Number.

6. Provide the related EDI information you want to include for the Trading Partner.

7. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

Page 51: EZConnect HowTo

How to map

51

8. Enter the contact information you want to include for the Trading Partner in Contacts tab.

9. Enter the notes information you want to include for the Trading Partner in Notes tab.

10. Click on Save button on Action Menu to save the settings.

11. Click on Close to close the Trading Partner Information window and return to Trading

Partner Manager workspace.

2.3.2. Setting up Database Schema

1. Select Schemas and then choose Database in the Toolbar or go to Schemas > Database on

Main Menu bar or click Database on Schemas section of Main Menu Tree to open

Database Connection workspace.

2. Click Add button on the Toolbar menu or right click on the database connection and choose

Add.

3. The Database Connection Interface opens.

4. Fill in the database connection name in Name field.

5. In Connection Information panel, choose the appropriate DB Type. Choices are Microsoft

SQL Server, Generic ODBC (using DSN).

Page 52: EZConnect HowTo

How to map

52

Note: If the required data source was previously created for Generic (ODBC),

select it. If you do not have a data source setup, create new a data source. After

completing the data source setup, the new connection will be displayed in DSN

drop down list (Generic ODBC).

6. Enter the appropriate information associated with the database type you want to establish a

connection with a specific database on a specific server.

7. Select some desired tables and then click Save in Action menu to save changes.

8. Click Close in Action menu to close the Database Connection window and return to

Database Connection workspace.

2.3.3. Setting up new Database to EDI map

Setup Map

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the workspace or available map type and

choose Add or click Add button on the Map Manager Toolbar.

3. The Map Manager - Map Setup Wizard window opens.

Page 53: EZConnect HowTo

How to map

53

4. In the Choose Map Type panel, select the Database item in Source Type and the EDI item in

the Target Type.

5. Click Next. The Setup Map Database to EDI Details interface opens.

Page 54: EZConnect HowTo

How to map

54

6. In the Map Information, fill in the Map Name and Notes for this map type.

7. In the Database Information, select the database in DB Connection drop down list and click

on Test button to test connection.

-OR-

Click the Add New button to add new database connection. Note that this button allows

creating a new database connection but the selected tables haven't yet performed. In order to

select tables, the user must go to Database Schema to select.

8. In the EDI Information, select a Standard, Version and Message ID from EDI List.

9. Click Finish to save the new map definition and close the Map Manager - Map Setup

Page 55: EZConnect HowTo

How to map

55

Wizard window.

10. Click Cancel to close the interface without creating the new map.

Start mapping After successfully added new Database to EDI map, you can start mapping by following steps:

1. To open the map:

Double click on the selected map to open.

Or

Right click on the selected map and then choose Open or click Open button on the Map

Manager Toolbar. The Map Editor workspace opens.

2. To create Database to EDI mapping, simply drag and drop the appropriate columns from

source Database tree to the EDI nodes from the target EDI tree or vice versa, connecting the

data sources to the desired data output. This feature allows you to quickly create expressions,

for example, without writing any code or introducing typographical errors to the source.

Note: Typically, not all of the nodes will actually contain data, so the project author must

be sufficiently familiar with the EDI documents being worked on, to locate the relevant

nodes.

3. One of the great features of Map Editor is the synchronized source code pane allows you to

immediately see the code that EZConnect 9 has composed for you, based on the source target

relationship defined by your drag and drop mapping operations. Similarly, you can edit the

Map Editor code manually. As illustrated below, the appropriate code is generated

automatically in Code Pane window.

In addition, EZConnect 9 now supports the Toolbox panel in the left hand side of Map Editor.

The Toolbox displays icons for code macro items that you can add to Code Pane window.

Each code macro in Code Pane can be dragged and dropped into Toolbox panel or vice versa.

Each time you return to Map Editor, the Toolbox automatically scrolls to the group and item

most recently selected.

Page 56: EZConnect HowTo

How to map

56

4. To navigate through the nodes and appropriate codes that associated with them, just click on

nodes in the source pane.

For example, in the illustrative figure below, the user is clicking on an element 324 „Purchase

Order Number‟ in the Target EDI, and the appropriate code generation appears in the Code Pane

window.

Page 57: EZConnect HowTo

How to map

57

EZConnect 9 also provides tools, Query Builder (illustrated below), that lets you

create, edit, and testing the SQL statements used to define any relational database

tables and views as a customized XML data source.

Page 58: EZConnect HowTo

How to map

58

The Variable Editor is used to add, remove the defined variable associated with the

selected map.

As illustrated below, the variables are defined globally. We can access them through

Source Code Pane window with the syntax: GLOBAL.VariableName

Page 59: EZConnect HowTo

How to map

59

The Function Editor is used to create definitions of new functions associated with the

selected map. The functions are defined globally and then access them through Code Pane

window with the syntax: GLOBAL.FunctionName

The Local Translation Editor is used to translate the value. The variables are defined

globally and then access them through Source Code Pane window with the syntax:

FUNC.LocalTranslation("Value Name")

The Auto Convert Setting is used to convert the source objects to specific converted

strings. The strings are defined in Auto Convert Setting and drag and drop between source

and target tree view nodes.

Page 60: EZConnect HowTo

How to map

60

For advanced EDI mapping process, EZConnect 9 now supports Linked Elements

means that all the related segments and elements in EDI Tree can be set into relational

conditions. Relational conditions are specified by a condition code and the identity of

the subject elements. In addiction, the Load EDI From File feature allows users

browsing an EDI file (preferred the same document type) within a blank map and

EZConnect 9 will automatically check all the appropriate segments and elements.

8. Additionally, Map Editor includes a code completion feature – a pop up list of methods and/or

properties available for objects typed into the code pane. The list appears after you enter a

period for the object, signaling method or property selection. Figure below shows the available

list for the DB object.

Page 61: EZConnect HowTo

How to map

61

Tips Just type as usual in the Source Code pane and EZConnect 9 will automatically sense

what the function you are trying to type and provide a drop down box of matching functions

and their method signatures.

9. Furthermore, you can execute your newly created Database to EDI mapping to verify that it

produces the desired EDI data from your relational data. To run map, simply click the Run

Map button or press F6. The Input Parameters window opens and then choose the

appropriate TP and document to start mapping.

Page 62: EZConnect HowTo

How to map

62

Note: In order to run the map, setting up Trading Partner and Document are required.

Figures below show the compile options. Any build errors encountered are displayed in the Output

Pane window.

Page 63: EZConnect HowTo

How to map

63

10. Once you are satisfied with the results, save the map. Database to EDI data sources store both

the database connection properties you have specified, as well as the SQL statements and the

codes that you have created.

2.3.4. Setting up Document for Trading Partner

1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar.

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document “Database to EDI” by selecting Database item from the

Source Type and EDI item from Target Type to add to the Trading Partner and click Next.

Page 64: EZConnect HowTo

How to map

64

6. Highlight the map (document) to assign to this Trading Partner and click Next.

Page 65: EZConnect HowTo

How to map

65

7. In Settings panel, provide basic settings for documents.

Page 66: EZConnect HowTo

How to map

66

Fill in the appropriate EDI information in Envelop Information and GS Information

panel.

Configure advanced EDI settings including Delimiters and ST Setup.

Note: all field noted with “*” are required.

8. In Communication panel, select a communication type for your document.

Page 67: EZConnect HowTo

How to map

67

9. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The

Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 68: EZConnect HowTo

How to map

68

2.3.5. Setting up Database to EDI process

1. Open the job to add process

2. The Job workspace opens. Right-click anywhere in the Process Configuration pane, click

Add Process.

3. The Add Process window opens.

Page 69: EZConnect HowTo

How to map

69

4. Fill in the process name in Process Name field.

5. Choose the type of process “Database to EDI” by selecting Database item from the Source

Type and EDI item from Target Type.

6. Click Save on Action menu to continue process configuration.

Page 70: EZConnect HowTo

How to map

70

Note: The type selected determines the number of predefined configuration steps that will

be available when the new process is saved. Each Tab provides additional options for further

defining the process being created or modified.

7. Configure the process by clicking on each tab to fill the appropriate information.

8. Click on Save in the Action menu to save the information.

Back to How to Map

Page 71: EZConnect HowTo

How to map

71

2.4. EDI to Database

Select this map type when the data to be translated originates from an EDI formatted

document and is destined to a database.

This map type allows you visually mapping between EDI file and rational data. You can

execute your newly created EDI to Database mapping to verify that it produces the desired

rational data output from your EDI data file.

You can obtain information about an EDI format, from its associated document called

the implementation guideline. The implementation guideline is probably the only

document that you would ever need for obtaining instructions about how to process EDI

files of your trading partner. Before EDI files are exchanged, trading partners have to

agree on the EDI format and mapping. These rules and instructions are entered into the

implementation guideline document. Depending on your trading partner, the

implementation guidelines can come in many formats.

Preparation for Mapping EDI to Database

It is a requirement that a Database schema should be linked prior mapping.

The following steps must be followed to successfully complete the data mapping process:

(click on each step to see the details)

Step 1: Setting up Trading Partner

Step 2: Setting up Database Schema

Step 3: Setting up new EDI to Database map

Step 4: Setting up Document for Trading Partner

Step 5: Setting up EDI to Database process

Mapping EDI to Database

2.4.1. Setting up Trading Partner

To begin sending and receiving files with a trading partner, you must first create Trading Partner in

EZConnect. To do this, complete the following steps:

Page 72: EZConnect HowTo

How to map

72

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu

item in the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed. This is a template for all of

the trading partner information that will be entered.

3. Click Add Trading Partner button on the Trading Partner Manager Toolbar or

highlight the available Trading Partner and right mouse click on it and then choose Add

Trading Partner in drop down list.

4. The Trading Partner Information window opens.

5. Enter the important Trading Partner Information including Customer Name, Customer

Number.

6. Provide the related EDI information you want to include for the Trading Partner.

7. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

8. Enter the contact information you want to include for the Trading Partner in Contacts tab.

Page 73: EZConnect HowTo

How to map

73

9. Enter the notes information you want to include for the Trading Partner in Notes tab.

10. Click on Save button on Action Menu to save the settings.

11. Click on Close to close the Trading Partner Information window and return to Trading

Partner Manager workspace.

2.4.2. Setting up Database Schema

1. Select Schemas and then choose Database in the Toolbar or go to Schemas > Database

on Main Menu bar or click Database on Schemas section of Main Menu Tree to open

Database Connection workspace.

2. Click Add button on the Toolbar menu or right click on the database connection and

choose Add.

3. The Database Connection Interface opens

4. Fill in the database connection name in Name field.

5. In Connection Information panel, choose the appropriate DB Type. Choices are

Microsoft SQL Server, Generic ODBC (using DSN).

Page 74: EZConnect HowTo

How to map

74

Note: If the required data source was previously created for Generic (ODBC), select

it. If you do not have a data source setup, create new a data source. After completing

the data source setup, the new connection will be displayed in DSN drop down list

(Generic ODBC).

6. Enter the appropriate information associated with the database type you want to establish a

connection with a specific database on a specific server.

7. Select some desired tables and then click Save in Action menu to save changes.

8. Click Close in Action menu to close the Database Connection window and return to

Database Connection workspace.

2.4.3. Setting up new EDI to Database map

Setting up Map

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the workspace or available map type and

choose Add or click Add button on the Map Manager Toolbar.

3. The Map Manager - Map Setup Wizard window opens.

Page 75: EZConnect HowTo

How to map

75

4. In the Choose Map Type panel, select the EDI item in Source Type and the Database item in

the Target Type.

5. Click Next. The Setup Map EDI to Database Details interface opens

Page 76: EZConnect HowTo

How to map

76

6. In the Map Information, fill in the Map Name and Notes for this map type.

7. In the EDI Information, select a Standard, Version and Message ID from EDI List.

8. In the Database Information, select the database in DB Connection drop down list and click

on Test button to test connection.

Or

Click the Add New button to add new database connection. Note that this button allows

creating a new database connection but the selected tables haven't yet performed. In order to

select tables, the user must go to Database Schema to select.

9. Click Finish to save the new map definition and close the Map Manager - Map Setup

Page 77: EZConnect HowTo

How to map

77

Wizard window.

10. Click Cancel to close the interface without creating the new map.

Start mapping After successfully added new EDI to Database map, you can start mapping by following steps.

1. To open the map:

Double click on the selected map to open.

Or

Right click on the selected map and then choose Open or click Open button on the Map

Manager Toolbar. The Map Editor workspace opens.

Note: The Database tree won't list nodes if the project author doesn't choose the tables

when setting up the Database Scheme

2. To create EDI to Database mapping, simply drag and drop the EDI nodes from the source EDI

tree to the appropriate columns from target Database tree or vice versa, connecting the data

sources to the desired data output. This feature allows you to quickly create expressions, for

example, without writing any code or introducing typographical errors to the source.

Note: Typically, not all of the nodes will actually contain data, so the project author

must be sufficiently familiar with the EDI documents being worked on, to locate the

relevant nodes.

3. One of the great features of Map Editor is the synchronized source code pane allows you to

immediately see the code that EZConnect 9 has composed for you, based on the source target

relationship defined by your drag and drop mapping operations. Similarly, you can edit the

Map Editor code manually. As illustrated below, the appropriate code is generated

automatically in Code Pane window.

In addition, EZConnect 9 now supports the Toolbox panel in the left hand side of Map Editor.

The Toolbox displays icons for code macro items that you can add to Code Pane window.

Each code macro in Code Pane can be dragged and dropped into Toolbox panel or vice versa.

Each time you return to Map Editor, the Toolbox automatically scrolls to the group and item

most recently selected.

Page 78: EZConnect HowTo

How to map

78

4. To navigate through the nodes and appropriate codes that associated with them, just click on

nodes in the source pane.

For example, in the illustrative figure below, the user is clicking on an element 330

„Quantity Ordered' in the Source EDI, and the appropriate code generation appears in

the Code Pane window.

Page 79: EZConnect HowTo

How to map

79

5. EZConnect 9 also provides tools, Query Builder (illustrated below), that lets you create, edit,

and testing the SQL statements used to define any relational database tables and views as a

customized XML data source.

Page 80: EZConnect HowTo

How to map

80

The Variable Editor is used to add, remove the defined variable associated with the

selected map.

As illustrated above, the variables are defined globally. We can access them through Code

Pane window with the syntax: GLOBAL.VariableName

Page 81: EZConnect HowTo

How to map

81

The Function Editor is used to create definitions of new functions associated with the

selected map. The functions are defined globally and then access them through Code Pane

window with the syntax: GLOBAL.FunctionName

The Local Translation Editor is used to translate the value.

As illustrated below, the variables are defined globally. We can access them through

Source Code Pane window with the syntax: FUNC.LocalTranslation("Value Name")

Page 82: EZConnect HowTo

How to map

82

The Auto Convert Setting is used to convert the source objects to specific converted

strings. The strings are defined in Auto Convert Setting and drag and drop between source

and target tree view nodes.

For advanced EDI mapping process, EZConnect 9 now supports Linked Elements means

that all the related segments and elements in EDI Tree can be set into relational conditions.

Relational conditions are specified by a condition code and the identity of the subject

elements. In addiction, the Load EDI From File feature allows users browsing an EDI file

(preferred the same document type) within a blank map and EZConnect 9 will

Page 83: EZConnect HowTo

How to map

83

automatically check all the appropriate segments and elements.

6. Additionally, Map Editor includes a code completion feature – a pop up list of methods and/or

properties available for objects typed into the code pane. The list appears after you enter a

period for the object, signaling method or property selection. Figure below shows the available

list for the DB object.

Tips Just type as usual in the Source Code pane and EZConnect 9 will automatically sense

what the function you are trying to type and provide a drop down box of matching functions

Page 84: EZConnect HowTo

How to map

84

and their method signatures.

7. Furthermore, you can execute your newly created EDI to Database mapping to verify that it

produces the desired database data from your EDI data. To run map, simply click the Run

Map button or press F6. The Input Parameters window opens and then choose the

appropriate TP and document to start mapping.

Note: In order to run the map, setting up Trading Partner and Document are required.

Figures below show the compile options. Any build errors encountered are displayed in the

Output Pane window.

Page 85: EZConnect HowTo

How to map

85

8. Once you are satisfied with the results, save the map. EDI to Database data sources store both

the database connection properties you have specified, as well as the SQL statements and the

codes that you have created.

2.4.4. Setting up Document for Trading Partner

1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar.

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document “EDI to Database” by selecting EDI item from the Source

Type and Database item from Target Type to add to the Trading Partner and click Next.

Page 86: EZConnect HowTo

How to map

86

6. Highlight the map (document) to assign to this Trading Partner and click Next.

Page 87: EZConnect HowTo

How to map

87

7. In Settings panel, provide basic settings for documents

Page 88: EZConnect HowTo

How to map

88

Fill in the appropriate EDI information in Envelop Information and GS Information

panel.

Note: all field noted with “*” are required.

8. Configure for Functional Acknowledgement.

Page 89: EZConnect HowTo

How to map

89

Choose path for placing the file of Functional Acknowledgement on server or client

machine.

In the Select doc to run, select an EDI Response for Functional Acknowledgement.

9. In Communication panel, select a communication type for your document

Page 90: EZConnect HowTo

How to map

90

10. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The

Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 91: EZConnect HowTo

How to map

91

2.4.5. Setting up EDI to Database Process

1. Open the job to add process.

2. The Job workspace opens. Right-click anywhere in the Process Configuration pane, click Add Process.

3. The Add Process window opens.

Page 92: EZConnect HowTo

How to map

92

4. Fill in the process name in Process Name field.

5. Choose the type of process “EDI to Database” by selecting EDI item from the Source Type and Database item from Target Type.

6. Click Save on Action menu to continue process configuration.

Page 93: EZConnect HowTo

How to map

93

Note: The type selected determines the number of predefined configuration steps that will

be available when the new process is saved. Each Tab provides additional options for further

defining the process being created or modified.

7. Configure the process by clicking on each tab to fill the appropriate information.

8. Click on Save in the Action menu to save the information.

Back to How to Map

Page 94: EZConnect HowTo

How to map

94

2.5. Flat File to EDI

Select this map type when the data to be translated originates from a Flat File and is destined

for an EDI formatted document.

This map type allows you visually mapping between Flat File and EDI file. You can execute

your newly created Flat File to EDI mapping to verify that it produces the desired EDI data

output from your Flat File data.

You can obtain information about an EDI format, from its associated document called

the implementation guideline. The implementation guideline is probably the only

document that you would ever need for obtaining instructions about how to process EDI

files of your trading partner. Before EDI files are exchanged, trading partners have to

agree on the EDI format and mapping. These rules and instructions are entered into the

implementation guideline document. Depending on your trading partner, the

implementation guidelines can come in many formats.

Preparation for Mapping Flat File to EDI

It is a requirement that a Flat File schema should be linked prior mapping.

The following steps must be followed to successfully complete the data mapping process:

(click on each step to see the details)

Step 1: Setting up Trading Partner

Step 2: Setting up Flat File Schema

Step 3: Setting up new Flat File to EDI map

Step 4: Setting up Document for Trading Partner

Step 5: Setting up Flat File to EDI process

Mapping Flat File to EDI

2.5.1. Setting up Trading Partner

To begin sending and receiving files with a trading partner, you must first create Trading Partner in

EZConnect. To do this, complete the following steps:

Page 95: EZConnect HowTo

How to map

95

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item

in the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed. This is a template for all of the

trading partner information that will be entered.

3. Click Add Trading Partner button on the Trading Partner Manager Toolbar or highlight

the available Trading Partner and right mouse click on it and then choose Add Trading

Partner in drop down list.

4. The Trading Partner Information window opens.

5. Enter the important Trading Partner Information including Customer Name, Customer Number.

6. Provide the related EDI information you want to include for the Trading Partner.

7. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

8. Enter the contact information you want to include for the Trading Partner in Contacts tab.

Page 96: EZConnect HowTo

How to map

96

9. Enter the notes information you want to include for the Trading Partner in Notes tab.

10. Click on Save button on Action Menu to save the settings.

11. Click on Close to close the Trading Partner Information window and return to Trading

Partner Manager workspace.

2.5.2. Setting up Flat File Schema

1. Select Schemas and then choose Flat File in the Toolbar or go to Schemas > Flat File on

Main Menu Bar or click Flat File on Schemas section of Main Menu Tree to open Flat File

Schemas workspace.

2. Click Add button on the Toolbar or right mouse click on Flat File Schemas workspace and

then choose Add.

3. The Add New Flat File Interface opens.

4. Fill in the schema name in the Schema Name field.

5. Fill in the Notes.

6. Click on Save in Action menu to save changes.

Page 97: EZConnect HowTo

How to map

97

2.5.3. Setting up new Flat File to EDI map

Setting up Map

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the workspace or available map type and

choose Add or click Add button on the Map Manager Toolbar.

3. The Map Manager - Map Setup Wizard window opens.

4. In the Choose Map Type panel, select the Flat File item in Source Type and the EDI item in

Page 98: EZConnect HowTo

How to map

98

the Target Type.

5. Click Next. The Setup Map Flat File to EDI Details interface opens.

6. In the Map Information, fill in the Map Name and Notes for this map type.

7. In the Flat File Information, select a Flat File schema from the Flat File Schemas List.

8. In the EDI Information, select a Standard, Version and Message ID from EDI List.

9. Click Finish to save the new map definition and close the Map Manager - Map Setup

Wizard window.

10. Click Cancel to close the interface without creating the new map.

Page 99: EZConnect HowTo

How to map

99

Start mapping After successfully added new Flat File to EDI map, you can start mapping by following steps:

1. To open the map:

Double click on the selected map to open.

Or

Right click on the selected map and then choose Open or click Open button on the Map

Manager Toolbar. The Map Editor workspace opens.

2. To create Flat File to EDI mapping, simply drag and drop the Flat File nodes from the source

Flat File tree to the EDI nodes from the target EDI tree or vice versa, connecting the data

sources to the desired data output. This feature allows you to quickly create expressions, for

example, without writing any code or introducing typographical errors to the source.

Note: Typically, not all of the nodes will actually contain data, so the project author must

be sufficiently familiar with the EDI documents being worked on, to locate the relevant nodes.

3. One of the great features of Map Editor is the synchronized source code pane allows you to

immediately see the code that EZConnect 9 has composed for you, based on the source target

relationship defined by your drag and drop mapping operations. Similarly, you can edit the

Map Editor code manually. As illustrated below, the appropriate code is generated

automatically in Code Pane window.

In addition, EZConnect 9 now supports the Toolbox panel in the left hand side of Map Editor.

The Toolbox displays icons for code macro items that you can add to Code Pane window.

Each code macro in Code Pane can be dragged and dropped into Toolbox panel or vice versa.

Each time you return to Map Editor, the Toolbox automatically scrolls to the group and item

most recently selected.

Page 100: EZConnect HowTo

How to map

100

4. To navigate through the nodes and appropriate codes that associated with them, just click on

nodes in the source pane.

For example, in the illustrative figure below, the user is clicking on an element 324 „Purchase

Order Number‟ in the Target EDI, and the appropriate code generation appears in the Code

Pane window.

Page 101: EZConnect HowTo

How to map

101

5. EZConnect 9 also provides tools, the Variable Editor is used to add, remove the defined

variable associated with the selected map.

As illustrated below, the variables are defined globally. We can access them through Source

Code Pane window with the syntax:

GLOBAL.VariableName

Page 102: EZConnect HowTo

How to map

102

The Function Editor is used to create definitions of new functions associated with the selected

map. The functions are defined globally and then access them through Code Pane window

with the syntax: GLOBAL.FunctionName

The Local Translation Editor is used to translate the value. The variables are defined globally

and then access them through Source Code Pane window with the syntax:

FUNC.LocalTranslation("Value Name")

The Auto Convert Setting is used to convert the source objects to specific converted strings.

The strings are defined in Auto Convert Setting and drag and drop between source and target

tree view nodes.

For advanced EDI mapping process, EZConnect 9 now supports Linked Elements means that

all the related segments and elements in EDI Tree can be set into relational conditions.

Relational conditions are specified by a condition code and the identity of the subject elements.

In addiction, the Load EDI From File feature allows users browsing an EDI file (preferred the

same document type) within a blank map and EZConnect 9 will automatically check all the

appropriate segments and elements.

6. Additionally, Map Editor includes a code completion feature – a pop up list of methods and/or

properties available for objects typed into the code pane. The list appears after you enter a

period for the object, signaling method or property selection. Figure below shows the available

list for the FF object.

Page 103: EZConnect HowTo

How to map

103

Tips Just type as usual in the Source Code pane and EZConnect 9 will automatically sense

what the function you are trying to type and provide a drop down box of matching functions

and their method signatures.

7. Furthermore, you can execute your newly created Flat File to EDI mapping to verify that it

produces the desired EDI data from your relational data. To run map, simply click the Run

Map button or press F6. The Input Parameters window opens and then choose the

appropriate TP and document to start mapping.

Note: In order to run the map, setting up Trading Partner and Document are required.

Page 104: EZConnect HowTo

How to map

104

Figures below show the compile options. Any build errors encountered are displayed in the

Output Pane window.

Page 105: EZConnect HowTo

How to map

105

Page 106: EZConnect HowTo

How to map

106

8. Once you are satisfied with the results, save the map. Flat File to EDI data sources store both

the database connection properties you have specified, as well as the SQL statements and the

codes that you have created.

2.5.4. Setting up Document for Trading Partner

1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar. <Show Figure>

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document “Flat File to EDI” by selecting Flat File item from the Source

Page 107: EZConnect HowTo

How to map

107

Type and EDI item from Target Type to add to the Trading Partner and click Next.

6. Highlight the map (document) to assign to this Trading Partner and click Next.

Page 108: EZConnect HowTo

How to map

108

7. In Settings panel, provide basic settings for documents:

· Choose appropriate Cust Number Path and Doc Type Path by selecting the node to fill in

the Cust Number Path and Doc Type Path text box.

Page 109: EZConnect HowTo

How to map

109

Fill in the Flat File prefix.

Enter file count number in File Count scroll control.

8. Fill in the appropriate EDI information in Envelop Information and GS Information panel

Page 110: EZConnect HowTo

How to map

110

9. Configure advanced EDI settings including Delimiters and ST Setup.

Page 111: EZConnect HowTo

How to map

111

Note: all field noted with “*” are required.

10. In Communication panel, select a communication type for your document

Page 112: EZConnect HowTo

How to map

112

11. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The

Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 113: EZConnect HowTo

How to map

113

2.5.5. Setting up Flat File to EDI process

1. Open the job to add process.

2. The Job workspace opens. Right-click anywhere in the Process Configuration pane, click

Add Process.

3. The Add Process window opens.

Page 114: EZConnect HowTo

How to map

114

4. Fill in the process name in Process Name field.

5. Choose the type of process “Flat File to EDI” by selecting Flat File item from the Source

Type and EDI item from Target Type.

6. Click Save on Action menu to continue process configuration.

Page 115: EZConnect HowTo

How to map

115

Note: The type selected determines the number of predefined configuration steps that will

be available when the new process is saved. Each Tab provides additional options for further

defining the process being created or modified.

7. Configure the process by clicking on each tab to fill the appropriate information.

8. Click on Save in the Action menu to save the information.

Back to How to Map

Page 116: EZConnect HowTo

How to map

116

2.6. EDI to Flat File

Select this map type when the data to be translated originates from an EDI formatted

document and is destined for a Flat File.

This map type allows you visually mapping between EDI file and Flat File. You can execute

your newly created EDI to Flat File mapping to verify that it produces the desired Flat File

data output from your EDI data file.

You can obtain information about an EDI format, from its associated document called

the implementation guideline. The implementation guideline is probably the only

document that you would ever need for obtaining instructions about how to process EDI

files of your trading partner. Before EDI files are exchanged, trading partners have to

agree on the EDI format and mapping. These rules and instructions are entered into the

implementation guideline document. Depending on your trading partner, the

implementation guidelines can come in many formats.

Preparation for Mapping EDI to Flat File

It is a requirement that a Flat File schema should be linked prior mapping.

The following steps must be followed to successfully complete the data mapping process:

(click on each step to see the details)

Step 1: Setting up Trading Partner

Step 2: Setting up Flat File Schema

Step 3: Setting up new EDI to Flat File map

Step 4: Setting up Document for Trading Partner

Step 5: Setting up EDI to Flat File process

Mapping EDI to Flat File

2.6.1. Setting up Trading Partner

To begin sending and receiving files with a trading partner, you must first create Trading Partner in

EZConnect. To do this, complete the following steps:

Page 117: EZConnect HowTo

How to map

117

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item

in the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed. This is a template for all of the

trading partner information that will be entered.

3. Click Add Trading Partner button on the Trading Partner Manager Toolbar or highlight

the available Trading Partner and right mouse click on it and then choose Add Trading

Partner in drop down list.

4. The Trading Partner Information window opens.

5. Enter the important Trading Partner Information including Customer Name, Customer

Number.

6. Provide the related EDI information you want to include for the Trading Partner.

7. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

8. Enter the contact information you want to include for the Trading Partner in Contacts tab.

Page 118: EZConnect HowTo

How to map

118

9. Enter the notes information you want to include for the Trading Partner in Notes tab.

10. Click on Save button on Action Menu to save the settings.

11. Click on Close to close the Trading Partner Information window and return to Trading

Partner Manager workspace.

2.6.2. Setting up Flat File Schema

1. Select Schemas and then choose Flat File in the Toolbar or go to Schemas > Flat File on

Main Menu Bar or click Flat File on Schemas section of Main Menu Tree to open Flat File

Schemas workspace.

2. Click Add button on the Toolbar or right mouse click on Flat File Schemas workspace and

then choose Add.

3. The Add New Flat File Interface opens.

4. Fill in the schema name in the Schema Name field.

5. Fill in the Notes.

6. Click on Save in Action menu to save changes.

Page 119: EZConnect HowTo

How to map

119

2.6.3. Setting up new EDI to Flat File map

Setting up map

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the workspace or available map type and

choose Add or click Add button on the Map Manager Toolbar.

3. The Map Manager - Map Setup Wizard window opens.

4. In the Choose Map Type panel, select the EDI item in Source Type and the Flat File item in

Page 120: EZConnect HowTo

How to map

120

the Target Type.

5. Click Next. The Setup Map EDI to Flat File Details interface opens.

6. In the Map Information, fill in the Map Name and Notes for this map type.

7. In the EDI Information, select a Standard, Version and Message ID from EDI List.

8. In the Flat File Information, select a Flat File schema from the Flat File Schemas List.

9. Click Finish to save the new map definition and close the Map Manager - Map Setup

Wizard window.

10. Click Cancel to close the interface without creating the new map.

Page 121: EZConnect HowTo

How to map

121

Start mapping After successfully added new EDI to Flat File map, you can start mapping by following steps:

1. To open the map:

Double click on the selected map to open.

Or

Right click on the selected map and then choose Open or click Open button on the Map

Manager Toolbar. The Map Editor workspace opens.

2. To create EDI to Flat File mapping, simply drag and drop the EDI nodes from the source EDI

tree to the Flat File nodes from the target Flat File tree or vice versa, connecting the data

sources to the desired data output. This feature allows you to quickly create expressions, for

example, without writing any code or introducing typographical errors to the source.

Note: Typically, not all of the nodes will actually contain data, so the project author must

be sufficiently familiar with the EDI documents being worked on, to locate the relevant nodes.

3. One of the great features of Map Editor is the synchronized source code pane allows you to

immediately see the code that EZConnect 9 has composed for you, based on the source target

relationship defined by your drag and drop mapping operations. Similarly, you can edit the

Map Editor code manually. As illustrated below, the appropriate code is generated

automatically in Code Pane window.

In addition, EZConnect 9 now supports the Toolbox panel in the left hand side of Map Editor.

The Toolbox displays icons for code macro items that you can add to Code Pane window.

Each code macro in Code Pane can be dragged and dropped into Toolbox panel or vice versa.

Each time you return to Map Editor, the Toolbox automatically scrolls to the group and item

most recently selected.

Page 122: EZConnect HowTo

How to map

122

4. To navigate through the nodes and appropriate codes that associated with them, just click on

nodes in the source pane.

For example, in the illustrative figure below, the user is clicking on an element 324 „Purchase

Order Number‟ in the Target EDI, and the appropriate code generation appears in the Code

Pane window.

Page 123: EZConnect HowTo

How to map

123

5. EZConnect 9 also provides tools, the Variable Editor is used to add, remove the defined

variable associated with the selected map.

As illustrated below, the variables are defined globally. We can access them through Source

Code Pane window with the syntax: GLOBAL.VariableName

Page 124: EZConnect HowTo

How to map

124

The Function Editor is used to create definitions of new functions associated with the selected

map. The functions are defined globally and then access them through Code Pane window

with the syntax: GLOBAL.FunctionName

Page 125: EZConnect HowTo

How to map

125

The Local Translation Editor is used to translate the value. The variables are defined globally

and then access them through Source Code Pane window with the syntax:

FUNC.LocalTranslation("Value Name")

The Auto Convert Setting is used to convert the source objects to specific converted strings.

The strings are defined in Auto Convert Setting and drag and drop between source and target

tree view nodes.

For advanced EDI mapping process, EZConnect 9 now supports Linked Elements means that

all the related segments and elements in EDI Tree can be set into relational conditions.

Relational conditions are specified by a condition code and the identity of the subject elements.

In addiction, the Load EDI From File feature allows users browsing an EDI file (preferred the

same document type) within a blank map and EZConnect 9 will automatically check all the

appropriate segments and elements.

6. Additionally, Map Editor includes a code completion feature – a pop up list of methods and/or

properties available for objects typed into the code pane. The list appears after you enter a

period for the object, signaling method or property selection. Figure below shows the available

list for the EDI object.

Page 126: EZConnect HowTo

How to map

126

Tips Just type as usual in the Source Code pane and EZConnect 9 will automatically sense

what the function you are trying to type and provide a drop down box of matching functions

and their method signatures.

7. Furthermore, you can execute your newly created EDI to Flat File mapping to verify that it

produces the desired Flat File data from your EDI data. To run map, simply click the Run Map

button or press F6. The Input Parameters window opens and then choose the appropriate TP

and document to start mapping.

Page 127: EZConnect HowTo

How to map

127

Note: In order to run the map, setting up Trading Partner and Document are required.

Figures below show the compile options. Any build errors encountered are displayed in the

Output Pane window.

Page 128: EZConnect HowTo

How to map

128

Page 129: EZConnect HowTo

How to map

129

Page 130: EZConnect HowTo

How to map

130

Once you are satisfied with the results, save the map. EDI to Flat File data sources store both the

mapping properties you have specified, as well as the codes that you have created.

2.6.4. Setting up Document for Trading Partner

1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar.

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document “EDI to Flat File” by selecting EDI item from the Source

Type and Flat File item from Target Type to add to the Trading Partner and click Next.

Page 131: EZConnect HowTo

How to map

131

6. Highlight the map (document) to assign to this Trading Partner and click Next.

Page 132: EZConnect HowTo

How to map

132

7. In Settings panel, provide basic settings for documents:

Fill in the appropriate EDI information in Envelop Information and GS Information

panel.

Page 133: EZConnect HowTo

How to map

133

Choose appropriate File Extension drop down list. Available choices are .txt, .doc, .rtf and

.xml.

Fill in the Flat File prefix.

Enter file count number in File Count scroll control.

Enter the maximum number transaction sets per file in Max ST/File scroll control.

Page 134: EZConnect HowTo

How to map

134

Note: all field noted with “*” are required.

8. Configure for Functional Acknowledgement.

Page 135: EZConnect HowTo

How to map

135

Choose path for placing the file of Functional Acknowledgement on server or client

machine.

In the Select doc to run, select an EDI Response for Functional Acknowledgement.

9. In Communication panel, select a communication type for your document

Page 136: EZConnect HowTo

How to map

136

10. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The

Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 137: EZConnect HowTo

How to map

137

2.6.5. Setting up EDI to Flat File Process

1. Open the job to add process.

2. The Job workspace opens. Right-click anywhere in the Process Configuration pane, click

Add Process.

3. The Add Process window opens.

Page 138: EZConnect HowTo

How to map

138

4. Fill in the process name in Process Name field.

5. Choose the type of process “EDI to Flat File” by selecting EDI item from the Source Type and Flat File item from Target Type.

6. Click Save on Action menu to continue process configuration.

Page 139: EZConnect HowTo

How to map

139

Note: The type selected determines the number of predefined configuration steps that will

be available when the new process is saved. Each Tab provides additional options for further

defining the process being created or modified.

7. Configure the process by clicking on each tab to fill the appropriate information.

8. Click on Save in the Action menu to save the information.

Back to How to Map

Page 140: EZConnect HowTo

How to map

140

2.7. XML to EDI

Select this map type when the data to be translated originates from a XML file and is destined

for an EDI formatted document.

This map type allows you visually mapping between XML file and EDI file. You can execute

your newly created XML to EDI mapping to verify that it produces the desired EDI data

output from your XML data file.

You can obtain information about an EDI format, from its associated document called

the implementation guideline. The implementation guideline is probably the only

document that you would ever need for obtaining instructions about how to process EDI

files of your trading partner. Before EDI files are exchanged, trading partners have to

agree on the EDI format and mapping. These rules and instructions are entered into the

implementation guideline document. Depending on your trading partner, the

implementation guidelines can come in many formats.

Preparation for Mapping XML to EDI

It is a requirement that a XML schema should be linked prior mapping.

The following steps must be followed to successfully complete the data mapping process:

(click on each step to see the details)

Step 1: Setting up Trading Partner

Step 2: Setting up XML Schema

Step 3: Setting up new XML to EDI map

Step 4: Setting up Document for Trading Partner

Step 5: Setting up XML to EDI process

Mapping XML to EDI

2.7.1. Setting up Trading Partner

To begin sending and receiving files with a trading partner, you must first create Trading Partner in

EZConnect. To do this, complete the following steps:

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item

Page 141: EZConnect HowTo

How to map

141

in the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed. This is a template for all of the

trading partner information that will be entered.

3. Click Add Trading Partner button on the Trading Partner Manager Toolbar or highlight

the available Trading Partner and right mouse click on it and then choose Add Trading

Partner in drop down list.

4. The Trading Partner Information window opens.

5. Enter the important Trading Partner Information including Customer Name, Customer

Number.

6. Provide the related EDI information you want to include for the Trading Partner.

7. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

8. Enter the contact information you want to include for the Trading Partner in Contacts tab.

9. Enter the notes information you want to include for the Trading Partner in Notes tab.

Page 142: EZConnect HowTo

How to map

142

10. Click on Save button on Action Menu to save the settings.

11. Click on Close to close the Trading Partner Information window and return to Trading

Partner Manager workspace.

2.7.2. Setting up XML Schema

1. Select Schemas and then choose XML in the Toolbar or go to Schemas > XML on Main

Menu Bar or click XML on Schemas section of Main Menu Tree to open XML Schemas

workspace.

2. Click Import button on the Toolbar or right mouse click on XML Schemas workspace and

then choose Import.

3. The Import XML Schema window opens.

4. Fill in the schema name in Schema Name field.

5. In Schema file field, browser and choose the appropriate XML schema.

6. Fill in the Note.

7. Click on Save in Action menu to save changes.

Page 143: EZConnect HowTo

How to map

143

2.7.3. Setting up new XML to EDI map

Setting up map

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the workspace or available map type and

choose Add or click Add button on the Map Manager Toolbar.

3. The Map Manager - Map Setup Wizard window opens.

4. In the Choose Map Type panel, select the XML item in Source Type and the EDI item in the

Page 144: EZConnect HowTo

How to map

144

Target Type.

5. Click Next. The Setup Map XML to EDI Details interface opens.

6. In the Map Information, fill in the Map Name and Notes for this map type.

7. In the Schema Information, select a XML schema from the XML Schemas List.

8. In the EDI Information, select a Standard, Version and Message ID from EDI List.

9. Click Finish to save the new map definition and close the Map Manager - Map Setup

Wizard window.

10. Click Cancel to close the interface without creating the new map.

Page 145: EZConnect HowTo

How to map

145

Start mapping

After successfully added new XML to EDI map, you can start mapping by following steps:

1. To open the map:

Double click on the selected map to open.

Or

Right click on the selected map and then choose Open or click Open button on the Map

Manager Toolbar. The Map Editor workspace opens.

2. To create XML to EDI mapping, simply drag and drop the XML nodes from the source XML

tree to the EDI nodes from the target EDI tree or vice versa, connecting the data sources to the

desired data output. This feature allows you to quickly create expressions, for example, without

writing any code or introducing typographical errors to the source.

Note: Typically, not all of the nodes will actually contain data, so the project author must

be sufficiently familiar with the EDI documents being worked on, to locate the relevant nodes.

3. One of the great features of Map Editor is the synchronized source code pane allows you to

immediately see the code that EZConnect 9 has composed for you, based on the source target

relationship defined by your drag and drop mapping operations. Similarly, you can edit the

Map Editor code manually. As illustrated below, the appropriate code is generated

automatically in Code Pane window.

In addition, EZConnect 9 now supports the Toolbox panel in the left hand side of Map Editor.

The Toolbox displays icons for code macro items that you can add to Code Pane window.

Each code macro in Code Pane can be dragged and dropped into Toolbox panel or vice versa.

Each time you return to Map Editor, the Toolbox automatically scrolls to the group and item

most recently selected.

Page 146: EZConnect HowTo

How to map

146

4. To navigate through the nodes and appropriate codes that associated with them, just click on

nodes in the source pane.

For example, in the illustrative figure below, the user is clicking on an element 234

„Product/Service ID‟ in the Target EDI, and the appropriate code generation appears in the

Code Pane window.

Page 147: EZConnect HowTo

How to map

147

5. EZConnect 9 also provides tools, the Variable Editor is used to add, remove the defined

variable associated with the selected map.

As illustrated below, the variables are defined globally. We can access them through Source

Code Pane window with the syntax: GLOBAL.VariableName

Page 148: EZConnect HowTo

How to map

148

The Function Editor is used to create definitions of new functions associated with the selected

map. The functions are defined globally and then access them through Code Pane window

with the syntax: GLOBAL.FunctionName

The Local Translation Editor is used to translate the value. The variables are defined globally

and then access them through Source Code Pane window with the syntax:

FUNC.LocalTranslation("Value Name")

Page 149: EZConnect HowTo

How to map

149

The Auto Convert Setting is used to convert the source objects to specific converted strings.

The strings are defined in Auto Convert Setting and drag and drop between source and target

tree view nodes.

For advanced EDI mapping process, EZConnect 9 now supports Linked Elements means that

all the related segments and elements in EDI Tree can be set into relational conditions.

Relational conditions are specified by a condition code and the identity of the subject elements.

In addiction, the Load EDI From File feature allows users browsing an EDI file (preferred the

same document type) within a blank map and EZConnect 9 will automatically check all the

appropriate segments and elements.

6. Additionally, Map Editor includes a code completion feature – a pop up list of methods and/or

properties available for objects typed into the code pane. The list appears after you enter a

period for the object, signaling method or property selection. Figure below shows the available

list for the XML object.

Tips Just type as usual in the Source Code pane and EZConnect 9 will automatically sense

what the function you are trying to type and provide a drop down box of matching functions

and their method signatures.

Page 150: EZConnect HowTo

How to map

150

7. Furthermore, you can execute your newly created XML to EDI mapping to verify that it

produces the desired EDI data from your XML data. To run map, simply click the Run Map

button or press F6. The Input Parameters window opens and then choose the appropriate TP

and document to start mapping.

Note: In order to run the map, setting up Trading Partner and Document are required.

Figures below show the compile options. Any build errors encountered are displayed in the

Output Pane window.

Page 151: EZConnect HowTo

How to map

151

Page 152: EZConnect HowTo

How to map

152

Page 153: EZConnect HowTo

How to map

153

Once you are satisfied with the results, save the map. XML to EDI data sources store both the

mapping properties you have specified, as well as the codes that you have created.

2.7.4. Setting up Document for Trading Partner

1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar.

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document “XML to EDI” by selecting XML item from the Source Type

and EDI item from Target Type to add to the Trading Partner and click Next. <Show

Figure>

Page 154: EZConnect HowTo

How to map

154

6. Highlight the map (document) to assign to this Trading Partner and click Next.

Page 155: EZConnect HowTo

How to map

155

7. In Settings panel, provide basic settings for documents:

Page 156: EZConnect HowTo

How to map

156

Choose the appropriate Cust Number XPath and Doc Type XPath by selecting the

node to fill in the Cust Number XPath and Doc Type XPath text box or set Input

File Information.

Fill in the XML file prefix.

Fill in the appropriate EDI information in Envelop Information and GS Information

panel.

Page 157: EZConnect HowTo

How to map

157

8. Configure advanced EDI settings including Delimiters and ST Setup.

Page 158: EZConnect HowTo

How to map

158

Note: all field noted with “*” are required.

9. In Communication panel, select a communication type for your document.

Page 159: EZConnect HowTo

How to map

159

10. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The

Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 160: EZConnect HowTo

How to map

160

2.7.5. Setting up XML to EDI Process

1. Open the job to add process.

2. Job workspace opens. Right-click anywhere in the Process Configuration pane, click Add

Process.

3. The Add Process window opens.

Page 161: EZConnect HowTo

How to map

161

4. Fill in the process name in Process Name field.

5. Choose the type of process “XML to EDI” by selecting XML item from the Source Type and EDI item from Target Type.

6. Click Save on Action menu to continue process configuration.

Page 162: EZConnect HowTo

How to map

162

Note: The type selected determines the number of predefined configuration steps that will

be available when the new process is saved. Each Tab provides additional options for further

defining the process being created or modified.

7. Configure the process by clicking on each tab to fill the appropriate information.

8. Click on Save in the Action menu to save the information.

Back to How to Map

Page 163: EZConnect HowTo

How to map

163

2.8. EDI to XML

Select this map type when the data to be translated originates from a EDI formatted document

and is destined for a XML file.

This map type allows you visually mapping between EDI file and XML file. You can execute

your newly created EDI to XML mapping to verify that it produces the desired XML data

output from your EDI data file.

You can obtain information about an EDI format, from its associated document

called the implementation guideline. The implementation guideline is probably

the only document that you would ever need for obtaining instructions about

how to process EDI files of your trading partner. Before EDI files are

exchanged, trading partners have to agree on the EDI format and mapping.

These rules and instructions are entered into the implementation guideline

document. Depending on your trading partner, the implementation guidelines

can come in many formats.

Preparation for Mapping EDI to XML

It is a requirement that a XML schema should be linked prior mapping.

The following steps must be followed to successfully complete the data mapping process:

(click on each step to see the details)

Step 1: Setting up Trading Partner

Step 2: Setting up XML Schema

Step 3: Setting up new EDI to XML map

Step 4: Setting up Document for Trading Partner

Step 5: Setting up EDI to XML process

Mapping EDI to XML

2.8.1. Setting up Trading Partner

To begin sending and receiving files with a trading partner, you must first create Trading Partner in

EZConnect. To do this, complete the following steps:

Page 164: EZConnect HowTo

How to map

164

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item in

the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed. This is a template for all of the

trading partner information that will be entered.

3. Click Add Trading Partner button on the Trading Partner Manager Toolbar or highlight the

available Trading Partner and right mouse click on it and then choose Add Trading Partner in

drop down list.

4. The Trading Partner Information window opens

5. Enter the important Trading Partner Information including Customer Name, Customer Number.

6. Provide the related EDI information you want to include for the Trading Partner.

7. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

8. Enter the contact information you want to include for the Trading Partner in Contacts tab.

Page 165: EZConnect HowTo

How to map

165

9. Enter the notes information you want to include for the Trading Partner in Notes tab.

10. Click on Save button on Action Menu to save the settings.

11. Click on Close to close the Trading Partner Information window and return to Trading

Partner Manager workspace.

2.8.2. Setting up XML Schema

1. Select Schemas and then choose XML in the Toolbar or go to Schemas > XML on Main

Menu Bar or click XML on Schemas section of Main Menu Tree to open XML Schemas

workspace.

2. Click Import button on the Toolbar or right mouse click on XML Schemas workspace and then

choose Import.

3. The Import XML Schema window opens.

4. Fill in the schema name in Schema Name field.

5. In Schema file field, browser and choose the appropriate XML schema.

6. Fill in the Note.

7. Click on Save in Action menu to save changes.

Page 166: EZConnect HowTo

How to map

166

2.8.3. Setting up new EDI to XML map

Setting up map

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the workspace or available map type and choose

Add or click Add button on the Map Manager Toolbar.

3. The Map Manager - Map Setup Wizard window opens.

4. In the Choose Map Type panel, select the EDI item in Source Type and the XML item in the

Page 167: EZConnect HowTo

How to map

167

Target Type.

5. Click Next. The Setup Map EDI to XML Details interface opens.

6. In the Map Information, fill in the Map Name and Notes for this map type.

7. In the EDI Information, select a Standard, Version and Message ID from EDI List.

8. In the Schema Information, select a XML schema from the XML Schemas List.

9. Click Finish to save the new map definition and close the Map Manager - Map Setup Wizard

window.

10. Click Cancel to close the interface without creating the new map.

Page 168: EZConnect HowTo

How to map

168

Start mapping After successfully added new EDI to XML map, you can start mapping by following steps:

1. To open the map:

Double click on the selected map to open.

Or

Right click on the selected map and then choose Open or click Open button on the Map

Manager Toolbar. The Map Editor workspace opens.

2. To create EDI to XML mapping, simply drag and drop the EDI nodes from the source EDI tree

to the XML nodes from the target XML tree or vice versa, connecting the data sources to the

desired data output. This feature allows you to quickly create expressions, for example, without

writing any code or introducing typographical errors to the source.

Note: Typically, not all of the nodes will actually contain data, so the project author must be

sufficiently familiar with the EDI documents being worked on, to locate the relevant nodes.

3. One of the great features of Map Editor is the synchronized source code pane allows you to

immediately see the code that EZConnect 9 has composed for you, based on the source target

relationship defined by your drag and drop mapping operations. Similarly, you can edit the Map

Editor code manually. As illustrated below, the appropriate code is generated automatically in

Code Pane window.

In addition, EZConnect 9 now supports the Toolbox panel in the left hand side of Map Editor.

The Toolbox displays icons for code macro items that you can add to Code Pane window. Each

code macro in Code Pane can be dragged and dropped into Toolbox panel or vice versa. Each

time you return to Map Editor, the Toolbox automatically scrolls to the group and item most

recently selected.

Page 169: EZConnect HowTo

How to map

169

4. To navigate through the nodes and appropriate codes that associated with them, just click on

nodes in the source pane.

For example, in the illustrative figure below, the user is clicking on an element

„CATALOG_NO‟ in the Target XML, and the appropriate code generation appears in the Code

Pane window.

Page 170: EZConnect HowTo

How to map

170

5. EZConnect 9 also provides tools, the Variable Editor is used to add, remove the defined

variable associated with the selected map.

As illustrated below, the variables are defined globally. We can access them through Source

Code Pane window with the syntax: GLOBAL.VariableName

Page 171: EZConnect HowTo

How to map

171

The Function Editor is used to create definitions of new functions associated with the

selected map. The functions are defined globally and then access them through Code Pane

window with the syntax: GLOBAL.FunctionName

The Local Translation Editor is used to translate the value. The variables are defined

globally and then access them through Source Code Pane window with the syntax:

FUNC.LocalTranslation("Value Name")

Page 172: EZConnect HowTo

How to map

172

The Auto Convert Setting is used to convert the source objects to specific converted strings.

The strings are defined in Auto Convert Setting and drag and drop between source and target tree

view nodes.

For advanced EDI mapping process, EZConnect 9 now supports Linked Elements means that all

the related segments and elements in EDI Tree can be set into relational conditions. Relational

conditions are specified by a condition code and the identity of the subject elements. In addiction,

the Load EDI From File feature allows users browsing an EDI file (preferred the same

document type) within a blank map and EZConnect 9 will automatically check all the appropriate

segments and elements.

6. Additionally, Map Editor includes a code completion feature – a pop up list of methods and/or

properties available for objects typed into the code pane. The list appears after you enter a period

for the object, signaling method or property selection. Figure below shows the available list for

the EDI object.

Tips Just type as usual in the Source Code pane and EZConnect 9 will automatically sense

what the function you are trying to type and provide a drop down box of matching functions and

their method signatures.

7. Furthermore, you can execute your newly created EDI to XML mapping to verify that it

produces the desired XML data from your relational data. To run map, simply click the Run

Page 173: EZConnect HowTo

How to map

173

Map button or press F6. The Input Parameters window opens and then choose the appropriate

TP and document to start mapping.

Note: In order to run the map, setting up Trading Partner and Document are required.

Figures below show the compile options. Any build errors encountered are displayed in the

Output Pane window.

Page 174: EZConnect HowTo

How to map

174

Page 175: EZConnect HowTo

How to map

175

Page 176: EZConnect HowTo

How to map

176

Once you are satisfied with the results, save the map. EDI to XML data sources store both the

database connection properties you have specified, as well as the SQL statements and the codes that

you have created.

2.8.4. Setting up Document for Trading Partner

1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar.

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document “EDI to XML” by selecting EDI item from the Source Type and

XML item from Target Type to add to the Trading Partner and click Next.

Page 177: EZConnect HowTo

How to map

177

6. Highlight the map (document) to assign to this Trading Partner and click Next.

Page 178: EZConnect HowTo

How to map

178

7. In Settings panel, provide basic settings for documents:

Fill in the appropriate EDI information in Envelop Information and GS Information

panel.

Page 179: EZConnect HowTo

How to map

179

Choose appropriate File Extension drop down list. Available choices are .txt, .doc, .rtf

and .xml.

Enter File Count number.

Fill in the XML File prefix.

Note: all field noted with “*” are required.

8. Configure for Functional Acknowledgement.

Page 180: EZConnect HowTo

How to map

180

Choose path for placing the file of Functional Acknowledgement on server or client machine.

In the Select doc to run, select an EDI Response for Functional Acknowledgement.

9. In Communication panel, select a communication type for your document.

Page 181: EZConnect HowTo

How to map

181

10. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The

Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 182: EZConnect HowTo

How to map

182

2.8.5. Setting up EDI to XML Process

1. Open the job to add process.

2. The Job workspace opens. Right-click anywhere in the Process Configuration pane, click Add

Process.

3. The Add Process window opens.

Page 183: EZConnect HowTo

How to map

183

4. Fill in the process name in Process Name field.

5. Choose the type of process “EDI to XML” by selecting EDI item from the Source Type and XML item from Target Type.

6. Click Save on Action menu to continue process configuration.

Page 184: EZConnect HowTo

How to map

184

Note: The type selected determines the number of predefined configuration steps that will be

available when the new process is saved. Each Tab provides additional options for further

defining the process being created or modified.

7. Configure the process by clicking on each tab to fill the appropriate information.

8. Click on Save in the Action menu to save the information.

2.9. XML to XML

Select this map type when the data to be translated originates from a XML file and is destined

for other XML formatted document.

This map type allows you visually mapping between XML files. You can execute your newly

created XML to XML mapping to verify that it produces the desired other XML data output

from your XML data file.

Preparation for Mapping EDI to XML

It is a requirement that a XML schema should be linked prior mapping.

Page 185: EZConnect HowTo

How to map

185

The following steps must be followed to successfully complete the data mapping process:

(click on each step to see the details)

Step 1: Setting up Trading Partner

Step 2: Setting up XML Schema

Step 3: Setting up new XML to XML map

Step 4: Setting up Document for Trading Partner

Step 5: Setting up XML to XML process

Mapping XML to XML

2.9.1. Setting up Trading Partner

To begin sending and receiving files with a trading partner, you must first create Trading Partner in

EZConnect. To do this, complete the following steps:

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item in the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed. This is a template for all of the

trading partner information that will be entered.

3. Click Add Trading Partner button on the Trading Partner Manager Toolbar or highlight the

available Trading Partner and right mouse click on it and then choose Add Trading Partner in drop down list.

4. The Trading Partner Information window opens.

Page 186: EZConnect HowTo

How to map

186

5. Enter the important Trading Partner Information including Customer Name, Customer Number.

6. Provide the related EDI information you want to include for the Trading Partner.

7. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

8. Enter the contact information you want to include for the Trading Partner in Contacts tab.

9. Enter the notes information you want to include for the Trading Partner in Notes tab.

10. Click on Save button on Action Menu to save the settings.

11. Click on Close to close the Trading Partner Information window and return to Trading

Partner Manager workspace.

2.9.2. Setting up XML Schema

1. Select Schemas and then choose XML in the Toolbar or go to Schemas > XML on Main

Menu Bar or click XML on Schemas section of Main Menu Tree to open XML Schemas

workspace.

2. Click Import button on the Toolbar or right-click anywhere in the XML Schemas workspace, then click Import.

3. The Import XML Schema window opens.

Page 187: EZConnect HowTo

How to map

187

4. Fill in the schema name in Schema Name field.

5. In Schema file field, browser and choose the appropriate XML schema.

6. Fill in the Note.

7. Click on Save in Action menu to save changes.

2.9.3. Setting up new XML to XML map

Setting up Map

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager workspace.

2. From Map Manager workspace, right click on the workspace or available map type and choose Add or click Add button on the Map Manager Toolbar.

3. The Map Manager - Map Setup Wizard window opens.

Page 188: EZConnect HowTo

How to map

188

4. In the Choose Map Type panel, select the XML item in Source Type and the XML item in the

Target Type.

5. Click Next. The Setup Map XML to XML Details interface opens.

2.9.4. Setting up Document for Trading Partner

1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar.

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document “XML to XML” by selecting XML item from the Source Type

Page 189: EZConnect HowTo

How to map

189

and XML item from Target Type to add to the Trading Partner and click Next.

3.

6. Highlight the map (document) to assign to this Trading Partner and click Next.

Page 190: EZConnect HowTo

How to map

190

7. In Settings panel, provide basic settings for documents:

Choose the appropriate Cust Number XPath and Doc Type XPath by selecting the node to

fill in the Cust Number XPath and Doc Type XPath text box or set Input File

Information

Page 191: EZConnect HowTo

How to map

191

Fill in the XML file prefix.

Fill the information in the Settings.

Page 192: EZConnect HowTo

How to map

192

8. In Communication panel, select a communication type for your document

Page 193: EZConnect HowTo

How to map

193

9. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 194: EZConnect HowTo

How to map

194

3.9.1. Setting up XML to XML Process

1. Open the job to add process.

2. The Job workspace opens. Right-click anywhere in the Process Configuration pane, click Add

Process.

3. The Add Process window opens.

Page 195: EZConnect HowTo

How to map

195

4. Fill in the process name in Process Name field.

5. Choose the type of process “XML to XML” by selecting XML item from the Source Type and XML item from Target Type.

6. Click Save on Action menu to continue process configuration.

Page 196: EZConnect HowTo

How to map

196

Note: The type selected determines the number of predefined configuration steps that will be

available when the new process is saved. Each Tab provides additional options for further defining

the process being created or modified.

7. Configure the process by clicking on each tab to fill the appropriate information.

8. Click on Save in the Action menu to save the information.

Back to How to Map

Page 197: EZConnect HowTo

How to map

197

2.10. Flat File to Database

Select this map type when the data to be translated originates from a Flat File and is destined

for a database.

This map type allows you visually mapping between Flat File and relational data. You can

execute your newly created Flat File to Database mapping to verify that it produces the

desired rational data output from your Flat File.

Preparation for Mapping Flat File to Database

It is a requirement that a Flat File schema should be linked prior mapping.

The following steps must be followed to successfully complete the data mapping process:

(click each step to see the details)

Step 1: Setting up Trading Partner

Step 2: Setting up Flat File Schema

Step 3: Setting up new Flat File to Database map

Step 4: Setting up Document for Trading Partner

Step 5: Setting up Flat File to Database process

Mapping Flat File to Database

2.10.1. Setting up Trading Partner

To begin sending and receiving files with a trading partner, you must first create Trading Partner in

EZConnect. To do this, complete the following steps:

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item

in the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed. This is a template for all of the

trading partner information that will be entered.

3. Click Add Trading Partner button on the Trading Partner Manager Toolbar or highlight

the available Trading Partner and right mouse click on it and then choose Add Trading

Partner in drop down list.

4. The Trading Partner Information window opens.

Page 198: EZConnect HowTo

How to map

198

5. Enter the important Trading Partner Information including Customer Name, Customer Number.

6. Provide the related EDI information you want to include for the Trading Partner.

7. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

8. Enter the contact information you want to include for the Trading Partner in Contacts tab.

9. Enter the notes information you want to include for the Trading Partner in Notes tab.

10. Click on Save button on Action Menu to save the settings.

11. Click on Close to close the Trading Partner Information window and return to Trading

Partner Manager workspace.

2.10.2. Setting up Flat File Schema

1. Select Schemas and then choose Flat File in the Toolbar or go to Schemas > Flat File on

Main Menu Bar or click Flat File on Schemas section of Main Menu Tree to open Flat File

Schemas workspace.

Page 199: EZConnect HowTo

How to map

199

2. Click Add button on the Toolbar or right mouse click on Flat File Schemas workspace and

then choose Add.

3. The Add New Flat File Interface opens.

4. Fill in the schema name in the Schema Name field.

5. Fill in the Notes.

6. Click on Save in Action menu to save changes.

2.10.3. Setting up new Flat File to Database map

Setting up Map

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the workspace or available map type and

choose Add or click Add button on the Map Manager Toolbar.

3. The Map Manager - Map Setup Wizard window opens.

Page 200: EZConnect HowTo

How to map

200

4. In the Choose Map Type panel, select the Flat File item in Source Type and the Database

item in the Target Type.

5. Click Next. The Setup Map Flat File to Database Details interface opens.

Page 201: EZConnect HowTo

How to map

201

In the Map Information, fill in the Map Name and Notes for this map type.

In the Flat File Information, select a Flat File schema from the Flat File

Schemas list.

In the Database Information, select the database in DB Connection drop down

list and click Test to test connection.

-OR-

Click Add New to add new database connection. Note that this button allows

creating a new database connection but the selected tables haven't yet performed.

In order to select tables, the user must go to Database Schema to select.

6. Click Finish to save the new map definition and close the Map Manager - Map Setup

Page 202: EZConnect HowTo

How to map

202

Wizard window.

7. Click Cancel to close the interface without creating the new map.

Start mapping After successfully added new Flat File to Database map, you can start mapping by following

steps:

1. To open the map:

Double click on the selected map to open.

Or

Right click on the selected map and then choose Open or click Open button on the Map

Manager Toolbar. The Map Editor workspace opens.

2. To create Flat File to Database mapping, simply drag the Flat File nodes from the source

Flat File tree to the appropriate columns from the target Database tree or vice versa,

connecting the data sources to the desired data output. This feature allows you to quickly

create expressions, for example, without writing any code or introducing typographical

errors to the source.

3. One of the great features of Map Editor is the synchronized source code pane allows you

to immediately see the code that EZConnect 9 has composed for you, based on the source

target relationship defined by your drag mapping operations. Similarly, you can edit the

Map Editor code manually. As illustrated below, the country node in Purchase Order

Schema drag to the ShipCountry in Ord table and the appropriate code is generated

automatically in Code pane.

In addition, EZConnect 9 now supports the Toolbox panel in the left hand side of Map

Editor. The Toolbox displays icons for code macro items that you can add to Code pane.

Each code macro in Code pane can be dragged to Toolbox panel or vice versa. Each time

you return to Map Editor, the Toolbox automatically scrolls to the group and item most

recently selected. See Map Editor > Overview > Toolbox in User References for more

information about Toolbox panel and how to use it.

Page 203: EZConnect HowTo

How to map

203

4. To navigate through the nodes and appropriate codes that associated with them, just click

on nodes in the source pane.

For example, in the illustrative figure below, the user is clicking an „hd1_ship_time‟ element, and

the appropriate code generation appears in the Code

pane.

Page 204: EZConnect HowTo

How to map

204

5. EZConnect 9 also provides tools, Query Builder (illustrated below), that lets you create,

edit, and testing the SQL statements used to define any relational database tables and views

as a customized Flat File data source.

Page 205: EZConnect HowTo

How to map

205

Query Builder window

Page 206: EZConnect HowTo

How to map

206

Accessing Defined Queries in the Code Pane

The Variable Editor is used to add, remove the defined variable associated with the selected

map.

As illustrated below, the variables are defined globally. We can access them through Source

Code pane with the syntax:

GLOBAL.VariableName

Page 207: EZConnect HowTo

How to map

207

The Function Editor is used to create definitions of new functions associated with the selected

map. The functions are defined globally and then access them through Code Pane window

with the syntax: GLOBAL.FunctionName

The Local Translation Editor is used to translate the value. The variables are defined globally

and then access them through Source Code Pane window with the syntax:

FUNC.LocalTranslation("Value Name")

Page 208: EZConnect HowTo

How to map

208

The Auto Convert Setting is used to convert the source objects to specific converted strings.

The strings are defined in Auto Convert Setting and drag and drop between source and target

tree view nodes.

6. Additionally, Map Editor includes a code completion feature – a pop up list of methods

and/or properties available for objects typed into the code pane. The list appears after you

enter a period for the object, signaling method or property selection. Figure below shows

the available list for the FF object.

Tips Just type as usual in the Source Code pane and EZConnect 9 will automatically sense

what the function you are trying to type and provide a drop down box of matching functions

and their method signatures.

Page 209: EZConnect HowTo

How to map

209

7. Furthermore, you can execute your newly created Flat File to EDI mapping to verify that

it produces the desired EDI data from your relational data. To run map, simply click the

Run Map button or press F6. The Input Parameters window opens and then choose the

appropriate TP and document to start mapping.

Note: In order to run the map, setting up Trading Partner and Document are required.

Figures below show the compile options. Any build errors encountered are displayed in the

Output Pane window.

Page 210: EZConnect HowTo

How to map

210

Page 211: EZConnect HowTo

How to map

211

8. Once you are satisfied with the results, save the map. Flat File to Database data sources

store the database connection properties you have specified, as well as the SQL statements

and the codes that you have created.

2.10.4. Setting up Document for Trading Partner

1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar.

Page 212: EZConnect HowTo

How to map

212

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document “Flat File to Database” by selecting Flat File item from the

Source Type and Database item from Target Type to add to the Trading Partner and click

Next.

6. Highlight the map (document) to assign to this Trading Partner and click Next.

Page 213: EZConnect HowTo

How to map

213

7. In Settings panel, provide basic settings for documents:

· Choose appropriate Cust Number Path and Doc Type Path by selecting the node to fill in

the Cust Number Path and Doc Type Path text box.

Page 214: EZConnect HowTo

How to map

214

Select Path by selecting a node in the Flat File tree to fill in the text box.

In the Position box, type or select the part of the position you want to change.

In the Length box, type or select the part of the length you want to change.

Fill in the Value in Document Type area.

Fill in the Flat File prefix and set the file count in the File Count box.

Note: all field noted with “*” are required.

8. Configure for Functional Acknowledgement.

Page 215: EZConnect HowTo

How to map

215

Choose path for placing the file of Functional Acknowledgement on server or client

machine.

In the Select doc to run, select a DB2FF map for Functional Acknowledgement.

9. In Communication panel, select a communication type for your document

Page 216: EZConnect HowTo

How to map

216

10. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The

Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 217: EZConnect HowTo

How to map

217

2.10.5. Setting up Flat File to Database process

1. Open the job to add process.

2. The Job workspace opens. Right-click anywhere in the Process Configuration pane, click Add Process.

3. The Add Process window opens.

Page 218: EZConnect HowTo

How to map

218

4. Fill in the process name in Process Name field.

5. Choose the type of process “Flat File to Database” by selecting Flat File item from the Source Type and Database item from Target Type.

6. Click Save on Action menu to continue process configuration.

Page 219: EZConnect HowTo

How to map

219

Note: The type selected determines the number of predefined configuration steps that will

be available when the new process is saved. Each Tab provides additional options for further

defining the process being created or modified.

7. Configure the process by clicking on each tab to fill the appropriate information.

8. Click on Save in the Action menu to save the information.

Back to How to Map

Page 220: EZConnect HowTo

How to map

220

2.11. Database to Flat File

Select this map type when the data to be translated originates from a database and is destined

for an Flat File.

This map type allows you visually mapping relational data and Flat File. You can execute

your newly created Database to Flat File mapping to verify that it produces the desired Flat

File data output from your relational data.

Preparation for Mapping Database to Flat File

It is a requirement that a Database and Flat File schema should be linked prior mapping.

The following steps must be followed to successfully complete the data mapping process:

(click each step to see the details)

Step 1: Setting up Trading Partner

Step 2: Setting up Database Schema

Step 3: Setting up Flat File Schema

Step 4: Setting up new Database to Flat File map

Step 5: Setting up Document for Trading Partner

Step 6: Setting up Database to Flat File process

Mapping Database to Flat File

2.11.1. Setting up Trading Partner

To begin sending and receiving files with a trading partner, you must first create Trading Partner in

EZConnect. To do this, complete the following steps:

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item

in the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed. This is a template for all of the

trading partner information that will be entered.

3. Click Add Trading Partner button on the Trading Partner Manager Toolbar or highlight

the available Trading Partner and right mouse click on it and then choose Add Trading

Partner in drop down list.

4. The Trading Partner Information window opens.

Page 221: EZConnect HowTo

How to map

221

5. Enter the important Trading Partner Information including Customer Name, Customer

Number.

6. Provide the related EDI information you want to include for the Trading Partner.

7. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

8. Enter the contact information you want to include for the Trading Partner in Contacts tab.

9. Enter the notes information you want to include for the Trading Partner in Notes tab.

10. Click on Save button on Action Menu to save the settings.

11. Click on Close to close the Trading Partner Information window and return to Trading Partner

Manager workspace.

2.11.2. Setting up Database Schema

1. Select Schemas and then choose Database in the Toolbar or go to Schemas > Database on

Main Menu bar or click Database on Schemas section of Main Menu Tree to open

Page 222: EZConnect HowTo

How to map

222

Database Connection workspace.

2. Click Add button on the Toolbar menu or right click on the database connection and choose

Add.

3. The Database Connection Interface opens

4. Fill in the database connection name in Name field.

5. In Connection Information panel, choose the appropriate DB Type. Choices are Microsoft

SQL Server, Generic ODBC (using DSN).

Note: If the required data source was previously created for Generic (ODBC), select

it. If you do not have a data source setup, create new a data source. After completing

the data source setup, the new connection will be displayed in DSN drop down list

(Generic ODBC).

6. Enter the appropriate information associated with the database type you want to establish a

connection with a specific database on a specific server.

7. Select some desired tables and then click Save in Action menu to save changes.

8. Click Close in Action menu to close the Database Connection window and return to

Database Connection workspace.

Page 223: EZConnect HowTo

How to map

223

2.11.3. Setting up Flat File Schema

1. Select Schemas and then choose Flat File in the Toolbar or go to Schemas > Flat File on

Main Menu Bar or click Flat File on Schemas section of Main Menu Tree to open Flat File

Schemas workspace.

2. Click Add button on the Toolbar or right mouse click on Flat File Schemas workspace and

then choose Add.

3. The Add New Flat File Interface opens.

4. Fill in the schema name in the Schema Name field.

5. Fill in the Notes.

6. Click on Save in Action menu to save changes.

2.11.4. Setting up new Database to Flat File map

Setup Map

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the workspace or available map type and

choose Add or click Add button on the Map Manager Toolbar.

Page 224: EZConnect HowTo

How to map

224

3. The Map Manager - Map Setup Wizard window opens.

4. In the Choose Map Type panel, select the Database item in Source Type and the Flat File

item in the Target Type.

5. Click Next. The Setup Map Database to Flat File Details interface opens.

Page 225: EZConnect HowTo

How to map

225

6. In the Map Information, fill in the Map Name and Notes for this map type.

7. In the Database Information, select the database in DB Connection drop down list and click

on Test button to test connection.

Or

Click the Add New button to add new database connection. Note that this button allows

creating a new database connection but the selected tables haven't yet performed. In order to

select tables, the user must go to Database Schema to select.

8. In the Flat File Information, select a Flat File schema from the XML Schemas List.

9. Click Finish to save the new map definition and close the Map Manager - Map Setup

Wizard window.

Page 226: EZConnect HowTo

How to map

226

10. Click Cancel to close the interface without creating the new map.

Start Mapping

After successfully added new Database to Flat File map, you can start mapping by following

steps:

1. To open the map:

Double click on the selected map to open.

Or

Right click on the selected map and then choose Open or click Open button on the Map

Manager Toolbar. The Map Editor workspace opens.

2. EZConnect 9 supports Database as the source or target of data mapping. To create Database to

Flat File mapping, simply drag the appropriate columns from source Database tree to the Flat

File nodes from target Flat File tree or vice versa, connecting the data sources to the desired

data output. This feature allows you to quickly create expressions, for example, without writing

any code or introducing typographical errors to the source.

3. One of the great features of Map Editor is the synchronized source code pane allows you to

immediately see the code that EZConnect 9 has composed for you, based on the source target

relationship defined by your drag mapping operations. Similarly, you can edit the Map Editor

code manually. As illustrated below, the Country column in OrdList table drags to the

country node in Purchase Order Schema and the appropriate code is generated automatically

in Code pane.

In addition, EZConnect 9 now supports the Toolbox panel in the left hand side of Map Editor.

The Toolbox displays icons for code macro items that you can add to Code pane. Each code

macro in Code pane can be dragged to Toolbox panel or vice versa. Each time you return to

Map Editor, the Toolbox automatically scrolls to the group and item most recently selected.

See Map Editor > Overview > Toolbox in User References for more information about

Toolbox panel and how to use it.

Page 227: EZConnect HowTo

How to map

227

4. To navigate through the elements/nodes, just click on elements/nodes in the target pane. the

appropriate codes associated with them are generated in the Code Pane.

For example, in the illustrative figure below, the user is clicking an „hd1_account‟ element, and

the appropriate code generation appears in the Code pane.

Page 228: EZConnect HowTo

How to map

228

5. EZConnect 9 also provides tools, Query Builder (illustrated below), that lets you create, edit,

and testing the SQL statements used to define any relational database tables and views as a

customized Flat File data source.

Page 229: EZConnect HowTo

How to map

229

Page 230: EZConnect HowTo

How to map

230

The Variable Editor is used to add, remove the defined variable associated with the

selected map.

As illustrated below, the variables are defined globally. We can access them through Code

Pane window with the syntax:

GLOBAL.VariableName

Page 231: EZConnect HowTo

How to map

231

The Function Editor is used to create definitions of new functions associated with the

selected map. The functions are defined globally and then access them through Code Pane

window with the syntax: GLOBAL.FunctionName

The Local Translation Editor is used to translate the value. The variables are defined

globally and then access them through Source Code Pane window with the syntax:

FUNC.LocalTranslation("Value Name")

The Auto Convert Setting is used to convert the source objects to specific converted

strings. The strings are defined in Auto Convert Setting and drag and drop between source

and target tree view nodes.

6. Additionally, Map Editor includes a code completion feature – a pop up list of methods and/or

properties available for objects typed into the code pane. The list appears after you enter a

Page 232: EZConnect HowTo

How to map

232

period for the object, signaling method or property selection. Figure below shows the available

list for the DB object.

Tip: Just type as usual in the Code Pane and EZConnect 9 will automatically sense what

the function you are trying to type and provide a drop down box of matching functions and their

method signatures.

7. Furthermore, you can execute your newly created Database to Flat File mapping to verify that

it produces the desired Flat File data output from your relational data. To run map, simply click

the Run Map button or press F6. The Input Parameters window opens and then choose the

appropriate Trading Partner and document to start mapping.

Note: In order to run the map, setting up Trading Partner and Document are required. For

more information, see Adding Trading Partner and Adding Document.

Page 233: EZConnect HowTo

How to map

233

Figures below show the compile options. Any build errors encountered are displayed in the

Output Pane window.

Page 234: EZConnect HowTo

How to map

234

Check Syntax Tab

Page 235: EZConnect HowTo

How to map

235

Run Map Tab

The Flat File results are displayed in Check Output Pane window

Page 236: EZConnect HowTo

How to map

236

8. Once you are satisfied with the results, save the map. Database to Flat File data sources store

both the database connection properties you have specified, as well as the SQL statements and

the codes that you have created.

Page 237: EZConnect HowTo

How to map

237

2.11.5. Setting up Document for Trading Partner

1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar.

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document “Database to Flat File” by selecting Database item from the

Source Type and Flat File item from Target Type to add to the Trading Partner and click

Next.

Page 238: EZConnect HowTo

How to map

238

6. Highlight the map (document) to assign to this Trading Partner and click Next.

Page 239: EZConnect HowTo

How to map

239

7. In Settings panel, provide basic settings for documents.

Page 240: EZConnect HowTo

How to map

240

Select file type in the File Extension list. Available choices are .doc, .rtf , .txt and .xml. Fill in the Flat File prefix.

In the File Count box, type or select the part of the file count you want to change.

In the Max ST/File box, type or select the part of the number of messages that you want

flat file document contains.

Note: all field noted with “*” are required.

8. In Communication panel, select a communication type for your document.

Page 241: EZConnect HowTo

How to map

241

9. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The

Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 242: EZConnect HowTo

How to map

242

Page 243: EZConnect HowTo

How to map

243

2.11.6. Setting up Database to Flat File process

1. Open a job to add process.

2. The Job workspace opens. Right-click anywhere in the Process Configuration pane, click

Add Process

3. The Add Process window opens.

4. Fill in the process name in Process Name field.

5. Choose the type of process “Database to Flat File ” by selecting Database item from the

Source Type and Flat File item from Target Type.

6. Click Save on Action menu to continue process configuration.

Page 244: EZConnect HowTo

How to map

244

Note: The type selected determines the number of predefined configuration steps that will

be available when the new process is saved. Each Tab provides additional options for further

defining the process being created or modified.

7. Configure the process by clicking on each tab to fill the appropriate information.

8. Click on Save in the Action menu to save the information.

2.12. EDI Response

Select this map type when the data to be translated originates from an EDI formatted

document.

You can obtain information about an EDI format, from its associated document called the

implementation guideline. The implementation guideline is probably the only document

that you would ever need for obtaining instructions about how to process EDI files of

your trading partner. Before EDI files are exchanged, trading partners have to agree on

the EDI format and mapping. These rules and instructions are entered into the

implementation guideline document. Depending on your trading partner, the

Page 245: EZConnect HowTo

How to map

245

implementation guidelines can come in many formats.

You can execute your newly created EDI Response mapping to verify that it produces the

desired ACK (Acknowledgement) data output from your EDI data file.

The following steps must be followed to successfully complete the data mapping process:

(click on each step to see the details)

Step 1: Setting up Trading Partner

Step 2: Setting up new EDI Response map

Step 3: Setting up Document for Trading Partner

Mapping EDI Response

2.12.1. Setting up Trading Partner

To begin sending and receiving files with a trading partner, you must first create Trading Partner in

EZConnect. To do this, complete the following steps:

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item in

the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed. This is a template for all of the

trading partner information that will be entered.

3. Click Add Trading Partner button on the Trading Partner Manager Toolbar or highlight the

available Trading Partner and right mouse click on it and then choose Add Trading Partner in

drop down list.

4. The Trading Partner Information window opens.

Page 246: EZConnect HowTo

How to map

246

5. Enter the important Trading Partner Information including Customer Name, Customer Number.

6. Provide the related EDI information you want to include for the Trading Partner.

7. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

8. Enter the contact information you want to include for the Trading Partner in Contacts tab.

9. Enter the notes information you want to include for the Trading Partner in Notes tab.

10. Click on Save button on Action Menu to save the settings.

11. Click on Close to close the Trading Partner Information window and return to Trading

Partner Manager workspace.

2.12.2. Setting up new EDI Response map

Setting up map

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

Page 247: EZConnect HowTo

How to map

247

workspace.

2. From Map Manager workspace, right click on the workspace or available map type and choose

Add or click Add button on the Map Manager Toolbar.

3. The Map Manager - Map Setup Wizard window opens.

4. In the Choose Map Type panel, select the EDI item in Source Type and the None item in the

Target Type or vice versa.

5. Click Next. The Setup Map EDI Response Details interface opens.

Page 248: EZConnect HowTo

How to map

248

6. In the Map Information, fill in the Map Name and Notes for this map type.

7. In the EDI Information, select a Standard, Version and Message ID from EDI List.

8. Click Finish to save the new map definition and close the Map Manager - Map Setup Wizard

window.

9. Click Cancel to close the interface without creating the new map.

Start mapping

After successfully added new EDI Response map, you can start mapping by following steps:

1. To open the map:

Page 249: EZConnect HowTo

How to map

249

Double click on the selected map to open.

Or

Right click on the selected map and then choose Open or click Open button on the Map

Manager Toolbar. The Map Editor workspace opens.

2. To create EDI Response mapping, simply drag and drop the EDI nodes from the target EDI tree,

connecting the data elements to the desired data output (preferred ACK). This feature allows you

to quickly create expressions, for example, without writing any code or introducing typographical

errors to the source.

Note: Typically, not all of the nodes will actually contain data, so the project author must be

sufficiently familiar with the EDI documents being worked on, to locate the relevant nodes.

3. One of the great features of Map Editor is the synchronized source code pane allows you to

immediately see the code that EZConnect 9 has composed for you. Similarly, you can edit the

Map Editor code manually.

In addition, EZConnect 9 now supports the Toolbox panel in the left hand side of Map Editor.

The Toolbox displays icons for code macro items that you can add to Code Pane window. Each

code macro in Code Pane can be dragged and dropped into Toolbox panel or vice versa. Each

time you return to Map Editor, the Toolbox automatically scrolls to the group and item most

recently selected.

4. To navigate through the nodes and appropriate codes that associated with them, just click on EDI

nodes in the Target pane.

For example, in the illustrative figure below, the user is clicking on an element 719 „Segment

Position in Transaction Set‟ in the Target EDI, and the appropriate code generation appears in

the Code Pane window.

Page 250: EZConnect HowTo

How to map

250

5. EZConnect 9 also provides tools, the Variable Editor is used to add, remove the defined variable

associated with the selected map.

As illustrated below, the variables are defined globally. We can access them through Source

Code Pane window with the syntax: GLOBAL.VariableName

Page 251: EZConnect HowTo

How to map

251

The Function Editor is used to create definitions of new functions associated with the selected

map. The functions are defined globally and then access them through Code Pane window with

the syntax: GLOBAL.FunctionName

The Local Translation Editor is used to translate the value. The variables are defined globally

and then access them through Source Code Pane window with the syntax:

FUNC.LocalTranslation("Value Name")

The Auto Convert Setting is used to convert the source objects to specific converted strings. The

strings are defined in Auto Convert Setting and drag and drop between source and target tree

view nodes.

For advanced EDI mapping process, EZConnect 9 now supports Linked Elements means that all

Page 252: EZConnect HowTo

How to map

252

the related segments and elements in EDI Tree can be set into relational conditions. Relational

conditions are specified by a condition code and the identity of the subject elements. In addiction,

the Load EDI From File feature allows users browsing an EDI file (preferred the same

document type) within a blank map and EZConnect 9 will automatically check all the appropriate

segments and elements.

6. Additionally, Map Editor includes a code completion feature – a pop up list of methods and/or

properties available for objects typed into the code pane. The list appears after you enter a period

for the object, signaling method or property selection. Figure below shows the available list for

the ACK object.

Tips Just type as usual in the Source Code pane and EZConnect 9 will automatically sense

what the function you are trying to type and provide a drop down box of matching functions and

their method signatures.

Page 253: EZConnect HowTo

How to map

253

7. Furthermore, you can execute your newly created EDI Response mapping to verify that it

produces the desired EDI data from your relational data. To run map, simply click the Run Map

button or press F6.

Note: In order to run the map, setting up Trading Partner and Document are required. For

more information see Adding Trading Partner and Adding Document in the Tutorial section.

From Input Parameters window, there are two ways to run EDI Response map:

Run map ACK without advanced input parameters - All objects in ACK have default

value "null" or 0. It is recommended that the user should set fixed value for all nodes to view

output result. Simply choose the appropriate TP and document to start mapping.

Run map ACK with advanced input parameters - Before running ACK map, the run the

selected map in Advanced. The data in main ACK is the collected data during running that map.

To do this, check to enable ACK check options allows you select the appropriate input

parameters.

Page 254: EZConnect HowTo

How to map

254

Page 255: EZConnect HowTo

How to map

255

Figures below show the compile options. Any build errors encountered are displayed in the

Output Pane window.

Page 256: EZConnect HowTo

How to map

256

Page 257: EZConnect HowTo

How to map

257

Once you are satisfied with the results, save the map. EDI data sources store properties you have

specified, as well as the codes that you have created.

2.12.3. Setting up Document for Trading Partner

1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar.

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document “EDI Response” by selecting EDI item from the Source Type

and ACK item from Target Type or vice versa to add to the Trading Partner and click Next.

Page 258: EZConnect HowTo

How to map

258

6. Highlight the map (document) to assign to this Trading Partner and click Next.

Page 259: EZConnect HowTo

How to map

259

7. In Settings panel, provide basic settings for documents:

Fill in the appropriate EDI information in Envelop Information and GS Information panel.

Page 260: EZConnect HowTo

How to map

260

Configure advanced EDI settings including Delimiters and ST Setup.

Page 261: EZConnect HowTo

How to map

261

Note: all field noted with “*” are required.

8. In Communication panel, select a communication type for your document.

Page 262: EZConnect HowTo

How to map

262

9. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The

Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 263: EZConnect HowTo

How to map

263

Back to Top

Page 264: EZConnect HowTo

How to manage Schema

264

3. How to manage Schema This section will guide you through Schemas Management. Specifically this section will address

how to manage:

Database Schema

XML Schema

Flat File Schema

3.1. Database This tutorial shows you the basics of adding, editing, deleting a new database connection in

EZConnect.

Specifically this tutorial will address:

Adding a Database Schema

Editing a Database Schema

Deleting a Database Schema

How to Create a New Data Source

3.1.1. Adding a Database Schema

1. Select Schemas and then choose Database in the Toolbar or go to Schemas > Database on

Main Menu bar or click Database on Schemas section of Main Menu Tree to open Database

Connection workspace.

2. Click Add button on the Toolbar menu or right click on the database connection and choose

Add.

3. The Database Connection Interface opens

Page 265: EZConnect HowTo

How to manage Schema

265

4. Fill in the database connection name in Name field.

5. In Connection Information panel, choose the appropriate DB Type. Choices are Microsoft SQL

Server, Generic ODBC (using DSN).

Note: If the required data source was previously created for Generic (ODBC), select it.

If you do not have a data source setup, create new a data source. After completing the

data source setup, the new connection will be displayed in DSN drop down list

(Generic ODBC).

6. Enter the appropriate information associated with the database type you want to establish a

connection with a specific database on a specific server.

7. Select some desired tables and then click Save in Action menu to save changes.

8. Click Close in Action menu to close the Database Connection window and return to Database

Connection workspace.

3.1.2. Editing a Database Schema

1. Select Schemas and then choose Database in the Toolbar or go to Schemas > Database on

Main Menu bar or click Database on Schemas section of Main Menu Tree to open Database

Connection workspace.

Page 266: EZConnect HowTo

How to manage Schema

266

2. Highlight a database connection to edit.

3. Right click on the database connection and choose Edit or click Edit button on the toolbar.

4. The Database Connection window opens

5. You are now ready to make changes to the selected database connection.

6. Click on Save on Action menu to save changes.

7. Click Close on Action menu to close the Database Connection window and return to Database

Connection workspace.

3.1.3. Deleting a Database Schema

1. Select Schemas and then choose Database in the Toolbar or go to Schemas > Database on

Main Menu bar or click Database on Schemas section of Main Menu Tree to open Database

Connection workspace.

2. Highlight a database connection to delete.

3. Right click on the database connection and choose Delete or click Delete button on the Toolbar.

4. The Confirm Database Connection Delete warning message opens.

Page 267: EZConnect HowTo

How to manage Schema

267

Yes - Deletes the selected database connection and closes confirmation widow.

No - Closes confirmation window without deleting selected database connection.

Cancel - Closes confirmation window and returns to Database Connection workspace without

taking any action.

3.1.4. How to create a new Data Source

1. In Database Connection window, click on Browser. The Select Data Source window opens.

Page 268: EZConnect HowTo

How to manage Schema

268

2. Click on New.

3. The Create New Data Source Wizard launches.

Page 269: EZConnect HowTo

How to manage Schema

269

4. Select the type of data source - User or System -and click Next.

5. Select the correct driver for the data source for the new connection.

6. The next screen verifies your selection. Click Next if correct.

7. Each driver has its' own setup template. Fill in the requested information and click Next until you

are Finished.

Page 270: EZConnect HowTo

How to manage Schema

270

TIP: Most drivers provide a Test selection after the configuration. It is always a good idea to run the

test when offered to confirm that the information entered is valid.

Back to Manage Schema

Page 271: EZConnect HowTo

How to manage Schema

271

3.2. XML This tutorial shows you the basics of deleting, exporting, importing, configuring a XML

Schema in EZConnect.

Specifically this tutorial will address:

Deleting a XML Schema

Exporting a XML Schema

Importing a XML Schema

Replacing new XML Schema

3.2.1. Deleting an XML Schema

1. Select Schemas and then choose XML in the Toolbar or go to Schemas > XML on Main

Menu Bar or click XML on Schemas section of Main Menu Tree to open XML Schemas

workspace.

2. Highlight a XML Schema to delete.

3. Right click on the selected XML Schema and choose Delete or click Delete button on the

toolbar.

4. The Confirm XML Schemas Delete dialog opens.

Yes - Deletes the selected XML schema and closes confirmation widow.

No - Closes confirmation window without deleting selected XML schema.

Cancel - Closes confirmation window and returns to XML Schemas workspace without

taking any action.

Page 272: EZConnect HowTo

How to manage Schema

272

3.2.2. Exporting an XML Schema

1. Select Schemas and then choose XML in the Toolbar or go to Schemas > XML on Main

Menu Bar or click XML on Schemas section of Main Menu Tree to open XML Schemas

workspace.

2. Highlight a XML Schema to export.

3. Right click on the selected XML Schema and choose Export or click Export button on the

Toolbar.

4. The Save As dialog opens.

5. Choose the directory that a file will be saved and click Save button.

3.2.3. Importing an XML Schema

1. Select Schemas and then choose XML in the Toolbar or go to Schemas > XML on Main

Page 273: EZConnect HowTo

How to manage Schema

273

Menu Bar or click XML on Schemas section of Main Menu Tree to open XML Schemas

workspace.

2. Click Import button on the Toolbar or right mouse click on XML Schemas workspace and then

choose Import.

3. The Import XML Schema window opens.

4. Fill in the schema name in Schema Name field.

5. In Schema file field, browser and choose the appropriate XML schema.

6. Fill in the Note.

7. Click on Save in Action menu to save changes.

3.2.4. Replacing new XML Schema

1. Select Schemas and then choose XML in the Toolbar or go to Schemas > XML on Main

Menu Bar or click XML on Schemas section of Main Menu Tree to open XML Schemas

workspace.

2. Click Replace button on the Toolbar or right mouse click on XML Schemas workspace and

then choose Replace.

Page 274: EZConnect HowTo

How to manage Schema

274

3. The Open dialog opens.

4. Choose the directory that a schema file (*.xsd) is located and click Open button.

Back to Manage Schema

Page 275: EZConnect HowTo

How to manage Schema

275

3.3. Flat File This tutorial shows you the basics of adding, editing, deleting, exporting, importing,

configuring a Flat File Schema in EZConnect.

Specifically this tutorial will address:

Adding a Flat File Schema

Deleting a Flat File Schema

Editing a Flat File Schema

Loading IDOCs Lib

Importing a Flat File Schema

Exporting a Flat File Schema

Configuring a Flat File Schema

3.3.1. Adding a Flat File Schema

1. Select Schemas and then choose Flat File in the Toolbar or go to Schemas > Flat File on Main

Menu Bar or click Flat File on Schemas section of Main Menu Tree to open Flat File Schemas

workspace.

2. Click Add button on the Toolbar or right mouse click on Flat File Schemas workspace and then

choose Add.

3. The Add New Flat File Interface opens.

Page 276: EZConnect HowTo

How to manage Schema

276

4. Fill in the schema name in the Schema Name field.

5. Fill in the Notes.

6. Click on Save in Action menu to save changes.

3.3.2. Deleting a Flat File Schema

1. Select Schemas and then choose Flat File in the Toolbar or go to Schemas > Flat File on Main

Menu Bar or click Flat File on Schemas section of Main Menu Tree to open Flat File Schemas

workspace.

2. Highlight a Flat File schema in Flat File Schemas List to delete.

3. Right click on the selected Flat File schema and choose Delete or click Delete button on the

Toolbar.

4. The Confirm Flat File Schemas Delete dialog opens.

Page 277: EZConnect HowTo

How to manage Schema

277

Yes - Deletes the selected Flat File schema and closes confirmation widow.

No - Closes confirmation window without deleting selected Flat File schema.

Cancel - Closes confirmation window and returns to Flat File Schemas workspace without taking

any action.

3.3.3. Editing a Flat File Schema

1. Select Schemas and then choose Flat File in the Toolbar or go to Schemas > Flat File on Main

Menu Bar or click Flat File on Schemas section of Main Menu Tree to open Flat File Schemas

workspace.

2. Highlight a Flat File schema in Flat File Schemas List to edit.

3. Right click on the selected Flat File schema and choose Edit or click Edit button on the Toolbar.

4. The Flat File Editor is enabled.

Page 278: EZConnect HowTo

How to manage Schema

278

5. Now you can start editing Flat File schema in Flat File Editor.

6. Click on Save on Toolbar or right mouse click on Flat File Editor and then choose Save to save

changes.

Page 279: EZConnect HowTo

How to manage Schema

279

7. Click Close button on Toolbar to close the Flat File Editor and return to Flat File Schemas

workspace.

3.3.4. Loading IDOCs Lib

1. On the Toolbar, click Schemas and then click Flat File. Or on Main Menu Bar, go to Schemas

> Flat File. Or on Schemas section of Main Menu Tree, click Flat File to open Flat File

Schemas workspace.

2. On the Toolbar, click Load IDOCs Lib. Or right-click anywhere in the Flat File Schemas

workspace and then click Load IDOCs Lib.

3. The Import IDOCs Library window opens.

Fill in the schema name in the Schema Name field.

In the Choose IDOCs File Type area, select Load from single file or Load from a set

of files. Click Browse to specify the path of desired IDOCs files.

Select the Add Global Loop or Add EOL check box.

Fill in the Notes.

4. Click Save in Action menu to save changes.

Page 280: EZConnect HowTo

How to manage Schema

280

3.3.5. Importing a Flat File Schema

1. Select Schemas and then choose Flat File in the Toolbar or go to Schemas > Flat File on

Main Menu Bar or click Flat File on Schemas section of Main Menu Tree to open Flat File

Schemas workspace.

2. Click Import button on the Toolbar or right mouse click on Flat File Schemas workspace and

then choose Import.

3. The Open dialog opens.

4. Choose the directory that a file is located and click Open button.

3.3.6. Exporting a Flat File Schema

1. Select Schemas and then choose Flat File in the Toolbar or go to Schemas > Flat File on

Main Menu Bar or click Flat File on Schemas section of Main Menu Tree to open Flat File

Schemas workspace.

2. Highlight a Flat File schema in Flat File Schemas List to export.

3. Right click on the selected Flat File schema and choose Export or click Export button on the

Toolbar.

4. The Save As dialog opens.

5. Choose the directory that a file will be saved and click Save button.

3.3.7. Configuring a Flat File Schema

1. Select Schemas and then choose Flat File in the Toolbar or go to Schemas > Flat File on Main

Menu Bar or click Flat File on Schemas section of Main Menu Tree to open Flat File Schemas

workspace.

2. Highlight a Flat File schema in Flat File Schemas List to configure.

3. Right click on the selected Flat File schema and choose Configure or click Configure button on

the Toolbar.

4. The Configure Flat File Schema Interface opens.

Page 281: EZConnect HowTo

How to manage Schema

281

5. Configure the changes including Schema Name and Notes fields.

6. Click on Save button on Action Menu to update changes.

Back to Top

Page 282: EZConnect HowTo

How to manage Map

282

4. How to manage Map This section will guide you through Map Management. Specifically this section will address:

Editing a Map Type

Deleting a Map Type

Opening a Map Type

Exporting a Map Type

Importing a Map Type

4.1. Editing a Map Type

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From the Map Manager workspace, right click on the map key and choose Edit or click Edit

button on the Map Manager Toolbar.

3. The appropriate Map Manager - Edit Map window opens.

4. Configure the changes and then click Save on Action Menu.

Page 283: EZConnect HowTo

How to manage Map

283

4.2. Deleting a Map Type

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the map key and choose Delete or click Delete

button on the Map Manager Toolbar.

3. The Confirm Map Delete warning message opens.

Yes - Deletes selected map and all document setups and closes confirmation widow.

No - Closes confirmation window without deleting the selected map.

Cancel - Closes confirmation window and returns to Map Manager workspace without taking any

action.

4.3. Opening a Map Type

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the map key and choose Open or click Open

button on the Map Manager Toolbar.

3. The appropriate Map Editor workspace window opens.

Page 284: EZConnect HowTo

How to manage Map

284

You are now able to execute your tasks on workspace.

4.4. Exporting a Map Type

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the map key and choose Export or click Export

button on the Map Manager Toolbar.

3. The Save As dialog box appears.

4. Choose the directory that a file will be located and click Save button.

Page 285: EZConnect HowTo

How to manage Map

285

4.5. Importing a Map Type

1. Select Map Manager in the Toolbar or go to Map > Map Manager on Main Menu Bar or

click Map Manager on Administrator section of Main Menu Tree to open Map Manager

workspace.

2. From Map Manager workspace, right click on the map type and choose Import or click Import

button on the Map Manager Toolbar.

3. The Open dialog box appears.

4. Choose an XML file and click Open button.

Back to Top

Page 286: EZConnect HowTo

How to manage Trading Partner

286

5. How to manage Trading Partner This section will guide you through Trading Partner and Document Management. Specifically

this section will address:

Adding a Trading Partner

Editing a Trading Partner

Deleting a Trading Partner

Importing a Trading Partner

Exporting a Trading Partner

5.1. Adding a Trading Partner

1. To begin sending and receiving files with a trading partner, you must first create Trading Partner

in EZConnect. To do this, complete the following steps:

2. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item in

the Main Menu Tree.

3. The Trading Partner Manager workspace will be displayed. This is a template for all of the

trading partner information that will be entered.

4. Click Add Trading Partner button on the Trading Partner Manager Toolbar or highlight the

available Trading Partner and right mouse click on it and then choose Add Trading Partner in

drop down list.

5. The Trading Partner Information window opens.

Page 287: EZConnect HowTo

How to manage Trading Partner

287

6. Enter the important Trading Partner Information including Customer Name, Customer

Number.

7. Provide the related EDI information you want to include for the Trading Partner.

8. Click on Save button on Action Menu to continue configuring the settings for the Alert,

Notification and Transmission pull-down menus in the Communication Settings.

9. Enter the contact information you want to include for the Trading Partner in Contacts tab.

10. Enter the notes information you want to include for the Trading Partner in Notes tab.

11. Click on Save button on Action Menu to save the settings.

12. Click on Close to close the Trading Partner Information window and return to Trading

Partner Manager workspace.

5.2. Editing a Trading Partner

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item in

Page 288: EZConnect HowTo

How to manage Trading Partner

288

the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed.

3. Highlight and select a Trading Partner to edit.

4. Right click on the Trading Partner and choose Edit Trading Partner or click Edit Trading

Partner button on the Trading Partner Manager Toolbar.

5. The Trading Partner Information window opens.

6. You are now ready to make changes to Trading Partner including Trading Partner

Information, EDI Information, Communication Settings, etc.

7. Click on Save on Action Menu to save changes.

8. Click on Close to close the Trading Partner Information window and return to Trading

Partner Manager workspace.

5.3. Deleting a Trading Partner

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Page 289: EZConnect HowTo

How to manage Trading Partner

289

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item in

the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed.

3. Highlight and select a Trading Partner to delete.

4. Right click on the Trading Partner and choose Delete or click Delete button on the Trading

Partner Manager Toolbar.

5. The Confirm Trading Partner Delete dialog opens.

Yes - Deletes selected Trading Partner and closes confirmation widow. Yes also removes any Doc...

and Address... associated with Trading Partner.

No - Closes confirmation window without deleting the selected Trading Partner.

Cancel - Closes confirmation window and returns to Trading Partner Manager workspace without

taking any action.

5.4. Importing a Trading Partner

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu Bar or click Trading Partner Manager menu

item in the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed.

3. Click Import Trading Partner button on the Trading Partner Manager Toolbar or Right

click on the Trading Partner Manager workspace and choose Import Trading Partner.

Page 290: EZConnect HowTo

How to manage Trading Partner

290

4. The Open dialog box opens.

5. Choose the directory that a file is located and click Open button. The layout must be an XML

formatted file.

5.5. Exporting a Trading Partner

1. Click the Trading Partner Manager button on the Toolbar or select Trading Partner >

Trading Partner Manager from Main Menu or click Trading Partner Manager menu item in

the Main Menu Tree.

2. The Trading Partner Manager workspace will be displayed.

3. Highlight and select a Trading Partner to export.

4. Right click on the Trading Partner and choose Export Trading Partner or click Export

Trading Partner button on the Trading Partner Manager Toolbar.

5. The Save As dialog box opens.

6. Choose the directory that a file will be saved and click Save button.

Back to Top

Page 291: EZConnect HowTo

How to manage Document

291

6. How to manage Document This section will guide you through Document Management. Specifically this section will

address:

Adding a Document

Editing a Document

Deleting a Document

Importing a Document

Exporting a Document

6.1. Adding Document 1. From Trading Partner Manager workspace.

2. Highlight a Trading Partner listed on the Trading Partners workspace.

3. Click on Add Document button on the Trading Partner Manager Toolbar or Right mouse

click on it and then choose Add Document from drop down list commands or select Trading

Partner > Add Document on the Main Menu Bar. <Show Figure>

4. The Trading Partner Setup – Document Setup Wizard window is displayed.

5. Choose the Type of Document by selecting item from the Source Type and item from Target

Type to add to the Trading Partner and click Next.

Page 292: EZConnect HowTo

How to manage Document

292

If you want to skip document validation when adding document to Trading Partner, simply check

Skip Document Validate checkbox.

6. Highlight the map (document) to assign to this Trading Partner and click Next.

7. In Settings panel, provide basic settings for documents.

8. In Communication panel, select a communication type for your document.

9. Review Summary screen contents. Missing required information will be listed in red. Use the

Back button to return to the Document Setup screen and enter any required information. The

Finish button will not activate until the Document Setup Wizard is completed correctly.

Page 293: EZConnect HowTo

How to manage Document

293

6.2. Editing Document 1. Expand the Trading Partner List and highlight the document to edit.

2. Right click on the document and choose Edit Document or click Edit Document button on the

Trading Partner Manager Toolbar.

3. The Document Setup window opens.

Note: Depend on the type of documents you added to Trading Partner, the Document Setup -

Edit mode will change.

You are now ready to make changes to document including General, Map, EDI, Notifications,

etc.

4. Click on Save on Action Menu to save changes.

5. Click on Close to close the Document Setup window and return to Trading Partner Manager

workspace.

Page 294: EZConnect HowTo

How to manage Document

294

6.3. Deleting Document 1. Expand the Trading Partner List and highlight the document to delete.

2. Right click on the document and choose Delete Document or click Delete Document button on

the Toolbar.

3. The Confirm Document Delete dialog opens.

Yes - Deletes selected document and closes confirmation widow.

No - Closes confirmation window without deleting the selected document.

Cancel - Closes confirmation window and returns to Trading Partner Manager workspace without

taking any action.

6.4. Importing Document 1. Expand the Trading Partner List and highlight the document to import.

2. Right click on the document and choose Import Document or click Import Document button

on the Trading Partner Manager Toolbar.

3. The Open dialog box opens.

4. Choose the directory that a file is located and click Open button. The layout must be an XML

formatted file.

6.5. Exporting Document 1. Expand the Trading Partner List and highlight the document to export.

2. Right click on the document and choose Export Document or click Export Document button

Page 295: EZConnect HowTo

How to manage Document

295

on the Trading Partner Manager Toolbar.

3. The Save As dialog box opens.

4. Choose the directory that a file will be saved and click Save button

Back to Top

Page 296: EZConnect HowTo

How to manage Job

296

7. How to manage Job This section will guide you through Process Designer. Specifically this section will address:

Adding a Job

Opening a Job

Running a Job

Editing a Job

Deleting a Job

Creating Deployment Package

7.1. Adding a Job

1. Select Process Designer in the Toolbar or go to Operation > Process Designer on Main Menu

Bar or click Process Designer on Operation section of Main Menu Tree to open Process

Designer workspace.

2. The Process Designer workspace opens.

3. Click Add Job button on the Job Toolbar or right-click the Process Designer workspace and

choose Add Job.

4. The Add Job window opens.

Page 297: EZConnect HowTo

How to manage Job

297

Fill in the job name in Job Name field.

Click Save on Action menu to continue Job configuration.

5. Configure the Job by clicking on each tab to fill the appropriate information.

6. Click on Save in the Action menu to save the information.

6.1. Opening a Job

1. Highlight and select a predefined Job.

2. Click Open Job button on the Toolbar or right-click the job name and choose Open Job.

6.2. Running a Job

1. Highlight and select a predefined job.

2. Click Run Job button on the Toolbar or right-click the job name and choose Run Job right-click anywhere in the Process Designer workspace.

3. The job status is running on the Status bar in the Process Designer workspace.

Page 298: EZConnect HowTo

How to manage Job

298

Run Job on Server

EZConnect is now support to run directly the job from server. To set the schedule for the job:

1. Choose the job you want to run on server.

2. The basic steps before running job on server are as follow:

Right-click the job, then click Connect to Server to connect the database of job to

server.

Right-click the job, then click Send to Server to send the job to server.

1. Click on the Run On Server button on the Toolbar or right-click on the Job and choose Run

On Server command. For understand the statuses of running process, see Job Status table

Action Status

Connect To Server Connected - if job connects successfully

Not Connected - if job connects

unsuccessfully

Send To Server Ended

Run On Server In Progress – when job is running

Waiting – when job finishes running

Note: To set a schedule for running job automatically, you need to configure in Job

Configuration Wizard.

1. Click on Schedule Run Setup tab. Make sure the checkbox next to Enable Schedule is checked.

Page 299: EZConnect HowTo

How to manage Job

299

This window allows changing the frequencies and times of the schedule.

2. After specifying all of the scheduling options, just click the Save button in Action Menu

to save changes and returned to the Process Designer window.

6.3. Editing a Job 1. Highlight and select a predefined job.

2. Click Edit Job button on the Job Toolbar or right-click the job name and choose Edit Job or right-click anywhere in the Process Designer workspace.

3. The Edit Job window opens.

Page 300: EZConnect HowTo

How to manage Job

300

4. You are now ready to make necessary changes to the job.

5. Click on Save on Action Menu to save changes.

6. Click on Close to close the Edit Job window and return to Process Designer workspace.

6.4. Deleting a Job 1. Highlight and select a predefined job.

2. Click Delete Job button on the Toolbar or right-click the job name and choose Delete Job.

3. The Confirm Job Delete dialog opens.

Page 301: EZConnect HowTo

How to manage Job

301

Yes - Deletes the job.

No - Closes confirmation window without deleting job.

6.5. Create Deployment Package

1. Highlight and select a predefined job.

2. Click Create Deployment Package button on the Job Toolbar or right-click the job name, then click Create Deployment Package.

3. The Create Deployment Package window opens.

4. Select a Trading Partner and browse to a Output Folder for placing the .Msi installation file is

created. Besides, you need to choose an appropriate platforms and select some necessary softwares in check boxes below that your system lacks of them. in Click Create button to start.

Page 302: EZConnect HowTo

How to manage Job

302

5. A dialog opens when creating package and installing softwares successfully.

In case you don't select to install softwares in the Create Deployment Package window, the

following dialog opens when creating package successfully.

6. An icon of Deployment Package is created at the Output Folder.

Page 303: EZConnect HowTo

How to manage Job

303

Back to Top

Page 304: EZConnect HowTo

How to manage Process

304

8. How to manage Process This section will guide you through Process Management. Specifically this section will address:

Adding a Process

Editing a Process

Deleting a Process

Running a Process

Opening Log File

Showing Tracking

Setup an External Process

Setup EZConnect Component

Setup a Communication Component

8.1. Adding a Process

1. Open the job to add process

2. The Job workspace opens.

3. Right-click anywhere in the Process Configuration pane, click Add Process.

4. The Add Process window opens.

Page 305: EZConnect HowTo

How to manage Process

305

5. Fill in the process name in Process Name field.

6. Choose the type of process by selecting item from the Source Type and item from Target

Type.

7. Click Save on Action menu to continue process configuration.

Note: The type selected determines the number of predefined configuration steps that will be

available when the new process is saved. Each Tab provides additional options for further

defining the process being created or modified.

8. Configure the process by clicking on each tab to fill the appropriate information.

9. Click on Save in the Action menu to save the information.

8.2. Editing a Process 1. Highlight and select a predefined process.

2. Click Edit Process button on the Job Toolbar or right-click the process name and choose Edit

Process or right-click anywhere in the Process Configuration pane.

3. The Edit Process window opens.

Page 306: EZConnect HowTo

How to manage Process

306

Note: Depend on the process type you added, the Edit Process mode will change.

When create a process to a job by dragging a process in Process Configuration pane

to the Job workspace, a copy of this process is created and added to job. So editing this

copy only effect to it within the job, not effect to the main process in Process

Configuration pane.

4. You are now ready to make necessary changes to the process.

5. Click on Save on Action Menu to save changes.

6. Click on Close to close the Edit Process window and return to Processing workspace.

8.3. Running a Process

1. Highlight and select a predefined process.

2. Click Run Process button on the Job Toolbar or right-click the process name and click Run

Process.

3. The process status is running on the Status bar in the Job workspace.

Page 307: EZConnect HowTo

How to manage Process

307

Run process on Server

EZConnect is now support to run directly the process from server. It is recommended that the

schedule for the process must configure before running process on server. To set the schedule for

the process:

1. Choose the process you want to run on server, click Run Process On Server button on the Job Toolbar or right-click the process name and click Run Process On Server.

Note: Before running a process on server, job must be connected to server first.

2. The confirm dialog opens when run the process successfully.

3. The process status is running on the Status bar in the Job workspace.

8.4. Deleting a Process 1. Highlight and select a predefined process.

2. Right click the process name, click Delete Process.

3. The Confirm Process Delete dialog opens.

Yes - Deletes the process.

No - Closes confirmation window without deleting process.

Page 308: EZConnect HowTo

How to manage Process

308

8.5. Opening Log File

Open Log File on Client

1. Select a predefined process.

2. On the Process Designer toolbar, click Open Log on Client. Or right-click the process

name in the Job workspace and then click Open Client Log.

3. There is a list of log files created. Select a file then click Open. Or click Open With… to

choose a program to open log file.

Open Log File on Server

1. Select a predefined process.

2. On the Process Designer toolbar, click Open Log on Server. Or right-click the process

name in the Job workspace and then click Open Server Log.

3. There is a list of log files created in date order. Select a file then click Open. Click Open

With... to choose a program to open log file.

Open Error Log File

On Client - Open log files of process contain errors after running this process on client

machine.

1. Select a predefined process.

2. On the Process Designer toolbar, click Open Error Log on Client. Or right-click an error process and click Open Error Log on Client.

3. There is a list of log files created in date order. Select a file then click Open. Click Open With... to choose a program to open log file.

On Server - Open log files of process contain errors after running this process on server

machine.

1. Select a predefined process.

2. On the Process Designer toolbar, click Open Error Log on Server. Or right-click an

error process and click Open Error Log on Server.

3. There is a list of log files created in date order. Select a file then click Open. Or click

Open With... to choose a program to open log file.

8.6. Showing Tracking 1. Select a predefined process.

2. On the Process Designer toolbar, click Show Tracking of EDI, XML, FF. Depend on each kind

of process, the Show Tracking icon of schema EDI, XML, FF are activated.

Page 309: EZConnect HowTo

How to manage Process

309

-OR-

Right-click a process name and click Show Tracking of EDI, XML, FF.

3. The tracking of process opens in Tracking workspace directly.

8.7. Setup an External Process

1. Select Process Designer in the Toolbar or go to Operation > Process Designer on Main Menu Bar

or click Process Designer on Operation section of Main Menu Tree to open Process Designer workspace.

2. Right-click anywhere in the Process Configuration pane, click Add Process.

3. The Add Process window opens, fill in the process name in Process Name field and select the External Component checkbox.

4. Click Save on Action menu to continue process configuration.

Page 310: EZConnect HowTo

How to manage Process

310

5. Configure the process by clicking on each tab to fill the appropriate information.

6. Click on Save in the Action menu to save the information.

8.8. Setup EZConnect Components

1. On the toolbar, select Process Designer. Or on the Operation menu, click Process Designer.

Or on Operation section of Main Menu Tree, click Process Designer to open Process

Designer workspace.

2. Right-click anywhere in the Process Configuration pane, click Add Process.

3. The Add Process window opens. Fill in the process name in Process Name field. Select the

checkbox, then select component you want in the combo box.

Page 311: EZConnect HowTo

How to manage Process

311

4. On Action menu, click Save to continue process configuration.

5. Configure the process by clicking on each tab to fill the appropriate information.

6. On the Action menu, click Save to save the information.

Back to Top

Page 312: EZConnect HowTo

How to manage User Account

312

9. How to manage User Account User Management Operations such as adding new users and assigning them roles, editing the

existing users and deleting the user could be performed only by the Administrators. Other three

types of users do not have this privilege.

Administrators can create as many users as required and define appropriate roles for the user.

From the Settings >> User Account Setup tab, administrators can:

View all the existing users

Create new users

Delete an existing user

9.1. Viewing all existing users 1. Click "User Account Setup" tab on the Settings window.

2. The list of users will be displayed with respective IDs and login names.

9.2. Creating new user 1. Click "User Account Setup" tab on the Settings window.

2. In the UI that opens, click the "Add" button.

3. The Account Information window opens.

4. Enter the desired login name in Username field; this name will be used to log in to the

EZConnect interface.

5. Enter the password in the Password field; the password should be at least 5 characters long.

Page 313: EZConnect HowTo

How to manage User Account

313

6. Click Save. The new user account has been created and displayed immediately in User List Grid.

9.3. Deleting a selected user

1. Click "User Account Setup" tab on the Settings window.

2. The list of users will be displayed with respective IDs and login names.

3. Highlight the selected user you want to delete.

4. Click Delete button to delete the selected user. The User Delete Confirmation dialog opens.

5. Click Yes. The user will be removed from EZConnect system.

6. Click No to close the Confirmation dialog and returns to Settings - User Account Setup

window.

Back to Top

Page 314: EZConnect HowTo

How to setup Email Configurations

314

10. How to setup Email Configurations

Before you can use your email account you must set up your email program. The following links

give step-by-step instructions for setting up most common mail programs. Please select the link

appropriate to the software you are using:

The outgoing mail server (SMTP) cannot verify who you are and will not allow you to send mail.

You will need to change your outgoing mail (SMTP) settings to use your UH Username and

password for authentication.

1. On the Tools menu, select Settings...or click Settings on Tools section in Main Menu Tree

2. The Settings interface opens

3. Click on Email Config tab

4. In Server Information panel:

Fill in the Outgoing Server (SMTP) text box.

Page 315: EZConnect HowTo

How to setup Email Configurations

315

Select Server (SMTP) requires authentication

Enter the Outgoing Server Port.

Select This server requires a secure connection (SSL)

Under Server Timeouts, move the slider toward the timeout.

5. In Logon Information panel:

In the User Name text box, type your account name. Do not include @xxx.com.

In the Password text box, type your account password.

6. In Testing panel, enter Test Email address then click Send Test Email button for checking.

7. Click OK to save the email settings and closes the Settings interface.

8. Click Cancel to close the Settings interface without saving changes.

Back to Top

Page 316: EZConnect HowTo

How to track Document

316

11. How to track Document Use the following instructions to track of missing or late documents within EZConnect:

1. Open Tracking workspace by select Tracking in the Toolbar or go to Operation > Tracking

on Main Menu Bar or click Tracking on Operation section of Main Menu Tree.

2. In the Tracking Search pane:

3. In Common panel, set the common search criteria including:

Trading Partner

Document Type

From Date

To Date

Page 317: EZConnect HowTo

How to track Document

317

Direction

Status

4. Click on the Advanced Search link to set the appropriately advanced search criteria including

advanced EDI, XML and Flat File.

5. Click Search button to apply the selected search criteria to the documents. <See sample tracking

search result>

6. Click on each item to view detail input information about the document highlighted on the

Search Results Grid

7. Click Clear button to clear all search criteria.

Back to Top

Page 318: EZConnect HowTo

How to manage Report

318

12. How to manage Report

View reports

Print reports

Export reports

12.1. View reports

1. Open Reporting workspace. The Report workspace provides details on the configured

information including Trading Partner, Maps and Dictionary-Schemas.

2. In the Report pane, select the appropriate report panel you want to view and choose report

criteria.

3. Click View button to see the detail report based on your selected information.

Page 319: EZConnect HowTo

How to manage Report

319

12.2. Print reports

Printing a Complete Set of any Report Type

After selecting the report type you want to print, select the print icon in the Report toolbar to

print the report as shown in figure above. A standard print dialog box will appear similar to the

one shown in figure below. Simply leave the “All” Print range selected and press the button

Print Options Window

Printing a Specific Section of the Reports

After selecting the report type you want to print, identify the first and last page of the reports you

want. Find the number of the first page by selecting the population within a group such as Female

in the Gender section of the preview tree. In the current page box above the “preview” tab, the

current page number is displayed.

To find the last page number of the section you want to print, select group in the the section after

the section you want to print. Once the report refreshes, press the left arrow to move back to the

Page 320: EZConnect HowTo

How to manage Report

320

last page of the section you want.

Enter the page numbers in the Print range “Pages” boxes in the print dialog box and press button.

12.3. Export reports 1. Click on the Export icon in the Report toolbar.

2. The Export Report window opens.

3. Select the desired format from the “Save as type:” drop down list.

4. Fill in the file name in File name: field

5. Travel to the location you wish the save the file to and click the “Save”.

6. You can now go to that location on your computer and open the file.

Back to Top

Page 321: EZConnect HowTo

How To Create Global Function

321

13. How To Create Global Function

Global Function Editor is used to create definitions of new functions that can be accessed by

any Map within EZConnect.

1. On the Tools menu, click Global Function Editor...or on Tools section in Main Menu Tree, click Global Function Editor.

2. The Global Function Editor interface opens

3. Click Add button to active all fields for starting defining new function.

Page 322: EZConnect HowTo

How To Manage Email Template

322

14. How To Manage Email Template

Email Template helps to reduce time for composing a same format of email because it allows to

create templates that can be reused at any time.

1. On the Tools menu, click Email Template or on Tools section in Main Menu Tree, click Email

Template.

2. The Email Template workspace opens.

3. To manage Email Template, use Email Template toolbar or right-click a template name in Email Template workspace.

Page 323: EZConnect HowTo

Using the Toolbox

323

15. Using the Toolbox Here is a reference list of common Toolbox tasks and how to do them:

To Complete the following steps

Open the Toolbox From the View menu, select Toolbox.

Make the Toolbox close

automatically

Open the Toolbox. Right click on the Toolbox panel, select Autohide.

Make the Toolbox stay open Open the Toolbox. Right click on the Toolbox panel, clear Autohide.

Move the Toolbox to a

different location

Open the Toolbox. Right click on the Toolbox panel, clear Autohide,

select Floating. Drag the Toolbox to the desired location.

Expand a Toolbox tab Select the name of the desired tab in the Toolbox.

Scroll through an expanded

list of items on a Toolbox

tab

Click the UP triangle at the top of the expanded list, or the DOWN

triangle at the bottom of the list.

Move an item from one

Toolbox tab to another

Drag the item from the expanded Toolbox tab onto the name of another

tab.

Change the position of a tab

in the Toolbox

Drag the Toolbox tab to the new location preferred, and release the

mouse.

Change the position of an

item on an expanded

Toolbox tab

Drag the item to the new location preferred, and release the mouse.

Rename a Toolbox item Select the Toolbox item and choose Rename Item from its shortcut menu.

How to add items to Code Pane window

Drag and drop code macro items from Toolbox panel into Code Pane window

As illustrated below, the code macro item FUNC.Trim(DB.Shippers.ShipperName) is

Page 324: EZConnect HowTo

Using the Toolbox

324

drag and drop in Code Pane window. The following code will be appeared in Code Pane

with the syntax below. See the Database to XML mapping for illustration.

Back to Top