webMethods EDIINT Module

Users Guide

VERSION 6.5

webMethods, Inc. South Tower 3877 Fairfax Ridge Road Fairfax, VA 22030 USA 703.460.2500 http://www.webmethods.com

webMethods Administrator, webMethods Broker, webMethods Dashboard, webMethods Developer, webMethods Fabric, webMethods Glue, webMethods Installer, webMethods Integration Server, webMethods Mainframe, webMethods Manager, webMethods Mobile, webMethods Modeler, webMethods Monitor, webMethods Optimize, webMethods Portal, webMethods Trading Networks, and webMethods Workflow are trademarks of webMethods, Inc. webMethods and the webMethods logo are registered trademarks of webMethods, Inc. Acrobat, Adobe, and Reader are registered trademarks of Adobe Systems Incorporated. Amdocs is a registered trademark, and ClarifyCRM is a trademark of Amdocs Inc. Ariba is a registered trademark of Ariba, Inc. BEA and BEA WebLogic Server are registered trademarks, and BEA WebLogic Platform is a trademark of BEA Systems, Inc. BMC Software and PATROL are registered trademarks of BMC Software, Inc. BroadVision is a registered trademark of BroadVision, Inc. ChemeStandards and CIDX are registered trademarks of Chemical Industry Data Exchange. Unicenter is a trademark of Computer Associates International, Inc. PopChart is a registered trademark of CORDA Technologies, Inc. Kenan and Arbor are registered trademarks of CSG Software, Incorporated. SNAP-IX and Data Connection are registered trademarks of Data Connection Corporation. DataDirect, DataDirect Connect, and SequeLink are registered trademarks of DataDirect Technologies Corp. D & B and D-U-N-S are registered trademarks of Dun & Broadstreet, Inc. Entrust is a registered trademark of Entrust, Inc. Hewlett-Packard, HP, HP-UX, and OpenView are trademarks of Hewlett-Packard Company. i2 is a registered trademark of i2 Technologies, Inc. AIX, AS/400, CICS, DB2, Domino, IBM, Infoprint, Lotus, Lotus Notes, MQSeries, OS/390, OS/400, RACF, RS/6000, S/390, System/390, VTAM, z/OS, and WebSphere are registered trademarks; and Informix, SQL/400, Communications System for Windows NT, IMS, MVS, SQL/DS, and Universal Database are trademarks of IBM Corporation. InnoDB is a trademark of Innobase Oy. JBoss is a registered trademark, and JBoss Group is a trademark of JBoss Inc. JD Edwards is a registered trademark of J.D. Edwards & Company and OneWorld is a registered trademark of J.D. Edwards World Source Company. Linux is a registered trademark of Linus Torvalds. X Window System is a trademark of the X.org Foundation. MetaSolv is a registered trademark of Metasolv Software, Inc. ActiveX, Microsoft, Outlook, Visual Basic, Windows, and Windows NT are registered trademarks; and SQL Server is a trademark of Microsoft Corporation. MySQL is a registered trademark of MySQL AB, Ltd. Teradata is a registered trademark of NCR International, Inc. Netscape is a registered trademark of Netscape Communications Corporation. ServletExec is a registered trademark, and New Atlanta is a trademark of New Atlanta Communications, LLC. CORBA is a registered trademark of Object Management Group, Inc. UNIX is a registered trademark of X/Open Company Ltd. Oracle is a registered trademark of Oracle International Corporation. PeopleSoft and Vantive are registered trademarks, and PeopleSoft Pure Internet Architecture and WorldSoftware are trademarks of PeopleSoft, Inc. Infranet and Portal are trademarks of Portal Software, Inc. RosettaNet is a trademark of RosettaNet, a non-profit organization. SAP and R/3 are registered trademarks of SAP AG. Siebel is a registered trademark of Siebel Systems, Inc. SPARC is a registered trademark, and SPARCStation is a trademark of SPARC International, Inc. SSA Global and SSA Baan are trademarks of SSA Global Technologies, Inc. EJB, Enterprise JavaBeans, Java, JavaServer, JDBC, JSP, J2EE, Solaris, and Sun Microsystems are registered trademarks; and Java Naming and Directory Interface, SOAP with Attachments API for Java, JavaServer Pages and SunSoft are trademarks of Sun Microsystems, Inc. SWIFT and SWIFTNet are registered trademarks of Society for Worldwide Interbank Financial Telecommunication SCRL. Sybase is a registered trademark of Sybase, Inc. UCCnet and eBusinessReady are registered trademarks of Uniform Code Council, Inc. Verisign is a registered trademark of Verisign, Inc. VERITAS is a registered trademark of VERITAS Operating Corporation, and VERITAS Software and VERITAS Cluster Server are trademarks of VERITAS Software Corporation. W3C is a registered trademark of Massachusetts Institute of Technology. All other marks are the property of their respective owners. Copyright 2005 by webMethods, Inc. All rights reserved, including the right of reproduction in whole or in part in any form.

Document ID: EDIINT-UG-65-20050429

Contents

Contents
About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

7
7 7

Chapter 1. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What Is EDIINT? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods EDIINT Module Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . webMethods EDIINT Module Support for EDIINT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EDIINT Interoperability Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The EDIINT Module and the webMethods Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Features Provided for EDIINT Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Inbound EDIINT Processing with AS1 and AS2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EDIINT Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Inbound EDIINT Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Inbound EDIINT MDNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Outbound EDIINT Processing With AS1 and AS2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Sending Outbound EDIINT Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Sending Outbound EDIINT MDNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Run-Time Processing With EDIINT AS3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Run-Time Processing For Host Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Host Partner Sending an AS3 Message to a Client Partner . . . . . . . . . . . . . . . . . . . . . . . . Host Partner Retrieving an AS3 Message or MDN from a Client Partner . . . . . . . . . . . . . . Run-Time Processing For Client Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Client Partner Sending an AS3 Message to the Host Partner . . . . . . . . . . . . . . . . . . . . . . . Client Partner Retrieving an AS3 Message or MDN from the Host Partner . . . . . . . . . . . . Using a Business Process to Send Outbound EDIINT Documents . . . . . . . . . . . . . . . . . . . . . . . . . .

9
10 10 11 11 12 13 13 14 14 17 18 19 20 23 24 24 24 24 24 24 25

Chapter 2. Before You Can Transport Documents Using EDIINT . . . . . . . . . . . . . . . . . . .

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Including EDIINT Information in Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Corporate Tab of the Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Behavior of External ID Matching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating Your Existing Profiles to Use EDIINT AS1, EDIINT AS2, and EDIINT AS3 . Using the EDIINT ID Match Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Delivery Method Tab of the Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Extended Fields Tab of the Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Security Tab of the Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27
28 28 29 29 29 30 31 32 34

webMethods EDIINT Module Users Guide Version 6.5

Contents

Configuring SMTP Settings to Enable EDIINT Message Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Inbound EDIINT SMTP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Outbound EDIINT SMTP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Your System To Support EDIINT AS3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Directories For Uploading/Downloading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Trading Partner Agreements (TPAs) For AS3 Support . . . . . . . . . . . . . . . . . . . . . . . . Configuring Whether Trading Networks Is To Process Payloads . . . . . . . . . . . . . . . . . . . . . . . . . . . . Trading Networks Objects Provided for EDIINT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Extended Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Services Invoked by Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

35 35 36 37 37 37 46 48 48 49 50 50 51

Chapter 3. Creating a Client to Submit a Document Using EDIINT . . . . . . . . . . . . . . . . . . . 53

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Content Types to Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Setting the Input Variables for the wm.EDIINT:send Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Chapter 4. Processing Inbound EDIINT Documents and MDNs . . . . . . . . . . . . . . . . . . . . . 55

Processing Inbound EDIINT Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Before You Can Process Inbound EDIINT Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of an EDIINT Document Posted by HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Outbound MDNs that Acknowledge Receipt of an EDIINT Document . . . . . . . . . . . . . Setting Up to Process Payloads from EDIINT Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How the S/MIME Type Profile Field Affects Processing Payloads . . . . . . . . . . . . . . . . . . . . . . . Processing Inbound EDIINT MDNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Before You Can Process Inbound EDIINT MDNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of an EDIINT MDN Posted by HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 56 57 57 58 59 60 60 61

Chapter 5. Using EDIINT to Deliver Outbound Documents . . . . . . . . . . . . . . . . . . . . . . . . . 63

Before You Can Deliver Outbound EDIINT Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Setting the S/MIME Type of the Outbound EDIINT Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Using the wM.EDIINT:send Service to Send EDIINT Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Chapter 6. Viewing and Managing Information about EDIINT Documents and MDNs . . . 67
Using Trading Networks Console to View Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Viewing Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Resubmitting EDIINT Outbound Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

webMethods EDIINT Module Users Guide Version 6.5

Contents

Chapter 7. webMethods EDIINT Module Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

wm.EDIINT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 wm.EDIINT.sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Appendix A. Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

85 89

webMethods EDIINT Module Users Guide Version 6.5

Contents

webMethods EDIINT Module Users Guide Version 6.5

About This Guide

About This Guide

This guide is for users of the webMethods EDIINT Module. It provides an overview of the webMethods EDIINT Module and its features.

Document Conventions
Convention Bold Italic Description Identifies elements on a screen. Identifies variable information that you must supply or change based on your specific situation or environment. Identifies terms the first time they are defined in text. Also identifies service input and output variables. Identifies storage locations for services on the webMethods Integration Server using the convention folder.subfolder:service. Identifies characters and values that you must type exactly or messages that the system displays on the console. Identifies keyboard keys. Keys that you must press simultaneously are joined with the + symbol. Directory paths use the \ directory delimiter unless the subject is UNIX-specific. Optional keywords or values are enclosed in [ ]. Do not type the [ ] symbols in your own code.

Narrow font
Typewriter font

UPPERCASE \ []

Additional Information
The webMethods Advantage Web site at http://advantage.webmethods.com provides you with important sources of information about webMethods components: Troubleshooting Information. webMethods provides troubleshooting information for many webMethods components in the webMethods Knowledge Base. Documentation Feedback. To provide documentation feedback to webMethods, go to the Documentation Feedback Form on the webMethods Bookshelf. Additional Documentation. All webMethods documentation is available on the webMethods Bookshelf.

webMethods EDIINT Module Users Guide Version 6.5

About This Guide

webMethods EDIINT Module Users Guide Version 6.5

CHAPTER

Concepts
What Is EDIINT? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 webMethods EDIINT Module Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 webMethods EDIINT Module Support for EDIINT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 EDIINT Interoperability Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 The EDIINT Module and the webMethods Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Features Provided for EDIINT Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Inbound EDIINT Processing with AS1 and AS2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Outbound EDIINT Processing With AS1 and AS2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Run-Time Processing With EDIINT AS3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Using a Business Process to Send Outbound EDIINT Documents . . . . . . . . . . . . . . . . . . . . 25

webMethods EDIINT Module Users Guide Version 6.5

CHAPTER 1 Concepts

What Is EDIINT?
EDIINT stands for Electronic Data Interchange-Internet Integration, or EDI over the Internet. EDIINT is a standard defined by the Internet Engineering Task Force (IETF) that defines a protocol for using the Internet to securely exchange business documents (EDI, XML, or other). The three versions of the EDIINT standard include: EDIINT AS1 (EDIINT Applicability Statement 1) that uses SMTP (e-mail) to transport documents EDIINT AS2 (EDIINT Applicability Statement 2) that uses HTTP (or HTTP/S) to transport documents EDIINT AS3 (EDIINT Applicability Statement 3) that uses FTPS (FTP over SSL) to transport documents All versions support digital signatures, encryption, and signed receipts. The EDIINT standard specifies how to exchange business documents over the Internet in a secure, reliable, non-repudiable way. It does not specify how to validate or process the business documents that are transported.

webMethods EDIINT Module Introduction

The webMethods EDIINT Module (EDIINT Module) adds support for the EDIINT exchange protocol. Documents using the EDIINT protocol are processed through Trading Networks. As a result, if you want to use the EDIINT protocol, you must use Trading Networks. The EDIINT Module supports EDIINT AS1 (SMTP), EDIINT AS2 (HTTP), and EDIINT AS3 (FTPS) messages, including MDN (receipt) exchange. The EDIINT Module exclusively uses the S/MIME version 2 cryptographic format to package, encrypt, and provide a digital signature to outbound data, as well as to unpack, decrypt, and verify the authenticity of inbound data. You can use EDIINT to transport both EDI and non-EDI formatted (e.g., XML or custom format) documents. When you use the EDIINT transport for EDI documents, you must also have the webMethods EDI Module installed. The EDIINT Module passes EDI documents to Trading Networks, which in turn allows the EDI Module to process the EDI document using the functions of the EDI Module packages (WmEDI and WmEDIforTN). When you use the EDIINT transport non-EDI documents, the EDIINT Module passes the documents to Trading Networks, and Trading Networks processes based on logic you define in Trading Networks.

10

webMethods EDIINT Module Users Guide Version 6.5

webMethods EDIINT Module Support for EDIINT

webMethods EDIINT Module Support for EDIINT

The EDIINT Module supports the following EDIINT features: Securely exchanges business documents using EDIINT AS1, EDIINT AS2, and EDIINT AS3. Exclusively uses the S/MIME version 2 cryptographic format to package, compress, encrypt, and provide a digital signature to outbound data, as well as to unpack, decrypt, and verify the authenticity of inbound data. Note: The S/MIME (Secure/Multipurpose Internet Mail Extensions) standard specifies formats and procedures for providing the cryptographic security services of message authentication, integrity, non-repudiation of origin, and confidentiality. Uses the SHA-1 hash algorithm to sign outbound messages, and verifies inbound messages that were signed with either SHA-1 or MD5. Enables you to set encryption types and key lengths for each of your trading partners using the extended fields in the partners Trading Networks profile. The choices include: Triple DES, DES, RC2 (40 bits), RC2 (64 bits), and RC2 (128 bits). Provides the standard outbound encryption permutations (signed, encrypted, signed and encrypted, or plain) at the send-service level. Can send receipts of received messages back to the sender as well as receive message receipts. EDIINT receipts are known as MDNs (message disposition notifications). The EDIINT Module can send and receive synchronous or asynchronous, signed or unsigned MDNs.

EDIINT Interoperability Tests

The webMethods EDIINT Module successfully completed the eBusinessReady interoperability testing for both EDIINT AS1, EDIINT AS2, and EDIINT AS3. The eBusinessReady interoperability testing is an industry-neutral software testing program under joint partnership of the Uniform Code Council, Inc. (UCC) and Drummond Group, Inc. (DGI). For more information about the interoperability tests, refer to http://www.eBusinessReady.org. webMethods has participated in all past EDIINT AS2 interoperability tests hosted by the Drummond Group.

webMethods EDIINT Module Users Guide Version 6.5

11

CHAPTER 1 Concepts

The EDIINT Module and the webMethods Components

When you install the webMethods EDIINT Module, the WmEDIINT package is installed into the Integration Server. The following diagram illustrates how the EDIINT Module fits into the webMethods architecture. For more information, see the text after the diagram.
EDIINT Module and the webMethods Architecture

Integration Server Trading Networks WmEDIforTN WmEDI

~~~~~~~~~~~~~~~~~~~~~~~~ Transports ~~~~~~~~~~~~~~~~~~~~~~~~ ebXML SMTP EDIINT HTTP FTP Module HTTPS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Integration Server is the underlying foundation of webMethods. Trading Networks is a webMethods component that enables your enterprise to link with other companies (buyers, suppliers, strategic partners) and marketplaces to form a business-to-business trading network. Trading Networks is required to use the EDIINT Module. For more information about Trading Networks, see the webMethods Trading Networks Concepts Guide and the webMethods Trading Networks Users Guide. EDI Module is comprised of the following two packages: The WmEDI package is the basic functionality that provides support for the EDI standard. The WmEDIforTN package allows for the interaction between the WmEDI package and Trading Networks. This interaction allows you to use Trading Networks as a gateway for EDI document exchange. The EDI Module uses the functionality of Trading Networks to provide additional features, such as support for VANs, reconciling FAs, and batching the sending of EDI documents. EDIINT Module contains the support for the EDIINT exchange protocol as described above in webMethods EDIINT Module Introduction on page 10.

12

webMethods EDIINT Module Users Guide Version 6.5

Features Provided for EDIINT Processing

Features Provided for EDIINT Processing

After installing the webMethods EDIINT Module, webMethods provides the following to support EDIINT processing: Content handlers to recognize inbound EDIINT documents and MDNs. Built-in services that you use to send outbound EDIINT documents and MDNs and that you use to receive inbound EDIINT documents and MDNs. TN document types that are automatically installed into Trading Networks and allow Trading Networks to recognize inbound EDIINT documents and MDNs; the TN document types are set up so all EDIINT documents and MDNs are automatically saved to the Trading Networks database. Extended profile fields that are automatically installed into Trading Networks and that are available in Trading Networks profiles for you to supply partner-specific information needed for EDIINT transport-level processing. Processing rules that are automatically installed into Trading Networks and are used to perform the EDIINT transport-level processing. Delivery services that are automatically registered with Trading Networks and used for delivering EDIINT documents and MDNs. For more information about how the EDIINT Module uses the items listed above for EDIINT inbound and outbound processing. see Inbound EDIINT Processing with AS1 and AS2 on page 13 and Outbound EDIINT Processing With AS1 and AS2 on page 18.

Inbound EDIINT Processing with AS1 and AS2

For inbound processing, a client sends a document to the Integration Server using the EDIINT exchange protocol. The document is processed in the Integration Server using services provided with the EDIINT Module and by using Trading Networks.
Inbound EDIINT processing

Client
Document
EDIINT

Integration Server Trading Networks

webMethods EDIINT Module Users Guide Version 6.5

13

CHAPTER 1 Concepts

EDIINT Client
Use the EDIINT Module to create the client to send documents using EDIINT. If you are not using webMethods software on the client side, see documentation for the EDIINT software that you are using. When the client sends the EDIINT document to the Integration Server, it must associate the inbound document with a content type that the EDIINT Module recognizes, for example, multipart/signed. When the Integration Server receives a document that has an EDIINT content type, it passes the document to the appropriate EDIINT content handler, which was installed when you installed the EDIINT Module. The EDIINT content handler passes the document to the service the client specifies. To use the EDIINT exchange protocol, the client must specify the wm.EDIINT:receive service. The wm.EDIINT:receive service is a built-in service provided with the EDIINT Module. For more information about processing the EDIINT document, see Processing Inbound EDIINT Documents below.

Processing Inbound EDIINT Documents

The EDIINT Module provides all logic required to perform the transport-level processing for inbound EDIINT documents. You can use Trading Networks to add business-level processing for the payloads of your EDIINT documents. Note: For information about how the EDIINT Module processes inbound MDNs, see Processing Inbound EDIINT MDNs on page 17.

14

webMethods EDIINT Module Users Guide Version 6.5

Inbound EDIINT Processing with AS1 and AS2

The following diagram illustrates how the EDIINT Module performs transport-level processing for an inbound EDIINT document. Additionally, as illustrated in the diagram, if you want to perform business-level processing, you can submit the payload of the EDIINT document to Trading Networks for further processing. For more information, see the table after the diagram.
Processing an inbound EDIINT document
Document payload

Integration Server
1

wm.EDIINT:receive service
2
TN document types EDIINT Pipeline bizdoc

Trading Networks
processing rules

3
EDIINT Process Message

EDIINT Process Message Processing Rule

MDN requested? no

yes

MDN

Send back to the sender.

5 Submit

payload to TN? no

yes

6
payload Submit the payload if you want to perform businesslevel processing on the payload of the EDIINT document.

Processing complete.

webMethods EDIINT Module Users Guide Version 6.5

15

CHAPTER 1 Concepts

Step
1 2

Description The wm.EDIINT:receive service accepts the inbound document. The wm.EDIINT:receive service uses the TN document types to determine the type of document. The document matches the EDIINT TN document type that is installed into Trading Networks when you install the EDIINT Module. After determining the TN document type, the wm.EDIINT:receive service forms a BizDocEnvelope for the inbound document and places it in the pipeline in the bizdoc variable. A BizDocEnvelope contains the original document and includes additional information that Trading Networks requires for routing and processing the document. One piece of information that Trading Networks can use in the selection of a processing rule is the user status. The EDIINT recognizer sets the user status to ProcessMsg. After forming the BizDocEnvelope, the wm.EDIINT:receive service sends BizDocEnvelope to Trading Networks for processing.

Trading Networks determines the processing rule to use for the document. For inbound EDIINT documents, Trading Networks uses the EDIINT Process Message processing rule that is installed into Trading Networks when you install the EDIINT Module. It selects this processing rule because the TN document type is EDIINT and the user status is ProcessMsg. This processing rule performs the Execute a Service action to invoke the wm.EDIINT.rules:processMsg service. The service processes the message by opening the MIME or S/MIME package and then decrypting and/or verifying the signature of the message.

The remaining steps represent actions specified in the EDIINT Process Message processing rule.
4

The wm.EDIINT.rules:processMsg service determines whether the sender of the EDIINT document requested an MDN. If the sender did request an MDN, the wm.EDIINT.rules:processMsg service determines whether the sender has requested a signed or an unsigned MDN. The service creates the appropriate type of MDN and sends the MDN back to Trading Networks for delivery. Trading Networks can deliver the MDN synchronously or asynchronously. For more information about how Trading Networks delivers the MDN, see Sending Outbound EDIINT MDNs on page 20. After sending the document to Trading Networks, continue with the next step. If the sender did not request an MDN, continue with the next step.

16

webMethods EDIINT Module Users Guide Version 6.5

Inbound EDIINT Processing with AS1 and AS2

Step
5

Description The wm.EDIINT.rules:processMsg service invokes the wm.EDIINT.rules:processPayload service, which determines whether you want to send the payload of the EDIINT document to Trading Networks for processing. You define whether you want the EDIINT Module to send EDIINT payloads to Trading Networks for processing when you configure the EDIINT Module.

If the payload is to be sent to Trading Networks for processing, submit the payload. You send the payload of the document for processing if you want to perform business-level logic on payload. The payload can be either an EDI document or a non-EDI document (e.g., an XML document). EDI documents. If the payload is an EDI document, the EDI Module processes the document. When the payload is an EDI document, you must set up the EDI Module and Trading Networks to process the EDI document. For example, use the EDI Module to install TN document types for the EDI documents and create a processing rule to process the EDI document. For more information about how the EDI Module processes EDI documents, see information about using the EDI Module with Trading Networks in the webMethods EDI Module Concepts Guide. Non-EDI documents. If the payload is not an EDI document, you must define the TN document types that Trading Networks can use to recognize the payload and the processing rule that Trading Networks should use to process the document.

Processing Inbound EDIINT MDNs

The following diagram illustrates how the EDIINT Module processes inbound MDNs. For more information, see the table after the diagram.
Processing inbound MDNs

Integration Server
MDN

wm.EDIINT:receive service
2
TN document types EDIINT MDN Pipeline bizdoc

Trading Networks
processing rules

3
EDIINT Process MDN Message

webMethods EDIINT Module Users Guide Version 6.5

17

CHAPTER 1 Concepts

Step
1 2

Description The wm.EDIINT:receive service accepts the inbound MDN. The wm.EDIINT:receive service uses the TN document types to determine the type of document. The MDN matches the EDIINT MDN TN document type that is installed into Trading Networks when you install the EDIINT Module. After determining the TN document type, the The wm.EDIINT:receive service forms a BizDocEnvelope for the inbound MDN and places it in the pipeline in the bizdoc variable. A BizDocEnvelope contains the MDN and includes additional information that Trading Networks requires for routing and processing the document. One piece of information that Trading Networks can use in the selection of a processing rule is the user status. The EDIINT recognizer sets the user status to ProcessMDNMsg. After forming the BizDocEnvelope, the wm.EDIINT:receive service sends BizDocEnvelope to Trading Networks for processing.

Trading Networks determines the processing rule to use for the MDN. For inbound MDNs, Trading Networks uses the EDIINT Process MDN Message processing rule that is installed into Trading Networks when you install the EDIINT Module. Trading Networks selects this processing rule because the TN document type is EDIINT MDN and the user status is ProcessMDNMsg. This processing rule performs the Execute a Service action to invoke the wm.EDIINT.rules:processMDN service, which processes the EDIINT MDN.

Outbound EDIINT Processing With AS1 and AS2

The documents you want to send using EDIINT can be EDI documents or a non-EDI documents. The EDIINT standard specifies requirements for how to package a document for transport and how to transport the document. To package the document and transport it, you use services provided with the EDIINT Module along with Trading Networks.
Outbound EDIINT processing

Integration Server
Trading Networks
Document EDIINT

Trading Partner

18

webMethods EDIINT Module Users Guide Version 6.5

Outbound EDIINT Processing With AS1 and AS2

Sending Outbound EDIINT Documents

The EDIINT Module provides all logic required to perform the transport-level processing for sending outbound EDIINT documents. Note: For information about how to send outbound MDNs, see Sending Outbound EDIINT MDNs on page 20. The following diagram illustrates how to use the EDIINT Module to send an outbound EDIINT document. For more information, see the table after the diagram.
Sending outbound EDIINT documents

Integration Server
1
business document (EDI, XML, etc.)

wm.EDIINT:send service
2
Document payload TN document types

3
EDIINT

Pipeline bizdoc

Trading Networks
processing rules

4
EDIINT Send Message

5
Document payload

Trading Partner

Step
1

Description You invoke the wm.EDIINT:send service to send a document to the EDIINT Module to be packaged as an EDIINT document and delivered to the receiving trading partner. The inputs of wm.EDIINT:send include the level of encryption to use, whether to compress the data, whether you are requesting an MDN and if so what kind, and how to deliver the document. Using the input information that you provide, the wm.EDIINT:send service creates the EDIINT document, that is, an EDIINT MIME or S/MIME message.

webMethods EDIINT Module Users Guide Version 6.5

19

CHAPTER 1 Concepts

Step
3

Description The wm.EDIINT:send service uses the TN document types to determine the type of document. The document matches the EDIINT TN document type that is installed into Trading Networks when you install the EDIINT Module. After determining the TN document type, the wm.EDIINT:send forms a BizDocEnvelope for the inbound document and places it in the pipeline in the bizdoc variable. A BizDocEnvelope contains the original document and includes additional information that Trading Networks requires for routing and processing the document. One piece of information that Trading Networks can use in the selection of a processing rule is the user status. The EDIINT recognizer sets the user status to SendMsg. After forming the BizDocEnvelope, the wm.EDIINT:send service sends BizDocEnvelope to Trading Networks for processing.

Trading Networks determines the processing rule to use for the document. For outbound EDIINT documents, Trading Networks uses the EDIINT Send Message processing rule that is installed into Trading Networks when you install the EDIINT Module. Trading Networks selects this processing rule because the TN document type is EDIINT and the user status is SendMsg. This processing rule performs the Execute a Service action to invoke the wm.EDIINT.rules:sendMsg service.

The wm.EDIINT.rules:sendMsg service delivers the document by invoking the wm.EDIINT.delivery:deliveryDocument service. The wm.EDIINT.delivery:deliveryDocument service delivers the document to the appropriate trading partner.

Sending Outbound EDIINT MDNs

The EDIINT Module automatically sends an outbound MDN when it receives an inbound EDIINT document that requests an MDN. Based on how the sender of the inbound EDIINT document requests the MDN to be sent, the EDIINT Module can send the MDN either synchronously or asynchronously. When the EDIINT Module sends an MDN synchronously, it sends the MDN using the same HTTP connection as that of the inbound EDIINT document. Otherwise, it sends the MDN as a separate transaction.

20

webMethods EDIINT Module Users Guide Version 6.5

Outbound EDIINT Processing With AS1 and AS2

The following diagram illustrates how the EDIINT Module sends an outbound MDN. For more information, see the table after the diagram.
Sending an outbound MDN

Sending Trading Partner

Document payload

Integration Server
1

wm.EDIINT.receive service Trading Networks

EDIINT Process Message Processing Rule wm.EDIINT.rules:processMessage

2
MDN MDN TN document types EDIINT MDN Pipeline bizdoc

3
processing rules EDIINT Send MDN Message

EDIINT Send MDN Message Processing Rule sync

sync or async? async

Processing is complete. The MDN is sent as a separate transaction.

webMethods EDIINT Module Users Guide Version 6.5

21

CHAPTER 1 Concepts

Step
1 2

Description The sender sends an EDIINT document to the wm.EDIINT:receive service with a request for an MDN. The wm.EDIINT:receive service accepts the inbound EDIINT document. The wm.EDIINT:receive service passes the EDIINT document to Trading Networks. Trading Networks processes the document using the EDIINT Process Message processing rule. For details about inbound processing, see Processing Inbound EDIINT Documents on page 14. The EDIINT Process Message processing rule invokes the wm.EDIINT.rules:processMsg service to process the inbound EDIINT document. Because an MDN is requested, the wm.EDIINT.rules:processMsg service creates the MDN. The wm.EDIINT.rules:processMsg service performs document recognition on the MDN using the Trading Networks TN document types. The MDN matches the EDIINT MDN TN document type. After determining the TN document type, Trading Networks forms a BizDocEnvelope for the MDN and places it in the pipeline in the bizdoc variable. The Trading Networks user status for the MDN is set to SendMDNMsg. The wm.EDIINT.rules:processMsg service then passes the BizDocEnvelope into standard Trading Networks processing.

Trading Networks determines the processing rule to use for the MDN. For inbound MDNs, Trading Networks uses the EDIINT Send MDN Message processing rule that is installed into Trading Networks when you install the EDIINT Module. Trading Networks selects this processing rule because the TN document type is EDIINT MDN and the user status is SendMDNMsg. The EDIINT Send MDN Message processing rule performs the Execute a Service action to invoke the wm.EDIINT.rules:sendMDN service.

The wm.EDIINT.rules:sendMDN service determines what type of MDN the sender has requested (synchronous or asynchronous) and then sends the MDN accordingly. If the sender requested a synchronous MDN, the wm.EDIINT.rules:sendMDN service returns a synchronous MDN to the sender using the same HTTP connection. If the sender requested an asynchronous MDN, the wm.EDIINT.rules:sendMDN service invokes wm.EDIINT.delivery:deliveryDocument service to send an asynchronous MDN as a separate transaction.

22

webMethods EDIINT Module Users Guide Version 6.5

Run-Time Processing With EDIINT AS3

Run-Time Processing With EDIINT AS3

To exchange AS3 messages with a trading partner, you use an FTP server that is located either on your system or on your trading partners system. You use just one FTP server. The partner with the FTP server is referred to as the host partner. The partner who accesses the host partners FTP server is referred to as the client partner. To retrieve the AS3 messages or files, the client partner needs to log in remotely as an FTP client. To enable the partners to exchange AS3 messages, the host partner must provide the client partner with a particular set of specifications known as a choreography. The AS3 term choreography refers to the actions that occur between a client and an FTP server, and the FTP commands that enable those actions to occur. The choreography describes the means for delivering, retrieving, and deleting AS3 messages. It includes information on how an upload is communicated to the server as finished and available for a trading partner to download, such as renaming the file extension. In addition, it states whether the partner who downloads the message must send a delete command to clean up the file, or whether the message is removed through other means within the server. There are three categories of actions: Server logon actions (secure or un-secure) The EDIINT Module utilizes the secure FTP support provided by the Integration Server. Using this support, clients connect to remote FTP servers using Secure Sockets Layer (SSL). Document upload and download actions. MDN upload and download actions. Each partner must specify the choreography information in a Trading Partner Agreement (TPA), as described in Creating Trading Partner Agreements (TPAs) For AS3 Support on page 37.

webMethods EDIINT Module Users Guide Version 6.5

23

CHAPTER 1 Concepts

Run-Time Processing For Host Partners

If you are a host partner (the partner with the FTP server on your Integration Server), you will send and retrieve AS3 messages as follows:

Host Partner Sending an AS3 Message to a Client Partner

1 2 The host partner invokes the wm.EDIINT:send service, which creates an AS3 message and uploads it to the userFtpRoot\userhome\AS3\inbox directory on the FTP server. The client partner logs in to the host partners FTP server and retrieves the message from the host partners userFtpRoot\userhome\AS3\inbox directory. The client partner can optionally delete the message.

Host Partner Retrieving an AS3 Message or MDN from a Client Partner

1 2 3 The client partner logs in to the host partners FTP server and uploads the AS3 message or MDN to the host partners userFtpRoot\userhome\AS3\outbox directory. EDIINT submits the AS3 message or MDN to Trading Networks to be processed. EDIINT places an MDN response message (if the TPA specifies it) in the host partners userFtpRoot\userhome\AS3\inbox directory.

Run-Time Processing For Client Partners

If you are a client partner (the partner accessing a remote FTP server on an Integration Server), you will send and retrieve AS3 messages as follows:

Client Partner Sending an AS3 Message to the Host Partner

1 2 The client partner invokes the wm.EDIINT:send service, which creates an AS3 message and uploads it to the host partners FTP server. The host partner processes the AS3 message and puts an MDN (if the TPA specifies it) on the host partners FTP server.

Client Partner Retrieving an AS3 Message or MDN from the Host Partner
1 The client partner invokes the wm.EDIINT:retrieveAS3Message service, which logs in to the host partners FTP server and downloads the AS3 message or MDN. EDIINT deletes the message if the TPA specifies it. EDIINT submits the AS3 message or MDN to Trading Networks to be processed. If the TPA requires an MDN response message, EDIINT logs in to the FTP server and uploads the MDN to the host partners FTP server.

2 3

For information about configuring your system to support EDIINT AS3, see Configuring Your System To Support EDIINT AS3 on page 37.

24

webMethods EDIINT Module Users Guide Version 6.5

Using a Business Process to Send Outbound EDIINT Documents

Using a Business Process to Send Outbound EDIINT Documents

You can design a process model that waits for a document that you want to send using the EDIINT transport. You can assign a conversation ID to the outbound EDIINT document. When its corresponding MDN is returned, the EDIINT Module assigns the MDN the same conversation ID, so the MDN can rejoin the conversation.
Sample process model that waits sends an EDIINT document and receives the corresponding MDN

Step
1 2

Description The business process waits for a document, for example, from a back-end system. This is the document that you want to send using EDIINT. The next step in the business process is to form an EDIINT document with the back-end system document as the payload, and send the EDIINT document to the trading partner. The step invokes the wm.EDIINT:send service to package the back-end system document as the payload of an EDIINT document. The ConversationID input parameter to the wm.EDIINT:send service is set to define the value to use for the conversation ID. It should be the same conversation ID that the back-end system document used. The trading partner responds with an MDN. The EDIINT Module sets the conversation ID of the MDN to the value specified for the ConversationID input parameter in the preceding step. As a result, the MDN rejoins the correct business process.

webMethods EDIINT Module Users Guide Version 6.5

25

CHAPTER 1 Concepts

26

webMethods EDIINT Module Users Guide Version 6.5

CHAPTER

Before You Can Transport Documents Using EDIINT

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Including EDIINT Information in Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Configuring SMTP Settings to Enable EDIINT Message Exchange . . . . . . . . . . . . . . . . . . . 35 Configuring Your System To Support EDIINT AS3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Configuring Whether Trading Networks Is To Process Payloads . . . . . . . . . . . . . . . . . . . . . 46

webMethods EDIINT Module Users Guide Version 6.5

27

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

Overview
Before you can transport EDI or non-EDI documents using the EDIINT transport, perform the tasks listed below: Ensure that the partner profiles for senders and receivers contain the information that the EDIINT Module requires, as described in Including EDIINT Information in Profiles on page 28. If you want to use EDIINT AS1 (SMTP), or if you want to use EDIINT AS2 and have partners send MDNs via SMTP, configure the SMTP settings to enable the EDIINT Module to send and receive EDIINT documents via SMTP, as described in Configuring SMTP Settings to Enable EDIINT Message Exchange on page 35. If you want to use EDIINT AS3 (FTPS), configure your system as described in Configuring Your System To Support EDIINT AS3 on page 37. Note: If you use HTTP, HTTPS, or FTPS, see the webMethods Integration Server Administrators Guide or the webMethods Integration Server Administrators Online Help for instructions about how to add a port. No EDIINT-specific settings are required to add an HTTP, HTTPS, or FTPS port. If you want the EDIINT Module to send the payload of the document to Trading Networks for further processing, configure the EDIINT Module appropriately, as described in Configuring Whether Trading Networks Is To Process Payloads on page 46.

Including EDIINT Information in Profiles

To use the EDIINT transport when exchanging documents between partners (senders and receivers), the partners profiles in Trading Networks must contain EDIINT information that the EDIINT Module requires. To modify profiles to include EDIINT information For steps to create or modify profiles, see the chapter about partner profiles in the webMethods Trading Networks Users Guide. The following sections identify the specific information that you supply on each tab of the profile to use the EDIINT transport. The sections do not include all profile tabs or all fields on the tabs. See the webMethods Trading Networks Users Guide for descriptions of profile fields that are not listed in the sections below.

28

webMethods EDIINT Module Users Guide Version 6.5

Including EDIINT Information in Profiles

Corporate Tab of the Profile

Provide values for the following fields on the Corporate tab: Corporate Tab field External ID Type and Value Description Select all versions of the EDIINT standard that the partners corporation uses: EDIINT AS1, EDIINT AS2, and/or EDIINT AS3. You may also select any number of other external ID types, such as User Defined. Then, for each selected external ID type, specify a value to identify the partner. You may assign the same external ID value for multiple external ID types within the same profile. For example, if the partner uses EDIINT AS2 and EDIINT AS3, you can specify the same identification value for both types. The external ID type and its value correspond to the values in the EDIINT document headers From and To (for AS1), AS2From and AS2-To (for AS2), and AS3-From and AS3-To (for AS3).

Behavior of External ID Matching

The external ID types EDIINT AS1, EDIINT AS2, and EDIINT AS3 are new as of version 6.5 of the webMethods EDIINT Module. If you used a version of the EDIINT Module prior to version 6.5 and you want to use your existing profiles, you have two options: Update your existing profiles so they use the external ID types EDIINT AS1, EDIINT AS2, or EDIINT AS3 instead of the existing external ID types. For details, see Updating Your Existing Profiles to Use EDIINT AS1, EDIINT AS2, and EDIINT AS3 on page 29. -ORIf you want to continue using the external ID types of your existing profiles without having to change your existing profiles, turn off the new EDIINT ID Match option to make the EDIINT Module behave as it did prior to version 6.5. For details, see Using the EDIINT ID Match Option on page 30. Important! You must either update your existing profiles or turn off the EDIINT ID Match option. Otherwise, you may get unpredictable results when trying to match external IDs. Updating Your Existing Profiles to Use EDIINT AS1, EDIINT AS2, and EDIINT AS3 Prior to version 6.5, the EDIINT Module only looked at the external ID value in order to find a matching profile when sending or receiving documents; it ignored the external ID type. Thus, each external ID value was required to be unique; a value could not be duplicated within a single profile or in any other profile.

webMethods EDIINT Module Users Guide Version 6.5

29

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

With version 6.5, the EDIINT Module looks at both the external ID value and the external ID type in order to find a matching profile. This means you may assign the same external ID value for multiple external ID types within the same profile or in any other profile (or the values may be unique). By default, when you send an EDIINT document the wm.EDIINT:send service tries to match the documents To header (for example, AS2-To: 987654321) with the external ID type and value defined in a partner profile (for example, EDIINT AS2 and 987654321). Similarly, when you receive an EDIINT document the wm.EDIINT:receive service tries to match the value of its sender ID input parameter (which specifies both type and value) with a partner profiles external ID type and value. Important! If you use the EDIINT AS1, EDIINT AS2, or EDIINT AS3 types in your profiles, make sure the EDIINT ID Match option is selected (this is the default). If you turn off this option, you may get unpredictable results when trying to match external IDs. For details, see Using the EDIINT ID Match Option on page 30. Using the EDIINT ID Match Option If you do not want to use the external ID types EDIINT AS1, EDIINT AS2, or EDIINT AS3 in your profiles, turn off the EDIINT ID Match option. Otherwise, leave this option turned on. If you fail to set this option appropriately, you may get unpredictable results when trying to match external IDs. For example, if you define a profile with three external ID types that have identical values as follows: External ID type EDIINT AS2 EDIINT AS3 User Defined Value 987654321 987654321 987654321

and you send an EDIINT document with the following headers:

AS2-From: 123456789 AS2-To: 987654321

the EDIINT ID Match option controls the external ID matching as follows: When EDIINT ID Match is ... On Off The matching external ID ... Is EDIINT AS2. Could be either any of the three IDs; you cannot predict which one will match.

30

webMethods EDIINT Module Users Guide Version 6.5

Including EDIINT Information in Profiles

To set the EDIINT ID Match option 1 2 Open the Server Administrator if it is not already open. In the Solutions menu of the navigation panel, click EDIINT. The Server Administrator opens a new browser window to display the EDIINT Module home page. 3 4 In the navigation panel of the EDIINT Module home page, click Configuration. Selecting or clearing the EDIINT ID Match check box causes the following behavior: If EDIINT ID Match option is ... On (default) Off Then the EDI Module tries to match ... Both the external ID value and the external ID type. Only the external ID value.

Delivery Method Tab of the Profile

On the Delivery Method tab, specify the delivery methods that EDIINT requires. The wm.EDIINT:send service uses the information that you specify on this tab to send outbound EDIINT messages and MDNs. If you are using... EDIINT AS1 Description Specify at least one of the following delivery methods: 1) Primary E-mail, 2) Secondary E-mail. Note: You must define the delivery method in both the sender and receiver profiles. The e-mail address in the senders profile is used for the From address and the e-mail address in the receivers profile is used for the delivery e-mail address (To). EDIINT AS2 Specify at least one of the following delivery methods: 1) Primary HTTP, 2) Secondary HTTP, 3) Primary HTTPS, 4) Secondary HTTPS.

Note: EDIINT AS3 is an available delivery method as well. For details, see Configuring Your System To Support EDIINT AS3 on page 37.

webMethods EDIINT Module Users Guide Version 6.5

31

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

Extended Fields Tab of the Profile

The following table lists the Extended Fields tab fields you should supply for EDIINT. Extended Fields Tab field AS1MDNURL

Description If you are using EDIINT AS1, use this field to specify the e-mail address that is to accept inbound AS1 EDIINT MDNs. For example, receiver@company.com. An inbound AS1 MDN is by definition asynchronous because it is not returned using the same connection as that of the originally sent document.

AS2MDNURL

If you are using EDIINT AS2, specify the URL that is to accept inbound AS2 EDIINT MDNs. To accept MDNs via HTTP, specify a URL that includes the /invoke/ element to invoke the wm.EDIINT:receive service. For example (where host:port would be an actual host and port number):
http://host:port/invoke/wm.EDIINT/receive

To accept AS2 MDNs via SMTP, specify a URI similar to the following:
mailto:receiver @company.com

An inbound AS2 MDN could be synchronous (HTTP only) or asynchronous (SMTP or HTTP). A synchronous MDN is returned using the same HTTP connection as that of the originally sent document. FTPUserName If you are using EDIINT AS3 and you are the hosting partner (that is, your partner will access your FTP server), specify your partners user name so that EDIINT can place AS3 messages and MDNs in the userFtpRoot\username\AS3\inbox directory. Your partner will download the messages and MDNs from this directory. For more information about the inbox directory, see Creating Directories For Uploading/Downloading on page 37. Specify the encryption option to use for outbound EDIINT messages. The default value is Triple DES. The choices include TripleDES, DES, RC2 40 (40 bits), RC2 64 (64 bits), and RC2 128 (128 bits).

Encryption Algorithm

32

webMethods EDIINT Module Users Guide Version 6.5

Including EDIINT Information in Profiles

Extended Fields Tab field S/MIME Type

Description The S/MIME type to use for payloads sent and received by the trading partner. You can specify one of the following values:
plain, which means payloads are neither signed nor

encrypted.
signed, which means payloads are signed. encrypted, which means payloads are encrypted. signedAndEncrpted, which means payloads are signed and

encrypted. This is the default. For more information about how the S/MIME Type extended profile field is used during inbound processing, see How the S/MIME Type Profile Field Affects Processing Payloads on page 59 in Chapter 4, Processing Inbound EDIINT Documents and MDNs. For more information about how the S/MIME Type extended profile field is used during outbound processing, see Setting the S/MIME Type of the Outbound EDIINT Document on page 64 in Chapter 5, Using EDIINT to Deliver Outbound Documents.

webMethods EDIINT Module Users Guide Version 6.5

33

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

Security Tab of the Profile

The following table lists the information that you should supply for EDIINT on the Security tab of the profile. Subtabs on the Security Tab Sign/Verify

Description If you want the EDIINT Module to be able to digitally sign outbound EDIINT documents, specify the certificates for your corporation along with your private key on the Sign/Verify tab of the profile. You can set up a default signing certificate information in the Enterprise profile. If you need to use a specific certificate to sign outbound documents for a particular partner, specify the certificate information on the Sign/Verify tab of that partners profile. If you expect to receive from a partner, an EDIINT document with a digital signature, and you want the EDIINT Module to be able to verify the digital signature, specify verify certificates on the Sign/Verify tab in the partners profile. You specify the certificates for your partners corporation.

Decrypt/Encrypt

If you expect to receive encrypted EDIINT documents from partners, specify the certificates for your corporation along with your private key that you need to use to decrypt the documents on the Decrypt/Encrypt tab of the profile. You can set up default decrypting certificate information in the Enterprise profile. If you need to use a specific certificate to decrypt inbound documents from a particular partner, specify the certificate information on the Decrypt/Encrypt tab of that partners profile. If you want the EDIINT Module to be able to encrypt outbound EDIINT documents for a partner, specify encrypt certificates on the Decrypt/Encrypt tab in the partners profile. You specify the certificates for your partners corporation.

34

webMethods EDIINT Module Users Guide Version 6.5

Configuring SMTP Settings to Enable EDIINT Message Exchange

Configuring SMTP Settings to Enable EDIINT Message Exchange

To allow the EDIINT Module to receive and send documents using SMTP, you must configure inbound (for receiving) and outbound (for sending) SMTP settings. You must configure these settings if: You want to use EDIINT AS1. You want to use EDIINT AS2 and have partners send MDNs via SMTP. Important! Check your mailbox settings for message size limitations that could adversely affect your ability to receive or send large EDIINT documents.

Configuring Inbound EDIINT SMTP Settings

To receive an inbound EDIINT message or MDN via SMTP, use these general guidelines. To configure your system to be able to receive inbound EDIINT documents via SMTP 1 2 Set up an e-mail account with an e-mail service provider that supports either the POP3 or IMAP protocols. From the Server Administrator, add a webMethods/Email port that corresponds to the e-mail host that you established in the previous step. For instructions about how to add a port, see either the webMethods Integration Server Administrators Guide or the webMethods Integration Server Administrators Online Help. The following table lists information you should specify when adding the port: In this section of the screen... Package

For this field... Package Name

Specify... Either WmEDIINT or WmRoot. Specify EDIINT if you want the port disabled when the WmEDIINT package is disabled. Specify WmRoot if you want the port available whenever the server is running.

Server Information

all fields

Information about the e-mail host that you established in the previous step.

webMethods EDIINT Module Users Guide Version 6.5

35

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

In this section of the screen... Security

For this field... Require authorization within message Run services as user

Specify...
No

A user account with administrator authority, e.g., Administrator.

wm.EDIINT:receive

Message Processing

Global Service Default service Invoke service for each part of multipart message Include email headers when passing message to content handler

leave blank
No

Yes

Note: The EDIINT Module does not use the fields in the Message Processing section of the screen that are not listed in the table above. Leave the fields set to their default values. 3 4 Enable the port. Edit the ports Access Mode and click Set Access Mode to Allow by Default.

Configuring Outbound EDIINT SMTP Settings

To send outbound EDIINT documents or MDNs via SMTP, you must configure the name of the SMTP server you want to use for outbound EDIINT documents. You only need to perform this procedure if you want to use EDIINT AS1. To enable outbound EDIINT SMTP transport 1 2 3 4 5 Open the Server Administrator if it is not already open. In the Solutions menu of the navigation panel, click EDIINT. The Server Administrator opens a new browser window to display the EDIINT Module home page. In the navigation panel of the EDIINT Module home page, click Configuration. In the SMTP Server field, type the name of your SMTP server. Click Save Changes.

36

webMethods EDIINT Module Users Guide Version 6.5

Configuring Your System To Support EDIINT AS3

Note: You can also make this change by directly editing the wm.EDIINT.SMTPHost property in the properties.cnf file in the following location:
webMethods6\IntegrationServer\packages\WmEDIINT\config

After you make changes to the properties.cnf file, you must restart the server.

Configuring Your System To Support EDIINT AS3

Configuring your system to support EDIINT AS3 involves: Creating Directories For Uploading/Downloading on page 37 Creating Trading Partner Agreements (TPAs) For AS3 Support on page 37

Creating Directories For Uploading/Downloading

The host partner must create the following directories in the Integration Server, under the userFtpRoot directory, which is the default FTP root directory that the Integration Server creates at startup. userFtpRoot\userhome\AS3 where userhome is the users FTP home directory. Note: To rename the default userFtpRoot directory, use the Integration Server configuration parameter watt.server.userFtpRoot. For details, see the webMethods Integration Server Administrators Guide. Then the host partner must create the following directories under the AS3 directory: userFtpRoot\userhome\AS3\inbox The directory from which the host partner will download AS3 messages. userFtpRoot\userhome\AS3\outbox The directory to which the host partner will upload AS3 messages.

Creating Trading Partner Agreements (TPAs) For AS3 Support

A Trading Partner Agreement (TPA) in Trading Networks is a set of parameters that you can use to govern how documents are exchanged between two trading partners. One partner fulfills the sender role during document exchange, and the other partner fulfills the receiver role. Both the sender and receiver in a TPA must be a partner in your Trading Networks system that has an existing profile.

webMethods EDIINT Module Users Guide Version 6.5

37

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

Each TPA must specify a unique combination of the following: A partner that represents the originator of a send or retrieve operation The partner of the originator The Agreement ID (the type of the TPA). Use the predefined Agreement ID named EDIINTAS3 to support AS3 message exchange. You might have multiple TPAs for a pair of trading partners. For example, if PartnerA is the originator of a send or retrieve operation, you would define the following TPA: TPA field Sender Receiver Agreement ID (type of TPA) Value PartnerA PartnerB EDIINTAS3

Conversely, if PartnerB is the originator of a send or retrieve operation, you would define the following TPA: TPA field Sender Receiver Agreement ID (type of TPA) Value PartnerB PartnerA EDIINTAS3

You define TPAs on the Agreement Details screen of the Trading Networks Console, as described below. To define a TPA 1 2 3 Start the Trading Networks Console. If you need procedures for this step, see the webMethods Trading Networks Users Guide. Select View Agreements. Trading Networks displays the Agreements screen.

Perform one of the following procedures to create a new TPA. Method to create a TPA NewThe TPA fields are empty. Procedure Select Agreements New. Trading Networks displays the Agreement Details screen to allow you to fill in the information for the TPA.

38

webMethods EDIINT Module Users Guide Version 6.5

Configuring Your System To Support EDIINT AS3

Method to create a TPA DuplicateThe TPA fields are filled with values from the TPA agreements that you duplicate. You can update any or all fields from the duplicated TPA agreement. You can use this function to create a template TPA. 4

Procedure a b Click the row containing the name of the TPA agreement that you want to duplicate. Select Agreements Duplicate. Trading Networks displays the Agreement Details screen.

Fill in the following fields on the Agreement Details screen for the TPA you want to create:

Note: The Sender, Receiver, and Agreement ID fields must be unique for each TPA. The values of these three fields together uniquely identify a TPA. After you create a TPA, you cannot change or update these fields of the TPA. For this TPA field... Sender Specify Name of the trading partner that has the originator role in the transaction that the TPA will govern. Type in the name of the partner or click the Select... button to select the partner from the Partner Selection Dialog. This list includes your own profile (Enterprise). For EDI, to create a template that you will duplicate to create other TPAs, you can use the default value of Unknown. Receiver Name of the trading partner that receives the send or retrieve operations from Sender. Type in the name of the partner or click the Select... button to select the partner from the Partner Selection Dialog. This list includes your own profile (Enterprise). For EDI, to create a template that you will duplicate to create other TPAs, you can use the default value of Unknown. Agreement ID Specify the Agreement ID EDIINTAS3, which indicates that the type of agreement between the two partners is an AS3 agreement using EDIINT. Note: You will not be able to continue creating a TPA unless you specify the Agreement ID.

webMethods EDIINT Module Users Guide Version 6.5

39

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

For this TPA field... IS Document Type

Specify Specify the IS document type wm.EDIINT.TPA:EDIINTAS3. This IS document type defines the application-specific TPA data. The TPA data is used to govern the exchange of documents between the two partners. Alternatively, click Find IS Document Type to browse the IS document types and select it. Trading Networks displays the data tree input values of the selected IS document type in the bottom panel of the Agreement Details screen. The right side of this panel displays the input values (TPA data inputs) to variables of the IS document type.

Control Number Data Status

Accept the default value zero (0) or leave blank; EDIINT does not use this field. Whether you want to be able to modify the values of the TPA data of the IS document type. The data status is only applicable when the agreement status is Agreed. Leave blank; EDIINT does not use this field. Specify the service wm.EDIINT.TPA:initService. This service populates the inputs to the variables in the IS document type wm.EDIINT.TPA:EDIINTAS3 with default values. Type in the name of the initialization service located on the server or click Find Service the one you want to use. to browse the services and select

Export Service Initialization Service

Description

Optionally, specify a description for the TPA in the Description field. Specify 1-1024 characters. There is no restriction to the characters that you can use.

For more information about creating TPAs, see Chapter 10, "Trading Partner Agreements (TPAs)" of the webMethods Trading Networks Users Guide. 5 Click the Set Inputs icon and provide values for the following upload input parameters for the document type wm.EDIINT.TPA:EDIINTAS3: Description Indicates whether to upload/download AS3 messages to a remote or local FTP server. remote Upload/download AS3 messages to/from the remote FTP server in the FTPUpload and FTPDownload fields.

Upload Parameter AS3FTPServerLocation

40

webMethods EDIINT Module Users Guide Version 6.5

Configuring Your System To Support EDIINT AS3

Upload Parameter

Description local Upload/download AS3 messages to/from the local FTP server. No other TPA fields will be used.

uploadService serverhost serverport dataport username password account

Always select the wm.EDIINT.delivery.defaultFTPUpload service, which uploads AS3 files. Name or IP address of the FTP server. Port number on which the FTP server listens for requests. Default: 21. Optional. Listener port number of the data transfer channel, for example, 3345. FTP user on the remote FTP server. Password for the user specified in username. Optional. The user name for an account on the FTP server. Specify a value if your FTP host requires account information. The account is defined in the FTP protocol to further identify the user and password specified in username and password. Specifies the type of the FTP data transfer mode: active Default. Active FTP data transfer mode. passive Passive FTP data transfer mode.

transfertype

encoding

Optional. Default character set for encoding data transferred during this session. Specify an IANA-registered character set, for example, ISO-8859-1. If you do not set encoding, the default JVM encoding is used. Optional. Time (measured in seconds) to wait for a response from the FTP server before timing out and terminating the request. The default is to wait forever. Type of the remote FTP server to connect to. Specifies whether to protect the FTP data channel. true Protect the FTP data channel. false Do not protect the FTP data channel.

timeout

secureFTP securedata

auth

Authentication/security mechanism: SSL TLS TLS-P

webMethods EDIINT Module Users Guide Version 6.5

41

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

Upload Parameter dirpath

Description Optional. The directory path to which AS3 messages are uploaded. If you do not specify a directory path, the current directory will be used. Optional. The file extension to be assigned to the uploaded AS3 message file, for example, msg. AS3 message file names are generated using the following naming convention:
MMddhhmmSSss

fileExtension

where MM is month, dd is day, hh is hour, mm is minutes, and SSss is seconds. For example, a generated file name with the extension msg might be 122012002222.msg. renameTo Optional. After uploading the AS3 message file, move it to a specified directory, and optionally rename their file extension. For example, if your FTP put command places the AS3 file in the tmp directory, and you want to move it to the outbox directory after uploading it, specify this command in the renameTo field:
/outbox/*

The wildcard character * is a placeholder for the file name. If you specified a file extension in the fileExtension field (for example, msg), you would specify this command in the renameTo field:
/outbox/*.msg

Optionally, you can rename the file extension in this field as well. MDNDirpath MDNFileExtension Optional. The directory to which MDNs are uploaded. Optional. The file extension to be assigned to the uploaded MDN file, for example, mdn. MDN file names are generated using the following naming convention:
MMddhhmmSSss

where MM is month, dd is day, hh is hour, mm is minutes, and SSss is seconds. For example, a generated file name with the extension mdn might be 122012002222.mdn.

42

webMethods EDIINT Module Users Guide Version 6.5

Configuring Your System To Support EDIINT AS3

Upload Parameter MDNRenameTo

Description Optional. After uploading the MDN files, move it to a specified directory, and optionally rename its file extension. For example, if your FTP put command places the MDN file in the tmp directory, and you want to move it to the outbox directory after uploading it, specify this command in the renameTo field:
/outbox/*

The wildcard character * is a placeholder for the file name. If you specified a file extension in the fileExtension field (for example, mdn), you would specify this command in the renameTo field:
/outbox/*.mdn

Optionally, you can rename the file extension in this field as well. storeUnique transfermode Optional. EDIINT assigns a unique file name after the file is uploaded. Specifies the type of the FTP file transfer mode: binary (required for AS3) ascii

Scroll down and provide values for the following download input parameters for wm.EDIINT.TPA:EDIINTAS3: Description Always select the wm.EDIINT.delivery.defaultFTPDownload service, which downloads AS3 files. Name or IP address of the FTP server. Port number of the FTP server. Default: 21. Optional. Listener port number of the data transfer channel, for example, 3345. FTP user on the remote FTP server. Password for the user specified in username.

Download Parameter downloadService serverhost serverport dataport username password

webMethods EDIINT Module Users Guide Version 6.5

43

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

Download Parameter account

Description Optional. The user name for an account on the FTP server. Specify a value if your FTP host requires account information. The account is defined in the FTP protocol to further identify the user and password specified in username and password. Specifies the type of the FTP data transfer mode: active Default. Active FTP data transfer mode. passive Passive FTP data transfer mode.

transfertype

encoding

Optional. Default character set for encoding data transferred during this session. Specify an IANA-registered character set, for example, ISO-8859-1. If you do not set encoding, the default JVM encoding is used. Optional. Time (measured in seconds) to wait for a response from the FTP server before timing out and terminating the request. The default is to wait forever. Type of the remote FTP server to connect to. Specifies whether to protect the FTP data channel. true Protect the FTP data channel. false Do not protect the FTP data channel.

timeout

secureFTP securedata

auth

Authentication/security mechanism: SSL TLS TLS-P

dirpath

Optional. The directory path to which AS3 messages are downloaded. If you do not specify a directory path, the current directory will be used. Optional. AS3 message file pattern, for example, *.msg. Optional. The directory to which MDNs are downloaded. You can specify either the path relative to dirpath or the absolute path. Optional. MDN message file pattern, for example, *.mdn. Indicates whether the file is to be deleted after downloading it.

filenamepattern MDNDirpath

MDNFilenamepattern deleteFile

44

webMethods EDIINT Module Users Guide Version 6.5

Configuring Your System To Support EDIINT AS3

Download Parameter transfermode

Description Specifies the type of the FTP file transfer mode: binary (required for AS3) ascii

Click OK to create the TPA.

webMethods EDIINT Module Users Guide Version 6.5

45

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

Configuring Whether Trading Networks Is To Process Payloads

In addition to having the EDIINT Module perform transport-level processing for an entire inbound EDIINT document, you can perform further processing on the payload of the document by having the EDIINT Module send the payload to Trading Networks for separate processing. As installed, the EDIINT Module is configured to submit the payload to Trading Networks. When the EDIINT Module is configured to send the payload to Trading Networks, the EDIINT Module submits the payload after it completes transport-level processing. Use the EDI Module to process payloads that are EDI documents, that is payloads that have one of the following content types : 1) application/edi-X12, 2) application/EDIFACT, or 3) application/XML. If you want to have the EDIINT Module submit to Trading Networks payloads that have a different content type, you must provide your own service to process the payload and submit it to Trading Networks. To enable or disable Trading Networks payload processing 1 2 3 4 Open the Server Administrator if it is not already open. In the Solutions menu of the navigation panel, click EDIINT. The Server Administrator opens a new browser window to display the EDIINT Module home page. In the navigation panel of the EDIINT Module home page, click Configuration. Enable or disable the EDIINT Module to or from submitting payloads to Trading Networks by doing one of the following: To enable, select the Submit payload to TN check box. To disable, clear the Submit payload to TN check box. Note: You can also make this change by directly editing the wm.EDIINT.submitPayload property in the properties.cnf file in the following location:
webMethods6\IntegrationServer\packages\WmEDIINT\config

Specify either true (to enable) or false (to disable) the submitting of payloads to Trading Networks. After you make changes to the properties.cnf file, you must restart the server. 5 In the User Process Payload Service field, specify a service that you created to process payloads and submit them to Trading Networks. You only need to specify a service if: You selected the Submit payload to TN check box. -AND-

46

webMethods EDIINT Module Users Guide Version 6.5

Configuring Whether Trading Networks Is To Process Payloads

The content types of the inbound payloads are not one of the following: 1) application/edi-X12, 2) application/EDIFACT, or 3) application/XML. The service you specify in the User Process Payload Service field must accept the following input variables: Input Variable stream contentType EDIINTbizdoc Description InputStream The payload. String The content type of the payload. Document The bizdoc that contains the original EDIINT message. For the structure of EDIINTbizdoc, see the wm.tn.rec:BizDocEnvelope service in the webMethods Trading Networks Built-in Services Reference.

The EDIINT Module ignores your settings in the following situations: Conditions You select the Submit payload to TN check box. You specify a service in the User Process Payload Service field. -ANDThe inbound payload has a content type that is one of: 1) application/edi-X12, 2) application/EDIFACT, or 3) application/XML. You select the Submit payload to TN check box. You do not specify a service in the User Process Payload Service field. -ANDThe content type of the inbound payload is not one of: 1) application/edi-X12, 2) application/EDIFACT, or 3) application/XML. Behavior of the EDI Module The EDI Module ignores the service you specify in the User Process Payload Service field. When you select the Submit payload to TN check box, the EDIINT Module always uses the EDI Module to process payloads that have one of the following content types: 1) application/edi-X12, 2) application/EDIFACT, or 3) application/XML.

The EDIINT Module ignores the check in the Submit payload to TN check box. The EDIINT Module cannot submit a payload with an unsupported content type to Trading Networks. You must provide a service that submits payloads with unsupported content types.

webMethods EDIINT Module Users Guide Version 6.5

47

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

Conditions You clear the Submit payload to TN check box. -ANDYou specify a service in the User Process Payload Service field.

Behavior of the EDI Module The EDIINT Module ignores the service you specify in the User Process Payload Service field. The EDIINT Module only invokes a service you specify to submit payloads to Trading Networks when you select the Submit payload to TN check box.

Click Save Changes.

Note: For information about how to set up the EDI Module and Trading Networks to process EDI documents, see the webMethods EDI Module Users Guide.

Trading Networks Objects Provided for EDIINT

When you install the EDIINT Module, Trading Networks objects (i.e., TN document types, document attributes, extended profile fields, and processing rules) are installed in Trading Networks for you. This section describes the Trading Networks objects provided with the EDIINT Module. The information in this section about the Trading Networks objects is for reference only. You should not alter the definitions of any of the Trading Networks objects.

TN Document Types
The following table describes the TN document types provided for EDIINT processing and the document attributes associated with each. For more information about the document attributes, see Document Attributes below. TN document type name EDIINT Document attributes associated with the TN document type EDIINT Message Type EDIINT Message ID EDIINT Message Digest EDIINT Delivery URL

Description Trading Networks matches all EDIINT documents to this TN document type.

48

webMethods EDIINT Module Users Guide Version 6.5

Configuring Whether Trading Networks Is To Process Payloads

TN document type name EDIINT MDN

Description Trading Networks matches all EDIINT MDNs to this TN document type.

Document attributes associated with the TN document type EDIINT Message Type EDIINT Message ID EDIINT Delivery URL EDIINT MDN Original Message ID EDIINT MDN Received MIC EDIINT MDN Disposition

Document Attributes
The following table describes the document attributes provided for EDIINT processing. The TN document types described in TN Document Types above extract these attributes from the EDIINT documents and MDNs. Attribute name EDIINT Message Type Description The protocol that the EDIINT document uses: AS1, AS2, or AS3. The value of the EDIINT Message-ID header, which is also used for the value of the Trading Networks Document ID system attribute. The message digest calculated for the EDIINT document. The destination URL or IP address from the EDIINT document. The value of the EDIINT Message-ID header from the original EDIINT document for which the MDN is a receipt. The message digest calculated for the EDIINT MDN. The results from processing the original EDIINT document for which the MDN is a receipt. Extracted from EDIINT documents EDIINT MDNs EDIINT documents EDIINT MDNs EDIINT documents EDIINT documents EDIINT MDNs EDIINT MDNs

EDIINT Message ID

EDIINT Message Digest EDIINT Delivery URL

EDIINT MDN Original Message ID

EDIINT MDN Received MIC EDIINT MDN Disposition

EDIINT MDNs EDIINT MDNs

webMethods EDIINT Module Users Guide Version 6.5

49

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

Extended Fields
When you install the EDIINT Module, the EDIINT field group is added to the Trading Networks profiles. The EDIINT field group contains then following extended profile fields that are used for EDIINT processing. For more information about these extended profile fields, see Including EDIINT Information in Profiles on page 28. Extended profile field name AS1MDNURL AS2MDNURL Encryption Algorithm S/MIME Type Description The e-mail address that is to accept inbound AS1 MDNs. The URL that is to accept inbound AS2 MDNs. The level of encryption to apply to outbound EDIINT messages being sent to the partner. The S/MIME type to use for payloads sent and received by the trading partner.

Processing Rules
The EDIINT Module provides processing rules for EDIINT transport-level processing. If you want to do business-level processing on the payload of the EDIINT document, you need to: Configure EDIINT Module to submit the payload to Trading Networks. For instructions, see Configuring Whether Trading Networks Is To Process Payloads on page 46. Create your own processing rules to process the payloads. For information about creating processing rules, see the webMethods Trading Networks Users Guide. The following table describes the processing rules provided for EDIINT transport-level processing: Processing rule name EDIINT Process Message Description Trading Networks invokes this processing rule for inbound EDIINT documents. The EDIINT Process Message processing rule invokes wm.EDIINT.rules:processMsg service to process the inbound EDIINT document. For more information about the wm.EDIINT.rules:processMsg service, see Services Invoked by Processing Rules on page 51. Trading Networks invokes this processing rule for inbound EDIINT MDNs. The EDIINT Process MDN Message processing rule invokes wm.EDIINT.rules:processMDN service to process an inbound MDN message. For more information about the wm.EDIINT.rules:processMDN service, see Services Invoked by Processing Rules on page 51.

EDIINT Process MDN Message

50

webMethods EDIINT Module Users Guide Version 6.5

Configuring Whether Trading Networks Is To Process Payloads

Processing rule name EDIINT Send Message

Description Trading Networks invokes this processing rule for outbound EDIINT documents. The EDIINT Send Message processing rule invokes the wm.EDIINT.rules:sendMsg service to initiate the sending of an outbound EDIINT document. For more information about the wm.EDIINT.rules:processMDN service, see Services Invoked by Processing Rules on page 51. Trading Networks invokes this processing rule for outbound EDIINT MDNs. The EDIINT Send MDN Message processing rule invokes wm.EDIINT.rules:sendMDN service to initiate the sending of an outbound EDIINT MDN message. For more information about the wm.EDIINT.rules:processMDN service, see Services Invoked by Processing Rules on page 51.

EDIINT Send MDN Message

Important! You should not modify or customize these processing rules in any way. Services Invoked by Processing Rules The following table describes the services that are invoked by the processing rules described in Processing Rules above. All services are located in the wm.EDIINT.rules folder except for deliveryDocument, which is located in the wm.EDIINT.delivery folder. Invoked by this processing rule EDIINT Process Message EDIINT Process Message

Service processMsg processPayload

Description Processes an inbound EDIINT document. Processes the payload of an EDIINT document. If you configure the EDIINT Module to process payloads, the wm.EDIINT.rules:processMsg service invokes this service to submit the payload to Trading Networks. For more information about configuring EDIINT Module to process payloads, see Configuring Whether Trading Networks Is To Process Payloads on page 46.

webMethods EDIINT Module Users Guide Version 6.5

51

C H A P T E R 2 B e f o r e Yo u C a n T r a n s p o r t D o c u m e n t s U s i n g E D I I N T

Service processMDN sendMsg sendMDN deliveryDocument

Description Processes an inbound EDIINT MDN. Initiates the sending of an outbound EDIINT document. Initiates the sending of an outbound EDIINT MDN document. Sends an outbound EDIINT document or MDN. The wm.EDIINT.rules:sendMDN and the wm.EDIINT.rules:sendMsg services invoke this service.

Invoked by this processing rule EDIINT Process MDN Message EDIINT Send Message EDIINT Send MDN Message EDIINT Send Message -ANDEDIINT Send MDN Message

52

webMethods EDIINT Module Users Guide Version 6.5

CHAPTER

Creating a Client to Submit a Document Using EDIINT

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Content Types to Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Setting the Input Variables for the wm.EDIINT:send Service . . . . . . . . . . . . . . . . . . . . . . . . . 54

webMethods EDIINT Module Users Guide Version 6.5

53

CHAPTER 3 Creating a Client to Submit a Document Using EDIINT

Introduction
The EDIINT standard requires the documents you send using the EDIINT transport be packaged in a specific way. If your client is running on the Integration Server that has the webMethods EDIINT Module installed, the client should invoke the wm.EDIINT:send service to package the document correctly and send it. If you are not using webMethods software for the client, see the documentation for the EDIINT software you are using to determine how to correctly package and send documents. This chapter describes how to create a client using the wm.EDIINT:send service of the EDIINT Module. Note: You can use the wm.EDIINT:send service to send both EDI documents and non-EDI documents.

Content Types to Use

You can use any of the EDIINT content types listed below. These content types are for both EDIINT documents and MDNs. multipart/signed multipart/report message/disposition-notification application/pkcs7-signature application/pkcs7-mime application/edi-X12 application/EDIFACT application/XML

Setting the Input Variables for the wm.EDIINT:send Service

The client should invoke the wm.EDIINT:send service to correctly package a document for EDIINT transport. For the list of input variables that the client should set for the wm.EDIINT:send service, see Chapter 7, webMethods EDIINT Module Services.

54

webMethods EDIINT Module Users Guide Version 6.5

CHAPTER

Processing Inbound EDIINT Documents and MDNs

Processing Inbound EDIINT Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Processing Inbound EDIINT MDNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

webMethods EDIINT Module Users Guide Version 6.5

55

CHAPTER 4 Processing Inbound EDIINT Documents and MDNs

Processing Inbound EDIINT Documents

The webMethods EDIINT Module (EDIINT Module) provides the wM.EDIINT:receive service as the entry point for inbound EDIINT documents. That is, clients that send EDIINT documents must invoke the wM.EDIINT:receive service. For more about creating a client that sends EDIINT documents, see Chapter 3, Creating a Client to Submit a Document Using EDIINT. For EDIINT transport-level processing, you do not need to create or customize services. The EDIINT Module provides all the logic needed to perform transport-level processing. If you want to perform business-level processing on the payload of the EDIINT document, you will need to add your own logic to perform the business-level processing.

Before You Can Process Inbound EDIINT Documents

Define a profile for the sender and receiver of the EDIINT document. For instruction about how to create profiles, see the chapter about creating profiles in the webMethods Trading Networks Users Guide. For information about adding EDIINT information to profiles, see Including EDIINT Information in Profiles on page 28. If you want to process the payloads of the EDIINT documents, configure the EDIINT Module to submit the payloads to Trading Networks. For instructions, see Configuring Whether Trading Networks Is To Process Payloads on page 46.

56

webMethods EDIINT Module Users Guide Version 6.5

Processing Inbound EDIINT Documents

Example of an EDIINT Document Posted by HTTP

Content-type: multipart/signed; micalg=SHA-1; protocol="application/pkcs7signature"; boundary="----=_Part_0_409673203.1011470256738" Disposition-notification-to: http://Administrator:manage@localhost:5555/invoke/wm.EDIINT/receive Disposition-notification-options: signed-receipt-protocol=optional, pkcs7signature; signed-receipt-micalg=optional, SHA-1 AS2-From: 123456789 AS2-To: 987654321 Message-ID: <1687657971.1011470256928.JavaMail.zhouz@zhenzhou> Content-Length: 2534 ------=_Part_0_409673203.1011470256738 Content-Type: application/edi-x12 Content-Transfer-Encoding: binary ISA*00*ssssssssss*00*rrrrrrrrrr*ZZ*123456789 *ZZ*987654321 *961007*2013*U*00200*000000001*0*T** GS*PO*S1S1S1S1S1S1S1S*R1R1R1R1R1R1R1R*961007*2013*000000004*X*003050 ST*850*000040001 BEG*00*BE*2a*43324234v5523*961007*23tc4vy24v2h3vh3vh*ZZ*IEL*09*RE*09 ... SE*22*000040001 GE*1*000000004 IEA*1*000000001 ------=_Part_0_409673203.1011470256738 Content-Type: application/pkcs7-signature; name=smime.p7s Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename=smime.p7s MIAGCSqGSIb3DQEHAqCAMIACAQExCzAJBgUrDgMCGgUAMIAGCSqGSIb3DQEHAQAAMYIBuDCCAbQC AQEwXjBZMQswCQYDVQQGEwJVUzEXMBUGA1UEChMOd2ViTWV0aG9kcyBJbmMxDzANBgNVBAsTBlBE IEVESTEgMB4GA1UEAxMXRURJSU5UIHNhbXBsZSBTZW5kZXIgQ0ECAQEwCQYFKw4DAhoFAKCBsTAY BgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0wMjAxMTcyMDM4MDhaMCMGCSqGSI b3DQEJBDEWBBQKbJZgrh/bit8BFmv1fuaWf40PjzBSBgkqhkiG9w0BCQ8xRTBDMAoGCCqG SIb3DQMHMA4GCCqGSIb3DQMCAgIAgDANBggqhkiG9w0DAgIBQDANBggqhkiG9w0DAgIBKDAHBgUr DgMCBzANBgkqhkiG9w0BAQEFAASBgKRrXO1tX3oFfLTgJwuoWKhygMQzdyNpX1Z4xU7kjDqYS8gs yvaRSl0s7d4wA3N1CLGQUk87yRCFqoJPygrXyCI0kaGh1Ny61GxkPHuQ2cP54m11Wzgq9OGhaRba TJu8HWB1ETFBML+wIBGunkRcR3s5mEpxINmflEYNZlxmf78ZAAAAAAAA ------=_Part_0_409673203.1011470256738

Creating Outbound MDNs that Acknowledge Receipt of an EDIINT Document

For an inbound EDIINT document, Trading Networks executes the EDIINT Process Message processing rule, which in turn invokes the wm.EDIINT.rules:processMsg service. The wm.EDIINT.rules:processMsg service detects whether the sender of the EDIINT document requested an MDN. If the sender requested an MDN, the processMsg service determines whether the sender requested a signed or an unsigned MDN. The processMsg service creates the appropriate type of MDN and submits the MDN back to Trading Networks for delivery to the sender.

webMethods EDIINT Module Users Guide Version 6.5

57

CHAPTER 4 Processing Inbound EDIINT Documents and MDNs

To deliver the outbound EDIINT MDN, Trading Networks executes the EDIINT Send MDN Message processing rule, which in turn invokes the wm.EDIINT.rules:sendMDN service. The sendMDN service determines whether the sender requested a synchronous or asynchronous MDN. If the sender requested a synchronous MDN, the sendMDN service returns the MDN to the sender using the same HTTP connection. If the sender requested an asynchronous MDN, the sendMDN service invokes the wm.EDIINT.rules:deliveryDocument service to send the MDN as a separate transaction.

Setting Up to Process Payloads from EDIINT Documents

Do the following to perform business-level logic on the payloads of EDIINT documents. To perform business-level processing on the payloads of EDIINT documents 1 2 Configure the EDIINT Module to process payloads. For instructions, seeConfiguring Whether Trading Networks Is To Process Payloads on page 46. Set the value of the S/MIME Type extended field in the senders profiles to specify the S/MIME type you expect inbound EDIINT documents to use. The EDIINT Module uses the S/MIME type you specify to determine whether to process the payload. For more information, see How the S/MIME Type Profile Field Affects Processing Payloads on page 59. For more information about setting up profiles for EDIINT, see Including EDIINT Information in Profiles on page 28. Set up Trading Networks to process the payload and perform the business-level logic. If the payload is an EDI document, see the webMethods EDI Module Users Guide for how to set up the EDI Module to process the EDI documents. If the payload is not an EDI document, you must: Define a TN document type for the payload. For instructions, see the chapter about TN document types in the webMethods Trading Networks Users Guide. Define a processing rule for the payload document. For instructions, see the chapter about processing rules in the webMethods Trading Networks Users Guide.

58

webMethods EDIINT Module Users Guide Version 6.5

Processing Inbound EDIINT Documents

How the S/MIME Type Profile Field Affects Processing Payloads

The EDIINT Module determines the S/MIME type used by the inbound EDIINT document, that is whether the inbound document is plain, signed, encrypted or signed and encrypted. The EDIINT Module then compares the S/MIME type of the inbound document with the value of the S/MIME Type extended profile field of the senders profile. The table below describes the actions the EDIINT Module takes based on the outcome of the comparison. Value of S/MIME Type extended profile field
plain signed

S/MIME type of the inbound document any value signed signed and encrypted plain encrypted

Action the EDIINT Module takes for the inbound document Processes the payload. Processes the payload. Logs an error message to the Trading Networks activity log and does not process the payload. Processes the payload. Logs an error message to the Trading Networks activity log and does not process the payload. Processes the payload. Logs an error message to the Trading Networks activity log and does not process the payload.

encrypted

encrypted signed and encrypted plain signed

signedAndEncrypted

signed and encrypted plain signed encrypted

webMethods EDIINT Module Users Guide Version 6.5

59

CHAPTER 4 Processing Inbound EDIINT Documents and MDNs

Processing Inbound EDIINT MDNs

The EDIINT Module provides the wM.EDIINT:receive service as the entry point for inbound EDIINT MDNs. That is, clients that send EDIINT MDNs must invoke the wM.EDIINT:receive service. For more about creating a client that sends EDIINT documents, see Chapter 3, Creating a Client to Submit a Document Using EDIINT. You do not need to create or customize services to process inbound EDIINT MDNs. The EDIINT Module provides all the logic needed to perform the processing.

Before You Can Process Inbound EDIINT MDNs

Define a profile for the sender and receiver of the EDIINT MDN. For instruction about how to create profiles, see the chapter about creating profiles in the webMethods Trading Networks Users Guide. For information about adding EDIINT information to profiles, see Including EDIINT Information in Profiles on page 28.

60

webMethods EDIINT Module Users Guide Version 6.5

Processing Inbound EDIINT MDNs

Example of an EDIINT MDN Posted by HTTP

AS2-From: 987654321 AS2-To: 123456789 Message-ID: <2038921766.1012252564086.JavaMail.zhenzhou@zhenzhou>Content-Type: multipart/signed; protocol="application/pkcs7-signature"; micalg=SHA-1; boundary="----=_Part_20_-1967424986.1012252564076" ------=_Part_20_-1967424986.1012252564076Content-Type: multipart/report; ReportType=disposition-notification; boundary="----=_Part_19_568293921.1012252564056" ------=_Part_19_568293921.1012252564056Content-Type: text/plainContent-TransferEncoding: 7bit MDN for Message ID: <128678451.1012252560430.JavaMail.zhenzhou@zhenzhou> From: 123456789 To: 987654321 Received on: 2002-01-28 at 16:16:04 (EST) Status: processed Comment: This is not a guarantee that the message has been completely processed or understood by the receiving translator ------=_Part_19_568293921.1012252564056Content-Type: message/dispositionnotificationContent-Transfer-Encoding: 7bit Reporting-UA: webMethods Integration ServerOriginal-Recipient: 987654321FinalRecipient: 987654321Original-Message-ID: <128678451.1012252560430.JavaMail.zhenzhou@zhenzhou>Received-content-MIC: qZvJD2+2H/OAQYa3+uIZUIyNUaw=, SHA-1Disposition: automatic-action/MDN-sentautomatically; processed ------=_Part_19_568293921.1012252564056-------=_Part_20_-1967424986.1012252564076Content-Type: application/pkcs7signature; name=smime.p7sContent-Transfer-Encoding: base64Content-Disposition: attachment; filename=smime.p7s MIAGCSqGSIb3DQEHAqCAMIACAQExCzAJBgUrDgMCGgUAMIAGCSqGSIb3DQEHAQAAMYIBujCCAbYCAQEwYD BbMQswCQYDVQQGEwJVUzEXMBUGA1UEChMOd2ViTWV0aG9kcyBJbmMxDzANBgNVBAsTBlBEIEVESTEiMCAG A1UEAxMZRURJSU5UIHNhbXBsZSBSZWNlaXZlciBDQQIBATAJBgUrDgMCGgUAoIGxMBgGCSqGSIb3DQEJAz ELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTAyMDEyODIxMTYwNFowIwYJKoZIhvcNAQkEMRYEFP0/ GE3KNoRkF6KUtnqDOm40bUxEMFIGCSqGSIb3DQEJDzFFMEMwCgYIKoZIhvcNAwcwDgYIKoZIhvcNAwICAg CAMA0GCCqGSIb3DQMCAgFAMA0GCCqGSIb3DQMCAgEoMAcGBSsOAwIHMA0GCSqGSIb3DQEBAQUABIGAJBb3 whwo+h0PsmEyPMXQHIpjFS5fa5w8PIipHQ9nfJVoTTbp5VTL4zT1E34vjESoktGBYmYnD+gTTe2aEB3PoI qCym25Lv2MZuvcSVNoa2hS4hrCnDwmYNqbFySlV2ZAqodgBElztd71eeIgnXLU1/R65gFOJw72Wto0xi8Q 930AAAAAAAA= ------=_Part_20_-1967424986.1012252564076--

webMethods EDIINT Module Users Guide Version 6.5

61

CHAPTER 4 Processing Inbound EDIINT Documents and MDNs

62

webMethods EDIINT Module Users Guide Version 6.5

CHAPTER

Using EDIINT to Deliver Outbound Documents

Before You Can Deliver Outbound EDIINT Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Setting the S/MIME Type of the Outbound EDIINT Document . . . . . . . . . . . . . . . . . . . . . . . 64 Using the wM.EDIINT:send Service to Send EDIINT Documents . . . . . . . . . . . . . . . . . . . . . 64

webMethods EDIINT Module Users Guide Version 6.5

63

CHAPTER 5 Using EDIINT to Deliver Outbound Documents

Before You Can Deliver Outbound EDIINT Documents

Define a profile for the sender and receiver of the EDIINT document. For instruction about how to create profiles, see the chapter about creating profiles in the webMethods Trading Networks Users Guide. For information about adding EDIINT information to profiles, see Including EDIINT Information in Profiles on page 28 in Chapter 2, Before You Can Transport Documents Using EDIINT.

Setting the S/MIME Type of the Outbound EDIINT Document

You can define the S/MIME type that you want the webMethods EDIINT Module (EDIINT Module) to use for an outbound EDIINT document; that is, whether you want to send the outbound EDIINT message: Without signing or encrypting (plain) Signing only (signed) Encrypting only (encrypt) Signing and encrypting (signedAndEncrypted) You specify the S/MIME type that you want the EDIINT Module to use by using one of the following: The type input variable to the wm.EDIINT:send service The S/MIME Type extended profile field and setting the type input variable to the wm.EDIINT:send service to getFromProfile. For more information about setting the S/MIME Type extended profile field, see Extended Fields Tab of the Profile on page 32 in Chapter 2, Before You Can Transport Documents Using EDIINT.

Using the wM.EDIINT:send Service to Send EDIINT Documents

The EDIINT Module provides the wM.EDIINT:send service to send EDIINT documents. This service performs all the necessary EDIINT transport-level processing. To use the wM.EDIINT:send service: Set the wm.EDIINT:send service input variables as necessary. You must create a java.io.InputStream from the EDI or XML data and pass it the input variable data/stream. For a description of key input variables, see Setting the Input Variables for the wm.EDIINT:send Service on page 54 in Chapter 3, Creating a Client to Submit a Document Using EDIINT. For a complete description of this service, see Chapter 7, webMethods EDIINT Module Services. Invoke the wm.EDIINT:send service from a service that you create.

64

webMethods EDIINT Module Users Guide Version 6.5

Using the wM.EDIINT:send Service to Send EDIINT Documents

Important! Do not invoke the wm.EDIINT:send service directly from the Trading Networks Execute a Service processing action. Doing so will produce processing errors. The service that you create to invoke the wm.EDIINT:send service can be invoked directly from the Execute a Service processing action.

webMethods EDIINT Module Users Guide Version 6.5

65

CHAPTER 5 Using EDIINT to Deliver Outbound Documents

66

webMethods EDIINT Module Users Guide Version 6.5

CHAPTER

Viewing and Managing Information about EDIINT Documents and MDNs

Using Trading Networks Console to View Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Resubmitting EDIINT Outbound Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

webMethods EDIINT Module Users Guide Version 6.5

67

CHAPTER 6 Viewing and Managing Information about EDIINT Documents and MDNs

Using Trading Networks Console to View Information

Because EDIINT documents and MDNs are processed through Trading Networks, the webMethods EDIINT Module (EDIINT Module) takes advantage of Trading Networks features. One of the features is to use the Trading Networks system attribute, User Status, to assign a user-defined status to a document. The EDIINT Module assigns statuses to EDIINT documents and MDNs as it processes the document. You can view the User Status associated with a document from the Transaction Analysis screen of the Trading Networks Console. For instructions on how to view information about documents using the Transaction Analysis screen, see the webMethods Trading Networks Users Guide. The following table describes the values of the User Status system attribute for EDIINT transport-level processing. Type Inbound EDIINT document User Status ProcessMsg ProcessMsg PAYLOAD Description The EDIINT document has been received and processing is starting. The EDIINT document was successfully processed. The EDIINT Module is configured to process payloads and the wm.EDIINT.rules:processPayload service has been invoked. One of the following: The EDIINT document contained an invalid sender ID or receiver ID. The message could not be decrypted or verified.

ProcessMsg ERROR

68

webMethods EDIINT Module Users Guide Version 6.5

Using Trading Networks Console to View Information

Type Inbound EDIINT MDN

User Status ProcessMDNMsg ProcessMDNMsg DONE ProcessMDNMsg ERROR

Description The EDIINT MDN has been received and processing is starting. The MDN was processed. One of the following: The MDN contained an invalid sender ID or receiver ID. The signature of the MDN could not be verified. The MDN contained errors. The MDN digest did not match that of the original EDIINT document.

ProcessMDNMsg IGNORED Outbound EDIINT document SendMsg SendMsg DONE

An identical MDN was previously received. Processing to send the EDIINT document has started. One of the following: The message was sent and an MDN was not requested. The message was sent and an MDN was returned.

SendMsg WAITMDN SendMsg ERROR

The message was sent and an MDN was requested, but not yet received. One of the following: The message could not be sent. The returned MDN contained errors.

Outbound EDIINT MDN

SendMDNMsg SendMDNMsg DONE SendMDNMsg ERROR

Processing to send the EDIINT MDN has started. The MDN was sent successfully. The MDN could not be sent.

webMethods EDIINT Module Users Guide Version 6.5

69

CHAPTER 6 Viewing and Managing Information about EDIINT Documents and MDNs

Viewing Related Documents

If you submit the payload of an inbound EDIINT document to Trading Networks for business-level processing, you can view information about the envelope(s) that the payload contains, using the View Related Documents option of the Trading Networks Console. By default Trading Networks persists to the Trading Networks database any EDIINT document that is submitted to it. If the document, which is stored in the pipeline variable bizdoc, has not been persisted (or if the wm.EDIINT.rules:receive service fails to place the document into bizdoc), the following occurs depending on the content type of the payload: Payload content type application/XML application/edi-X12 application/EDIFACT other If the bizdoc has not been persisted... No information about the payload is displayed. Information about the main envelope is not displayed; information about each individual envelope is displayed if they have been persisted. If you specified a user-defined service to handle another content type (as described in Configuring Whether Trading Networks Is To Process Payloads on page 46), the webMethods EDIINT Module passes the bizdoc to the userdefined service, along with the payloads data stream and content type. The user-defined service must handle the display of payload information.

To view related documents 1 On the Trading Networks Consoles Transaction Analysis screen, display the Detail view. If you are currently displaying the Summary view, select View Detail/Summary to switch to the Detail view. Click to display the query panels if they are not already displayed.

2 3

Specify search criteria to find the inbound document you want to view and click the Run Query button on the toolbar. For more information about creating queries on this screen, see Chapter 18, "Managing and Tracking Documents", in the webMethods Trading Networks Users Guide.

4 5

Click the row containing the inbound document for which you want to view related documents. Select View Related Documents.

70

webMethods EDIINT Module Users Guide Version 6.5

Resubmitting EDIINT Outbound Transactions

Resubmitting EDIINT Outbound Transactions

You can resubmit EDIINT outbound transactions. When you resubmit a document, Trading Networks performs the following processing: Uses the TN document type definitions to recognize the document Performs a processing rule lookup to determine the rule to use Performs the pre-processing and processing actions identified in the matching processing rule Resubmit an outbound transaction if the document was not recognized when it was originally received. Create or modify a TN document type definition to recognize the document before processing the document again. To resubmit an EDIINT outbound transaction 1 On the Trading Networks Consoles Transaction Analysis screen, select View Partners. Trading

2 3 4 5 6

Use the Select... button to select the partner with which you want to associate the document query. Select the partner from the Partner Selection Dialog. Select the sender from the Partner Selection Dialog. Select View Transaction Analysis.

Display the Detail view. If you are currently displaying the Summary view, select Transactions View Detail/Summary to switch to the Detail view. If the query panels are not displayed, select Transactions the query panels. Show/Hide Query to display

Specify search criteria to find the outbound document and click the Run Query button on the toolbar. For more information about creating queries on this screen, see Chapter 18, "Managing and Tracking Documents", in the webMethods Trading Networks Users Guide. Note: To find documents that were processed but encountered errors in the recognition process, specify the processing status DONE W/ ERRORS for the processing status in the basic criteria.

8 9

Click the row containing the outbound document that you want to resubmit. Select Resubmit.

webMethods EDIINT Module Users Guide Version 6.5

71

CHAPTER 6 Viewing and Managing Information about EDIINT Documents and MDNs

72

webMethods EDIINT Module Users Guide Version 6.5

CHAPTER

webMethods EDIINT Module Services

wm.EDIINT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 wm.EDIINT.sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

webMethods EDIINT Module Users Guide Version 6.5

73

CHAPTER 7 webMethods EDIINT Module Services

wm.EDIINT
Use the services in this folder for sending and receiving EDIINT (AS1, AS2, or AS3) messages and MDNs.

wm.EDIINT:receive
Receives inbound EDIINT (AS1/AS2/AS3) messages or MDNs and submits the message to Trading Networks to be unwrapped, decrypted, and signature authenticated. The EDIINT content handler populates the inputs described below. Input Parameters protocol String The EDIINT protocol to use. Value of protocol
smtp http

Meaning AS1 message or MDN. AS2 message or MDN. AS3 message or MDN.

ftp message-ID contentType stream AS2-From AS2-To AS3-From AS3-To From To ReceiptDeliveryOption

String The EDIINT message ID of the EDIINT message or MDN. This value becomes the Trading Networks system attribute, Document ID. String The content type of the EDIINT message or MDN. Object The data InputStream representing the inbound EDIINT message or MDN. String The sender ID from the EDIINT AS2 message/MDN. This should match the senders Trading Networks external ID. String The receiver ID from the EDIINT AS2 message/MDN. This should match the receivers Trading Networks external ID. String The sender ID from the EDIINT AS3 message/MDN. This should match the senders Trading Networks external ID. String The receiver ID from the EDIINT AS3 message/MDN. This should match the receivers Trading Networks external ID. String The sender ID from the EDIINT AS1 message/MDN. This should match the senders Trading Networks external ID. String The receiver ID from the EDIINT AS1 message/MDN. This should match the receivers Trading Networks external ID. String The address to which to send an asynchronous MDN, if requested.

74

webMethods EDIINT Module Users Guide Version 6.5

wm.EDIINT

Output Parameters None Usage Notes For information about how to use this service, see Chapter 4, Processing Inbound EDIINT Documents and MDNs.

webMethods EDIINT Module Users Guide Version 6.5

75

CHAPTER 7 webMethods EDIINT Module Services

wm.EDIINT:retrieveAS3M essage
Downloads AS3 messages or MDNs from a partners remote FTP server and submits the message to Trading Networks to be unwrapped, decrypted, and to have its signature authenticated. The service locates the partners remote FTP server using the values defined in IS document type wm.EDIINT.TPA:EDIINTAS3TPA. If the IS document type specifies that the retrieved file(s) are to be deleted, the service deletes the file(s). Input Parameters sender Document Optional. Identification of the partner from whom to retrieve the message. Note: When sender is not specified, the service will access the remote FTP servers of all partners with whom you have a Trading Partner Agreement. Variable in sender id idTypeDesc receiver Variable in sender id idTypeDesc Output Parameters None

Meaning String The partners external ID. String Optional. The partners external ID type. Default: AS3.

Document Identification of the partner who retrieves the message. Meaning String The partners external ID. String Optional. The partners external ID type. Default: AS3.

76

webMethods EDIINT Module Users Guide Version 6.5

wm.EDIINT

wm.EDIINT:send
Constructs an outbound EDIINT message according to the configuration of the input variables, and then submits the message to Trading Networks. Input Parameters type String The S/MIME type that you want to use for the outbound EDIINT message. Specify one of the following: Value of type
plain

Description You want the wm.EDIINT:send service to neither sign nor encrypt the outbound EDIINT message. You want the wm.EDIINT:send service to sign the outbound EDIINT message. You want the wm.EDIINT:send service to encrypt the outbound EDIINT message. You want the wm.EDIINT:send service to sign and encrypt the outbound EDIINT message. You want the wm.EDIINT:send service to determine whether to sign and/or encrypt the outbound EDIINT message using the value of the S/MIME Type extended field from the receivers profile.

signed

encrypted

signedAndEncrypted

getFromProfile

compressed

String (optional) Whether you want the EDIINT message that you are sending to be compressed before it is signed and/or encrypted. Specify either true or false. Value of compressed
true

Meaning Compress outbound message before signing and encrypting. Do not compress outbound message before signing and encrypting. This is the default.

false

webMethods EDIINT Module Users Guide Version 6.5

77

CHAPTER 7 webMethods EDIINT Module Services

deliveryMethod

String The delivery method you want to use to send the EDIINT document. The wm.EDIINT:send service obtains the Trading Networks profile for the receiver (specified by the receiverID input variable) and delivers the EDIINT document to the receivers system using the information specified for the delivery method you specify. Specify a delivery method that is defined in the receivers Trading Networks profile. For EDIINT AS1, specify one of the following:
PrimarySMTP (corresponds to the Trading Networks Primary E-mail delivery method) SecondarySMTP (corresponds to the Trading Networks Secondary E-mail delivery method)

For EDIINT AS2, specify one of the following:

PrimaryHTTP SecondaryHTTP PrimaryHTTPS SecondaryHTTPS

For EDIINT AS3, specify the following:

AS3

data

Document The payload that you want to send. Variable in data contentType stream Description The content type to assign to the outbound message. The java.io.InputStream that you map from the EDI or XML data.

requestMDN

String Whether you want the receiver to return an MDN. Specify one of the following: Value of requestMDN
none synchronousMDN asynchronousMDN

Meaning Do not request a return MDN. Request a return synchronous MDN. Request a return asynchronous MDN.

Note: If you specify PrimarySMTP, SecondarySMTP, PrimaryFTPS, or SecondaryFTPS for deliveryMethod, you can only receive an asynchronous MDN.

78

webMethods EDIINT Module Users Guide Version 6.5

wm.EDIINT

requestSignedReceipt

String Whether you want the MDN to be signed. Note: requestSignedReceipt is ignored when requestMDN is false. Value of requestSignedReceipt
true false

Meaning Request a signed MDN. Request a plain (not signed) MDN. Description The senders external ID. That is, the identification that you want for the sender in the message. Optional. The external ID type for the sender ID you specified in id. This is an external ID type as defined in Trading Networks. Note: By default, the service uses the appropriate external ID type based on the value you specify for the deliveryMethod parameter. For example, if you specify AS3 for the deliveryMethod parameter, the service uses the EDIINT AS3 external ID type. Specify a value for idTypeDesc only if you want to override this default.

senderID

Document Identification of the sender of the EDIINT message. Variable in senderID id idTypeDesc

webMethods EDIINT Module Users Guide Version 6.5

79

CHAPTER 7 webMethods EDIINT Module Services

receiverID

Document Identification of the receiver of the EDIINT message. Variable in senderID id idTypeDesc Description The receivers external ID. That is, the identification that you want for the receiver in the message. Optional. The external ID type for the receiver ID you specified in id. This is an external ID type as defined in Trading Networks. Note: By default, the service uses the appropriate external ID type based on the value you specify for the deliveryMethod parameter. For example, if you specify AS3 for the deliveryMethod parameter, the service uses the EDIINT AS3 external ID type. Specify a value for idTypeDesc only if you want to override this default.

ConversationID

String (optional) Conversation ID for the outbound EDIINT message. You might want to use the same conversation ID as that of the payload that you are sending. The EDIINT Module automatically assigns to a return MDN the same conversation ID that is assigned here.

Output Parameters None Usage Notes For information about how to use this service, see Chapter 3, Creating a Client to Submit a Document Using EDIINT and Chapter 5, Using EDIINT to Deliver Outbound Documents.

80

webMethods EDIINT Module Users Guide Version 6.5

wm.EDIINT.sample

wm.EDIINT.sample
You can run the following sample send service within the webMethods Developer to exchange sample EDIINT messages. See the sample on the EDIINT Module home page for information about how to set up the sample.

wm.EDIINT.sample:send
Reads the input file as an InputStream and invokes the wm.EDIINT:send service. Input Parameters dataFileName dataContentType type String Name and location of the file to send. String The content type of the file to send, for example application/edi-x12. String The S/MIME type that you want to use for the outbound EDIINT message. Specify one of the following: Value of type
plain

Description You want the wm.EDIINT.sample:send service to neither sign nor encrypt the outbound EDIINT message. You want the wm.EDIINT.sample:send service to sign the outbound EDIINT message. You want the wm.EDIINT.sample:send service to encrypt the outbound EDIINT message. You want the wm.EDIINT.sample:send service to sign and encrypt the outbound EDIINT message. You want the wm.EDIINT.sample:send service to determine whether to sign and/or encrypt the outbound EDIINT message using the value of the S/MIME Type extended field from the receivers profile.

signed

encrypted

signedAndEncrypted

getFromProfile

webMethods EDIINT Module Users Guide Version 6.5

81

CHAPTER 7 webMethods EDIINT Module Services

deliveryMethod

String The delivery method you want to use to send the EDIINT document. The wm.EDIINT:send service obtains the Trading Networks profile for the receiver (specified by the receiverID input variable) and delivers the EDIINT document to the receivers system using the information specified for the delivery method you specify. Specify a delivery method that is defined in the receivers Trading Networks profile. For EDIINT AS1, specify one of the following:
PrimarySMTP (corresponds to the Trading Networks Primary E-mail delivery method) SecondarySMTP (corresponds to the Trading Networks Secondary E-mail delivery method)

For EDIINT AS2, specify one of the following:

PrimaryHTTP SecondaryHTTP PrimaryHTTPS SecondaryHTTPS

For EDIINT AS3, specify the following:

AS3

requestMDN

String Whether you want the receiver to return an MDN. Specify one of the following: Value of requestMDN
none synchronousMDN asynchronousMDN

Meaning Do not request a return MDN. Request a return synchronous MDN. Request a return asynchronous MDN.

Note: If you specify PrimarySMTP, SecondarySMTP, PrimaryFTPS, or SecondaryFTPS for deliveryMethod, you can only receive an asynchronous MDN. requestSignedReceipt String Whether you want the MDN to be signed. Note: requestSignedReceipt is ignored when requestMDN is false. Value of requestSignedReceipt
true false

Meaning Request a signed MDN. Request a plain (not signed) MDN.

82

webMethods EDIINT Module Users Guide Version 6.5

wm.EDIINT.sample

senderID

Document Identification of the sender of the EDIINT message. Variable in senderID id idTypeDesc Description The senders external ID. That is, the identification that you want for the sender in the message. Optional. The external ID type for the sender ID you specified in id. This is an external ID type as defined in Trading Networks. Note: By default, the service uses the appropriate external ID type based on the value you specify for the deliveryMethod parameter. For example, if you specify AS3 for the deliveryMethod parameter, the service uses the EDIINT AS3 external ID type. Specify a value for idTypeDesc only if you want to override this default.

receiverID

Document Identification of the receiver of the EDIINT message. Variable in senderID id idTypeDesc Description The receivers external ID. That is, the identification that you want for the receiver in the message. Optional. The external ID type for the receiver ID you specified in id. This is an external ID type as defined in Trading Networks. Note: By default, the service uses the appropriate external ID type based on the value you specify for the deliveryMethod parameter. For example, if you specify AS3 for the deliveryMethod parameter, the service uses the EDIINT AS3 external ID type. Specify a value for idTypeDesc only if you want to override this default.

ConversationID

String (optional) Conversation ID for the outbound EDIINT message. You might want to use the same conversation ID as that of the payload that you are sending. The EDIINT Module automatically assigns to a return MDN the same conversation ID that is assigned here.

Output Parameters None

webMethods EDIINT Module Users Guide Version 6.5

83

CHAPTER 7 webMethods EDIINT Module Services

84

webMethods EDIINT Module Users Guide Version 6.5

APPENDIX

Glossary
activity log A log that webMethods Trading Networks (Trading Networks) maintains in its database to record activity that occurs within the Trading Networks system. AS1 See EDIINT AS1. AS2 See EDIINT AS2. AS3 See EDIINT AS3. bizdoc The name of the variable in the pipeline that contains the BizDocEnvelope. BizDocEnvelope A BizDocEnvelope represents a routable Trading Networks transaction. It contains a document that Trading Networks is processing and includes additional information that Trading Networks requires for routing and processing the document. It is in the pipeline in the bizdoc variable and conforms to the IS document type wm.tn.rec:BizDocEnvelope. business process A multi-step interaction among participating systems, people, and trading partners. A business process can be fully automated (involve only interaction among computer systems) or include varying degrees of human interaction (for example, review and approval steps). It may be brief or long running. Some business processes transpire over days or weeks. conversation A specific case of a business process that involves a series of related documents being exchanged by two or more trading partners. All documents from a specific trading partner contain the same conversation ID. You model a conversation by creating a process model using webMethods Modeler.

webMethods EDIINT Module Users Guide Version 6.5

85

APPENDIX A Glossary

conversation ID A webMethods Trading Networks system document attribute that identifies a value within a document that is common to all documents that are part of the same business process (also called a conversation). document type See IS Document Type or TN document type. EDIINT A standard defined by the Internet Engineering Task Force (IETF) that defines a protocol for using the Internet to securely exchange business documents (EDI, XML, or other). EDIINT stands for Electronic Data Interchange-Internet Integration or EDI over the Internet. EDIINT has two version: EDIINT AS1 and EDIINT AS2. EDIINT AS1 EDIINT Applicability Statement 1, which is a version of the EDIINT standard that uses SMTP (e-mail) to transport documents. EDIINT AS2 EDIINT Applicability Statement 2, which is a version of the EDIINT standard that uses HTTP (or HTTP/S) to transport documents. EDIINT AS3 EDIINT Applicability Statement 3, which is a version of the EDIINT standard that uses FTP over SSL (also known as FTPS) to transport documents. extended fields Fields within a profile that are not provided with Trading Networks out of the box. Users of Trading Networks can define extended profile fields to extend the profile to meet their needs. Additionally, the EDI Module adds extended fields to profiles for use when transporting documents using EDIINT. external ID The value of an external ID type. For example, if an external ID type is a D-U-N-S number, the external ID is the actual D-U-N-S number. external ID type A type of identifier that trading partners use in documents. For example, a user might use a D-U-N-S number. The external ID type corresponds to the EDI ID qualifier in an EDI document. IData object The collection of name/value pairs on which a service operates. An IData object can contain any number of elements of any valid Java objects, including additional IData objects and IDataCodable objects. IS Document Type An element in the Integration Servers namespace that contains a set of fields used to define the structure and type of data in an IS document (IData object).

86

webMethods EDIINT Module Users Guide Version 6.5

MDNs EDIINT receipts for messages that are received. The receiver sends the receipt back to the sender. MDN stands for message disposition notifications. pipeline The general term used to refer to the data structure in which input and output values are maintained for a flow service at run time. The pipeline starts with the input to the flow service and collects inputs and outputs from subsequent services in the flow. When a service in the flow executes, it has access to all data in the pipeline. processing rule A webMethods Trading Networks object that contains set of actions that determine how Trading Networks is to process a document and criteria that indicates when to select a processing rule for an incoming document.webMethods Modeler. process model Diagrams that illustrate and define the actions to perform for a business process or conversation. You create process models using webMethods Modeler. process run time A facility of the Integration Server that manages the execution of processes (or conversations). You model a process (or conversation) using webMethods Modeler. profile A webMethods Trading Networks object that contains a summary of information about a corporation that is part of a trading network. A profile contains standard fields that webMethods defines and extended fields that are site defined. TN document type A webMethods Trading Networks object that defines how Trading Networks is to recognize a document and specifies initial actions to take on a recognized document.

webMethods EDIINT Module Users Guide Version 6.5

87

APPENDIX A Glossary

88

webMethods EDIINT Module Users Guide Version 6.5

Index

Index
A
activity log, defined 85 Agreement ID, specifying for AS3 39 algorithm, used in EDIINT encryption 11 application/EDIFACT payload processing 46 application/edi-X12 payload processing 46 application/XML payload processing 46 architecture of webMethods EDIINT Module 12 AS1, EDIINT version defined 10 delivery methods for 31 enabling e-mail exchange 35 importance of checking mailbox size 35 profile field, for EDIINT 31 SMTP, configuring 35 specifying inbound e-mail address 32, 50 AS1MDNURL extended profile field for inbound AS1 MDNs 32, 50 AS2, EDIINT version defined 10 delivery methods for 31 profile field, for EDIINT 31 SMTP, configuring 35 specifying inbound address 32, 50 AS2MDNURL extended profile field for inbound AS2 MDNs 32, 50 AS3, EDIINT version defined 10 directories for downloading/uploading 37 overview of 23 Trading Partner Agreements (TPAs), creating 37 asynchronous MDN 11, 16, 22, 58 wm.EDIINT.delivery:deliveryDocument service 22 BizDocEnvelope defined 85 for MDN 22 formed by wm.EDIINT:receive service 16, 18 formed by wm.EDIINT:send service 20 inbound document 20 EDIINT document 16 MDN 18, 22 built-in services EDIINT documents and MDNS 13 wm.EDIINT:receive service 14 business process defined 85 for inbound EDIINT documents 15 on EDIINT payload 17 sample process model to send outbound EDIINT documents 25 business-level processing EDIINT 50 logic on payloads of EDIINT documents 58 payload of EDIINT document 56

C
clients for inbound processing using EDIINT exchange protocol 13 compression, EDIINT messages 11 configuration file, WmEDIINT properties.cnf 37, 46 configuring to receive inbound EDIINT documents via SMTP 35 to send outbound EDIINT documents via SMTP 36 content handlers EDIINT 14 EDIINT documents 13 MDNs 13 content type, EDIINT 14 contentType input variable 47 conventions used in this document 7

B
bizdoc variable defined 85 EDIINT document 16, 20 MDN 18, 22

webMethods EDIINT Module Users Guide Version 6.5

89

Index

conversation ID in sample process model to send outbound EDIINT documents 25 input parameter of process model 25 MDN 25 outbound EDIINT document 25 conversation, defined 85 copying document attributes 39 Corporate tab fields, profile for EDIINT 29 creating outbound EDIINT message 77

D
Decrypt/Encrypt subtab, for EDIINT profile 34 defining TPA 38 definitions activity log 85 bizdoc variable 85 BizDocEnvelope 85 business process 85 conversation 85 conversation ID 85 EDIINT 10 AS1 10 AS2 10 AS3 10 extended (profile) fields 86 external ID 86 external ID type 86 IData object 86 Integration Server 12 IS document type 86 MDNs (message disposition notifications) 11 message disposistion notifications (MDNs) 11 pipeline 87 process model 87 process run time 87 processing rules 87 profiles 87 TN document types 87 TPA 37 Trading Partner Agreement (TPA) 37 WmEDI package 12 WmEDIforTN package 12

delivering EDIINT documents 64 MDN asynchronously 11, 16 MDN synchronously 11, 20 wm.EDIINT.delivery:delivery Document service 20 Delivery Method tab of profile, for EDIINT 31 deliveryDocument service 52 DES encryption algorithm 32 diagram of EDIINT Module and Integration Server architecture 12 EDIINT Module and the webMethods Architecture 12 inbound EDIINT document processing 15 outbound EDIINT processing 18 processing inbound MDNs 17 sample process model that waits sends an EDIINT document and receives the corresponding MDN 25 sending outbound EDIINT documents 19 sending outbound MDN 21 digital signature outbound EDIINT documents 34 verifying for EDIINT document 34 disabling port when EDIINT packed is disabled 35 Trading Networks payload processing 46 document attributes copying 39 EDIINT MDN Disposition 49 EDIINT MDN Original Message 49 EDIINT MDN Received MIC 49 EDIINT Message Digest 49 EDIINT Message ID 49 EDIINT Message Type 49 EDIINT transport-level processing 49 provided for EDIINT processing 49 document recognition, wm.EDIINT.rules:processMsg service 22 document types See also IS document types and TN document types documentation additional 7 conventions used 7 feedback 7

90

webMethods EDIINT Module Users Guide Version 6.5

Index

documents EDIINT, See EDIINT documents processing rule for inbound 16, 22 Drummond Group 11

E
EDI documents EDIINT payload 17 payload, business-level processing 58 sending to EDIINT 18 EDI Module MDNs inbound processing 17 outbound processing 20 EDI over the Internet, See EDIINT EDIINT 48 built-in services 13 content types 54 defined 10 delivery method 31 digitally sign outbound documents 34 document attributes 49 documents, See EDIINT documents 32 EDIINT Process MDN Message processing rule 18 Message processing rule 16, 22 EDIINT Send MDN Message processing rule 22 Message processing rule 20 exchange protocol 13 Execute a Service action 16 extended profile fields 32, 50 features supported by EDIINT Module 11 field group 50 FTPS, configuring 28 HTTP, configuring 28 HTTPS, configuring 28 including information in profiles 28 interoperability testing 11 MDN TN document type 18, 20, 22 MDNs, See MDNs messages, See EDIINT messages MIME messages 19 outbound processing 18

packaging a document for transport 18 payload, processing of 14 processing rules for transport-level processing 50 processing rules, See processing rules profile fields 29 receipts, See MDNs S/MIME messages 19 security information 34 sending EDI documents to 18 sending non-EDI documents to 18 services invoked by processing rules 51 services to package and transport documents 18 SMTP, configuring 35 Submit payload to TN check box 46 TN document types 13, 22, 48 transport-level processing 50, 56, 64 User Process Payload Service field 46 wm.EDIINT:receive service 16, 22, 56 EDIINT documents acceptable versions (AS1, AS2, AS3) 10 attributes 49 content type 14 conversation ID 25 created by wm.EDIINT:send service 19 cryptographic permutations 11 defined 10 delivering outbound, prerequisites 64 EDIINT Send Message processing rule 20 encrypting outbound 34 Execute a Service action 20 inbound EDIINT Process Message processing rule 16, 22 flow 16, 18, 22 processing 13 User Status 68 outbound 19, 25 encryption options 32, 50 processing 18 User Status 69 packaging for transport 18 payload 15 posted by HTTP, example of 57 processing inbound documents, prerequisites 56

webMethods EDIINT Module Users Guide Version 6.5

91

Index

processing rule for inbound 16 processing rule for outbound 20 receiving encrypted 34 S/MIME type 59 sample process model of outbound 25 setting S/MIME type for outbound document 64 setting up to process payloads 58 veritying digital signature 34 viewing on Transacation Analysis screen 68 EDIINT ID Match option 31 EDIINT MDN See also MDNs Disposition document attributes 49 entry point 60 inbound User Status 69 Original Message ID document attributes 49 outbound User Status 69 posted by HTTP, example of 61 processing inbound MDN, prerequisites 60 Received MIC document attributes 49 TN document type 49 viewing on Transacation Analysis screen 68 EDIINT Message Digest document attribute 49 EDIINT Message ID document attribute 49 EDIINT Message Type document attribute 49 EDIINT messages constructing outbound 77 receiving 74, 76 retrieving AS3 messages 76 samples 81 sending samples 81 EDIINT Module architecture of 12 conditions to ignore payload settings 47 content handler installed with 14 EDIINT TN document types 16 overview 10 Trading Networks objects 48 wM.EDIINT:send service 64 EDIINT Process MDN Message processing rule 50 EDIINT Process Message processing rule 50, 57 sender requesting MDN 16 EDIINT recognizer, setting user status 16, 18, 20

EDIINT Send MDN Message processing rule 51, 58 EDIINT Send Message processing rule 51 EDIINT TN document type 16 EDIINT transport, sample process model 25 EDIINTAS3 38 Agreement ID 39 IS document type 40 input parameters 40 output parameters 43 e-mail, EDIINT exchange 35 enabling Trading Networks payload processing 46 encrypted EDIINT documents 34 S/MIME type 33, 59 encrypting outbound EDIINT documents 34 encryption EDIINT documents outbound choices 32 specifying outbound 32 EDIINT messages 11 types for trading partners 11 wm.EDIINT:send service 19 Encryption Algorithm extended profile field 32, 50 entry point for inbound EDIINT MDNs 60 errors and not invoking wm.EDIINT:send service directly from Execute a Service processing action 65 payload 59 ProcessMDNMsg ERROR 69 ProcessMsg ERROR 68 SendMDNMsg ERROR 69 SendMsg ERROR 69 example of EDIINT document posted by HTTP 57 EDIINT MDN posted by HTTP 61 Execute a Service processing action 16, 18, 20, 22 not invoking wm.EDIINT:send service directly from 65 extended profile fields and EDIINT 13 defined 86 EDIINT field group 50 EDIINT, AS1MDNURL 50 EDIINT, AS2MDNURL 50

92

webMethods EDIINT Module Users Guide Version 6.5

Index

EDIINT, Encryption Algorithm 50 EDIINT, S/MIME Type 50 for EDIINT 32 external ID 86 external ID types defined 86 EDIINT ID Match option 31 EDIINT, specifying how to match 29 specifying 29

F
false setting, wm.EDIINT.submit Payload configuration property 46 FTP user root directory 37 FTPS port, adding for EDIINT 28 FTPUserName extended profile field for outbound AS3 messages and MDNs 32

H
HTTP example of EDIINT document 57 example of EDIINT MDN 61 sending MDN 20 HTTP port, adding for EDIINT 28 HTTPS port, adding for EDIINT 28

wm.EDIINT:receive service 74 wm.EDIINT:retrieveAS3Message service 76 wm.EDIINT:send service 19, 77 Integration Server and EDIINT Module architecture 12 and EDIINT Module, diagram 12 defined 12 Internet Engineering Task Force (IETF) 10 interoperability testing 11 invoking wm.EDIINT.delivery:deliveryDocument service 22 wm.EDIINT.rules deliveryDocument service 20 processMDN service 18 processMsg service 16, 22 processPayload service 17 sendMsg service 20 wm.EDIINT.rules:sendMDN service 22 wm.EDIINT:send service 19, 25, 64 IS document type defined 86 specifying for input parametersAS3 40 specifying output parameters for AS3 43

K
key length 11

I
IData object defined 86 IETF, and EDIINT 10 IMAP protocol 35 inbound EDI documents requesting MDN 20 inbound EDIINT documents 14 inbound EDIINT message, configuring SMTP settings 35 inbound flow, EDIINT messages 16, 18, 22 inbound processing clients to send EDI documents using EDIINT exchange protocol 13 EDIINT documents MDNs 17 input variables contentType 47 stream 47 wm.EDIINT.TPA EDIINTAS3 document type 40

L
logic business-level on EDIINT document 17 to perform transport-level processing for inbound EDIINT documents 14, 19

M
MD5 algorithm usage 11 MDNs and wm.EDIINT.rules:processMsg service 57 asynchronous 11, 16, 22 automatically sending outbound 20 conversation ID assigned 25 creating with wm.EDIINT.rules:processMsg service 22 defined 11 delivering synchronously or asynchronously 58

webMethods EDIINT Module Users Guide Version 6.5

93

Index

EDIINT MDN TN document type 18, 20 EDIINT, See also EDIINT MDN Execute a Service action 18, 22 HTTP connection of inbound EDIINT document 20 inbound AS1 address 32, 50 AS2 address 32, 50 document 20 EDIINT Process MDN Message processing rule 18, 22 processing 17 wm.EDIINT:receive service 18 outbound 20 processing rule for inbound 18, 22 receipt exchange 10 receipt of EDIINT document 57 receiving inbound via SMTP 35 sample process model for outbound EDIINT documents 25 sender not requesting 16 requesting 16, 20 sending outbound via SMTP 36 separate transaction 20 signed 16 SMTP, configuring 35 synchronous 11, 20, 22 synchronous and asynchronous 32 unsigned 16 wm.EDIINT.delivery:deliveryDocument service 22 wm.EDIINT.rules processMDN service 18 processMsg service 16, 22 sendMDN service 22 message disposition notifications 11 messages EDIINT MIME 19 EDIINT S/MIME 19 MIME messages 19 package 16 modifying profile to include EDIINT information 28

N
new document attribute 38 non-EDI documents EDIINT payload 17 payload, business-level processing 58 sending to EDIINT 18

O
outbound choices for EDIINT message encryption 11 outbound EDIINT message, configuring SMTP settings 36 outbound processing EDIINT 18 EDIINT documents 18 MDNs, sending 20 wm.EDIINT:send service 19

P
package a document for transport using EDIINT 18 packages EDI Module 12 WmEDI 12 WmEDIforTN 12 payload business-level logic 58 business-level process for EDIINT document 50 business-level processing 56 conditions EDIINT Module ignores settings 47 EDI document 58 non-EDI document 58 processing by Trading Networks 46 S/MIME type affecting processing 59 submitting 46 Trading Networks to process 46 payload of EDIINT document business-level logic 17 EDI document 17 in sample process model 25 non-EDI document 17 sending to Trading Networks 15, 17 performing business-level processing on payloads of EDIINT documents 58

94

webMethods EDIINT Module Users Guide Version 6.5

Index

pipeline, defined 87 plain S/MIME type 33, 59 POP3 protocol 35 port adding for FTPS 28 adding for HTTP 28 adding for HTTPS 28 adding for SMTP 35 for MDNs via HTTP 32 webMethods/Email 35 prerequisites for delivering outbound EDIINT documents 64 processing inbound EDIINT documents 56 processing inbound EDIINT MDNs 60 Primary E-mail delivery method for EDIINT AS1 31 Primary HTTP delivery method for EDIINT AS2 31 Primary HTTPS delivery method for EDIINT AS2 31 process model defined 87 sample outbound EDIINT documents and corresponding MDN 25 process run time, defined 87 processing business level on payload of EDIINT document 50 business-level for inbound EDIINT documents 15 EDIINT transport-level 64 inbound EDIINT documents 15, 56 prerequisites 56 EDIINT MDNs, prerequisites 60 outbound EDIINT documents, prerequisites 64 payloads 46 rules, See processing rules transport-level for inbound EDIINT documents 14 outbound EDIINT documents 19 processing actions, Execute a Service 18 processing rules defined 87 EDIINT and user status 16, 20 Process MDN Message 18 Process Message 16, 22, 50, 57

Send MDN Message 22, 51 Send MDN Message service 58 Send Message 20, 51 services 51 transport-level processing 50 Execute a Service action 16, 18, 20, 22 inbound EDIINT documents 16, 22 MDNs 18, 22 MDNs 16 and user status 18 outbound EDIINT documents 20 payload of non-EDI document 58 sender requesting MDNs 16 user status EDIINT 16 EDIINT documents 20 MDN 18 wm.EDIINT.rules:processMsg service 50 processMDN service 52 ProcessMDNMsg DONE user status 69 ProcessMDNMsg ERROR user status 69 ProcessMDNMsg IGNORED user status 69 ProcessMDNMsg user status 18, 69 ProcessMsg ERROR user status 68 ProcessMsg PAYLOAD user status 68 processMsg service 51 ProcessMsg user status 16, 68 processPayload service 51 profiles defined 87 EDIINT information 28 program code conventions in this document 7 protocol, EDIINT 10

R
RC2 128 (128 bits) encryption algorithm 32 RC2 40 (40 bits) encryption algorithm 32 RC2 64 (64 bits) encryption algorithm 32 receive service 74 receiving EDIINT messages 74, 76 encrypted EDIINT documents 34

webMethods EDIINT Module Users Guide Version 6.5

95

Index

inbound EDIINT message via SMTP 35 inbound MDN via SMTP 35 retrieveAS3Message service 76

S
S/MIME EDIINT message 19 package 16 setting for outbound EDIINT document 64 version 2 10, 11 S/MIME Type 59 affecting payload processing 59 encrypted 59 extended profile field 33, 50, 58 plain 59 type partners use for payloads sent and received 50 samples EDIINT 81 process model of outbound EDIINT documents and corresponding MDN 25 Secondary E-mail delivery method for EDIINT AS1 31 Secondary HTTP delivery method for EDIINT AS2 31 Secondary HTTPS delivery method for EDIINT AS2 31 Secure/Multipurpose Internet Mail Extensions 11 Security tab profile, for EDIINT 34 send service, usage 74, 76, 77 sender not requesting MDN 16 requesting MDN 16, 20 asynchronous 22 synchronous 22 sending documents to EDIINT 18 EDIINT documents 64 EDIINT MDNs outbound 20 EDIINT message samples 81 MDN 20 outbound EDIINT documents 19 EDIINT message via SMTP 36 MDN via SMTP 36 wm.EDIINT:send service 19 sendMDN service 52

SendMDNMsg ERROR user status 69 SendMDNMsg user status 69 SendMsg DONE user status 69 SendMsg ERROR user status 69 sendMsg service 52 SendMsg user status 20, 22, 69 SendMsg WAITMDN user status 69 services packaging and transporting a document, using EDIINT 18 processing rules for EDIINT documents 51 sendMDN service 52 sendMsg service 52 wm.EDIINT receive service 14, 16, 18, 22 send service 19 wm.EDIINT.delivery:deliveryDocument service 20, 22 wm.EDIINT.rules processMDN service 18 processMsg service 16, 17, 22, 50, 57 processPayload service 17 sendMDN service 22, 58 sendMsg service 20 wm.EDIINT:receive service 60 wm.EDIINT:send service 64 setting up processing payloads from EDIINT documents 58 settings, S/MIME type for outbound EDIINT document 64 SHA-1 hash algorithm 11 Sign sub-tab, for EDIINT profile 34 signed MDN 16 signed S/MIME type 33, 59 signedAndEncrypted S/MIME type 33, 59 SMTP method, configuring settings to enable EDIINT message exchange 35 SMTP port, adding for EDIINT 35 SMTP Server field 36 stream input variable 47 Submit payload to TN check box 46 synchronous MDN 11, 20, 22, 58

T
TN document types defined 87 EDIINT 48

96

webMethods EDIINT Module Users Guide Version 6.5

Index

EDIINT MDN 49 EDIINT MDN TN 22 EDIINT TN 16, 18, 20 for EDIINT documents 13 MDNs 13 payload of non-EDI document 58 provided for EDIINT processing 48 wm.EDIINT:receive service 16, 18 wm.EDIINT:send service 20 TPA 37 defining 38 EDIINTAS3 38 list of fields 39 new with empty fields 38 Trading Networks adding business-level processing for EDIINT document payloads 14 and EDIINT Module architecture 12 EDIINT Process MDN Message processing rule 18 Process Message processing rule 16, 22 Send MDN Message processing rule 22 Send Message processing rule 20 objects prorvided for EDIINT 48 processing payloads 46 TPAs 37 wm.EDIINT.rules:processMsg service 22 wm.EDIINT:receive service 16, 18, 22 wm.EDIINT:send service 20 TPA See Trading Partner Agreements Trading Partner Agreement (TPA), defined 37 transport-level processing logic for inbound EDIINT documents 14 logic for outbound EDIINT documents 19 processing rules 50 TripleDES encryption algorithm 32 troubleshooting information 7 true setting, wm.EDIINT.submit Payload property 46 typographical conventions in this document 7

U
Uniform Code Council 11 unsigned MDN 16 User Process Payload Service field 46 user status EDIINT 16 EDIINT document 20 inbound EDIINT documents 68 inbound EDIINT MDNs 69 MDN 18, 22 outbound EDIINT documents 69 outbound EDIINT MDNs 69 ProcessMDNMessage 18 ProcessMessage 16 SendMsg 20, 22 User Status system attribute, viewing EDIINT documents and MDNs 68 userFtpRoot directory 37

V
Value (external ID) profile field for EDIINT 29 viewing EDIINT documents and MDNs 68

W
webMethods EDIINT Module, See EDIINT Module webMethods/Email port EDIINT SMTP settings 35 wm.EDIINT.delivery:deliveryDocument service 22 delivering EDIINT document to trading partner 20 wm.EDIINT.rules folder 51 processMsg service 50 outbound MDNs for EDIINT document 57 sendMDN service 58 wm.EDIINT.rules:deliveryDocument service 20 wm.EDIINT.rules:processMDN service 18 wm.EDIINT.rules:processMsg service 16 invoking wm.EDIINT.rules:processPayload service 17 MDNs creating 22 sender requesting 16

webMethods EDIINT Module Users Guide Version 6.5

97

Index

opening MIME or S/MIME package 16 Trading Networks 22 wm.EDIINT.rules:processPayload service 17 wm.EDIINT.rules:sendMDN service 22 wm.EDIINT.rules:sendMsg service 20 wm.EDIINT:receive service 14, 16, 18, 22, 74 accepting inbound MDN 18 and TN document types 18 input variables 74 passing EDIINT document to Trading Networks 22 processing inbound EDIINT documents 56 processing inbound EDIINT MDNs 60 Trading Networks 18 wm.EDIINT:retrieveAS3Message service 76 input variables 76

wm.EDIINT:send service 20, 74, 76, 77 and TN document types 20 creates EDIINT document 19 delivering outbound documents 64 in sample process model 25 input variables 19, 77 packaging document and sending it using EDIINT 54 sending document to EDI module 19 Trading Networks 20 WmEDI package, defined 12 WmEDIforTN package, defined 12 WmEDIINT port for SMTP 35 WmRoot port for SMTP 35

98

webMethods EDIINT Module Users Guide Version 6.5