Home

Extreme Translator v1.9x User`s Manual

image

Contents

1. Etasoft Building blocks of intedration Extreme Translator v1 9x User s Manual Copyright O 1998 2009 Etasoft Inc Main website http www etasoft com Extreme Translator website http www xtranslator com Extreme Translator iig i e S 3 Redquiremefhts mica 3 Enterprise or Lite Edition liCenSe aia 3 The role of translatOFs siii 3 What translators can dO msccacnstc a as 4 Map i re P 4 How todo the mapping nica ade 6 AAA A e o ro MM NEN Aai 7 Plug ins and NET components coccccccccoocnnnnnnnnccnnnnnnnnnnnnnrnnnrnnnnnnnnnnnarrenannanannnns 8 Command line batch processiNg cccccocccocconnnnnnnnnconncnnnnnnnnnnnarrrnnnnnnnnnnarrrnnnnnns 9 Passing parameters via command line ssssssssssus25222 22 22 222222u2220 11 Dialog based processIng sssseusxsuxunszuukwis uni SERE a 12 What are the maps How to do the mapping 12 l dr4 qi T 14 Template RP 15 Translation aicrrirancic az uuu iu nEF a a 16 EDI X12 EDIFACT Translation riesen uam na RR Rt eau rear 17 HIPAA SUDDOTE asociacion 19 PFODOFTtIGS ieriet ouxuE kinda RIS eii 20 Biol pie ge eis du RR D e o o POE EE EEE OO 22 Condition and ConditionType properties uaacosarann op an 26 Aiao A 27
2. Example of detail query attached to the master There ord_info is the MasterQuery while ord_stat is the detail For each record of the master detail is executed and ORDINFO_ID is passed into it Properties Tab Properties Tab shows all the properties of the currently selected map item You can edit any properties that are displayed in black Property list can be displayed in groups Common Advanced Separators etc or it can be sorted by property name Some properties allow entering decimal codes in cases when they are not displayable characters and cannot be entered using the keyboard One of most common cases is CRLF carriage return and line feed character sequence it is also called new line You can enter decimal characters 13 10 and they will be treated as CRLF If your data is separated with just LF you can use 10 only should be entered before any decimal code The properties where you can enter decimal codes are StartTag EndTag LoopEndTag SegmentSep ElementS ep SubElementS ep E scapeCharacter Filter Etasoft Inc Page 43 9 9 201 1 58 Extreme Translator Mapper C testnow trans utopia 4xmp Modified File Edit Project Tools Help mM t Em e Egi utopia EE 12 810 1N Invoice H E ord info La 154 B E odsta E Info Qualifier 1 H E ard items 00 Authorization Info Snumelupe File E e cust Item LT Security Info Quali Speciallastruct Mone fT Security Info 4 TranslationT ype 12 LL
3. special instructions can be used on input elements Tells also discussed in translator to output looping element inline See EDIX12 to FlatFile additional document example related to looping issues It can also be used on output elements of flat file See end of Text and itis available as Translation chapter separate download on AppendToFile instruction to append output to file rather than our website overwriting and creating a new file use on root item only DeleteWhenDone instruction to delete files after processing has finished use on root item only OutOfLoopData instruction for translator do not pay attention to sequence of this element in the loop It can be used on looping elements that are inside of the loop but data into them is coming from other loop use on elements only It should be used only as exception in cases when default looping does not work correctly FlatOutputInline it can be used on output element to make it line up correctly in the output file ConditionType Two properties form simple conditional IF statement Condition Currently implemented for TranslationType X12 Edifact XML You can specify multiple conditions under one segment by simply entering them separated by commas ValidationT ype Type of validation to be performed Validation ValidationType is MustEqualTo then Validation should be the value you expect in the input Validation Type is SchemaFile then Validation should be
4. Map object name Add first segment under the message Repeating this task you can define whole map It is tedious and time consuming lt is much faster to use wizard and have map ready for you in minutes However there are times when manual mapping is the only option because input or output data is so complex that no generic rules can be applied to create the map from scratch You can also use Copy Cut and Paste to move items around All these actions can be applied both to first and third panes So you can copy items from one tree view and paste into the second Drag and drop using mouse can be performed as well however you should be careful using it because it is very easy to drag n drop items and have them added to incorrect location Sometimes it is even better to disable drag n drop You can do it in under menu Options If you hold Ctrl key pressed during drag n drop operation it will result into copied and pasted items in the new location If Ctrl key is not pressed it will result into cut and paste operation Note You can map un map items that are at least two levels down in the tree view If it is root item or item directly attached to the root nested only one level Map Un map menu option will be disabled The reason is that you should define loops SQL queries and segments under root not real data items that can be mapped In case if you do not have any loops just define at least one segment under the
5. Query and checked fields will be added to the map Etasoft Inc Page 38 9 9 201 1 Extreme Translator SOL Select Query Options Mame mu table LIL SL select statement select from MANYTYPES TEST intld langlnt decNumber single Mumber doubleN umber currencylumber 12 boolT ype memoT ype Adding query and fields to the map Map editor will try to detect queries field types and sizes Some specific field types may not be detected properly and may result in data truncation or failure during data retrieval SQL can be edited after query is added If new fields are added to SQL statement SQL property and should be retrieved you should add them under the query using Add and Field menu option and map them to output Etasoft Inc Page 39 9 9 2011 Extreme Translator A mes SEE IER PPS Le v a Jp Pe PRP EA a e I 0 l E File Edit Project Tools Properties Data 0 A lanalnt El Lommon ch decNumber dd 38572 sch single umber kernT ype SOLQuery r h double umber Mame my table tp curencyNumber E Processing EP bool ype MasterQuerny peciallnstruction None select from MANYTYPES_TEST 3 validation ValidationT ype Validation Validation may be actual value expected in the item ar ML Schema file path Major query properties Etasoft Inc Page 40 9 9 201 1 Extreme Translator E Extreme Translator Mapper Modified File Edit Proje
6. This macros is replaced with current date in form CCYYMMDD Y SystemDateT ime This macros is replaced with current date and time in form CCYYMMDDhhmm property ID This macro is replaced by actual processing data from input or output Example if DataPath is set to C test output 187645 ixt translator will replace 187645 with the first value that item with property 1d2187645 has during translation Important Macros are case sensitive They can be used only in one to one mappings when one type input message is mapped to one output message Etasoft Inc Page 23 9 9 201 1 Extreme Translator Lt a Py Tatar hip LALIC HIST OF CP ee Peak T Lr r St o A A File Edit Project Tools DH Be 4 Text with delimiters Message 172 835 HP Health Ca gt Looping BasedOnParentOnly RootTupe Output Source ype File Speciallnstruction Mone D ataP ath Data source or destination as file path database connection elc Example of macro input usage Etasoft Inc Page 24 9 9 201 1 Extreme Translator M E A y i y ka F g E JT 45 Extreme Translator Mapper C WtestnowitransMest3 xmp Modified File Ed Te Helr ELIT El E Test File or Message O Transactior Properties Log 07 Data 33 D Header lt Q Transactior GEL A Oi Refer BSN E 21 E 2 ff Custna lt Q Transa B Common A T Mame 2
7. e o RE E UE EE i a O EAE EE E EE EA AEE E T tne cadets 31 XML Translat sossa N Ra 33 Etasoft Inc Page 1 9 9 2011 XML Schema Validation cuina ERN RESERERRS RREDRURCUREEERNEE EFE CENE 34 Flat Text File Translation caca ia 34 Database Mappings issus wiki in cic occi ior sien ir RR WE ROW ERO RIO RD DR RE RR 36 MESSI ARI NE dao da Ihsertng data VLOG a Sumado ente veto npe ot Serecthg Calla O O nd feug Properties Tab vus ex oves vussascuase ves ever vavisve ecvessvveres cu cacaacaaa 43 Log TaD iaces a A ARA A FO FER EKRR CES 44 Data E o 45 Technical SUPPOKE irc 46 Etasoft Inc Page 2 9 9 201 1 Extreme Translator Extreme Translator Purpose Extreme Translator was designed as lightweight Business to Business middleware integration suite It was designed as extension and next generation product suite based on our successful Import Export Studio software package Primary purpose of this software suite is data translation and conversion from one format to another We have incorporated both file to from file file to from database translation Our goal is to keep it simple and lightweight Requirements Table lists minimum hardware and software requirements for the application to run CPU Pentium 3 700 MHz RAM 256 Mbt HDD 2 5 Gbt Other Keyboard mouse Operating System Windows XP Vista 7 Server 2003 If you are working with big data files and map files that are more than 50
8. Extreme Trans lator nrnrezsinu Error Product is not licensed License key is not valid stack lrace at axlrans Lore axlranslatorJob KHuninputtaxinputParams priInput axMap prMap gt in d net src xtranengy axTIranslatordJaob cs line 128 at xtranrun axIranzslatorHun Hun amp StringL L l args in d net src xtranrun saxIranzs latorRun cs iline 189 Running the map in command line with invalid or expired license key produces error Etasoft Inc Page 9 9 9 2011 Extreme Translator EX Administrator CA Windows system32 cmd exe lx D net src Dehugy xtranrun exe G testnow strans sHejectionzsZ xmp LIGEMHSE 382 F883hA IFFL8 FEAF 55FT Copyright lt C 1978 2665 Etasoft Inc Extreme Translator processing Completed without warnings ompleted D net zrc Dehugy Running the map with fixed input and output files Example 1 You want to perform file translation and you have made a map for it If you pass Input and Output parameters you can process specific file each time You can also use wildcards to process multiple input files Example 2 You do not want to use constants like in previous example You want to hard code data path into the map for simplicity In this case all you have to do is supply one parameter in command line and it is the map file name PluginDirectory parameter lets change the folder name for the plug ins This assumes that you have put correct values into DataPath properties of the map and
9. Format Mandatory False Sequence SpecialFunction None El Plugin EstemalFunctiar Parameters E Processmg EndT ag noapEndT ag c mappings tor Siallnstructic None specific item ig CM Elbe Container Status B Reefer Temp SE Temp Indicator inane m This is how to reach mappings for editing amp sing Fixed Length ength False ExternalFunction External code stored in library Mappings can be rearranged deleted or edited When you use menu option Map Unmap all data from the item is mapped to the destination output But you can change this default mapping option and specify actual sub element you want to extract and use This is especially useful for EDIFACT mappings where many data elements are composite of sub elements Etasoft Inc Page 13 9 9 201 1 Extreme Translator Ok Mapping Mapped Destination Mapping To All data EDI Batch Subelement 1 Lancel Move Up Move Dawn Delete There is how you can map to or from sub elements Wizards There are two major wizards One is based on template model and another one on sample data you can provide 1 Add from template wizard is like storage of existing maps that are already pre built for you However those maps are mostly for standard implementations of EDI X12 or EDIFACT documents You may also save some of your pre built maps into templates for future use 2 Add
10. ID Qualifier 5 UseButter True E Sender ID 5 El Separators fT ID Qualifier 7 ElementSep LL Receiver ID 8 Escapelharact Date 8 EE i60 31000 LL Time 10 SubElementsep LL Standards Id 11 SubElementSer E Control Version 1 co Usedep True LL Control Humber 1 Tools LL Ack Requested 1 AutoDetect True LI Usage 15 LhangeCase Mone LL Component Separ Encoding ASCIL Zbit OO Functional Idei E e 0 ULL Sender Code p C3 Processing finished successfully There is how to use non printable characters in properties In this example carriage return and line feed is placed in the output file Log Tab Log Tab should display warnings and non critical errors in a form of the list That means processing finished with warnings and minor errors but output was produced anyway Most of warnings are data validation errors Some of them are based on assumption that data we received do not match certain rules defined in the map however those restrictions are not critical and output was produced anyway Etasoft Inc Page 44 9 9 201 1 Extreme Translator a Ext reme Translato r Mappet CE now File Edit Project Tools Help O co Ed de Em B 0 E E EDIFACT COAF E E Liner Application TOS Format Type Description 5 p 4 de dd EY gt Ra rg Er AY 5j JY gemens Mia Ue mni n
11. LE Shipme Datal ype DBl 5torenum E LLI Date ld 184123 LT Carton Een Oo Time ItemT pe Element Lil Invdate nr element that will be ud A Mame LH DETSILND le asics output file name ana El Advanced LLI nifl i Property Id will be used in Ms a Format xi g Tote i DataPath property on the Mandatory True I Detail output side E Sequence TDI S SpecialFunctiir None T E Prise el TDS 7 E Plugin xig TD3 ExteralFuncti Ig REF Farameters H DTM O Processing DTM EndTag DTM LoapEndT ag N1 Speciallnstruc None m o LII En C eT n TI Ide al Map object name den Processing finished successfully Example how propertyID macro can be used to form DataPath based on the input or output data See next screen shot for complete illustration Etasoft Inc Page 25 9 9 201 1 Extreme Translator File Edit Project Tools Help OSA E z Text File c Properties Log 07 Data 0 lt i Heade 1 Ge ATI Ar le TI Info Qualifier loss 2y E d eee T Authorization El Common ON I Security Info d 57691 B St f LL Security Info temType Message HT Ce CO ID Qualifier Mame A12 855 5H Ship Notice Manifest Bl n L Sender ID B E Procesami O Ol AAA Qualifier E DataPath C Xtestnow transkouUzT11841 23 Ext T CL fill er e Sen po P IrniFile L Stestnaw transxedicantral ini xi g Tote j name should be formed K Looping BasedOnParentOnl
12. NET class library DLL and placed into plugins directory 2 Class must have default constructor that has no parameters 3 External function method should have special signature return string and take three parameters integer map object Id actual processing data as string and function parameters coded in the map as string as well Library can be built using VB C or C pluginsamples directory contains samples of plug in functions in C You are free to copy the code and modify it for your own needs Library can be built using IDE tools or build from command line If you use command line tools go to the pluginsamples directory and in order to make a build type csc exe t library EDIMain cs nologo Metadata about plug ins is loaded into translator map editor only once during startup If you update or drop new plug ins library Etasoft Inc Page 8 9 9 201 1 Extreme Translator into plug ins directory map editor will not list all the new external functions until you close and reopen editor again Runtime Parameters lo E a i Runtime Plugins Settings Directory C Mranelatorspluging T Pre processing gt Translatorwillsearchfor plug ins in the following Parameters A folder Post processing Parameters Cancel External functions are stored in subdirectory called plugins by default Plug in can be passed into translator batch process via parameter PluginDirectory Example
13. PluginDirectory C mytransalator myplugins In this case it will overwrite value used in the map Runtime Parameters dialog Pre processing plug in is called at the beginning of processing and post processing plug in is called at the very end of translator processing Any actions can be performed in these plug ins it can be file deletion renaming or even file sending by email operations When pre processing plug in is called passed in Id equals 0 and when post processing plug in is called passed in Id equals 1 If pre processing plug in returns null it is treated as translation abort event and translation does not continue This feature can be used to receive data via some network communication and if data is not present do not run actual translation Command line batch processing In order to run translator in Batch Mode you need to use utility called xtranrun exe It should be located in main application installation directory If you want to see the usage simply run it without any parameters in command line Batch utility returns O zero in case if processing has completed successfully and 1 minus one if it has failed Usage is xtranrun exe map file name xmp License YOUR LICENSE optional datapath1 optional datapath2 EX Administrator CA Windows system32 cmd exe mA D net sre De bug gt xtranrun exe Cisxtestnow trans Re ject lons2 xmp LICENSE 431 F4835 pN IFFL8 FEAT 55FT Copyright lt C 1998 2005 Etasoft Inc
14. Properties EE 4 Pad lharacter Pad ppe E Script Script EEN Condition P8 PO PE Condition Type FirstHestedltemE qualsTo Validation Validation Validation T ype Condition Conditional statement for the translator A E Nu j 4 rate A bee z 2 A psi z tren Pi PLA EL E G E PA E S Tz It Ea ns a itor Pap Fer Az yl h DE J ul i X d T File Edit Tools Help ALE ah Affecteditems h Affected tems Osh Affecteditems ah Affected tems Gah Affectedltems ah Affecteditems Uh Affectedltems ah Affecteditems Uh PageTwo B I Parts ef TD uniqueld g Iph TitleBlock Lg FageThree Ce PageT wo Properties 55 24 a FadLharacter Pad ppe El Script Script SLIL FirstHestedltemE quals T o V alid ation Validation Validation ype Condition Conditional statement Far the translator Only MiscRecord s with SI and IL are placed in the output Format property Etasoft Inc Page 27 9 9 201 1 Extreme Translator It is advanced property that allows special formatting to be applied to data during translation lt is powerful feature There are number of types of expressions you can use in this property Function Description Value Place constant value into the element or field ValuelfNull Place constant value if data for that element or field is NULL no data _ ValuelfNotNull Place constant value if data for tha
15. XML file Definitions Text field delimiter Text record delimiter ERLF First row contains field names Element 1 Element 2 Obsolete Obsolete Obsolete Obsolete Obsolete Obsolete 4 Element 3 ul Comma T Hew line Element 4 JuPB5542 PAPES JuPB5544 PAPES WWPETO PAPA 00 Element 5 Packaging Packaging Packaging Packaging Packaging Packaging Extreme Translator Properties JA ES E Common DataType undefined ld el Item ype Segment Mame NameNumber O Advanced Format Mandatory False Sequence SpecialFunction None El Plugin Name Map object name If you choose Text file with delimiters wizard will give you data preview based on delimiters you choose Templates Etasoft Inc Page 15 9 9 201 1 Extreme Translator Software comes with over 5000 pre built templates If you need a template for some standard mapping that is not included in templates let us know and we will create template for you free of charge If you develop a map and you think it can be useful for others using Extreme Translator you may send the map to us and we will consider it for inclusion into our next release of the product as a sample map or template Special mapping services are also available check our website for details E te Templates Templates E x12 4010 100 PG Insurance Plan Description mp 101 NL Mame and Address Lists mp 104 54 Aur Shipment Information mp 105 BF Busines
16. all fields that come in the input after PrimaryKey should be marked as NotNull or Nullable 2 NotNull fields should always have data in them If there is no data in the input NotNull fields will borrow data from values in previous record 3 Nullable fields can have they values discarded If there is only one Key value and two Nullable field values first value will be lost overridden with second value coming into Nullable field Nullable values should come after PrimaryKey value in the input side 4 Optional field is like Nullable field with only difference that it s value can come from input data that is above first value that comes to PrimaryKey 5 ForeignKey is used to mark field that is used to form relationship for PrimaryKey on other table Example there are two tables Header and Detail Header has PrimaryKey and some Nullable fields Detail will have one Etasoft Inc Page 41 9 9 201 1 Extreme Translator PrimaryKey some Nullable fields and one ForeignKey Detail ForeignKey value will come from the same item on input side where Header PrimaryKey data is coming from Look into XML to Database sample for more details Using these concepts you should be able to achieve almost any record ordering ME Extreme Translator Mapper D net bin files samples book anp File Edit Project Tools Help DEB TESTS EE ML Sl ET SAMPLE Properties Log Data 0 SE BODKXML_HEADER esa i COMPANY IS zt I El Advanced Format
17. i gh A LLL gem etur zh AA i PS a il h rrp hee o 1 i oh X anms d 1 T 71 Aco E Pi i F L My y Waning OTM segment out of sequence ar nat Warming OTM segment out of sequence or nat Warming OTM segment out of sequence or not Wearing LOC segment out of sequence or not Warming LOC segment out of sequence or not Wearing LOC segment out of sequence or nat Warming LOC segment out of sequence or nat Warming MEA segment aut of sequence or not Warnings displayed 3 In Lag tab e Check the logs Processing Finished with warnings Warnings produced during execution Data Tab Is designed to show processing data attached to the map item After processing each item in the map has data associated with it That is whatever was retrieved from the file or written to the file and attached to the map item You can select item and see data attached to it Each item can have 0 to many data blocks attached to it This is because most of the map items can loop Etasoft Inc Page 45 9 9 201 1 Extreme Translator m t Te Extreme Translator Mapper C testnow trans Rejections3 0np File Edit Project Tools Help Dg S Re EO parentNum gt E A Processing data for select Length O providerlD donet 1 25 1 provider ame pU 145 4 EU provider amet PoP ER 105l lazt ame 2 PNE 140 LBl first ame 3 Re ER me WENS 100 i 140 b 1001 65 LL Diaani yan G
18. into database tables You have to define database objects in the map in order to process them in translator Root item database object can be defined using popup menu Add and Database Etasoft Inc Page 36 9 9 201 1 Extreme Translator amp amp Extreme Translator Map File Edit Project Tools Help ai 5 55mm Add Message Cul segment EM Element Co py Paste Paste With Mappings Delete Mappings Adding database to the map Add Database dialog contains connection string information ODBC data source name user name and password ODBC data source should be defined in Control Panel under Data Sources ODBC rem FL FC A AS i PER Ex User DSN System DSN File DSN System Data Sources Mame Driver Add Driver do Microsoft Access mdb opth heim MySQL ODBC 3 51 Driver test Driver do Micrazaft Access mdb transtest Driver do Microsoft Access mdb An ODBC System data source stores information about how to connect to the indicated data provider A System data source is visible to all users an this machine including MT services Cw Windows ODBC data source manager Sometimes databases do not require user name and password in that case it should be left blank You can use Test Connection button to make sure connection works After you press OK connection information is used to populate DataPath property This property can be modified late
19. path to XML Schema file for validation Etasoft Inc Page 21 9 9 201 1 StartTag Itis a generic name for data block that indicates start of segment or element If it is used for input it indicates boundaries where data starts If it is used for output it indicates what will be placed to output before the data EndTag It is an end marker for data block Should be used for items that have no nested items attached It is supplement to LoopEndT ag LoopEndTag It is an end marker for the block of looping data Should be used for items that have nested items and those items have nested items too SQL Free form SQL statement It must be used in queries where SQLType set to Select Can also be used in queries with SQLType InsertOrUpdate or Update In this case SQL is added to WHERE clause for database Update Example if you want to update records only if they have field State 1 in this case your SQL should be AND STATE 1 SQLType Select should be set for database query used on the input side All other flag values are for database tables on the output side Translator will use first PrimaryKey field in the database to perform Insert InsertOrUpdate and Update operations InsertOrUpdate is a combination of possible operations on the database where translator will select row from the database based on PrimaryKey and if it exists translator will perform u
20. root and hang all the items under it That way you can map them all and segment is just a placeholder How to do the mapping After you define both map segments and elements for input and output you can use popup menu in the right tree view Follow these steps 1 Click on the item on the left tree view 2 Click on the item on the right tree view 3 Press right button on the mouse to get popup menu 4 Click menu item Map Unmap Etasoft Inc Page 6 9 9 201 1 Extreme Translator a nr LH Tu ATE me i I E zt T E VO Pm ure T bangi Nea n m ds A A Er LA iT L E A a DLE ae Me DOE ee UNT EXCESS NX TAL P treme lranslator IvVlapper G testnow trans Relectia T Li ks uu n il Edit Project Tools Help i C CONES wea isZ xmnp Modified Properties Lag Data 0 i LLI parentum i E m TOU CE UTERE EE EM ERA i Bes L ED providerlD o _Map7Unmap adefined LO provider ame 3 l 13 a LL provider ame Add ement O lastName S s Cut aim Subm m ut ON first ame Copy Paste Paste With Mappings 00 level Delete Y cprCade E ae Mappings H Perform mapping using right popup menu Map Unmap There is also a way to create mappings faster using Auto Map feature It is available via Edit menu lt tries to suggest mappings based on translation type and matching item names on both sides of the map Suggested Mappings Message reference number 1 gt
21. 0Kbt in size you need much faster machine This is recommended configuration CPU Pentium 4 1500 MHz RAM 512 Mbt HDD 2 5 Gbt Other Keyboard mouse Operating System Windows XP Vista 7 Server 2003 Enterprise or Lite Edition license Wu Evaluation version can be distributed free of charge een Licensing is based on number of installations Retail version with setup license key can be installed on as many machines as many licenses have been purchased License It is possible to buy unlimited install and distribution license You can find more licensing details on our website User You can register and buy licenses from our website After the purchase email will be send to you with the license key You should go to submenu Options under menu cmm key 1TI FABBLAAAAA STLE 5BE Project and enter that key in License Key field If license key is not entered or has expired translation will not run and license key has to be purchased Options View License Company Humber af licenses 1 Enterprise Edition is oriented towards companies and users that wish to automate data processing Enterprise Edition can run as part of batch process or be scheduled to run at certain times or time intervals via Extreme Pec Processing process Cancel Lite Edition is for manual data processing only It is much more restricted in runtime utilities that can be used to run
22. 1 EDI X12 276 Health Care Claim Status Request EDI X12 277 Health Care Claim Status Notification EDI X12 278 Health Care Service Review EDI X12 820 Payment Order Remittance Advice EDI X12 834 Benefit Enrollment and Maintenance EDI X12 835 Health Care Claim Payment Advice EDI X12 837 Health Care Claim Properties You can see there are many properties describing each item in the map As you click on the item all properties are displayed and you can change them Some properties are common to all objects such as Name Id DataType ItemT ype There is the list of most used properties and they explanations Name The name of map object can be any name defined by the user You _ should use names that are meaningful DataType It is the data type of the object It can be String Integer etc It is used for conversions and in special functions You may leave it undefined unless you are going to use special functions ld Internal object ID used by translator Format See special chapter Format Property Mandatory This item must be present This especially useful during export when you want certain elements produced in the file if other elements are produced However you cannot make all the elements in the segment mandatory because it would create infinite loop during export Sequence Name of the sequence to be used to generate unique numbers Useful at times when transl
23. ECT PO ID PO LINE NO PO ITEM NAME FROM PR LINE Both queries can be tied using master detail relationship You can add both queries using Add SQL Query menu item and set MasterQuery property on PR LINE to point to PR ORDERS also use field PO ID to make a relation Detail query should be modified to SELECT PO ID PO LINE NO PO ITEM NAME FROM PR LINE PO ID Q9PO ID Symbol means that field from master query should be used to fetch results from this query It is possible to nest queries 4 levels deep That is header detail1 detail2 trailer with each query passing parameters to the one nested below Etasoft Inc Page 42 9 9 201 1 Extreme Translator E TUM 3 Extreme Translator Mapper C AP estas Frans ito pia xmp File Edit Project Taals Help Dekj mte Ar la E w utopia E Properties Lag Log Data B 0 EH ord info MN NEUES 5 shipm sz I T ord stat T 9 E ones v This is where Si E9 ord items chord eer El Common E cust item reiatiansnip TO Master ld 1747 query I setup ItemT ype SlLuery ra 2 Mame ord stat 2 HE x Eae c1 teat El Processing Ba La IT MasterQuery i Mone 3 m Ig TDS Speciallnstructi m CAD TL ETIN SELECT FROM DAD STAT WHERE D Ig SAC elect p Full SOL for this query is SELECT FROM GORDI STAT WHERE ORD _STAT ORDINFO_ID 0RDINFO_ID e Processing finished superecialle
24. L Quantity 12 Oo InvoiceNum zd o fe E Percent 13 i1 Eg CAS lg NMI 0 MA C akh lH 4 t Flat file to EDI X12 mapping example Extreme Translator y CA EDL File Edit ae Tof flat file a le side Format Mandatory False Sequence Special ur Mone El Plugin p ExternalFu FlatFilter E x Parameter El Processing Endlag LoopEndT Speciallns None Start ag El Processing Fixed Leng FixedLengl False Length O FadCharac FadTvpe Left El Script Script E special Processmg Speciallnstiaclon Special processing instruction for the translator There are certain properties on the message level that need to be setup for EDI files X12 EDIFACT to be processed We will take simple fragment of EDIFACT file and do the mapping to flat file with output data elements separated by delimiters First you need to setup DataPath property We simply make it point to file in a local drive Etasoft Inc Page 18 9 9 201 1 Extreme Translator ES Extreme Translator Mapper E Atestnow trane Rejections3 xmp File Edit Project Tools Help OSHO Ber TELS E E Text with delimiters 2 Se 835 HF Health mn 155 E Common ld E ItemT ype Message Mame 212 635 HF Health Can Processmg DataPath XtestnowXtranskT EST J riF ile Looping BasedOnParentO nly Root ype Output Source Type File Speciallnstruction Mone TranslationT ype UseButter True Separators Elements ep E
25. Message Date Message Identifier 2 gt Message Time Contact function coded 1 gt Container Temperature qualifier 1 gt Temp Indicator Contact function coded 1 gt Container Status Temperature qualifier 1 Temp Indicator Control 1 Container Message reference number 2 Message Date There are 8 suggested mappings based on match Check mappings you want created in the map Once mappings are checked and accepted they are added to the map Integration Etasoft Inc Page 7 9 9 201 1 Extreme Translator There are number of ways for integrating middleware products We try to support most of options available Integrations supported Batch Mode processing stand alone Extreme Processing Script Runner Developer SDK for NET ActiveX component Plug ins and NET components Translator engine can be integrated into application by using NET components and classes exported from the translator library That way translator maps can be executed directly from the application without a need to run external processes using shell commands In order to receive translator Software Development Kit you need to obtain Developer license X se Extreme Translator Mapper C testnow trans MYPRG MorthPort COARRISS5B 4 xmp File Edit Project Tools Help Du Es5m T pP RI EDIFACT COAR c Ig Unboard Record SIE 0 DB Running LL Syntax li F Bl EDI Batch p e Message Dat
26. Position number count starts from 1 not O Will place all data in this location so 00 would print 00 all the data Example 1 You have data in format YY YYMMDD coming from EDI X12 file You want to convert data into format MM DD Y YYY In order to do that you can setup F ormat property like this Form 5 6 7 8 1 2 3 4 Etasoft Inc Page 28 9 9 2011 Extreme Translator This basically says take character at position 4 from input and place in position O then take character at position 5 and place at position 1 place take character 6 and place at position 4 etc If you need to add some constant data to the output of some element simply use Example 2 You want to add four zeros in at the end of data Your Format would look Form 0000 eme Translator Mapper C testnow trans Rejections3 xmp Madified File Edit Project Tools Help AE A p E Gah CLP a Properties Log _ Data oy I provider Li a LLI provider ame Eod DataType undefined TEE ld 254 Item T ype Element Claim Status Code 2 Form _00 used to Er ans append two zeros to the A Patient Sequence incaming data in this fuss Ia opecialF unction example Zl Quantity E E Plugin LE cpitode E LL Percent EsternalFunction 3 I toed Service UT a oat h CAS Ella e l Format H MMI Data formatting LE MIA EU modifier ON charges 4 Till r 4 TR t pr Ex
27. T INVC E Data 0 gt ML Schema n El Tools validation should be AutoDetect True set on the input side j ChangeCase None ai Encoding ASUII 7bhit Filter Remove Substitute Trims paces Xteststranssinvprb schema xsd Validation ype Schema ile Validation Validation may be actual value expected in the item ar ML Schema file path Example of setting XML validation on the incoming XML file using XML Schema Flat Text File Translation List of most important properties for delimited variable length text file processing maps StartTag Block of text or single character that marks the start of the item You can think of it as an opening bracket in the text data Most of the time it is delimiter such as comma new line character Space character etc EndTag LoopEndTag Block of text that marks the end of the item You can think of it as closing bracket Translator will extract data between StartT ag and EndTag LoopEndT ag Speciallnstruction It can be setup to FlatOutput or FlatOutputinline on output Etasoft Inc Page 34 9 9 201 1 Extreme Translator element to make data in the output line up correctly Please read to the end of this chapter for illustration List of most important properties for fixed length text file processing maps FixedLength Length If FixedLength is true the Length of actual data item
28. a that is coming in Testing Test data 270 Compile Successtul Result Add Edit Delete You can use Map Scripts dialog to add and test new scripts If you click Test button script will be compiled and executed with data from Test data edit box assigned to strData variable Script Add Edit Script Mamespace mycompany Class formatting Method checkvalue All scripts have to contain namespace class and method names For simplicity you can use your company name as namespace Class and method names cannot match Etasoft Inc Page 32 9 9 2011 Extreme Translator XML Translation List of most important properties for XML maps StartTag XML tag or XML attribute name Do not use lt and gt brackets in this property EndTag LoopEndTag Not used ValidationT ype Validation If ValidationT ype is set to SchemaFile then Validation should point to actual XML Schema file Translator uses DOM parser included in NET Framework Warning XML file should have proper valid XML format including first XML item example lt xml version 1 0 gt If this item is missing By Example Wizard would not be able to setup map items based on XML file provided se Extreme Translator Mapper Ci testnow trans ecdifact cambioAML xmp Sse hee a ee Da e Be A Log Data 0 2 21 Datal ype undefined Id Fou ItemT ppe Segment AML version Format Value x
29. ample of Form usage Match and Replace is based on regular expressions processing used in Perl awk and many other utilities and languages There are books written on how to write powerful regular expressions Translator supports a subset of all available regular expressions Those are some of examples on how to use Match and Replace If input is abracadabra then Match alb r would give us abra which is the amount of string that has been successfully matched If input is abracadabra then Replace zzzz abra would give us zzzzcadzzzz in which all occurrences of the matching pattern are replaced by the replacement string zzzz Note semicolon is used to separate replacement string zzzz and actual regular expression abra in previous Replace If semicolon has to be in your input data it can be escaped with backslash character Example ZREPLACE amp APOS would replace amp APOS with but your desired result is to replace amp APOS with quote so your Format property should be REPLACE amp APOS Examples of some regular expressions Replace s remove leading whitespace Replace s remove trailing whitespace Replace s r n s joining lines in multilane strings or removing carriage return and line feed Match d d d extract all numbers from string As you can see regular expressions can be very powerful h
30. ap LOMPANYNSME Sequence El Plugin ExternalFunctn i LT Attrib gap SIHEETADDRESS2 Parameters i SENDER mb CONTACTHAME E Processing Ri COMI l STRE M Size 50 n lay STRE speciallnstrucl Mone Eg STRE El Script Ig CITY Script TB PRO El Validation Ig POST Validation EA cout WalidationType None 5 Igi ACCE Validation 2 M Validation may be actual value expected in the m T Item ar ML Schema file path EY BOOKXML_DETAIL C3 Processing finished successfully FieldType property drives record ordering SQLType property for database table can be set to Insert InsertOrUpdate or Update flag Translator will use first PrimaryKey field in the database to perform Insert InsertOrUpdate and Update operations InsertOrUpdate is a combination of possible operations on the database where translator will select row from the database based on PrimaryKey and if it exists translator will perform update otherwise insert will be performed Selecting data from database Queries can be executed in sequence and retrieve results in master detail layouts In simplest scenario you would have two queries one would provide data for header record let say purchase order and another one would provide data for detail record say purchase order line item One query would be something like SELECT PO ID PO AMOUNT FROM PR ORDERS second one would be SEL
31. ator should produce EDI X12 control numbers Other property called IniFile should be setup to get unique numbers IniF ile Path and file name of Initialization file It will be used during translation to generate unique number and maybe used in other functions as well Example C temp editrans ini SpecialFunction DataPath Extra functions You can use them to get total segment count SE count used in EDI X12 Also get current input and output file names Location of file or data for input or output You can override this property by passing parameters in command line File names may contain wildcards such as or Example C test trans inputxm would pickup all the files having names start with inputxml in that directory Wildcards cannot be used in directory part of path see special chapter DataPath Property Looping BasedOnParentOnly default looping model when each output item repeats in synchronization with its parent one level up BasedOnAllParents looping model when each output item repeats in synchronization with all of its parents up TranslationType Translator performs certain optimizations on some file formats that it has special routines for performance and validation Txt type is most generic and should be used only in cases when no other type matches UseBuffer Reserved for future use Means that translator will cache data in mem
32. by example wizard is a bit more complicated lt is based on features of certain formats and somewhat intelligent in a way that it can read the file detect file structure and create most of map objects based on example provided By Example Wizard a Sample File Sample file name C stestnowstrans sInput File txt File type ML Item Type Input 4 Remove duplicates Sample file should be smaller than 00 b in size and include all the item groups vou want to be displayed in the map Choose actual production file that is smaller than 200Kb Wizard wall tru to detect file tyoe and import items based on that By Example wizard takes sample file and produces the map There are certain requirements to the files you can feed into this wizard a File should have all the items you expect to have in real production environment In most cases we recommend to use actual file from production because it should reflect actual data you are sending or receiving b File should be small Recommended size should be less than 20Kbt If you try to use files that are more than 100Kbt in size wizard will take a long time to process it lt may even take more than 10 minutes Etasoft Inc Page 14 9 9 2011 E Extreme Translator Mapper Macifred File Edit Project Tools Help de e fs gt O Gm fa El XML EY AgileD ata LL smlnz xsi ch Automated ransferdrders DO uniqueld Osh CoverPage Imported sample
33. ches a whitespace character same as n r t f S Matches a nonwhitespace character d Matches a decimal digit same as 0 9 D Matches a nondigit character n Beginning of the line End of the line b On a word boundary B Not on a word boundary Zero or more matches E One or more matches Zero or one matches in Exactly n matches n Atleast n matches n m At least n but no more than m matches Capture matched substring 2 lt name gt Capture matched substring into group name Logical OR Etasoft Inc Page 30 9 9 201 1 Extreme Translator Substitute can be used to replace specific input values with predefined output values Property format is Substitute oldvalue1 newvalue1 oldvalue2 newvalue2 newvalue3 Special character star means any other value will be newvalue3 3 Extreme Translator Mapper CAtestnow trans agilbom xmp Modified File Edit Project Tools Help D cEES Gm A p E l Text with delimiters Sl Test record DataT ppe undefined id B3l Item Type Element Invoice E Advanced Format 5ubst tute L Invoice Cn D Invoice Di Mandatory True Sequence SpecialFunction None E Plugin ExternalF unctior Name Map object name In this example if input is C Invoice it will be replace to Cn but if it is D Invoice it will be Di on output Evaluate can be used to perform
34. ct Tools Help Dg EB SB85099 A b ra EY my table m 2 ch intld ugs g langlnt El J Common ch decMumber DataType ch singleMumber ld 38581 EP daoubleMumber Iter ype Field ch currency umber Mame text T ype pen boolT ype El Advanced Format Sequence Plugin E teralFunctian Parameters Processing y FieldT ppe Nullable Size 50 S peciallnstructian None Validation Validation may be actual value expected in the item or AML Schema file path C3 Processing finished successfully Major field properties Date time and datetime fields accept data in a special format DataType property Data format to be used Date yyyymmdd Time hhmmss Datetime yyyymmddhhmmss Inserting data into database Field Type property drives inserts If you want to change the way records are inserted modify property for table fields FieldT ype should match database field type in most cases However there could be exceptions if you would like to reorder fields in some special way You may have FieldType setup to NotNull or PrimaryKey even if actual field in the database table is Nullable Basic concepts built into the translator 1 PrimaryKey field is like a leader field and should lead record ordering There should be at least one PrimaryKey field in the table All fields that come in the input stream before PrimaryKey should be marked as ForeignKey or Optional and
35. ditors for display purposes and saved back into the file In many cases they are not valid and do not contain any business data and Serve no purpose during processing S ubstitute Can be used to substitute characters in the input with other characters or strings of characters Example of use 1 TEST 2 TEST2 this will replace all instances of 1 with word TEST and all instances of 2 with word TEST2 Remove Can be used to remove strings or characters from the message Regular Expressions can be used in this property TrimS paces Trim spaces from the end or start or both sides of each data element Can be used for translation of fixed length flat files into other formats NullValues If set to Ignore translator will skip incoming NULL values If set to TreatAsBlankValues translator will treat NULL values as empty values This setting is mostly used for mappings from database in cases when non existing field value should still be produced in the output as spaces or blank value ChangeCase Change case on each data element Can be used when translation should output data only in upper or lower case Encoding Used to define of characters during translation Use ASCII 7bit for English European 8bit for European languages and Unicode for languages that are Unicode based S peciallnstruction Tells translator to perform special operations during data translation use of this property is FlatOutput
36. e HO Interchaj All available plug ins listed in Soe tes B re ExternalFunction property Mandatory Sequence SpecialFunctian El Plugin E stemalF unction LLI Interchai amp caunt E stra Cauntlltilt InerementEaunt count E stra Count ti ncrementlounts ave count E tra Count ti a etlnerementCaunt amp caunt Extra Count tit GetlncreementCounts ave amp caunt E stra Count til Deerement aunt count E tra Count ti Get ecrementlount xFtormatb E tra FormatLltil LI sePrevieusttHull stormat E tra FarmatLlItil5 er anable Format E tra Format til Get arable format E stra Format til Get anablesnd4ppendT oE nd stormat E tra FormatUti E er anable4nd4ppend stormat E tra FarmatLItil Eier anable amp nd amp ppendb ot stormat E tra FormatLItil M ulllfE qualsParameter EIA MAA p LE Suc ME ean Fs ti cou EL PrI F LIBI Reefer Temp SE Temp Indicate List of available functions stored in libraries in plug in directory However you can use plug in feature and add your own functionality to the translation You do not need any special license to use and develop plug ins Special functions such as specific date time conversions formatting can be achieved using external NET libraries Each element and segment in the map can have attached to external functions External functions must have certain interface to be integrated into translation 1 Should be compiled into
37. e path 4 p Cu Processing finished successfully There is example of XML mapping to flat text file with comma delimiters In this example header data has to repeat per each line Etasoft Inc Page 35 9 9 201 1 of detail so UsePreviouslfNull plug in function is used to fill in empty spots EE er EENE Translator Mapper re Nrestnowtrans agilbom oump He Edit Project Tools Help Su mo ESE E a AML a E El A gileD ata LL mins xs E mins asd E sr schemaLo El Text with delimiters E E Text record LBH ABLFEYEL N AB HREV CN ABHRE 8 ABECOMO um ABEFFDT r in Gah AutamatedTr em Changebrder uniqueld E J LowerPac 00 ABACTH y ABCHILD O ABU TY i ABBLUBBL O ABREFD Cu Processing finished successfully Extreme Translator E temalFunction Parameters Processing End ag a LoopEndT ag a Speciallnstructon Start T ag Processing Fixed Length FixedLenath False Length O PadCharacter _PadT ype Left Validation Validation may be actual value expected in the item ar ML Schema file path Also to have all the headers line up with details Speciallnstruction property has to be setup to FlatOutputlnline on first detail item in the flat file Database Mappings Mapping Translator is capable to import or export data from database ODBC connection is established to read data using SQL statements or write data
38. engMaxFilrs at axTranz DLore axFileInputBuilder pen axMapBoot mapRoot in d netMsrcxrranengMaxFilelInputBbui at axTrans Lore axInputbullder Read axMapRoot mapRoot axTranslator xTrans axIDFTable idfTablej at axTrans Core axTranslatorJob RunInput axInputParams prinput axMap prMap in d netMsrcixtranl There are sample log file contents Etasoft Inc Page 46 9 9 201 1 Extreme Translator Please visit Support page on our website for more information Etasoft Inc Page 47 9 9 201 1
39. estniow transsez2 out Ext Dialog based processing What are the maps How to do the mapping Translator maps are sets of data translation rules defined using graphical mapping tool and saved in xmp files You can use those map files to process data and transform it into some other format or relational database You do not have to write any code and you do not have to know any programming language to use the mapping tool for most of scenarios The main idea is that you should be able to make mapping point and click and have it ready in an hour or two However this is in ideal world in reality sometimes very complex business rules should be applied and they just can not be simply defined by changing properties In order to solve those problems we introduced scripting support into the product Also mapping can take a long time if you have never used other mapping tools before If it is a new experience to you it may take longer than a few hours to make the mapping work But this time will decrease tremendously after you get used to the tool Mapping process goes from left to right on the screen divided in two You have to define at least one root item on both sides and one or many contained items underneath Each root item represents a file or database connection So it is the source or destination of data You should define DataPath property in order for map to be functional DataP ath can be path to actual data file for input or output or it ca
40. fined at the root level of the message In case if you do not know those separators or you expect EDI files with various separators use option AutoDetect and set it to true Separators are special characters that separate segments and elements in EDI document You can find all three separators sub element element and segment separator defined in the EDI X12 file at the location starting position 103 after ISA If you use the wizard separators will be defined for you In EDI X12 and EDIFACT mappings only elements should be mapped to output Typical EDI map might look something like this Etasoft Inc 1o 5 paeme Transla or Mapp Todas T WRejectioncomp rc um L V EE Text with delimiters 7 i H NTE E E el Text record nO TAN bem BB claimMNum H CUR E parentum i Ig REF TI providerlL i Ly DTM EE provider ame i Up H1 1 provider ameLont E a w La jus E Assigned Number g Ig 53 g Ig 52 3m CLP um lastM ame 3 LNl cisHum E adiDate 3 a fe Claim Submit TI authhum m IN Claim Status E level i TE O Monetary Am LL level S x ig EJ Monetary Aml TW cptCode ui S22 x EJ Monetary Am EE HpeO Service 3 3 be SEE Claim Filing In fT modifier Sf TI Reference ld SE charges i 3 BE SEE Facility Code EH units T EJ Claim Frequet Sun recelvelate 2E E DO Patient Statu N svcBeginD ate m SEE Diagnosis Re EU svcEndDate EN 2E L
41. its property Mandatory set to true during map execution Whole command line may look like xtranrun exe C test trans mapping_new2 xmp Id 138 Mandatory true License T3D 6UXF3D U6LXF Two or more properties can be passed in as parameters for example Mandatory and Format D net trans Debug gt xtranrun C test trans mapping_new2 xmp ld 138 Mandatory true Id 138 Format Value TEST License T3D 6UXF3D U6LXF In this case Format property for item Id 138 is being set to Value TEST string There are limitations to command line parameters that can be passed in to properties 1 Item with that Id must exist in the map in order for parameter to be accepted 2 Property must be not read only It can be changed via Mapper 3 Property must be string integer or Boolean value Fixed dropdown list type properties cannot be reassigned or changed via command line Etasoft Inc Page 11 9 9 201 1 Extreme Translator Dialog based processing Files can be processed using dialog screen when operator has to enter data and map file names You may use xtranrunw exe to do that type of processing This utility accepts map file name as parameter If you start it with map file name in shortcut parameters Map file field will be pre populated Extreme Translator Runner EH E 3 Execution Input Tools Output Tools Wamings Fracessing Map file Extestnowtranstezla mp Input C Mestniowstrans s B2 T bet Output D t
42. length files then you should use FixedLength Length PadCharacter and PadT ype properties It is possible to intermix text file processing and have both fixed length and delimited text processing techniques in one map but it is very rare Mapping XML EDI X12 and EDIFACT formats to flat files can be a challenge just because they are nested and or looping Most of flat files contain some header and detail elements that are separated by commas or presented in fixed length Header elements have to repeat per each detail line 35 Extreme Translator Map per C testnow trans agilbom2 xmp File Edit Project Tools Help D el A gt oy Number B 3 E Text with delimiters Properties Log 0 Data 9 E Status 3 44 Test record E ChangeType O ABLFCYCL GEIE eed ChangeCatec O ABOREV Mandatory Ty Description OF D BH ABNREY Sequence ea ReasonForCk SpecialFunction None Lg ReasonCade TB ABEFFDT amp Plugin T Workflow y ABDISDT 5 Phares O ABPARNT ILE Originator Y ABAMETH El Processing i D atellriginate LL ABACTN EndTag IE DateReleaze LB ABCHILD LoopEndT ag Affected tems Speciallnstructio Mone ILL referentld D BH ABBUBBL StartT ag ih HasBeenRed O ABREFD oa Processing Fixed Length E Item umber Validation E Attachments Validation may be actual value expected in the item or ML Schema E Manufacturer 7 fil
43. lete Mappings Add message to the map Translation C Based on sample file C Based on template i amp Manual mapping Translation type XML Translator use routines specific ta each message tune Etasoft Inc Extreme Translator ja El Element Database SOL Query Field Choose translation type that is most accurate to the message file you want to process You can change translation type later however map and map item properties are different depending on what translation type you are using Example in XML property StartT ag means actual XML tag without lt and gt brackets so in XML translation StartTag mytag if you are planning to parse XML file as simple text file you should set StartTag lt mytag gt just because simple text parsing does not know what XML tags are and whole XML data is just plain text with some separators For EDI segments you do not need to have EndTag or LoopEndTag defined because translator takes those properties from Message SegmentSep property 9 9 201 1 Extreme Translator amp amp Extreme Translator Mapper Modified File Edit Project Tools Help Oo el AH JE Aa s D MI A eee Add Message F vm ml File or M esses ld ler T ype Message Mame ml File or M SUL Query El Processing Ebr DataPath Delete t IniFile Looping BasedOnParn Root ype Input Mappings Name
44. maps Lite Edition license does not permit map execution via command line The role of translators Why are they needed A translator is an application program designed to convert one electronic format into another and perform additional data conversion if desired The industry term for applications designed to convert electronic formats is translator software Etasoft Inc Page 3 9 9 201 1 Extreme Translator Translator software can be acquired by 1 Developing a translator process in house Gives the maximum control over the design quality and functionality of the translator but requires an investment in development testing and maintaining We provide integration and Developer SDK tools for this scenario 2 Purchasing or leasing vendor translator packages It provides a tested application and a range of support services including upgrades and new releases as the standards evolve This is what our package is designed for 3 Contracting with a clearinghouse to perform the translator function The clearinghouse offers a series of value added services such as connectivity a communications package and trading partner interfaces in addition to translation What translators can do Translators are designed to convert the data into transactions the receiving and sending system can recognize They can perform the following functions 1 Accept incoming standard formats and translate into other formats 2 Strip and store da
45. ml version 1 0 encoding 150 8859 1 7 Mandatory True Sequence SpecialFunctior None Plugin ExternalFunciio Parameters Processing End ag LeepEndTag Hame Map object name Screen shot on how to setup XML attribute for the output Segments as well as elements can be mapped to output Segment might look like segment name gt some data segment name gt Elements are inside of segments and look like lt segment name elem1 some element data gt some segment data segment name gt Etasoft Inc Page 33 9 9 2011 Extreme Translator When you create mappings to produce XML certain characters will be escaped in order to produce valid XML output There is a table of escaped characters Input character Output string single quote Sapos double quote amp quot greater than sign amp gt less than sign amp lt amp ampersand amp amp XML Schema Validation Validation against XML Schema can be performed using XML Schema file Validation and ValidationType properties have to be setup to perform the validation By Example Wizard can be used to create the map for you After you run the wizard you have to click on the root item and fill DataPath and Validation ValidationType properties Es Extreme Translator Mapper C itestnow trans INVOIC XML EDI2xmp Modified File Edit Project Tools Help Denli Rre gt E EDIFAC
46. n be a constant value In case if it is a constant value you will be able to pass real path to the data via command line parameters Please read more about it in a topic that describes how to pass data from command line However you can use wizards to do the mapping for you In many cases they produce one side of the map it can be input or output and if you run wizard twice you can have most of the map created in minutes All you will have to do is finish mapping using Map Unmap menu in popup menu on the tree view in the right side You can view mappings displayed as red arrow lines However lines are painted only if mapped item is visible expanded on both tree views You can also edit mappings by clicking Mappings menu item on the left side of the screen Etasoft Inc Page 12 9 9 201 1 He Edit PSA Tik Help EH Es m E A gt a EDIFALT COARRI Lontan a 3 E UNE LL Syntas Identifier 1 TI Interchange Sende P HH Interchange Recel TN Data and Time Pre m HH Recipients Referer H E LINH BGM OnBoard C El Doo mant Add e Ig FTX vut LG AFF Copy um TOT Faste Paste With Mappings Delete AMYPKG North Dort t COAR E OnBoard Record Running O EDI Batch N Message Date N Message Time PEE POL Service E POL Vessel N POL Vovage El POL Direction POL Terminal ETA Date ETA Time ane Extreme Translator RI95B pres Document message numb El Advanced
47. om xmp Madified File Edit Project Tools Help OSA 4 5 E XML J m m ld m bu ItemTupe Message Mame Text with delimiters Processing DataPath C Testnows Transtagilbor niF ile Looping BasedOnParentO nly RootT ype Output 5 aurceTwupe 5 peciallnstruchon Special processing instruction hor the translator Set this property on the output root item if you want data to be appended to the output file EDI X12 EDIFACT Translation List of most important properties for EDI X12 and EDIFACT maps StartTag Used only for segments loops It should be setup to segment name example ISA ST SE UNA UNB etc EndTag LoopEndTag Not used Mandatory Should be setup true for mandatory EDI or EDIFACT items such as ISA GS ST UNA UNB etc AutoDetect If setup to true will try to locate segment and element separators UseSep If setup to true will use separators setup in other properties It ls opposite to AutoDetect property SegmentSep ElementSep SubElementSep Separators coded in the map Used only if UseSep property is setup to true Filter Can be setup to 13 10 to filter carriage return and line feed characters from the incoming data Extreme Translator Product supports both UN EDIFACT and IATA EDIFACT for Airline Industry In order to perform EDI translation you need to have separators de
48. ory during processing This is good option for small files less than 1Mbt in size This property will allow optimize translation for large files Default is true ElementS ep SegmentSep S ubE lementS ep S ubE lementS ep2 Are separators used in some translations such as EDI X12 EDIFACT They separate data segments such as ISA GS GE UNA UNB etc EscapeCharacter is used in EDIFACT for special cases when EscapeCharacter SegmentSep should be treated as simple data character and not a segment separator Etasoft Inc Page 20 9 9 201 1 Extreme Translator Extreme Translator SubElementSep2 is used in HL7 UseSep Indicator to use hard coded separators AutoDetect Automatically detect features of the file just before processing and use them during file processing For example in cases if those files are EDI X12 EDIFACT files separators fill be detected automatically This property overrides other properties such as UseSep property for example However in some cases AutoDetect is impossible Example your EDI X12 files come without ISA header In this case translator will not be able to find separators and translation will fail F ilter Can be used to filter garbage characters from the file or message It is mostly used for removing CRLF carriage return and line feed characters from EDI X12 and EDIFACT messages decimal codes 13 10 Some junk characters are being added by graphical file e
49. owever somewhat cryptic to read and use You may consider searching for more information on them in Internet sources Etasoft Inc Page 29 9 9 201 1 Extreme Translator MEE ia de bareme Translator Mapper CAtestnowktrans Rejections3 xmp Modified File Edit Project Tools Help 6 BB AY b LT tvpetrs m 7 c r CLP Properties Log Data 01 LB charges LB Clair Datal ype undefined ld 265 ItemT ype Element Percent 13 LL invaicel Ll rejErort Eom LL typeD fe E n Sequence LL errorval E caw SpecialFunction None 3 DO erorDle 2 E Plugin INE ExternalFunction Format Data formatting Example on using Match regular expression The regular expression language includes two basic character types literal normal test characters and metacharacters Regular expression metacharacters are an evolved extension of the and metacharacters used with the MS DOS file system to represent any single character or group of characters This is a short overview of common regular expressions metacharacters Expression Meaning Matches any character except n characters Matches a single character in the list characters Matches a single character not in the list charX charY Matches a single character in the specified range w Matches a word character same as a zA Z_0 9 _ W Matches a nonword character NS Mat
50. pdate otherwise insert will be performed MasterQuery Name of other query in the map that will act as Master to form Master Detail relationship and supply parameters to this query FieldType Represents relational database enforced type lt is used to reorder and populate resulting records Size Database field size FixedLength Indicates to treat item as fixed length Length Actual length of item in characters PadType Dictates how fixed length item is padded with pad characters PadCharacters Character to be used for padding ExternalFunction Parameters Script Translator will call external routine stored in NET assembly to get data External routine must have certain function signature see Plug ins chapter in this document Parameters will be passed into external function Translator will call script that was defined via Scripts screen in Map Editor Each script is compiled once before it is executed for the first time during map processing DataPath property Extreme Translator DataPath property is used on root items of the map for both input and output It is generic name for data source that can be local file file on the Internet accessible via http fto protocols or database connection string There are different rules what should be in this property depending on what is actual data source or destination It is recommended to test
51. processing using local files first and move them to ftp or http servers later Local or network file s DataPath property can be a path to the file including file name File name also may contain wild cards like and Example C test trans txt would pick up and translate all the text files in C test trans directory It can also be a shared directory on another computer in local network like MYSERVER testing txt Internet file start with string http Example http www somewebsite com somedata xm Translator would pick up XML file from the web site Wild cards are not allowed Translator uses HTTP GET to retrieve file and HTTP POST to submit files to the web server DataPath property can be an URL to the file on the web It should Database connection DataPath property can be a connection string to the database Example of connection string to ODBC data source Etasoft Inc Page 22 9 9 201 1 DSN mydatasource UID myusername PWD mypassword FTP file s DataPath property can be a connection string to file on FTP server Connection string can contain user name password FTP server address and remote server directory On the input side DataPath may contain file pattern for the file to be picked up ftp Uusername password fipserver com directory filepattern Example ftp myuser mypassword someserver test txt It would connect to someserver
52. r if data source name user name or password changes Etasoft Inc Page 37 9 9 201 1 Extreme Translator ODBC data source transtezt User name Password Test Connection Database connection settings When database is setup you can add SQL queries to it Queries you can setup on the left side input are different than ones you would setup on the right output Input queries are SQL SELECT based queries for data retrieval Output queries are for SQL INSERT statements Major difference is that you can edit SQL statement of SELECT query and modify it when INSERT statement is dynamically constructed based on the fields listed under the query E A AA EE ior MN TS a xtreme Translator Mapper Modified di TEME File Edit Project Tools Help D c Sm A p Properties Add Message Ena El Segment Cut niF ile Copy Element RaotType Input Source ype Odbe Paste Database 5 peciallnstructian Hone Paste With Mappings SOL Query TranslationT ype Database O Validation Delete Validation Validation Validation may be actual value expected in the item ar ML Schema file path Mappings Ca Processing finished successfully Adding SQL queries to database SQL queries during processing are executed in the order they are listed on the screen Type query name and SQL statement in SQL Select Query dialog then press Read Fields to get all the fields query can retrieve and press OK
53. s Entity Filings mp 106 MH Motor Carrier Rate Proposal mp 107 MC Request for Motor Carrer Hate Propozal mp 108 ME Response to a Motor Carrier Rate Proposal mp TOS VE Vessel Content Details mp 11014 Air Freight Details and Invoice mp 112 PH Property Damage Report mp 120 VC Vehicle Shipping Order rip H 121 V5 Vehicle Service mp 124 VD Vehicle Damage mp 125 MA Multilevel Rallcar Load Details mp 1276 V Vehicle Application Advice mp Ter VB Vehicle Baying Order rip 128 DI Dealer Information mp Refresh Les ae E Cancel Import existing templates for most of standard messages of EDI X12 EDIFACT SAP Translation This is a simple and brief topic because we do not guarantee that translation logic will remain unchanged in next version of the software However we try to minimize the impact and keep versions compatible Now translator uses different translation logic based on the translation type property defined for the root item in the map EDI X12 and EDIFACT translation is based on segment splitting XML translation is based on XML parser and Text based translation uses complex file parsing based on offsets and data blocks Translator overwrites output files during processing by default You may change it to append using Speciallnstruction property on output root item in the map Etasoft Inc Page 16 9 9 201 1 tU s Extreme Translator Mapper CAtestnowtrans agilb
54. scapeLharacter Segments ep 7111 310 SUBE lement ep SubElementS epz UseSep El Tools AutoD etect Hame Map object name Properties that should be setup for EDI messages Important properties relate to EDI separators are listed in Separators group You should setup ElementSep SegmentSep SubElementSep if you setup UseSep to true If you do not setup UseSep property to true you should set AutoDetect to true in that case translator will try to find separators in default locations ISA header in EDI X12 or UNB header in EDIFACT We also setup Filter property to filter carriage return and line feed characters decimal codes 13 and 10 This is a fragment of EDIFACT we want to translate UNB UNOA 2 SGSIN HOIT D 021220 0953 SINFO019 UNH 1 IFCSUM D 01A UN UAS120 Mapping is based on two segments on the input side called UNB and UNH There are some composite data elements that have sub elements we need to extract Examples would be Element 1 in UNB or Element 2 in UNH In order to extract sub elements mappings should be edited using menu option Mappings on the popup menu when you click item on the left HIPAA Support HIPAA is supported through the map templates You can choose one and have map created in seconds Those HIPAA templates are available EDI X12 270 Eligibility Coverage or Benefit Inquiry EDI X12 271 Eligibility Coverage or Benefit Inquiry Etasoft Inc Page 19 9 9 201
55. simple arithmetical operations or help to concatenate character data Special character can be used to indicate incoming data Example 1 Evaluate 10 will add 10 to incoming data So if data that is coming to element or field is for example equal to 85 then result after evaluation will be 95 Example 2 Evaluate 4 AAA will add 4 to incoming data and append AAA to the end result So if incoming data is 34 then end result would be 38AAA Example 3 Evaluate ABC DEF will append ABC characters to the front of incoming data and append DEF characters to the end Example 4 Evaluate O 10 will divide incoming number by 10 Script property If Format property cannot format data the way you want you can use full power of C NET language to do extra processing using Script property Add scripts via Scripts menu in Map Editor then click on specific item that has Script property and assign script from the list Etasoft Inc Page 31 9 9 201 1 Extreme Translator Scripts Selected script mycompany formatting checkvalue Script using System using System Collections using System ID using System ml using System Data namespace mycompany class formatting public static object check valuefint Id string strD ata i perfarm some processing here and return result to translator as string if strD ata 201 return null return strata 2 this will return same dat
56. t element or field is not NULL has data Form Reformat data Match Match using Regular Expressions Replace Replace using Regular Expressions Substitute Substitute certain values based on the list provided Evaluate Perform simple arithmetical operations on data append or add additional character data Value is used to place default value in the map item during processing Example of use Value defaultvalue ValuelfNull is used to place default value in the map only if incoming data is NULL or empty string ValuelfNotNull is opposite of ValuelfNull 15 Dereme Translator Mapper C testnow trans Rejections3 xmp Madified File Edit Project Tools Help Ora E 8 A p Text with delimiters Properties Log Data 0 DataType undefined ld 65 e Security Info 4 Item T ype Element E ID Qualifier 5 E Info Qualifier 1 EE TID laalifier 7 Ms CMM Lco Mandatory You need both Sequence properties set SpecialFunction E Flugin we EstemalFunction Hu TET EE OTRA He Mandato LL Ack Requested 14 Mandatory item must be present E Usage 15 Hr I Default value placement in output Form is used to form output data based on input You may use special escape characters to manipulate data Escape characters are and _ Usage Position number may look like this 00 21 would print DO character at position 21 in the data
57. ta 3 Translate one file to many and many files to one file 4 Perform data validation 5 Reformat certain data items example change date time formats pad numbers with zero 6 Insert processed data into relational databases Map Editor Map editor is divided into four panes First and third pane is for adding new map items Second pane is to display relations between map items and fourth pane is the one used to display selected item properties There are many ways to add items to the map use wizard use menu Add use Copy and Paste or use Drag n Drop In any case you need to have at least one root item inserted at the top This can be the item that represents your Message or Database Connection Translator supports one or many to one or many mappings That means you may have one or many messages files mapped to one or many output messages So you can have one or many root items on each side Simplest way to add some items is to use Add menu item however there are some limitations in order what can be added to what 1 Only segments can be added to the message 2 Elements and segments can be added to segments 3 Nothing can be added to elements In other words elements can not contain other items Etasoft Inc Page 4 9 9 201 1 me ru Pr a ms er Iza ian NI AA Extreme lranslator wapper id a E Edit Project Tools Help File OD M s Ea A 0 9 Add Cut Copy Paste Paste With Mappings De
58. they are pointing to input and output files Plug in can be passed into translator batch process via parameter PluginDirectory Example PluginDirectory C mytransalator myplugins In this case it will overwrite value used in the map Runtime Parameters dialog You can also setup shortcut on the desktop so every time it is double clicked specific map would run Etasoft Inc Page 10 9 9 201 1 Extreme Translator xtranrun exe Properties General Shortcut Options Font Colors Compatibility o y S LanTun exe My Documents IERE Target type Application Target location Files I Target xIranrun exe C testmy_map xmp License 7DT Fl Start in D nethbin Miles l Shortcut kep Mone Hun Normal window bul Comment Places A There is our desktop C5 shortcut and its 4 properties There is an example of shortcut and properties It will run C test my_map xmp translation whenever executed Passing parameters via command line Most property values set in translator Mapper can be overwritten by passing new values to them via command line This is very powerful feature if you need to do some pre processing before map is called and would like to change map properties during runtime on each map execution Parameter passing might look something like Id 138 Mandatory true Here Id 138 means the item that has property Id equal to 138 should have
59. to extract PadCharacter PadType Actual character to be used if data should be padded on the Left or Right Format Can be used to produce desired output in a special format Text translation is raw data conversion It is the same model used in our first product called Import Export Studio This is less effective method than XML or EDI translations mainly because translator steps though every character in the file and does numerous iterations in the map to determine what this block of data is Text files can be of any structure flat files fixed length files files exported from Excel or MS Access even dBase format DBF files Any file that has a structure can be converted Even EDI and XML files could be translated however translation would be raw file conversion not taking into account EDI and XML file specifics There are two most important properties you have to setup in the map in order to process delimited text files Those properties are called StartT ag and EndTag LoopEndTag You can think about these two properties as open and closing brackets Just imagine brackets in your text file you want to process and based on this create segments and elements etartTag is the block of text translator will compare incoming data against If data matches then translator will try to find EndTag LoopEndT ag and if it can find the end it will step one level down into the map and try to locate nested items If you are trying to process fixed
60. uanti 100 LL Percer Bg CAS ee a h NM1 rul H MIA 140 a MOA Fol h REF 1501 Be m DTM 1001 Ol svcBegnDate w PER 1051 DI 03 bo MW cO Pa to C3 i Cd Ll 63 F3 C32 CO oT A n k C Processing finished successfully Data attached to and processed for each map item after execution Data tab also shows items length and marks end of item with It is handy if item has spaces at the end of data so you can see them Technical Support When critical errors happen in the code during processing of the map log file is produced It contains instructions and function names that failed This log may not be useful for the end user but is excellent source of information for support Log file name starts with original map file name where error happened and ends with log Log 8 24 2007 4 07 49 PM Message Could not find a part of the path C Test Trans otack Trace at System 10 Error WinI Error Int352 errorCode String maybeFullPath at System 10 Directory InternalGetFileDirectoryWNames String path String userPath riginal Strin at System 0 Directory GetFiles String path String searchPattern Searchlption search ption at System 10 Directory CetFiles String path String searchPattern at axTrans Lore axFileReader InitFileList axInputParams prinput axMap map axMapFileMsgq mapFiler at axTrans Lore axFilseReader pen axInputParams prinput axMap map in d netisrcMxtran
61. using user name myuser and password mypassword change to directory test and pick up file that has txt in the name On the output side FTP file should be exact file name ftp myuser mypassword someserver test myoutputfile txt If login should be anonymous user name and password might be omitted Example will fetch all XML files from FTP server called someserver and remote directory somedirectory fto someserver somedirectory xml Speciallnstruction DeleteWhenDone can be used on input side in order to remove processed file from FTP server Speciallnstruction AppendToFile is not available with FTP on output side Files with extension txt are transferred in text mode Binary transfer mode is used for all other files Extreme Translator Special macro can be used to place input file name into the output and have all the output file names formed based on input file names Macros should be used on output DataPath property Input Translator drops file extension from the input file therefore any extension can be used in output DataPath property to form output file InputFileName Translator drops file extension and directory from the input file therefore any extension and directory can be used in output DataPath property to form output file Count This macro is replaced by internal file count during processing 9eSystemDate 6
62. y i Detail based on the data PootTune Cutout element in the input File F ES Speciallnstru Mane ri control NumE TranslationT 12 T Ack Request LIseEutfe ri T Usage 15 El Separators T Component 5 Elementsep G GS EscapeChar LL Function Segmentier 4131410 T Sender C CEP RTPA T Recerver DataPath I Date 4 ro Pata source or destination as file path database rrr connection etc E RH dh Processing finished successfully I Example how propertyID macro can be used Condition and ConditionType properties Properties Condition and ConditionType provide a way to filter or route incoming data to separate locations on the output file In this example below only certain XML data with attribute Qualifier equal Sl and IL should be placed into the output and all XML tags that have Qualifier equal P8 PO and EQ should be filtered and will not make into the output Etasoft Inc Page 26 9 9 201 1 YT f anslator Map per Cite tn owtr agill VOUT 1xn np ed Edit _ Tools Help 7 oa de Bm e 4 gt ih CoverPage El Pm Gah Affectedltems Iph Aifectedltems IB Affectedltems AN er fee Condition is seton CUN Ip Affecte XML tag but itis based E ar Affects on values coming into Th Alfecte uniqueld attribute n Affectel Dah Affected gt Y um Page se ib La E im litleBloc e Pagel hree i Gh PageT wo B ant Parts 4 Th Extreme Translator

Download Pdf Manuals

image

Related Search

Related Contents

Toshiba 46SL417U LED TV  User Guide CompSdpToSdpI    Sustainability Report 2012  Manuel GS1 Barcodes - GS1 Belgium & Luxembourg  OWNERS MANUAL - D&R Broadcast Mixing Consoles  Adesso iMouse G25  Samsung 2033SN Lietotāja rokasgrāmata  Ferm Table drilling machine FTB  TEFAL BL1151AD Instruction Manual  

Copyright © All rights reserved.
Failed to retrieve file