EDI Validator User`s Manual for version 2.x
Contents
1. B lg ST E H E BSN 7184350333 6113310271 H DTM 131270001 eae HL m 6511 dcm E Eg SE ET E A GE yi t r TD JA S REF 0215000032630 E Common DTM o 201002 Changed ud DTM 067 vem HL 42 FOB PP Tope Segment 13 Nt SF FASHION MFG CO E Im N4 Brooklyn Ny 11219 15 NI sT 92 Erors 51 Wamings D Output 51 MaxRepes 1 MinReocai o Count Segment Message MinRepeat Minimum number of times it can repeat e Processing finished with emors L Example of MaxRepeat error when input has 193 HLs and we limit accepted maximum repeat value of only 1 DefaultValidation Property Basic validation is performed on EDI X12 and EDIFACT enveloping segments if DefaultValidation property is set to true EDI X12 basic validation Whether an ISA and an IEA exists Whether ISA 08 contains a well formed date value Whether ISA 09 contains a well formed time value Whether ISA 13 contains legal boolean value Whether ISA 14 contains legal interchange usage indicator P T I Whether ISA 12 and IEA 02 contain the same value Whether IEA 01 contains the correct number of function groups in the interchange If there is a matching GS and GE pair Whether GS04 contains a well formed date value Whether GS05 c2. S A02 Authorization Info 1010 5403 Security Info Qualifier 2 72 S A04 Security Info 1010 IS A05 Interchange ID Qualifier 272 IS A06 Interchange Sender ID 15 15 Reuze incoming value Reuze incoming value Reuze incoming value x Reuze incoming value x Reuze incoming value Reuze incoming Hecerver ID value x ISAU Interchange ID Qualifier 2 2 IS A08 Interchange Receiver ID 15 15 Reuze incoming value x Reuze incoming Sender ID value S417 Standards Identifier 1 1 i Reuse incoming value 5412 Control version 5 5 iw Reuse incoming value 5 415 Usage Indicator 1 1 iw Reuse incoming value Some elements like date time and control numbers are populated dynamically when software rung and you do nat need to define them Check All Uncheck al Cancel X12 997 and 999 processing is setup to reuse incoming values by default But you can overwrite this behavior by unchecking Reuse checkbox and providing your own constant value X12 997 and 999 default processing will also swap Receiver and Sender Ids from incoming file and reuse separators delimiters from the incoming file Control number for 997 ISA GS ST SE GE and IEA segments will be generated and incremented each time validation runs In order to reset generated values delete file 997controls txt and 999controls txt from software installation directory E
3. El Format FixedLength False Format Format ype None Length 0 El Processing ScriptName El Qualrfiers Qualifiers El Requirement AllowBlank Mandatory El Values AllowedValues DisallowedValues Element and subelement properties FormatType and Format Properties FormatT ype works with Format property but in some cases Format can be left blank FormatType Format JjDescipion gt N A not applicable Validates if input data is an integer number Validates if input data is a number RegularExpression Regular expression Validates if input data matches defined regular expression DateTime See next chapter on FormatType DateTime FormatType DateTime When FormatType is set to DateTime Format property may contain combination of specific characters to validate dates and times Example 12 JAN 2002 can be validated with Format set to d MMM yyyy Example2 12 2 04 can be validated with Format set to d M yy Example3 02 04 05 1314 can be validated with Format set to dd MM yy HHmm d The day of the month Single digit days will not have a leading zero dd The day of the month Single digit days will have a leading zero ddd The abbreviated name of the day of the week as defined in AbbreviatedDayNames dddd The full name of the day of the week as defined in DayNames M The numeric month Single digit months will not have a leading zero MM The numeric month Single digit months will have a
4. leading zero MMM The abbreviated name of the month as defined in AbbreviatedMonthNames MMMM The full name of the month as defined in MonthNames y The year without the century If the year without the century is less than 10 the year is displayed with no leading zero Etasoft Inc Page 14 12 30 2011 EDI Validator yy The year without the century If the year without the century is less than 10 the year is displayed with a leading zero yyyy The year in four digits including the century gg The period or era This pattern is ignored if the date to be formatted does not have an associated period or era string h The hour in a 12 hour clock Single digit hours will not have a leading zero hh The hour in a 12 hour clock Single digit hours will have a leading zero H The hour in a 24 hour clock Single digit hours will not have a leading zero HH The hour in a 24 hour clock Single digit hours will have a leading zero m The minute Single digit minutes will not have a leading zero mm The minute Single digit minutes will have a leading zero s The second Single digit seconds will not have a leading zero ss The second Single digit seconds will have a leading zero t The first character in the AM PM designator defined in AMDesignator or PMDesignator if any tt The AM PM designator defined in AMDesignator or PMDesignator if any z The time zone offset or followed by the hour only Single digit hours will not have a leading zero For
5. Batch Processing Validation can be executed as time scheduled job run as part of other batch process or be executed as external job to do the validation This makes it very flexible Validator command line utility can produce output in plain text or XML format First two parameters are required and they must be included on the command line Parameters are listed with they priority and expected order 1 Mandatory Path to definitions file with extension xva 2 Mandatory License key in form License2my license key 3 Mandatory Input file in form Input C test testfile txt You can use wildcard to process multiple files like this Input C test test txt and it will pick all text files starting with word test 4 Optional OutputFormat Plain or OutputFormat XML 5 Optional Output C some_directory errors_warnings txt 6 Optional OnError Stop Output file name may contain following macros Count this macro will increment for each input file if multiple input files are processed when wildcard is used in the input file YsystemDate this macro will produce current system date in the file name YoystemDateTime this macro will produce current system date and time in the file name Example if parameter Output is set to C some_directory output SystemDate txt then produced file name will be CAsome directory voutput20061 204 txt You can use unexpired license key from Definition Editor Help Product License screen Als
6. Etasoft Building blocks of intedration EDI Validator User s Manual for version 2 x Copyright 2004 2012 Etasoft Inc Main website http www etasoft com EDI Validator website http www xtranslator com PU DOSO iusaaa kara iac CR SERERE RR DOR CU A GER A ere reer Ca ndr RC OE RR RC RC RR RE CR rr RR Rl 2 Additional DocumentatlOH 255io eeu ivasvaseevexwascusan eisin 2 Readuiremernts deb UER ROI ERU E Pd Wand KW ERROR RC Er Mri Ln OR a RD RM OR DR RR NER DR RA 2 LICENSE 2 TerminologJV iesaxsiscmuirniii n BUR EN RN RO URN M OR CHER UN n E RD RR OR ER CARN ER D 2 Validation SChelTid auesuussess ns sunesssukPRERECRFEERaREESREEN FEMESRERRAN ERR DEVE KEREEEER PE EN R EE EFE E EE 3 Validation Schema Templates LLuueeee ee eere enhn nnno nn nnn nnn nn nnns 5 PIOCOSSITO iccisusexesE wA siuRiM Ge REP E M PE NN PES 7 Batch PrOCeSSIQ iorciss sesseseuEesaSurQsodsas crUsersuriUEEE P EEEREREANERN MM aA 9 Output X12 997 or 999 acknowledgement e 10 CDUIOWS e 12 PIODGOITUIGS osssesavinppon ks aba bd iR IET A UO KR GR CR D a CERE UV a GRECE RBRUM 13 FormatType and Format Properties nee ee eene nena nnn annu nnn 14 FormatType DateTime scs unsk ak vsE nid Xii iD RARO CDD ERROR GC ROC CROCI ECCO CLE o OR Alc d E Ka 14 MinRepeat and MaxRepeat Properties e eere enn n nn nnn nnn 15 D
7. Identification T Entity Relatior ait i 5 BM 0215000032630 e a ee ee ee ee mmi i I 20100226 FormatType None Length 0 4 El Processing FASHION MFG CO 91 Scripthame 11218 El Qualmhers Qualifiers BY Requirement AllowBlank True Mandatory False Count Segment Message rr z 5O IB Allowed values for the item Packaging Code 1 did not match input di __ 5 HL Segment HL repeated 193 allowed maximum 1 Allowed values separated by comme 4 n al L Processing finished with emors Etasoft Inc Page 17 12 30 201 1 EDI Validator In this example N1 element 1 contains qualifier BY and each N1 is separated into individual N1s Scripts Scripts provide extra facility to validate data against specific business rules They can be developed in C and added to the validation process at various points of execution They can be attached to any object in the validation tree and get executed once validation engine receives data for that item For example if you set script on segment ISA element 3 it will be called when ISA is received from the input message and element 3 is processed Script will be loaded compiled and called
8. ad IN PAT ava Input File testnowtrangs NMT Error tat Output file CMesinowransout Ext Validation output format x12 997 License B4B T 3DL Results Errors a Warnings 105 Output 106 Count Segment Message Position Segmen Data J CLM There are more subelements in input than is defined in definitions 1035 ELM E 2 CLM There are mare subelements in input than i defined in definitions 1035 CLO 3 CLM There are more subelements in input than is defined in definitions 1035 CLM VO 4 HI There are more subelements in input than i defined in definitions 1210 Hl BE 5 HI There are mare subelements in input than i defined in definitions 1210 HI BK b HI There are more subelements in input than rs defined in definitions 1210 HI BK T HI There are more subelements in input than is defined in definitions 121 Hl BE B HI There are more subelements in input than i defined in definitions 1223 HI BF d HI There are more subelements in input thanis defined in definitions 1223 HI BF 1 HI There are more subelements in input than Is defined in definitions 1247 HI BR 11 HI There are mare subelements in input than i defined in definitions 1247 HI BR 1z HI There are more subelements in input than is defined in definitions 1247 HI BR m Run Close 3 Processing finished with warnings There is Validation Runner validrun exe in action
9. ckage You can load template using Templates menu or by pressing F10 on your keyboard Template directory is scanned and all template names appear in the list Etasoft Inc Page 5 12 30 201 1 EDI Validator JEDI Choose Template Templates E x12 4010 H x12_5010 x12 6010 Standard EDI X12 templates included in the package Pre built templates come without sub elements defined Sub elements have to be added manually in order for the validator to be able to validate them If sub element is received but not defined in the schema validator will produce warning message about it Etasoft Inc Page 6 12 30 2011 EDI Validator Sa Sin 0D Message DefaultValidation True Encoding ASCH Messagelype EDIXI2 _ SuppressMultiple False SuppressScriptE False Save modified template to directory of your choice This allows you to preserve original templates and changes you make are specific to your business rules Processing Internally processing is divided in two stages 1 Low level parser reads all the incoming data and parses it into segments elements and sub elements 2 Validator uses definitions objects and properties set by Validation Editor and performs validation All the errors and warnings are displayed in the lists at the bottom of the screen Etasoft Inc Page 7 12 30 201 1 File Edit Wiew Validation Schema ee Schema X12 856 SH Ship Message El Processin
10. eed characters enter 13 10 in Filter property Important character filtering may shift segment positions reported in errors and warnings Common properties explained in Message section above ScriptName script to be executed when segment processing starts PostScriptName script to be executed when segment processing ends Tag is specific character string that identifies segment Mandatory should be set to true if segment is mandatory MaxRepeat maximum number of occurences for this segment MinRepeat minimum number of occurences for this segment Common properties explained in Message section above FixedLength element has fixed length and uses Length property to validate it Length used with FixedLength to validate items length FormatType can be used to validate input data against various formats defined in Format property Format specific format to validate input data ScriptName script to be executed when element processing starts 12 30 2011 EDI Validator El Common Qualifiers if any qualifier is entered in this property Changed Fate validation will match not just segment name Tag but ld 1143 also value of the element that has qualifier set NN 05 206 Equipment Initial O idi aa by default will allow incoming data to have value Mandatory if set to true will have to be always present AllowedValues list of allowed values separated by comma DisallowedValues list of disallowed values separated by comma YPE Hement
11. efaultValidation Property senno or c ccc eV ER een 16 Oualhilliers Property oed DO E a ORUM op Ed D OR UC CR ERRAN 17 SODES M RR T S 18 Technical SUP DOME iunii acia bocib GR Rr Rot lE CER RR ROC ERG ea 8 ERROR RR Re CREER RR Ria 19 Etasoft Inc Page 1 12 30 2011 EDI Validator EDI Validator Purpose EDI Validator is data validation package for EDI X12 format messages While it is completely stand alone and independent it is recommended to be used with translator package in order to validate incoming and outgoing data Additional Documentation User Manual describes basic use of the EDI Validation Editor and other validation utilities You can find additional documentation and sample source code for Developer SDK in software installation directory Requirements Table lists minimum hardware and software requirements for the application to run Pentium 700 MHz 256Mbt 1 2Gbt Operating System Windows 2000 XP Vista 7 Windows Server 2003 If you are working with big input files recommended configuration is Pentium 2GHz 2Gbt 1 2Gbt Operating System Windows 2000 XP Vista 7 Windows Server 2003 License You can distribute evaluation version free of charge 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 You can also buy unlimited site license and install the software on unl
12. example Pacific Standard Time is 8 zz The time zone offset or followed by the hour only Single digit hours will have a leading zero For example Pacific Standard Time is 08 zzz The full time zone offset or followed by the hour and minutes Single digit hours and minutes will have leading zeros For example Pacific Standard Time is 08 00 The default time separator defined in TimeSeparator The default date separator defined in DateSeparator c Where c is a format pattern if used alone The 96 character can be omitted if the format pattern is combined with literal characters or other format patterns Vc Where c is any character Displays the character literally To display the backslash character use MinRepeat and MaxRepeat Properties MinRepeat and MaxRepeat properties can be used to validate segment looping and limit how many times segment can repeat within loop Important Segment section in error report is displaying parent segment name and not actual segment that has repeat problems and message section shows actual segment with repeat problems Exception to this is situation when top level segment such as ISA has repeat problems Then Segment section will be empty or show actual segment name Etasoft Inc Page 15 12 30 2011 EDI Validator File Edit View Validation Schema Help a X Hag Validation Schema Re fi Agency Cade 7 be T Version Control 8 A
13. g DefaultValidation True Encoding ASCII Messagelype EDIX12 scriptName El Reporting Suppress Multiple False SuppressscriptE F False Name Name 8 pe a 42 13 14 La Count M REF DTM DTM o M Na NI EDI Validator FT o Ing Pp SF l Brooklyn ST Message 7184350333 FASHION MFG CO E NY us 92 Slowed values m the item pete Code 1 id not match input di Allowed values for the item Packaging Code 1 did not match input di t Typical processing screen when validation fails with errors Error lines indicated in red and warning lines indicated in yellow You can minimize number of errors and warnings reported by setting properties SuppressMultipleNotifications and SuppressScriptErrors to True When SuppressMultipleNotifications is set to True validator will report only one error per segment Let say you have number of elements wrong in ST segment but only first error detected will be displayed SuppressScriptErrors will not show errors produced by custom script executions even if script fails with runtime error or fails to load You can use additional program called validrun to execute validations without use of EDI Validation Editor Etasoft Inc Page 8 12 30 2011 EDI Validator Extreme Validator Runner Validation Setup Validation schema eva CStestrow strane haar
14. imited number of computers in organization Visit our website to find more licensing details You can register and buy licenses online After the purchase email will be send to you with the license key Product license information License kep 5807 L RESDL DsTA34 3A7 Cancel Enter your license key in Product License screen Terminology List of definitions and they explanations Message Type Meaning All types File or data stream to be processed E SSB Bm N Etasoft Inc Page 2 12 30 2011 EDI Validator EDI X12 EDI segment such as ISA GE ST es a asas Element EDI X12 EDI element block of data inside of segment terminated by EDI separator S es eee Subelement EDI X12 EDI component sub element block of data inside of element Validation Schema EDI X12 message has to be defined for validation to work Message should contain all expected segments elements and sub elements If some segments are missing they will generate warning or error messages Segments can be added manually using Add gt Segment menu option or using Templates Wl COT Veldetien Coc Cl x DIIS c Wi i ED won L tad File Edit View Validation Schema Help Segment Cut Elernent Copy Paste subelement Delete B E I Encoding Messagelype criptName SuppressMultipleNotifica False H ppressScriptErrors False Adding segment manually Segme
15. ipleM otificatic False SuppressSeriptE rors False Separators Auto etect True Element ep EscapeLhar Segments ep SubElementSep S ubElement5 epz Tools Filter 13 410 Message properties PostScriptName Scrptame Tag Requirement Mandatory Max Repeat MinRepeat Segment properties Etasoft Inc Page 13 Id is property used internally by validator Name is object name displayed on the screen Type is object type Can be Message Segment Element or Subelement DefaultValidation is a flag to use build in basic validation for EDI X12 or EDIFACT see chapter Default Validation Encoding defaults to ASCII but can be changed to European 8bit if is used to validate inputs with accented European characters MessageType can be EDIX12 or EDIFACT ScriptName script to be executed when message processing starts SuppressMultipleNotifications will suppress multiple error or warning messages about the same segment SuppressScriptErrors will suppress errors raised during script execution AutoDetect will attempt to learn separators from incoming file AutoDetect may fail if EDI X12 message does not have ISA segment or EDIFACT does not have UNB segment at the top of the message ElementSep EscapeChar SegmentSep SubElementSep SubElementSep 2 various separators They have to be set if AutoDetect is set to false Filter can be used to filter garbage from input files For example to filter unwanted carriage return and line f
16. ipt attached via ScriptName property will get called when segment processing starts Script attached via PostScriptName property will get called when all the elements of that segment have already been processed Etasoft Inc Page 18 12 30 201 1 EDI Validator PostScriptName is usually used to check inter element cross reference rules For that you would attach scripts to elements that need to be referenced You can use tabGlobal to hold certain element values Then in PostScriptName for that segment you can compare values saved in tabGlobal and perform validation Technical Support Please contact technical support if you have any questions or concerns Contact information is listed on the product and company websites For most technical support questions we will request processing log Etasoft Inc Page 19 12 30 2011
17. nts should be added manually only if there is no pre built template already supplied with the product All of the templates are accessible via Project gt Templates menu When adding segments manually property has to be supplied in order for Etasoft Inc Page 3 12 30 2011 EDI Validator validator to find and identify segment in input message MEE X File Edit View Validation Schema Help ss sSOSSSCSCSCSCSCi idC X17 ER H C Hea thE are i laim Ai TX m im Suppress MutipleNotiical False DpressScri ptErrors False DefaultValidation properties When set to true DefaultValidation property turns on basic validation for EDI X12 messages If your EDI X12 message does not have standard enveloping segments like ISA GS GE IEA etc then this option should be turned off as those segments are primary basic validation targets Please check Default Validation chapter for more details Etasoft Inc Page 4 12 30 201 1 EDI Validator Sax a EDI Va TET LER fme File Edit View Validation Schema Help E 5 Bm s Validation Schema gs Al 837 HC Health Care Claim S ISA I r rom mE Ta SE Qualifiers Sy Hemden E hi1 Leil ril Pare ditch bec rcnt Allow Blank MES Whenever any processing property changes Changed property is set to True and object icon is marked red Validation Schema Templates Most common EDI X12 standard messages are included in the pa
18. o use OutputFormat to output errors and warnings in plain text or XML formats and output them on the screen default or write them into the file specified with Output switch in command line Etasoft Inc Page 9 12 30 2011 EDI Validator Recommendation try to use directories and file names without space characters in them Spaces provide additional challenges and when entered as command line parameters they have to be enclosed in quotes If quotes are omitted or missed spaces will split command line parameters and command will fail to run Example 1 validator exe C testnow schema856 xva License 348TL ULXTX X6L3X6 366F3 inoput C testnow test856 txt output C testnow testout txt outputformat Plain EE Administrator CAWindowsNsystem32 cmd validator exe input c Xresinoe Ee stt C WS xva License 346TL ULXTX X6L3X6 366 556 pm t output c tes tnow testout txt outputformat P lain Total segments in the file 690 Processing Finished 7 12 2010 12 A Segment name GS position 166 data 6113310271 20100236 1102 13512 xX 004010VICS Segment name TDL position 252 data TD1 CTN25 48 6G 19 200 LB Segment name TDL position 466 5 Segment name TD1 position 669 L Batch processing screen with Output and OutputFormat specified Example 2 validator exe C testnow schema856 xva License 348TL ULXT X X6L3X6 366F3 input C testnow test856 txt OnError Stop In Example 2 Output and OutputFormat is omitted B
19. ontains a well formed time value Whether GS08 and GEO 2 contain the same value Etasoft Inc Page 16 12 30 201 1 EDI Validator Whether GS01 contains the correct number of messages in the function group If there is a matching ST and SE pair Whether STO2 and SE02 contain same value Whether SEO01 contains the correct number of segments in the message Qualifiers Property This property can be set on element It allows you to match incoming segments not just by Tag property but also by qualifier values in the elements When validation process reads incoming segments it tries to match incoming segment to Tag properties of the segments in the schema definitions If any segment in schema has elements with Qualifier property set then validation process tries to match incoming element values to Qualifier property values set in the schema This is especially useful if you have few segments that have different validation rules based on qualifier values in them elements Most typical ones in EDI X12 are N1 NM1 REF DTM and PER segments that contain qualifiers You can enter few qualifiers in Qualifiers property separated by commas Add same qualifier value to AllowedValues property File Edit View Validation Schema Help i La d ga Validation Schema 1 EH CLD F lg MAN H DTM ik 7184350333 611331027 gj FOR i 131270001 6511 20100226 TI Identification be LLI
20. tasoft Inc Page 11 12 30 2011 EDI Validator Once you define X12 997 and 999 processing save definitions Now you can also generate 997 or 999 via command line Simply use OutputFormat 997 or OutputFormat 999 as a parameter validator exe c testnow xvalid test837P1 xva Input c testnow xvalid 837P 1 txt License 848TL RUFF4 TUUDDR 6RLFF Output c testnow xvalid 837P1_997 txt OutputFormat 997 Options Open most recently used file option will open most recently loaded or saved file Create backup copies of definition files will create extra backup copy of current file Show warnings message before delete will show warning message when definition item is about to be deleted Show internal processing information will show internal validation processing information messages in Output pane This option can be helpful when working with very complex validations E ditor Open most recently used file Create backup copies af definition files Show warning message before delete Show internal processing information Cancel Use Options screen to set Schema Editor options Etasoft Inc Page 12 12 30 2011 EDI Validator Properties Screen shot of properties Changed property is used to indicate items with changed EJ Common property values in the definitions tree Changed False Hame A12 837 HC Health Care Processing Default alidatior True Encoding ASCII Messagel ype EDIX1T2 Script ame Reporting S uppressMult
21. ut OnError flag is added This way output is provided only to the screen but if validation error happens program stops execution and waits for user input E Administrator CAWindows sy sy ste E C testnow gt validator ex F3 Input C testnow tes e C testnow schema856 xva_ License 3481L ULXTX X6L 3X6 ETT t656 txt OnError Stop Total segments in the mt bes 690 Processing Finished 7 12 2010 12 07 48 PM segment name G5 position 166 data GS SH 7184350333 61133102 71720100236 1102 1312 X 004010VIC5 Segment name TD1 position data TDi CTN25 48 56 19 200 LB Segment name TD1 position data TD1 CTN25 1 Batch processing screen with OnError flag but without Output and OutputFormat flags specified Output X12 997 or 999 acknowledgement Validator can produce X12 997 or 999 output as a result of validation of EDI X12 files You can define X12 997 and 999 output by using setup window under Run With Parameters screen Etasoft Inc Page 10 12 30 2011 EDI Validator Open EDI File mmm Parameters Validation schema D projects xvalidatorsbin iles templates x12 4010856 SH Ship Notice Manife aca al Templates Templates Input C Xestnow test E56 txt l is We Output CMtestnow trans out bi n gc outgoing 397 b i here A Output format 7 i 2 007 S I Define outgoing X12 997 via this screen ISA as Options Elements ISA07 Authorization Info Qualifier 22 D
22. with first parameter being input data for ISA element 3 If some element does not receive data script will not be called and executed for it Example let say you have script attached to REF element number 4 However your input data always comes with REF having only two elements That way script is never called Scripts Le Selected script test My Script basic Script using System using System Collections using System lO using System Xml using System Data namespace test 1 i class MyScript i petom some checking here and retum false if validation fails if strParam 00 retum false retum true Testing Testdata 55 Compile Successful Validation Result False Sample script compares incoming data with 00 if data is not equal to 00 validation fails Scripts also allow you to implement cross reference validation Since instance of Hashtable tabGlobal is shared by all scripts you can save data value of strParam current data in tabGlobal and retrieve it later in other script In that second script you can compare previous data values and make a decision Simply return false if you want script to fail the validation Segments run scripts at the start of processing when segment is being parsed and at the end of processing when segment and all its elements are already processed Therefore there are two types of properties called ScriptName and PostScriptName Scr
Download Pdf Manuals
Related Search