iway iway Integration Solution for EDI User's Guide Version 5 Release 5 Service Manager (SM) DN

Transcription

1 iway iway Integration Solution for EDI User's Guide Version 5 Release 5 Service Manager (SM) DN

2 EDA, EDA/SQL, FIDEL, FOCCALC, FOCUS, FOCUS Fusion, FOCUS Vision, Hospital-Trac, Information Builders, the Information Builders logo, Parlay, PC/FOCUS, SmartMart, SmartMode, SNAPpack, TableTalk, WALDO, Web390, WebFOCUS and WorldMART are registered trademarks, and iway and iway Software are trademarks of Information Builders, Inc. Due to the nature of this material, this document refers to numerous hardware and software products by their trademarks. In most, if not all cases, these designations are claimed as trademarks or registered trademarks by their respective companies. It is not this publisher s intent to use any of these names generically. The reader is therefore cautioned to investigate all claimed trademark rights before using any of these names other than to refer to the product described. Copyright 2008, by Information Builders, Inc. and iway Software. All rights reserved. Patent Pending. This manual, or parts thereof, may not be reproduced in any form without the written permission of Information Builders, Inc.

3 iway Contents Preface...7 Documentation Conventions...8 Related Publications...9 Customer Support...9 Help Us to Serve You Better...10 User Feedback...12 iway Software Training and Professional Services Introducing the iway Integration Solution for EDI...13 A Brief History of Electronic Data Interchange...14 Early Standardization Efforts...14 The ANSI X12 and UN/EDIFACT Standard...15 Features of the iway Integration Solution for EDI...15 EDI X12 Transmission Envelope Structure...17 Information Roadmap Deployment Information for Your iway Integration Solution...19 iway Products...20 iway Service Manager...20 iway Transformer...20 iway Designer...21 Using a Channel to Construct a Message Flow...21 Components of a Channel...22 Components of the iway Integration Solution for EDI...25 Ebix...25 Preparsers...26 Acknowledgement Service...27 Preemitter...27 Data Segments and Data Elements...28 iway Integration Solution for EDI User's Guide 3

4 Contents 3. Inbound Processing: EDI to XML...31 Inbound Processing Overview...32 Sample Configuration for Inbound Processing: EDI to XML...33 Accessing the iway Service Manager Administration Console...33 Adding an Ebix to the Registry...35 Defining an Inlet...38 Defining a Route...46 Defining the Outlets...50 Defining a Channel...55 Reusing Your Channel Configuration Outbound Processing: XML to EDI...63 Outbound Processing Overview...64 Sample Configuration for Outbound Processing: XML to EDI...65 Accessing the iway Service Manager Administration Console...65 Adding an Ebix to the Registry...65 Defining an Inlet...67 Defining a Route...70 Defining an Outlet...71 Defining a Channel...75 Reusing Your Channel Configuration...79 A. Ebix-Supported Transaction Sets...81 Transaction Set and Acknowledgement Support...82 B. Separators and Terminators Separators and Terminators C. Special Register (SREG) Types Special Register (SREG) Types D. Sample EDI Files Sample EDI Purchase Order Sample EDI Invoice Sample EDI Advanced Ship Notice iway Software

5 Contents E. Defining a Route With iway Designer Defining a Route With iway Designer Reader Comments iway Integration Solution for EDI User's Guide 5

6 Contents 6 iway Software

7 iway Preface This documentation describes how to configure and use the iway Integration Solution for EDI. It is intended for developers to enable them to parse, transform, validate, store, and integrate information into the existing enterprise and pass information electronically to partners in Electronic Data Interchange (EDI) mandated format. How This Manual Is Organized This manual includes the following chapters: Chapter/Appendix Introducing the iway Integration Solution for EDI Deployment Information for Your iway Integration Solution Inbound Processing: EDI to XML Outbound Processing: XML to EDI Contents Describes Electronic Data Interchange (EDI) and how the components of the iway Integration Solution for EDI streamline the flow of information. Describes the iway products used with your iway Integration Solution for EDI and provides a roadmap to full information on those products. Introduces the concept of a channel for the construction of a message flow in iway Service Manager. Includes an overview of the iway business components and processing steps in a basic inbound message flow. The message flow converts a document from EDI format to XML format. Also includes instructions for configuring a basic inbound message flow. Includes an overview of the iway business components and processing steps in a basic outbound message flow. The message flow converts a document from XML format to EDI format. Also includes instructions for configuring a basic outbound message flow. iway Integration Solution for EDI User's Guide 7

8 Documentation Conventions A B C D E Chapter/Appendix Ebix-Supported Transaction Sets Separators and Terminators Special Register (SREG) Types Sample EDI Files Defining a Route With iway Designer Contents Describes the ANSI X12 transaction sets supported by the iway Integration Solution for EDI in the Ebix files supplied with the product. Includes a list of separators and terminators that are allowed. Describes the Special Register (SREG) types that are created during EDI to XML transactions and 997 creation. Includes a sample EDI Purchase Order, Invoice, and Advanced Ship Notice. Includes instructions for creating an iway Designer Project and defining a route using iway Designer. iway designer is used to create and publish a process flow bound to a channel as a route. Documentation Conventions The following table lists and describes the conventions that apply in this manual. Convention THIS TYPEFACE or this typeface this typeface underscore this typeface Key + Key Description Denotes syntax that you must enter exactly as shown. Represents a placeholder (or variable), a cross-reference, or an important term. It may also indicate a button, menu item, or dialog box option you can click or select. Indicates a default setting. Highlights a file name or command. Indicates keys that you must press simultaneously. 8 iway Software

9 Preface Convention { } Description Indicates two or three choices; type one of them, not the braces. Separates mutually exclusive choices in syntax. Type one of them, not the symbol. Indicates that you can enter a parameter multiple times. Type only the parameter, not the ellipsis points (...). Indicates that there are (or could be) intervening or additional commands. Related Publications To view a current listing of our publications and to place an order, visit our World Wide Web site, You can also contact the Publications Order Department at (800) Customer Support Do you have questions about this product? Call Information Builders Customer Support Services (CSS) at (800) or (212) Customer Support Consultants are available Monday through Friday between 8:00 A.M. and 8:00 P.M. EST to address all your questions. Information Builders consultants can also give you general guidance regarding product capabilities and documentation. Be prepared to provide your six-digit site code (xxxx.xx) when you call. You can also access support services electronically, 24 hours a day, with InfoResponse Online. InfoResponse Online is accessible through our World Wide Web site, You can connect to the tracking system and knownproblem database at the Information Builders support center. Registered users can open, update, and view the status of cases in the tracking system and read descriptions of reported software issues. New users can register immediately for this service. The technical support section also provides usage techniques, diagnostic tips, and answers to frequently asked questions. To learn about the full range of available support services, ask your Information Builders representative about InfoResponse Online, or call (800) 969-INFO. iway Integration Solution for EDI User's Guide 9

10 Help Us to Serve You Better Help Us to Serve You Better To help our consultants answer your questions effectively, be prepared to provide specifications and sample files and to answer questions about errors and problems. The following table lists the environment information our consultants require. Platform Operating System OS Version JAM Vendor JAM Version The following table lists the deployment information our consultants require. Integration Solution Deployment Container For example, JCA, iway Business Services Provider, iway Service Manager For example, WebSphere Version Enterprise Information System (EIS) - if any EIS Release Level EIS Service Pack EIS Platform The following table lists iway-related information needed by our consultants. iway Integration Solution iway Release Level iway Patch 10 iway Software

11 Preface The following table lists additional questions to help us serve you better. Request/Question Error/Problem Details or Information Did the problem arise through a service or event? Provide usage scenarios or summarize the application that produces the problem. When did the problem start? Can you reproduce this problem consistently? Describe the problem. Describe the steps to reproduce the problem. Specify the error message(s). Any change in the application environment: software configuration, EIS/database configuration, application, and so forth? Under what circumstance does the problem not occur? Following is a list of error/problem files that might be applicable. Input documents (XML instance, XML schema, non-xml documents) Transformation files Error screen shots Error output files Trace files Service Manager package to reproduce problem Custom functions and services in use iway Integration Solution for EDI User's Guide 11

12 User Feedback User Feedback Diagnostic zip Transaction log For information on tracing, see the iway Service Manager User's Guide. In an effort to produce effective documentation, the Documentation Services staff welcomes your opinions regarding this manual. Please use the Reader Comments form at the end of this manual to communicate suggestions for improving this publication or to alert us to corrections. You can also go to our Web site, and use the Documentation Feedback form. Thank you, in advance, for your comments. iway Software Training and Professional Services Interested in training? Our Education Department offers a wide variety of training courses for iway Software and other Information Builders products. For information on course descriptions, locations, and dates, or to register for classes, visit our World Wide Web site, or call (800) 969-INFO to speak to an Education Representative. Interested in technical assistance for your implementation? Our Professional Services department provides expert design, systems architecture, implementation, and project management services for all your business integration projects. For information, visit our World Wide Web site, 12 iway Software

13 iway Introducing the iway Integration Solution for 1 EDI The iway Integration Solution for EDI transforms Electronic Data Interchange (EDI) documents into standard XML format, or transforms XML representations into EDI format. This section provides an overview of EDI and describes the features that are provided by the iway Integration Solution for EDI. Topics: A Brief History of Electronic Data Interchange Features of the iway Integration Solution for EDI Information Roadmap iway Integration Solution for EDI User's Guide 13

14 A Brief History of Electronic Data Interchange A Brief History of Electronic Data Interchange In this section: Early Standardization Efforts The ANSI X12 and UN/EDIFACT Standard Electronic Data Interchange (EDI) is a set of standards for formatting information that is electronically exchanged between one business and another, or within a business. These standards describe how documents for conducting certain aspects of business such as purchase orders and purchase order acknowledgements are structured. By specifying a standardized, computer-readable format for transferring data, EDI enables the automation of commercial transactions around the world. It provides a common, uniform language through which computers can communicate for fast and efficient transaction processing. Early Standardization Efforts Before the development of standards, many businesses used proprietary systems to exchange trading information such as purchase orders and invoices. However, they recognized the economic need for a faster, less costly way to process information in order to stay competitive in the business world. Business sectors such as transportation, grocery supply, and banking drove the creation of standards for the communication of data. In 1968, the United States Transportation Data Coordinating Committee (TDCC) was formed to oversee the design and development of format standards for transportation documents. In 1975, the TDCC released its first standard, the Rail Transportation Industry Application. The Rail Transportation Industry Application focused on the content of a message rather than the means of transmission through the use of transaction sets. A transaction set is a business document that consists of an arrangement of data segments. The data segments include data elements in an exact order. The concept of the transaction set is the basis of the EDI ANSI X12 standard created later and widely used today. About the same time that the TDCC was formed, the United Kingdom started its own effort to develop standard transaction documents for trans-atlantic trade. The U.K. Department of Customs and Excise, with the help of the British Simplification of Trade Procedures Board (SITPRO), developed a competitive document standard for international trade, named TRADACOMS. 14 iway Software

15 1. Introducing the iway Integration Solution for EDI The ANSI X12 and UN/EDIFACT Standard Standards development progressed in 1979, when the American National Standards Institute (ANSI) chartered the Accredited Standards Committee (ASC) X12 to develop a uniform standard for electronic, inter-industry business transactions. The United States Electronic Data Interchange (EDI) ANSI X12 standard, which resulted from the committee's effort, extended and ultimately replaced the standards created by the TDCC. In 1988, the United Nations chartered UN/EDIFACT (United Nations Electronic Data Interchange for Administration, Commerce, and Transport) to develop a worldwide, internationally approved standard structure for exchanging information among partners. The UN/EDIFACT standards are called United Nations Standard Messages (UNSM). They are comparable to the ANSI ASC X12 transaction sets. EDI is the standardized data format used for the majority of the world's electronic business transactions. Many companies use either the ANSI X12 or UN/EDIFACT standard, or both. With over 275 transaction sets, the ANSI X12 standard is used to perform nearly every aspect of business operation such as order placement and processing, shipping and receiving, invoicing and payment, pricing and sales, and inventory. It streamlines the communication of data to and from a broad range of entities, including financial and education institutions, insurance providers, food and pharmaceutical suppliers, retailers, automotive manufacturers, and federal and state government. Features of the iway Integration Solution for EDI In this section: EDI X12 Transmission Envelope Structure The standards-based iway Integration Solution for EDI reduces the amount of effort it takes to integrate Electronic Data Interchange (EDI) documents with your internal enterprise applications and third-party trading partners. It includes conversion and validation of documents from EDI to XML format, making it easy to include EDI documents in your XMLbased integration projects. Features of the iway Integration Solution for EDI include: Integration with iway Service Manager to provide bi-directional conversion of EDI formats and XML. Integration with iway Trading Partner Manager to provide routing, custom transformation by document, and other value-added features. Integration with more than 200 other information assets, including J2EE-based back-office systems; data structures such as DB2, IMS, VSAM, and ADABAS; and front-office systems based on Sybase. iway Integration Solution for EDI User's Guide 15

16 Features of the iway Integration Solution for EDI Integration with leading application servers, integration brokers, and development environments. Supported software platforms include BEA WebLogic, IBM WebSphere, Sun Java Enterprise System, and Oracle Application Server. Support for synchronous and asynchronous bi-directional interactions for EDI documents between application servers, integration brokers, third-party software packages, and messaging services. Out-of-the-box support for EDI ANSI X12 transaction sets. For details on the supported transaction sets, see Ebix-Supported Transaction Sets on page 81. Reusable framework for parsing, transforming, and validating EDI documents without the need to write custom code. Data dictionary approach that facilitates EDI-to-XML transformations. The iway Integration Solution for EDI uses dictionaries to transform data from EDI format to any other format, or from any format to EDI format. It supports flat files, comma-delimited files, popular relational database formats, XML, and more. Pre-built data dictionaries, XML schemas, transformation templates, and rule files for automatic transformation and validation of input and output documents. 16 iway Software

17 1. Introducing the iway Integration Solution for EDI EDI X12 Transmission Envelope Structure The following image illustrates a typical EDI X12 envelope structure that is used during a purchase order transmission. Syntax for an EDI X12 document containing two purchase orders is shown on the left and a graphical representation of the hierarchy is provided on the right. An EDI X12 document must contain the following segments in its structure: Interchange Control Header (ISA) - Indicates the start of the interchange. The ISA segment has a fixed length and consists of 106 characters. The fourth character, for example, an asterisk (*), is the segment delimiter that is used throughout the document. Functional Group Header (GS) - Indicates the start of a group, which contains one or more transaction sets. The GS segment contains various sender and receiver codes for identification and control purposes. Transaction Set Header (ST) - Indicates the start of a transaction set. The transaction set contains segments that make up the message data. All of the details that are required to process the transaction are available within the transaction set. A transaction set can contain one or more loops, which are required to repeat a collection of related segments. Transaction Set Trailer (SE) - Indicates the end of a transaction set. The SE segment provides a count of the data segments that includes the header and trailer segments. iway Integration Solution for EDI User's Guide 17

18 Information Roadmap Functional Group Trailer (GE) - Indicates the end of the group. The GE segment contains an element that indicates the number of transaction sets within the group. Interchange Control Trailer (IEA) - Indicates the end of the interchange. The IEA segment contains an element that indicates the number of groups within the interchange. Information Roadmap The following table lists the location of deployment and user information for products used with the iway Integration Solution for EDI. Product iway Service Manager iway Transformer iway Designer For more information, see... Chapters 3 and 4 of this guide iway Service Manager User's Guide iway Transformer User's Guide Appendix D of this guide iway Designer User s Guide 18 iway Software

19 iway Deployment Information for Your iway 2 Integration Solution This topic describes the iway products used with your iway Integration Solution for EDI and provides a roadmap to full information on those products. It also introduces the concept of a channel for the construction of a message flow in iway Service Manager. Topics: iway Products Using a Channel to Construct a Message Flow Components of the iway Integration Solution for EDI iway Integration Solution for EDI User's Guide 19

20 iway Products iway Products In this section: iway Service Manager iway Transformer iway Designer Your iway integration solution works in conjunction with one or more of the following products: iway Service Manager iway Transformer iway Designer iway Service Manager iway Service Manager is the heart of the Universal Integration Framework and is an open transport service bus. Service Manager uses graphical tools to create sophisticated integration services without writing custom integration code by: Using metadata from target applications Transforming and mapping interfaces Managing stateless processes Its capability to manage complex integration interactions makes it ideally suited to be the foundation of a service-oriented architecture. For more information, see the IWay Service Manager User s Guide. iway Transformer iway Transformer is a rule-based data transformation tool that converts an input document of one data format to an output document of another data format or structure. The easy-touse graphical user interface and function tool set facilitate the design of transform projects that are specific to your requirements. For more information, see the iway Transformer User's Guide. 20 iway Software

21 2. Deployment Information for Your iway Integration Solution iway Designer The capability of graphically visualizing a business process is a powerful and necessary component of any e-business offering. iway Designer, a Windows-based design-time tool, provides a visual and user-friendly method of creating a business process, also called a process flow. Through a process flow, you control the sequence in which tasks are performed and the destination of the output from each task. For more information, see the iway Designer User s Guide. For details on using iway Designer in configuring the iway Integration Solution for EDI, see Defining a Route With iway Designer on page 112. Using a Channel to Construct a Message Flow In this section: Components of a Channel The use of iway Service Manager is centered on a channel. A channel is a container for all the iway business components used in an EDI message flow. At a high level, a channel accepts input data via an inlet, processes the data via a route, and outputs the resulting data via an outlet. Another component in the process is an e- Business Information Exchange (Ebix). The following diagram shows the channel components available in the construction of a message flow. In the following diagram, the value n underneath a component name indicates how many instances of that component you can have in a channel configuration zero, one, or more than one. For example, n = 1 for Inlet means that you can have only one inlet on the channel. iway Integration Solution for EDI User's Guide 21

22 Using a Channel to Construct a Message Flow Required components are in boldface type. Components of a Channel A channel consists of: An inlet, which defines how a message enters a channel. A route, which defines the path a message takes through a channel. Outlets, which define how transformed messages leave a channel. An e-business Information Exchange (Ebix), which is a collection of metadata that defines the structure of data. 22 iway Software

23 2. Deployment Information for Your iway Integration Solution iway Service Manager provides a design-time repository called the Registry, where you assemble and manage the components in a channel. An inlet can contain: A listener (required), which is a protocol handler responsible for picking up an incoming message on a channel. A decryptor, which applies a decryption algorithm to an incoming message and verifies the security of the message. A preparser, which is a logical process that converts an incoming message into a processable document. The preparsed document then passes through the standard transformation services to reach the designated processing service. A route can contain: An in transformer, which is an exit sequence that applies to a message before processing occurs. A reviewer, which is either the first exit to receive a document after parsing (inbound), or the last exit to receive a document prior to the actual emit operation (outbound). These exits are intended for envelope handling but can be used for any desired purpose. Validation rules, which apply validation using the rules validation engine. Rules are provided when the iway Integration Solution for EDI is installed. A transform, which is a transformation definition file that contains sets of rules, interpreted and executed by a transformation engine. Transformation is the process by which data is transformed from one structure/format to another. A process, which is a stateless, lightweight, short-lived microflow that is executed by iway Service Manager on a message as it passes through the system. Processes that are published using iway Designer are available in the Registry and can be bound to channels as routes. A pflow process. An agent list. A service, which is an executable Java procedure that handles the business logic of a message. iway Integration Solution for EDI User's Guide 23

24 Using a Channel to Construct a Message Flow An adapter, which refers to a target that represents a specific instance of a connection to a back-end system. An out transformer, which is an exit sequence that applies to a message after processing occurs. A transform, which is a transformation definition file that contains sets of rules, interpreted and executed by a transformation engine. Transformation is the process by which data is transformed from one structure/format to another. Validation rules, which apply validation using the rules validation engine. Rules are provided when the iway Integration Solution for EDI is installed. A reviewer, which is either the first exit to receive a document after parsing (inbound), or the last exit to receive a document prior to the actual emit operation (outbound). These exits are intended for envelope handling but can be used for any desired purpose. An outlet (optional), which is responsible for all aspects of preparing a document for emission and then emitting it. A preemitter, which is a logical process that handles a document immediately before transmission. Normally it converts an XML document into non-xml format. An encryptor, which can be called to encrypt an outgoing document. An emitter, which is a transport protocol that sends a document to its recipient. An outlet can contain: A preemitter. An encryptor. Multiple emitters. For details on the preceding components, see the iway Service Manager User's Guide. 24 iway Software

25 2. Deployment Information for Your iway Integration Solution Components of the iway Integration Solution for EDI In this section: Ebix Preparsers Acknowledgement Service Preemitter Data Segments and Data Elements iway business components used in the construction of a message flow for EDI transactions include: Ebix An Ebix (e-business Information Exchange) A preparser An acknowledgement service A preemitter iway Software provides various e-business Information Exchange (Ebix) files used in conjunction with the iway integration solutions. In iway Service Manager, the iway Integration Solution for EDI contains several Ebix files, one for each supported EDI ANSI X12 transaction set. An Ebix file for EDI-X12 is named X12_transaction_set.ebx, where transaction_set is the transaction set number. For example, the Ebix file for EDI X-12 transaction set 4050 is named X12_4050.ebx. For details on the supported EDI X-12 transaction sets, see Ebix-Supported Transaction Sets on page 81. An Ebix is a collection of metadata that defines the structure of data. The Ebix supplied with the iway Integration Solution for EDI defines the structure of supported EDI messages. Each Ebix includes: Pre-built data dictionaries. The structure of each EDI document is described by two data dictionaries: Header dictionary, which describes the enveloping structure of the document. iway Integration Solution for EDI User's Guide 25

26 Components of the iway Integration Solution for EDI Document dictionary, which describes the segments and elements that compose each document. The dictionaries from the Ebix are used to transform the structure of a document per EDI regulation. Pre-built XML schemas that define the structure and content of XML messages in detail. Pre-built EDI to XML transformation templates, and XML to EDI templates, for the supported EDI ANSI X12 transaction sets. Pre-built rule files for each message. The iway Integration Solution for EDI uses these rule files to validate inbound and outbound documents. Preparsers In this section: EDIX12SplitterPreParser A preparser is an iway business component that converts incoming messages into processable documents. Typically a preparser converts a non-xml document into XML format. The preparser for the iway Integration Solution for EDI converts an incoming EDI-X12 formatted document to XML format. The EDIX12SplitterPreParser is provided by iway Software for the iway Integration Solution for EDI. EDIX12SplitterPreParser The EDIX12SplitterPreParser (com.ibi.preparsers.edisplitpp) parses an EDI input file that contains one or more interchanges (ISA) and multiple documents, and creates multiple XML output files. One XML output file is produced for each document. For example, if the EDI input file contains three documents within one ISA, the EDIX12SplitterPreParser creates three XML output files, one per document. Use the EDIX12SplitterPreParser for large files with multiple documents within one ISA; if there is a specific business requirement to create separate XML output files; or if you receive multiple documents within one ISA and want to separate each document for further business processing. You can also use the EDIX12SplitterPreParser if there is only one document within the ISA. 26 iway Software

27 2. Deployment Information for Your iway Integration Solution Acknowledgement Service An acknowledgement service is an iway business component used in inbound processing to create a functional acknowledgement (997) for inbound messages. An acknowledgement indicates that an inbound document was received and validated for structure against the appropriate standard. An acknowledgement does not indicate that a document was processed. An acknowledgement is typically routed back to the originator of the inbound document or to the next step in the integration process. It is a best business practice to send an acknowledgement to the originator of the inbound document. The acknowledgement service for the iway Integration Solution for EDI is called EDIX12AckAgent (com.ibi.agents.xdx12ackagent). Preemitter A preemitter is a logical process that handles a document immediately before transmission. Typically a preemitter is used to convert an XML document to non-xml format. The XML document is created from EDI input data in inbound processing. The iway Integration Solution for EDI uses a preemitter in outbound processing to convert the XML-formatted EDI document to an EDI-X12 formatted document. The XML structure must be compliant with the schema supplied in the Ebix. The preemitter for the iway Integration Solution for EDI is called EDIX12PreEmitter (com.ibi.preemit.xdx12preemitter). iway Integration Solution for EDI User's Guide 27

28 Components of the iway Integration Solution for EDI Data Segments and Data Elements The following example shows what an 850 purchase order looks like. Each line is called a Data Segment and begins with the Segment Name. For example, N1 represents name and address line 1 while PO1 represents puchase order line 1. Following the Segment Name are a number of Data Elements. In the N1 segment, the code BT means it s a bill-to name and address. Data elements are separated by a single character, usually an asterisk (*). A segment ends with a single character-- in this example a tilde (~). Other EDI documents such as an 835 Health Care Claim will have their own sets of data segments and data elements. Segments such as the N1 overlap many transaction sets, but an 835 will have its own segments and elements that are unique to healthcare. 28 iway Software

29 2. Deployment Information for Your iway Integration Solution Any number of data segments come together to form a transaction set. In this example, there are 32, as shown in the control counter stored in the very last segment (SE). You will notice that the PO1, PID and PO4 segments repeat multiple times, just as they would on a paper-based purchase order. There is flexibility in how an industry or company uses the EDI standards. For example, a purchase order going from a retailer to its supplier will look very different from a purchase order going from a mining company to its supplier. The drawback is when one supplier receives purchase orders from five different customers and they each structure their 850s differently. The supplier is burdened with the task of handling the five different 850 layouts. iway Integration Solution for EDI User's Guide 29

30 Components of the iway Integration Solution for EDI 30 iway Software

31 iway 3 Inbound Processing: EDI to XML The iway Integration Solution for EDI includes iway Service Manager. iway Service Manager converts a document from Electronic Data Interchange (EDI) format to XML format, and validates it based on EDI's published implementation guides. This chapter provides the information you need to understand and implement a basic inbound message flow. Topics: Inbound Processing Overview Sample Configuration for Inbound Processing: EDI to XML The inbound processing overview describes the iway business components and the processing steps in the basic inbound message flow. The sample configuration contains detailed instructions for configuring the basic inbound message flow. This topic guides you through each step of the configuration procedure. iway Integration Solution for EDI User's Guide 31

32 Inbound Processing Overview Inbound Processing Overview The inbound process converts an EDI-X12 formatted document to an XML document. In a basic message flow, inbound processing consists of the following components and steps. For an illustration of the components available in the construction of a message flow, see Using a Channel to Construct a Message Flow on page 21. You will define the components in the configuration instructions in Sample Configuration for Inbound Processing: EDI to XML on page 33. Inlet The listener picks up the incoming EDI document. The preparser obtains the message type and version from the EDI document, in order to select the appropriate transformation template name. The transformation template converts the original EDI document to an XML representation of that document. The preparser ensures that the document is converted to a structurally correct EDI XML document. The transformation templates that are provided in the Ebix are used to transform the structure of the document. The iway Integration Solution for EDI supports one preparser (EDIX12SplitterPreParser), which is described in Preparsers on page 26. Validation The inbound EDI document is validated for structure and content. The published EDI standards and user implementation guides define element types (for example, numeric, alpha, or date) and describe business rules to apply for validation. For example, here is a typical date segment in an inbound EDI document: DTM*001* The value in DTM01 ("001") is validated against an allowed code list. The value in DTM02 (" ") is validated as a properly formatted date. In addition, the following business rule is applied: DTM02 is required if DTM01 is present (if there is a qualifier, there must be data). Route After validation, you can apply any additional business logic to the document. You can use a single service or multiple services, passing the output of one service to the input of the next. In our basic message flow, the copy service redirects the output document to the destination. For details on available services, see the iway Service Manager User's Guide. 32 iway Software

33 3. Inbound Processing: EDI to XML The acknowledgement service creates a functional acknowledgement (997) for the inbound document. The acknowledgement indicates that the document was received and validated for structure. Outlets Outlets define how messages leave a channel at the end of a process. In our basic sample channel, two outlets are configured: One outputs the XML format of the document. In a real case scenario, it would output the result of your business logic. The other outputs the functional acknowledgement. A functional acknowledgement is typically returned to the sender of the document. Sample Configuration for Inbound Processing: EDI to XML In this section: Accessing the iway Service Manager Administration Console Adding an Ebix to the Registry Defining an Inlet Defining a Route Defining the Outlets Defining a Channel Reusing Your Channel Configuration This topic provides step-by-step instructions on how to configure a basic inbound message flow for the iway Integration Solution for EDI. The message flow represents the movement and tasks in the conversion of a message from Electronic Data Interchange (EDI) format to XML format and acknowledgement of the message. Accessing the iway Service Manager Administration Console How to: Access the iway Service Manager Administration Console on Windows To access the iway Service Manager Administration Console, you must first make sure that the iway Service Manager service is running. iway Integration Solution for EDI User's Guide 33

34 Sample Configuration for Inbound Processing: EDI to XML For instructions on starting iway Service Manager, see the iway Service Manager User's Guide. Procedure: How to Access the iway Service Manager Administration Console on Windows 1. From the Windows desktop, select Start, All Programs, iway 5.5 SM, and Console, or, from a browser such as Microsoft Internet Explorer, enter the following URL, where: host Is the host machine on which iway Service Manager is installed. The default value is localhost. port Is the port number on which iway Service Manager is listening. The default value is The following image shows the URL with the default values. 2. When prompted, enter your user name and password, and clickok. Note: The default user name and password is iway. 34 iway Software

35 3. Inbound Processing: EDI to XML The iway Service Manager Administration Console opens, as shown in the following image. Adding an Ebix to the Registry How to: Add an Ebix to the Registry on Windows Add an Ebix to the Registry on UNIX The iway e-business Information Exchange (Ebix) framework supplies several Ebix files for the iway Integration Solution for EDI. An Ebix file for EDI-X12 is named X12_transaction_set.ebx, where transaction_set is the transaction set number. For example, the Ebix file for EDI X-12 transaction set 4050 is named X12_4050.ebx. For details on the supported EDI-X12 transaction sets, see Ebix-Supported Transaction Sets on page 81. This topic describes how to add an Ebix to the Registry on Windows and UNIX. iway Integration Solution for EDI User's Guide 35

36 Sample Configuration for Inbound Processing: EDI to XML Procedure: How to Add an Ebix to the Registry on Windows 1. To access the Registry, select the Registry option in the blue shaded area below the iway Service Manager banner, as shown in the following image. 2. Under Components in the left pane of the Registry, select Ebix. 3. On the Ebix pane on the right, click Add to add a new Ebix. 36 iway Software

37 3. Inbound Processing: EDI to XML The New Ebix pane opens on the right. 4. Browse to the directory in which the Ebix is located and select the name of the file, for example, X12_4050.ebx. The directory path is based on the one in which you installed iway Service Manager. By default, the directory path in which Ebix files are located is installation_drive:\..\iway55sm\etc\manager\packages. On Windows, the default directory is C:\Program Files\iway55sm\etc\manager\packages. 5. Once you have selected the Ebix, click Next. You are prompted for the name of the Ebix and an optional description. 6. Enter a name for the Ebix, for example, EDI_4050, and an optional description, such as EDI 4050 Ebix. Note: This step must be repeated for each Ebix X12 message set that is added to the Registry. 7. Click Finish. On the Ebix pane, you will see that the Ebix was successfully added. Later you will associate it with the channel for inbound processing. iway Integration Solution for EDI User's Guide 37

38 Sample Configuration for Inbound Processing: EDI to XML Procedure: How to Add an Ebix to the Registry on UNIX Depending on your system configuration, there are two methods that you can use to add an Ebix to the Registry on UNIX. If you have a Web browser on the UNIX machine, follow the instructions for Windows. Use FTP to download the Ebix from the iway55sm/etc/manager/packages directory to your Windows machine and follow the instructions for Windows. Defining an Inlet How to: Add a Listener Add a Preparser Define an Inlet An inlet defines how a message enters a channel. It typically contains a: Listener. A listener is a component that picks up input on a channel from a configured end point. Decryptor. A decryptor is a component that applies a decryption algorithm to an incoming message and verifies the security of the message. The configuration example in this topic does not include a decryptor, which is an optional component. One or more preparsers. A preparser is a component that converts incoming messages into processable documents. Typically a preparser converts a document into XML format. Other preparsers may perform data decryption or reformatting. Procedure: How to Add a Listener 1. From the Registry menu options on the left pane, select Listeners under Components. 2. On the Listeners pane on the right, click Add to add a new listener. 3. For the purpose of this example, we will show the configuration with a File listener. For details on supported protocols, see the iway Service Manager Protocol Guide. Select File from the Type drop-down list and click Next. 38 iway Software

39 3. Inbound Processing: EDI to XML The configuration parameters pane opens. 4. Supply configuration parameters for the new File listener as follows. An asterisk indicates that a parameter is required. For parameters not listed in the following table, accept the default value. Parameter Input Path * Value C:\File_in This value is the directory in which input messages are received. Make sure that you have created this directory; otherwise, errors will occur during deployment. iway Integration Solution for EDI User's Guide 39

40 Sample Configuration for Inbound Processing: EDI to XML Parameter Destination * Removal Destination Suffix In Suffix Out Value C:\File_out This value is the directory in which output files are stored after transformation. Make sure that you have created this directory; otherwise, errors will occur during deployment. C:\File_removal This value is the directory to which input messages are moved if they fail during transformation. Make sure that you have created this directory; otherwise, errors will occur during deployment. It is recommended to configure a removal destination when you are constructing a basic channel. * Input files with any file extension are allowed. xml The extension for output files is.xml. 5. Click Next. You are prompted for the name of the listener and an optional description. 40 iway Software

41 3. Inbound Processing: EDI to XML 6. On the Listeners pane, enter the name of the new listener, EDItoXML_Listener, and an optional description. Then click Finish to add the listener. In a later step, you will associate this listener with the inlet. Procedure: How to Add a Preparser 1. From the Registry menu options, select Preparsers under Components. 2. On the Preparsers pane, click Add to add a new preparser. You are prompted for the type of preparser. 3. Select EDIX12SplitterPreParser (com.ibi.preparsers.edisplitpp) from the Type drop-down list. The EDIX12SplitterPreParser parses an EDI input file with one or more ISAs and multiple transaction sets (STs), and creates multiple XML output files. One XML output file is produced for each transaction set. You can also use the EDIX12SplitterPreParser if there is only one transaction set in an ISA. For details on the supported EDI-X12 transaction sets, see Ebix-Supported Transaction Sets on page Click Next. iway Integration Solution for EDI User's Guide 41

42 Sample Configuration for Inbound Processing: EDI to XML The Preparsers configuration parameters pane opens. The following table lists and describes the available configuration parameters for the preparser: Parameter Template Debug Segment Terminator Description Used to locate the template in the Ebix used in the transformation from EDI format to XML format. If enabled, the transformation components are written to files in the local directory. This parameter is set to False by default. The control character that marks the end of a specific variable-length segment. To view a list of segment terminator characters, see Separators and Terminators on page iway Software

43 3. Inbound Processing: EDI to XML Parameter Element Delimiter Description The control character used to separate elements in a segment. It follows the segment identifier and each data element in a segment except the last. To view a list of element delimiter characters, see Separators and Terminators on page 101. Component Element Delimiter The control character used to separate subelements/components in a composite element. To view a list of component element delimiter characters, see Separators and Terminators on page 101. Escape Character The escape character is necessary if any of the EDI document separators is part of the actual value of an attribute. 5. In the Template field, enter X12_%_^toXML.xch. The preparser obtains the message type and version information from the EDI input document. In the parameter, the character "%" represents the message type, and the character "^" represents the version. For example, if the message type of the EDI input document is 810, and the version is , the constructed template name is X12_810_004050toXML.xch. 6. Click Next. You are prompted for a name and optional description for the new preparser. 7. Enter a name for the new preparser, for example, EDItoXML_SplitterPreparser, and an optional description. iway Integration Solution for EDI User's Guide 43

44 Sample Configuration for Inbound Processing: EDI to XML 8. Click Finish to add the preparser. In the next procedure, you will associate this preparser with an inlet. Procedure: How to Define an Inlet Now that you have added a File listener and splitter preparser to the Registry, you are ready to add and define an inlet. You will associate the previously created listener and preparser with the inlet. 1. From the Registry menu options, select Inlets under Conduits. 2. On the Inlet Definitions pane, click Add to add an inlet. 3. On the New Inlet Definition pane, enter the name of the new inlet and an optional description, as shown in the following table. Then click Finish to add the inlet. Parameter Name * Description Value EDItoXML_Inlet Inlet for EDI to XML. 4. On the Construct Inlet pane, click Add to associate the listener and preparser with the inlet. The next pane prompts you for the component type. 5. Select Listener and click Next. 44 iway Software

45 3. Inbound Processing: EDI to XML The next pane prompts you to select a listener. 6. Select EDItoXML_Listener, which is the listener you added earlier, and click Finish. The listener is associated with the inlet. Now you need to associate the preparser created earlier with the inlet. 7. On the Construct Inlet pane, click Add. The next pane prompts you for the component type. 8. Select Preparser and click Next. On the next pane, you are prompted to select a preparser. 9. Select EDItoXML_SplitterPreparser, which is the preparser you added earlier, and click Finish. You have now successfully completed definition of the inlet. iway Integration Solution for EDI User's Guide 45

46 Sample Configuration for Inbound Processing: EDI to XML Defining a Route How to: Add a Copy Service and an Acknowledgement Service Add a Process and Associate the Services With It Add a Route and Associate the Process With It A route defines the path a message takes through a channel. The route for the channel for inbound processing consists of a process. A process is a stateless, lightweight, short-lived microflow executed by iway Service Manager on a message as it passes through the system. A service is an executed procedure that handles the business logic of a message. In this example, the process consists of two services: Copy service. The copy service redirects the output document to the destination. Acknowledgement service. This service returns an acknowledgement to the sender of the input document. It indicates that the document was received and processed with no structural errors. First you will add the services to the Registry, then associate them with a new process, and, finally, associate the process with a new route. Tip: To define a route using iway Designer, see Defining a Route With iway Designer. Procedure: How to Add a Copy Service and an Acknowledgement Service 1. From the Registry menu options, select Services. 2. On the Services pane, click Add to add a service. You are prompted for the type of service you want to add. 3. From the Type drop-down list, select Document copy (com.ibi.agents.xdcopyagent) and click Next. 46 iway Software

47 3. Inbound Processing: EDI to XML 4. On the configuration parameters pane. click Next to accept the default values (Delay of 0, no Comment). You are prompted for the name and an optional description for the new service. 5. Enter the name EDI_Copy and a description, and click Finish. The copy service is added to the Registry. 6. To add the acknowledgement service, on the Services pane, click Add. You are prompted for the type of service. 7. From the Type drop-down list, select EDIX12AckAgent (com.ibi.agents.xdx12ackagent) and click Next. 8. On the configuration parameters pane, click Next to accept the default values. You are prompted for the name and an optional description for the new service. iway Integration Solution for EDI User's Guide 47

48 Sample Configuration for Inbound Processing: EDI to XML 9. Enter the name EDI_Ack and a description, and click Finish. The acknowledgement service is added to the Registry. Procedure: How to Add a Process and Associate the Services With It 1. From the Registry menu options, select Processes under Conduits. 2. On the Process Definitions pane, click Add to add a process. 3. On the New Process Definition pane, enter the name of the new process and an optional description, as shown in the following table. Then click Finish to add the process. Parameter Name * Description Value EDItoXML_Process Process for EDI to XML. 4. On the Construct Process pane, click Add to associate the copy and acknowledgement services with the process. You are prompted to associate services with the new process. 5. Select EDI_Ack and EDI_Copy, which are the services you added earlier, and click Finish. You will see that the services are added to the process. 6. The copy service should be first in order. If necessary, reverse the order of the services using the arrow icon in the Move column. Procedure: How to Add a Route and Associate the Process With It 1. From the Registry menu options, select Routes. 2. On the Route Definitions pane, click Add to add a route. 48 iway Software

49 3. Inbound Processing: EDI to XML 3. On the New Route Definition pane, enter a name for the route and an optional description, as shown in the following table. Then click Finish. Parameter Name * Description Value EDItoXML_Route Route for EDI to XML. 4. On the Construct Route pane, click Add. You are prompted for the type of component to associate with the route. 5. Select Process and click Next. 6. The next pane prompts you to select a process. Select the process you added earlier, EDItoXML_Process, and click Finish. The route, with its associated process, has been successfully defined. Note: This is the simplest possible route to configure. In a real world scenario, most users will have more complex business logic. iway Integration Solution for EDI User's Guide 49

50 Sample Configuration for Inbound Processing: EDI to XML Defining the Outlets How to: Add an Emitter for XML Output Add an Emitter for Acknowledgement Output Define an Outlet for XML Output Define an Outlet for Acknowledgement Output An outlet defines how a message leaves a channel. An emitter is a transport protocol that sends a document to its recipient. In the sample configuration, we will use a File emitter. For details on supported protocols, see the iway Service Manager Protocol Guide. For the channel in this example, you will add two emitters to the Registry. Then you will define two outlets, associating one emitter with each outlet. When you associate the outlets with the channel in later steps, you will apply a condition to each one to dynamically direct the flow of the output document based on its content. In the example, you will add: An emitter for the XML output data. When you add the XML outlet to the channel, you will set the condition _isxml(). This condition tests the output data for XML format. If it is in XML format, it is routed to the specified destination. An emitter for the acknowledgement data. In the example, the data for the functional acknowledgement (transaction 997) is in EDI flat file (non-xml) format. When you add the acknowledgement outlet to the channel, you will set the condition _isflat(). This condition tests the output data for flat file (non-xml) format. If the data is in flat file (non- XML) format, it is routed to the specified destination. Procedure: How to Add an Emitter for XML Output 1. From the Registry menu options, select Emitters. 2. On the Emitters pane, click Add to add an emitter. The next pane prompts you for the emitter type. 3. For this example, select File from the drop-down list and click Next. 50 iway Software

51 3. Inbound Processing: EDI to XML The configuration parameters pane opens. 4. Supply configuration parameters for the new File emitter as follows, then click Next. Parameter Destination * Create Directory Value C:\File_out\EDI\_SREG(basename)_*.xml This value is the directory to which the XML output goes. Make sure that you have created this directory; otherwise, errors will occur during deployment. SREG(basename) is a special register reserved by iway Service Manager, which uses a file name without an extension. For more information on how to configure a special register (SREG), see the iway Service Manager User's Guide. On output, an asterisk (*) in the destination file name is replaced by a date and time stamp. Since you are using the EDIX12SplitterPreParser, include an asterisk in the file name to create each XML output file with a unique name. false 5. On the Emitters pane, enter the name of the new emitter and an optional description, as shown in the following table. Then click Finish to add the emitter. iway Integration Solution for EDI User's Guide 51

52 Sample Configuration for Inbound Processing: EDI to XML Parameter Name * Description Value XML_Out_Emitter Emitter for XML output for EDI. Procedure: How to Add an Emitter for Acknowledgement Output 1. On the Emitters pane, click Add to add another emitter. The next pane prompts you for the emitter type. 2. For this example, select File from the drop-down list and click Next. The configuration parameters pane opens. 3. Supply configuration parameters for the second File emitter as follows, then click Next. Parameter Destination * Value C:\File_out\EDI\_SREG(basename)_*.txt This value is the directory to which the acknowledgement output goes. You can use an extension other than.txt, for example,.edi or.data. Make sure that you have created this directory; otherwise, errors will occur during deployment. On output, an asterisk (*) in the destination file name is replaced by a date and time stamp. For details on the special register (SREG) used in the preceding file name, see the iway Service Manager User's Guide. 52 iway Software

53 3. Inbound Processing: EDI to XML Parameter Create Directory Value false 4. On the Emitters pane, enter the name of the new emitter and an optional description, as shown in the following table. Then click Finish to add the emitter. Parameter Name * Description Value Ack_Out_Emitter Emitter for acknowledgement output for EDI. Procedure: How to Define an Outlet for XML Output Now that you have added an XML and acknowledgement emitter to the Registry, you are ready to add and define the outlets. You will associate the previously created emitters with the outlets (one emitter for each outlet). 1. From the Registry menu options, select Outlets. 2. On the Outlet Definitions pane, click Add to add an outlet. 3. On the New Outlet Definition pane, enter the name of the new outlet and an optional description, as shown in the following table. Then click Finish to add the outlet. Parameter Name * Description Value EDI_XML_Outlet XML outlet for EDI. 4. On the Construct Outlet pane, click Add to associate the XML emitter with the XML outlet. iway Integration Solution for EDI User's Guide 53

54 Sample Configuration for Inbound Processing: EDI to XML The next pane prompts you for the component type. 5. Select Emitter and click Next. The next pane prompts you to select an emitter. 6. Select XML_Out_Emitter, which is the XML emitter you added earlier, and click Finish. The XML emitter is associated with the outlet. Now you need to define the second outlet for the acknowledgement output. Procedure: How to Define an Outlet for Acknowledgement Output 1. From the Registry menu options, select Outlets. 2. On the Outlet Definitions pane, click Add to add an outlet. 3. On the New Outlet Definition pane, enter the name of the new outlet and an optional description, as shown in the following table. Then click Finish to add the outlet. Parameter Name * Description Value EDI_Ack_Outlet Acknowledgement outlet for EDI. 4. On the Construct Outlet pane, click Add to associate the acknowledgement emitter with the acknowledgement outlet. The next pane prompts you for the component type. 5. Select Emitter and click Next. The next pane prompts you to select an emitter. 54 iway Software

55 3. Inbound Processing: EDI to XML 6. Select Ack_Out_Emitter, which is the acknowledgement emitter you added earlier, and click Finish. Now you have defined the two outlets. Defining a Channel How to: Define a Channel Add the Ebix to the Channel Build the Channel Deploy the Channel Verify the Channel Now that you have defined the inlet, route, and outlets for the channel, you are ready to add the channel to the Registry and associate the conduits with it. Procedure: How to Define a Channel 1. From the Registry menu options, select Channels under Conduits. 2. On the Channel Definitions pane, click Add to add a channel. 3. On the New Channel Definition pane, enter the name of the new channel and an optional description, as shown in the following table. Then click Finish to add the channel. Parameter Name * Description Value EDItoXML_Channel Channel for EDI to XML inbound processing. 4. On the Construct Channel pane, click Add to associate the inlet, route, and outlets defined previously with the channel. You are prompted to associate components with the channel. 5. Select Inlet and click Next. The next pane prompts you to select an inlet. 6. Select EDItoXML_Inlet, which is the inlet you defined earlier, and click Finish. iway Integration Solution for EDI User's Guide 55

56 Sample Configuration for Inbound Processing: EDI to XML The inlet is added to the channel. Now you need to associate the route defined earlier with the channel. 7. On the Construct Channel pane, click Add. The next pane prompts you for the component type. 8. Select Route and click Next. On the next pane, you are prompted to select a route. 9. Select EDItoXML_Route, which is the route created earlier, and click Finish. 10. On the Construct Channel pane, click the minus sign (-) under Conditions next to the name of the route to set it as the default. 11. On the Construct Channel pane, click Add to add the outlets. 12. On the next pane, select Outlet and click Next. 13. Select the two outlets defined earlier, EDI_Ack_Outlet and EDI_XML_Outlet, and click Finish. 14. To set a condition for the EDI_XML_Outlet, on the Construct Channel pane, click the plus sign (+) under Conditions for the EDI_XML_Outlet. 56 iway Software

57 3. Inbound Processing: EDI to XML The Set Condition pane opens. 15. In the Condition input field, enter _isxml(), and click Update. This condition tests the output data for XML format. If it is in XML format, it is routed to the destination specified when you added the emitter for XML output. You will see that the Conditions plus sign icon has changed. You can click this icon to edit the condition. For details on supported conditions, see the topic on using functions in the iway Service Manager User's Guide. 16. To set a condition for the EDI_Ack_Outlet, on the Construct Channel pane, click the plus sign (+) under Conditions for the EDI_Ack_Outlet. The Set Condition pane opens. 17. In the Condition input field, enter _isflat(), and click Update. iway Integration Solution for EDI User's Guide 57

58 Sample Configuration for Inbound Processing: EDI to XML This condition tests the output data for EDI flat file (non-xml) format. If the data is in EDI flat file (non-xml) format, it is routed to the destination specified when you added the emitter for acknowledgement output. Procedure: How to Add the Ebix to the Channel 1. From the Registry menu options, select Channels. The Channel Definitions pane opens. 2. Click the link in the Ebix column for the EDItoXML_Channel. 3. On the next pane, which prompts you to add Ebix components, click Add to add the Ebix to the channel. 4. On the next pane, select EDI_4050, which is the name of the Ebix you added previously, and click Finish. Now that you have associated all the components with the channel, you are ready to build it. Procedure: How to Build the Channel 1. From the Registry menu options on the left pane, select Channels under Conduits. 2. On the Channel Definitions pane, select the channel defined previously, EDItoXML_Channel, and click Build. 58 iway Software

59 3. Inbound Processing: EDI to XML The results of the build are displayed on the right pane. 3. Review the results of your build and then click Back. If an error or errors are displayed in the Message column, take the appropriate action as instructed. Procedure: How to Deploy the Channel Deployment is the mechanism by which a channel moves from being stored in the Registry to becoming active in iway Service Manager. For more information on deployment, see the iway Service Manager User's Guide. 1. Select the Deployments option in the blue shaded area below the iway Service Manager banner. 2. On the Channel Management pane, click Deploy. 3. On the Available Channels pane, select the channel you defined previously, EDItoXML_Channel, and click Deploy. The Channel Management pane reopens. 4. Select EDItoXML_Channel and click Start. iway Integration Solution for EDI User's Guide 59

60 Sample Configuration for Inbound Processing: EDI to XML The red X under Status changes to a green check mark to indicate that the channel has been started. If an error or errors are displayed, take the appropriate action as instructed. Procedure: How to Verify the Channel To make sure that the channel is working as expected, perform the following steps: 1. Place an EDI document as test data in the C:\File_in directory. This is the path in which EDI messages are received, which you specified for the listener associated with the inlet for the channel. The following table contains links to EDI files that are attached to this PDF and can be used to verify your channel. EDI 810 Invoice. 810.x12.txt EDI 850 Purchase Order. 850.x12.txt EDI 856 Advanced Ship Notice. 856.x12.txt Note: For file association compatibility only, each EDI file that is attached to this PDF has been renamed to include a.txt extension. However, please note that the actual EDI output file that is placed in the C:\File_in directory will not carry a.txt extension. 2. Check for the XML file and the functional acknowledgement in the C:\File_out\EDI directory. This is the destination path you specified for the emitters associated with the outlets for the channel. The listener will detect the presence of the file in the input directory, and the copy service will copy it to the output directory, replacing the asterisk in the file name with a time stamp. For example, if you specified the destination file name for the XML emitter as _SREG(basename)_*.xml per the configuration example, an EDI input file named X12856C001_4050.x12 is named _X12856C001_4050_ T19_33_26.684Z.xml on output. The following table contains links to sample XML output files that are attached to this PDF and can be used to verify your output. 60 iway Software

61 3. Inbound Processing: EDI to XML X xml X xml X xml The following table contains links to sample functional acknowledgement documents that are attached to this PDF and can be used to verify your output txt txt txt Note: For file association compatibility only, each functional acknowledgement document that is attached to this PDF has been renamed to include a.txt extension. However, please note that the actual functional acknowledgement document that is placed in the C:\File_out\EDI directory will not carry a.txt extension. Reusing Your Channel Configuration Using the Archive Manager feature of iway Service Manager, you can archive your channel configuration with its associated components and import them into another Registry. They will then be available from that Registry for modification or reuse. For details on this feature, see the iway Service Manager User's Guide. iway Integration Solution for EDI User's Guide 61

62 Sample Configuration for Inbound Processing: EDI to XML 62 iway Software

63 iway 4 Outbound Processing: XML to EDI The iway Integration Solution for EDI includes iway Service Manager. iway Service Manager validates an XML document based on EDI s published implementation guides and converts it to a document in Electronic Data Interchange (EDI) format. This chapter provides the information you need to understand and implement a basic outbound message flow. Topics: Outbound Processing Overview Sample Configuration for Outbound Processing: XML to EDI The outbound processing overview describes the iway business components and the processing steps in the basic outbound message flow. The sample configuration contains detailed instructions for configuring the basic outbound message flow. This topic guides you through each step of the configuration procedure. iway Integration Solution for EDI User's Guide 63

64 Outbound Processing Overview Outbound Processing Overview The standard outbound process converts an XML document to an EDI-formatted document. The input document that is sent to the channel may not be in XML format. It can be any input document that first will be processed by the channel and transformed to an EDI document. In a basic message flow, outbound processing consists of the following components and steps. For an illustration of the components available in the construction of a message flow, see Using a Channel to Construct a Message Flow on page 21. You will define the components in the configuration instructions in Sample Configuration for Outbound Processing: XML to EDI on page 65. Inlet The listener picks up the input document. Route A predefined move service passes the XML document to the next step in the process. For the purposes of this example, this is the simplest possible route to configure. In a real world scenario, most users will have more complex business logic. Validation The outbound EDI document is validated for structure and content. The published EDI standards and user implementation guides define element types (for example, numeric, alpha, or date) and describe business rules to apply for validation. Outlet The preemitter obtains the message type and version from the XML-formatted EDI document, in order to select the appropriate transformation template name. It converts the XML-formatted EDI document to EDI format. The preemitter ensures that the document is converted to a structurally correct EDI document. The transformation templates that are provided in the Ebix are used to transform the structure of the document. The EDI document is passed to the next step in the integration process. 64 iway Software

65 4. Outbound Processing: XML to EDI Sample Configuration for Outbound Processing: XML to EDI In this section: Accessing the iway Service Manager Administration Console Adding an Ebix to the Registry Defining an Inlet Defining a Route Defining an Outlet Defining a Channel Reusing Your Channel Configuration This topic provides step-by-step instructions for configuring a basic outbound message flow for the iway Integration Solution for EDI. The message flow represents the movement and tasks in the conversion of a message from XML to EDI. If you plan to modify the message flow presented here and would like more information on the supported iway business components that you can use in channel construction, see the iway Service Manager User's Guide. Accessing the iway Service Manager Administration Console For instructions, see Accessing the iway Service Manager Administration Console on page 33. Adding an Ebix to the Registry How to: Add an Ebix to the Registry on Windows Add an Ebix to the Registry on UNIX The iway e-business Information Exchange (Ebix) framework supplies several Ebix files for the iway Integration Solution for EDI. An Ebix file for EDI-X12 is named X12_transaction_set.ebx, where transaction_set is the transaction set number. For example, the Ebix file for EDI X-12 transaction set 4050 is named X12_4050.ebx. For details on the supported EDI X-12 transaction sets, see Ebix-Supported Transaction Sets on page 81. iway Integration Solution for EDI User's Guide 65

66 Sample Configuration for Outbound Processing: XML to EDI This topic describes how to add an Ebix to the Registry on Windows and UNIX. Tip: If you already added an Ebix to the Registry as described in Adding an Ebix to the Registry on page 35, you do not need to add it again for outbound processing. You can go directly to Defining an Inlet on page 67. Procedure: How to Add an Ebix to the Registry on Windows 1. Access the iway Service Manager Administration Console as described inaccessing the iway Service Manager Administration Console on page To access the Registry, select the Registry option in the blue shaded area below the iway Service Manager banner. 3. Under Components in the left pane, select Ebix. 4. On the Ebix pane on the right, click Add to add a new Ebix. The New Ebix pane opens on the right. 5. Browse to the directory in which the Ebix is located and select the name of the file, in this case, X12_4050.ebx. 66 iway Software

67 4. Outbound Processing: XML to EDI The directory path is based on the one in which you installed iway Service Manager. By default, the directory path in which Ebix files are located is installation_drive:\..\iway55sm\etc\manager\packages. On Windows, the default directory is C:\Program Files\iway55sm\etc\manager\packages. 6. Once you have selected the Ebix, click Next. You are prompted for the name of the Ebix and an optional description. 7. Enter a name for the Ebix, for example, EDI_4050, and an optional description, such as EDI 4050 Ebix. 8. Click Finish. On the Ebix pane, you will see that the Ebix was successfully added. Later you will associate it with the channel for outbound processing. Procedure: How to Add an Ebix to the Registry on UNIX Depending on your system configuration, there are two methods that you can use to add an Ebix to the Registry on UNIX. If you have a Web browser on the UNIX machine, follow the instructions for Windows. Use FTP to download the Ebix from the iway55sm/etc/manager/packages directory to your Windows machine and follow the instructions for Windows. Defining an Inlet How to: Add a Listener Define an Inlet You will add a listener to the Registry, then associate that listener with a new inlet. iway Integration Solution for EDI User's Guide 67

68 Sample Configuration for Outbound Processing: XML to EDI Procedure: How to Add a Listener 1. From the Registry menu options, select Listeners. 2. On the Listeners pane, click Add to add a new listener. 3. For the purpose of this example, we will show the configuration with a File listener. For details on supported protocols, see the iway Service Manager Protocol Guide. Select File from the Type drop-down list and click Next. The configuration parameters pane opens. 4. Supply configuration parameters for the new File listener as follows. An asterisk indicates that a parameter is required. For parameters not listed in the following table, accept the default value. 68 iway Software

69 4. Outbound Processing: XML to EDI Parameter Input Path * Destination * Removal Destination Suffix In Suffix Out Value C:\XML_in This value is the directory in which input messages are received. Make sure that you have created this directory; otherwise, errors will occur during deployment. C:\XML_out This value is the directory in which output files are stored after transformation. Make sure that you have created this directory; otherwise, errors will occur during deployment. C:\XML_removal This value is the directory to which input messages are moved if they fail during transformation. Make sure that you have created this directory; otherwise, errors will occur during deployment. It is recommended to configure a removal destination when you are constructing a basic channel. xml Input files with the extension.xml are allowed. edi In this example, the extension for output files is.edi. 5. Click Next. 6. On the Listeners pane, enter the name of the new listener and an optional description, as shown in the following table. Then click Finish to add the listener. iway Integration Solution for EDI User's Guide 69

70 Sample Configuration for Outbound Processing: XML to EDI Parameter Name * Description Value XMLtoEDI_Listener File listener for XML input. Procedure: How to Define an Inlet 1. From the Registry menu options, select Inlets. 2. On the Inlet Definitions pane, click Add to add an inlet. 3. On the New Inlet Definition pane, enter the name of the new inlet and an optional description, as shown in the following table. Then click Finish to add the inlet. Parameter Name * Description Value XMLtoEDI_Inlet Inlet for XML to EDI. 4. On the Construct Inlet pane, click Add to associate the listener with the inlet. The next pane prompts you for the component type. 5. Select Listener and click Next. The next pane prompts you to select a listener. 6. Select XMLtoEDI_Listener, which is the listener you added earlier for outbound processing, and click Finish. The listener is added to the inlet. Defining a Route For this sample channel configuration, you will use the predefined move route as the default. You add the move route when you define the channel, so no steps are required at this time. Note: This assumes that the incoming XML document already conforms to the iway XML- EDI format. Any XML formatting must be performed by the route. 70 iway Software

71 4. Outbound Processing: XML to EDI Defining an Outlet How to: Add a Preemitter Define an Outlet For the iway Integration Solution for EDI, you will add a preemitter to the Registry, then associate it with a new outlet. A preemitter is a logical process that handles a document immediately before transmission. It is generally used to convert from XML to non-xml format, such as EDI. In the sample configuration, it converts an XML-formatted EDI document to EDI-X12 format. Procedure: How to Add a Preemitter 1. From the Registry menu options, select Preemitters. 2. On the Preemitters pane, click Add to add a preemitter. The next pane prompts you for the preemitter type. 3. Select EDIX12PreEmitter (com.ibi.preemit.xdx12preemitter) from the drop-down list and click Next. iway Integration Solution for EDI User's Guide 71

72 Sample Configuration for Outbound Processing: XML to EDI The Preemitters configuration parameters pane opens. The following table lists and describes the available configuration parameters for the preemitter: Parameter Template Debug Segment Terminator Description Used to locate the template in the Ebix used in the transformation from XML format to EDI format. If enabled, the transformation components are written to files in the local directory. This parameter is set to False by default. The control character that marks the end of a specific variable-length segment. The default value is a tilde character (~). To view a list of segment terminator characters, see Separators and Terminators on page iway Software

73 4. Outbound Processing: XML to EDI Parameter Segment Suffix Description The segment suffix is a character that marks the end of the segment. It is used in combination with a segment terminator character. By default, no segment suffix is specified. You can select one of the following characters from the drop-down list: 0D CR Carriage Return 0A LF Line Feed 0D0A CRLF Carriage Return and Line Feed You can also enter a predefined SREG, whose value is resolved at runtime or a function to retrieve the value from a trading partner profile. Element Delimiter The control character used to separate elements in a segment. It follows the segment identifier and each data element in a segment except the last. The default value is an asterisk character (*). To view a list of element delimiter characters, see Separators and Terminators on page 101. Component Element Delimiter The control character used to separate subelements/components in a composite element. The default value is a colon character (:). To view a list of component element delimiter characters, see Separators and Terminators on page 101. Escape Character The escape character is necessary if any of the EDI document separators is part of the actual value of an attribute. The default value is a backslash character (\). 4. In the Template field, enter XMLtoX12_%_^.xch. The preemitter reads the message type and version information from the XML-formatted EDI input document. In the parameter, the character "%" represents the message type, and the character "^" represents the version. iway Integration Solution for EDI User's Guide 73

74 Sample Configuration for Outbound Processing: XML to EDI For example, if the message type of the input document is 810, and the version is , the constructed template name is XMLtoX12_810_ xch. 5. Click Next. 6. On the Preemitters pane, enter the name of the new preemitter and an optional description, as shown in the following table: Parameter Name * Description Value XMLtoEDI_Preemitter Preemitter for XML to EDI. 7. Click Finish to add the preemitter. Procedure: How to Define an Outlet Now that you have added a preemitter to the Registry, you are ready to add and define the outlet. You will associate the previously created preemitter with the outlet. 1. From the Registry menu options, select Outlets. 2. On the Outlet Definitions pane, click Add to add an outlet. 3. On the New Outlet Definition pane, enter the name of the new outlet and an optional description, as shown in the following table. Then click Finish to add the outlet. Parameter Name * Description Value XML_EDI_Outlet XML to EDI outlet. 4. On the Construct Outlet pane, click Add to associate the preemitter with the outlet. 74 iway Software

75 4. Outbound Processing: XML to EDI The next pane prompts you for the component type. 5. Select Preemitter and click Next. The next pane prompts you to select a preemitter. 6. Select XMLtoEDI_Preemitter, which is the preemitter you added earlier, and click Finish. Defining a Channel How to: Define a Channel Add the Ebix to the Channel Build the Channel Deploy the Channel Verify the Channel Now that you have defined the inlet and outlet for the outbound channel, you are ready to add the channel to the Registry and associate the conduits with it. At this time you will also add the route to the channel. Procedure: How to Define a Channel 1. From the Registry menu options, select Channels. 2. On the Channel Definitions pane, click Add to add a channel. 3. On the New Channel Definition pane, enter the name of the new channel and an optional description, as shown in the following table. Then click Finish to add the channel. iway Integration Solution for EDI User's Guide 75

76 Sample Configuration for Outbound Processing: XML to EDI Parameter Name * Description Value XMLtoEDI_Channel Channel for XML to EDI outbound processing. 4. On the Construct Channel pane, click Add to associate the inlet, route, and outlet with the channel. You are prompted to associate components with the channel. 5. Select Inlet and click Next. The next pane prompts you to select an inlet. 6. Select XMLtoEDI_Inlet, which you defined earlier, and click Finish. The inlet is associated with the channel. Now you need to associate a predefined route with the channel and set it to the default. 7. On the Construct Channel pane, click Add. The next pane prompts you for the component type. 8. Select Route and click Next. On the next pane, you are prompted to select a route. 9. Select the predefined move route and click Finish. 76 iway Software

77 4. Outbound Processing: XML to EDI The Construct Channel pane reopens. 10. Click the minus sign (-) under Conditions next to move to set this route as the default. 11. On the Construct Channel pane, click Add to add the next component. 12. When prompted for the component type, select Outlet and click Next. 13. Select the outlet defined earlier, XML_EDI_Outlet, and click Finish. Procedure: How to Add the Ebix to the Channel 1. From the Registry menu options, select Channels. The Channel Definitions pane opens. 2. Click the link in the Ebix column for the XMLtoEDI_Channel. 3. On the next pane, which prompts you to add Ebix components, click Add to add the Ebix to the channel. 4. On the next pane, select EDI_4050, which is the name of the Ebix you added previously, and click Finish. Procedure: How to Build the Channel 1. From the Registry menu options, select Channels. iway Integration Solution for EDI User's Guide 77

78 Sample Configuration for Outbound Processing: XML to EDI 2. On the Channel Definitions pane, select the channel for outbound processing defined previously, XMLtoEDI_Channel, and click Build. The results of the build are displayed on the right pane. 3. Review the results of your build and then click Back. If an error or errors are displayed in the Message column, take the appropriate action as instructed. Procedure: How to Deploy the Channel Deployment is the mechanism by which a channel moves from being stored in the Registry to becoming active in iway Service Manager. For more information on deployment, see the iway Service Manager User's Guide. 1. Select the Deployments option. 2. On the Channel Management pane, click Deploy. 3. On the Available Channels pane, select the channel you defined previously, XMLtoEDI_Channel, and click Deploy. The Channel Management pane reopens. 4. Select XMLtoEDI_Channel and click Start. The red X under Status changes to a green check mark to indicate that the channel has been started. If an error or errors are displayed, take the appropriate action as instructed. Procedure: How to Verify the Channel To make sure that the channel is working as expected, perform the following steps: 1. Place an XML file as test data into C:\XML_in. This is the path in which XML messages are received, which you specified for the listener associated with the inlet for the channel. The following table contains links to sample XML input files that are attached to this PDF and can be used for testing purposes. X xml X xml X xml 78 iway Software

79 4. Outbound Processing: XML to EDI 2. Check for the EDI output file in the directory C:\XML_out. This is the destination directory you specified for the listener. The following table contains links to the EDI output files that are attached to this PDF and can be used to verify your output. EDI 810 Invoice. 810.x12.txt EDI 850 Purchase Order. 850.x12.txt EDI 856 Advanced Ship Notice. 856.x12.txt Note: For file association compatibility only, each EDI output file that is attached to this PDF has been renamed to include a.txt extension. However, please note that the actual EDI output file that is placed in the C:\XML_out directory will not carry a.txt extension. 3. Confirm that the output has been converted to EDI format. Reusing Your Channel Configuration Using the Archive Manager feature of iway Service Manager, you can archive your channel configuration with its associated components and import them into another Registry. They will then be available from that Registry for modification or reuse. For details on this feature, see the iway Service Manager User's Guide. iway Integration Solution for EDI User's Guide 79

80 Sample Configuration for Outbound Processing: XML to EDI 80 iway Software

81 iway A Ebix-Supported Transaction Sets This topic describes the EDI ANSI X12 transaction sets supported by the iway Integration Solution for EDI in the Ebix files supplied with the product. Topics: Transaction Set and Acknowledgement Support iway Integration Solution for EDI User's Guide 81

82 Transaction Set and Acknowledgement Support Transaction Set and Acknowledgement Support The iway Integration Solution for EDI supports the EDI ANSI X12 transaction sets shown in the following tables. The integration solution also supports 997 functional acknowledgements, as shown in the tables. Transaction Number Description 2001 Transaction Set Invoice Operating Expense Statement Payment Order/Remittance Advice Account Analysis Lockbox Planning Schedule with Release Capability Purchase Order Receiving Advice Functional Acknowledgement Transaction Number Description 2002 Transaction Set Advanced Ship Notice Functional Acknowledgement Transaction Number Description 2003 Transaction Set 82 iway Software

83 A. Ebix-Supported Transaction Sets Transaction Number Description Invoice Payment Order/Remittance Advice Planning Schedule with Release Capability Purchase Order Advanced Ship Notice Purchase Order Change Request Functional Acknowledgement Transaction Number Description 2040 Transaction Set Invoice Payment Order/Remittance Advice Planning Schedule with Release Capability Inventory Inquiry Purchase Order Purchase Order Acknowledgement Advanced Ship Notice Purchase Order Change Request Receiving Advice Shipping Schedule Text Message Purchase Order Change Acknowledgement Product Transfer and Resale Report iway Integration Solution for EDI User's Guide 83

84 Transaction Set and Acknowledgement Support Transaction Number 997 Description Functional Acknowledgement Transaction Number Description 3010 Transaction Set Invoice Payment Order/Remittance Advice Application Advice Price/Sales Catalog Purchase Order Purchase Order Acknowledgement Advanced Ship Notice Functional Acknowledgement Transaction Number Description 3010VICS (Voluntary Inter-industry Commerce Standard) Transaction Set Purchase Order Product Activity Data Functional Acknowledgement 84 iway Software

85 A. Ebix-Supported Transaction Sets Transaction Number Description 3020 Transaction Set Motor Carrier Load Tender Motor Carrier Freight Details and Invoice Invoice Payment Order/Remittance Advice Application Advice Planning Schedule with Release Capability Price/Sales Catalog Inventory Inquiry Purchase Order Product Activity Data Purchase Order Acknowledgement Advanced Ship Notice Shipment and Billing Notice Purchase Order Change Request Receiving Advice Text Message Functional Acknowledgement Transaction Number Description 3021 Transaction Set Routing and Carrier Instruction Functional Acknowledgement iway Integration Solution for EDI User's Guide 85

86 Transaction Set and Acknowledgement Support Transaction Number Description 3030 Transaction Set Invoice Payment Order/Remittance Advice Purchase Order Purchase Order Acknowledgement Advanced Ship Notice Shipment and Billing Notice Purchase Order Change Acknowledgement Product Transfer and Resale Report Functional Acknowledgement Transaction Number Description 3040 Transaction Set Invoice Payment Order/Remittance Advice Application Advice Purchase Order Purchase Order Acknowledgement Advanced Ship Notice Shipment and Billing Notice Receiving Advice Shipping Schedule Purchase Order Change Acknowledgement 86 iway Software

87 A. Ebix-Supported Transaction Sets Transaction Number Description Product Transfer and Resale Report Functional Acknowledgement Transaction Number Description 3050 Transaction Set Invoice Payment Order/Remittance Advice Application Advice Planning Schedule with Release Capability Price/Sales Catalog Purchase Order Purchase Order Acknowledgement Advanced Ship Notice Shipment and Billing Notice Purchase Order Change Acknowledgement Product Transfer and Resale Report Functional Acknowledgement Transaction Number Description 3060 Transaction Set Return Merchandise Authorization Invoice Payment Order/Remittance Advice iway Integration Solution for EDI User's Guide 87

88 Transaction Set and Acknowledgement Support Transaction Number Description Price/Sales Catalog Purchase Order Product Activity Data Purchase Order Acknowledgement Advanced Ship Notice Shipment and Billing Notice Purchase Order Change Request Purchase Order Change Acknowledgement Functional Acknowledgement Transaction Number Description 3070 Transaction Set Return Merchandise Authorization Payment Order/Remittance Advice Purchase Order Product Activity Data Purchase Order Acknowledgement Advanced Ship Notice Shipment and Billing Notice Purchase Order Change Request Purchase Order Change Acknowledgement Functional Acknowledgement 88 iway Software

89 A. Ebix-Supported Transaction Sets Transaction Number Description 4010 Transaction Set Air Freight Details and Invoice Return Merchandise Authorization Mortgage Credit Report Motor Carrier Load Tender Motor Carrier Freight Details and Invoice Motor Carrier Shipment Status Inquiry Transport Carrier Ship Status Booking Cancellation (Ocean) Shipping Instructions U.S. Customs Manifest Invoice Consolidated Service Invoice/Statement Organizational Relationships Payment Order/Remittance Advice Financial Information Reporting Application Advice Planning Schedule with Release Capability Application Control Totals Price/Sales Catalog Inventory Inquiry Purchase Order iway Integration Solution for EDI User's Guide 89

90 Transaction Set and Acknowledgement Support Transaction Number Description Product Activity Data Purchase Order Acknowledgement Advanced Ship Notice Shipment and Billing Notice Purchase Order Change Request Receiving Advice Shipping Schedule Text Message Purchase Order Change Acknowledgement Product Transfer and Resale Report Order Status Report Grocery Products Purchase Order Price Information Grocery Products Invoice Item Maintenance Promotion Announcement Delivery/Return Base Record Warehouse Shipping Order Warehouse Stock Transfer Shipment Advice Warehouse Stock Transfer Receipt Advice Warehouse Shipping Advice iway Software

91 A. Ebix-Supported Transaction Sets Transaction Number Description Response to a Load Tender File Transfer Functional Acknowledgement Set Cancellation Transaction Number Description 4010UCS (Uniform Communication Standard) Transaction Set 810 Invoice Purchase Order Product Activity Data Advanced Ship Notice Text Message Grocery Products Purchase Order Price Information Grocery Products Invoice Item Maintenance Promotion Announcement Delivery/Return Base Record Delivery/Return Acknowledgement or Adjustment Functional Acknowledgement iway Integration Solution for EDI User's Guide 91

92 Transaction Set and Acknowledgement Support Transaction Number Description 4010VICS (Voluntary Inter-industry Commerce Standard) Transaction Set Purchase Order Functional Acknowledgement Transaction Number Description 4020 Transaction Set Invoice Payment Order/Remittance Advice Purchase Order Price Information Item Maintenance Functional Acknowledgement 92 iway Software

93 A. Ebix-Supported Transaction Sets Transaction Number Description 4030 Transaction Set Product Service Claim Response Product Service Claim Motor Carrier Load Tender Motor Carrier Freight Details and Invoice Transport Carrier Ship Status Motor Carrier Pick-up Manifest Motor Carrier Package Status Eligibility, Coverage, or Benefit Inquiry Eligibility, Coverage, or Benefit Information Health Care Claim Status Request Health Care Claim Status Notification Health Care Services Review Information Shipping Instructions Invoice Credit/Debit Adjustment Payment Order/Remittance Advice Lockbox Application Advice Planning Schedule with Release Capability Price/Sales Catalog iway Integration Solution for EDI User's Guide 93

94 Transaction Set and Acknowledgement Support Transaction Number Description Benefit Enrollment and Maintenance Health Care Claim Payment/Advice Health Care Claim Request for Quotation Response to Request for Quotation Product Transfer Account Adjustment Price Authorization Acknowledgement Response to Product Transfer Account Adjustment Purchase Order Product Activity Data Purchase Order Acknowledgement Advanced Ship Notice Shipment and Billing Notice Purchase Order Change Request Receiving Advice Shipping Schedule Text Message Purchase Order Change Acknowledgement Warehouse Shipping Order Warehouse Shipping Advice Functional Acknowledgement 94 iway Software

95 A. Ebix-Supported Transaction Sets Transaction Number Description 4030UCS (Uniform Communication Standard) Transaction Set Grocery Products Invoice Delivery/Return Base Record Functional Acknowledgement Transaction Number Description 4040 Transaction Set Product Service Claim Response Product Service Claim Motor Carrier Load Tender Motor Carrier Freight Details and Invoice Transport Carrier Ship Status Motor Carrier Pick-up Manifest Eligibility, Coverage, or Benefit Inquiry Eligibility, Coverage, or Benefit Information Health Care Claim Status Request Health Care Claim Status Notification Health Care Services Review Information Shipping Instructions Vessel Schedule and Itinerary (Ocean) Invoice iway Integration Solution for EDI User's Guide 95

96 Transaction Set and Acknowledgement Support Transaction Number Description Payment Order/Remittance Advice Lockbox Planning Schedule with Release Capability Price/Sales Catalog Benefit Enrollment and Maintenance Health Care Claim Payment/Advice Health Care Claim Request for Quotation Response to Request for Quotation Product Transfer Account Adjustment Price Authorization Acknowledgement Response to Product Transfer Account Adjustment Purchase Order Product Activity Data Purchase Order Acknowledgement Advanced Ship Notice Shipment and Billing Notice Purchase Order Change Request Receiving Advice Shipping Schedule Text Message Purchase Order Change Acknowledgement 96 iway Software

97 A. Ebix-Supported Transaction Sets Transaction Number Description Grocery Products Invoice Warehouse Shipping Order Warehouse Shipping Advice Functional Acknowledgement Transaction Number Description 4050 Transaction Set Invoice Purchase Order Advanced Ship Notice Functional Acknowledgement Transaction Number Description 5010 Transaction Set Air Freight Details and Invoice Return Merchandise Authorization Motor Carrier Load Tender Motor Carrier Freight Details and Invoice Transport Carrier Ship Status Motor Carrier Package Status Invoice Credit/Debit Adjustment Organizational Relationships iway Integration Solution for EDI User's Guide 97

98 Transaction Set and Acknowledgement Support Transaction Number Description Payment Order/Remittance Advice Application Advice Price/Sales Catalog Inventory Inquiry Purchase Order Product Activity Data Purchase Order Acknowledgement Advanced Ship Notice Shipment and Billing Notice Purchase Order Change Request Receiving Advice Text Message Purchase Order Change Acknowledgement Order Status Report Functional Acknowledgement Transaction Number Description 5010UCS (Uniform Communication Standard) Transaction Set Grocery Products Invoice Delivery/Return Base Record Functional Acknowledgement 98 iway Software

99 A. Ebix-Supported Transaction Sets Transaction Number Description 5020 Transaction Set 997 Functional Acknowledgement Transaction Number Description 5030 Transaction Set Eligibility, Coverage, or Benefit Inquiry Invoice Payment Order/Remittance Advice Application Advice Benefit Enrollment and Maintenance Health Care Claim Payment/Advice Health Care Claim Purchase Order Advanced Ship Notice Shipment and Billing Notice Functional Acknowledgement iway Integration Solution for EDI User's Guide 99

100 Transaction Set and Acknowledgement Support 100 iway Software

101 iway B Separators and Terminators All EDI documents are embedded with tokens that are separated by special characters called separators and terminators. These separators and terminators are used to identify: Topics: Separators and Terminators element separators sub-element separators segment terminators This appendix provides a list of the separators and terminators that are allowed during the configuration of preparsers and preemitters in iway Service Manager. iway Integration Solution for EDI User's Guide 101

102 Separators and Terminators Char Hex Char Hex Char Hex / 2F SYN 16 SOH 01 : 3A ETB 17 STX 02 ; 3B CAN 18 ETX 03 < 3C EM 19 EOT 04 = 3D SUB 1A ENQ 05 > 3E ESC 1B ACK 06? 3F FS 1C BEL 40 GS 1D BS 08 [ 5B RS 1E TAB 09 \ 5C US 1F LF 0A ] 5D! 21 VT 0B ^ 5E # 23 FF 0C _ 5F $ 24 CR 0D 60 % 25 SO 0E { 7B & 26 SI OF 7C 27 DLE 10 } 7D ( 28 DC1 11 ~ 7E ) 29 DC2 12 DEL 7F * 2A DC B DC4 14-2D NAK iway Software Separators and Terminators

103 iway C Special Register (SREG) Types This section describes the Special Register (SREG) types that are created during EDI to XML transactions and 997 creation. Topics: Special Register (SREG) Types iway Integration Solution for EDI User's Guide 103

104 Special Register (SREG) Types Special Register (SREG) Types During EDI to XML transactions and 997 creation, the following types of Special Registers (SREGs) are created: SYS (System) - These SREGs exist until you restart iway Service Manager. USR/DOC - These SREGs exist throughout the life of the document. CFG - These SREGs are configuration related. SEGMENT COUNT 1. <variable name="segcount" type="usr">20</variable> 2. <variable name="basename" type="doc">stephan_850_bad</variable> 3. <variable name="console-master-port" type="sys">9999</variable> CORRELATION ID 4. <variable name="correlid" type="usr"> </variable> 5. <variable name="doclocation" type="sys">config</variable> END OF STREAM FLAG 6. <variable name="eos" type="usr">1</variable> 7. <variable name="extension" type="doc">x12</variable> 8. <variable name="filename" type="doc">stephan_850_bad.x12</variable> FROM PARTY 9. <variable name="fromparty" type="usr">notp </variable> GROUP CONTROL NUMBER - GE 10. <variable name="ge_groupctlnumber" type="usr">1000</variable> NUMBER OF TRANSACTIONS - GE 11. <variable name="ge_numtransactions" type="usr">1</variable> 12. <variable name="ibse-port" type="cfg">9000</variable> INTERCHANGE CONTROL NUMBER - IEA 13. <variable name="iea_interchangectlnum" type="usr"> </variable> VALIDATION REPORT/ACK 104 iway Software

105 C. Special Register (SREG) Types 14. <variable name="iwaf.validationreport" type="usr">isa*00* *00* *12*NOTP *12*NOTP *QAQAQA*QAQA*U*00401* *0*P*> GS*FA*NOTP*NOTP*QAQAQAQA*QAQA*1000*X* ST*997*0001 AK1*PO*1000 AK2*850* AK3*DTM*6**8 AK4*2**8* AK5*R*5 AK9*E*1*1*1 SE*8*0001 GE*1*1000 IEA*1* </variable> 15. <variable name="iway.eos" type="doc">true</variable> 16. <variable name="iwayconfig" type="sys">base</variable> 17. <variable name="iwayhome" type="sys">c:/program Files/iway55sm/</variable> 18. <variable name="iwayversion" type="sys"> sm</variable> 19. <variable name="iwayworkdir" type="sys">c:/program Files/iway55sm/config/base</variable> 20. <variable name="locale" type="sys">en_us</variable> 21. <variable name="name" type="sys">edi_xml</variable> NUMBER OF FUNCTIONAL GROUPS 22. <variable name="numfunctionalgroups" type="usr">1</variable> 23. <variable name="parent" type="doc">c:\testing\edix12\input</variable> 24. <variable name="protocol" type="sys">file</variable> 25. <variable name="source" type="doc">c:\testing\edix12\input\stephan_850_bad.x12</variable> SPLIT COUNT 26. <variable name="splitcount" type="usr">1</variable> 27. <variable name="tid" type="doc">edi_xml-file-w.edi_xml.1_ z</variable> TRANSACTION ID 28. <variable name= edi.transactionid type= USR >850</variable> VERSION 29. <variable name= edi.version type= USR >004010</variable> iway Integration Solution for EDI User's Guide 105

106 Special Register (SREG) Types 106 iway Software

107 iway D Sample EDI Files This appendix includes a sample Electronic Data Interchange (EDI) Purchase Order, Invoice, and Advanced Ship Notice. These are the key EDI documents in wholesale distribution. Topics: Sample EDI Purchase Order Sample EDI Invoice Sample EDI Advanced Ship Notice iway Integration Solution for EDI User's Guide 107

108 Sample EDI Purchase Order Sample EDI Purchase Order The following is a sample EDI Purchase Order. ISA*00* *00* *12*NOTP *12*NOTP *080501*1700*U*00401* *0*P*> GS*PO*NOTP*NOTP* *1700*1000*X* ST*850* BEG*00*SA* ** * REF*DP*030 REF*PS* ITD*14*3*2**45**46 DTM*001* PKG*F*68***PALLET, SHRINKWRAP 48W X 40D X 45H PKG*F*66***REGULAR TD5*A*92*P3**SEE ROUTING GUIDE FOR ROUTING N1*ST*RETAIL STORE*9* N3*123 ANYWHERE AVENUE N4*CITY*ST*12345 PO1*1*120*EA*9.25*TE*CB*(12) *PR*RO*VN*ABA18783 PO1*2*220*EA*13.7 9*TE*CB*(69) *PR*RO*VN*RUP83112 PO1*3*126*EA*10.9 9*TE*CB*(71) *PR*RO*VN*CPR19293 PO1*4*76*EA*4.35*TE*CB*(71) *PR*RO*VN*PIW28173 PO1*5*72*EA*7.5*TE*CB*(71) *PR*RO*VN*JBM PO1*6*696*EA*9.55*TE*CB*(71) *PR*RO*VN*IUI19283 CTT*6 SE*20* GE*1*1000 IEA*1* iway Software

109 D. Sample EDI Files Sample EDI Invoice The following is a sample EDI Invoice. ISA*00* *01* *ZZ*NOTP *ZZ*NOTP *050108*0954*U*00501* *0*P*> GS*IN*NOTP*NOTP* *0954*1*X* ST*810*0001 BIG* *184* *BMB REF*IA* N1*BT*WALGREEN*92*0000 ITD*02**1.000**30**31*****1% 30 NET 31 FOB*CC PID*S**VI*FL IT1*0001*267*CA*53.52**IN* PID*F*08*VI**BARBIE SING W/ME DISC GRL CD PLYR TDS* * CAD*T***CFWY*CONSOLIDATED FREIGHTWAYS SAC*A*D240***7145**********FREIGHT CHARGE ISS*267*CA CTT*1 SE*15*0001 GE*1*1 IEA*1* iway Integration Solution for EDI User's Guide 109

110 Sample EDI Advanced Ship Notice Sample EDI Advanced Ship Notice The following is a sample EDI Advanced Ship Notice. ISA*00* *00* *ZZ*NOTP *ZZ*NOTP *080105*1026*U*00501* *0*P*: GS*NOTP*NOTP* *1026*1*X* ST*856*0001 BSN*00*PC123456* *1026*0004 DTM*067* HL*1**S TD1******A3*5.750*EA*1*1N TD5**S*DHL REF*BM*PC N1*SF*ACME PHARMA CO N1*ST*DISTRIBUTION CENTER*92*0001 HL*2*1*O PRF*PWS6*** HL*3*2*P MAN*GM* HL*4*3*I LIN*10*UP* *LT* Safety Pins*CH*CN CTT*4 SE*17*0001 GE*1*1 IEA*1* iway Software

111 iway E Defining a Route With iway Designer iway Designer is a Windows-based design-time tool. You can use it to create and publish a process flow that is bound to a channel as a route. Through the process flow, you control the sequence in which tasks are performed and the destination of the output from each task. Topics: Defining a Route With iway Designer iway Integration Solution for EDI User's Guide 111

112 Defining a Route With iway Designer Defining a Route With iway Designer How to: Create an iway Designer Project and Start the Process Flow Add a Copy Service Object Add an End Object for the Copy Service Object Add an Acknowledgement Service Object Add an End Object for the Acknowledgement Service Object Define a Route and Associate the Process Flow With It This topic describes how to create a process flow with iway Designer and bind it to the sample channel as a route. These instructions replace Defining a Route on page 46. For details on the full features of iway Designer, and additional information on using its capabilities, see the iway Designer User's Guide. You will complete the following high-level steps to define the route. 1. Using iway Designer, create a new project and start a new process flow. 2. Add a copy service object to the process flow. 3. Add an acknowledgement service object to the process flow. 4. Validate the process flow and publish it to the Registry of the iway Service Manager Administration Console. See the iway Designer User's Guide for instructions on validating and publishing. 5. Add a route to the Registry and associate the process flow with that route. Procedure: How to Create an iway Designer Project and Start the Process Flow 1. From the Windows Start menu select Programs, iway 5.5 SM, tools, and then iway Designer. 2. Connect to the repository from which you want to work, for example, iway. 3. Right-click the repository node and select New Project from the drop-down list. The Designer Project Information dialog box opens, prompting you for a project name and optional description. 4. In the Name field, type EDI_PF_Configuration as the project name. In the Description field, type Defining a route for EDI inbound processing using iway Designer to describe the project. 112 iway Software

113 E. Defining a Route With iway Designer 5. Click Next. The Designer Project Bindings dialog box opens. 6. To create the project in the iway Registry, select iway Registry and click Finish. The choice of project association depends on where you intend to publish (deploy) your process flow. If you are developing a process flow for use as part of a channel, you must publish it to the Registry for subsequent deployment. 7. The EDI_PF_Configuration project node appears under the repository in which it was created (in this example, it appears under iway). 8. To save the project to the repository, right-click the project node and select Save from the drop-down list. 9. Expand the EDI_PF_Configuration project node to expose the project elements (Processes, Services, Transforms, and so on). 10. Right-click the Processes folder and select New Process from the drop-down list. The iway Process Configuration dialog box opens. 11. In the Name field, type EDI_Process_Flow as the process flow name. In the Description field, type Process flow for EDI route for channel for inbound processing. iway Integration Solution for EDI User's Guide 113

114 Defining a Route With iway Designer 12. Click Finish. The new EDI_Process_Flow node appears under the Processes folder, and the workspace displays a Start object. You are ready to build the EDI_Process_Flow by adding objects to it and specifying their relationships. Procedure: How to Add a Copy Service Object The copy service redirects an output document to a destination. 1. Drag and drop the Service object from the toolbar to the workspace. The Service Name and Description dialog box opens. 2. In the Name field, type EDI_PFlow_Copy, and leave the default value (Service object) in the Description field. 3. Click Next. The Service Type dialog box opens. 114 iway Software

115 E. Defining a Route With iway Designer 4. Select Class Name and enter com.ibi.agents.xdcopyagent. 5. Click Next. The Define Service dialog box opens. Do not select the check box, since you do not want to use this service in other process flows. 6. Click Next. The Properties dialog box opens. 7. Click Finish to accept the default values and close the dialog box. The new EDI_PFlow_Copy Service object appears in the workspace. Now you need to connect the Start object to the Copy Service object. 8. Select the Start object, right-click the EDI_PFlow_Copy Service object, and select Relation from the drop-down list. The Line Configuration dialog box opens. 9. From the Event drop-down list, select OnCompletion and click OK. This option indicates that there are no conditions that affect the path, and that the path between the two objects will always be followed. A line appears between the objects to indicate that a relationship has been established. iway Integration Solution for EDI User's Guide 115

116 Defining a Route With iway Designer Procedure: How to Add an End Object for the Copy Service Object All processing paths must terminate with an End object. 1. Drag and drop the End object from the toolbar to the workspace. The End Name and Description dialog box opens. 2. In the Name field, type CopyEnd, and leave the default value (End object) in the Description field. 3. Click Next. The End Name Schema dialog box opens. 4. Since no schemas are used in this processing path (that is, the process flow will not be exposed as a Web service), from the Schema drop-down list, select None. 5. Click Next. The Properties dialog box opens. 6. Click Finish to accept the default values and close the dialog box. The new CopyEnd object appears in the workspace. 7. Select the EDI_PFlow_Copy Service object, right-click the CopyEnd object, and select Relation from the drop-down list. The Line Configuration dialog box opens. 8. From the Event drop-down list, select OnCompletion and click OK. This option indicates that there are no conditions that affect the path and that the path between the two objects will always be followed. Your process flow will look similar to the following. The EDI_PFlow_Copy Service object is a unit of work that redirects the XML output to a defined destination through a custom emit. The CopyEnd object terminates this single process. You can reposition the objects as desired. 116 iway Software

117 E. Defining a Route With iway Designer Procedure: How to Add an Acknowledgement Service Object You will add an acknowledgement service to return a functional acknowledgement (997) to the originator of the input document. The acknowledgement indicates that the input document was received and validated for structure. The acknowledgement does not indicate that business processing was performed on the document. 1. Drag and drop the Service object from the toolbar to the workspace. The Service Name and Description dialog box opens. 2. In the Name field, type EDI_PFlow_Ack, and leave the default value (Service object) in the Description field. 3. Click Next. The Service Type dialog box opens. 4. Select Class Name and enter com.ibi.agents.xdx12ackagent. 5. Click Next. The Define Service dialog box opens. Do not select the check box, since you do not want to use this service in other process flows. 6. Click Next. The Properties dialog box opens. 7. Click Finish to accept the default values and close the dialog box. iway Integration Solution for EDI User's Guide 117

118 Defining a Route With iway Designer The new EDI_PFlow_Ack Service object appears in the workspace. The process flow will look similar to the following. 8. Select the Start object, right-click the EDI_PFlow_Ack Service object, and select Relation from the drop-down list. The Line Configuration dialog box opens. 9. From the Event drop-down list, select OnCompletion and click OK. A line appears between the objects to indicate that a relationship has been established. Procedure: How to Add an End Object for the Acknowledgement Service Object All processing paths must terminate with an End object. 1. Drag and drop the End object from the toolbar to the workspace. The End Name and Description dialog box opens. 2. In the Name field, type AckEnd, and leave the default value (End object) in the Description field. 3. Click Next. The End Name Schema dialog box opens. 4. Since no schemas are used in this processing path, from the Schema drop-down list, select None. 5. Click Next. The Properties dialog box opens. 6. Since you do not need to define any properties for this End object, click Finish to accept the default values and close the dialog box. 118 iway Software

119 E. Defining a Route With iway Designer The new AckEnd object appears in the workspace. 7. Select the EDI_PFlow_Ack Service object, right-click the AckEnd object, and select Relation from the drop-down list. 8. From the Event drop-down list on the Line Configuration dialog box, select OnCompletion and click OK. The process flow is now complete. It will look similar to this. 9. To save the process flow, right-click the EDI_Process_Flow node and select Save from the drop-down list. 10. Now you need to validate the process flow and publish it to the Registry of the iway Service Manager Administration Console for use in the route in the channel for inbound processing. Validating a process flow ensures that its structure is correct. Publishing a process flow makes it available in the Registry for use in channel configuration. For instructions on validating and publishing the process flow, see the iway Designer User's Guide. 11. Close iway Designer. Your next step is to add a new route to the Registry of the iway Service Manager Administration Console and associate the process flow with it. Procedure: How to Define a Route and Associate the Process Flow With It 1. From the Registry menu options in the iway Service Manager Administration Console, click Routes. 2. On the Route Definitions pane, click Add to add a route. iway Integration Solution for EDI User's Guide 119

120 Defining a Route With iway Designer 3. On the New Route Definition pane, enter a name for the route and an optional description, as shown in the following table. Then click Finish. Parameter Name * Description Value EDItoXML_Route_PFlow Route for EDI to XML using process flow. 4. On the Construct Route pane, click Add. You are prompted for the type of component to associate with the route. 5. Select Process and click Next. 6. The next pane prompts you to select a process. Select the process flow you created earlier with iway Designer, EDI_Process_Flow, and click Finish. The route, with its associated process flow, has been successfully defined. 120 iway Software

121 iway Reader Comments In an ongoing effort to produce effective documentation, the Documentation Services staff at Information Builders welcomes any opinion you can offer regarding this manual. Please use this form to relay suggestions for improving this publication or to alert us to corrections. Identify specific pages where applicable. You can contact us through the following methods: Mail: Fax: Web form: Name: Company: Address: Telephone: Comments: Documentation Services - Customer Support Information Builders, Inc. Two Penn Plaza New York, NY (212) [email protected] Date: Information Builders, Two Penn Plaza, New York, NY (212) iway Integration Solution for EDI User's Guide DN Version 5 Release 5 Service Manager (SM)

122 Reader Comments Information Builders, Two Penn Plaza, New York, NY (212) iway Integration Solution for EDI User's Guide DN Version 5 Release 5 Service Manager (SM)