X12 OTD Library User’s Guide - Oracle Help Center

1 SeeBeyond Proprietary and ConfidentialX12 OTD Library user s GuideRelease information contained in this document is subject to change and is updated periodically to reflect changes to the applicable software. Although every effort has been made to ensure the accuracy of this document, SeeBeyond Technology Corporation (SeeBeyond) assumes no responsibility for any errors that may appear herein. The software described in this document is furnished under a License Agreement and may be used or copied only in accordance with the terms of such License Agreement. Printing, copying, or reproducing this document in any fashion is prohibited except in accordance with the License Agreement. The contents of this document are designated as being confidential and proprietary; are considered to be trade secrets of SeeBeyond; and may be used only in accordance with the License Agreement, as protected and enforceable by law.

2 SeeBeyond assumes no responsibility for the use or reliability of its software on platforms that are not supported by , e*Gate, e*Way, and e*Xchange are the registered trademarks of SeeBeyond Technology Corporation in the United States and/or select foreign countries. The SeeBeyond logo, SeeBeyond Integrated Composite Application Network Suite, eGate, eWay, eInsight, eVision, eXchange, eView, eIndex, eTL, ePortal, eBAM, and e*Insight are trademarks of SeeBeyond Technology Corporation. The absence of a trademark from this list does not constitute a waiver of SeeBeyond Technology Corporation's intellectual property rights concerning that trademark. This document may contain references to other company, brand, and product names. These company, brand, and product names are used herein for identification purposes only and may be the trademarks of their respective owners.

3 2004 SeeBeyond Technology Corporation. All Rights Reserved. This work is protected as an unpublished work under the copyright work is confidential and proprietary information of SeeBeyond and must be maintained in strict OTD Library user s Guide2 SeeBeyond Proprietary and ConfidentialContentsX12 OTD Library user s Guide3 SeeBeyond Proprietary and ConfidentialContentsList of Tables6 List of Figures7 Chapter 1 Introduction8 Overview8 Intended Reader8 Compatible Systems8 Document Organization9 Writing Conventions9 Additional Conventions9 Supporting Documents10 SeeBeyond Web Site10 Chapter 2X12 Overview11 Introduction to X1211 What Is X12?11 What Is a Message Structure?12 Components of an X12 Envelope12 Data Elements13 Segments13 Loops13 Delimiters13 Structure of an X12 Envelope14 Transaction Set (ST/SE)17 Functional Group (GS/GE)17 Interchange Envelope (ISA/IEA)18 Control Numbers19 ISA13 (Interchange Control Number)20GS06 (Functional Group Control Number)20 ContentsX12 OTD Library user s Guide4 SeeBeyond Proprietary and ConfidentialST02 (Transaction Set Control Number)

4 20 Backward Compatibility20 Messages21 Example of EDI Usage29 overview of EDI Payments Processing29 Types of Information that Is Exchanged Electronically30 Types of Electronic Payment30 Transfer of Funds31 Payment-Related EDI Transactions32 Acknowledgment Types32TA1, Interchange Acknowledgment32997, Functional Acknowledgment32 Application Acknowledgments33 Key Parts of EDI Processing Logic33 Structures33 Validations, Translations, Enveloping, Acknowledgments34 Trading Partner Agreements34 Additional Information34 Chapter 3 Installation35X12 Libraries35 Installation Procedure36 Uploading to the Repository36 Refreshing Enterprise Designer37X12 OTD Libraries38X12 OTDs38 Transaction Names39 Chapter 4 Working With the X12 OTDs40 Importing .jar Files40 Viewing an X12 OTD in the OTD Editor41 Setting the Delimiters43 Methods for Getting and Setting43 Bean Nodes for Getting and Setting Data44 Bean Nodes for Getting Errors and Results44 Using Validation in the Java Collaboration Editor45 Creating a Collaboration Rule to Validate an X12 OTD45 Alternative Formats.

5 ANSI and XML46 ContentsX12 OTD Library user s Guide5 SeeBeyond Proprietary and ConfidentialXML Format for X1246 Possible Differences in Output When Using Pass-Through49 Limitations of X12 OTDs49 Memory Requirements49 Delayed Unmarshaling50 Errors and Exceptions50 Special Methods for Error Classes51 Chapter 5 Java Methods for X12 OTDs52 Bean Nodes52 Read/Write Bean Nodes for Getting and Setting Values52 Read-Only Bean Nodes for Getting Values53 Bean Nodes for Reporting Errors and Exceptions53 Java Methods54check54clone55isUnmarshalComple te55marshal55marshalToBytes56marshalToSt ring56performValidation56reset57setDefau ltX12 Delimiters58getElementSeparator58setElem entSeparator59getRepetitionSeparator60se tRepetitionSeparator60getSegmentTerminat or61setSegmentTerminator61getSubelementS eparator62setSubelementSeparator63setXml Output63unmarshal64unmarshalFromBytes65u nmarshalFromString65 Index66 List of TablesX12 OTD Library user s Guide6 SeeBeyond Proprietary and ConfidentialList of TablesTable 1 Writing Conventions9 Table 2 Default Delimiters in X12 OTD Library14 Table 3 Transactions Included in X12 Version 401021 Table 4 Key Parts of EDI Processing33 Table 5X12 Versions Supported35 List of FiguresX12 OTD Library user s Guide7 SeeBeyond Proprietary and ConfidentialList of FiguresFigure 1X12 Envelope Schematic15 Figure 2X12 997 (Functional Acknowledgment) Segment Table15 Figure 3X12 997 (Functional Acknowledgment)

6 Viewed in OTD Editor16 Figure 4 Example of a Transaction Set Header (ST)17 Figure 5 Example of a Transaction Set Trailer (SE)17 Figure 6 Example of a Functional Group Header (GS)18 Figure 7 Example of a Functional Group Trailer (GE)18 Figure 8 Example of an Interchange Header (ISA)19 Figure 9 Example of an Interchange Trailer (IEA)19 Figure 10 Update Center Wizard: Select Modules to Install37 Figure 11 Some of the Transaction Set Structures for X12 Version 401038 Figure 12 Importing 13X12 270 Transaction in the OTD Editor42 Figure 14 Accessing a Method in an X12 OTD45 Figure 15 Accessing the performValidation Method from the Root Node46 Figure 16 XML X12 DTD47 Figure 17X12 997 Functional Acknowledgment XML48 Figure 18X12 997 Functional Acknowledgment ANSI Format48 Figure 19 Setting the Maximum Heap Size49X12 OTD Library user s Guide8 SeeBeyond Proprietary and ConfidentialChapter 1 IntroductionThis chapter introduces you to the X12 OTD Library user s of the eGate Object Type Definition (OTD) libraries contains sets of pre-built structures for industry-standard formats.

7 The ASC X12 OTD Library is one of the products within the SeeBeyond ICAN Suite. The OTD Library contains message definitions for X12 document gives a brief overview of X12 and the X12 message structures provided, and provides information on installing and using the ASC X12 OTD ReaderThe reader of this Guide is presumed to be a developer or system administrator with responsibility for maintaining the SeeBeyond ICAN Suite (such as eGate Integrator and eXchange Integrator), to have familiarity with Windows operations and administration, and to be thoroughly familiar with Microsoft Windows graphical user SystemsThe ASC X12 OTD Library is available on the following platforms: Microsoft Windows 2000, Windows XP, and Windows 2003 Sun Solaris 8 and Solaris 9 IBM AIX 5L Version and AIX 5L Version HP-UX and HP-UX 11i (PA-RISC) HP Tru64 UNIX Version Red Hat Linux 8 (Intel x86) and Linux Advanced Server (Intel x86)Chapter 1 Section OrganizationX12 OTD Library user s Guide9 SeeBeyond Proprietary and OrganizationThis document is organized topically as follows: Chapter 1 Introduction gives a general preview of this document, its purpose, scope, and organization.

8 Chapter 2 X12 overview provides an overview of X12. Chapter 3 Installation explains how to install the X12 OTD Library files and where to find them after installation. Chapter 4 Working With the X12 OTDs provides instructions and examples on how to load, view, and test X12 OTDs. Chapter 5 Java Methods for X12 OTDs lists and explains the bean nodes and Java methods that can be used to extend the functionality of the OTDs in the ConventionsThe following writing conventions are observed throughout this ConventionsWindows SystemsFor the purposes of this Guide , references to Windows will apply to Microsoft Windows Server 2003, Windows XP, and Windows Name SeparatorThis Guide uses the backslash ( \ ) as the separator within path names. If you are working on a UNIX or HP NonStop system, please make the appropriate 1 Writing Conventions TextConventionExampleNames of buttons, files, menus and menu items, icons, parameters, variables, methods, and objectsBold text Click OK to save and close.

9 Select the file. On the File menu, click Exit. Enter the timeout value. Use the getClassName() arguments, code samplesFixed font. Variables are shown in bold -f -p passwordHypertext linksBlue text For more information, see Writing Conventions on page 9. 1 Section DocumentsX12 OTD Library user s Guide10 SeeBeyond Proprietary and DocumentsThe following SeeBeyond documents provide additional information about eGate and the ICAN system: You can also refer to the appropriate Microsoft Windows or UNIX documents, if Web SiteThe SeeBeyond Web site is your best source for up-to-the-minute product news and technical support information. The site s URL is: SeeBeyond ICAN Suite Installation Guide SeeBeyond ICAN Suite Primer SeeBeyond ICAN Suite Deployment Guide eGate Integrator user s Guide eGate Integrator Tutorial eGate Integrator System Administration Guide eXchange Integrator user s Guide HIPAA OTD Library user s Guide UN/ edifact OTD Library user s GuideX12 OTD Library user s Guide11 SeeBeyond Proprietary and ConfidentialChapter 2X12 OverviewThis chapter provides the following information: An overview of X12, including the structure of an X12 envelope, data elements, and syntax.

10 An explanation of how to use the generic message structures provided as an add-on to eGate to help you quickly create the structures you need for X12 transactions. An example of how X12 is used in payment to X12 The following sections provide an introduction to X12 and to the message structures that constitute the X12 OTD Is X12?X12 is an EDI (electronic data interchange) standard, developed for the electronic exchange of machine-readable information between Accredited standards Committee (ASC) X12 was chartered by the American National standards Institute (ANSI) in 1979 to develop uniform standards for interindustry electronic interchange of business transactions electronic data interchange (EDI). The result was the X12 X12 body develops, maintains, interprets, and promotes the proper use of the ASC standard. Data Interchange standards Association (DISA) publishes the X12 standard and the UN/ edifact standard.