web methods trading networks concepts guide 6.5

webMethods Trading NetworksConcepts 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: TN-CG-65-20050429

Contents

ContentsAbout This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

77 8

Chapter 1. Overview of webMethods Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . .What Is a Trading Network? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . What Is webMethods Trading Networks? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Architecture and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Trading Networks Is the Foundation for eStandards Processing . . . . . . . . . . . . . . . . . . . . . . . . Partners in a Trading Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Processing with Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Overview of Trading Networks Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Design Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Run Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

910 10 11 12 12 14 14 15 15

Chapter 2. Trading Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Overview of Trading Partner Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Profile Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Data Types of Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Required Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Trading Partner Agreements (TPAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TPA Information vs. Profile Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information in a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TPA Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1718 18 19 19 20 20 21 22 22 23

Chapter 3. Setting Up Trading Networks to Process Documents . . . . . . . . . . . . . . . . . . .Overview of Items to Set Up for Processing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . What You Specify to Define a Document Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Document Attributes Relate to TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Trading Networks Uses Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2526 27 28 28 29 30 31

webMethods Trading Networks Concepts Guide Version 6.5

3

Contents

TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Gateway Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information You Supply to Define TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . Unknown TN Document Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Rule Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Pre-processing Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Rule Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scheduled Delivery Queues and Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

32 33 33 34 35 36 37 38 39

Chapter 4. Sending Documents to Trading Networks for Processing . . . . . . . . . . . . . . . . 41Overview of Sending Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Sending Documents to Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Clients that Trading Partners Use to Send Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Service the Client Should Invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . User Accounts for Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Protocols the Client Can Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Sending the Documents to Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Forwarding Documents to Another Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Sending a Document Back to the Same Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 42 42 43 43 44 44 46 48

Chapter 5. Trading Networks Document Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Overview of How Trading Networks Processes a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing of Documents in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recognition Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recognition of XML Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recognition of Flat Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Gateway Services During Flat File Recognition . . . . . . . . . . . . . . . . . . . . . . . . . Trading Networks Processing During Flat File Recognition . . . . . . . . . . . . . . . . . . . . . . . . Processing Rule Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Pre-processing Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Rule Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Pipeline Information that You Can Use in Processing Actions . . . . . . . . . . . . . . . . . . . . . . . . . . Execute a Service Processing Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Send an Alert E-mail Processing Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Change User Status Processing Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deliver the Document to the Receiver Processing Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Respond with a Message Processing Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Trading Networks Handles Large Documents Differently . . . . . . . . . . . . . . . . . . . . . . . . . . Items You Must Set Up Differently for Large Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 53 55 55 56 56 59 59 60 62 63 64 65 65 66 66 66 67 67

4


Contents

Chapter 6. Delivering Documents to Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Overview of Delivering Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Trading Networks Determines Delivery Method Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . When Delivery Information Cannot Be Determined . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Immediate Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Immediate Delivery Methods Provided with Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Your Own Immediate Delivery Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reliable Delivery with Immediate Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using Reliable Delivery for an Immediate Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scheduled Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scheduled Delivery Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scheduled Delivery Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scheduled Delivery Services Provided with Trading Networks . . . . . . . . . . . . . . . . . . . . . . Adding Your Own Scheduled Delivery Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reliable Delivery and Scheduled Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Queuing Documents for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . When Trading Networks Uses Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6970 71 72 73 73 74 74 75 75 77 78 78 78 79 80 81

Chapter 7. Sending Documents to Business Processes for Processing . . . . . . . . . . . . .Overview of Sending Documents to Business Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How You Define the Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ConversationIDs for Trading Networks Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Documents Are Passed to a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8384 84 85 86

Chapter 8. Tracking and Analyzing Run-Time Information in Trading Networks . . . . . . .Run-time Information that You Can Track . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Documents with the Transaction Analysis Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Resubmitting and Reprocessing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Stopping, Restarting, and Deleting Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing the Activity Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using Trading Networks Web Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8990 91 91 92 93 94 95

Appendix A. Glossary for Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Overview of Security Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Communicating Securely Using SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Protecting Access to the Trading Networks User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Protecting Partner Profile Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97106 106 106 107

Appendix B. Security within Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105


5

Contents

Protecting Access to Trading Networks Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Access Control Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Certificates for Verifying, Signing, Encrypting, and Decrypting Documents . . . . . . . . . . . . . . . . . . . . Verifying Digital Signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Actions You Must Take to Verify Digital Signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Trading Networks Verifies Digital Signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Digitally Signing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Trading Networks Signs Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Encrypting and Decrypting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Encrypt Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Trading Networks Encrypts Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Decrypt Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Trading Networks Decrypts Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

107 108 108 109 110 110 111 111 111 112 112 112 113

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

6


About This Guide

About This GuideThis manual is for users of webMethods Trading Networks and webMethods for Partners and provides an overview of webMethods Trading Networks (Trading Networks). It contains information to familiarize you with using Trading Networks and the functionality that it provides. After reading this book, see the webMethods Trading Networks Users Guide for procedures on how to build your trading network, manage your trading partners, manage the documents flowing through your trading network, and analyze the use of your trading network. Note: The webMethods Trading Networks and webMethods for Partners components perform the same functionality. The difference between the components is that webMethods Trading Networks allows you to have as many partners in your network as you want, and webMethods for Partners allows you to have only a single partner. This guide provides documentation for both components although it refers only to webMethods Trading Networks (referred to as Trading Networks).

Document ConventionsConvention 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 fontTypewriter font

UPPERCASE \ []


7

About This Guide

Additional InformationThe 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.

8


CHAPTER

1

Overview of webMethods Trading NetworksWhat Is a Trading Network? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 What Is webMethods Trading Networks? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Architecture and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 Partners in a Trading Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Document Processing with Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Overview of Trading Networks Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14


9

CH A P T E R 1 O v er v iew of w e b Met h o d s Tr ad in g N et w o r ks

Note: The webMethods Trading Networks and webMethods for Partners components provide the same functionality. The difference between the components is that webMethods Trading Networks allows you to have as many partners in your network as you want, while webMethods for Partners allows you to have only a single partner. This guide provides documentation for both components although it only refers to webMethods Trading Networks.

What Is a Trading Network?A trading network is a set of organizations that have agreed to exchange business documents. Participants might include strategic partners, buyers, suppliers, and marketplaces. Examples of typical business documents are purchase orders, order statuses, purchase order acknowledgements, invoices, as well as other domain-specific business documents. The organizations in your network are referred to as trading partners (partners). A trading partner can be any system, within or outside your enterprise, that produces or consumes business documents.

What Is webMethods Trading Networks?webMethods Trading Networks (also referred to as Trading Networks) is a component that runs on the webMethods Integration Server. Trading Networks enables your enterprise to link with other companies (buyers, suppliers, strategic partners) and marketplaces to form a business-to-business trading network. The components of Trading Networks are: a server, standalone user interface (called the Console), and a web-based user interface (called Trading Networks Web Manager).

10


Architecture and Components

Architecture and ComponentsThe following shows the components of Trading Networks:Architecture and Components Trading Networks Console

Integration ServerTrading Networks Trading Networks and WmTNWeb (WmTN and WmTNWeb packages)

Trading Networks Web Manager

Relational Database

Integration Server with the WmTN and WmTNWeb packages installed and enabled. The server handles the management of partners on your network and the exchange of documents. You interact with the server via the Trading Networks Console and/or Trading Networks Web Manager. Your partners interact with the server to exchange business documents. Relational database (RDBMS) that Trading Networks uses to store all information about the trading network: partner information, the types of documents to process, how to process business documents, information about business documents that pass through the network, log information, etc. You need to install a relational database for Trading Networks use, for example, Oracle or SQL Server. Trading Networks Console, which is a Java GUI, is the main user interface for Trading Networks. Use the Trading Networks Console to perform functions such as managing the profiles of your trading partners, designing how documents are exchanged through your network, and performing real-time monitoring and analysis. Trading Networks Web Manager is another user interface for Trading Networks that you access via a Web browser. It offers some of the functionality of the Trading Networks Console plus additional administrative actions. Small and medium size enterprises that are too small to justify integrating into the trading network with Trading Networks can use Trading Networks Web Manager as a lightweight alternative to participate and exchange business documents in the trading network. In addition, internally-focused business users and administrators can use the Web Manager to get a focused view of information flowing through the trading network. Use Web Manager to perform functions such as submitting documents to Trading Networks, viewing custom pages designed by the Trading Networks administrator, and performing real-time monitoring and analysis of documents that have passed through the Trading Networks system.


11


Trading Networks Is the Foundation for eStandards ProcessingTrading Networks is also the base through which webMethods components support numerous eBusiness Standards (eStandards) such as RosettaNet, EDI, ebXML Messaging Service, SWIFT, FIX, and CIDX. webMethods provides eStandards Modules that use features of the Trading Networks component to carry out the processing behavior that is specific to the eStandard the module supports.

Partners in a Trading NetworkTo form a trading network, you add trading partners (also known as partners) that will send documents to Trading Networks for processing and/or that will receive documents that Trading Networks is instructed to deliver. You add partners by creating a Trading Networks profile for each partner you want to add to the trading network. The profile contains information about a partner. Each of your partners has their own system that communicates with your instance of Trading Networks. Trading Networks does not require that all partners in the network use webMethods Trading Networks or webMethods software. If you have a buyer, supplier, or strategic partner that uses other software, you can add them to your network. When you add the partner by defining its profile, you provide information about how to connect to the partner and how to send that partner information.A Trading Network Integration Server Integration Server(with WmTN package) (without WmTN package)

Application Server Marketplace

DB

Integration Server(with WmTN package)


DB


DB

DB

12


Partners in a Trading Network

In the above network, one of the non-Trading Networks partners is a webMethods Integration Server that is not using Trading Networks. Also, the application server and marketplace (e.g., Ariba Network) might not use webMethods software at all. Also note in the above network, that the partner in the center is referred to as the hub of the network. The other partners are referred to as spokes. The hub hosts the network and the spokes participate by interacting with the hub. A Trading Networks partner does not have to be exclusively a hub or a spoke; it can be bothas illustrated below, it can be a hub of its own network and a spoke in another partner's network.Trading Networks Partner Can Be Both a Hub and a Spoke Integration Server Integration Server(with WmTN package) (without WmTN package)

Application Server Marketplace

DB




DB hub and spoke Integration Server(with WmTN package)

DB

DB Integration Server(with WmTN package)

DB hub and spoke


DB

DB


13


Document Processing with Trading NetworksUse Trading Networks to set up your network of trading partners in a document-oriented exchange scenario. You can exchange business documents with the partners in your network to relay production information. The business documents can be in any format recognized by two partners that exchange data, e.g., XML and flat file. Conceptually, Trading Networks is a format-neutral, business-document gateway that can recognize and process a variety of XML and structured flat-file formats that flow between distributed trading partners. To specify how to exchange documents, you use the Trading Networks Console to define: Profiles for partners; that is, the information you want to collect and maintain about your partners. A profile contains the information that Trading Networks needs to exchange documents with your partners. TN document types that specify the types of business documents that you want to exchange with your partners. The business documents might conform to an industry standard, such as, cXML, CBL, OAG, and EDI, or have your own customized specifications. Processing rules that indicate how you want Trading Networks to process documents as they traverse your trading network. After you have your trading network established, you use Trading Networks to manage and maintain your trading network.

Overview of Trading Networks ProcessingThe following diagram and accompanying text provide a high-level overview of how Trading Networks receives and processes documents.Overview of Processing

Trading Partner Client

1 2

Integration Server Trading Networks

Trading Partner Receiver

Step1 2

Description A client sends a document to Trading Networks. Trading Networks receives and processes the document. For example, Trading Networks might be instructed to deliver the document to another trading partner.

14


Overview of Trading Networks Processing

You define the processing that Trading Networks performs at run time when a document is received. You define this run time processing by defining Trading Networks objects at design time. For a list and description of these Trading Networks objects, see Design Time below.

Design TimeAt design time, you define the following objects for Trading Networks: Define for Trading Networks Profiles TN document types Document attributes

Description Identifies the partners you want Trading Networks to interact with. Defines the types of documents that you want Trading Networks to recognize and process. Identifies the pieces of information within the documents that are important to you for processing documents and for later analyzing the documents that have passed through your network. Defines the actions you want Trading Networks to take against the documents it receives, for example, delivering the document to its receiver.

For more information, see... Profiles on page 18 TN Document Types on page 30 Document Attributes on page 27

Processing rules

Processing Rules on page 35 Processing Rule Actions on page 38

Run TimeAt run time, the following actions occur: Action for Trading Networks A client or back-end system sends a document to Trading Networks Trading Networks processes the document For more information, see... Chapter 4, Sending Documents to Trading Networks for Processing Chapter 5, Trading Networks Document Processing Chapter 6, Delivering Documents to Partners

Trading Networks can deliver the document to a trading partner


15


16


CHAPTER

2

Trading PartnersOverview of Trading Partner Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Profile Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Trading Partner Agreements (TPAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21


17

CH A P T E R 2 Tr ad in g P a r t ne r s

Overview of Trading Partner InformationYou supply information about trading partners in: Profiles. Profiles are required for each partner in your trading network. To add a partner to your trading network, you define a profile for that partner. Trading Networks is only aware of partners for which it has a profile. The profile contains information such as contact information and information that Trading Networks uses when exchanging documents with the partner. Trading partner agreements (TPAs). Optionally, you can define trading partner agreements for pairs of partners. Each TPA contains specific information for two trading partners, where one partner represents a sender and the other represents the receiver. You can create applications that use TPA information to tailor how documents are exchanged. Other webMethods components (e.g., webMethods EDI Module) use TPAs to perform processing.

ProfilesA profile is a collection of information about a corporation that is a part of a trading network. Trading Networks maintains your profile (called the Enterprise profile), as well as the profile of each of your trading partners on your network. The information in a profile encompasses both technical (e.g., HTTP port number) and business level (e.g., payment terms) information. You fill in profile fields to define the information for a profile. A profile contains standard profile fields that webMethods defines and extended profile fields that you define. For more information, see Profile Fields on page 19. The information in the profile includes the following types of information: General information about the corporation, for example, the corporation name and its address. Contact information for the corporation, for example, a technical contact. Information about how documents should be delivered to the corporation, for example, the HTTP host name and port number to use to deliver a document to the corporation via HTTP. Certificate information for digital signing of documents, verifying digital signatures, encrypting and decrypting documents. Any information that you want to include in the profile that webMethods does not define. You define extended fields for this information.

18


Profiles

For more information about: Defining profiles, see Chapter 8, "Your Profile (Your Enterprise)" and Chapter 9, "Partner Profiles" in the webMethods Trading Networks Users Guide. Certificate information, see, Appendix B, Security within Trading Networks.

Profile StatusTrading Networks maintains a status for the profile of each partner. After you add a profile for a partner and Trading Networks validates the fields, Trading Networks saves the profile and sets profile status to Inactive. Before you can exchange documents with the partner, you must enable the profile by updating the status to Active. When you enable your own profile, you are able to exchange documents with partners. When you enable a partners profile, you are able to exchange documents with that partner. The following table shows the possible profile statuses and their meanings: Value Active Meaning You have filled in the partner's profile and Trading Networks has programmatically determined that all profile fields (standard and extended) are valid. You have enabled the profile by setting the status to Active. When the partner's profile is active, you can exchange documents with the partner. Inactive When a partners profile is inactive, you cannot exchange documents with this partner. Either you have just added the profile and have not yet enabled it, or you have disabled the profile.

Profile FieldsProfile fields are the fields in a profile. Each profile field represents information that you can collect and maintain about your own enterprise and the enterprises of each partner in your network. There are two types of profile fieldsstandard and extended. Standard fields are webMethods-defined fields that incorporate the majority of the information that you will want to collect and maintain about a partner. These profile fields are available out of the box. Most of the standard fields are for your own use, for example, the name of the corporation and its mailing address. However, Trading Networks requires some of the standard fields to operate normally, for example, the host and port number that a partner uses for HTTP to deliver a document to the partner via HTTP.


19


Extended fields are custom fields that you define to extend the standard profile that webMethods provides out of the box. If you want to collect additional information about your partners that is not covered by the standard fields, you can define extended fields. If you define extended fields, all profiles on your Trading Networks system will contain the standard fields and the extended fields that you define. Both standard and extended profile fields are 1) have a data type and 2) can be required. For more information about defining profile fields, see Chapter 7, "Profile Fields" in the webMethods Trading Networks Users Guide.

Data Types of Profile FieldsA profile field can have one of two data typesstring or binary. When the data type is string, you can define: A default value for the field. Trading Networks includes the default value in the partner profile that it displays. The maximum length allowed for the field. Trading Networks assures that the specified value for the field is no longer than the maximum value. A list of valid values that can be specified for a field. If valid values are specified, Trading Networks assures that the specified value for the field matches one of the valid values.

Required FieldsA required field is one that you want supplied for all profiles, both your profile and your partners. Several of the standard fields, as defined by webMethods, are required. If you want, you can change standard fields that come out-of-the-box as non-required to required. When you add your own extended fields, you can make them required. Each profile on your system must have a value for each required profile field before you can make the profile active. In other words, a partners profile must contain a valid value for all required fields before you can enable the partners profile and therefore make the partner an active member in the trading network from which Trading Networks will accept documents and to which Trading Networks can send documents. On the Profile screen of the Trading Networks Console, Trading Networks displays each required field in blue and places an asterisk (*) next to the required fields, so you can easily see the fields that are required.

20


Trading Partner Agreements (TPAs)

Trading Partner Agreements (TPAs)A Trading Partner Agreement (TPA) is an optional set of parameters that you can define and use to tailor how documents are exchanged between two trading partners. These can be any two partners, not necessarily the hub and a spoke. Both partners must have existing profiles in Trading Networks. Each TPA must have a unique combination of the following: Partner that represents the sender Partner that represents the receiver Type of TPA, represented by the Agreement ID You might have multiple TPAs for a pair of trading partners. For example, the following shows two TPAs for partners A and B that are used by the webMethods EDI Module: TPA field Partner that represents the sender Partner that represents the receiver Type of TPA (Agreement ID) TPA 1 A B EDITPA TPA2 B A EDITPA

Trading Networks does not use TPAs for its own processing. For example, Trading Networks does not use TPAs when determining the processing rules to use for a document. Rather the parameters that you specify in the TPA are available for your own use. For example, you can access the TPA information from services executed by a processing rule. Access to this information allows you to build a document exchange application that uses the TPA to tailor the exchange of documents between partners. Other webMethods components take advantage of the TPA feature in Trading Networks. For example, the webMethods ebXML Module uses the TPA feature to support ebXML Collaboration Protocol Agreements (CPAs). For more information, see the webMethods ebXML Users Guide. Based on the document exchange processing that you want to put into effect, you define the parameters that you want saved in the TPA. The set of parameters can be different for different types of TPAs. For example, you might use TPAs for partners that exchange documents using ebXML that contain the parameters defined by the webMethods ebXML Module. Other partners might exchange documents using EDI, and for those partners you create TPAs that contain parameters defined by the webMethods EDI Module. For more information, see the webMethods EDI Module Users Guide. For more information about how to define TPAs, see Chapter 10, "Trading Partner Agreements (TPAs)" in the webMethods Trading Networks Users Guide.


21


TPA Information vs. Profile InformationThe type of information that a TPA contains is different than the type of information that Trading Networks maintains in a profile. A profile contains information about the partner that does not vary with each document being exchanged (e.g., company information and address, certificate information, delivery protocol parameters, external IDs). However, TPAs are intended to contain transaction-dependent information (e.g., configuration information to support specific types of documents being exchanged) that are specific to a group of transactions between the two trading partners (e.g., digital signature or encryption to a message). The TPA augments the profile in Trading Networks and offers a flexible way to process and manage the documents exchanged between two trading partners. The primary goal of the TPA function in Trading Networks is to offer users a flexible and efficient way to define these transaction-specific parameters; users can design and store any application-specific TPA information at design time and efficiently retrieve the TPA information at run time.

Information in a TPAWhen you define a TPA, you assign the following information: The partner that represents the sender for the TPA. The partner that represents the receiver for the TPA. An agreement ID to identify the type of TPA (e.g., TPAs for the webMethods EDI Module use the agreement ID EDITPA). The TPA data that contains the application-specific variables to use to tailor the processing of documents exchanged between the sender and receiver. You specify this data by defining an IS document type that defines the structure of the data to provide. You supply values for the variables defined by the IS document type. For example, the webMethods EDI Module ships with an IS document type (the wm.b2b.editn.TPA:EDITPA IS document type) to use for TPAs for partners exchanging EDI documents. This IS document type contains a set of variables that are used for processing EDI documents. Optionally, an export service that you supply to export the TPA data. Optionally, an initialization service that you supply to initialize the TPA data (e.g., the webMethods EDI Module supplies an initialization service to set the TPA values to its default values).

22


Trading Partner Agreements (TPAs)

TPA StatusesTPAs have two types of statusesagreement status and data status. 1 Agreement status. Indicates the status of the TPA agreement between the receiver and sender.There are three TPA agreement statuses. Proposed . When the agreement status is Proposed, a TPA is in a draft status. You do most of the modification to the TPA fields and data input in this Proposed state. Agreed . An Agreed status means that the TPA is final. When the agreement status is Agreed, the data statuses take affect. Additionally, after the agreement status is Agreed, you cannot delete the TPA agreement. Disabled . The Disabled status means the TPA should not be used. If you are using a TPA and no longer want to use it, you can disable it. When you disable a TPA, the TPA remains in the Trading Networks system, but is considered inactive. Later, if you decide that you need the TPA, you can change the agreement status to Proposed or Agreed. webMethods components that use the TPA feature recognize a Disabled agreement status for a TPA. For example, if the webMethods ebXML Module attempts to use a TPA with a Disabled status, it acts as if there is no TPA. If you create an application that uses TPAs, it should check and honor the Disabled status. 2 Data status. The data status determines whether you can modify the TPA data, which is data that you supply for the IS document type you define for the TPA. That is, the TPA data is the data for the application-specific variables to use to tailor the processing of documents exchanged between a sender and receiver. The TPA data status can be: Modifiable. You can change TPA data; that is you can change the values of the variables in the IS document type associated with the TPA. Non-modifiable. You cannot change the TPA data; that is you cannot change the values of the variables in the IS document type associated with the TPA. Note: The data status is only effective when the Agreement status is Agreed. When the Agreement status is Proposed, Trading Networks allows you to make any changes to the TPA, including changing the TPA data.


23


24


CHAPTER

3

Setting Up Trading Networks to Process DocumentsOverview of Items to Set Up for Processing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35


25

C H A P T E R 3 S e t t i n g U p Tr a d i n g N e t w o r k s t o P r o c e s s D o c u m e n t s

Overview of Items to Set Up for Processing DocumentsTo set up how you want Trading Networks to process documents, you define the following Trading Networks objects: Document attributes that identify specific pieces of information that you want Trading Networks to extract from documents, for example, the sender of the document or the total amount of a purchase order. For more information, see Document Attributes on page 27. TN document types that represent the types of documents that you expect for delivery to your trading network. TN document types are definitions that represent particular categories of documents. They are typically associated with a particular formatting style and a particular business purpose. The TN document type can represent documents specific to: An internet standard, for example, a cXML Purchase Order (an Ariba cXML purchase order), FIXML Quote Request (a FIXML-formatted request for quotation), or Biztalk Envelope (a Microsoft BizTalk envelope) A custom standard used specifically for your trading partner integrations, for example, a purchase order format that you and your partner have agreed upon. In a TN document type, you specify the document attributes that you want to extract from documents that match the TN document type. For example, if you are defining a TN document type for a purchase order, you might specify to extract the attributes for the total number of items purchased and the total amount of a purchase order. For more information, see TN Document Types on page 30. Processing rules that specify the actions that you want Trading Networks to perform for the document. For example, you might specify that you want Trading Networks to deliver the document to a partner or invoke a service to process the document. For more information, see Processing Rules on page 35. For more information about: Standard and custom document attributes, including how to define custom attributes, see Chapter 11, "Document Attributes" in the webMethods Trading Networks Users Guide. How to define TN document types, see Chapter 12, "TN XML Document Types" and Chapter 13, "TN Flat File Document Types" in the webMethods Trading Networks Users Guide. How to define processing rules, see Chapter 14, "Processing Rules" in the webMethods Trading Networks Users Guide.

26


Document Attributes

Document AttributesDocument attributes identify selected content from the documents that pass through your trading network. This selected content is information in the documents that you are interested in, for example, a purchase order number or the account number of a purchaser. Trading Networks maintains two types of attributessystem attributes and custom attributes. System attributes are webMethods-defined attributes. The system attributes are: SenderID ReceiverID DocumentID User Status GroupID ConversationID Identification of the sender of a document Identification of the receiver of a document Identification of the document The status that you or a partner associate with the document Identification within a document that associates a document with other documents in a group Identification within a document that associates this document with other documents in the same business process (or conversation of documents) Portion of a document that contains data that was digitally signed Portion of a document that contains the digital signature of the document

SignedBody Signature

Although you do not define the system attributes, if you want Trading Networks to extract a system attribute from a document, you must specify that system attribute in the TN document type. For more information, see How Document Attributes Relate to TN Document Types on page 28. Custom attributes are attributes that you define to identify any other content that you are interested in extracting from documents. For example, to extract the purchase order number from documents, you might define a document attribute named PO_Number. To extract the total amount of a purchase order, you might define a document attribute named Total_Order_Amount. For more information about system and custom document attributes, including how to define custom attributes, see Chapter 11, "Document Attributes" in the webMethods Trading Networks Users Guide.


27


What You Specify to Define a Document AttributeThe definition of a document attribute consists of: Name of the attribute Description of the attribute Data type of the attribute, which can be one of: STRING, STRINGLIST, NUMBER, NUMBER LIST, DATETIME, or DATETIME LIST.

How Document Attributes Relate to TN Document TypesDocument attributes are simply definitions of the pieces of information that you are interested in from all types of documents. After you define a document attribute, you can reference the attribute in TN document types indicating that you want that piece of information extracted from documents that match the TN document types. As described above, the document attribute defines the name, description, and data type for a document attribute. When you set up a TN document type to extract a document attribute, you define how to locate an attribute within that specific type of document. Different types of documents have different formats, so the location of attributes within a document is based on the type of document. In the illustration below, there are three TN document types and a single document attribute (PO_Number). Each of the TN document types represents a different format of purchase order. All three TN document types indicate that Trading Networks is to extract the PO_Number attribute. Each TN document type specifies where in the purchase order to locate the content that should be extracted for the PO_Number attribute.

28


Document Attributes

Document Attributes and How They Relate to TN Document TypesThe definition of a document attribute specifies the name, description, and data type for a document Document #1 TN Document Type Name = OAG PO . . . Attributes PO_Number . . .

The definition of a TN document type specifies how to locate the attributes in the specific type of document.

A230

Document Attribute Name = PO_Number Type = Number Description = Purchase Order Number TN Document Type Name = cXML PO . . . Attributes PO_Number . . .

Document #2 . . .

Document #3 100

TN Document Type Name = CBL PO . . . Attributes PO_Number . . .

In the TN document type, you can also indicate that you want Trading Networks to transform the value that is extracted for an attribute. You can transform the value using either a built-in transformation (for example, upper case a STRING value), or if you need more complex transformations, you can create your own custom transformation services. Additionally, when you define the TN document type, you indicate whether you want Trading Networks to save the attribute values that it extracts to the database. If you save the attribute values, they are available for your later use. By default, Trading Networks always saves the attribute to the database.

How Trading Networks Uses Document AttributesExtracted attributes can be used in the following ways: You can select a processing rule based on the value of an extracted attribute. For example, you can select one processing rule if the sender is Partner A or another processing rule if the sender is Partner B. Another example might be to select a processing rule if the receiver is Partner B and the custom attribute for total amount of a purchase order (Total_Order_Amount custom attribute that you define) is greater than $10,000. Trading Networks requires that you extract some system attributes for normal processing. For example, if you want Trading Networks to verify the digital signature of a document, you must extract the SignedBody and Signature system attributes. Additionally, if you


29


want Trading Networks to deliver the document, you must extract the ReceiverID system attribute so Trading Networks can determine the partner that is to receive the document. If you save attribute values to the database, you can query the database based on attribute values to locate specific documents. For example, you might want to locate all documents that were sent by Partner A and have and for which the custom attribute for total amount of a purchase order (Total_Order_Amount custom attribute that you define) is greater than $10,000. For more information about: Standard and custom document attributes, including how to define custom attributes, see Chapter 11, "Document Attributes" in the webMethods Trading Networks Users Guide. How to extract attributes from TN document types, including how to transform attribute values using either the built-in transformations or your own custom transformation services, see Chapter 12, "TN XML Document Types" and Chapter 13, "TN Flat File Document Types" in the webMethods Trading Networks Users Guide. How to define processing rule criteria that uses the values of extracted attributes, see Chapter 14, "Processing Rules" in the webMethods Trading Networks Users Guide. How to query the database for documents based on the values of extracted attributes, see Chapter 18, "Managing and Tracking Documents" in the webMethods Trading Networks Users Guide.

TN Document TypesTN document types represent the types of documents that you expect to come into your trading network. TN document types include: Identification information, which indicates how Trading Networks is to recognize a type of document, for example is the document a cXML Purchase Order (an Ariba cXML purchase order) or a custom format that you and a trading partner use. Extraction information, which indicates the document attributes to extract from an inbound document. After Trading Networks matches an inbound document to the TN document type, the TN document type indicates the attributes to extract from the inbound document. For more information, see Document Attributes on page 27. Pre-processing options. In a TN document type, you can specify pre-processing options that Trading Networks performs before it performs the actions specified by a processing rule. For more information, see Pre-processing Actions on page 37.

30


TN Document Types

Trading Networks supports TN document types for two categories of documents: XML documents Flat file documents For more information about how Trading Networks uses TN document types at run time, see Recognition Processing on page 55.

TN XML Document TypesTN XML document types define how Trading Networks recognizes XML documents, where to locate attributes within an XML document, and how to pre-process the XML documents. To define TN XML document types, you specify the following types of information: Identification information. Trading Networks checks XML documents against the identification information to determine whether the document matches a defined TN XML document type. When you define the identification information for a TN XML document type, you can specify one or more of the following: Root tag that the XML document must have to match the TN XML document type. Identifying queries, which are XQL queries that Trading Networks performs against the XML document to locate specific nodes in the XML document. The nodes must be present for Trading Networks to consider the TN XML document type a match. Optionally, you can specify the value the node must have. Pipeline variables that must be present when Trading Networks is determining the TN XML document type to use. The pipeline variables that you specify must exist for Trading Networks to consider the TN XML document type a match. Optionally, you can specify the value the pipeline variables must have. Extraction information. Specifies the attributes (system attributes and custom attributes) that you want Trading Networks to extract from XML documents. You define XQL queries that Trading Networks uses to locate the attributes within the XML documents. For Trading Networks to extract a value, the node that the XQL query identifies must exist in the XML document. Optionally, in the extraction information, you can specify that you want to Trading Networks to use a built-in transformation or invoke a custom transformation service against the attribute value to alter the value of the extracted attribute. For example, you might want Trading Networks to transform a STRING value into all uppercase characters. Namespace mappings. If the XML documents use namespaces, you should specify namespace mappings to describe the namespaces that XML documents might use. Namespaces are used in an XML document to distinguish between elements that come from different sources. A set of elements (or tags) from a specific source is assigned to a specific namespace. Each namespace is associated with a URI, which is used to


31


uniquely identify the namespace. Namespace mappings map the prefixes used by namespaces to the URIs used by those namespaces. For more information about XML namespaces, see the XML Namespace specification at http://www.w3.org/. When you define namespace mappings in a TN XML document type, Trading Networks uses the namespace mappings you specify when applying XQL queries against the XML document. That is, Trading Networks uses the namespace mappings for both the identifying XQL queries and the XQL queries to extract attributes. Options. You can use the options to define items for later processing. When specifying the options for an XML document, you can specify: An IS document type that defines the structure of the XML document and that can be used to parse the XML document into an IData object. Trading Networks uses the IS document type if you invoke the wm.tn.doc.xml:bizdocToRecord service to convert the document content in the BizDocEnvelope to an IData object. A webMethods IS schema that defines the structure of the XML document. Trading Networks uses this IS schema if you indicate you want to Trading Networks to perform the pre-processing action to validate the structure of the XML document. Whether you want Trading Networks to perform any or all of the pre-processing actions. Pre-processing actions are actions that Trading Networks performs before using the processing rule actions to process the XML document. For more information, see Pre-processing Actions on page 37. Note: You specify pre-processing actions in both TN XML document types and processing rules. The pre-processing actions in a processing rule indicate whether Trading Networks is to use the settings from the TN document type or to override the TN document type settings. For more information about: How to define TN XML document type, see Chapter 12, "TN XML Document Types" in the webMethods Trading Networks Users Guide. How to define document attributes, see Chapter 11, "Document Attributes" in the webMethods Trading Networks Users Guide

TN Flat File Document TypesTN flat file document types are definitions that Trading Networks uses to recognize flat file documents. Flat file documents present complex hierarchical data in a record-based storage format which, unlike XML, does not embed structural information within the data. Trading Networks definition of a flat file is any file or document that has a format that is nondescribing, that is, a document that does not contain metadata.

32


TN Document Types

In other words, flat file data is externalized as a set of records (list of records containing fields and composites) without any structural information. As the records are not structured in the document, the application receiving the flat file must have knowledge of the structure of a flat file to read its content. When you want to process a flat file document through Trading Networks, the application that initially receives the flat file document is a document gateway service that you create.

Document Gateway ServicesFor Trading Networks to process a flat file document, you must create a document gateway service (also referred to as a gateway service). The main function of the document gateway service is to provide hints that Trading Networks uses to recognize the type of flat file document; that is, to determine which TN flat file document type the incoming flat file matches. Document gateway services are the entry points for flat files into Trading Networks. That is, rather than sending flat files directly to Trading Networks, your trading partners send their flat files to a document gateway service. After the gateway service executes, it passes control to Trading Networks. A document gateway service performs the following: Provide hints to Trading Networks to indicate the TN flat file document type to use for the flat file document. The service provides these hints in the TN_parms variable, which is located at the root of the pipeline. Specifies the attributes and their values. Because Trading Networks does have knowledge of the structure a flat file document, it cannot extract values for attributes. If you want to use document attributes, the gateway service must supply the values. Records the name of the gateway service in the pipeline. This allows Trading Networks to be able to obtain the name of the gateway service and record it in its database. Because Trading Networks records the name of the gateway service, you can resubmit the document if necessary. Passes the flat file document to Trading Networks to continue processing.

Information You Supply to Define TN Flat File Document TypesThe information you provide in a TN flat file document type indicates how to match a flat file document to a TN flat file document type, specify the attributes that Trading Networks is to associate with the flat file document, and specify options for preprocessing the flat file. To define TN flat file document types, you specify the following types of information: Identification information. Trading Networks checks pipeline hints against the identification information to determine whether to use the TN flat file document type for the flat file document. When you define the identification information for a TN flat file document type, you can specify pipeline variables that must be present. The


33


pipeline variables will be present if the document gateway service places them in the pipeline hints. Optionally, you can specify the value the pipeline variables must have. Extraction information. Specifies the attributes (system attributes and custom attributes) that you want Trading Networks to associate with the flat file document. Trading Networks looks in the pipeline for the attributes that you define in the TN flat file document type. If the document gateway service placed the attribute with its value in the pipeline, Trading Networks can associate the attribute with the flat file document. For TN flat file document types, the SenderID and ReceiverID attributes are always required. Options. You can use the options to define items for later processing. When specifying options for a flat file document, you can specify: A webMethods flat file schema that Trading Networks can use to perform the preprocessing action to validate the structure of the flat file document. Whether you want Trading Networks to perform any or all of the pre-processing actions. Pre-processing actions are actions that Trading Networks performs before using the processing rule actions to process the flat file document. For more information, see Pre-processing Actions on page 37. Note: You specify pre-processing actions in both TN flat file document types and processing rules. The pre-processing actions in a processing rule indicate whether Trading Networks is to use the settings from the TN document type or to override the TN document type settings. For more information about: How to define TN flat file document types, see Chapter 13, "TN Flat File Document Types" in the webMethods Trading Networks Users Guide. Flat file schemas and parsing flat files, see the Flat File Schema Developers Guide.

Unknown TN Document TypeEach document that passes through your system should match exactly one TN document type. To determine the TN document type to use for a document, Trading Networks looks at all enabled TN document types for that type of document. That is: For XML documents, Trading Networks matches documents against all enabled TN XML document types. For flat file documents, Trading Networks matches the flat file against all enabled TN flat file document types.

34


Processing Rules

An unknown document type can occur when a document (XML or flat file): Does not match any TN document type. Matches more than one TN document type. The document is considered to be an unknown type because Trading Networks does not know which of the multiple matching TN document types to use. In this situation, Trading Networks logs a message to the activity log that identifies all the TN document types that the document matched. Because TN document types indicate the document attributes to associate with the document, when Trading Networks cannot match a document to exactly one TN document type, it also cannot associate any attributes with the document. Trading Networks will still attempt to process documents with an unknown TN document type by performing the actions identified in the processing rule that the document triggers. You can set up processing rules that act on documents with an unknown TN document type.

Processing RulesProcessing rules specify how you want Trading Networks to process documents. Processing rules define the actions that you want Trading Networks to take for a particular document. For example, you might want Trading Networks to send an alert e-mail message to a contact and then deliver the document to the receiver that is identified in the document. For each document that Trading Networks is to process, it performs a processing rule lookup to determine which processing rule to use. To perform the lookup, Trading Networks uses criteria that you define in processing rules. Trading Networks matches information from the document against the criteria you specify. After Trading Networks locates a matching processing rule based on the criteria, it takes the actions that you specify in the matching processing rule.


35


Processing Rules

If the document information matches the processing rule criteria... Information from Document sender receiver document type user status errors? custom attributes Processing Criteria sender receiver document type user status errors? custom attributes

...perform the pre-processing and processing actions specified in the processing rule.

Pre-processing Actions verify validate check duplication save

Processing Actions Execute a service Send an alert e-mail Change the user status Deliver the document to the receiver Respond with a message

bizdoc Processing Rules

Integration Server

For more information about how to define processing rules, see Chapter 14, "Processing Rules" in the webMethods Trading Networks Users Guides

Processing Rule CriteriaThe purpose of the criteria in a processing rule is to identify the documents Trading Networks should process using the processing rule. You can define criteria that uses one or more of the following: The sender and receiver of the document. Trading Networks uses the values of the SenderID and/or ReceiverID system attributes (which identify the sender and receiver of the document) to determine the sending and/or receiving partner. Then it matches the sender or receiving partner from the document to the sender and receiver criteria you specify in the processing rule. For example, if you specify the sender criteria in a processing rule, Trading Networks uses the value extracted for the SenderID system attribute to find the profile for the sending partner. Then Trading Networks matches that partner to the sender criteria in the processing rule. The TN document type. Trading Networks matches the TN document type used for the document against the TN document type criteria you specify in the processing rule. For example, if you have a TN document type for a cXML Purchase Order, you can define criteria to select a processing rule if the document matched the cXML Purchase Order TN document type.

36


Processing Rules

The User Status system attribute. Trading Networks matches the value of the User Status system attribute to the user status criteria you specify in a processing rule. For example, you might set the User Status system attribute to PENDING in certain circumstances, and then you can define criteria to select a processing rule if the User Status system attribute is PENDING. Whether Trading Networks encountered recognition errors. For example, you might set up processing rule criteria to select the processing rule only if Trading Networks did not encounter errors determining the TN document type to use. The values of custom attributes. Trading Networks matches the values of the custom attributes that are associated with the document to the values you specify in the processing rule criteria. For example, if you have a custom attribute Total_Order_Amount, you can define criteria to select a processing rule if Total_Order_Amount is greater than $10,000. If you specify more than one criterion, a document must match all the criteria for Trading Networks to select it. For more information about how Trading Networks uses processing rule criteria at run time, see Processing Rule Selection on page 59.

Pre-processing ActionsThe pre-processing actions specify actions you want Trading Networks to take before it processes the document using the processing actions you specify. For a list of the processing rule actions, see Processing Rule Actions on page 38. Use pre-processing actions to instruct Trading Networks to: Verify the digital signature of a document Validate the structure of a document Determine whether the document has already been received by Trading Networks Save the document content, attribute values, and/or activity log information to the database Note: You can specify pre-processing actions in both TN document types and the processing rule. You can use the pre-processing actions in the processing rule to override the actions that are specified in the TN document type. For more information about how Trading Networks uses pre-processing actions at run time, see Pre-processing Actions on page 60.


37


Processing Rule ActionsThe processing actions (also referred to as processing rule actions) specify how Trading Networks is to process a document. After Trading Networks locates the processing rule to use for a document (using the criteria), Trading Networks performs the actions specified in the processing rule to process the document. Trading Networks can perform the following processing actions: Execute a service that you create. Trading Networks can execute the service synchronously or asynchronously. Send an alert e-mail message. Change the User Status system attribute that is associated with the document. Deliver the document to the receiver identified in the document. Trading Networks can deliver the document in the following ways: Immediately using delivery methods such as SMTP, HTTP, FTP, , or FTPS by invoking a delivery service that you create. For a later time using scheduled delivery. To schedule a document, Trading Networks places the document into a scheduled delivery queue that you define. When you define the queue, you associate the delivery schedule with the queue. At the times indicated by the delivery schedule, Trading Networks acts on the documents that are in the queue. For more information about queues, see Scheduled Delivery Queues and Processing Rules on page 39. Queue the document for polling. In this situation Trading Networks does not deliver the document; rather, the receiver polls for the document at a later time and Trading Networks returns the document in response to the polling. For more information about delivery options, see Chapter 6, Delivering Documents to Partners. Respond to the caller by sending a message back to the sender of the document. For more information about how Trading Networks uses processing actions at run time, see Processing Rule Actions on page 62.

38


Processing Rules

Scheduled Delivery Queues and Processing RulesIf you want to use scheduled delivery, you need to define all queues that you will want to use before you can set up the delivery action in the processing rules. A scheduled delivery queue is a grouping of documents that are intended for one or more trading partners. Trading Networks supports two types of scheduled delivery queuespublic queues and private queues. Public queues are queues that can contain documents for multiple receiving partners. Private queues are queues that contains only delivery tasks that correspond to documents aimed for a specific receiving partner. You define private queues in the profile of the receiving partner. For more information about using scheduled delivery to deliver documents, see Scheduled Delivery on page 75. For more information about: Defining public queues, see Chapter 15, "Queues in Trading Networks" in the webMethods Trading Networks Users Guide. Defining private queues for a specific partner, see Chapter 9, "Partner Profiles"in the webMethods Trading Networks Users Guide. How to set up schedule delivery, see Chapter 17, "Delivery Services" in the webMethods Trading Networks Users Guide.


39


40


CHAPTER

4

Sending Documents to Trading Networks for ProcessingOverview of Sending Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Sending Documents to Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Forwarding Documents to Another Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Sending a Document Back to the Same Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48


41

CH A P T E R 4 S e n di ng Do cu m en t s to Tr ad in g N et w o r ks f o r P r o c ess in g

Overview of Sending DocumentsTo start the run-time processing of Trading Networks, a document is sent to Trading Networks. The following lists some of the ways a document can be sent to Trading Networks: A back-end system can send a document to Trading Networks; for more information, see Sending Documents to Trading Networks on page 42. A partner can send a document to Trading Networks; for more information, see Sending Documents to Trading Networks on page 42. A partners Trading Networks system can deliver a document to your Trading Networks system; for more information, see Forwarding Documents to Another Server on page 46. Your own Trading Networks system can send a document back to your system for processing; for more information, see Sending a Document Back to the Same Server on page 48.

Sending Documents to Trading NetworksTo have Trading Networks process business documents, trading partners and back-end systems send business documents to Trading Networks. For a trading partner to send business documents, it must create an application that communicates with the server. This application is called a client. Clients and back-ends systems can use HTTP, HTTPS, FTP, FTPS, or SMTP to send the documents to Trading Networks.

Clients that Trading Partners Use to Send DocumentsFor a trading partner to send business documents, it must create a client that communicates with the server to send the business documents to the server. You can use any of the following types of clients: Java client C/C++ client Visual Basic client Excel client Browser-based client

42


Sending Documents to Trading Networks

Service the Client Should InvokeWhen a client sends a document to Trading Networks, it must specify the service that is to accept and process the document. For XML documents, the client should invoke the wm.tn:receive service. For flat files, the client should invoke a document gateway service you created, which in turn, invokes the wm.tn:receive service. For more information about flat files, see Document Gateway Services on page 33. Trading Networks protects access to the wm.tn:receive service using an Access Control List (ACL). The protection assures only partners with Trading Networks administrative authority or partner authority can invoke this service.

User Accounts for PartnersTo invoke the wm.tn:receive service, the client must supply the user name and password of a valid IS user account. When using a user account with Trading Networks administrative authority, Trading Networks always accepts and processes the document. However, you will typically not grant your partners administrative authority. Instead, they will use IS user accounts that have Trading Networks partner authority. Trading Networks creates for each partner an IS user account with partner authority when the partner is added to the trading network. The user name for the user account is one of the external IDs in the partners profile. In a Trading Networks profile, one of the external ID types is required. The required external ID type is configurable. By default, it is the D-U-N-S number. When you define a profile for a partner, you must specify a value for the required external ID type before you can make the profile active. When Trading Networks creates an IS user account for the partner, it uses the value of the required external ID type for the user name of the account. For example, if the required external ID type is DUNS, the user name is the partners D-U-N-S number. When using a user account with partner authority, Trading Networks ensures that the user invoking the wm.tn:receive service matches the sender specified within the document being sent. That is, Trading Networks uses the sender identified within the document to lookup the senders profile and ensures that the required external ID in the profile matches the sending partners user name. If the user account name does not match the required external ID in the senders profile, Trading Networks does not process the document. For more information about administrative and partner authority, see Protecting Access to the Trading Networks User Interfaces on page 106.


43

CH A P T E R 4 S e n di ng Do cu m en t s to Tr ad in g N et w o r ks f o r P r o c ess in g

Protocols the Client Can UseA Trading Networks client can send a document to the wm.tn:receive service using any of the following methods. XML document Flat File document

Method Post the document via HTTP Post the document via HTTPS Send a document via FTP Send a document via FTPS Send a document via SMTP Submit the XML document in the $xmldata variable

Client All types of clients except browser-based clients All types of clients except browser-based clients All types of clients except browser-based clients All types of clients except browser-based clients All types of clients except browser-based clients All types of clients

Note: For more details about using each of the above methods for XML documents, see the chapter about passing XML data to services in the webMethods Developer Users Guide. For more information about creating clients, see the chapter about creating client code in the webMethods Developer Users Guide. In the webMethods Developer Users Guide, clients are referred to as IS clients.

Sending the Documents to Trading NetworksWhen a client or back-end system sends a document to Trading Networks, it invokes one of the following: For XML documents, the wm.tn:receive service For flat files, the document gateway service you created, which in turn, invokes the wm.tn:receive service

44


Sending Documents to Trading Networks

Clients and Back-end Systems Sending Documents to Trading Networks

1Client (for a Trading Partner) or back-end system XMLHTTP, FTP, or SMTP

3

Integration Server1. Recognize the document. 2. Extract the attributes. 3. Perform pre-processing. 4. Perform processing actions.

2document gateway service

Flat File

Step1 2

Description The client or back-end system sends the document to the Integration Server that is running Trading Networks. If the document is a flat file, the client or back-end system should invoke the document gateway service. For more information, see Document Gateway Services on page 33. When Trading Networks receives the document, it processes the document as defined by TN document types and processing rules. Trading Networks performs the following tasks to process the document: 1 Recognizes the document using the TN document types. If the document is a flat f

web methods trading networks concepts guide 6.5

Documents

registered trademark

registered trademark

trademark of jboss

trademark of rosettanet

trademark of amdocs

trademark of computer

webmethods portal

trademark of bea systems