TIBCO ActiveMatrix BusinessWorks Plug-in for EDI User s Guide. Software Release 1.0 November 2011

Transcription

1 TIBCO ActiveMatrix BusinessWorks Plug-in for EDI User s Guide Software Release 1.0 November 2011

2 Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIBCO, The Power of Now, TIBCO Designer, TIBCO Administrator, TIBCO Rendezvous, TIBCO Runtime Agent, TIBCO Hawk, and TIBCO Enterprise Message Service are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. Copyright 2011 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

3 iii Contents Figures vii Tables ix Preface xi Related Documentation xii TIBCO ActiveMatrix BusinessWorks Plug-in for EDI Documentation xii Other TIBCO Product Documentation xii Typographical Conventions xiii Connecting with TIBCO Resources xv How to Join TIBCOmmunity xv How to Access All TIBCO Documentation xv How to Contact TIBCO Support xv Chapter 1 Introduction TIBCO Foresight Overview Transaction Validation Translation TIBCO ActiveMatrix BusinessWorks Plug-in for EDI Overview Chapter 2 EDI Palette Overview CallBack Configuration Code Instream Configuration DocumentSplitter GenerateResponse Input Output Error Output Translator Configuration Input

4 iv Contents Output Error Output Chapter 3 Getting Started Overview Creating a Project Creating a Process Adding Activities to a Process Testing a Process Deploying a Project Defining Global Variables Chapter 4 Using the Sample Project Overview Set Up the BWEDI-Sample Project Instream-Translator Process Instream Activity Translator Activity InstreamWithCallBack Process Deploy the BWEDI-Sample Project Appendix A Electronic Data Interchange Overview Structure Standards Appendix B Acknowledgements Overview Acknowledgements CA/U Acknowledgements Application Advice Functional Acknowledgement Implementation Acknowledgement TA1 Interchange Acknowledgement CONTRL Document (EDIFACT Responses) Appendix C Parsing Data from XML Format to Hashmap Overview

5 Contents v Parsing from XML to Hashmap Index

6 vi Contents

7 Figures vii Figures Figure 1 EDI Processing Workflow Figure 2 Translation Workflow Figure 3 EDI Palette Figure 4 CallBack Shared Resource: Configuration Tab Figure 5 Code Tab Figure 6 Instream Activity: Configuration Tab Figure 7 DocumentSplitter Tab Figure 8 GenerateResponse Tab Figure 9 Instream Activity: Input Tab Figure 10 Instream Activity: Output Tab Figure 11 Instream Activity: Error Output Tab Figure 12 Translator Activity: Configuration Tab Figure 13 Translator Activity: Input Tab Figure 14 Translator Activity: Output Tab Figure 15 Translator Activity: Error Output Tab Figure 16 TIBCO Designer Start Screen Figure 17 TIBCO Designer Save Project Screen Figure 18 Process Definition Figure 19 Global Variables Tab Figure 20 Create Global Variables Figure 21 BWEDI-Sample Project in TIBCO Designer Figure 22 BWEDI-Sample: Global Variables Figure 23 Instream-Translator Process Figure 24 Instream-Translator Process: Output of the Instream Activity Figure 25 Instream-Translator Process: Output of the Translator Activity Figure 26 InstreamWithCallBack Process Figure 27 InstreamWithCallBack Process: Output of the Instream Activity Figure 28 Add a Process Starter to the Archive

8 viii Figures Figure 29 Build Archive Figure 30 Create New Application in TIBCO Administrator Figure 31 Deploy the Application in TIBCO Administrator Figure 32 Deploy Successfully Figure 33 Application Management Figure 34 BWEDI-Sample Service Instance Figure 35 EDI Structure Figure 36 The Info Variable Value in XML Format Figure 37 Parsing EDI Data Figure 38 Parsing Flat File Data

9 Tables ix Tables Table 1 General Typographical Conventions xiii Table 2 Foresight CallBack Configuration Fields Table 3 CallBack Code Tab Table 4 Instream Configuration Fields Table 5 Instream DocumentSplitter Fields Table 6 Instream GenerateResponse Fields Table 7 Instream Input Fields Table 8 Instream Output Fields Table 9 Instream Exceptions Table 10 Translated File Formats Table 11 Translator Configuration Fields Table 12 Translator Input Fields Table 13 Translator Output Fields Table 14 Translator Exceptions Table 15 Set Up the Instream Activity for the Instream-Translator Process Table 16 Set Up the Translator Activity for the Instream-Translator Process Table 17 Set Up the Instream Activity for the InstreamWithCallBack Process

10 x Tables

11 xi Preface TIBCO ActiveMatrix BusinessWorks Plug-in for EDI is designed as a plug-in integrated with TIBCO BusinessWorks to address the needs of the TIBCO BusinessWorks customer who wants to make use of the functions provided by TIBCO Foresight Instream and TIBCO Foresight Translator in a user-friendly way. Topics Related Documentation, page xii Typographical Conventions, page xiii Connecting with TIBCO Resources, page xv

12 xii Related Documentation Related Documentation This section lists documentation resources you may find useful. TIBCO ActiveMatrix BusinessWorks Plug-in for EDI Documentation The following documents form the TIBCO ActiveMatrix BusinessWorks Plug-in for EDI documentation set: TIBCO ActiveMatrix BusinessWorks Plug-in for EDI Installation Read this manual for instructions on site preparation and installation. Read this manual for instructions on using the product. TIBCO ActiveMatrix BusinessWorks Plug-in for EDI Release Notes Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for this release. Other TIBCO Product Documentation You may find it useful to read the documentation for the following TIBCO products: TIBCO Designer TIBCO Administrator TIBCO ActiveMatrix BusinessWorks TIBCO Rendezvous TIBCO Enterprise Message Service TIBCO Hawk TIBCO Runtime Agent TIBCO Foresight Instream TIBCO Foresight Translator

13 Preface xiii Typographical Conventions The following typographical conventions are used in this manual. Table 1 General Typographical Conventions Convention ENV_NAME TIBCO_HOME EDI_HOME TIBCO_FORESIGHT _HOME code font Use TIBCO products are installed into an installation environment. A product installed into an installation environment does not access components in other installation environments. Incompatible products and multiple instances of the same product must be installed into different installation environments. An installation environment consists of the following properties: Name Identifies the installation environment. This name is referenced in documentation as ENV_NAME. On Microsoft Windows, the name is appended to the name of Windows services created by the installer and is a component of the path to the product shortcut in the Windows Start > All Programs menu. Path The folder into which the product is installed. This folder is referenced in documentation as TIBCO_HOME. The value of TIBCO_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco. TIBCO ActiveMatrix BusinessWorks Plug-in for EDI is installed into a directory within a TIBCO_HOME. This directory is referenced in documentation as EDI_HOME. The default value of EDI_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco\bw\plugins\edi. TIBCO Foresight products are installed into a directory. This directory is referenced in documentation as TIBCO_FORESIGHT_HOME. The default value of TIBCO_FORESIGHT_HOME depends on the operating system. For example, on Windows systems, the default value is C:\Foresight. Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example: Use MyCommand to start the foo process.

14 xiv Typographical Conventions Table 1 General Typographical Conventions (Cont d) Convention bold code font Use Bold code font is used in the following ways: In procedures, to indicate what a user types. For example: Type admin. In large code samples, to indicate the parts of the sample that are of particular interest. In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable disable] italic font Italic font is used in the following ways: To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts. To introduce new terms. For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal. To indicate a variable in a command or code syntax that you must replace. For example: MyCommand PathName Key combinations Key names separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C. Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q. The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances. The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result. The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.

15 Preface xv Connecting with TIBCO Resources How to Join TIBCOmmunity TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to How to Access All TIBCO Documentation After you join TIBCOmmunity, you can access the documentation for all supported product versions here: How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, please contact TIBCO Support as follows: For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site: If you already have a valid maintenance or support contract, visit this site: Entry to this site requires a username and password. If you do not have a username, you can request one.

16 xvi Connecting with TIBCO Resources

17 1 Chapter 1 Introduction This chapter gives an overview of TIBCO Foresight and TIBCO ActiveMatrix BusinessWorks Plug-in for EDI. Topics TIBCO Foresight Overview, page 2 TIBCO ActiveMatrix BusinessWorks Plug-in for EDI Overview, page 4

18 2 Chapter 1 Introduction TIBCO Foresight Overview Before using this document, familiarize yourself with Electronic Data Interchange (EDI). See Appendix A, Electronic Data Interchange for more information. TIBCO Foresight products benefit customers by connecting partners and validating transactions, reducing administrative inefficiencies and addressing mandates such as HIPAA In addition, the Foresight family of EDI management solutions allows organizations to trade electronic transactions with commonly-used formats (EDI, XML, and proprietary Flat File) and standards (HIPAA, X12, EDIFACT, TRADACOMS, VICS and so on.). This document focuses on the transaction validation and translation functions provided by TIBCO Foresight Instream and TIBCO Foresight Translator respectively. Transaction Validation TIBCO Foresight Instream ensures the compliance of inbound and outbound data using the fastest and most thorough transaction validation engine. You can use TIBCO Foresight Instream to automate transaction flow throughout your organization and validate transactions according to industry standards, organizational guidelines, and specific business rules. TIBCO Foresight Instream is designed to be highly configurable, with several components that work together. Figure 1 is a sample screen that shows Instream Validator, Response Generator, and Document Splitter working together to process inbound EDI. Figure 1 EDI Processing Workflow Validation To sender Your Communication System EDI Instream Validator Validation Summary Results Validation Detail Results Response Generator Docsplitter 277CA/U, 824, 997, 999, TA1, Custom reports Valid EDI Invalid EDI XML Report Your Translator Your Customer Support System

19 TIBCO Foresight Overview 3 See Instream Validation Technical Manual PDF document for more information about the Instream validation function, which you can find in the TIBCO Foresight Instream s Doc folder. Instream validation can be run as a command line, usually from within a batch file or script. Or you can integrate Instream validation into other applications, either statically (C/C++) or dynamically (C/C++, C#, and Java). Translation TIBCO Foresight Translator is a specialized, high-speed transformation engine that enables the mass conversion of transaction files based on pre-built or custom maps, providing direct translation to and from EDI, XML, and Flat File formats with no interim staging required. You can use TIBCO Foresight Translator to translate the input data in one format to a new file in another format. Figure 2 is a sample screen that shows the translation workflow. Figure 2 Translation Workflow Source Guideline Map Target Guideline Foresight Translator Output Data Input Data See Translator PDF document for more information about the translation function, which you can find in the TIBCO Foresight Translator s Doc folder.

20 4 Chapter 1 Introduction TIBCO ActiveMatrix BusinessWorks Plug-in for EDI Overview TIBCO BusinessWorks is an easy-to-use integration software that provides world-class integration technology in a rapid deployable solution that manages the entire lifecycle of integration projects. The TIBCO Foresight Instream validation module is a command-line validator. The TIBCO Foresight Translator module also uses a command-line executable to perform the translation. TIBCO ActiveMatrix BusinessWorks Plug-in for EDI creates a user-friendly environment that allows access to the functions provided by TIBCO Foresight Instream and TIBCO Foresight Translator through the following a shared resource and activities: CallBack, page 7 Instream, page 11 Translator, page 22

21 5 Chapter 2 EDI Palette This chapter describes the EDI palette, which includes one shared resource and two activities. Topics Overview, page 6 CallBack, page 7 Instream, page 11 Translator, page 22

22 6 Chapter 2 EDI Palette Overview The EDI palette includes one shared resource and two activities, as shown in Figure 3. Figure 3 EDI Palette Shared Resource CallBack, page 7 Activities Instream, page 11 Translator, page 22

23 CallBack 7 CallBack Shared Resource The CallBack shared resource allows you to select validation guidelines and profiles based on the contents of the data by modifying the Java code. It also allows you to modify the codes to implement different business logic. To enable the CallBack shared resource, check the CallBack checkbox in the Instream activity Configuration tab. The following shows details about how the CallBack shared resource works: Methods and variables mentioned in this section are defined in the Java code of the CallBack shared resource, which you can access by clicking the Code tab. See Figure 5. The package and class names in the Java code are named using the standard Java naming conventions based on the CallBack shared resource name. For example, if you name the CallBack shared resource CallBack_X12-1, then the package and class names will be changed to callback_121 and CallBack_X121 respectively. Set Guidelines and Profiles You can set guidelines and profiles by modifying Java codes using one of the following two methods: Use the setguideline(string val) method to set guidelines, and the setprofileoptions (String val) method to set profiles. Assign a value to the guideline variable to set the guideline directly, and assign a value to the profileoptions variable to set the profile directly. Implement Different Business Logic You can implement your own business logic by modifying the updateanalysis() method. If the input data is in EDI format: The updateanalysis() method will be called each time a new EDI data s functional group enveloping is encountered (CallBack happens only at every group level). The default updateanalysis() method is implemented to parse each info variable value in XML format, and to form a Hashmap with keys and values. The value of the info variable in XML format consists of information

24 8 Chapter 2 EDI Palette extracted from the EDI input data s interchange and functional group enveloping headers. Information is extracted each time a new EDI data s functional group enveloping is encountered. See Appendix C, Parsing Data from XML Format to Hashmap on page 61 for details about how to parse the info variable value in XML format to a Hashmap. If the input data is in Flat File format: The updateanalysis() method will be called when the Flat File input data has been correctly entered in the.csv configuration file. The CallBackXMLUtil.ParseToHashMap() method in the updateanalysis() method will parse the value of the info variable in XML format to the Hashmap data structure. The value of the info variable in the XML format consists of information extracted from the input Flat File header. Information is extracted when a new Flat File has been correctly entered in the.csv configuration file. See Appendix C, Parsing Data from XML Format to Hashmap on page 61 for details about how to parse the info variable value in XML format to a Hashmap. When using the CallBack shared resource to validate the Flat File input data, you need to enable the PARTNERAUTOMATIONFLAT property in the $dir.ini Instream configuration file (located in the TIBCO Instream s bin folder), and set the value of PARTNERAUTOMATIONFLAT with the.csv file mentioned in the above steps. For example: PARTNERAUTOMATIONFLAT= "C:\BWProjects\EDI\data\SampleFlatFilePartnerAutomation5.csv" Configuration Figure 4 shows a sample screen of the Configuration tab. Figure 4 CallBack Shared Resource: Configuration Tab

25 CallBack 9 The Configuration tab has the following fields. Table 2 Foresight CallBack Configuration Fields Field Global Var? Description Name No The name for the activity in the process definition. Description No A short description of the activity. Click the button to add the description in the Description dialog. Alias Library Yes Allows you to specify third-party JAR files that need to be included in your project. TIBCO Designer uses AliasLibrary resource (in the General palette) to specify the locations of the JAR files. See TIBCO Designer User s Guide for details about how to use the AliasLibrary resource. Code Figure 5 shows a sample screen of the Code tab. Figure 5 Code Tab In the Code tab, Java Code field, do not modify the content of comments that say "DO NOT MODIFY THIS COMMENT". Global variables can be accessed in the CallBack code. See the Accessing TIBCO ActiveMatrix BusinessWorks Global Variables and Java System Properties section in TIBCO ActiveMatrix BusinessWorks Palette Reference for details.

26 10 Chapter 2 EDI Palette Table 3 CallBack Code Tab The Code tab has the following GUI elements. GUI Element Java Code Field Compile Button View Errors Button Edit Class Button Description The source code of the Java class. You can specify validation guidelines and profiles in the Java code. Compiles the current source code. When the code in the activity needs compilation, a yellow warning icon appears on this button. The code will either compile successfully, or the View Errors dialog will appear to display any errors in the code. Displays the errors encountered when the code was compiled. Displays the source code in the editor.

27 Instream 11 Instream Instream Activity The Instream activity allows the plug-in to validate the input EDI data, split validation results, and use validation detail results to generate responses. Support Protocols The following list shows the protocols supported by the Instream activity: X12 HIPAA EDIFACT Flat File Features The following list shows the features provided by the Instream activity: Validation creates two files or an output stream: detail results and summary results. supports the CallBack function. See Instream Validation Technical Manual PDF document for more information about the validation function, which you can find in the TIBCO Foresight Instream s Doc folder. Document Splitter uses validation results to separate the valid EDI from the invalid. generates a list of files containing valid data, a list of files containing invalid data, and a Document Splitter report containing the status of each claim or other data being split based on the split point grouping specified in the Document Splitter profile. You can create your own profile to split the EDI into multiple documents. See Document Splitter Technical Manual PDF document or details about the Document Splitter function, which you can find in the TIBCO Foresight Instream s Doc folder. Generate Response uses validation results to create responses, such as 277 Acknowledgement, 824 Application Advice, 997/999 Functional Acknowledgement, TA1 Interchange Acknowledgement, and CONTRL document.

28 12 Chapter 2 EDI Palette See Response Generator Technical Manual PDF document for details about the Response Generator function, which you can find in the TIBCO Foresight Instream s Doc folder. The validation function still works fine even if the Document Splitter and Generate Response functions fail. Configuration Figure 6 shows a sample screen of the Configuration tab. Figure 6 Instream Activity: Configuration Tab Table 4 Instream Configuration Fields Field The Configuration tab has the following fields. Global Var? Description Name No The name for the activity in the process definition. Description No A short description of the activity. Click the button to add the description in the Description dialog. Input Mode No Specifies where the input data is stored. There are two options: File and Memory. Memory is normally the most efficient way of connecting, but large documents should be stored as files. Output Mode No Specifies where the output data is stored. There are two options: File and Memory. Memory is normally the most efficient way of connecting, but large documents should be stored as files.

29 Instream 13 Table 4 Instream Configuration Fields (Cont d) Field Document Level Validation Document Level Validation Separator Global Var? No Yes Description Check this checkbox to validate the EDI data that has no enveloping (EDI does not have ISA or GS enveloping). When the incoming EDI data contains ISA or GS enveloping, the enveloping will be ignored if you check this checkbox. See Appendix A, Electronic Data Interchange on page 51 for details about EDI enveloping. Note: This functionality is not applicable when the CallBack shared resource is enabled, and it is applicable only for X12 protocol. This field appears when you check the Document Level Validation checkbox. Separators (Segment Terminator, Element Separator, and Component Element Separator, in this order) must be specified in this field in one of the following formats: character, for example: ~*: integer, for example: 29, 30, 31 hex, for example: 0x1E, 0x1F, 0x1D CallBack No Check this checkbox to enable the CallBack function. CallBack ShareResource Yes This field appears when you check the CallBack checkbox. It is used to locate the Callback resource. Click the button to open the Select A Resource dialog. All usable CallBack resources are listed in the dialog. Select one to apply to your current activity. DocumentSplitter Figure 7 shows a sample screen of the DocumentSplitter tab. Figure 7 DocumentSplitter Tab

30 14 Chapter 2 EDI Palette Table 5 Instream DocumentSplitter Fields Field The DocumentSplitter tab has the following fields. Global Var? Description Document Splitter No Check this checkbox to enable the Document Splitter function. DS Report Type No This drop-down list allows you to specify what report types are generated. The following are the three options available: Valid Only Invalid Only Both Report Format No This drop-down list allows you to specify the format of the generated report. The following are the there two options available: XML CSV GenerateResponse Figure 8 shows a sample screen of the GenerateResponse tab. Figure 8 GenerateResponse Tab

31 Instream 15 Table 6 Instream GenerateResponse Fields Field The GenerateResponse tab has the following fields. Global Var? Description Generate Response No Check this checkbox to enable the Response Generator function. Generate 277 No Check this checkbox to generate a 277 CA/U Acknowledgement. A 277 CA/U Acknowledgement is generated when responding to HIPAA 837 transactions. See Appendix B, Acknowledgements on page 57 for details. Generate 824 No Check this checkbox to generate an 824 Application Advice. An 824 Application Advice is generated when responding to X12 EDI transactions. See Appendix B, Acknowledgements on page 57 for details. Generate 997 No Check this checkbox to generate a 997 Functional Acknowledgement. A 997 Functional Acknowledgement is generated when responding to X12 EDI transactions. See Appendix B, Acknowledgements on page 57 for details. Generate 999 No Check this checkbox to generate a 999 Functional Acknowledgement. A 999 Functional Acknowledgement is generated when responding to X12 EDI transactions. See Appendix B, Acknowledgements on page 57 for details. Generate TA1 No Check this checkbox to generate a TA1 Interchange Acknowledgement. A TA1 Interchange Acknowledgement is generated when responding to X12 EDI transactions. Generate Control No Check this checkbox to generate a CONTRL document. A CONTRL document is generated when responding to EDIFACT validation (except Inbound CONTRL). Parameters Yes You can specify parameters listed in the Response Generator Technical Manual PDF document in this field. You can find this document in the TIBCO Foresight Instream s Doc folder. For example: -ge-y indicates that group enveloping is to be included in the response documents. The Response Generator function can overwrite files if they already exist. -dav string indicates that the string, for example, , is set as the application version for the outbound GS. -fver_pass indicates that the ISA and GS version numbers for the source document will not be changed.

32 16 Chapter 2 EDI Palette Input Figure 9 shows a sample screen of the Input panel. Figure 9 Instream Activity: Input Tab Table 7 Instream Input Fields The input for the activity is as follows. Input Item Data Type Description validator_profile string (Optional) Specifies which APF file to use. The APF file contains configuration information for the Instream activity. Each time you validate, an APF file is read to determine what is to be checked and what is written to output files. The default APF is $fsdeflt.apf and is located in the TIBCO_FORESIGHT_HOME/Instream-Translator/bin directory. Note: This field will not be displayed when the CallBack shared resource is enabled, because the APF file will be extracted from the CallBack code. guideline_name string The name of the guideline used for validation, or used as the input for Document Splitter. Note: This field will not be displayed when the CallBack shared resource is enabled, because the guideline will be extracted from the CallBack code. ds_profile string (Optional) This field only appears when the Document Splitter checkbox is checked in the DocumentSplitter tab. You need to specify the full path and name to a Document Splitter INI file in this field. Note: The parameters set in the Document Splitter INI file take precedence over those set in the Input tab and the DocumentSplitter tab. input_file string This field only appears when the File mode is selected as the input mode in the Configuration panel. You need to specify the full path and name of the input file in this field.

33 Instream 17 Table 7 Instream Input Fields (Cont d) Input Item Data Type Description msg_content string This field only appears when the Memory mode is selected as the input mode in the Configuration panel. You need to specify the content of the input file. output_directory string This field only appears when the File mode is selected as the output mode in the Configuration panel. You need to specify the output directory for the output files. Output Figure 10 shows a sample screen of the Output tab. Figure 10 Instream Activity: Output Tab The output for the activity is as follows. Table 8 Instream Output Fields (Sheet 1 of 4) Output Item Data Type Description return_code integer Specifies the return code. For example, 100 means the validation ran successfully, 133 means the database directory cannot be found, and so on. Return codes are listed in Appendix A of Instream Validation Technical Manual PDF document which is located in the TIBCO Foresight Instream s Doc folder.

34 18 Chapter 2 EDI Palette Table 8 Instream Output Fields (Sheet 2 of 4) Output Item total_of_error integer Records the total errors with a severity level larger than level 2 (Error Count, Fatal Count, User1 Count, and User2 Count). The number of errors for each severity is recorded in the SVRTY record in the summary file. See Instream Validation Technical Manual PDF document for details. Validation Data Type Description File output mode selected validation_resultfile validation_summaryfile string string Specifies the full path and name of the validation detail results file (in the Flat File format), which contains general messages and statistics, and describes errors and warnings found during validation. Specifies the full path and name of the validation summary file (in the Flat File format), which contains a summary of the validation, including validation start time, end time, number of errors, warnings, and other messages. validation_result_in _flatfile string Specifies the message of the validation detail results in the Flat File format. Memory output mode selected validation_summary_in _flatfile validation_summary string N/A Specifies the message of the validation summary results in the Flat File format. This node displays the validation summary file in the XML tree format. Note: When the Document Splitter or Response Generator functions are enabled, the summary in XML format will be not supported (this node will disappear). DocSplitter

35 Instream 19 Table 8 Instream Output Fields (Sheet 3 of 4) Output Item ds_report_filename Data Type string Description Specifies the full path and name of the Document Splitter report, which contains the status of each claim or other data being split, as well as other information. File output mode selected ds_rpt_valid_results N/A Contains a list of valid files (ds_rpt_valid_filename). The ds_rpt_valid_filename output specifies the full path and name of the valid EDI file. Note: When splitting the EDI based on the split point grouping specified in the Document Splitter profile, multiple valid files will be generated if the input data contains multiple segments. ds_rpt_invalid_results N/A Contains a list of invalid files (ds_rpt_invalid_filename). The ds_rpt_invalid_filename output specifies the full path and name of the invalid EDI file. Note: When splitting the EDI based on the split point grouping specified in the Document Splitter profile, multiple invalid files will be generated if the input data contains multiple segments. ds_report_content string Specifies the content of the Document Splitter report. Memory output mode selected ds_rpt_valid_results N/A Contains a list of ds_rpt_valid_content. The ds_rpt_valid_content output specifies the content of the valid EDI data. Note: When splitting the EDI based on the split point grouping specified in the Document Splitter profile, multiple valid files will be generated if the input data contains multiple segments ds_rpt_invalid_results N/A Contains a list of ds_rpt_invalid_content. The ds_rpt_invalid_content output specifies the content of the invalid EDI data. Note: When splitting the EDI based on the split point grouping specified in the Document Splitter profile, multiple invalid files will be generated if the input data contains multiple segments Response

36 20 Chapter 2 EDI Palette Table 8 Instream Output Fields (Sheet 4 of 4) Output Item Data Type Description rg_277_filename string Specifies the full path and name of the 227 CA/U Acknowledgement. rg_824_filename string Specifies the full path and name of the 824 Application Advice. File output mode selected rg_997_filename string Specifies the full path and name of the 997 Functional Acknowledgement. rg_999_filename string Specifies the full path and name of the 999 Implementation Acknowledgement. rg_ta1_filename string Specifies the full path and name of the TA1 Interchange Acknowledgement. rg_contrl_doc_ filename string Specifies the full path and name of the CONTRL document. rg_277 string Provides the content of the 277 CA/U Acknowledgement. rg_824 string Provides the content of the 824 Application Advice. Memory output mode selected rg_997 string Provides the content of the 997 Functional Acknowledgement. rg_999 string Provides the content of the 999 Implementation Acknowledgement. rg_ta1 string Provides the content of the TA1 Interchange Acknowledgement. rg_contrl_doc string Provides the content of the CONTRL document. In File output mode, when you run a process with the Instream activity twice, using the same input file and output location, an error is thrown indicating that the output files already exist. Make sure that you move all the output files to an appropriate location after every validation to avoid this error.

37 Instream 21 Error Output Figure 11 shows a sample screen of the Error Output tab. Figure 11 Instream Activity: Error Output Tab Table 9 Instream Exceptions The Error Output tab lists the exceptions that can be thrown by this activity. Exception FSInstreamException Cause Occurs when: validating an input EDI data fails splitting an EDI into valid, invalid, or multiple documents fails. generating Acknowledgements fails.

38 22 Chapter 2 EDI Palette Translator Translator Activity The Translator activity provides the translation function. It takes in data in one format and creates a new file in another format. Table 10 shows the file formats for translation (operation types) supported by the Translator activity. Table 10 Translated File Formats From (Source) EDI EDI XML Flat File XML Flat File To (Target) XML Flat File EDI EDI Flat File XML Configuration Figure 12 shows a sample screen of the Configuration tab. Figure 12 Translator Activity: Configuration Tab The configuration tab has the following fields.

39 Translator 23 Table 11 Translator Configuration Fields Field Global Var? Description Name No The name for the activity in the process definition. Description No A short description of the activity. Click the button to add the description in the Description dialog. Input Mode No Specifies where the input data is stored. There are two options: File and Memory. Memory is normally the most efficient way of connecting, but large documents should be stored as files. Output Mode No Specifies where the output data is stored. There are two options: File and Memory. Memory is normally the most efficient way of connecting, but large documents should be stored as files. Operation Type No This drop-down list allows you to specify the operation type. See Table 10. CallBackBuffer(KB) No The size of the CallBack buffer in Kilo Bytes. This is used when in Memory output mode. Note: The minimum value of this field is 4 KB. If you have a larger document, it is recommended that the value is a multiple of 4, such as 8, 16, and so on. Separator Group Yes This field appears when the target file is an EDI file, for example, when selecting the XMLToEDI item in the Operation Type drop-down list. With an EDI target, you must define your own value in the Separator Groups. Otherwise, the output will contain improper separators and delimiters. For X12 EDI data, separators (Segment Terminator, Element Separator, Component Element Separator, and Repetition Separator, in this order) must be specified in this field in one of the following formats: character, for example: ~*:^ integer, for example: 126, 42, 58, 94 hex, for example: 0x7E, 0x2A, 0x3A, 0x5E For EDIFACT data, only HEX format is supported. Separators (Component Data Element Separator, Data Element Separator, Decimal Notification, Release Indicator, Reserved for future use, and Segment Terminator) may look like: "UNA=Y,0x2b,0x3a,0x2e,0x3f,0x2a,0x27" Note: "UNA=Y/N" delimiters refer to how to create a UNA segment when the target is EDIFACT. "Y" indicates create a UNA segment, "N" indicates do not create a UNA segment.

40 24 Chapter 2 EDI Palette Input Figure 13 shows a sample screen of the Input tab. Figure 13 Translator Activity: Input Tab Table 12 Translator Input Fields Input Item The input for the activity is as follows. Data Type Description map_filename string This field specifies the map file name. The source guideline (describes the data before translation) and target guideline (describes the data after translation) are specified in the map file. Note: All source guidelines, target guidelines, schemas, and mapping files must be in the Database folder. input_file string This field only appears when the File mode is selected as the input mode in the Configuration panel. You need to specify the full path and name of the file that will be translated in this field. msg_content string This field only appears when the Memory mode is selected as the input mode in the Configuration panel. It specifies the content of the file that will be translated. output_directory string This field only appears when the File mode is selected as the output mode in the Configuration panel. You need to specify the output directory for the Translator output files. encoding string (Optional) Specifies the encoding used by the Translator activity for output data.

41 Translator 25 Output Figure 14 shows a sample screen of the Output tab. Figure 14 Translator Activity: Output Tab Table 13 Translator Output Fields The output for the activity is as follows. Output Item output_file (Output is file-based) msg_content (Output is memory-based) Data Type string string Description Specifies the full path and name for the output file. Specifies the content of the output file. return_code string Specifies the return code. For example, 100 means the transaction ran successfully, 158 means the map file cannot be opened, and so on. Return codes are listed in Appendix C of Translator PDF document which is located in the TIBCO Foresight Translator s Doc folder. encoding string Specifies the encoding used by Translator activity for output data. In File output mode, when you run a process with the Translator activity twice, using the same input file and output location, an error is thrown indicating that the output files already exist. Make sure that you move all the output files to an appropriate location after every translation to avoid this error.

42 26 Chapter 2 EDI Palette Error Output Figure 15 shows a sample screen of the Error Output tab. Figure 15 Translator Activity: Error Output Tab Table 14 Translator Exceptions The Error Output tab lists the exceptions that can be thrown by this activity. Exception FSTranslatorException Cause Occurs when the translation fails.

43 27 Chapter 3 Getting Started This chapter describes the basic steps that are required to configure and run TIBCO ActiveMatrix BusinessWorks Plug-in for EDI in TIBCO Designer. Topics Overview, page 6 Creating a Project, page 29 Creating a Process, page 31 Adding Activities to a Process, page 32 Testing a Process, page 33 Deploying a Project, page 34 Defining Global Variables, page 35

44 28 Chapter 3 Getting Started Overview TIBCO ActiveMatrix BusinessWorks is a scalable, extensible, and easy to use integration platform that allows you to develop and test integration projects. TIBCO ActiveMatrix BusinessWorks includes a graphical user interface, TIBCO Designer, for defining business processes, and an engine that executes the processes. For detailed information about how to configure processes, see TIBCO Designer documentation, which can be accessed from the Help > Designer Help menu option in TIBCO Designer. A typical configuration session entails the following steps: 1. Creating a Project, page Creating a Process, page Adding Activities to a Process, page Testing a Process, page Deploying a Project, page 34