webMethods Trading Networks

User’s 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-UG-65-20050429

Contents

Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15

Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Chapter 1. Integration Server and Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting the webMethods Server from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Shutting Down the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17
18 18 19 19 20

Chapter 2. Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Opening and Closing Sessions on Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Familiarizing Yourself with the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The Selector Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Screen Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Display Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Refreshing the Contents of the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Basic Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Multiple Panes and Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Resizing Panes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Working with Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Right-click menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Selecting Trading Networks Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Selecting a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Selecting TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Coordinating Your Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Closing the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21
22 22 24 25 26 26 29 29 29 30 31 31 32 33 34 34 34 36 37 37

webMethods Trading Networks User’s Guide Version 6.5

3

Contents

Chapter 3. Trading Networks Web Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Chapter 4. Configuring webMethods Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Trading Networks Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the Database Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Trading Networks in a High Availability Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Shared Database in a Clustered Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Shared Database in a Non-Clustered Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Separate Database for Each Instance of Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . Configuring Trading Networks for a Clustered Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Profile Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring E-mail Settings for Document Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Tasks Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling Task Failure Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Registry Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Trading Networks for Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum Hardware Requirements for Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . Steps for Configuring Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Properties in the Trading Networks Properties File . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Other Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Customizing the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Predefining the List of Servers that You Want to Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining Proxy Servers for the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 43 44 44 45 47 48 50 51 52 54 55 56 56 57 57 58 61 61 61 63

Chapter 5. Planning Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Task 1: Identify the Types of Transactions to Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Task 2: Determine the Important Document Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Task 3: Define the Types of Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Task 4: Define Information to Maintain about Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Task 5: Create Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Task 6: Define Actions to Perform Against Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Task 7: Add Partners to Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 69 71 72 80 81 81 82

Chapter 6. Trading Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
How to Manage Partners in Your Trading Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining the Information You Want to Collect about Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Profiles for Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Steps to Setting up Profiles in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 84 84 85 85

4

webMethods Trading Networks User’s Guide Version 6.5

Contents

Chapter 7. Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What are Profile Fields? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Required Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Disabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

87
88 88 88 95 96 97 98 101 102 102 103

Chapter 8. Your Profile (Your Enterprise) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
What are Profiles? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information Trading Networks Maintains in Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information on Your Corporate Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information on Your Contact Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information on Your Delivery Method Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information on Your Extended Fields Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information on Your Security Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying Your Profile Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Profile Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling Your Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Disabling Your Profile—Changing the Status to Inactive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 106 106 109 111 113 113 115 115 116 117 117 117 129 129

Chapter 9. Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
What is a Partner’s Profile? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information Trading Networks Maintains in the Partner’s Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information on the Partner’s Corporate Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information on the Partner’s Contact Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information on the Partner’s Delivery Method Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information on the Partner’s Extended Fields Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information on the Partner’s Security Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 1: Defining a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 2: Enabling the Partner’s Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 132 132 136 137 143 144 145 146 164

webMethods Trading Networks User’s Guide Version 6.5

5

Contents

Step 3: Informing the Partner of the User Name and Password . . . . . . . . . . . . . . . . . . . . . . . . . Retrieving the Partner’s User Name and Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplying the User Account Information to Your Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About Querying and Viewing Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Basic Search Criteria for Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Custom Search Criteria for Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Detail View of Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Finding and Viewing Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing the Partner’s Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating the Profile of Your Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Disabling a Partner’s Profile—Changing the Status to Inactive . . . . . . . . . . . . . . . . . . . . . . . . . Enabling a Partner’s Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . .

165 165 166 166 167 167 168 168 173 173 174 175 176

Chapter 10. Trading Partner Agreements (TPAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
What is a Trading Partner Agreement (TPA)? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information You Supply to Define a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing TPAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Finding and Viewing TPAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating TPAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing a TPA Agreement Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing the TPA Data Inputs in the IS Document Type . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 178 181 185 185 187 188 190 192

Chapter 11. Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
What are Document Attributes? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying Disabled Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Hiding Disabled Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Disabling Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Determining the TN Document Types that Use an Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 196 198 198 198 199 199 199 200 201

6

webMethods Trading Networks User’s Guide Version 6.5

Contents

Chapter 12. TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
What Are TN XML Document Types? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 Identification Information in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 Determining the TN Document Type to Use for an XML Document . . . . . . . . . . . . . . . . . . . . . . 209 When an XML Document Does Not Match Any TN Document Types . . . . . . . . . . . . . . . . 209 When an XML Document Matches More Than One TN Document Type . . . . . . . . . . . . . . 209 Extraction Information In TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Important Attributes that You Should Extract from an XML Document . . . . . . . . . . . . . . . . . . . . 210 Indicating that Attributes are Required in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . 213 Transformation Information for Extracted Attributes of TN Document Types . . . . . . . . . . . . . . . 214 Specifying Built-in Transformation Information for SenderID and ReceiverID . . . . . . . . . . . 215 Specifying Built-In Transformation Information for Attributes with the DATETIME and DATETIME LIST Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Specifying Built-in Transformation Information for Attributes with the STRING or STRING LIST Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 Specifying Built-in Transformation Information for Attributes with the NUMBER Data Type 218 Specifying a Custom Transformation Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 Namespace Mappings in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 XML Documents and Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 How Namespaces Affect Identifying and Attribute XQL Queries . . . . . . . . . . . . . . . . . . . . . 223 Namespace Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Options in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 Specifying an IS Document Type for TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . 226 Specifying an IS Schema for TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 Specifying Pre-Processing Actions for TN XML Document Type . . . . . . . . . . . . . . . . . . . . . . . . 227 Verifying the Digital Signature of an XML Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 Validating the Structure of an XML Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 Checking for Duplicate of the XML Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 Saving an XML Document to the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 Defining TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 Using a Sample Document to Define a TN XML Document Type . . . . . . . . . . . . . . . . . . . . . . . . 233 Working with a Sample Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 Defining a TN XML Document Type without a Sample Document . . . . . . . . . . . . . . . . . . . . . . . 247 Managing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 Viewing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255 Updating TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255 Using a Sample Document when Updating a TN XML Document Type . . . . . . . . . . . . . . . 255 Updating a TN XML Document Type without a Sample Document . . . . . . . . . . . . . . . . . . . 261 Disabling TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266 Enabling TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 Testing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

webMethods Trading Networks User’s Guide Version 6.5

7

Contents

Chapter 13. TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Run-Time Processing of Flat File Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining Document Gateway Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reading the Input Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Determining the Content Type and Content Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . Converting a Flat File Document to an IS Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying the Document Gateway Services Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Pipeline Matching Criteria Used to Identify the TN Document Type . . . . . . . . . . . . . . . . . . . . . . Error Conditions When Matching Documents To TN Document Types . . . . . . . . . . . . . . . Attributes To Extract From Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Conditions When Extracting Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . System Attributes To Extract From Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Transformation Information for Extracted Attributes of TN Flat File Document Types . . . . Pre-Processing Actions in the TN Flat File Document Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . Verifying the Digital Signature of Flat File Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . Validating the Structure of Flat File Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Checking for Duplicates of the Flat File Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Saving Flat File Documents to the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Disabling TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 273 276 278 278 278 280 283 283 284 285 285 286 288 294 294 295 296 297 300 306 306 306 308 309

Chapter 14. Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
What are Processing Rules? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Rules Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Processing Rules and the Order of Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . Reordering Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Rule Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Sender and Receiver Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Type Criterion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . User Status Criterion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Recognition Errors Criterion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Extended Criteria—Using Custom Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Bypassing Lookups for Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Pre-Processing Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Duplicate Document Check Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312 313 313 316 317 317 319 319 321 322 326 327 329

8

webMethods Trading Networks User’s Guide Version 6.5

Contents

Processing Rule Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Action 1—Execute a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Executing the Service Synchronously or Asynchronously . . . . . . . . . . . . . . . . . . . . . . . . . . Service Execution Tasks and Reliable Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating the Service for the Execute a Service Processing Action . . . . . . . . . . . . . . . . . . . Action 2—Send an Alert E-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recipient of the E-mail Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subject of the E-mail Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Body of the E-mail Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Action 3—Change User Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Action 4—Deliver the Document to the Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Immediate Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scheduled Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Queued for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Preferred Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Action 5—Respond With a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying the Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying the Content Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining a Processing Rule Based on a Saved Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Up a Default Processing Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ordering the Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Testing the Order of Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About Querying and Viewing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Basic Search Criteria for Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Detail View of Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Finding and Viewing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Disabling Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

329 330 331 333 335 338 338 340 340 341 341 342 344 345 346 346 347 347 347 361 362 363 365 366 366 367 367 372 373 373 374 374

Chapter 15. Queues in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
What is a Queue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scheduled Delivery Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Delivery Schedule for Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Run Once Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Simple Interval Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Complex Interval Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378 378 380 384 385 385 386

webMethods Trading Networks User’s Guide Version 6.5

9

Contents

Scheduled Delivery Queue States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing the State of a Scheduled Delivery Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing the State of a Public Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing the State of a Private Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting up Queue for Polling to Poll on a Partner’s System . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting up Queue for Polling for webMethods for Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Documents in a Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Documents that are Scheduled for Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Documents that are Queued for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

390 391 392 393 394 394 395 396 396 397

Chapter 16. Queries in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Running Queries in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling the Query Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating and Saving a Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Selecting and Running a Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Navigating Through the Results Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating the Search Criteria for a Saved Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Saving a New Query Based on an Existing Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reverting to a Saved Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting Saved Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400 402 404 405 406 406 407 407 408

Chapter 17. Delivery Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
What is a Delivery Service? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . What is an Immediate Delivery Service? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . What is a Scheduled Delivery Service? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating an Immediate Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Retrieving the Content of a Document for Immediate Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Inputs and Outputs for a Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Inputs for Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Outputs for Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Retrieving the Content of a Document for Scheduled Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . Required Logic to Include in the Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . Typical Logic to Include in the Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . Handling Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The wm.tn.transport:batchFtp Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding and Registering New Delivery Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410 410 410 411 412 413 413 413 414 414 415 417 418 419 421

10

webMethods Trading Networks User’s Guide Version 6.5

Contents

Chapter 18. Managing and Tracking Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
About Viewing and Querying Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Transaction Analysis Basic Search Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Transaction Analysis Custom Search Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Detail View of Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Documents in Your System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Documents Using the Trading Partners Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Document Attributes and Document Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Documents that are Scheduled for Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Pollable Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting Detail View Information to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Determining the SQL for a Document Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Documents in a Partner’s System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing a Saved Document Again . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Resubmitting a Saved Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Considerations When Resubmitting a Flat File Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Steps to Resubmit a Saved Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reprocessing a Saved Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Steps to Reprocess a Saved Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Archiving and Deleting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Archiving Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Up Basic Archival and Deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting How Many Days to Retain Documents before Archival and Deletion . . . . . . . . . . . Scheduling When To Archive and Delete Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Up Configurable Archival and Deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scheduling When To Archive and Delete Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428 429 437 441 442 447 448 449 450 450 450 451 451 452 452 453 454 454 455 456 456 457 457 457 458 460 461

Chapter 19. Delivery Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
What is a Delivery Task? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About Viewing Delivery Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Delivery Task Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Task Statuses for Immediate Deliveries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Task Statuses for Scheduled Deliveries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Finding and Viewing Delivery Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing the Delivery Tasks Associated with a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting Delivery Task Information to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Running Delivery Tasks Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Stopping a Delivery Task for Immediate Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Restarting an Immediate Delivery Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 467 469 469 470 472 474 474 475 476 477

webMethods Trading Networks User’s Guide Version 6.5

11

. Migrating TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Migrating Trading Partner Agreements (TPAs) . . . . . . . . 478 Reassigning a Delivery Task to Another Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Entries that Relate to a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505 About Exporting and Importing Database Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Trading Networks Objects that You Can Export and Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Service Execution Tasks . . . . Viewing Entries that Relate to Enterprise or a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Type Dependencies . . . . Processing Rules Dependencies . . . . . The Activity Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents Deleting Delivery Tasks . . . . . . . . . . . . . . . . . . . . . . . Deleting Activity Log Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506 507 508 508 509 510 511 513 513 514 514 515 515 516 518 12 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . Why You Should Use Export/Import to Migrate Dependencies . . . . . . . . . . . . . . . . . . . . . Partner Data . . . . . . . . . . . . . . . . . . . . . . . . 482 482 485 487 488 489 489 490 491 492 Chapter 21. . . . . 479 Chapter 20. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495 What is the Activity Log? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Migrating Custom Document Attributes . . . . . . Running Service Execution Tasks Queries . . . . . . . Viewing the Service Execution Tasks Associated with a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Activity Class Values . . . . . . . . . . . . . . . . . . . Migrating Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting Service Execution Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Finding and Viewing Service Execution Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Stopping a Service Execution Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting and Importing Database Information . . . . . . . . . . . . . . . . . . . .5 . . . . . . . . . . . . . . Dependencies For Trading Networks Objects . . About Viewing Service Execution Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting Activity Log Information to a File . . . . . . . . . . . . . . . . . Partner Data Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Running Activity Log Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reassigning a Service Execution Task to Another Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing the Activity Log . . . . . . . . . . . . . . 496 497 498 498 501 502 503 503 Appendix A. . . . . . . . . . . . . . . . . . . . . . . . 481 What is a Service Execution Task? . . . . . Restarting a Service Execution Task . . . . . . . . Migrating Profile Fields . . . . . . Field Definitions Dependencies . . . . . . . . . . . . . Exporting Service Execution Task Information to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Migrating Processing Rules . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Overwrite Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Sample XML File . . . . . . . . . Defining TN Document Type XQL Queries for Large Documents . . . . . . . . 542 542 543 544 544 545 547 548 548 548 549 Index . . . . . . . . . Procedure for Importing Database Information from the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532 532 533 536 536 537 538 Appendix C. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing Database Information from the Console . . . . . . . XQL Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing Items that Have the Same Name as Existing Items . . . . . . . . . . . Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Extracting NUMBERLIST or NUMBER ATTRIBUTES . . . . . . . . . . . . . . . . . . . . What You Need to Do to Use Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . Viewing Large Documents that Trading Networks Has Processed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Determining Where the Document Content is Stored . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Extracting DATETIMELIST or DATETIME ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . tnimport Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541 Overview of Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents Migrating Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Sending Large XML Documents for Processing . Programmatically Finding Nodes in a Large Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Retrieving the Content for Document Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Features Not Available for Large Documents . . . . . . Specifying How to Import Processing Rules . . . . . . . . . . . .5 13 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the tnexport and tnimport Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Extracting STRINGLIST or STRING ATTRIBUTES . . . . Extracting Custom Attributes From XML Documents . . . . . . . . . tnexport Utility . . . . . . . . . . . . . Creating Services that Recognize Large Document Handling . . . . . . . . . . . . . . . . Example XQL Queries . . . Retrieving Document Content from Hard Disk Drive Space . . . . . . . . . . . . 531 XQL Reference Information . . . . . . . . . . . . . . . . . . . . . . . Suppressing the Overwrite Dialog Box and Forcing the Overwrite of Items . . Exporting Database Information from the Console . . . . . . . . . . . . . . . . . . . . . Large Document Handling . . . . . . . . . . . . 519 519 521 521 522 523 524 524 526 526 527 528 529 Appendix B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Contents 14 webMethods Trading Networks User’s Guide Version 6.5 .

It also describes how to define how you want Trading Networks to process business documents that are sent to your trading network. including how to define and update the information you want to collect about trading partners and how to add and maintain partners to your trading network. Identifies characters and values that you must type exactly or messages that the system displays on the console. Identifies storage locations for services on the webMethods Integration Server using the convention folder. Directory paths use the “\” directory delimiter unless the subject is UNIX-specific. Keys that you must press simultaneously are joined with the “+” symbol. Document Conventions Convention Bold Italic Description Identifies elements on a screen. Narrow font Typewriter font UPPERCASE \ [] webMethods Trading Networks User’s Guide Version 6. and webMethods for Partners allows you to have only a single partner. Identifies variable information that you must supply or change based on your specific situation or environment.5 15 . including searching and viewing documents that have flowed through your network and viewing audit logs of events that have occurred in your trading network system.About This Guide About This Guide This manual describes how to configure Trading Networks and how to plan for your trading network. Optional keywords or values are enclosed in [ ]. Do not type the [ ] symbols in your own code. Identifies terms the first time they are defined in text.subfolder:service. Identifies keyboard keys. This guide provides documentation for both components although it refers only to webMethods Trading Networks (referred to as Trading Networks). this manual contains procedures for analyzing the exchange of documents in your trading network. Also identifies service input and output variables. It provides procedures for setting up Trading Networks to build your trading network and how to manage an existing trading network. The difference between the components is that webMethods Trading Networks allows you to have as many partners in your network as you want. Additionally. Note: The webMethods Trading Networks and webMethods for Partners components perform the same functionality.

com provides you with important sources of information about webMethods components: Troubleshooting Information. Additional Documentation. webMethods provides troubleshooting information for many webMethods components in the webMethods Knowledge Base. 16 webMethods Trading Networks User’s Guide Version 6. go to the Documentation Feedback Form on the webMethods Bookshelf.webmethods.About This Guide Additional Information The webMethods Advantage Web site at http://advantage.5 . All webMethods documentation is available on the webMethods Bookshelf. To provide documentation feedback to webMethods. Documentation Feedback.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Starting the Integration Server . . . . 20 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . . . . . . . . . .CHAPTER 1 Integration Server and Trading Networks Overview . . . . . . . . . . . . . . . . . .5 17 . . . . . . . 18 Shutting Down the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Configuring Trading Networks . . . . . . . . . . . . . . . . . . .

"Overview of webMethods Trading Networks" in the webMethods Trading Networks Concepts Guide. and management tasks that you can perform for the webMethods Integration Server also apply to the Trading Networks. In addition. webMethods Servers webMethods Integration Note: When you installed the Trading Networks. you installed additional packages into the webMethods Integration Server. the WmPublic package must be enabled. Execute this script.5 . how to start and shut down the server. you must start the Integration Server. Note: For Trading Networks to function properly. This chapter describes basic tasks that you will need to perform when using the server.C H A P T E R 1 I n t e g r a t i o n S e r v e r a n d Tr a d i n g N e t w o r k s Overview To use webMethods Trading Networks (Trading Networks). select Programs Server. Installing the Trading Networks added functionality to the webMethods Integration Server. specifically. To start the Integration Server on UNIX 1 2 Locate the server. For more information on the WmPublic package and how to assure a package is enabled. To start the Integration Server on Microsoft Windows 1 On the Start menu. all configuration.sh script file that you modified for your environment when you installed the server. For more information about the architecture and components of webMethods Trading Networks. see Chapter 1. the Integration Server must be running to use the Console or Trading Networks Web Manager. Because Trading Networks is seamlessly integrated into the webMethods platform. see the webMethods Integration Server Administrator’s Guide. administration. Starting the Integration Server The Integration Server must be running in order for you to set up and manage Trading Networks and for your partners to submit documents to the trading network. 18 webMethods Trading Networks User’s Guide Version 6.

Shutting Down the Integration Server Shut down the server to stop the Integration Server and all active sessions. start your browser and point it to the host and port where the Integration Server is running. For instructions on how to start the Integration Server from the command line and a description of the parameters you can specify. click the Shutdown and Restart link.Shutting Down the Integration Server Important! Run this script when logged in as a non-root user.5 19 . Delay number minutes or until all client sessions are complete. To open the webMethods Administrator. you can restore the console’s session on the server. It also lets you start the Integration Server in “debug” mode. When you shut down the Integration Server. see the webMethods Integration Server Administrator’s Guide. type: http://QUICKSILVER:4040 2 3 In the upper right corner of any webMethods Administrator screen. Trading Networks begins monitoring user activity and automatically shuts down when all non-administrator sessions complete or when the maximum wait time you specify elapses (whichever comes first). webMethods Trading Networks User’s Guide Version 6. Specify the number of minutes you want the Integration Server to wait before shutting down. Starting the webMethods Server from the Command Line There are times when it is useful to start the Integration Server from the command line. To shut down the server 1 Open the webMethods Administrator if it is not already open. Example If the server were running on port 4040 on a machine called QUICKSILVER. Starting the Integration Server this way allows you to override certain configuration settings. so you can record or display the activity occurring in the Integration Server. Immediate. the Trading Networks automatically closes its session on the server. Select whether you want the server to wait before shutting down or to shutdown immediately. The server and all active sessions terminate immediately. Running the script as root might reduce the security of your system. When you start the server again.

you can specify the database you want to use and the parameters that control how Trading Networks delivers documents. see Chapter 4. Configuring Trading Networks You can configure the Integration Server to suit your site. For complete information. 4 Click Shutdown. see the webMethods Integration Server Administrator’s Guide. 20 webMethods Trading Networks User’s Guide Version 6. For example.5 . “Configuring webMethods Trading Networks”.C H A P T E R 1 I n t e g r a t i o n S e r v e r a n d Tr a d i n g N e t w o r k s For instructions on how to view the active sessions.

. . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Selecting Trading Networks Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 21 . . . . . . . . . . . . . . . . . . 37 Closing the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Basic Operations . . . . . . . . . . . . . . . . . . 22 Opening and Closing Sessions on Servers . . . . . . . . . . . . . . . . . . . . . . . . . .CHAPTER 2 Trading Networks Console Overview . . . . . . . . 24 Familiarizing Yourself with the Trading Networks Console . . . . . . . . . . . . . . . . 37 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Starting the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Coordinating Your Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

To start the Trading Networks Console 1 On the Start menu. administration. In addition. Starting the Trading Networks Console Use the following procedure to start the Trading Networks Console on your workstation. and management tasks that you can perform for the webMethods Integration Server also apply to the Trading Networks. configuring how documents are exchanged through your network. you must start the Integration Server. This chapter provides procedures for how to start and exit from the Console. Use the Trading Networks Console to perform functions such as managing your trading partners. webMethods Trading Networks Console. In addition..5 .CH A P T E R 2 Tr ad in g N et w o r ks Co n so l e Overview The Trading Networks Console (Console) is a standalone Java GUI. it contains information to help you become familiar with how to use the Console. Because Trading Networks is seamlessly integrated into the webMethods platform. and performing real-time monitoring and analysis To use webMethods Trading Networks (Trading Networks). You cannot work with the Console if the server is not running..and enter a user account that has administrator privileges 22 webMethods Trading Networks User’s Guide Version 6. . the Integration Server must be running to use the Trading Networks Console or Trading Networks Web Manager.. Important! Make sure that the Integration Server with which you want to use the Console is running. which is the main user interface for webMethods Trading Networks (Trading Networks). all configuration.. select Programs Specify the name and port assignment of a Trading Networks Server.

complete the following: In this field.5 23 . To open a session on the selected server using the Secure Socket Layer (SSL). User Name The name of a valid user account on this server. Server Specify. select this check box. and setting inputs for a TPA. IS passwords are case-sensitive. To open a session on the selected server using your proxy server. Whether the connection will be made through HTTP or HTTPS. For information about defining default proxy servers.. see “Defining Proxy Servers for the Console” on page 63.. select this check box. webMethods Trading Networks User’s Guide Version 6.Starting the Trading Networks Console 2 In the Open Session dialog box..and lower-case characters with which it was originally defined. specifying a custom duplicate checking service or custom attribute transformation service for a doctype. (The user name must be a member of a group belonging to the Administrators ACL and a member of a group belonging to the Developers ACL. browsing for an IS doctype for a TPA. Whether the Trading Networks opens a session on the server through the default proxy server. Password The password for the user account in User Name. You can select a server from this list or type a different server name and port number. Example localhost:5555 Note: Servers to which you have successfully logged on in the past are listed in the Server list. Use the exact combination of upper. Use the exact combination of upper. The name and port assignment of the Integration Server in ServerName:PortNum format. such as: specifying a service for a routing rule or a delivery queue.and lower-case characters with which the user name was originally defined.. Use secure connection Use proxy server 3 Click OK. IS user names are case-sensitive.) Note: The user name must be a member of a group belonging to the Developers ACL because Trading Networks actually launches the Developer for some tasks.

Before you switch to another server. If you have unsaved work. To close a session on the current server 1 2 Save any work that you want to keep. you are prompted to save it. Trading Networks automatically closes the session you have on that server. You can open a session on only one webMethods Integration Server at a time. Note: If you already have a session opened on a Integration Server. Click OK. Important! While the Trading Networks Console has an open session on a Integration Server. The Trading Networks Console maintains an open session on that server until you exit Trading Networks or switch to another server. you must first close the session on the current server.5 . When you are not actively using Trading Networks. 2 3 Complete the Opening Session to Integration Server dialog box. See step 2 on page 23 for instructions. 24 webMethods Trading Networks User’s Guide Version 6. To open a session on a different server 1 Select File Open Session.CH A P T E R 2 Tr ad in g N et w o r ks Co n so l e Opening and Closing Sessions on Servers When you start Trading Networks. Select File Close Session. you are using a licensed seat for that server. you are prompted to log on to the Integration Server that you want to work with. you might want to close the session on the server or close Trading Networks to free a seat on the server for others to use.

g.5 25 . Profiles table) webMethods Trading Networks User’s Guide Version 6..Familiarizing Yourself with the Trading Networks Console Familiarizing Yourself with the Trading Networks Console The Trading Networks Console screen contains several different parts: Menu bar Selector panel with selector panel buttons Screen name Toolbar Display area Trading Networks Console for the Trading Partners screen Selector panel Screen name Toolbar Display area showing query tabs Display area Display area showing the query results table (e.

The following table lists the selector panel buttons. e.g. Add. close. In addition. Additionally. and access the registry settings so that you can define public queues and add profile groups. etc. the host of the Trading Networks system. meaning the partner hosting the network. “Your Profile (Your Enterprise)”..CH A P T E R 2 Tr ad in g N et w o r ks Co n so l e The Menu Bar The Trading Networks menu options are: File: Use to open. edit. View: Use to select the screen you want to display. You change the screen view of the Trading Networks Console by selecting one of these selector panel buttons. and view the profile information for your corporation. see Chapter 8.. This Selector Panel icon. select View Buttons. Tools: Use to access the Profile Assistant. access the Developer. To turn the selector panel buttons on/off... Enterprise 26 webMethods Trading Networks User’s Guide Version 6. The Selector Panel Use the selector panel buttons to choose what type of information you want to view about your trading network (Enterprise) or a partner. Enterprise menu item for the Enterprise profile screen. Screen function: Use to perform action specific to the screen you are viewing. you can access the Profile Fields screen from the Enterprise profile screen. Enterprise is also referred to as the local partner. For more information about your company’s profile. Performs this function. along with a description of each button.. and restore sessions on Integration Servers and to close the Trading Networks Console. Transactions menu item for Transaction Analysis screen. The menu option allows you to perform functions that correspond to toolbar functions for the screen. Help: Use to access help information for Trading Networks. Edit: Use to set preferences. Trading Networks displays the appropriate menu option for the screen you are viewing.5 . use it to export/import database information as a deployment tool to move data from development to production environment within the same Trading Networks release.

Familiarizing Yourself with the Trading Networks Console

This Selector Panel icon...

Performs this function... Trading Partner: Displays information for a trading partner in your trading network. To select a different partner for which you want to view information, perform a query on the Profiles list. Note that this list also includes your Enterprise partner as well. For more information about your partner’s profile, see Chapter 9, “Partner Profiles”. In addition, you can access the Profile Fields screen from the Trading Partners profile screen. Define and manage TN document types, specify attributes for Trading Networks to extract from the document, and specify options for pre-processing. In addition, you can access the Document Attribute screen from the Document Types screen. If you are using an OEM version of the Trading Networks, you cannot create new TN document types in Trading Networks. Trading Networks will gray out this unavailable feature. For more information about TN document types, see Chapter 12, “TN XML Document Types” and Chapter 13, “TN Flat File Document Types”. Define and manage processing rules, which Trading Networks uses to determine how to process the documents sent to your Trading Networks system. For more information about processing rules, see Chapter 14, “Processing Rules”. Define and manage Trading Partner Agreement (TPA) parameters that will specify how to govern transactions between two trading partners. You can also view and query TPAs. For more information about TPAs, see Chapter 10, “Trading Partner Agreements (TPAs)”.

Trading Partners

Document Types

Processing Rules

Agreements

webMethods Trading Networks User’s Guide Version 6.5

27

CH A P T E R 2 Tr ad in g N et w o r ks Co n so l e

This Selector Panel icon...

Performs this function... Track and manage documents in your system by querying the Trading Networks database for the documents in which you are interested. Note: If you are using an OEM version of the Trading Networks, this Trading Networks feature is not available through the Trading Networks Console. To view documents, use Trading Networks Web Manager. For more information about transaction analysis, see Chapter 18, “Managing and Tracking Documents”. View the status and detail of delivery and service execution tasks. You can also restart or delete tasks. Note: If you are using an OEM version of the Trading Networks, this Trading Networks feature is not available through the Trading Networks Console. To view tasks, use Trading Networks Web Manager. For more information about tasks, see Chapter 19, “Delivery Tasks” and Chapter 20, “Service Execution Tasks”. Access the activity log that records the activity occurring within the Trading Networks system. This includes activity while managing your partners; while documents are being received, processed, and delivered; as well as administrative actions performed for your Trading Networks system. For more information about the activity log, see Chapter 21, “The Activity Log”.

Transaction Analysis

Tasks

Activity Log

Note: If you are using an OEM version of Trading Networks, not all Trading Networks’ features are available. Trading Networks grays out these unavailable features.

28

webMethods Trading Networks User’s Guide Version 6.5

Familiarizing Yourself with the Trading Networks Console

Screen Name
The screen name shows the selector panel function you have selected (e.g., Trading Partners).

Toolbar
The buttons on the toolbar are function-specific for each of the Console screens. These toolbar buttons are a quick alternative method to access most of the basic menu functions for that screen.

Display Area
The display area contains the corresponding Trading Networks Console screen based on the selector panel button or Trading Networks function you have selected. Appropriate window panes, pop-up windows, and tab groups, including the query functions, also appear in this area. See “Basic Operations” on page 31 for a description of these window elements. The query functions may not initially appear on your Console screen, as shown below.
The Trading Partners screen with no query tabs displayed

Display area showing only the query results table (e.g,. Profiles table)

webMethods Trading Networks User’s Guide Version 6.5

29

CH A P T E R 2 Tr ad in g N et w o r ks Co n so l e

To view the query tabs on the Console screen as shown below, click Show Query toolbar.
Trading Partners screen displayed with query tabs

on the

Display area showing query tabs...

... and the query results table (e.g, Profiles table) below

To return to the table view, click Hide Query

on the toolbar.

For more information about the query functions, see Chapter 16, “Queries in Trading Networks”.

Refreshing the Contents of the Console
The Console is not dynamically updated when other users who have open sessions on the same server add, delete, or update documents, profiles, etc. To refresh the contents of the Console while you are working with Trading Networks, click Refresh bar. To update and see the results of the query table, click Run Query on the menu on the toolbar.

30

webMethods Trading Networks User’s Guide Version 6.5

Basic Operations

Basic Operations
This section describes basic operations you can perform with the Trading Networks Console.

Multiple Panes and Tabs
On some screens, the Trading Networks Console display area is divided into multiple panes. Click on the split pane controls or
Multiple pane window displaying a single pane

symbols to expand the panes.

Single (upper) pane

Click the split pane controls to expand the bottom pane

webMethods Trading Networks User’s Guide Version 6.5

31

CH A P T E R 2 Tr ad in g N et w o r ks Co n so l e

Multiple pane window displaying both panes

Upper pane

Lower pane

Sometimes, editing controls within a pane are grouped onto tabs. To display the contents of a tab, click the tab’s name.

Resizing Panes
You can resize panes in the Trading Networks screen by dragging borders with your mouse. Movable borders are typically marked with the split pane controls or symbols.

32

webMethods Trading Networks User’s Guide Version 6.5

Basic Operations

Resizing a Pane

Drag this border (where the split pane controls are located)...

...to resize the lower pane

You can also click the lower pane.

symbols to expand a pane to the full height or width of the

Working with Tables
In general for most tables (e.g., Profiles table on the Trading Partners screen), use the following buttons to supply information to Trading Networks: Use this button To... Add a row entry Edit a row entry Delete a row entry You can reorganize the information displayed in a table in the following ways: Reposition table columns: Use click-and-drag. Click on the column you want to move, drag it to the appropriate location, and then release the mouse when the column is correctly placed.

or

webMethods Trading Networks User’s Guide Version 6.5

33

CH A P T E R 2 Tr ad in g N et w o r ks Co n so l e

Adjust column width: Place the cursor over the edge of a column and then drag the border until the column is the desired width. Sort the information in a column: Click the column header for forward ( ( ) alpha-numeric order. ) and reverse

For more information about query result tables, see “About Viewing and Querying Documents” on page 428.

Right-click menus
Most Trading Networks screens have a right-click menu that contains the basic menu functions for that screen. The actions you can perform from this menu mimic the functions you can perform using the toolbar.

Selecting Trading Networks Objects
Many of the screens and query panels on the Trading Networks Console use the same buttons for selecting various Trading Networks objects (e.g., partner profiles and document types). For example, the Select... button appears on the Trading Partners, Agreements, Processing Rules, and Transaction Analysis screens so you can select the partner profile.

Selecting a Partner
If you need to select a partner profile, you can use Select... ; for example, when you .

create processing rule criteria, you can select a Sender or Receiver by clicking Select... To select a profile for Sender, Receiver, or Partner 1 2 Click Select... . Trading Networks displays the Partner Selection Dialog.

Select the profile from the list of partners in the Partner Selection Dialog table. You can select Unknown if you want to select a profile for which the partner is not known. To select multiple profiles from the partners list, use the following keys: Hold this key... <Shift> <Ctrl> To select... A contiguous block of profiles More than one non-contiguous profiles

34

webMethods Trading Networks User’s Guide Version 6.5

Selecting Trading Networks Objects

3 4

Click OK to select the partner profile(s). If you wish to search for a specific profile, click the Show Query button on the toolbar. Trading Networks expands the Partner Selection dialog to show the Basic Criteria, Custom Criteria, and Detail View tabs. Use these tabs to specify more detailed search criteria to select a partner profile. To use this tab... Basic Criteria Custom Criteria Use this procedure... Step 4a on page 169 Step 4b on page 170 For more information, see... “Basic Search Criteria for Profiles” on page 167 “Custom Search Criteria for Profiles” on page 167

For more information about searching for partner profiles, see “About Querying and Viewing Profiles” on page 166. 5 6 To run the query, click the Run Query toolbar button.

To change the format of the query results in the Profiles table, click the Detail View tab. Fill in the following fields to specify how Trading Networks displays information in the Detail view. a In the Standard Fields section, check each field that you want Trading Networks to include in the Detail view. Trading Networks displays a column for each checked field. Trading Networks always displays the Corporation Name column for each partner profile. In the Extended Fields section, select the extended fields that you want Trading Networks to include in the Detail view. Trading Networks displays a column for each field in the Selected Extended Fields list. To move items to the Selected Extended Fields list: Select this... To do this... To move all extended fields to the Selected Extended Fields list To move some but not all extended fields to the Selected Extended Fields list, select one or more fields in the Available Extended Fields list and then click .

b

webMethods Trading Networks User’s Guide Version 6.5

35

CH A P T E R 2 Tr ad in g N et w o r ks Co n so l e

If you decide you do not want Trading Networks to display information for the fields in the Selected Extended Fields list, move the items back to the Available Extended Fields list:
.

Select this...

To do this... To remove some but not all extended fields from the Selected Extended Fields list, select the extended fields you do not want displayed from the Selected Extended Fields list and then click . To remove all extended fields from the Selected Extended Fields list.

For more information about: Searching for partner profiles, see “About Querying and Viewing Profiles” on page 166 Running queries in Trading Networks, see Chapter 16, “Queries in Trading Networks” The Detail View tab of the Trading Partners screen, see “Detail View of Profiles” on page 168. Changing the display table format, see “Working with Tables” on page 33.

Selecting TN Document Types
If you need to select a TN document type, use Select Document Type , which accesses the Document Type Selection Dialog. For example, when you create processing rule criteria, you can select a Document Type by clicking Select Document Type To select a TN document type 1 Click Select Document Type . Trading Networks displays the Document Type Selection Dialog, which lists all of the TN document types (both the TN XML document types and TN flat file document types). To view disabled TN document types, select Types Show All. Trading Networks places a check ( ) next to the Show All menu item to indicate that Trading Networks is currently displaying disabled TN document types. Select the row containing information about the TN XML document type or TN flat file document type that you want. .

2

3

36

webMethods Trading Networks User’s Guide Version 6.5

Coordinating Your Work

To select multiple TN document types from the list by, use the following keys: Hold this key... <Shift> <Ctrl> To select... A contiguous block of TN document types More than one non-contiguous TN document types

Trading Networks displays the Document Type Details dialog for the selected TN document type. 4 Click OK.

For more information about TN document types, see Chapter 12, “TN XML Document Types” and Chapter 13, “TN Flat File Document Types”.

Coordinating Your Work
If you will have more than one Trading Networks administrator, the administrators should coordinate their work. If more than one Trading Networks administrator accesses the Trading Networks Console and edits the same item (e.g., document type, profile, profile field, etc.) simultaneously, the administrators might inadvertently overwrite one another’s work.

Closing the Trading Networks Console
To close the Trading Networks Console, follow the single-step procedure below. To close the Trading Networks Console 1 Select File Exit.

webMethods Trading Networks User’s Guide Version 6.5

37

CH A P T E R 2 Tr ad in g N et w o r ks Co n so l e 38 webMethods Trading Networks User’s Guide Version 6.5 .

Web Manager is also known as Partner Connect Express. Web Manager users can view profiles. see the webMethods Trading Networks Web Manager Administrator’s Guide. For example. Web Manager (Partner Connect Express) is a web interface to webMethods Trading Networks. It is located in the following location: webMethods6\IntegrationServer\packages\WmTNWeb\pub\doc\wMTN_WebMgrGuide.CHAPTER 3 Trading Networks Web Manager Web Manager is another user interface to webMethods Trading Networks (Trading Networks). Web Manager provides a limited set of the functionality that is available through the Trading Networks Console. search for documents.pdf webMethods Trading Networks User’s Guide Version 6. In addition. For more information about Web Manager.5 39 . you add functionality to Web Manager to allow users to exchange business documents and participate in the trading network through the web. and check the status of documents.

CH A P T E R 3 Tr ad in g N et w o r ks Web Man a ge r 40 webMethods Trading Networks User’s Guide Version 6.5 .

. . 48 Configuring Profile Settings . . . . . . . . . . . 61 Customizing the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Configuring Trading Networks for a Clustered Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Configuring Registry Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Configuring the Database Settings . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Configuring Trading Networks for Large Document Handling . . . . . . . . . 50 Configuring E-mail Settings for Document Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Configuring Tasks Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . .CHAPTER 4 Configuring webMethods Trading Networks Trading Networks Configuration Properties .5 41 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Other Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cnf You can update the configuration properties using the TN Properties page of the Server Administrator. Trading Networks updates all properties with the values from the TN Properties page. The Server Administrator opens a new browser window to display Trading Networks-specific pages. This is important if you are using Trading Networks in a clustered environment and have the tn. In the Settings menu of the navigation panel. To see a list of the Trading Networks configuration properties and a description of each. If you want the servers in the cluster to maintain different values for some of the properties. click Trading Networks. and maintain the properties for each server individually.5 . The procedures in this chapter describe how to access the TN Properties page. set the tn. Important! When you use the TN Properties page and save your updated properties. click TN Properties.cluster. In the Solutions menu of the navigation panel. view the online help files that you access from the TN Properties page.C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s Trading Networks Configuration Properties You perform most Trading Networks configuration tasks by updating the Trading Networks properties. In the upper right corner of the TN Properties page. To view online help for the Trading Networks configuration properties 1 2 Open the Server Administrator if it is not already open. 3 4 42 webMethods Trading Networks User’s Guide Version 6. which appear in: webMethods6\IntegrationServer\packages\WmTN\config\properties. including those that you might not have altered.cluster.notifyPropertyChange property to false. Using the TN Properties page to update properties when you are in a clustered environment will cause Trading Networks to synchronize all properties each time you use the TN Properties page.notifyPropertyChange property set to true. click Help.

Configuring the Database Settings Configuring the Database Settings When you installed Trading Networks. If you want to change these parameters (for example. However. see the webMethods Logging Guide for general instructions. “Exporting and Importing Database Information”. webMethods Trading Networks User’s Guide Version 6. A user name and password—If the database requires a user name and password to connect to it. see Appendix A. Database properties—If you want Trading Networks to supply any additional database properties when connecting to the database. Important! If you change the database after using Trading Networks. Then. Trading Networks does not copy the data in the current database to the new database. For more information. after you change the database. you identified the database properties.5 43 . you can import the exported information into the new database. to adjust the minimum and maximum connections). you specified the following database connection parameters: The JDBC driver—The name of the JDBC driver for database. The location of the database—A URL to specify the location of the database. you identified the user name and password that Trading Networks must supply. you can use the Trading Networks export and import facility to export data from your existing database.

5 .remoteAliases server property for each instance of Trading Networks.cnf file Be sure that the application code you need Trading Networks to execute (e.sync. The Integration Server system properties are in the webMethods6\IntegrationServer\config\server.g. see “Cluster Properties” in the Trading Networks properties online help. you must decide whether to share a single Trading Networks database among the Trading Networks instances.. see “Trading Networks Configuration Properties” on page 42. See the webMethods Integration Server Clustering Guide for more information about running servers in a cluster. delivery services. you should share a single Trading Networks database among the Trading Networks instances. Shared Database in a Clustered Environment Setting up the servers Set the tn.. Be sure that all Integration Server system properties are identical for all servers in the clusters.g.C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s Trading Networks in a High Availability Environment To meet your high availability requirements. etc. 44 webMethods Trading Networks User’s Guide Version 6. and you configure all Trading Networks systems to use the same database. you can still share a single Trading Networks database among the Trading Networks instances. services invoked from processing rules. you might need to use multiple instances of Trading Networks. when one of your adapters does not work in a clustered environment). If you do not cluster your Integration Servers (e. The following lists possible scenarios: If you cluster your Integration Servers. For more information about this property.cluster. For instructions about how to access the online help. You can also use multiple Trading Networks instances that each use their own database. Shared Database in a Clustered Environment For this option.) is available on all servers in the cluster. See “Configuring Trading Networks for a Clustered Environment” on page 48 for more information about running Trading Networks in a cluster. When you use multiple instances of Trading Networks. Trading Networks is running on two or more Integration Servers that are in a clustered environment.

are automatically shared by all servers that share the database. delivery services. Be sure that the application code you need Trading Networks to execute (e.g. Define remote aliases for each server sharing the database. webMethods Trading Networks User’s Guide Version 6.tn.tn.remoteAliases server property for each instance of Trading Networks that will be sharing the database. services invoked from processing rules.admin:setProperties service. Note: If you change the server properties by directly editing the webMethods6\IntegrationServer\packages\WmTN\config\pr operties.cnf file for each server. see “Cluster Properties” in the Trading Networks properties online help. All configuration data and run-time data (e.sync.. see “Trading Networks Configuration Properties” on page 42. attributes. Be sure that all Integration Server system properties are identical for all servers. This is required even though the servers are not clustered. documents received from partners.admin:setProperties service are automatically replicated to all servers in the cluster.g. You set remote aliases using the Server Administrator. see the webMethods Trading Networks Built-in Services Reference. etc. The instances of Trading Networks are not running on servers in a clustered environment. activity log. For more information about the wm.) is available on all servers.cnf file. The Integration Server system properties are in the webMethods6\IntegrationServer\config\server.. Shared Database in a Non-Clustered Environment Setting up the servers Set the tn. etc. etc. For instructions about how to access the online help.cnf file. Changes you make to Trading Networks server properties using the TN Properties page or by invoking the wm.. profiles.Configuring the Database Settings Shared Database in a Clustered Environment Behavior of Trading Networks Changes you make to Trading Networks objects (e. Shared Database in a Non-Clustered Environment For this option.5 45 .cluster. you configure two or more instances of Trading Networks to use the same database. processing rules. TN document types.g.) is shared among all instances of Trading Networks in the cluster. For more information about this property.). you must manually make your changes to the properties. This is required even though the servers are not clustered.

5 . specify the host name and port name of one of the Trading Networks instances that share the database. This is important because Trading Networks stores the results of the database queries in the repository.g. profiles.cnf file for each server. activity log. First Page. You can use a load balancer to “cluster” Trading Networks only if your application code is stateless and you are not using stateful processes (e. you must manually make your changes to the properties.. Changes you make to Trading Networks server properties using the TN Properties page or by invoking the wm. To use the Console query paging feature (e. documents received from partners. This server will not have the query results that the Console is attempting to retrieve.g. etc.tn. Behavior of Trading Networks Changes you make to Trading Networks objects (e.tn. be sure to connect it to one of the Trading Networks instances.C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s Shared Database in a Non-Clustered Environment If you want each instance of Trading Networks to have the same Web Manager configuration.admin:setProperties service are automatically replicated to all servers that share the database. All run-time data (e. see the webMethods Trading Networks Built-in Services Reference. attributes. and do not specify the virtual IP address defined by the load balancer. If you connect the Console to the load balancer. TN document types. Next Page. long-running conversations). 46 webMethods Trading Networks User’s Guide Version 6. Last Page). are automatically shared by all servers that share the database.g.). processing rules.) is shared among all instances of Trading Networks that share the database..admin:setProperties service. be sure to configure Web Manager the same for each instance of Trading Networks.g. etc... when you start the Console. the load balancer might redirect query paging results to a different server than the one that originally executed the query. That is.cnf file. Prev Page. Note: If you change the server properties by directly editing the webMethods6\IntegrationServer\packages\WmTN\config\pr operties. For more information about the wm.

. attributes.g. For more information.g. TN document types. are not shared by all servers. You cannot cluster the Integration Servers because the Trading Networks database is not shared. you must ensure that: All Integration Server system properties are identical for all servers. attributes. Behavior of Trading Networks Changes you make to Trading Networks objects (e..Configuring the Database Settings Separate Database for Each Instance of Trading Networks For this option. etc. services invoked from processing rules. TN document types. profiles. Changes you make to Trading Networks server properties are not replicated to all servers. The Trading Networks server properties are in the from the TN Properties page of the Server Administrator. profiles.). processing rules. be sure that the application code you need Trading Networks to execute (e. etc.cnf file. You can view and set these properties If you want all instances of Trading Networks to be able to handle all incoming documents. webMethods6\IntegrationServer\packages\WmTN\config \properties.g. “Exporting and Importing Database Information”.). You need to make the changes to each instance of Trading Networks if you want to keep them in sync. see Appendix A.cnf file. you have multiple instance of Trading Networks running. Separate Database for Each Instance of Trading Networks Setting up the servers If you want each instance of Trading Networks to have identical versions of Trading Networks objects (e. If you want all servers to have identical configurations. The Integration Server system properties are in the webMethods6\IntegrationServer\config\server. Each instance of Trading Networks is unaware of other the other instances of Trading Networks. processing rules.) is available on all servers. All Trading Networks server properties are identical for all servers. you must use the Trading Networks’ import/export feature to copy the data from one server to the other. You need to make the changes to each instance of Trading Networks if you want to keep them in sync. but you configure each to use its own database. delivery services.. webMethods Trading Networks User’s Guide Version 6. etc.5 47 .

notifyPropertyChange properties in the properties. perform the following: a b Open the Server Administrator if it is not already open. you can configure Trading Networks so that the data cached in memory. For example. and Trading Networks properties are synchronized on all servers in the cluster. 2 To update the Trading Networks properties. click Trading Networks. click TN Properties. These synchronizations are controlled by the tn.cnf file for each Integration Server in the cluster. c 48 webMethods Trading Networks User’s Guide Version 6. and a remote server alias for Server1 on Server2. see “Trading Networks Configuration Properties” on page 42. activity log. documents received from partners. see webMethods Integration Server Administrator’s Guide. user accounts. For information on how to create a remote server alias. an Acknowledgement document that is sent to server A cannot be related to the Confirmation document if the Confirmation document is sent to server B. In the Settings menu of the navigation panel. if you have two servers (Server1 and Server2) in the cluster.cnf file.C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s Separate Database for Each Instance of Trading Networks An instance of Trading Networks does not share its run-time data (e. create a remote server alias for the other servers in the cluster. tn.notifyProfileAddUser. For example. For instructions about how to access the online help.cluster. etc.notifyCacheChange.. To configure Trading Networks for a clustered environment T 1 On each Integration Server in the cluster.cluster. Configuring Trading Networks for a Clustered Environment If Trading Networks is running on an Integration Server in a cluster of servers.g.cluster. In the Solutions menu of the navigation panel. For information on these properties. you need to create an additional remote server alias for the server specifically for the Trading Networks cluster. The Server Administrator opens a new browser window to display Trading Networksspecific pages.) with the other instances of Trading Networks. You cannot relate documents sent to and processed by one server to documents sent by and processed by another server. and tn. Important! If you have already created a remote server alias so the server is part of an Integration Server cluster (without Trading Networks). you would create a remote server alias for Server2 on Server1.5 . see “Cluster Properties” in the Trading Networks properties online help.

Trading Networks updates all properties with the values from the TN Properties page.notifyPropertyChange property to false. modify the respective property in the Trading Networks properties. For a description of the properties used in this procedure. To view the online help. webMethods Trading Networks User’s Guide Version 6. If you want the servers in the cluster to maintain different values for some of the properties. For example. After completing the above procedure. This is important if you are using Trading Networks in a clustered environment and have the tn. and Trading Networks properties are automatically synchronized on all Integration Servers in the cluster. see “Cluster Properties” in the Trading Networks properties online help...cluster.cluster.notifyProfileAddUser property. tn.. To turn one of these synchronizations off for a server. you would disable automatic user account creation by turning off the tn.cluster. f Ensure the following properties are set to true: Set this property to true.notifyPropertyChange property set to true. user accounts..cnf file..remoteAliases Specify.5 49 .Configuring Trading Networks for a Clustered Environment d e Click Edit TN Properties Settings.. Add or update the following property: For this property. if you wanted to manually control user account creation.cluster. and maintain the properties for each server individually. Using the TN Properties page to update properties when you are in a clustered environment will cause Trading Networks to synchronize all properties each time you use the TN Properties page. set the tn. The remote server aliases you created in step 1..sync.notifyProfileAddUser tn. tn. A change to data cached in memory New user accounts A change to Trading Networks properties Important! When you use the TN Properties page and save your updated properties.notifyCacheChange tn. including those that you might not have altered.cluster.notifyPropertyChange To notify all servers in the cluster about. the data cached in memory.. click the Help link on the TN Properties page.cluster.cluster.

In the Settings menu of the navigation panel.g.C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s Configuring Profile Settings When you add a profile for a partner.. DUNS) that Trading Networks uses for the user name of a webMethods account that it creates for the partner. tn.idType Specify... In the Solutions menu of the navigation panel.5 . Click Edit TN Properties Settings. To configure profile settings.g. click Trading Networks. The Server Administrator opens a new browser window to display Trading Networks-specific pages.. You configure the required external ID type that Trading Networks uses for the user account.. click TN Properties. 50 webMethods Trading Networks User’s Guide Version 6.required. The external ID Trading Networks uses is the value of the required external ID type. The external ID type (e.. Add or update the following property to define the profile setting: For this property. When you add a profile. Trading Networks requires and uses a D-U-N-S number (DUNS external ID type). By default. perform the following procedure: To configure profile settings 1 2 Open the Server Administrator if it is not already open. Trading Networks uses the value of one of the external IDs (e. Trading Networks creates a webMethods user account for the partner. 3 4 5 6 Click Save Changes. D-U-N-S number) that you specify in the profile for the user name. Trading Networks will not allow you to make the profile active if you have not supplied a value for the required external ID type.

In the Settings menu of the navigation panel. specify the following: tn. click TN Properties.from=TNAdmin@ifc.com 3 4 5 tn.mail.subject The subject line you want Trading Networks to use in the email messages that it sends to deliver a document when instructed to use an e-mail delivery method (Primary E-mail or Secondary E-mail). specifically.mail. the “from” e-mail address and subject line that you want Trading Networks to use in the e-mail messages.5 51 . Example: If you want the e-mail messages to use the subject line “Document from IFC”. To configure e-mail settings for document delivery To 1 2 Open the Server Administrator if it is not already open.mail. Add or update the following properties to configure how Trading Networks performs document delivery: For this property… tn. specify the following: tn.com.Configuring E-mail Settings for Document Delivery Configuring E-mail Settings for Document Delivery You can configure settings Trading Networks uses when delivering documents via an e-mail message. The Server Administrator opens a new browser window to display Trading Networks-specific pages. webMethods Trading Networks User’s Guide Version 6.mail.from Specify… The e-mail address you want Trading Networks to use as the “from” e-mail address in the e-mail messages that it sends to deliver a document when instructed to use an e-mail delivery method (Primary E-mail or Secondary E-mail). Example: If you want the e-mail messages to use the “from” email address TNAdmin@ifc. In the Solutions menu of the navigation panel. click Trading Networks. Click Edit TN Properties Settings.subject=Document from IFC 6 Click Save Changes.

Note: If you want to be notified when tasks fail.rec:TaskFailure IS document type. you need to create an Integration Server trigger that subscribes to the wm. The number of seconds the reliable task manager thread remains idle before checking for tasks it needs to perform (for example.C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s Configuring Tasks Settings Trading Networks establishes tasks when it is to deliver a document using reliable delivery or when it is to asynchronously execute a service using reliable execution. a task to deliver a document or execute a service). The Server Administrator opens a new browser window to display Trading Networks-specific pages. The task manager thread waits the number of seconds you specify with this property before waking up to check for tasks it needs to process. see the Publish-Subscribe Developer’s Guide.task.tn. 3 4 5 52 webMethods Trading Networks User’s Guide Version 6. The tasks that the task manager attempts to process when it wakes up are those tasks that failed on their last attempt and have not yet reached their retry limit Note: The task manager wakes up immediately if a new task arrives. In the Settings menu of the navigation panel. Add or update the following property to configure settings that affect both delivery and service execution tasks: For this property. To configure tasks settings 1 2 Open the Server Administrator if it is not already open.sweepTime Specify. The task manager thread becomes idle when all tasks are completed. failed.. For more information. tn. In the Solutions menu of the navigation panel. or in the wait period between attempts. You can configure settings that Trading Networks uses when processing these tasks... click TN Properties.5 . Click Edit TN Properties Settings. For more information about these tasks. click Trading Networks. see “Using Reliable Delivery with Immediate Delivery Method” on page 343 and “Service Execution Tasks and Reliable Execution” on page 333..

.sweepTime value.task.task. The number of times you want Trading Networks to attempt to re-execute a service.task.task. the task manager thread will not wake up to process the task until the tn.. the wait between retries value is governed by one of the following: Type of task Delivery Service execution Wait between retries is governed by… The Wait between retries value on the Delivery Method tab of the receiving partner’s profile. tn.maxRetries tn..) The factor you want Trading Networks to use when determining how long to wait before making the second and subsequent attempts to re-execute the service.task.task. These settings configure how many times Trading Networks attempts to execute services that use reliable execution and how long Trading Networks waits between attempts to re-execute a service that failed.retryFactor webMethods Trading Networks User’s Guide Version 6. Typically.retryFactor value along with the tn.task. Trading Networks could wait as long as the tn.task. The tn. (Trading Networks uses the tn. Specify a whole number greater than zero for tn. The number of milliseconds you want Trading Networks to wait before making its first attempt to re-execute a service when the first attempt failed. Example: The following shows sample values for the these properties and how they affect the wait times between attempts to re-execute a failed service.retryFactor value..retryFactor.5 53 .sweepTime can affect how long Trading Networks waits between attempts to retry a task.task.task.sweepTime value expires. Specify a whole number. However.task.ttw value to calculate how long to wait for subsequent retry attempts. 6 Add or update the following properties to configure settings that affect only service execution tasks. For this property. tn. If the task manager thread is idle when the wait between retries value expires.ttw Specify. Trading Networks calculates the time to wait by multiplying the last wait time by the tn.Configuring Tasks Settings The value you specify for tn.ttw property value.

The Server Administrator opens a new browser window to display Trading Networks-specific pages. click Trading Networks.task. tn. You can create an Integration Server trigger that subscribes to IS documents of this IS document type. Specify.rec:TaskFailure IS document type..maxRetries tn. In the Settings menu of the navigation panel. Trading Networks publishes an IS document with the format defined by the wm. When this property is true. make sure the tn.task. In the Solutions menu of the navigation panel. Enabling Task Failure Notification If you want to be notified when a task fails.notifyFailure property is set to “true”. see the WmTNSamples package. see PublishSubscribe Developer’s Guide.. click TN Properties. Click Edit TN Properties Settings. To configure Trading Networks to publish an IS document when a task fails To 1 2 Open the Server Administrator if it is not already open.5 .C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s For this property.task.ttw tn. For information on creating an Integration Server trigger. 3 4 54 webMethods Trading Networks User’s Guide Version 6.retryFactor = 3 = 10000ms = 3 Retry 1 Wait until next attempt 10000 ms Retry 2 30000 ms Retry 3 90000 ms 7 Click Save Changes.task.. For an example of a trigger.tn..

To associate profiles to a profile group.. To create and register a profile group in Trading Networks..notifyFailure Specify. A profile group is a logical user-defined group that you associate a profile with. Tools Registry Public Queue For the following. Tools Registry Profile Groups webMethods Trading Networks User’s Guide Version 6. you can associate a partner profile (including your Enterprise profile) with any profile group and to more than one group. Configuring Registry Settings Trading Networks maintains/contains a registry for setting public queues and creating new profile groups. Once you create a profile group.5 55 . Either true or false. For instructions for this procedure.. For more information. you can create a group profile named “Buyers” to associate all of your partner profiles who are buyers in your trading network... use the Profile Group Membership field on the Corporate tab of the Profile screen.. true if you want Trading Networks to publish an IS document false if you do not want Trading Networks to publish an IS document 6 Click Save Changes. For example..task.Configuring Registry Settings 5 Add or update the following property to enable Trading Networks to publish an IS document in the event that a task fails: For this property. To define these registry settings. Perform this... tn. see “Defining Public Queues” on page 380. To define and register a public queue. see the “Information on Your Corporate Tab” on page 106 and “Information on the Partner’s Corporate Tab” on page 132. use the Tools menu of the Console.

Minimum Hardware Requirements for Large Document Handling The following lists the required minimum requirements and the recommended hardware requirements for using the Large Document Handling facility of Trading Networks. see Appendix C. you would need a hard disk drive space that is 10 to 15 times the combined size of the documents being processed concurrently. 56 webMethods Trading Networks User’s Guide Version 6. For more information about the areas in Trading Networks that are affected by large document handling. You can configure Trading Networks to handle large documents differently. if your typical concurrent document load is 10. "Trading Networks Document Processing" in the webMethods Trading Networks Concepts Guide. You also configure the document size that Trading Networks should treat as large. you need to define hard disk drive space where Trading Networks can temporarily save documents (rather than store them in memory). For example. Trading Networks acts on all documents in the same manner regardless of their size. It does not account for the hard disk drive space that is necessary for temporarily saving the large documents during processing.C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s Configuring Trading Networks for Large Document Handling As installed. See the Important! note below for more information about additional hard disk drive space required for large document handling. Important! The hard disk drive space listed above identifies only the amount of hard disk drive space that Trading Networks requires for normal processing. see the section about large document handling in Chapter 5. To learn more about large document handling. “Large Document Handling”.5 . Required Hard Disk Space 100 MB† † Recommended # of CPUs 1CPU Hard Disk Space 256 MB† RAM 1 GB # of CPUs 2CPU RAM 512 MB Note that this is only the space required for normal processing. The size of the hard disk drive space for temporarily saving documents will vary based on the number of documents that you process concurrently and the size of the documents that you process. To use large document handling.

you need to set configuration properties in the Trading Networks properties file and perform configuration tasks on the Integration Server. To configure Trading Networks for large document handling T 1 2 Open the Server Administrator if it is not already open.000 bytes as large: tn.BigDocThreshold Specify. The default is -1.. Trading Networks considers all documents greater than 1.Configuring Trading Networks for Large Document Handling Steps for Configuring Large Document Handling To use large document handling.5 57 . 0: Specify zero to have Trading Networks consider all documents as large. n: Specify a positive whole number to indicate the number of bytes over which Trading Networks considers a document large. reading the document content into memory during processing. In the Settings menu of the navigation panel. For example. Trading Networks processes all documents in the traditional manner. tn. In the Solutions menu of the navigation panel.. Click Edit TN Properties Settings and add or update the following properties to define the profile setting: For this property. Specify one of the following: -n: Specify a negative number to have Trading Networks consider no documents as large. Setting Properties in the Trading Networks Properties File To configure Trading Networks to use large document handling. The Server Administrator opens a new browser window to display Trading Networks-specific pages.000. How many bytes a document must contain for Trading Networks to consider the document to be large.. Trading Networks uses large document handling for all documents. click Trading Networks. if you specify the following. click TN Properties..BigDocThreshold=1000000 3 4 webMethods Trading Networks User’s Guide Version 6. Because all documents that Trading Networks receives contains more than 0 bytes. perform the following procedure.

see “Defining TN XML Document Types” on page 232. specify the following: tn.000 bytes. restart the server.cnf Before you edit the configuration file. For more information. In your TN XML document types. update the following properties in the Integration Server configuration file: webMethods6\IntegrationServer\config\server. shut down the Integration Server. or if the value that you specify is negative.. Trading Networks needs to read at least 1. After you make the changes.000 bytes to perform document recognition. If you do not specify a value for tn.xqlThreshold.BigDocThreshold. The number of bytes that Trading Networks reads into memory to perform the XQL queries in a TN XML document type.xqlThreshold Specify.BigDocThreshold.xqlThreshold=50000 If you do not specify a value for tn. tn. 58 webMethods Trading Networks User’s Guide Version 6.. 5 Click Save Changes. To configure the Integration Server.xml. the queries will fail.. Specify a positive whole number.xml. if you have XQL queries that point to nodes beyond the number of bytes that Trading Networks reads. Trading Networks defaults to 1.xml.5 . you also need to configure settings for the webMethods Integration Server. Configuring the Integration Server In addition to setting configuration properties for Trading Networks. if the XQL queries that you specify reference nodes in the first 50. For example. Trading Networks uses the number of bytes that you specify for tn..C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s For this property.000 bytes of the document.

be sure to use a double backslash (\\) in place of a single backslash in the directory path because Trading Networks reads the property as a Java String.tspace.tspace. Trading Networks.location=D:/opt/webmethods/ tspace If you do not specify a value for watt.tmpDir.max=30000000 webMethods Trading Networks User’s Guide Version 6.Configuring Trading Networks for Large Document Handling For this property.tspace..server. watt. Trading Networks uses the value defined by the Java system property java. Each file that the Integration Server stores in this directory is given the name DocResxxxxx. For example: For Windows: watt. For UNIX: watt.tspace.location.428.g. For example: watt.server.server. Specify any positive whole number of bytes. The default is 52.tspace. webMethods EDI Module. an error message is displayed on the server console and the document is not stored. All components use the same location and the Integration Server manages allotting space to each component.tspace.. If Trading Networks (or another webMethods component) attempts to write a large document to the hard disk drive space that will cause the number of bytes you specify to be exceeded. where xxxxx is a value that can vary in length and character.5 59 .location property.location=D:\\LargeDocTemp When specifying the directory path. watt.800 bytes (50 MB). use this property to define a single hard disk drive location... The directory you specify is on the same machine as the Integration Server.server.server. The absolute directory path of the hard disk drive space where Trading Networks is to temporarily store large documents rather than keep them in memory.io..max The maximum number of bytes that can be stored at any one time in the hard disk drive space that you defined using the watt.tspace.server. which defaults to the value of the environment variable Temp on most platforms.dat.server. location Specify. Note: If you are setting up large document handling for multiple webMethods components (e. and webMethods RosettaNet Module).

Rather it is just to accommodate the length of time it takes to receive a response to a read request. Important! The size of the hard disk drive space for temporarily saving documents will vary based on the number of documents that you process concurrently and the size of the documents that you process.. Note: If you are setting up large document handling for multiple webMethods components.server. If the Integration Server does not receive a response in the specified amount of time. Note: The value you specify with watt.5 .keepAliveTimeout=180000 The default value is 15000 (15 seconds).server.. For example. keepAliveTimeout The maximum number of milliseconds that you want the Integration Server to wait for a response after making a request to read from a network InputStream. Specify a whole number greater than zero. 60 webMethods Trading Networks User’s Guide Version 6. Specify.C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s For this property.server. all components use this property... watt. The Integration Server waits the amount of time you specify with the watt. for example: watt. you would need a hard disk drive space that is 10 to 15 times the combined size of the documents being processed concurrently. the Integration Server makes a request to read from the InputStream.keepAliveTime property for a response. When you submit a document using a Java InputStream over a network to the Integration Server. The Integration Server ensures that the hard disk drive space use for all components does not exceed the value you specify. if your typical concurrent document load is 10.keepAliveTime does not need to be long enough to accommodate reading the entire document.server. It is recommended that you set this property to 180000 (3 minutes). it times out with the error “Connection reset by peer”.

To predefine the list of servers to which you want to open sessions. see “Opening and Closing Sessions on Servers” on page 24. By default.) You can customize the list of servers that Trading Networks displays in the list on the Open Session dialog box.5 61 .Other Configuration Settings Other Configuration Settings For instructions on how to perform the following configuration tasks. For example. see the webMethods Integration Server Administrator’s Guide: Setting or updating the webMethods Integration Server license key Defining listening ports Allowing and denying inbound connections to the Integration Server Specifying a proxy server Specifying error message recipients Customizing the Trading Networks Console Customize the Trading Networks Console by setting preferences. perform the following procedure. Trading Networks displays the Open Session dialog box. You can set Console preferences to: Predefine a list of Integration Servers that the Console displays in the Open Session dialog box Define proxy servers that the Trading Networks Console must use to access an Integration Server Specify how you want Trading Networks to filter the list of partners in the selector panel and what order to display this sorted filtered partners list Predefining the List of Servers that You Want to Use When you start the Trading Networks Console or when you select File Open Session in the Trading Networks Console to open a session on a different Integration Server. (For more information about opening sessions on an Integration Server. the Trading Networks Console displays the localhost:5555 and other servers on which you have previously opened a session. webMethods Trading Networks User’s Guide Version 6. This dialog box contains a list of Integration Servers from which you can select. if your site runs more than one Integration Server. you might want to predefine the list with the identification of all your servers.

62 webMethods Trading Networks User’s Guide Version 6.C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s To predefine the list of servers on which you want to open sessions 1 2 3 4 5 Start the Trading Networks Console. To add a new server to the list. Select the Servers tab. .5 . select this checkbox. Be sure to use the correct combination of upper. click OK. Example: rubicon:5555 User Name The user name of the user account on the Integration Server that you want Trading Networks to display in the User Name field of the Open Session dialog box when the server specified by Server is selected. Trading Networks automatically selects the Use secure connection checkbox in the Open Session dialog box when the server specified by Server is selected. Trading Networks displays the server with the user name from the first entry in the list of servers in the Open Session dialog box. For this Server Information parameter… Host:Port Specify… The name of the Integration Server that you want to appear in the Open Session dialog box. Select Edit Preferences. Type the name of the server in ServerName:PortNumber format. The user name must identify a valid webMethods User account on the associated server. Use secure connection Whether you want the connection to this server to be made through HTTP or HTTPS. Trading Networks displays the Specify the following parameters. If you select this checkbox.and lowercase letters because user names are casesensitive Note: If you add the same server more than one time specifying different user names. then. see “Starting the Trading Networks Console” on page 22. If you need procedures for this step. click Add Row Server Information dialog box. To use HTTPS.

see “Starting the Trading Networks Console” on page 22. then. webMethods Trading Networks User’s Guide Version 6. 7 To remove a server from the list. Defining Proxy Servers for the Console The Trading Networks Console can use a proxy server when opening a session on an Integration Server. Trading Networks automatically selects the Use proxy server checkbox in the Open Session dialog box when the server specified by Server is selected. see “Defining Proxy Servers for the Console” on page 63. click OK. 6 To edit the information for an existing server in the list. If you need procedures for this step. To indicate you want to use a proxy server for the connection. To define proxy servers for the Console to use 1 2 3 Start the Trading Networks Console. If you have not defined proxy information. 8 When you have completed making your changes. To define proxy servers. If you select this checkbox. Type the changes in the appropriate field. Select the checkbox to use a proxy server. When this box is checked. perform the following procedure. (For more information about opening sessions on an Integration Server from the Console. click the row you want to delete. Trading Networks looks up the proxy information to use in the Trading Networks Console preferences. you will receive an error and will be unable to open the session on the server using a proxy server. click the row you want to update. Select the Proxies tab. click Edit .5 63 . see “Opening and Closing Sessions on Servers” on page 24. Select Edit Preferences.Customizing the Trading Networks Console Use proxy server Whether you want the connection to this server to be made through the default proxy server. check the Use proxy server check box in the Open Session dialog box. click Remove Row .) You can define a proxy server that you want the Trading Networks Console to use when opening a session on a server via HTTP and/or a proxy server to use when opening a session via HTTPS. For information about defining default proxy servers. then.

leave this field blank. If you do not know this name. contact your network administrator. Password 5 To define a proxy server that the Console uses when opening a session on a server via HTTPS (secure). If you do not know this name.5 . contact your network administrator. and do not leave spaces. This entry is case-sensitive. The password that the Trading Networks Console is to use to access the HTTP proxy server. For this Proxies tab parameter… Host:Port Specify this for HTTPS (secure)… The address of the HTTPS proxy server in ServerName:PortNumber format. If your proxy server does not require a password. This entry is case-sensitive. Type a valid user name for the proxy server specified in Host:Port. Be sure to place a colon between the server name and the port number. 64 webMethods Trading Networks User’s Guide Version 6. specify the following parameters. and do not leave spaces Example: secureproxy:8080 User Name The user name that the Trading Networks Console is to use to access the HTTPS proxy server. leave this field blank. leave these fields blank. If you do not know the password. For this Proxies tab parameter… Host:Port Specify this for HTTP… The address of the HTTP proxy server in ServerName:PortNumber format. leave these fields blank. contact your network administrator.C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s 4 To define a proxy server that the Console uses when opening a session on a server via HTTP. This entry is case-sensitive. If you do not want to use a proxy for HTTP requests. specify the following parameters. Type the password for the user name specified in User Name. Be sure to place a colon between the server name and the port number. If your proxy server does not require a user name. If you do not want to use a proxy for HTTPS requests. Example: myproxy:8080 User Name The user name that the Trading Networks Console is to use to access the HTTP proxy server. If your proxy server does not require a user name. Type a valid user name for the proxy server specified in Host:Port. leave this field blank.

click OK. 6 When you have completed making your changes. Type the password for the user name specified in User Name. If your proxy server does not require a password. contact your network administrator.5 65 . leave this field blank.Customizing the Trading Networks Console Password The password that the Trading Networks Console is to use to access the HTTPS proxy server. If you do not know the password. This entry is case-sensitive. webMethods Trading Networks User’s Guide Version 6.

5 .C H A P T E R 4 C o n f i g u r i n g w e b M e t h o d s Tr a d i n g N e t w o r k s 66 webMethods Trading Networks User’s Guide Version 6.

. . . . . . . . . . . . . .CHAPTER 5 Planning Your Network Introduction . . . . . . 80 Task 5: Create Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 67 . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Task 3: Define the Types of Documents . . . . . . . . . . . . . . . . . . 72 Task 4: Define Information to Maintain about Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Task 7: Add Partners to Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Task 6: Define Actions to Perform Against Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Task 2: Determine the Important Document Information . . . . . . . . . . . . . . 82 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . 68 Task 1: Identify the Types of Transactions to Process . . . . . . . . . . . . . . . . . . . . .

6. Create the profile for your own corporation. you have defined the document attributes. 2. Determine the information that you want to maintain about your partners. use this information to define the profiles you want to keep about partners. If problems arise. You can migrate your document attributes. see Appendix A. After you perform these tasks. you can use your development system to test your trading network to ensure it processes documents as you intended. profile fields. This chapter describes the tasks to perform to plan for and set up your trading network. The tasks are presented in the proposed order in which you should complete them. profile fields.C H A P T E R 5 P l a n n i n g Yo u r N e t w o r k Introduction Before you begin planning your network. 72 80 5. Description Identify the types of transactions that Trading Networks will need to handle. For more information. based on your unique situations. After you ensure your trading network is defined properly. however. Define the types of documents you want Trading Networks to recognize. you might want (or need) to perform the tasks in an alternative order. 4.5 . it is helpful if you have a basic understanding of Trading Networks and how the Trading Networks Console is set up. 81 81 82 Tasks 1 through 6 define the behavior of your trading network. see the webMethods Trading Networks Concepts Guide. For more information. “Exporting and Importing Database Information”. processing rules. You might want to perform these tasks in a development environment. Add partners to your network. Define the actions that you want Trading Networks to take against the documents it receives. After Tasks 1 through 6 are completed. The general order of tasks is: Task 1. and processing rules that determine how Trading Networks processes documents that enter your system. See page… 69 71 3. migrate your information to a production environment. TN document types. TN document types. 7. you can correct them. 68 webMethods Trading Networks User’s Guide Version 6. and your profile into your production system using the export and import facility that Trading Networks provides. Determine the pieces of information within documents that are of interest to you and define this information to Trading Networks.

For example. etc. for example. For example. Place the samples in a directory that you will have available when using the Trading Networks Console. For example. Although it is not necessary. you might receive EDI. you might send documents that represent purchase orders. you need to define the types of documents that your Trading Networks system will receive. Obtain sample files. This first task is to identify the transaction types that your Trading Networks system will receive. The description of each task points to sections of this manual or other manuals that describe more information about the task and how to perform the steps required to complete each task. acknowledgements. 2. etc. The following sections provide more information about each task required to set up your trading network. that is. you can perform Task 7. cXML. it is helpful if you can obtain a representative sample document for each variation of a transaction type. This is applicable for XML documents only. Task 1: Identify the Types of Transactions to Process To exchange documents with trading partners. webMethods Trading Networks User’s Guide Version 6. Action Determine types of transactions. This is applicable for XML documents only.). and CBL. purchase orders. and CBL purchase orders. confirmations. You should know the types of transactions you will be exchanging with your trading partners (your suppliers. business partners. Task 1: Identify the Types of Transactions to Process Step 1. you need to determine the variations of each transaction. Determine variations of transaction types. available to promise. add partners to your network. determine the variations of that transaction that you receive. In addition. OAG.Task 1: Identify the Types of Transactions to Process After you have migrated information to your production system. 3. etc. you might receive purchase orders in cXML. For each type of transactions.5 69 .

For more information about transforming XML documents to IS documents (IData objects). set up IS document types for each variation of an XML document. For flat file documents: For flat file documents. You need to write a document gateway service to provide information hints for the Trading Networks recognition process. see the Flat File Schema Developer’s Guide 5.xml:bizdocToRecord built-in service that is described in the webMethods Trading Networks Built-in Services Reference. you must create schemas. Create a document gateway service. For information about creating IS document types. and outbound documents to be converted to a flat file for delivery to another’s back-end system. Create webMethods IS document types.C H A P T E R 5 P l a n n i n g Yo u r N e t w o r k Task 1: Identify the Types of Transactions to Process Step 4. see the webMethods Integration Server Schema Reference.5 . see the webMethods Developer User’s Guide. 70 webMethods Trading Networks User’s Guide Version 6. If you want Trading Networks to be able to programmatically validate the structure of the documents it receives.doc. Action Create webMethods schemas. 6. A document gateway service is the entry point for flat file documents into Trading Networks. This enables inbound flat file documents to be parsed and validated for use by back-end systems. you can create a flat file schema that contains a particular TN document type’s structural information. To transform the XML documents to an IS document (IData object) to allow you to manipulate the document within a service.tn. see “Defining Document Gateway Services” on page 276. This is applicable for flat file documents only. This is applicable for XML documents only. For more information about the flat file schema and parsing. see the wm. For more information about the document gateway service.You build/create your own flat file schema in webMethods Developer. For information about creating IS schemas. including how to identify records and separate those records into fields. For XML documents: For XML documents. you must create IS schemas for each variation of a transaction type. Your trading partners send their flat files to the document gateway service so that Trading Networks can process the documents.

OAG purchase order. define a custom attribute for total purchase order. you can define custom document attributes. and CBL purchase order all have some piece of information that represents the total purchase amount.5 71 . To identify other pieces of information within a document that are of interest. You do not define multiple custom attributes. The information that Trading Networks extracts is available to determine how to process the document and for you to use for reporting. For example. you have to define the pieces of information within documents that are important to you. a cXML purchase order. you can have Trading Networks extract information from documents. one for each variation of webMethods Trading Networks User’s Guide Version 6. Trading Networks provides a different way to do this for TN flat file document types) DoctypeID or DoctypeName—The Trading Networks-generated internal identifier or name of the TN flat file document type that you want Trading Networks to use for a TN flat file document type processingRuleID or processingRuleName—The Trading Networks-generated internal identifier or name of the processing rule that you want Trading Networks to use for a TN flat file document type The system attributes are available out of the box. Typically.Task 2: Determine the Important Document Information Task 2: Determine the Important Document Information To process and analyze the types of information that pass through your network. in this case. For example. you might be interested in the total amount of purchase orders you receive. Trading Networks refers to these pieces of information as document attributes. You do not need to define them. and you cannot delete them. For Trading Networks to extract information. webMethods defines the following system document attributes: SenderID—Identification of the partner that sent the document ReceiverID—Identification of the partner that is to receive the document DocumentID—Identification of the document UserStatus—A status that you or a partner has associated with the document GroupID—Identification within a document that associates this document with other documents in its group ConversationID—Identification within a document that associates this document with other documents in the same “conversation” of documents SignedBody and Signature—Portions of the document that contain the data that was digitally signed and the digital signature (available only for TN XML document types. You can use it to search for specific documents that have been sent through your system or to gather information about the documents that have been sent through your system. the documents for all variations of a transaction type have the same pieces of information.

complete the following tasks: Task 2: Determine the Important Document Information Step 1. For instructions. determine whether the document has been received before. For each piece of information (attribute) that is of interest to you. For each variation of a transaction. The preprocessing actions indicate whether Trading Networks is to verify the document’s digital signature. Optionally. see “Defining Document Attributes” on page 196.5 .C H A P T E R 5 P l a n n i n g Yo u r N e t w o r k a transaction type—define a single custom attribute that can be used for all variations of the transaction type. Use the Trading Networks Console and the information from Step 1 to define the attribute. complete the following tasks: 72 webMethods Trading Networks User’s Guide Version 6. Action Identify the attribute. Note: If you are using an OEM version of the Trading Networks. you cannot create new TN document types in Trading Networks Console. you might want to give the attribute a description. you can define the TN document types for each of the variations of documents that Trading Networks will receive for a transaction. NUMBER. and/or save the document to the Trading Networks database. When documents are first received. or DATETIME) for the value of the attribute. Trading Networks will gray out this unavailable selection. 2. Define the custom document attribute. Select a name for the attribute and the data type (STRING. Trading Networks uses the TN document types to recognize the type of document and perform actions based on the TN document type. validate the structure of the document. The actions it performs based on the TN document type are to create the attributes from the document and to perform pre-processing actions against the document. Task 3: Define the Types of Documents After you identify the types of transactions that your Trading Networks system needs to process and have defined the attributes that are of interest to you.

if you are defining a cXML purchase order.Task 3: Define the Types of Documents Task 3: Define the Types of Documents Step 1. You can have Trading Networks create any or all of the system and custom attributes from XML and flat file documents. Identify the contents of the document that uniquely indicate that a document is this variation of a transaction. identify the parts of the document that uniquely identify a document as a cXML purchase order—it might be that the root tag of the document is cXML and there is “PurchaseOrder” node within the document. when you use the Trading Networks Console to define the TN XML document type. webMethods Trading Networks User’s Guide Version 6. For XML documents: For each attribute that you want to extract from an XML document. you must provide an XQL query that identifies the location of the attribute within the document. For details about what you can use to identify a TN XML document type.5 73 . read “Pipeline Matching Criteria Used to Identify the TN Document Type” on page 283. The identification information specifies how Trading Networks is to recognize a flat file document based on variables the document gateway service places in the pipeline. For flat file documents: you can specify arbitrary pipeline variables to identify a TN flat file document type. For details. you can select the node in the sample document and Trading Networks creates the query for you. you specify an XQL query. If you have a sample document available. you can select the node that contains the attribute information and Trading Networks creates the query for you. read “Extraction Information In TN XML Document Types” on page 210. 2. For details about specifying XML document attributes. When a sample document is loaded. you can have Trading Networks load the sample for your use in creating the XQL queries. Action Determine how to recognize documents of this type. you can have Trading Networks load the sample for your use in creating the XQL queries. Determine the attributes that you want to create from documents of this type. when you use the Trading Networks Console to define the TN document type. To identify specific nodes within an XML document. When a sample document is loaded. For XML documents: For example. read “Identification Information in TN XML Document Types” on page 206. If you have a sample document available.

see “Action 2—Send an Alert E-mail” on page 338. You set up contacts when you define profiles for a partner. cont.) Note: Typically. (For more information. The following lists the system attributes that you should consider extracting along with the Trading Networks pre-processing and processing actions they affect: System Attribute SenderID Function it affects… Processing rule search criteria—To process documents based on the sender of the document.C H A P T E R 5 P l a n n i n g Yo u r N e t w o r k Task 3: Define the Types of Documents Step 2. which is handled in a later task. specify the system and custom (user-defined) attributes that you want Trading Networks to extract from TN_parms and place in the bizdoc. see “Processing Rule Criteria” on page 317. For example. read “Attributes To Extract From Documents” on page 285. you might want all documents from a specific sender to be handled in a special way. (For more information. you need to extract the Sender ID. (For more information.5 .) The Check for Duplicate Document pre-processing action—If you want Trading Networks to be able to check if it has received the document already by comparing the sender. you should always extract the SenderID system attribute. These are attributes that Trading Networks can save to the database to use later. Action For flat file documents: For each attribute that you want to create from a flat file document. you need to extract the SenderID. you must extract certain system attributes. see “Checking for Duplicate of the XML Document” on page 228 and “Checking for Duplicates of the Flat File Document” on page 296. 74 webMethods Trading Networks User’s Guide Version 6.) Alert E-mail processing actions—To send an email message to a contact at the sender’s corporation.. For details about specifying flat file document attributes.. For Trading Networks to perform some pre-processing and processing actions. you must extract the SenderID.

(For more information.) The Deliver Document By processing action—If you want Trading Networks to deliver the document to the receiver. you need to extract the ReceiverID.) The Check for Duplicate Document pre-processing action—If you want Trading Networks to be able to check if it has received the document already by comparing the receiver. see “Action 4—Deliver the Document to the Receiver” on page 341. (For more information. you need to extract the ReceiverID.) Note: Typically. (For more information. For example. you need to extract the ReceiverID. see “Action 2—Send an Alert E-mail” on page 338. which is handled in a later task. You set up contacts when you define profiles for a partner. see “Checking for Duplicate of the XML Document” on page 228 and “Checking for Duplicates of the Flat File Document” on page 296. see “Processing Rule Criteria” on page 317.5 75 . you should always extract the ReceiverID system attribute webMethods Trading Networks User’s Guide Version 6. Action System Attribute ReceiverID Function it affects… Processing rule search criteria—To process a document based on receiver of the document.Task 3: Define the Types of Documents Task 3: Define the Types of Documents Step 2. cont. you must extract the ReceiverID. (For more information. you might want all documents that are sent to a specific receiver to be handled in a special way.) Alert e-mail processing action—To send an e-mail message to a contact at the receiver’s corporation...

. SignedBody and Signature The Verify Digital Signature pre-processing action—If you want Trading Networks to be able to verify the digital signature of XML documents. you need to extract the conversation ID.C H A P T E R 5 P l a n n i n g Yo u r N e t w o r k Task 3: Define the Types of Documents Step 2. see “Specifying the Document Gateway Services Outputs” on page 280. (For more information. (For more information. see “Verifying the Digital Signature of an XML Document” on page 227. you need to extract the SignedBody and Signature.) Process management for a document—If a document is part of a conversation of documents and you want Trading Networks to pass the document along to process management after performing the actions defined by processing rules.5 . (For more information. Action System Attribute DocumentID Function it affects… The Check for Duplicate Document pre-processing action—If you want Trading Networks to be able to check if it has received the document already by comparing the document ID. you should always extract the DocumentID system attribute.) Note: Typically. thus eliminating the overhead of that lookup. cont. To verify the digital signature of flat file documents.) ConversationID processingRule ID 76 webMethods Trading Networks User’s Guide Version 6. see “Checking for Duplicate of the XML Document” on page 228 and “Checking for Duplicates of the Flat File Document” on page 296. see “Important Attributes that You Should Extract from an XML Document” on page 210 or “Specifying the Document Gateway Services Outputs” on page 280. see “Verifying the Digital Signature of Flat File Documents” on page 294.) Rather than have Trading Networks look up the appropriate rule for a flat file document. use this attribute to explicitly specify the processing rule.. (For more information. you need to extract the DocumentID.

Task 3: Define the Types of Documents

Task 3: Define the Types of Documents Step 2. cont... Action DoctypeID Rather than have Trading Networks search for an appropriate TN flat file document type for a flat file document, use this attribute to explicitly specify the document type, thus eliminating the overhead of that search. (For more information, see “Specifying the Document Gateway Services Outputs” on page 280.) Use this attribute if you want to process a flat file document based on the user status. Also, the user status is a criterion that Trading Networks uses to determine the processing rule to use for a document. (For more information, see “Specifying the Document Gateway Services Outputs” on page 280.) Use this attribute to easily locate all the flat file documents within the same group. (For more information, see “Specifying the Document Gateway Services Outputs” on page 280.)

UserStatus

GroupID

3.

Determine whether you want to associate an IS document type with the TN XML document type. This is applicable for XML documents only. If you will want to use the wm.tn.doc.xml:bizdocToRecord built-in service to transform the XML document to an IS document (IData object), you must identify a webMethods IS document type with the document. the wm.tn.doc.xml:bizdocToRecord service uses the IS document type that you specify as the blueprint to form the IS document (IData object). For more information about this service, see the webMethods Trading Networks Builtin Services Reference. For more information about associating an IS document type with a TN XML document type, see “Specifying an IS Document Type for TN XML Document Types” on page 226. Determine whether you want to associate a schema with the TN document type. For XML documents: If you want Trading Networks to perform the Validate Structure pre-processing action to validate the structure of an XML document, you must specify an IS schema that maps the structure of the TN XML document type. For more information, see “Specifying an IS Schema for TN XML Document Types” on page 227. For flat file documents: If you want Trading Networks to perform the Validate Structure pre-processing action to validate the structure of a flat file document, you must specify a parsing schema that maps the structure of the TN flat file document type. For more information, see “Validating the Structure of Flat File Documents” on page 295.

4.

webMethods Trading Networks User’s Guide Version 6.5

77

C H A P T E R 5 P l a n n i n g Yo u r N e t w o r k

Task 3: Define the Types of Documents Step 5. Action Determine the pre-processing actions you want Trading Networks to perform. You can specify whether you want Trading Networks to perform any or all of the following pre-processing actions against documents of this type. For more information about specifying the pre-processing actions in a TN document types, see “Specifying Pre-Processing Actions for TN XML Document Type” on page 227 and “Pre-Processing Actions in the TN Flat File Document Type” on page 294. Verify the digital signature of a document. For XML documents: To use this action, you must have Trading Networks extract the system attributes SignedBody and Signature. In addition, you must have a certificate on file for each partner whose digital signature you want to verify; this will be addressed in a later step. For more information, see “Verifying the Digital Signature of an XML Document” on page 227. For flat file documents: To use this action, you must code the verification service for your flat file document. For the inputs and outputs of the service, your verification service should implement the wm.tn.rec:BizDocVerification service. For more information, see “Verifying the Digital Signature of Flat File Documents” on page 294. Validate the structure of a document. For XML documents: To use this action, you must specify an IS schema with the TN XML document type. For more information, see “Validating the Structure of an XML Document” on page 228. For flat file documents: To use this action, you must specify a flat file schema with the TN flat file document type. For more information, see “Validating the Structure of Flat File Documents” on page 295.

78

webMethods Trading Networks User’s Guide Version 6.5

Task 3: Define the Types of Documents

Task 3: Define the Types of Documents Step 5. cont... Action Check the for duplicate document of a document; that is, has Trading Networks already received the document—you can have Trading Networks determine whether it has already received a document with either: the same document ID the same document ID and sender the same document ID, sender and receiver the same document ID, sender and TN document type To use this action, you must have Trading Networks extract the system attributes DocumentID, SenderID and/or ReceiverID. Save a copy of the document content, attributes, and/or log information to the database—You can have Trading Networks maintain information about the document in the database. Trading Networks has a reliable delivery feature that it uses only if the document content is saved to the database. The reliable delivery feature allows Trading Networks to attempt to deliver a document to a partner more than one time. For more information, see “Using Reliable Delivery with Immediate Delivery Method” on page 343. Keep in mind that all pre-processing actions can be overridden by selections you make in the processing rules that process a document. This will be addressed in a later task. 6. Create the TN document type. Use the Trading Networks Console and the information from Steps 1-5 to define the TN document type. You can create TN XML document types and TN flat file document types. For instructions, see “Defining TN XML Document Types” on page 232 and “Defining TN Flat File Document Types” on page 300. Note: If you are using an OEM version of the Trading Networks, you cannot create new TN document types in Trading Networks. Trading Networks will gray out this unavailable selection.

webMethods Trading Networks User’s Guide Version 6.5

79

C H A P T E R 5 P l a n n i n g Yo u r N e t w o r k

Task 4: Define Information to Maintain about Partners
To determine the type of information you want to collect about your partner, consider: The types of partners you plan to add to your network The type of information do you need about your partners to perform your business Information you will need about your partners to process documents from them, for example, information you need access in services that process documents After you understand the type of information you need about your partners, you are ready to start to define information you need to store in the profiles for your partners. Complete the following tasks to define the information you want to maintain about partners in your network: Task 4: Define Information to Maintain about Partners Step 1. Action Review the standard profile fields that webMethods defines. Determine whether the standard fields meet your needs. To view the standard fields, see the following sections in this manual: “Information on the Partner’s Corporate Tab” on page 132 “Information on the Partner’s Contact Tab” on page 136 “Information on the Partner’s Delivery Method Tab” on page 137 “Information on the Partner’s Security Tab” on page 144 Note any deficiencies in the fields. For more information, see “Standard Profile Fields” on page 88. 2. Update standard fields as necessary. If there are standard fields that are not currently required but that you want to require, you can update the fields. If there are standard fields that are required that you do not require, you might be able to mark them not required. Trading Networks allows you to update a subset of the standard fields. For information about the standard fields that you can update, see “Standard Profile Fields” on page 88. For instructions on how to update whether fields are required or not, see “Updating Standard Profile Fields” on page 96.

80

webMethods Trading Networks User’s Guide Version 6.5

Task 5: Create Your Own Profile

Task 4: Define Information to Maintain about Partners Step 3. Action Define extended profile fields. To maintain information about partners that is not covered by the standard fields, you can define extended profile fields. For example, you might want to define extended fields for preferred shipping method, cost centers, or customer codes. Use the Trading Networks Console to define your extended profile fields. For instructions on how to define extended profile fields, see “Extended Profile Fields” on page 97 and “Adding Extended Profile Fields” on page 98.

Task 5: Create Your Own Profile
After you have defined the format of the profiles on your Trading Networks system, you can fill in your own profile. For instructions, see “Creating Your Own Profile” on page 115.

Task 6: Define Actions to Perform Against Documents
You can define how Trading Networks handles the documents it processes by setting up processing rules. Use processing rules to perform actions that are stateless, meaning that each application of a processing rule has no knowledge of the actions that happen before it. Examples of uses for process rules are: Actions that you want to perform against all or several documents that Trading Networks receives, such as saving documents to a specific location or mapping all order documents (regardless of process) to a canonical order Delivering a document to the receiving partner. (Note that if you want to use queued documents for delivery to partners and have the documents delivered at scheduled intervals, you need to define the queues. See “Other Configuration Settings” on page 61 for more information.) Sending notifications (for example an e-mail message) when Trading Networks receives specific types of documents Perform actions in processing rules that are not specific to a single business process.

webMethods Trading Networks User’s Guide Version 6.5

81

C H A P T E R 5 P l a n n i n g Yo u r N e t w o r k

Note: If you want to process documents as part of a complete business interaction (that is, as a series of connected steps), use process management. You define the business process by using webMethods Modeler to create a process model. If you have Trading Networks extract a conversation ID from a document, Trading Networks automatically passes the document to process management after it performs the actions you define in a processing rule. For more information about creating process models, see the webMethods Modeler User’s Guide. Processing rules and conversation scripts are extremely flexible. To understand all of the capabilities of processing rules and how to set them up, see “Processing Rules” on page 311.

Task 7: Add Partners to Your Network
After you have set up how to recognize and process documents and the information you want to collect about partners, you can now start adding partners to your network. To add profiles, gather the information required for the partner’s profile. Then use the Profile Assistant or Profile screen to create the profile using the gathered information. For instructions, see “Adding Partner Profiles” on page 145. After a partner is added to your network, you can start exchanging business documents with the partner.

82

webMethods Trading Networks User’s Guide Version 6.5

CHAPTER

6

Trading Partners
How to Manage Partners in Your Trading Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Steps to Setting up Profiles in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

webMethods Trading Networks User’s Guide Version 6.5

83

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

How to Manage Partners in Your Trading Network
To add a partner to your network, you add a profile for the partner.You add profiles for those partners with which you want to exchange documents with. Trading Networks is only aware of partners for which it has a profile. Before you can add profiles, you must do the following: 1 2 Define the profile information you want to collect about partners Create your own profile

After you perform these tasks, you can start adding profiles for your partners. For more information about trading partners information, see Chapter 2, "Trading Partners" in the webMethods Trading Networks Concepts Guide.

Defining the Information You Want to Collect about Partners
Trading Networks saves the information that it collects about partners in profiles. A profile is made up of fields. To define the information that you want to collect about your partners, you set up profile fields. There are two types of profile fields—standard fields and extended fields: Standard fields are webMethods-defined fields that incorporate the majority of the information that you will want to collect about a partner. You cannot add additional standard fields or disable the standard fields that are provided. However, you can modify the definitions for standard fields to change the description. Most of the standard fields are for your own use, for example, the name of the corporation and its address. However, Trading Networks requires some of the standard fields to operate normally, for example, the Trading Networks host and port number that a partner uses for HTTP to deliver a document to the partner via HTTP. Extended fields are 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. The profiles that reside on your system contain all the extended fields that you define.

Creating Your Own Profile
Trading Networks maintains a profile for your corporation. Your profile contains the standard fields and the extended fields that you define. Your profile must be filled out before you can exchange business documents with partners. Use the Profile Assistant to create your profile.

84

webMethods Trading Networks User’s Guide Version 6.5

Steps to Setting up Profiles in Trading Networks

Adding Profiles for Partners
To identify a partner with which you want to exchange business documents, you add a profile for the partner. After you create your own profile, you can use the Profile Assistant or the Profile screen to create profiles for your partners.

Steps to Setting up Profiles in Trading Networks
To set up the information you want Trading Networks to maintain in profiles and add partners to your network, perform the tasks in the following checklist: Task 1 Set up the profile fields for profiles For more information, see... “What are Profile Fields?” on page 88 “Standard Profile Fields” on page 88 “Adding Extended Profile Fields” on page 98 2 3 Create your own profile Add partners by adding their profiles to your system “What are Profile Fields?” on page 88 “Adding Partner Profiles” on page 145

webMethods Trading Networks User’s Guide Version 6.5

85

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

86

webMethods Trading Networks User’s Guide Version 6.5

CHAPTER

7

Profile Fields
What are Profile Fields? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

webMethods Trading Networks User’s Guide Version 6.5

87

you can modify the definitions for standard fields to change the description. 88 webMethods Trading Networks User’s Guide Version 6. Standard Profile Fields The standard profile fields are fields that webMethods defines and that are available out-of-the-box. You cannot add additional standard fields or disable the standard fields that are provided. you set up profile fields. so you can easily determine the fields that are required. Trading Networks displays each required field in blue and places an asterisk (*) next to the required fields. for example. Several of the standard fields.CHAPTER 7 Profile Fields What are Profile Fields? To define the information that you want to collect about your partners. All profiles on your system must have a value for required profile fields. If you want to collect additional information about your partners that is not covered by the standard fields. as defined by webMethods. you can define extended fields. Trading Networks uses the standard profile fields on the portion of the Profile screen above the split pane controls. for example. you must supply information for all required fields before Trading Networks will allow you to enable the profile. Those that are not. However. you can mark them as required. Most of the standard fields are for your own use. Extended fields are fields that you define to extend the standard profile that webMethods provides out-of-the-box. However. the Trading Networks host and port number that a partner uses for HTTP to deliver a document to the partner via HTTP. the name of the corporation and its address. There are two types of profile fields—standard fields and extended fields: Standard fields are webMethods-defined fields that incorporate the majority of the information that you will want to collect about a partner. see Chapter 2. are required. Trading Networks requires some of the standard fields to operate normally. For more information about profile fields. When you are filling in a profile. you can view and update only a subset of the fields with the Standard tab on the Profile Fields screen. When you add extended fields. Although Trading Networks has many standard fields. When you create your own profile or add a profile for a partner. "Trading Partners" in the webMethods Trading Networks Concepts Guide Required Fields A required field is one that you want supplied for all profiles. The profiles that reside on your system contain all the extended fields that you define.5 . you can mark as required if you want.

if specified) to identify your enterprise or a partner within the network. For example. For each field. If not specified: Trading Networks will not have a name to use to identify for this partner. “Sales and Marketing”. “Industrial Steel Company”. Trading Networks uses the CorporationName and OrgUnitName as the name of your enterprise on the Enterprise selection in the Selector Panel and as the name of your partner on the Partner selection. This field is located on the Delivery Method tab of the Profile screen and has the label Use as preferred protocol. How it is used: Trading Networks uses this field (along with the OrgUnitName. If not specified: The preferred protocol defaults to Queue for polling. If not specified: Trading Networks will use only the CorporationName for identification. webMethods Trading Networks User’s Guide Version 6.5 89 . How it is used: Trading Networks uses this field (along with the CorporationName) to identify your enterprise or a partner within the network. How it is used: If a processing rule is configured to deliver a document using the preferred protocol. Standard Field Corporation Name Description What it is: This field identifies the name of the corporation. the table lists a description of what each field is. the partner’s delivery method that is selected as the preferred protocol will be used. For example. Preferred Delivery Method What it is: This field identifies which delivery method the partner prefers to receive documents with. This field is located on the Corporate tab of the Profile screen and has the label Corporation Name.Standard Profile Fields The following table lists the standard profile fields that you can update. Unit Name What it is: This field identifies a unit name or division name within the corporation. for example. Trading Networks uses the CorporationName and OrgUnitName as the name of your enterprise on the Enterprise selection in the Selector Panel and as the name of your partner on the Partner selection. for example. This field is located on the Corporate tab of the Profile screen and has the label Unit Name. how Trading Networks uses the field. and any consequences if a field is not included in a partner profile.

If the e-mail address is not specified for a contact of the selected contact type. How it is used: Trading Networks does not use this information. If not specified: The information will not be available in the partner profile. If not specified: The information will not be available in the partner profile.CHAPTER 7 Profile Fields Standard Field E-mail Description What it is: This field identifies an e-mail address for a contact.com”. It is maintained to allow easy access to contact information. Fax What it is: This field identifies the fax number for a contact. If not specified: If the contact is referenced in the Alert e-mail action of a processing rule. It is maintained for your information. How it is used: Trading Networks does not use this information. see “Action 2—Send an Alert E-mail” on page 338. for example. 90 webMethods Trading Networks User’s Guide Version 6. How it is used: Trading Networks allows you to select a contact type in a processing rule for the Alert e-mail action. For more information on the Alert e-mail action in a processing rule. You can view it by displaying the partner profile for a partner. “1-888-555-4897”. This field is located on the Contact tab of the Profile screen and has the label E-mail. “jsmith@IndustrialSteel.5 . First Name What it is: This field identifies the contact's first name. Trading Networks will not be able to send an email message. You can view it by displaying the partner profile for a partner. Trading Networks cannot send the e-mail message to that contact. This field is located on the Contact tab of the Profile screen and has the label Fax. This field is located on the Contact tab of the Profile screen and has the label First Name. for example. The Alert e-mail action instructs Trading Networks to send an e-mail message to the contacts associated with the selected contact type.

If not specified: The information will not be available in the partner profile. webMethods Trading Networks User’s Guide Version 6. You can view it by displaying the partner profile for a partner. You can view it by displaying the partner profile for a partner. This field is located on the Contact tab of the Profile screen and has the label Role. You can view it by displaying the partner profile for a partner. If not specified: The information will not be available in the partner profile. How it is used: Trading Networks does not use this information. This might be a job title. “Trading Network Administrator”. This field is located on the Contact tab of the Profile screen and has the label Pager. It is maintained to allow easy access to contact information. for example. This field is located on the Contact tab of the Profile screen and has the label Last Name. Last Name What it is: This field identifies the contact's last name.Standard Profile Fields Standard Field Pager Description What it is: This field identifies the pager number for a contact. It is maintained to allow easy access to contact information. Role What it is: This field identifies the contact's role. for example. How it is used: Trading Networks does not use this information. “1-330-555-7890”. If not specified: The information will not be available in the partner profile. How it is used: Trading Networks does not use this information. It is maintained to allow easy access to contact information.5 91 .

How it is used: Trading Networks does not use this information. Note: If you require AddressLine1. It is maintained to allow easy access to contact information. If not specified: The information will not be available in the partner profile. It is maintained to allow easy access to contact information. How it is used: Trading Networks does not use this information. You can view it by displaying the partner profile for a partner.5 . Address What it is: This field identifies the first line of the street address. How it is used: Trading Networks does not use this information. for example. If not specified: The information will not be available in the partner profile. “1-800-555-1234”. 92 webMethods Trading Networks User’s Guide Version 6. If not specified: The information will not be available in the partner profile. Telephone What it is: This field identifies the telephone number for a contact. use the Extension field to identify the contact's extension.CHAPTER 7 Profile Fields Standard Field Extension Description What it is: This field identifies the extension number for a contact. If the telephone number in the Telephone field identifies the main line for the corporation. the AddressLine1 field on both the Corporate and Contact tabs will be required. This field is located on the Contact tab of the Profile screen and has the label Telephone. You can view it by displaying the partner profile for a partner. “595 Main Street”. for example. You can view it by displaying the partner profile for a partner. This field is located on the Contact tab of the Profile screen and has the label Extension. This field is the first line of the Address fields that are located on the Corporate and Contact tabs of the Profile screen. It is maintained to allow easy access to partner information.

Standard Profile Fields Standard Field AddressLine2 Description What it is: This field identifies the second line of the street address. for example. the AddressLine3 field on both the Corporate and Contact tabs will be required. “Suite 556”. the AddressLine2 field on both the Corporate and Contact tabs will be required. It is maintained to allow easy access to partner information. You can view it by displaying the partner profile for a partner. for example. How it is used: Trading Networks does not use this information. This field is the second line of the Address fields that are located on the Corporate and Contact tabs of the Profile screen. Note: If you require AddressLine2. Note: If you require AddressLine3.5 93 . How it is used: Trading Networks does not use this information. If not specified: The information will not be available in the partner profile. “ATTN Billing Department”. You can view it by displaying the partner profile for a partner. It is maintained to allow easy access to partner information. webMethods Trading Networks User’s Guide Version 6. If not specified: The information will not be available in the partner profile. AddressLine3 What it is: This field identifies the third line of the street address. This field is the third line of the Address fields that are located on the Corporate and Contact tabs of the Profile screen.

“USA”. Note: If you require City. How it is used: Trading Networks does not use this information. How it is used: Trading Networks does not use this information. the Country field on both the Corporate and Contact tabs will be required. It is maintained to allow easy access to partner information. Country What it is: This field identifies the country in an address. “Los Angeles”. You can view it by displaying the partner profile for a partner. If not specified: The information will not be available in the partner profile. the City field on both the Corporate and Contact tabs will be required. 94 webMethods Trading Networks User’s Guide Version 6. You can view it by displaying the partner profile for a partner. for example. Note: If you require Country.CHAPTER 7 Profile Fields Standard Field City Description What it is: This field identifies the city in an address. for example. If not specified: The information will not be available in the partner profile.5 . This field is the Country fields that are located on the Corporate and Contact tabs of the Profile screen. It is maintained to allow easy access to partner information. This field is the City fields that are located on the Corporate and Contact tabs of the Profile screen.

This field is the Postal Code fields that are located on the Corporate and Contact tabs of the Profile screen. Select View Enterprise. the Postal Code field on both the Corporate and Contact tabs will be required. Note: If you require Postal Code. If not specified: The information will not be available in the partner profile. Viewing Standard Profile Fields To view the standard profile fields that Trading Networks allows you to update. Select Enterprise webMethods Trading Networks User’s Guide Version 6. “90001”.5 95 . If you need procedures for this step. How it is used: Trading Networks does not use this information. How it is used: Trading Networks does not use this information. for example. Postal Code What it is: This field identifies the postal code (for example.Standard Profile Fields Standard Field State/Province Description What it is: This field identifies the state or province in an address. It is maintained to allow easy access to partner information. It is maintained to allow easy access to partner information. perform the following procedure. for example. Note: If you require State/Province. You can view it by displaying the partner profile for a partner. You can view it by displaying the partner profile for a partner. ZIP code) for the state or province in an address. If not specified: The information will not be available in the partner profile. This field is the State/Province fields that are located on the Corporate and Contact tabs of the Profile screen. “California”. the State/Province field on both the Corporate and Contact tabs will be required. To view standard profile fields 1 2 3 Start the Trading Networks Console. Profile Fields. see “Starting the Trading Networks Console” on page 22.

Updating Standard Profile Fields Perform the following procedure to update information for standard profile fields: To update a standard profile field 1 2 3 4 Start the Trading Networks Console. If you need procedures for this step. 96 webMethods Trading Networks User’s Guide Version 6. 5 6 Click the row containing the profile field that you want to view. Select Enterprise Click the Standard tab. Profile Fields. there are no restrictions. see “Starting the Trading Networks Console” on page 22. Note: To sort the columns in the Standard table. Update the field(s) you want to change: For this Standard tab parameter… Description Specify… The description you want the profile field to have. Right click and select Edit.5 . 5 6 7 Click the row containing the profile field that you want to update. select the column to sort and then click on the column heading for forward ( ) and reverse ( ) alpha-numeric order. For more information about the fields on this tab. Select View Enterprise. see “Standard Profile Fields” on page 88. Right click and select Edit. You can specify any characters. select the column to sort and then click on the column heading for forward ( ) and reverse ( ) alpha-numeric order. Note: To sort the columns in the Standard table. You can specify 1-1024 characters. You can replace the current description or add more detail to it.CHAPTER 7 Profile Fields 4 Click the Standard tab.

Click the checkbox to indicate your choice. When you define an extended profile field. see “Standard Profile Fields” on page 88. To determine how Trading Networks uses each standard field and the effect of not specifying a field. Trading Networks might be prevented from performing a function that you will require. webMethods uses some standard fields for its processing. You can add additional groups. The name of the Group that you want Trading Networks to assign to the profile field. webMethods Trading Networks User’s Guide Version 6. Custom. The valid values that can be supplied for the profile field. Important! Use caution when changing fields from required to not required. assure the checkbox has a check.5 97 . The data type of the extended profile field—string or binary. You can supply this information only if the data type is string. and External ID. You can supply this information only if the data type is string. You can supply this information only if the data type is string. Extended Profile Fields If after reviewing the profile that webMethods defines you determine that you want to maintain additional information about partners. A description you want Trading Networks to display for the extended profile field. Trading Networks displays the Name as the field label when displaying a profile on the Profile screen. so if you change a field so that it is not required and a partner opts to not supply that information. Delivery. 8 Click OK.Extended Profile Fields For this Standard tab parameter… Required Specify… Whether the profile field is required or not. you specify the following: The name you want the extended profile field to have. webMethods provides the groups—Address. To indicate that the profile field is not required. remove the check from the checkbox. The maximum length of the value that can be supplied for the profile field. Corporation. Contact. you can define extended profile fields by using the Extended tab on the Profile screen. The default value of the extended profile field. To indicate the profile field is required. All extended fields appear on this tab.

To add a new extended profile field 1 2 3 4 Start the Trading Networks Console. including its name. When you already have profiles in your system and then change an extended field from not required to required. you must manually edit the existing profiles for the newly added extended profile fields. For more information about how to change the format of the table. the information might not be available if the partner is not required to supply it. see “Working with Tables” on page 33. If you need procedures for this step. Profile Fields. Select View Enterprise. This is true even when the updated extended profile fields has a default value The following table describes the tasks you can perform against extended profile fields: Task “Adding Extended Profile Fields” “Viewing Extended Profile Fields” “Updating Extended Profile Fields” “Disabling Extended Profile Fields” “Enabling Extended Profile Fields” See page. 98 webMethods Trading Networks User’s Guide Version 6. Select Enterprise Click the Extended tab to view the list of extended profile fields. Note: If you already have profiles in your system and then add extended profile fields that are required.. 98 101 102 102 103 Adding Extended Profile Fields To add an extended profile field to the profiles you maintain on your system. If you have services that use the field or if you might create or update services that use the field. This is true even when you define default values for the added extended profile fields. you must manually edit the existing profiles for the updated extended profile fields. see “Starting the Trading Networks Console” on page 22. Important! Use caution when changing fields from required to not required..CHAPTER 7 Profile Fields You can change all information for an extended field. perform the following procedure.5 .

. 1 2 Click New . To assign the field to an existing group. It is helpful to include the type of information that you expect for this field because Trading Networks displays this description when requesting a profile be completed. A blank New Extended Profile Field screen Perform this procedure.. You can specify any characters. An existing extended profile field 1 2 3 Trading Networks displays the New Extended Profile Field screen with the information copied from the selected profile field. Name Specify. To assign the field to a new group. select a group from the list.Extended Profile Fields 5 Perform one of the following to start defining a new extended profile field: To create a new extended field based on.5 99 . Specify 1-1024 characters.. You can update any or all fields for the extended profile field 4 Fill in the fields on the New Extended Profile Field screen: For this Extended tab parameter. type the name of the group. Specify 1-32 characters. The name you want to assign the new extended profile field. there are no restrictions... For example. Group The group you want Trading Networks to assign the extended profile field to. you might define an extended profile field named “Catalog Type”. there are no restrictions. Click Duplicate . You can specify any characters.. Description webMethods Trading Networks User’s Guide Version 6. Optional. Trading Networks displays a blank New Extended Profile Field screen Click the row containing the profile field that you want to duplicate.. if you send catalogs to clients and you want to maintain the type of catalog the partner is to receive. A description of the profile field..

If you specify String. To indicate that the profile field is not required. click Add New . maximum length. You can specify Default only when Data Type is String. Default Maximum Length Optional. there is no limit placed on the profile field. You can specify Valid Values only when Data Type is String. Place one valid value per row.... Optional. To add row to the table. remove the check from the checkbox. Data Type Specify. and valid values for the profile field. Valid Values To remove a row from the table.CHAPTER 7 Profile Fields For this Extended tab parameter. You can specify any characters. Optional. To define the field and assure it is enabled. Required 5 Click OK. make sure the Enabled checkbox is selected. you can specify a default value. Trading Networks displays a list of the values that can be selected when filling out a profile. Select either String or Binary from the list. You can specify Maximum Length only when Data Type is String. 100 webMethods Trading Networks User’s Guide Version 6. Select the checkbox to indicate your choice. The maximum number of characters that you want to allow someone to specify for the profile field. If you specify valid values. there are no restrictions. If you do not specify a maximum length. select the row and then click Delete Selected . The data type of the profile field. These are values that you want Trading Networks to accept for this profile field. Whether the profile field is required or not. Specify the valid values in the table in the Valid Values field. To indicate the profile field is required. Specify 1-128 characters.5 . The default value for a profile field. assure the checkbox has a check. Enabled Whether the profile field is enabled or disabled..

To hide disabled extended profile fields. see “Working with Tables” on page 33. click Show Enabled to only show enabled (yellow light bulbs) items.. Select one of the following options to view extended profile fields. To display disabled extended profile fields. Profile Fields. If you need procedures for this step.5 101 . see “Starting the Trading Networks Console” on page 22. Trading Networks does not display any disabled (darkened light bulbs) items. webMethods Trading Networks User’s Guide Version 6.. Double click the row for that field. Select Enterprise Click the Extended tab to view the list of extended profile fields.Extended Profile Fields Viewing Extended Profile Fields To view the extended profile fields that are defined on your system... click Show All to show both enabled (yellow light bulbs) and disabled (darkened light bulbs) items. perform the following procedure: To view extended profile fields 1 2 3 4 5 Start the Trading Networks Console. For more information about how to change the format of the table. To see details about a specific extended profile field To display disabled extended profile fields To hide disabled extended profile fields Perform this procedure. For the following. Select View Enterprise.

This is true even when the updated extended profile fields has a default value To update extended profile fields. see step 4on page 99. you must manually edit the existing profiles for the updated extended profile fields. Trading Networks no longer displays it in profiles. you can disable it. Note: To sort the columns in the Extended table. When you disable an extended profile field. When you already have profiles in your system and then change an extended field from not required to required. see “Starting the Trading Networks Console” on page 22. including its name. 102 webMethods Trading Networks User’s Guide Version 6.CHAPTER 7 Profile Fields Updating Extended Profile Fields You can change all information for an extended profile field. Select Edit . the information might not be available if the partner is not required to supply it. Click OK. Disabling Extended Profile Fields If you no longer want to use an extended profile field. If you need procedures for this step. Note: Use caution when changing fields from required to not required. For information on what you can specify. Select View Enterprise. select the column to sort and then click on the column heading for forward ( ) and reverse ( ) alpha-numeric order. 5 6 7 Click the row containing the profile field you want to update. Select Enterprise Click the Extended tab. Profile Fields. perform the following procedure: To update an extended profile field 1 2 3 4 Start the Trading Networks Console. Update the fields you want to change. If you have services that use the field or if you might create or update services that use the field. Trading Networks does not delete the field definition from the database or any information stored for the field in partner profiles.5 .

If the profile field you are enabling is a required field. Profile Fields. Enabling Extended Profile Fields If you disable an extended profile field and then later determine that you still need it. To enable an extended profile field. You will need to manually update the profiles to supply the missing information. Use caution when disabling fields. see “Updating Your Profile” on page 117. webMethods Trading Networks User’s Guide Version 6. Trading Networks places No in the Enabled column to indicate that the extended profile field is disabled. the new profile will not contain information for the disabled field. you can enable it. see “Starting the Trading Networks Console” on page 22.5 103 .Extended Profile Fields Because the field is no longer displayed in profiles. Before you can remove the field. To disable an extended profile field 1 2 3 4 5 6 Start the Trading Networks Console. you must first remove all rows from the PartnerProfileField table that reference the profile field you want to delete. your database administrator must remove it. you must first perform the procedure described in “Disabling Extended Profile Fields” on page 102. Select Enterprise Click the Extended tab. perform the following procedure. Important! To perform this procedure. Select View Enterprise. the profiles that were added in the interim do not contain information for the required field. Note: To permanently remove the extended profile field from the database. If you need procedures for this step. For instructions on how to update a partner profile. Right click and select Disable. Click the row containing the profile field that you want to disable. You should not disable a field that is used by services at your site because the information the services use will not be available for profiles that you add after you disable the field. If you added partner profiles while the profile field was disabled. you might need to take further action. if you create new profiles after disabling a field.

Note: To sort the columns in the Extended table. Trading Networks places Yes in the Enabled column to indicate that the extended profile field is enabled.CHAPTER 7 Profile Fields To enable an extended profile field 1 2 3 4 Start the Trading Networks Console. If you need procedures for this step. Select View Enterprise. see “Starting the Trading Networks Console” on page 22. select the column to sort and then click on the column heading for forward ( ) and reverse ( ) alpha-numeric order. Profile Fields. Select Enterprise Click the Extended tab. 104 webMethods Trading Networks User’s Guide Version 6.5 . Right click and select Enable. 5 6 Click the row containing the profile field that you want to enable.

117 webMethods Trading Networks User’s Guide Version 6.115 Managing Your Profile . . . . . . . . . . . . . . . 106 Information Trading Networks Maintains in Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Creating Your Own Profile . . . . . . . .5 105 . . . . . . . . . . . . . . . . .CHAPTER 8 Your Profile (Your Enterprise) What are Profiles? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) What are Profiles? A profile is a summary of information about a corporation as part of a trading network. The name of the organizational unit or division within your corporation. 106 webMethods Trading Networks User’s Guide Version 6. However. “Partner Profiles”. Corporate Tab Field Corporation Name Unit Name Description The name of your corporation. Your profile (Enterprise) contains standard profile fields that webMethods defines and extended profile fields that you define about your corporation. the presentation is different: Profile Assistant—The Profile Assistant is a wizard that takes you step-by-step through the process of supplying the information for your profile. as well as the profile of each of your partners on your network. Profile screens—Trading Networks groups related information together on the Profile screen on the following tabs: Corporate. Extended Fields. “Sales and Marketing”. for example. webMethods Trading Networks (Trading Networks) maintains your profile. In addition. Contact. For more information about creating partner profiles. for example. The Profile Assistant is a wizard that takes you step-by-step through the process of creating your own profile. The fields that Trading Networks displays in the Profile Assistant and Profile screen are the same. and Security. Delivery Method. you can use the Profile Assistant to create partner profiles. see Chapter 9. These profile identifiers include the partner’s external ID type and profile group membership information. Trading Networks displays the following fields on your profile’s Corporate tab. Information Trading Networks Maintains in Your Profile The profile is made up of the standard fields that webMethods defines and the extended fields you define. “Industrial Steel Company”. Information on Your Corporate Tab The Corporate tab contains your company’s address information and profile identifiers. You must create your profile using the Profile Assistant before you can create profiles for your partners and exchange documents with partners.5 .

Trading Networks displays the following fields on your profile’s Address sub-tab. “Los Angeles”. for example. specify the preferred language of your corporation. Optionally. The postal code (for example. for example. “90001”.5 107 . Address Sub-Tab Field Country Address Description The country where your corporation is located. Trading Networks automatically sets the value of this field based on the license key. “California”. City State/Province Postal Code webMethods Trading Networks User’s Guide Version 6. “123 Main Street”.. The city where your corporation is located. Preferred Language The Preferred Language option is for use only by other webMethods components (e. You are using webMethods for Partners. for example “USA”.Trading Networks does not use this option for its own processing. webMethods RosettaNet Module) for localization purposes. for example. The state or province where your corporation is located.Information Trading Networks Maintains in Your Profile Corporate Tab Field Partner Type Description The type of software your corporation uses to interact with the trading network.g. Note: You cannot change the Partner Type for your corporation (Enterprise). Value webMethods Trading Networks webMethods for Partners Meaning You are using webMethods Trading Networks. The street address of your corporation. a zip code) for the state or province where your corporation is located. You can specify an unlimited number of addresses for a corporation. The order that you add the addresses is the order that they are displayed as tabs. for example.

tn.idtype property on the TN Properties page. For more information.C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) Trading Networks displays the following fields in the Profile Identifiers section of your profile’s Corporate tab. For example. You can add additional external ID types using the built-in service wm. see Chapter 4. The tn.required. The Value is the alpha-numerical value of the corporation’s external ID type.required. Trading Networks uses these fields to correlate the identification of a corporation in a document to the corporation defined by the profile. Trading Networks uses the required external ID defined by the tn. if the corporation uses a D-U-N-S number. “Trading Networks Configuration Properties”. Profile Identifiers Field External ID Type Value Description The External ID Type is the identification that your corporation uses within documents. Your partner’s Trading Networks system uses the value of the external ID type that is required on its Trading Networks system. the Value is the corporation’s D-U-N-S number.idType property controls what type of external ID is used as the IS username for Trading Networks partners. For more information about the TN Properties page. Additionally. 108 webMethods Trading Networks User’s Guide Version 6. a corporation might use a D-U-N-S number as an external identification type. Note: Out-of-the-box.5 .This required ID type cannot contain any white spaces and the default value is DUNS. the value of the required ID types in your profile is used to create a webMethods User account. For example.dictionary:addIDType. This required ID type cannot contain any white spaces. Trading Networks can associate the document with the profile and the corporation defined by the profile. For example. when Trading Networks receives a document with an external ID type that is a D-U-N-S number and it matches the value specified in a profile. on the systems of your partners that use Trading Networks.required. Trading Networks provides predefined external ID types.idType system property. You configure the required ID type by using the tn. see the webMethods Trading Networks Built-in Services Reference.

tn.dictionary:addContactType. You can only associate profiles with a profile group if there are profile groups defined in the database. This might be a job title. Note: Out-of-the-box. see the webMethods Trading Networks Built-in Services Reference. “Trading Network Administrator”. First Name The contact's first (given) name. for example. For more information about how to create profile groups. Note: To sort the contacts’ last names alphabetically. you can associate a partner profile (including your Enterprise profile) with any profile group and to more than one group.5 109 . see “Other Configuration Settings” on page 61.Information Trading Networks Maintains in Your Profile The your profile’s Corporate tab also contains the Profile Group Membership table. Corporate tab Field Profile Group Membership Description The name of the profile group that Trading Networks associates your profile to. The contact's last name (surname). for example. For more information. Information on Your Contact Tab Trading Networks displays the following fields on the Contact tab. Once you create a profile group. click on the Name column heading for forward ( ) and reverse ( ) alpha-numeric order. Contact Tab Field Contact Type Description The type of contact. You can add additional contact types by using the built-in service wm. This column contains the list of profile groups that your profile belongs to. Trading Networks provides the contact types Administrative and Technical. “Administrative”. webMethods Trading Networks User’s Guide Version 6. Role Last Name The role the contact has in your corporation.

see “Action 2—Send an Alert E-mail” on page 338. The city where the contact is located.C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) Contact Tab Field E-mail Description The contact's e-mail address. for example. for example. “1-888-555-4897”. for example. “123 Main Street. If an e-mail address is not specified for a contact of the selected contact type. for example. 110 webMethods Trading Networks User’s Guide Version 6. For more information. for example. “1-800-555-1234”. Trading Networks cannot send the e-mail message. Suite 456”. The contact's extension number. “1-330-555-7890”. The Alert e-mail processing action instructs Trading Networks to send an e-mail message to the contacts of the selected contact type. The contact's pager number. “90001”. The contact's fax number. The country where the contact is located. for example.5 . Trading Networks allows you to select a contact type for the Alert e-mail processing action. Note: On the Processing Rules screen. “Los Angeles” The state or province where the contact is located. for example. a zip code) for the state or province where the contact is located. The postal code (for example. “USA”. The street address of the contact. for example. Telephone Extension Pager Fax Country Address City State/Province Postal Code The contact's telephone number. “California”.

delivering into a message queuing system). This option is only valid for HTTP..5 111 . “Delivery Services”. FTP. “IndustrialSteel. and FTPS. for example. Note: Trading Networks provides (out-of-the-box) delivery methods for delivering documents via e-mail (SMTP). “5555”.Information Trading Networks Maintains in Your Profile Information on Your Delivery Method Tab Trading Networks displays the following fields on the Delivery Method tab. see Chapter 17. and FTPS protocols. FTP. Trading Networks uses the default port number for the protocol—for HTTP. Delivery Method Tab Field Protocol Description The name of a delivery method that Trading Networks can use when delivering documents. for HTTPS. If you require another method (e. and FTPS protocols. FTP. for example. for FTP and FTPS it uses 21. it uses 80. HTTPS.com”. Port The port number on which your system listens for incoming requests. HTTPS. Note: This option is only valid for HTTP. HTTP.g. Host The host name or IP address of your system. If you do not supply a port number. This chapter describes how to add your own delivery methods. HTTPS. webMethods Trading Networks User’s Guide Version 6. it uses 443.

112 webMethods Trading Networks User’s Guide Version 6. If the Use as preferred protocol is not selected for any delivery method. The directory path that Trading Networks is to use when sending documents.tn/receive. 0a010154f70ddbf900000203. For this Protocol… HTTP or HTTPS Use this Location… The URL that Trading Networks is to use when sending documents.xml. For flat file documents. The file name of the file is the internal ID that Trading Networks generates for the document when Trading Networks receives it. the standard URL for document exchange. see Chapter 6. “bizdoc@isteel. Trading Networks uses Queue for Polling. for example. "Sending Documents to Trading Networks for Processing" in the webMethods Trading Networks Concepts Guide.com”.5 . For XML documents. For more information about Clients that partners can use to send documents to Trading Networks. e. the file extension is xml. Trading Networks automatically fills in the Location with /invoke/wm.g. Delivery methods you can use with Trading Networks.C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) Delivery Method Tab Field Location Description The location a partner is to use when sending a document to your system. The delivery method that you prefer partners to use to deliver documents to your Trading Networks system. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. see Chapter 4.. The preferred delivery method is the value you select for Protocol. the file extension is dat FTP or FTPS E-mail Use as preferred protocol The e-mail address a partner is to use when delivering documents to your system.

see the webMethods Trading Networks Built-in Services Reference. Decrypt/Encrypt sub-tab—Use this sub-tab to specify certificate information that Trading Networks uses to decrypt documents that your Enterprise receives from partners. and Trading Networks displays the corresponding extended fields on the right. “Corporate” will not appear in the Group column. that group is not listed. if you have not defined any extended profile fields for the “Corporate” group.doc:sign is invoked. Trading Networks provides pre-defined field groups.tn. Alternatively. For example. Trading Networks does not check to see whether the CA that signed the certificate is included in the list of trusted webMethods Trading Networks User’s Guide Version 6. Trading Networks digitally signs a document when the built-in service wm. Trading Networks maintains this information for other webMethods components (e. If there are no extended profile fields in a specific group. you can also use the built-in service wm.g.Information Trading Networks Maintains in Your Profile Information on Your Extended Fields Tab Trading Networks displays the extended fields that you define on this tab. When you add certificate information on this sub-tab.5 113 . For more information on this service. Information on Your Security Tab The Security tab contains the following sub-tabs: Sign/Verify sub-tab—Use this sub-tab to specify certificate information that Trading Networks uses to digitally sign documents that your Enterprise sends to partners.. webMethods RosettaNet Module) that take advantage of this feature. Note: Out-of-the-box.dictionary:addFieldGroup. Specify this information if you are using another webMethods component that requires it.tn. select the name of the group from the Group column. For more information about this service. You can add additional field groups by specifying a new group when you add a new extended field. Note: To see extended fields. Extended Fields Tab Field Group (Name) Description The name of the field group that Trading Networks associates extended fields with. This column contains the list of groups that have defined profile fields. see the webMethods Trading Networks Built-in Services Reference.

A best practice is to specify the certificate that you want to use with most of your partners in the Default profile to establish the default. Decrypt. For more information about security in Trading Networks. if you want to use a different certificate with other partners. "Security within Trading Networks" in the webMethods Trading Networks Concepts Guide. Similarly. Trading Networks uses it for all partners for which there are no alternative certificate set defined. 114 webMethods Trading Networks User’s Guide Version 6. Trading Networks cannot save the information that you supplied.C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) CAs that the webMethods Integration Server maintains. If you specify a default certificate set. Security Tab Field Certificate Chain Description The digital certificate that you want Trading Networks to use to digitally sign or decrypt documents when a partner’s profile does not contain a signing or decrypting certificate. Trading Networks displays the value of the CN (Common Name) field from the Subject defined by the certificate. whether you set values for a default or not. Trading Networks uses the default certificate set for your Enterprise to process information for that partner. For more information.5 . This is because the certificate set is the same as the default set. Trading Networks displays the following fields on each sub-tab. see Appendix B. If you do not set values. if you try to save alternative certificate sets for a partner whose certificates are not set. Private Key The private key that is associated with the digital certificate that you specified in the Certificate Chain field. Trading Networks uses the private key to process Sign. Default certificate sets cannot be deleted. Trading Networks cannot save the information. see security information in the webMethods Integration Server Administrator’s Guide. the default certificate will have sub-tabs with no certificate information defined. SSL Client sub-tab—Use this sub-tab to specify a certificate that enables Trading Networks to act as an SSL client to connect to a remote secure server. If a profile has no signing/decrypting certificate information. and Client SSL certificates. If you try to save alternative certificate sets for a partner using default certificate sets. add that partner to the list of certificate sets and define the alternate set. Then. All profiles display the default certificate as the first element of the Partner list.

The information you need to supply in the Profile Assistant is the same as the information you supply on the Profile screen. Click Next.. In addition. 2 3 4 5 Select Create my profile. Edit an existing entry. or if you are a webMethods Partner Connect member. Add an entry. see “Starting the Trading Networks Console” on page 22. perform the following procedure: To create your profile by specifying your profile information 1 Start the Trading Networks Console. Specifying Your Profile Information To create your profile by specifying your profile information. Delete an entry. Follow the directions specified by the Profile Assistant.Creating Your Own Profile Creating Your Own Profile You create your own profile using the Profile Assistant. you can use the Profile Assistant to create partner profiles. To learn more about: What profiles are.5 115 . “Partner Profiles”. For descriptions of the fields on the or webMethods Trading Networks User’s Guide Version 6. For more details. you can either supply all the information. If you need procedures for this step. see Chapter 9. you can download your profile information from webMethods Partner Connect. The Profile Assistant is a wizard that takes you step-by-step through the process of creating your own profile.. use the following buttons to supply information to the profile fields: Use this button To. On the Profile Assistant panels. The Profile Assistant takes you to the appropriate panel based on the action that you are to perform. Select Tools Profile Assistant . To create your own profile. see the profiles chapter in the webMethods Trading Networks Concepts Guide.

you must go back to that panel and complete the required information to proceed with Profile Assistant.5 . 6 When you have completed all the steps. Trading Networks saves your profile and sets the status of your profile on your system to “Inactive”. Trading Networks saves the new profile and displays the “Profile Created” message. For instructions. even if there are errors. but not yet enabled it. After you create your profile and Trading Networks validates the fields. see “Enabling Your Profile—Changing the Status to Active” on page 129. If you receive an error message. Note that your profile is saved. For instruction on how to enable a profile. see “Information Trading Networks Maintains in Your Profile” on page 106. Click Back to return to the previous panel in Profile Assistant. Summary of Profile Statuses Trading Networks maintains a status for your profile (Enterprise). The following table shows possible profile statuses and their meanings: Status Active Meaning You have filled in your profile and Trading Networks has determined that all profile fields (standard and extended) are valid. Either you have just added your profile. Inactive 116 webMethods Trading Networks User’s Guide Version 6. Note: If the profile fields were not completed correctly. You must edit the profile to correct the errors. Note: Trading Networks validates the information you enter in each panel and will alert you with an error message for incorrect or incomplete entries. Trading Networks: 1) Displays a dialog box listing the error messages that identify the fields that are in error and 2) Saves the profile with the information you specified. Important! Before you can exchange documents with partners.C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) Profile screen. or you have disabled your profile. You have enabled your profile to set the status to “Active”. see “Updating Your Profile” on page 117. you must enable your profile to update the status to “Active”.

5 117 .Managing Your Profile If you enable your own profile. etc. Updating Your Profile From time to time. For more information about enabling a partner’s profile. you will be able to exchange documents with partners. webMethods Trading Networks User’s Guide Version 6. The following lists some reasons for updating your own partner profile: Information about your corporation has changed (name. The Enterprise toolbar and tabs appear on the screen. the contact's e-mail address has changed or possibly you have a new contact to replace an existing one. If you need procedures for this step. You have changed the port number on which Trading Networks listens for incoming requests. for example. You have added extended profile fields that you need to fill in for your profile. If you enable a partner’s profile.. 117 117 129 129 Viewing Your Profile Perform the following procedure to view your profile: To view your profile 1 2 Start the Trading Networks Console.. address.). Managing Your Profile The following table describes the tasks you can perform on your profile: Task “Viewing Your Profile” “Updating Your Profile” “Enabling Your Profile—Changing the Status to Active” “Disabling Your Profile—Changing the Status to Inactive” See page. Information for one of your contacts has changed. see “Starting the Trading Networks Console” on page 22. see “Enabling a Partner’s Profile—Changing the Status to Active” on page 176. you will be able to exchange documents with that partner. You want to change the default certificate that Trading Networks uses to digitally sign documents. you might need to update your profile. Select View Enterprise.

webMethods RosettaNet Module). optionally specify the language preference your corporation uses if needed for another webMethods component (e. For this Corporate tab parameter.g.. for example. Click Save. Fields that you must specify are in blue and are marked with an asterisk (*) on the screen: To update your profile 1 2 3 Start the Trading Networks Console.. “Industrial Steel Company”. In the Preferred Language field. 4) 5) 6) 118 webMethods Trading Networks User’s Guide Version 6. type the name of the organizational unit or division within your corporation. specify the type of software your corporation uses to interact with the trading network: webMethods Trading Networks or webMethods for Partners. “Sales and Marketing”.C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) Perform the following procedure to update your profile. type the name of your corporation. If you need procedures for this step. Corporation Name Unit Name Partner Type Preferred Language Perform this procedure. see “Starting the Trading Networks Console” on page 22.. In the Unit Name field. To add or edit your corporation information: 1) 2) 3) Click Edit Corporation Name Name field. Click the Corporate tab and make the necessary changes. next to the Corporation In the Corporation Name field. Select View Enterprise. for example. For more information about these fields. Trading Networks displays the Profile screen. In the Partner Type field.. see “Information on Your Corporate Tab” on page 106. The partner type is listed with the icon used in the Summary view of the Transaction Analysis screen..5 .

for example. “90001”. Trading Networks confirms that you want to delete the address. Note: Repeat this step for each address that you want to add or edit.Managing Your Profile For this Corporate tab parameter.5 119 . a zip code) for the state or province where your corporation is located. 2) webMethods Trading Networks User’s Guide Version 6. To delete an address: 1) Select the tab containing the address you want to delete. for example. The postal code (for example. Country Address City State/Province Postal Code Perform this procedure. Click Yes. “123 Main Street. “California”... The city where your corporation is located. You can specify an unlimited number of addresses for a corporation. select the tab containing the address you want to edit. City State/Province Postal Code 3) Click Save.. Suite 456”. click Add New Address on the right side of the screen. “Los Angeles”. for example. for example. The state or province where your corporation is located. The order that you add the addresses is the order that they are displayed as tabs.. then click Edit Address 2) . To edit. Click Delete Address in the bottom portion of the screen. Specify the following fields for the corporate information: For this corporate parameter… Country Address Specify… The country where your corporation is located. The street address for your corporation. To add or edit an address for your corporation: 1) To add. “USA”. for example.

Select the profile group name from the list of available groups. Note: You can only associate profiles with a profile group if there are profile groups defined in the database.C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) For this Corporate tab parameter.. select the row you want to edit. Click Save. Be sure to include an external ID type for each type of identification that you use in documents. 3) 4) 5) 6) Click Save. see “Other Configuration Settings” on page 61. The maximum length you can specify for an external ID is 128 characters. For example. specify 987654321 for Value. select the external ID type. Trading Networks confirms that you want to delete the profile group. To add or edit a profile identifier: 1) To add and external ID. You can associate your profile with a profile group.. specify the value of the external ID type.5 . In the External ID Type field. To add a new profile group. Click Yes. if you selected DUNS and your D-U-N-S number is 987654321. In the Value field. To delete a profile group association.. select the row containing the profile group you want to delete and click Delete From Group . You can specify an unlimited number of external ID types. then click Edit External ID 2) . Repeat this step if you want to associate your profile with more than one profile group. 120 webMethods Trading Networks User’s Guide Version 6. Click Add New Profile Group next to Profile Group Membership.. External ID Type Value Profile Group Membership Perform this procedure. To edit. click Add New External ID in the Profile Identifiers section on the bottom portion of the screen.

Trading Networks confirms that you want to delete the external ID. To delete a profile identifier: 1) Select the row containing the external ID you want to delete and click Delete External ID . Click Yes. for example. For each contact. This might be a job title. “Administrative”. For more information. select the . supply the following information. then click Edit Contact 2) Specify the following fields for the contact: For this contact parameter… Contact Type Specify… The type of contact. Note: To sort the contacts’ last names alphabetically.. or delete the contacts listed in this column. see “Information on Your Contact Tab” on page 109...Managing Your Profile For this Corporate tab parameter.5 121 . The role the contact has in the partner’s corporation. Select a contact type from the list. webMethods Trading Networks User’s Guide Version 6. 4 Click the Contact tab and fill in the fields. To add or edit a contact: 1) To add.. Perform this procedure. The contact's last (surname) name. name you want to edit. click Add New Contact . edit. For this Contact tab parameter.. for example. “Trading Network Administrator”. Use the Name column on the left-hand side of the screen to add.. To edit.. click on the Name column heading for forward ( ) and reverse ( ) alphabetization. Contact Type Role Last Name First Name E-mail Telephone Extension Pager Fax Country Address City State/Province Postal Code Last Name Role Perform this procedure..

The postal code (for example. You can specify an unlimited number of contacts for a corporation.. If the telephone number in the Telephone field identifies the main line for the corporation. The contact's telephone number. for example. for example.5 .com”. use the Extension field to identify the contact's extension. “California”. “90001”. The state or province where the contact is located. The contact's pager number. “jsmith@IndustrialSteel. The country where the contact is located. Suite 456”. Perform this procedure.C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) For this Contact tab parameter. Note: Repeat this step for each contact that you want to add or edit. “1-330-555-7890”. for example. “1-800-555-1234”. for example. The contact's extension number. the new contact’s name now appears in the Name column. 122 webMethods Trading Networks User’s Guide Version 6. for example. for example. If you added a contact. for example. Telephone Extension Pager Fax Country Address City State/Province Postal Code a Click Save. for example. for example. a zip code) for the state or province where the contact is located. “123 Main Street.. First Name E-mail The contact's first (given) name... The street address for the contact. The city where the contact is located. “Los Angeles”. “1-888-555-4897”. The contact's e-mail address. The contact's fax number. “USA”.

. specify the host name or IP address of your system in the Host field. FTP. To edit a delivery method. For an HTTP. The Deliver document processing action uses the settings on the Delivery Method tab. Click Yes.Managing Your Profile For this Contact tab parameter. 4) Note: If you do not supply a port number. select the tab for the delivery method. HTTPS.. In the Protocol field. For this Delivery Method tab parameter. click Add New Destination in the upper portion of the screen. specify the port number on which your system listens for incoming requests in the Port field.. select a delivery method from the list. Trading Networks uses the following defaults: HTTP—80. 3) For an HTTP.com”. Trading Networks updates the information on the tab screen to display the fields required for the protocol you selected. To delete a contact: 1) Select the contact that you want to delete in the Name column.. or FTPS delivery method. “IndustrialSteel. for example. or FTPS delivery method. Click Delete Contact . webMethods Trading Networks User’s Guide Version 6. HTTPS—443. To add or edit a delivery method: 1) To add a delivery method.. see “Information on Your Delivery Method Tab” on page 111.5 123 . “5555”. Trading Networks confirms that you want to delete the contact.. FTP... FTP or FTPS— 21. 2) 5 Click the Delivery Method tab and fill in the fields to specify how partners are to deliver documents to your Trading Networks system. HTTPS. for example. Protocol Host Port Location E-mail Use as preferred protocol 2) Perform this procedure. Perform this procedure. click Edit Destination . then. For more information.

5 . By default. 5) For an HTTP.tn/receive” for HTTP and HTTPS. “bizdoc@isteel. 8) 1) 2) Click Save.. select the Use as preferred protocol checkbox. Perform this procedure.. Trading Networks uses Queue for polling. Note: You cannot delete a delivery method that is selected as the preferred protocol... Location is the URL partners should use to send documents to your system via HTTP or HTTPS. For FTP or FTPS. Trading Networks displays the default URL: “/invoke/wm. HTTPS. specify one of the following in the Location field: For HTTP or HTTPS. FTP or FTPS delivery method. Location is a directory path on the machine identified by Host and Port to which your partners should deliver documents when using this FTP or FTPS delivery method. Trading Networks displays the preferred protocol at the top of the Delivery Method tab screen. specify the e-mail address to which you want a partner to deliver documents in the E-mail field. Click Yes. 6) For an E-mail delivery method. Trading Networks confirms that you want to delete the delivery method. 124 webMethods Trading Networks User’s Guide Version 6.C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) For this Delivery Method tab parameter. Click Delete Destination . for example.com” If you prefer that partners use this delivery method to deliver documents to your Trading Networks system. 7) To delete a delivery method: Select the tab for the delivery method you want to delete. Note: If the Use as preferred protocol is not selected for any delivery method.

Trading Networks does not list that group. To view the values of the extended field: 1) From the Group column on the left side of the screen. 2) Click Edit Field group. Note: You must save the changes you make to one group’s extended fields before you can edit another group’s extended fields.Managing Your Profile 6 Click the Extended Fields tab and fill in the fields... Group Perform this procedure. “Corporate” will not appear in the Group column. For more information.. contact your Trading Networks administrator to determine what to specify. 3) Click Save. See “Extended Profile Fields” on page 97 on how to add and define extended fields.5 125 . For this Delivery Method tab parameter.. For example. if you have not defined any extended profile fields for the “Corporate” group. Repeat this step for each extended field you want to update. see “Information on Your Extended Fields Tab” on page 113. Note: If there are no extended profile fields in a specific group. webMethods Trading Networks User’s Guide Version 6. to fill in the fields for the selected Note: If you do not know what to specify for an extended field and the description does not indicate what to specify. Trading Networks displays the corresponding extended fields on the right. select the name of the group that contains the extended profile field you want to edit.

Select the appropriate certificate sub tab: Sign/Verify. Use this sub-tab… Sign/Verify Decrypt/Encrypt SSL Client To add/update certificates to use to… Digitally sign documents that your Enterprise sends to partners. Enable Trading Networks to act as an SSL client to connect to a remote secure server. . The Console displays the certificate information on the right. 3) To add a certificate chain: 1) 2) 3) Click Edit Selected Click Add Certificate(s) . see “Information on Your Security Tab” on page 113..C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) 7 Click the Security tab and fill in the fields. For this Security tab parameter… Certificate Chain Perform this procedure. Decrypt/Encrypt.5 . Trading Networks displays the certificate information. For more information. or SSL Client. 126 webMethods Trading Networks User’s Guide Version 6. Click the appropriate row of the Certificate Chain table. Perform the following procedure for each sub-tab. To view information about a certificate: 1) 2) Select the partner from the Partner list on the left. add one or more certificates as follows: To add one certificate. In the Add Certificate dialog box.. browse to and select the file that contains the certificate. Decrypt documents that your Enterprise receives from partners.

If a key is not defined. <Empty> appears in the text field. If you import a . To delete certificates: 1) 2) Click Edit Selected .p7b file. CA certificates. webMethods Trading Networks User’s Guide Version 6.5 127 . To select multiple certificates. be sure also to delete the CA certificate(s) and private key that are associated with the certificate. Select the certificate(s) that you want to delete.cer or . Trading Networks replaces the certificate chain list with the . However.der file. or . Note: If you delete the certificate.. be sure also to add the CA certificate(s) and private key that are associated with the certificate. Note: When you add a certificate. Defined appears in the text field. Trading Networks can import files that have a .. if you import a . When Trading Networks prompts you to verify that you want to delete the certificate(s).cer or . click Yes. Note: The order that Trading Networks displays the certificate chain does not reflect how the chain is linked. and private keys must reside in your file system. press CTRL and click on the second and subsequent certificates. To add multiple certificates within a directory. If you select an entire directory. Trading Networks imports all files except duplicate files and private key files. If a key is defined.cer.der. . Click Delete Certificate(s) . 3) Private Key To view a private key: The Trading Networks Console will not display private key information. The certificates. using the SHIFT + CONTROL keys. Trading Networks appends it to the existing certificate chain list. browse to and select the files that contain the certificates.p7b file.p7b extension.Managing Your Profile For this Security tab parameter… Perform this procedure.

in the Private Key field. click Yes.5 . To add a private key: 1) 2) 3) Click Edit Selected . When Trading Networks prompts you to verify that you want to delete the private key. Note: If you add a private key.. Note: If you delete the private key. be sure also to delete the certificate and CA certificate(s) that are associated with the private key. then click Open. browse to and select the file that contains the private key that you want to add. Once you select the file. You can only import a . To delete a private key: 1) 2) Click Edit Selected . Click Delete Private Key . 128 webMethods Trading Networks User’s Guide Version 6. be sure also to add the certificate and CA certificate(s) that are associated with the private key.der file that contains a valid private key format.. Click Import Private Key In the Import Private Key dialog box.C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) For this Security tab parameter… Perform this procedure.

perform the following procedure: To disable your profile 1 2 3 Start the Trading Networks Console. see “Starting the Trading Networks Console” on page 22. Disable. perform the following procedure: To enable a your profile 1 2 3 Start the Trading Networks Console. see “Starting the Trading Networks Console” on page 22. you must enable your profile by updating your status to “Active”. For more information about statuses. To disable your profile.Managing Your Profile Enabling Your Profile—Changing the Status to Active After you add a profile and Trading Networks validates the fields. Select Enterprise webMethods Trading Networks User’s Guide Version 6. If you need procedures for this step. Select View Enterprise. Enabling your profile allows you to exchange documents with partners. Enable. Trading Networks saves the profile and sets the status of the profile to “Inactive”. When you enable your profile. Select View Enterprise. If you need procedures for this step. For more information about statuses. As a result. To enable your profile. Trading Networks changes the status of the profile to “Active”. Select Enterprise Disabling Your Profile—Changing the Status to Inactive When you disable your profile. you will not be able to exchange documents with your partners. see “Summary of Profile Statuses” on page 116. see “Summary of Profile Statuses” on page 116. Trading Networks changes the status of your profile to “Inactive”. Before you can exchange documents with partners.5 129 .

5 .C H A P T E R 8 Yo u r P r o f i l e ( Yo u r E n t e r p r i s e ) 130 webMethods Trading Networks User’s Guide Version 6.

. . . . . . . . . . . . 145 About Querying and Viewing Profiles . . . . . . . . . . . . . . . . . . . . . . .5 131 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .CHAPTER 9 Partner Profiles What is a Partner’s Profile? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 Information Trading Networks Maintains in the Partner’s Profile . . . . . . . . . . . 173 webMethods Trading Networks User’s Guide Version 6. . . . . . . 166 Managing the Partner’s Profile . . . . . . . . . . . . . . 132 Adding Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . .

For procedures on how to add a partner’s profile. edit. Chapter 8. Value webMethods Trading Networks webMethods for Partners Meaning The corporation uses webMethods Trading Networks. Information on the Partner ’s Corporate Tab Note: Note that you cannot create partner profiles until after you have created the Enterprise profile for your corporation. see “Adding Partner Profiles” on page 145. Extended Fields. You need to supply partner information that Trading Networks groups on the following tabs of the Profile screen: Corporate. The type of software the corporation uses to interact with the trading network. for example. The name of the organizational unit or division within the partner’s corporation. You add a partner’s profile by providing partner information on the New Profile screen. Contact. Delivery Method. You can use the Trading Networks Console to add. for example. and Security. The Corporate tab contains the partner’s address information and profile identifiers.CHAPTER 9 Partner Profiles What is a Partner ’s Profile? A partner’s profile is a summary of information about a partner on a trading network. and view profiles. For more information about creating your Enterprise profile.5 . “Industrial Steel Company”. see the previous chapter. “Your Profile (Your Enterprise)”. webMethods Trading Networks (Trading Networks) maintains your profile and the profile of each of your partners on your network. Trading Networks displays the following fields on the partner’s Corporate tab. Corporate Tab Field Corporation Name Unit Name Partner Type Description The name of the partner’s corporation. These profile identifiers include the partner’s external ID type and profile group membership information. A partner in the network that is using webMethods for Partners. Information Trading Networks Maintains in the Partner ’s Profile The partner’s profile is made up of the standard fields that webMethods defines and the extended fields you define. 132 webMethods Trading Networks User’s Guide Version 6. “Sales and Marketing”.

. Trading Networks displays the following fields on the partner’s Address sub-tab. “California”. webMethods Trading Networks User’s Guide Version 6. Trading Networks does not use this option for its own processing.g. The postal code (for example. A partner in the network that is not using one of the other types of software. for example. Preferred Language The Preferred Language option is for use only by other webMethods components (e.5 133 . for example. a zip code) for the state or province where the partner’s corporation is located. this might be a partner that is using a webMethods Integration Server (without Trading Networks) or a marketplace. for example. The city where the partner’s corporation is located. for example “USA”. Optionally. “90001”. “Los Angeles”. Address Sub-Tab Field Country Address City State/Province Postal Code Description The country where the partner’s corporation is located. webMethods RosettaNet Module) for localization purposes. The street address of the partner’s corporation. For example. The state or province where the partner’s corporation is located.Information Trading Networks Maintains in the Partner’s Profile Corporate Tab Field Description Web Browser Other/Unknown A partner in the network that is using a Web browser. specify the preferred language of the partner. for example. “123 Main Street”.

idType property controls what type of external ID is used as the IS username for Trading Networks partners.5 . the value of the required ID type is used for a webMethods user account that Trading Networks automatically creates when you add a partner profile. You configure the required ID type by using the tn.required. select DUNS from the External ID Type list and specify the partner’s D-U-N-S number in the Value column. Note: The tn. if the partner uses a D-U-N-S number as an external identification type. For example. Profile Identifiers Field External ID Type Value Description The External ID Type is the type of identification that the partner (partner’s corporation) uses within documents. Trading Networks can associate the document with the partner. “Trading Networks Configuration Properties”. This required ID type cannot contain any white spaces. For more information about the TN Properties page. The Value is the alpha-numerical value of the partner’s external ID type.idtype property on the TN Properties page. 134 webMethods Trading Networks User’s Guide Version 6. Trading Networks uses the values of these fields to correlate the identification of a corporation in a document to the corporation defined by the partner’s profile. see Chapter 4. This required ID type cannot contain any white spaces and the default value is DUNS.CHAPTER 9 Partner Profiles Trading Networks displays the following fields in the partner’s Profile Identifiers section of the partner’s Corporate tab. For example. Additionally. when Trading Networks receives a document with an external ID type that is a D-U-N-S number and that D-U-N-S number matches the value specified in a partner’s profile. You determine the external ID that Trading Networks uses for the user account by identifying a required ID type.required.

5 135 . Important! After the valid profile is added. Once you create a profile group. The partner’s Corporate tab also contains the Profile Group Membership table. your partner must access your system using this user account. webMethods Trading Networks User’s Guide Version 6. Corporate tab Field Profile Group Membership Description The name of the profile group that Trading Networks associates the partner’s profile to. you can associate a partner profile (including your Enterprise profile) with any profile group and to more than one group. Be sure to record the information so that you can send the user name and password to your partner in“Step 3: Informing the Partner of the User Name and Password” on page 165. For more information about how to create profile groups.Information Trading Networks Maintains in the Partner’s Profile Profile Identifiers Field Description When your partner delivers a document to your system. You can only associate profiles with a profile group if there are profile groups defined in the database. The user account has the proper Trading Networks privileges to allow your Trading Networks system to accept documents. your partner cannot access or use your Trading Networks system. This column contains the list of profile groups that the partner profile belongs to. Otherwise. Trading Networks displays the partner’s username and password on your system. see “Other Configuration Settings” on page 61.

The contact's last name (surname). see the webMethods Trading Networks Built-in Services Reference. The country where the contact is located. click on the Name column heading for forward ( ) and reverse ( ) alphabetization. for example. Telephone Extension Pager Fax Country Address The contact's telephone number.tn. If an e-mail address is not specified for a contact of the selected contact type. Note: Out-of-the-box. Trading Networks cannot send the e-mail message. The contact's extension number. “1-330-555-7890”. for example. Role Last Name The role the contact has in the partner’s corporation. Contact Tab Field Name Contact Type Description This column contains the list of contacts defined for a partner’s corporation. 136 webMethods Trading Networks User’s Guide Version 6. “1-800-555-1234”. You can add additional contact types by using the built-in service wm.5 . see “Action 2—Send an Alert E-mail” on page 338. The type of contact. For more information. Note: To sort the contacts’ last names alphabetically. “Administrative”. “USA”.dictionary:addContactType. Trading Networks allows you to select a contact type for the Alert e-mail processing action. Trading Networks provides pre-defined contact types. “1-888-555-4897”. The contact's fax number. for example. for example. for example. “123 Main Street. Suite 456”. The street address of the contact.CHAPTER 9 Partner Profiles Information on the Partner ’s Contact Tab Trading Networks displays the following fields on the partner’s Contact tab. This might be a job title. The contact's e-mail address. The Alert e-mail processing action instructs Trading Networks to send an e-mail message to the contacts of the selected contact type. Note: On the Processing Rules screen. for example. First Name E-mail The contact's first (given) name. for example. “Trading Network Administrator”. For more information. The contact's pager number.

Host The host name or IP address of the partner’s system. for example. FTP. webMethods Trading Networks User’s Guide Version 6. If no port number is supplied. see Chapter 17. and FTPS. for example. Delivery Method Tab Field Protocol Description The name of a delivery method Trading Networks can use when delivering documents. FTP. for example. HTTPS. FTP. use 80. You can also queue documents for scheduled delivery using the Trading Networks’ out-of -the-box delivery service (wm. a zip code) for the state or province where the contact is located.5 137 . and FTPS protocols. for FTP or FTPS. “5555”. “Los Angeles” The state or province where the contact is located. for HTTPS. for example.tn. Information on the Partner ’s Delivery Method Tab Trading Networks displays the following fields on the partner’s Delivery Method tab. “90001”. Note: This option is only valid for HTTP. use 21. The postal code (for example. HTTPS.Information Trading Networks Maintains in the Partner’s Profile Contact Tab Field City State/Province Postal Code Description The city where the contact is located.com”. “Delivery Services” on how to create custom delivery services. “IndustrialSteel. HTTP. and FTPS protocols. If you require another method. HTTPS. “California”. for example. See “Scheduled Delivery Queues” on page 378 for more information. Port The port number on which the partner’s system listens for incoming requests. the following defaults are used: for HTTP.transport:batchFTP service). use 443. which uses FTP to deliver documents to a single destination. Note: This option is only valid for HTTP. Note: Trading Networks provides (out-of-the-box) immediate delivery methods for delivering documents via e-mail (SMTP).

contact the partner. the file extension is dat FTP or FTPS User Name The user name that your Trading Networks system is to supply when connecting to the partner’s system to deliver documents using the associated protocol (HTTP. Important! If you are creating a profile for a partner that uses webMethods Trading Networks or webMethods for Partners. or FTPS).g. For XML documents. the file extension is xml. you must specify the user name of a webMethods User account on the partner’s system.. The directory path that Trading Networks is to use when sending documents. e. For this Protocol… HTTP or HTTPS Use this Location… The URL that Trading Networks is to use when sending documents. 0a010154f70ddbf900000203.tn/receive. For flat file documents. 138 webMethods Trading Networks User’s Guide Version 6. If you do not know what to specify for User Name.CHAPTER 9 Partner Profiles Delivery Method Tab Field Location Description The location Trading Networks is to use when sending a document to a partner’s system.5 . The user account must be a member of the TNPartners group on the partner’s Integration Server. FTP. HTTPS. The file name of the file is the internal ID that Trading Networks generates for the document when Trading Networks receives it.xml. Trading Networks automatically fills in the Location with /invoke/wm. the standard URL for document exchange.

webMethods Trading Networks User’s Guide Version 6. Note: You cannot select either the public or private queue as the preferred protocol. You can view the password in clear text (after you save the profile) by selecting Show Password from the Trading Partners menu. since trading partners are allowed to create custom scheduled delivery services. FTP. and FTPS protocols. see “Defining Public Queues” on page 380. It is not possible for Trading Networks to encrypt passwords used in scheduled delivery queues.com”. Note: Passwords used in scheduled delivery queues (public and private) are stored in the Trading Networks database in binaryencoded form (not in clear text). Note: This option is only valid for HTTP. E-mail Use Public Queue The e-mail address to which the partner wants Trading Networks to deliver documents. For more information about public queues. or FTPS). HTTPS.Information Trading Networks Maintains in the Partner’s Profile Delivery Method Tab Field Password Description The password that your Trading Networks system is to supply (along with User Name) when connecting to the partner’s system using the associated protocol (HTTP. A public queue is a queue that can contain documents for multiple receiving partners. FTP. HTTPS. for example. Documents bound for several partners can be placed in the same public queue.5 139 . Trading Networks cannot anticipate which user-defined input variable might be a password. see Appendix B. View-only screen of schedules and settings for the selected public queue. The password appears hidden by asterisks (*) on this screen. "Security within Trading Networks" in the webMethods Trading Networks Concepts Guide. “bizdoc@isteel. For more information.

Trading Networks runs the delivery service on the day(s) and at the time(s) that you specify either during a specified date range or indefinitely. see “Using the Run Once Option” on page 385 Simple Interval. For more information. A private queue is a queue that contains only delivery tasks that correspond to documents aimed for a specific receiving partner. Run Once. Schedule tab–The schedule of when Trading Networks is to invoke the delivery service that will deliver documents from this queue. For more information. or Disable Queue). For more information about the fields on the Schedule tab. Complex Interval. 140 webMethods Trading Networks User’s Guide Version 6. see “Adding and Registering New Delivery Services” on page 421 Set Inputs. For more information. Drain Queue. see “Using the Simple Interval Option” on page 385. The delivery service to use for the private queue. The state of the queue (Enable Queue. Delivery Service. For more information. see “Using the Complex Interval Option” on page 386.5 . Select the delivery service from the list. Trading Networks executes the delivery service repeatedly at an interval you specify. Trading Networks executes the delivery service a single time. Queue State. see “Delivery Schedule for Queues” on page 384. Suspend Delivery.CHAPTER 9 Partner Profiles Delivery Method Tab Field Use Private Queue Description Send documents to a private queue for scheduled delivery. Settings tab–Set the following private queue settings on this tab. The state of the scheduled delivery queue determines: 1) whether Trading Networks can add delivery tasks to the queue and 2) whether Trading Networks can deliver documents associated with the delivery tasks in the queue. The inputs for the delivery service you selected.

webMethods Trading Networks User’s Guide Version 6. If the Use as preferred protocol is not selected for any delivery method. Note: You cannot select either the public or private queue as the preferred protocol. Trading Networks uses the Retry Factor along with the Wait Between Retries value to calculate how long to wait for subsequent retry attempts. Wait Between Retries. The Delivery Maximum Retries option is used for both immediate and scheduled delivery methods. and Retry Factor options are only used when Trading Networks is using reliable delivery (delivery tasks).5 141 .Information Trading Networks Maintains in the Partner’s Profile Delivery Method Tab Field Use as preferred protocol Description The delivery method that your partner prefers your system use to deliver documents to the partner’s system. The preferred delivery method is the value you select for Protocol. Trading Networks does not use the Wait Between Retries and Retry Factor settings for reliable delivery with scheduled delivery because the queue’s delivery schedule dictates how often to retry delivery attempts. Delivery Maximum Retries The number of times you want Trading Networks to attempt to redeliver a document to the partner’s system. Note: The Delivery Maximum Retries. Wait Between Retries The number of milliseconds (ms) you want Trading Networks to wait before making its first attempt to redeliver the document to the partner’s system. Trading Networks uses Queue for Polling. Note: The Wait Between Retries and Retry Factor options are only used when Trading Networks is using reliable delivery for an immediate delivery method (as opposed to a scheduled delivery method).

If you specify zero. Note: Setting the polling frequency too low can have an adverse effect on Trading Networks performance. Delivery Maximum Retries Wait Between Retries Retry Factor Wait until next attempt = = = 3 10000 ms 2 Retry 1 10000 ms Retry 2 20000 ms Retry 3 40000 ms Note: For more information about reliable delivery. Example: The following shows sample values for the reliable delivery settings and how they affect the wait times between attempts to redeliver a document.5 .. Specify a whole number greater than zero for Retry Factor.g. Primary HTTP) that your Trading Networks system uses to contact the partner’s system to request documents that the partner has queued for your system. If you do not want your Trading Networks system to poll for documents. Trading Networks will not poll. Specify a number of minutes that is zero or greater. Trading Networks calculates the time to wait by multiplying the last wait time by Retry Factor. see “Using Reliable Delivery with Immediate Delivery Method” on page 343 and “Using Reliable Delivery with Scheduled Delivery” on page 344. select the blank entry. How often Trading Networks is to poll the partner’s system to retrieve documents that the partner has queued for your system. Select the method from the list.CHAPTER 9 Partner Profiles Delivery Method Tab Field Retry Factor Description The factor you want Trading Networks to use when determining how long to wait before making the second and subsequent attempts to redeliver the document when Trading Networks is using reliable delivery. Polling Method The method (e. Polling Frequency 142 webMethods Trading Networks User’s Guide Version 6.

see Chapter 6.dictionary:addFieldGroup.5 143 . Information on the Partner ’s Extended Fields Tab Trading Networks displays the extended fields that you define on this tab. Note: To see extended fields. Extended Fields Tab Field Group (Name) Description The name of the field group that Trading Networks associates extended fields with.tn. if you have not defined any extended profile fields for the “Corporate” group. Trading Networks does not display “Corporate” in the Group column. For example. For more information about this service. see Chapter 4. webMethods Trading Networks User’s Guide Version 6. Trading Networks provides pre-defined field groups. Delivery methods you can use with Trading Networks. Note: Out-of-the-box. "Sending Documents to Trading Networks for Processing" in the webMethods Trading Networks Concepts Guide.Information Trading Networks Maintains in the Partner’s Profile For more information about Clients that partners can use to send documents to Trading Networks. If there are no extended profile fields in a specific group. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. select the name of the group from the Group column. This column contains the list of groups that have defined profile fields. you can also use the built-in service wm. see the webMethods Trading Networks Built-in Services Reference. You can add additional field groups by specifying a new group when you add a new extended field. and Trading Networks displays the corresponding extended fields on the right. Trading Networks does not display that group. Alternatively.

this certificate information can also be used to decrypt documents that were encrypted with the partner’s public key. You can obtain the certification information by using built-in services. When you specify certificate information on this sub-tab. webMethods RosettaNet Module) that take advantage of this feature. You can also add your own functionality that takes advantage of this certificate information. see the webMethods Trading Networks Concepts Guide. see “Verifying the Digital Signature of an XML Document” on page 227 and “Verifying the Digital Signature of Flat File Documents” on page 294. For more information.5 . For more information. Decrypt/Encrypt sub-tab—Use this sub-tab to specify certificate information that can be used to encrypt information that is being sent to a partner.g. for example a department within your corporation. For more information about security. This tab contains the following sub-tabs: Sign/Verify sub-tab—Use this sub-tab to specify certificate information that Trading Networks uses to verify the digital signature of documents that were digitally signed by this partner. Trading Networks does not check to see whether the CA that signed the certificate is included in the list of trusted CAs that the Integration Server maintains. Trading Networks can also use this certificate information to digitally sign documents on behalf of the partner. Trading Networks maintains this information for other webMethods components (e. Note: If you include the private key in this certificate information.. SSL Client sub-tab—Use this sub-tab to specify a certificate that enables Trading Networks to act an SSL client to connect to a remote secure server. You might have the private key if the profile describes an internal group. You might have the private key if the profile describes an internal group. 144 webMethods Trading Networks User’s Guide Version 6. for example a department within your corporation. Trading Networks verifies a digital signature when instructed to do so by the Verify Digital Signature pre-processing action. see security information in the webMethods Integration Server Administrator’s Guide. Note: If you include the private key in this certificate information.CHAPTER 9 Partner Profiles Information on the Partner ’s Security Tab The Security tab contains the partner’s certificate information that Trading Networks needs to access and interact with any partner in the system.

and enable Trading Networks to act as an SSL client to connect to a remote secure server. "Security within Trading Networks" in the webMethods Trading Networks Concepts Guide. The private key that is associated with the digital certificate that you specified in the Certificate Chain field.Adding Partner Profiles For more information about Security in the Integration Server. you can add a single partner. Security in Trading Networks. you can add as many partners as you want. Security Tab Field Certificate Chain Description The partner’s digital certificate that you want Trading Networks to use to verify digital signatures. and Client SSL certificates. Private Key Adding Partner Profiles If you are using Trading Networks. see the chapter about security information in the webMethods Integration Server Administrator’s Guide. Trading Networks displays the following fields on the sub-tabs. Inform the partner of the user name and password. webMethods Trading Networks User’s Guide Version 6. When you add a profile. You must complete the following steps to add a partner to your network: Step 1 2 3 Description Create the profile for the partner. Enable the partner profile. including trusted CA certificates. If you are using webMethods for Partners and do not already have a partner. webMethods for Partners allows you to maintain only a single partner.5 145 . you are adding a partner to your network. see Appendix B. Encrypt. encrypt documents. Trading Networks uses the private key to process Verify. Trading Networks displays the value of the CN (Common Name) field from the Subject defined by the certificate.

Note: You can duplicate both your enterprise profile or an existing partner profile to add another partner profile. Procedures Select Trading Partners New Trading Partner. 2) Select Trading Partners Trading Partner. 146 webMethods Trading Networks User’s Guide Version 6. 1) Select either your enterprise profile -ORClick the row containing the partner profile that you want to duplicate. Perform the following procedure to add a partner profile from the Profile screen: To add a profile using the Profile screen 1 2 3 Start the Trading Networks Console. fulfill the following prerequisites: Prerequisite Create and enable your Enterprise profile. see “Starting the Trading Networks Console” on page 22. Duplicate Duplicate— With the exception of the corporation name and external ID. You can update any or all fields from the duplicated profile.5 . If you need procedures for this step. Review the fields you need to fill out for the partner profile. Perform one of the following procedures to add a profile. the profile fields are filled with the values from the profile that you want to duplicate. Select View Trading Partners. Obtain the partner information that you require in the profiles on your system and have this information available when you create the profile.CHAPTER 9 Partner Profiles Step 1: Defining a Partner Profile Before you can create partner profiles. Trading Networks displays the New Profile screen to allow you to fill in the information for the profile. Method to add a profile New— The profile fields are empty.

see “Information on the Partner’s Corporate Tab” on page 132. next to the Corporation Continue with step 1 from above. or Other/Unknown. For more information about these fields. For this Corporate tab parameter. In the Partner Type field. for example.. “Sales and Marketing”. for example. In the Preferred Language field. To add the partner’s corporation information: 1) In the Corporation Name field. webMethods for Partners. Web Browser. type the name of the organizational unit or division within the partner’s corporation. optionally specify the language preference the partner uses if needed for another webMethods component (e.5 147 . type the name of the partner’s corporation... webMethods RosettaNet Module). Corporation Name Unit Name Partner Type Preferred Language 2) Perform this procedure.. Fields that you must specify are in blue and are marked with an asterisk (*) on the screen.Adding Partner Profiles 4 Click the Corporate tab and fill in the fields. 3) 4) To edit the partner’s corporation information: 1) 2) Click Edit Corporation Name Name field. specify the type of software that the partner uses to interact with your trading network: webMethods Trading Networks.. webMethods Trading Networks User’s Guide Version 6. “Industrial Steel Company”. In the Unit Name field.g.

The street address of the partner’s corporation. for example. “90001”. To edit an address for your partner: Select the address tab you want to edit. You can specify an unlimited number of addresses for a corporation. The postal code (for example. for example. click Edit Address 1) . “California”. Address City State/Province Postal Code 2) Click Save.. for example. “USA”. then. Suite 456”. “123 Main Street. The state or province where the partner’s corporation is located. a zip code) for the state or province where the partner’s corporation is located. Note: Repeat this step for each address that you want to add. “Los Angeles”. The order that you add the addresses is the order that they are displayed as tabs.. click Edit External ID .CHAPTER 9 Partner Profiles For this Corporate tab parameter. then. Country Address City State/Province Postal Code Perform this procedure. for example. Specify the following fields for the address: For this address parameter… Country Specify… The country where the partner’s corporation is located.. External ID Type Value To add a new external ID type: Click Add New External ID located next to the External ID Type table in the Profile Identifiers section. To add an address for your partner: Click Add New Address on the right side of the screen. The city where the partner’s corporation is located.. for example. To edit an external ID type: Select the row containing the external ID you want to edit.5 . 148 webMethods Trading Networks User’s Guide Version 6.

see Chapter 4. Be sure to include an external ID type for each type of identification that you use in documents.idType property controls what type of external ID is used as the IS username for Trading Networks partners.required. For example. 1) In the External ID Type field. You can specify an unlimited number of external ID types. “Trading Networks Configuration Properties”. specify DUNS if the partner uses a D-U-N-S number.idType property and a description of it.. Click Save.. 3) 1) To delete an external ID: Select the row containing the external ID you want to delete and click Delete External ID 2) . specify the type of identification that the partner’s corporation uses within documents. The maximum length you can specify for an external ID is 128 characters. view the online help files that you access from the TN Properties page. specify 987654321 for Value. 2) In the Value field. The tn. if you selected DUNS and the partner D-U-N-S number is 987654321.required. For more information about the TN Properties page. Note: You determine the external ID that Trading Networks uses for the user account by identifying a required ID type. webMethods Trading Networks User’s Guide Version 6. specify the value of the external ID type.idtype property on the TN Properties page. Click Yes.Adding Partner Profiles For this Corporate tab parameter.. Trading Networks confirms that you want to delete the external ID.. For example. You configure the required ID type by using the tn.required. Perform this procedure.5 149 . To see a list of the tn. This required ID type cannot contain any white spaces and the default value is DUNS.

Trading Networks confirms that you want to delete the profile group. If you want to delete the profile group association: 1) Select the row containing the profile group you want to delete. Note: You can only associate profiles with a profile group if there are profile groups defined in the database.. If you want to associate the partner profile with a profile group: 1) Click Add New Profile Group located next to the Profile Group Membership table in the Profile Identifiers section. Repeat this step to associate the partner profile with more than one profile group. Profile Group Membership Perform this procedure. 2) 3) Click Save. 150 webMethods Trading Networks User’s Guide Version 6.. then.. see “Other Configuration Settings” on page 61. To add a new profile group.5 .CHAPTER 9 Partner Profiles For this Corporate tab parameter. Click Yes so that the partner profile is no longer associated with this partner group.. Delete Profile Group 2) .

com”. supply the following information. on the right side of To edit a contact: Select the row containing the name of the contact you want to edit.. To add a contact: Click Add New Contact the screen. then. “jsmith@IndustrialSteel. .5 151 . Select a contact type from the list. The contact's telephone number. Telephone webMethods Trading Networks User’s Guide Version 6. Note: To sort the contacts’ last names alphabetically. click on the Name column heading for forward ( ) and reverse ( ) alphabetization. for example. First Name E-mail The contact's first (given) name. For each contact. see “Information on the Partner’s Contact Tab” on page 136. This might be a job title.Adding Partner Profiles 5 Click the Contact tab and fill in the fields. “1-800-555-1234”.. Trading Networks displays fields for you to fill in. Fields that you must specify are in blue and are marked with an asterisk (*) on the screen. The role the contact has in the partner’s corporation... for example. You can specify an unlimited number of contacts. “Administrative”. for example. For this Contact tab parameter. “Trading Network Administrator”. For more information about these fields. The contact's last (surname) name. Contact Type Role Last Name First Name E-mail Telephone Extension Pager Fax Country Address City State/Province Postal Code Last Name Role Perform this procedure. for example. click Edit Contact 1) Specify the following fields for the contact: For this contact parameter… Contact Type Specify… The type of contact. The contact's e-mail address.

. 152 webMethods Trading Networks User’s Guide Version 6.CHAPTER 9 Partner Profiles For this Contact tab parameter..5 . a zip code) for the state or province where the contact is located. for example. “123 Main Street. The contact's fax number. For this contact parameter… Pager Fax Address City State/Province Postal Code 2) Click Save. Click Yes. Trading Networks confirms that you want to delete the address. for example.. for example.. The street address for the contact. Suite 456”. You can specify an unlimited number of contacts for a corporation. “90001”. click on the Name column heading for forward ( ) and reverse ( ) alphabetization To delete a contact: 1) Select the contact you want to delete from the Name list and then click Delete Contact 2) . The state or province where the contact is located. The city where the contact is located. Perform this procedure. for example. “1-330-555-7890”. “1-888-555-4897”. “California”. use the Extension field to identify the contact's extension. Note: Repeat this step for each contact that you want to add or edit. Specify… The contact's pager number. for example. Extension The contact's extension number. “Los Angeles”. for example. If the telephone number in the Telephone field identifies the main line for the corporation. To sort the contacts’ last names alphabetically. The postal code (for example.

2) For an HTTP. Trading Networks uses the following defaults: HTTP—80. HTTPS. To add a delivery method: Click Add New Destination upper portion of the screen.com”. in the To edit the delivery method: Select the tab for the delivery method you want to edit. Note: If you selected Queue for delivery as your delivery method. see “Action 4—Deliver the Document to the Receiver” on page 341. specify the port number on which the partner’s system listens for incoming requests. for example.. see “Information on the Partner’s Delivery Method Tab” on page 137. in the Host field. “5555” Note: If you do not supply a port number.. In the Protocol field. select a delivery method from the list. FTP or FTPS—21. click Edit Destination 1) .Adding Partner Profiles 6 Click the Delivery Method tab and fill in the fields to specify how you are to deliver documents to the partner. For this Delivery Method tab parameter. For more information about the Deliver Document By processing action. or FTPS delivery method. see step 7 on page 155 for instructions on how to specify information for this delivery method. in the Port field. The Deliver document processing action uses the settings on the Delivery Method tab. FTP. for example. or FTPS delivery method.. specify the host name of the partner’s system. “IndustrialSteel.5 153 . For more information about these fields. HTTPS—443. For an HTTP. Protocol Host Port Location User Name Password E-mail Use as preferred protocol Perform this procedure. 3) webMethods Trading Networks User’s Guide Version 6. Trading Networks updates the information on the tab screen to display the fields required for the protocol you selected. then. HTTPS. FTP..

5 . FTP. HTTPS. Trading Networks delivers the document to this directory. specify one of the following in the Location field: For HTTP and HTTPS delivery methods. Perform this procedure.. If the partner is using Trading Networks. Note: If you do not know what to specify for User Name. FTP.. 6) For an HTTP. specify the URL Trading Networks is to use when sending a document to the partner’s system. 5) For an HTTP. for example. For FTP and FTPS delivery methods. “cgibin/acceptOrder”. The user account must be a member of the TNPartners group on the partner’s Integration Server. “/invoke/wm.CHAPTER 9 Partner Profiles For this Delivery Method tab parameter. FTP. 4) For an HTTP. HTTPS. contact the partner. specify the password that your Trading Networks system is to supply (along with User Name) when connecting to the partner’s system.tn/receive”.. If you are creating a profile for a partner that uses webMethods Trading Networks or webMethods for Partners. or FTPS delivery method. or FTPS delivery method. specify the user name that your Trading Networks system is to supply when connecting to the partner’s system to deliver documents. or FTPS delivery method. in the User Name field. you must specify the user name for your webMethods User account on the partner’s system. specify the directory path on the partner’s system identified by Host and Port.. the URL is typically. HTTPS. in the Password field. 154 webMethods Trading Networks User’s Guide Version 6.

select which type of queue: Use Public Queue or Use Private Queue. click the View button. Note: You cannot select the Queue for delivery as the preferred protocol. To use a public queue: 1) 2) Select Use Public Queue. Note: You cannot use either the public or private queue as your preferred protocol. Trading Networks displays the preferred protocol at the top of the Delivery Method tab.. For more information about the public queue fields. Trading Networks confirms that you want to delete the delivery method.. then. To delete a delivery method: Select the tab for the delivery method you want to delete.. If you want to review the setting for the public queue. The public queues were defined on the Tools menu of the Console. select the Use as preferred protocol checkbox.. For this Delivery Method tab parameter… Use Public Queue Perform this procedure.. webMethods Trading Networks User’s Guide Version 6.. Then set the following parameters on the New Protocol tab screen of the Delivery Method tab. Specify which public queue to use to deliver documents from the Public Queues list. see “Defining Public Queues” on page 380. Perform this procedure. Click Yes.Adding Partner Profiles For this Delivery Method tab parameter. 7 If you added Queue for delivery as the delivery method (in the Protocol field). 8) 1) Click Save. click Delete Contact 2) .5 155 . 7) When defining the delivery method that the partner prefers that you use to deliver documents to its system.

CHAPTER 9 Partner Profiles For this Delivery Method tab parameter… Perform this procedure. Disable Queue.5 . Select Use Private Queue. The state of the queue (Enable Queue. The inputs for the delivery service. Set the following Settings tab parameters to specify private queue settings. or Suspend Delivery). 3) Click Save. For this parameter… Delivery Service Set Inputs Queue State Specify… Which delivery service to use with the private queue. For a description of each queue state. Drain Queue. The states for private queues are the same states as for public queues. The state of the scheduled delivery queue determines: 1) whether Trading Networks can add delivery tasks to the queue and 2) whether Trading Networks can deliver documents associated with the delivery tasks in the queue. Click Edit and fill in the fields on the Settings and Schedule tabs.. “Scheduled Delivery Queue States” on page 390 Use Private Queue To use a private queue: 1) 2) 3) 156 webMethods Trading Networks User’s Guide Version 6..

For more information. If you want Trading Networks to wait for a delivery service to complete execution before it starts the next scheduled execution of the service.. For descriptions of these fields and examples of setting them. webMethods Trading Networks User’s Guide Version 6.. see “Using the Complex Interval Option” on page 386.Adding Partner Profiles For this Delivery Method tab parameter… Perform this procedure. Trading Networks invokes the service immediately. “Using the Run Once Option” on page 385 Simple Interval The number of seconds that you want Trading Networks to wait between executions of the delivery service in the Interval field. When you add or update a simple interval schedule for a queue that is Enabled or Draining. 4) Set the following Schedule tab parameters for the private queue delivery settings. Subsequent invokes are governed by the interval. In the Time field the time at which you want Trading Networks to execute the delivery service.5 157 . see “Using the Simple Interval Option” on page 385 Complex Interval Settings that indicate when and how often you want the delivery service to execute. The scheduling fields for a private queue are the same as for a public queue. For this parameter… Run Once Specify… In the Date field the date on which you want Trading Networks to execute the delivery service. check Do not overlap task. See “Delivery Schedule for Queues” on page 384 for more information about the schedule settings.

see “Using Reliable Delivery with Immediate Delivery Method” on page 343 and “Using Reliable Delivery with Scheduled Delivery” on page 344 The Delivery Maximum Retries option is used for both immediate and scheduled delivery methods. 5) 6) Click OK. Specify a whole number. In the Delivery Maximum Retries field. Trading Networks uses the Retry Factor along with the Wait Between Retries value to calculate how long to wait for subsequent retry attempts. For more information about reliable delivery. specify the number of times you want Trading Networks to attempt to redeliver a document to the partner when Trading Networks is using reliable delivery. 158 webMethods Trading Networks User’s Guide Version 6...CHAPTER 9 Partner Profiles For this Delivery Method tab parameter… Perform this procedure.5 . 8 Set the following parameters (located on the bottom of the Delivery Method tab screen) to specify the reliable delivery and polling settings.. Note: The Delivery Maximum Retries. To set/supply the values of the reliable delivery and polling settings: 1) 2) 3) Click on Edit Access Information .. 4) In the Wait Between Retries field. specify the number of milliseconds you want Trading Networks to wait before making its first attempt to redeliver the document when Trading Networks is using reliable delivery. Click Save. For this Delivery Method tab parameter… Delivery Maximum Retries Wait Between Retries Retry Factor Polling Method Polling Frequency Perform this procedure. Wait Between Retries.On the bottom portion of the screen to change the default values for these fields. and Retry Factor options are only used when Trading Networks is using reliable delivery (delivery tasks).

Note: If you do not want your Trading Networks system to poll for documents.g. In the Polling Method field. see “Information on the Partner’s Extended Fields Tab” on page 143. 7) Click Save..5 159 .. 6) 9 Click the Extended Fields tab and fill in the fields. For more information. Specify a whole number greater than zero for Retry Factor. specify the method (e.. Trading Networks does not use the Wait Between Retries and Retry Factor settings for reliable delivery with scheduled delivery because the queue’s delivery schedule dictates how often to retry delivery attempts.. select the blank entry. To view the values of the extended field: 1) S webMethods Trading Networks User’s Guide Version 6. specify the factor you want Trading Networks to use when determining how long to wait before making the second and subsequent attempts to redeliver the document when Trading Networks is using reliable delivery.. 5) In the Retry Factor field. Extended fields that you must specify are in blue and are marked with an asterisk (*) on the screen. Select the method from the list..Adding Partner Profiles For this Delivery Method tab parameter… Perform this procedure.. Note: The Wait Between Retries and Retry Factor options are only used when Trading Networks is using reliable delivery for an immediate delivery method (as opposed to a scheduled delivery method). For this Extended Fields tab parameter. Primary HTTP) that your Trading Networks system uses to contact the partner’s system to request queued documents. Trading Networks calculates the time to wait by multiplying the last wait time by Retry Factor. Group Perform this procedure.

. Repeat this step for each extended field you want to update.CHAPTER 9 Partner Profiles For this Extended Fields tab parameter. 10 Click the Security tab and fill in the fields. contact your Trading Networks administrator to determine what to specify. Note: You must save the changes you make to one group’s extended fields before you can add another group’s extended fields.5 .. 2) Click Edit Field group. 3) Click Save. Specify certificate information that can be used to encrypt information that is being sent to a partner. Perform this procedure. For more information. to fill in the fields for the appropriate Note: If you do not know what to specify for an extended field and the description does not indicate what to specify.. see “Information on the Partner’s Security Tab” on page 144. Use this sub-tab… Sign/Verify To … Specify certificate information that Trading Networks uses to verify the digital signature of documents that were digitally signed by this partner. Enable Trading Networks to act as an SSL client to connect to a remote secure server. Decrypt/Encrypt SSL Client 160 webMethods Trading Networks User’s Guide Version 6..

browse to and select the files that contain the certificates.. Note: When you add a certificate. and private keys must reside in your file system. add one or more certificates as follows: To add one certificate. Trading Networks appends it to the existing certificate chain list. 3) To add a certificate chain: 1) 2) 3) Click Edit Selected Click Add Certificate(s) . Trading Networks displays the certificate information.p7b extension.. To add multiple certificates within a directory. However. In the Add Certificate dialog box.p7b file. Trading Networks replaces the certificate chain list with the . webMethods Trading Networks User’s Guide Version 6. browse to and select the file that contains the certificate. or SSL Client. Note: The order that Trading Networks displays the certificate chain does not reflect how the chain is linked. using the SHIFT + CONTROL keys. . If you select an entire directory.cer.Adding Partner Profiles For this Security tab parameter… Certificate Chain Perform this procedure.5 161 . Click the appropriate row of the Certificate Chain table. To view information about a certificate: 1) 2) Select the partner from the Partner list on the left. The certificates. CA certificates. Trading Networks imports all files except duplicate files and private key files.p7b file. be sure also to add the CA certificate(s) and private key that are associated with the certificate. The Console displays the certificate information on the right. Trading Networks can import files that have a . if you import a .cer or . If you import a .der file. Select the appropriate certificate sub tab: Sign/Verify.der. . Decrypt/Encrypt. or .cer or .

5 .. To select multiple certificates. Defined appears in the text field. be sure also to delete the CA certificate(s) and private key that are associated with the certificate. Once you select the file. Click Delete Certificate(s) . You can only import a . To delete certificates: 1) 2) Click Edit Selected . Click Import Private Key In the Import Private Key dialog box.CHAPTER 9 Partner Profiles For this Security tab parameter… Perform this procedure. 162 webMethods Trading Networks User’s Guide Version 6. click Yes.der file that contains a valid private key format. Note: If you add a private key. then click Open. browse to and select the file that contains the private key that you want to add. Note: If you delete the certificate. To add a private key: 1) 2) 3) Click Edit Selected . be sure also to add the certificate and CA certificate(s) that are associated with the private key. <Empty> appears in the text field.. Select the certificate(s) that you want to delete. If a key is not defined. If a key is defined. When Trading Networks prompts you to verify that you want to delete the certificate(s). in the Private Key field. 3) Private Key To view a private key: The Trading Networks Console will not display private key information. press CTRL and click on the second and subsequent certificates.

Important! Be sure to record the information and send the user name and password to your partner. Saves the profile with the information you specified. Otherwise. Note: If you delete the private key. be sure also to delete the certificate and CA certificate(s) that are associated with the private key. 11 After completing all of the partner profile fields: If you are creating a new profile: 1 Click Create Profile to save your new profile. Displays a dialog box listing the error messages that identify the fields that are in error and 2. You must edit the profile to correct the errors.Adding Partner Profiles For this Security tab parameter… Perform this procedure. Trading Networks: 1. Note: If the profile fields were not completed correctly. webMethods Trading Networks User’s Guide Version 6.5 163 . Note: This dialog box will only appear when the profile saved is valid and created successfully. Click Delete Private Key . your partner cannot access or use your Trading Networks system. 2 Once you create the profile and Trading Networks saves it.. To delete a private key: 1) 2) Click Edit Selected .. click Yes. When Trading Networks prompts you to verify that you want to delete the private key. the Console displays the User Account Information dialog box. Trading Networks displays the user name and password of the created IS user account in this dialog box and will use this information later on in “Step 3: Informing the Partner of the User Name and Password” on page 165.

If you need procedures for this step. Either you have just added the profile. To enable a partner’s profile. Inactive You have disabled the profile. When the partner's profile is in this status. Select Trading Partners Enable Trading Partner. perform the following procedure: To enable a partner’s profile 1 2 Select the partner whose profile you want to update. you must enable the profile to update the status to “Active”. Before you can exchange documents with the partner. If you are updating an existing profile: Click Save to save all your changes to the partner profile. You have enabled the profile to set the status to “Active”. you can exchange documents with the partner. see “About Querying and Viewing Profiles” on page 166. see “About Querying and Viewing Profiles” on page 166. Step 2: Enabling the Partner ’s Profile After you add a profile for a partner and Trading Networks validates the fields. 164 webMethods Trading Networks User’s Guide Version 6. but not yet enabled it. or you have disabled the profile.CHAPTER 9 Partner Profiles 3 Continue with “Step 2: Enabling the Partner’s Profile” on page 164. The following table shows the possible profile statuses that Trading Networks maintains for each partner profile and the statuses’ 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. Trading Networks saves the profile and sets the status of the profile to “Inactive”. For more information about managing profiles.5 .

and Secondary HTTPS. HTTP. Be sure to record the information and send the user name and password to your partner. The partner should update the Delivery Method tab of the Profile screen. Secondary HTTP. your Trading Networks system will not accept documents that the partner sends via HTTP or HTTPS. Retrieving the Partner ’s User Name and Password The following is the procedure you need to perform to retrieve the partner’s user account information (user name and password) from your Trading Networks system. Secondary HTTP. Primary FTPS Secondary FTPS. On this screen. the partner should: Enter the user name you supply for the User Name fields for Primary FTP. see “About Querying and Viewing Profiles” on page 166. Secondary FTP. if the partner uses webMethods Trading Networks or webMethods for Partners. Trading Networks displays the user name and password for this partner profile. Primary FTPS Secondary FTPS. If the partner does not. Select Trading Partners Show Password. Primary HTTPS. This is the user name and password Trading Networks displayed at the end of successfully creating a partner profile in “Step 2: Enabling the Partner’s Profile” on page 164. Otherwise. Primary HTTPS. and Secondary HTTPS Enter the password you supply for the Password fields for Primary FTP. In addition. Primary HTTP. Trading Networks displays the user name and password User Account Information dialog box. To retrieve your partner’s user name and password 1 2 3 Select your partner’s profile. or HTTPS and to access the webMethods Trading Networks Web Manager. Secondary FTP. webMethods Trading Networks User’s Guide Version 6.5 165 . Important! After the profile is added. your partner cannot access or use your Trading Networks system.Adding Partner Profiles Step 3: Informing the Partner of the User Name and Password After you create the user account. If you need procedures for this step. you should let your partner know the user name and password for the account that Trading Networks created for the partner. you must make sure the partner enters the user name and password into your profile on their Trading Networks system. Primary HTTP. FTPS. Record the user name and password. Your partner will need to supply this user name and password when delivering documents via FTP.

CHAPTER 9 Partner Profiles Supplying the User Account Information to Your Partner The following is the procedure your partner needs to perform to update your profile on its system. Trading Networks returns information about the profiles that meet the search criteria that you specify and displays the query results in the Profiles table. For more information about different query functions you can perform. Secondary HTTPS. If you plan to use the same query many times. In the Password field. Secondary HTTP. 166 webMethods Trading Networks User’s Guide Version 6. Primary FTPS. Primary FTP. query Trading Networks for the profiles in which you are interested... you can save the query settings.. Click Save. For this Delivery Method tab parameter. When you want to use the same query again. In the User Name field. 4 About Querying and Viewing Profiles You can use the query function of the Trading Partners profile screen to find and view information about all of the profiles in Trading Networks. you simply select that saved query.5 . Secondary FTP. see Chapter 16. Click Edit Destination . 1 2 3 Click the tab for the delivery method. including your own Enterprise profile. For your partner’s procedures to this step.. Specify the following fields for Primary HTTP. Primary HTTPS. User Name Password Perform this procedure. For your partner to update your profile with user name and password on the partner’s system 1 2 3 Your partner should view your profile. your partner should specify the password that you supplied. “Running Queries in Trading Networks”. your partner should specify user name that you supplied. To find a specific profile. and Secondary FTPS. Click the Delivery Method tab. see “About Querying and Viewing Profiles” on page 166.

For each extended profile field that you want to use to select profiles. The basic search criteria includes most of the basic corporate information found on the Corporate tab of the Trading Partners screen. Attribute instructs Trading Networks to look at the value of the specified attribute to determine whether it meets the rest of the criteria for this extended field. and/or postal code. You can use basic search criteria to select for profiles with a specific: Corporation and/or unit name External ID type and value Group membership Partner status (active or inactive) Basic corporation address elements of: country. Operator instructs Trading Networks how to match the value.About Querying and Viewing Profiles To set up a query and display information for viewing profiles. You can specify attributes with the STRING data type. you can search for all profiles with the Encryption Algorithm equal to a specified value. match string values that contain specified characters. state/province. you specify the attribute name. Custom Search Criteria for Profiles Use the Custom Criteria tab to search for profiles based on the extended profile fields. an operator. Basic Search Criteria for Profiles Use the Basic Criteria tab to search for profiles. for example. For example. specify some or all of the following: Basic search criteria Custom search criteria How to display detail view information about selected profiles.5 167 . and the value the attribute should have. The operator you can specify depends on the data type of the attribute. webMethods Trading Networks User’s Guide Version 6. Trading Networks searches for profiles that meet all search criteria that you specify. if you set up Trading Networks with the extended profile field Encryption Algorithm. city.

Matches exactly the value that you specify. Finding and Viewing Profiles To view profiles or perform any operations on the profile. you need to first have the profile visible. You can customize this Profiles table to indicate the columns you want Trading Networks to display using the options on the Detail View tab. Select View Trading Partners. such as the corporation and unit names. You do not need to specify a value when you specify this operator. Has a value that does not match the value that you specify. group membership. it displays the results of your query in the Profiles table.CHAPTER 9 Partner Profiles Data Type STRING Operator Is null Matches when the attribute extracted from a document… Has no value. partner status. Is not null Equals Not equals Contains Has any value. For more information about customizing the display of your table format. 168 webMethods Trading Networks User’s Guide Version 6. Perform the following procedure to select the profile. The attribute value has no value if: XQL query (defined in the TN document type) that Trading Networks used to extract the attribute failed. Detail View of Profiles After Trading Networks selects the profile that matches the basic search criteria that you specify. If you need procedures for this step. “Working with Tables” on page 33. The TN document type does not instruct Trading Networks to extract the attribute.5 . and basic corporation address information. external ID information. Contains the character string that you specify for the value. To find and view a profile 1 2 Start the Trading Networks Console. see “Starting the Trading Networks Console” on page 22. Each column corresponds to information that Trading Networks maintains about a partner profile. You do not need to specify a value when you specify this operator.

“Industrial Steel Company”. External ID Type Value webMethods Trading Networks User’s Guide Version 6. You can use the pattern-matching characters “%” in the corporation name search. 4 Perform one of the following to identify and select the profile of one of your partners: To select from all partners: Select a partner from the Profiles table on the bottom portion of the screen. Type a character string contained in the Corporation Name of the partner you want to work with. on the toolbar. for example.About Querying and Viewing Profiles 3 Select Show Query Detail View tabs. The Value is the alpha-numerical value of the partner’s external ID type. Unit Name The name of the organizational unit or division within the partner’s corporation. for example. select the checkbox next to each criterion you want to use. select DUNS from the External ID Type list and specify the partner’s D-U-N-S number in the Value column.5 169 . To narrow down the list of partners from which to choose: a Select the Basic Criteria tab and fill in the fields to specify basic search criteria.Trading Networks displays the Basic Criteria and Note: Trading Networks displays the last query run on the Trading Networks Console. You must provide both values for the query to work. type a character string contained in the Unit Name of the partner you want to work with. Specify… The name of the partner’s corporation. The External ID Type is the type of identification that the partner (partner’s corporation) uses within documents. if the partner uses a D-U-N-S number as an external identification type. Then fill out the corresponding information as follows For this Basic Criteria tab parameter… Corporation Name . “Sales and Marketing”. For example. To indicate that you want to use one or more of the basic search criteria.

“Los Angeles”.CHAPTER 9 Partner Profiles For this Basic Criteria tab parameter… Group Membership Specify… The name of the profile group that Trading Networks associates the partner’s profile to.5 . The state or province where the partner’s corporation is located. The country where the partner’s corporation is located. You can only select one profile group from the list for each query. specify a STRING extended field to query documents as follows. for example. The postal code (for example. “90001”. For more information about how to create profile groups. Select Active to search for an enabled profile or Inactive for a disabled profile. For the profile query. This column contains the complete list of profile groups that have been created in the database. Partner Status Corporation Country Corporation City Corporation State/Province Corporation Postal Code For more information about these profile query fields. for example. for example “USA”. 170 webMethods Trading Networks User’s Guide Version 6. The city where the partner’s corporation is located. for example. see “Step 2: Enabling the Partner’s Profile” on page 164. “California”. For this Custom Criteria tab parameter… Extended Field Specify… The name of the extended profile fields that you want Trading Networks to use to select documents. a zip code) for the state or province where the partner’s corporation is located. Select a STRING data type from the drop-down list. For more information about partner profile statuses. see “Information on the Partner’s Corporate Tab” on page 132. b Select the Custom Criteria tab and fill in the fields to specify custom search criteria for the extended profile field(s). The status of the partner’s profile. see “Other Configuration Settings” on page 61.

select Equal if you want Trading Networks to match extended fields that have the exact value you specify for Value.5 171 . You do not need to specify a value if you select Is null or Is not null for Operator.and lowercase letters because Trading Networks performs a case-sensitive match. Trading Networks displays a column for each field in the Selected Extended Fields list. Be sure to use the exact combination of upper. select the extended fields that you want Trading Networks to include in the Detail view. Trading Networks displays the Profiles table with the results from the refined query. c 5 Select Run Query on the toolbar. click the Detail View tab. Data Type STRING Operator values Is null. a In the Standard Fields panel. In the Extended Fields section. type the characters in the string. To change the format of the query results in the Profiles table. see “Information on the Partner’s Extended Fields Tab” on page 143. Equals. Contains Value The value you want Trading Networks to use when querying for documents. For more information about extended profile fields. Not equals. For more information about how to use custom criteria. check field that you want Trading Networks to include in the Detail view. To move items to the Selected Extended Fields list: b webMethods Trading Networks User’s Guide Version 6. For example. Trading Networks displays a column for each checked field. Is not null. To specify a string.About Querying and Viewing Profiles For this Custom Criteria tab parameter… Operator Specify… The operator you want Trading Networks to use with the Value you specify. Fill in the following fields to specify how Trading Networks displays information in the Detail view. see “Custom Search Criteria for Profiles” on page 167. Trading Networks always displays the Corporation Name column for each partner profile.

. move the items back to the Available Extended Fields list: . 172 webMethods Trading Networks User’s Guide Version 6. see “Updating the Profile of Your Partner” on page 173. For more information about queries in Trading Networks. If you decide you do not want Trading Networks to display information for the fields in the Selected Extended Fields list. Trading Networks displays the Update Profile screen.. click the Run Query toolbar button. For more information about the tabs and fields on this screen. 6 7 To see the new display format.. To move all extended fields to the Selected Extended Fields list To move some but not all extended fields to the Selected Extended Fields list. select one or more fields in the Available Extended Fields list and then click .5 . see “Step 1: Defining a Partner Profile” on page 146.. Select this. To remove some but not all extended fields from the Selected Extended Fields list. Double click to select the partner you want from query results in the Profiles table on the bottom portion of the screen..CHAPTER 9 Partner Profiles Select this. To do this.. To do this. For procedures on how to change the information in your partner’s profile. select the extended fields you do not want displayed from the Selected Extended Fields list and then click To remove all extended fields from the Selected Extended Fields list... see “About Viewing and Querying Documents” on page 428. .

To update the profile of one of your partners 1 2 Select the partner whose profile you want to update. Corporate Contact Delivery Method Extended Fields Security Use this procedure. Perform the following procedure to update your partner profile. see. Step 4 on page 147 Step 5 on page 151 Step 6 on page 153 Step 9 on page 159 Step 9 on page 160 For more information. Use the table below to find the procedure to update the selected tab.. use the following buttons to supply information to the profile fields: webMethods Trading Networks User’s Guide Version 6. select the tab you wish to update.. To update an existing partner profile. see “About Querying and Viewing Profiles” on page 166.Managing the Partner’s Profile Managing the Partner ’s Profile The following table describes the tasks you can perform on the partner’s profile: Tasks “Updating the Profile of Your Partner” “Deleting a Profile” “Disabling a Partner’s Profile—Changing the Status to Inactive” “Enabling a Partner’s Profile—Changing the Status to Active” See page..5 173 . To update this tab. If you need procedures for this step... “Information on the Partner’s Corporate Tab” on page 132 “Information on the Partner’s Contact Tab” on page 136 “Information on the Partner’s Delivery Method Tab” on page 137 “Information on the Partner’s Extended Fields Tab” on page 143 “Information on the Partner’s Security Tab” on page 144 Follow the procedures to update the partner profile. on the Profile screen.. In general. These procedures are the same ones you initially used to create a partner profile. 173 174 175 176 Updating the Profile of Your Partner You can update the partner profiles that you maintain for your partners..

174 webMethods Trading Networks User’s Guide Version 6. You are no longer able to view: the profile using the Profile screen and any related TPAs. Add an entry Edit an entry Delete an entry or Fields that you must specify are in blue and are marked with an asterisk (*) on the screen. If you decide to delete a profile.5 . Note: You cannot delete your own Enterprise profile. Deleting a Profile When you delete a profile from the Trading Networks Console. use the webMethods Administrator. For instructions. and TPAs that are associated with the partner. you must also delete all related TPAs before deleting the profile. Trading Networks does not provide a way to “undelete” a profile. but keeps all documents.CHAPTER 9 Partner Profiles Use this button To. If a partner sends you a document after you delete its profile. Trading Networks does not delete the user account it created for the partner. To delete the user account. make sure to click Save to save all your changes to the profile.. see the webMethods Integration Server Administrator’s Guide. Trading Networks removes most of the profile data from its database. Important! When you delete a partner’s profile. 3 After updating all of the partner profile fields. Trading Networks treats the document as if it came from an unknown partner. entries..

Trading Networks: Logs an error message to the activity log and associates it with the document Sets the processing status of the document to “ABORTED” Sends an e-mail message to the webMethods Administrator Responds to the sender with an HTTP 403 message if the document was sent using HTTP. webMethods Trading Networks User’s Guide Version 6. When you disable a partner’s profile. Disabling a Partner ’s Profile—Changing the Status to Inactive When you disable a profile.5 175 . see “About Querying and Viewing Profiles” on page 166. If the partner attempts to send you documents while its profile is disabled. perform the following procedure: To disable a partner’s profile 1 2 Select the partner whose profile you want to update. you must delete any related TPAs. Trading Networks changes the status of the profile to “Inactive”.Managing the Partner’s Profile To delete a partner’s profile. For more information. If you need procedures for this step. When Trading Networks prompts you to verify that you want to delete the profile. Select Trading Partners Enable Trading Partner. As a result. click Yes. If you need procedures for this step. see “Step 2: Enabling the Partner’s Profile” on page 164. disabling a profile can be thought of as temporarily removing a partner from your network. you will not be able to exchange documents with that partner. see “Deleting a TPA” on page 192. Important! Before you delete any profile. To disable a partner’s profile. perform the following procedure: To delete a partner’s profile 1 Select the partner whose profile you want to delete. 2 3 Select Trading Partners Delete Trading Partner to delete the profile. For more information about profile statuses. see “About Querying and Viewing Profiles” on page 166.

Select Trading Partners Enable Trading Partner. use the webMethods Administrator. For more instructions. Trading Networks changes the status of the profile to “Active”. you will be able to exchange documents with that partner. 176 webMethods Trading Networks User’s Guide Version 6. see the webMethods Integration Server Administrator’s Guide. see “Step 2: Enabling the Partner’s Profile” on page 164.CHAPTER 9 Partner Profiles Important! When you disable a partner’s profile. As a result. Trading Networks does not disable or delete the webMethods User account for the partner. If you enable a partner’s profile. To delete the user account. perform the following procedure: To enable a partner’s profile 1 2 Select the partner whose profile you want to update. If you need procedures for this step. enabling a profile can be thought of as reestablishing a partner into your network. To enable a partner’s profile. Enabling a Partner ’s Profile—Changing the Status to Active When you enable a profile. For more information about profile statuses. you will be able to exchange documents with partners. If you enable your own profile. see “About Querying and Viewing Profiles” on page 166.5 .

. 181 Managing TPAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .CHAPTER 10 Trading Partner Agreements (TPAs) What is a Trading Partner Agreement (TPA)? . . . . . 185 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . 178 Information You Supply to Define a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 Defining a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 177 . . . . . . . . .

you supply the following information: sender. Information You Supply to Define a TPA When you define a TPA. Agreement ID. one that fulfills the sender role during document exchange. Trading Networks returns information about the TPAs that meet the search criteria that you specified in your query. first specify a query to identify the TPAs in which you are interested. and optionally. Agreement Status. For more information about TPAs. agreement ID. services (export and initialization). To view TPAs and their data in Trading Networks. Both the sender and receiver in a TPA must be a partner in your Trading Networks system that has an existing profile. Receiver Name of the trading partner that has the receiver role in the TPA. including your own profile (Enterprise). see Chapter 2. To use a TPA. IS document type. both partners in the agreement must have existing profiles in Trading Networks. including your own profile (Enterprise). data status. "Trading Partners" in the webMethods Trading Networks Concepts Guide. Note: A TPA is an agreement between two partners in your network. receiver. a description. Agreement ID 178 webMethods Trading Networks User’s Guide Version 6.C H A P T E R 1 0 Tr a d i n g P a r t n e r A g r e e m e n t s ( T PA s ) What is a Trading Partner Agreement (TPA)? 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. You select the receiver from the profiles defined on your Trading Networks system. Timestamp. An application-specific field that uniquely identifies the type of agreement between two partners. and IS Document Type. Receiver. and the other that fulfills the receiver role. TPA Information Sender Description Name of the trading partner that has the sender role in the TPA. You can query TPAs by the following fields: Sender. You select the sender from the profiles defined on your Trading Networks system.5 . Trading Networks uses the profiles to ensure that the partners are valid for that Trading Networks system.

b2b. webMethods’ components that use the TPA feature come with the IS document type you need to use for the TPA data. the webMethods EDI Module uses the control number to ensure documents are processed in order and that no documents have been lost or unprocessed.editn. these are the parameters that your custom applications need access to during document exchange.cpa. see webMethods EDI Module User’s Guide. Use the webMethods Developer to create the IS document type that contains the parameters you need for your custom application. see “Changing the TPA Data Inputs in the IS Document Type” on page 190. For more information on how to create an IS document type. When using the TPA feature for your own custom application. For example.ip.rec:tpaDataSchema IS document type. For more information about EDI TPAs.TPA:EDITPA IS document type and the webMethods ebXML Module supplies the wm.5 179 . the webMethods EDI Module supplies the wm. For more information about changing the data. webMethods Trading Networks User’s Guide Version 6. see the webMethods Developer User’s Guide.Information You Supply to Define a TPA TPA Information IS Document Type Description An IS document type that specifies the data that you define in the TPA.ebxml. you can use the Control Number field in any way you want. Trading Networks does not update the Control Number field. Some webMethods’ components that take advantage of the TPA feature use the Control Number field. Control Number A field that is available for application-specific use. For example. When using the TPA feature for your own custom application.

The data status can be one of the following: Modifiable . When using the TPA feature for your own custom application.the TPA data cannot be changed Note: Trading Networks uses the data status only after the TPA has an Agreed status. you can execute your export service.C H A P T E R 1 0 Tr a d i n g P a r t n e r A g r e e m e n t s ( T PA s ) TPA Information Data Status Description This field applies only when the Agreement Status is Agreed. Export Service A service that exports a Trading Networks TPA and converts it to an industry-standard format. see “Changing a TPA Agreement Status” on page 188.the TPA data can be changed Non-modifiable . The data status indicates whether you can update the values for the TPA data defined in the IS document type (located in the panel on the lower portion of the Agreement Details dialog box). you can create an export service that converts the Trading Networks TPA to the industry-standard format that you require. After creating a TPA. Defining an export service is optional. 180 webMethods Trading Networks User’s Guide Version 6. see “Changing the TPA Data Inputs in the IS Document Type” on page 190. For more information about changing the TPA data defined in the IS document type.5 . For more information about TPA statuses. Note: The format of the industry-standard agreement will not be the same as the format of a Trading Networks TPA. if you need to obtain the industry-standard format of a TPA.

If you need procedures for this step. Defining an initialization service is optional. Specify 1-1024 characters. webMethods Trading Networks User’s Guide Version 6. Some webMethods’ components that take advantage of the TPA feature supply an initialization service.editn.ip. the webMethods EDI Module supplies the service wm. For example. Use the following procedure to define a TPA. Perform one of the following procedures to create a new TPA. Defining a TPA You define TPAs on the Agreement Details screen of the Trading Networks Console. The webMethods ebXML Module supplies the wm. There is no restriction to the characters that you can use. you can create an initialization service that populates the parameters in the IS document type with default values. Trading Networks displays the Agreements screen. For more information about EDI TPAs. Trading Networks displays the corresponding IS document type data tree on the bottom panel of the screen. see the webMethods ebXML User’s Guide Description This is an optional field that you can use to specify a description for the TPA.5 181 . Select View Agreements.ebxml.Defining a TPA TPA Information Initialization Service Description A service that sets default values for the IS document type data of the TPA. You can set this field to point to an IS service that can provide the initial values for that data.b2b. see the webMethods EDI Module User’s Guide. After you set the attributes of your TPA on the top portion of this screen and select the IS document type. The right side of this panel displays the input values (TPA data inputs) to variables of the IS document type.TPA:initService that populates the EDITPA with the default values for an EDI TPA.cpa:initTPA initialization service. see the webMethods Trading Networks Concepts Guide. When using the TPA feature for your own custom application. For more information about ebXML CPAs. To define a TPA 1 2 3 Start the Trading Networks Console.

to create a template that you will duplicate to create other TPAs. you can use the default value of Unknown. and Agreement ID fields must be unique for each TPA. Trading Networks displays the Agreement Details screen.. Trading Networks displays the Agreement Details screen to allow you to fill in the information for the TPA.. For EDI. For more information about how to select a sender. 182 webMethods Trading Networks User’s Guide Version 6. Duplicate—The TPA fields are filled with values from the TPA agreements that you duplicate. Type in the name of the sender or click the Select. After you create a TPA. You can update any or all fields from the duplicated TPA agreement. 4 Procedures Select Agreements New. you cannot change or update these fields of the TPA.. you can use the default value of Unknown. button to select the sender from the Partner Selection Dialog. see “Selecting a Partner” on page 34. For this TPA field. Receiver Name of the trading partner that has the receiver role in the transaction the TPA will govern. see “Selecting a Partner” on page 34. a b Click the row containing the name of the TPA agreement that you want to duplicate... Sender Specify Name of the trading partner that has the sender role in the transaction the TPA will govern. For more information about how to select a receiver. This list includes your own profile (Enterprise). Type in the name of the receiver or click the Select.5 . Select Agreements Duplicate. Fill in the following fields on the Agreement Details screen for the TPA you want to create: Note: The Sender. You can use this function to create a template TPA. button to select the receiver from the Partner Selection Dialog.. This list includes your own profile (Enterprise).C H A P T E R 1 0 Tr a d i n g P a r t n e r A g r e e m e n t s ( T PA s ) Method to create a TPA New—The TPA fields are empty. to create a template that you will duplicate to create other TPAs. For EDI. Receiver.

The TPA data is used to govern the exchange of documents between the two partners. Trading Networks displays the data tree input values of the selected IS document type in the bottom panel of the Agreement Details screen. see “Information You Supply to Define a TPA” on page 178. see “Changing the TPA Data Inputs in the IS Document Type” on page 190. Receiver. The default value is zero (0). see “Information You Supply to Define a TPA” on page 178. Agreement ID Specify An identifier that indicates the type of agreement between the two partners. you can: create the TPA or continue to supply data for the remaining fields.5 183 .Defining a TPA For this TPA field. and Agreement ID values together uniquely identify a TPA.. Type in the name of the IS document type located on the server or click Find IS Document Type to browse the IS document types and select the one you want to use. webMethods Trading Networks User’s Guide Version 6. Data Status Whether you want to be able to modify the values of the TPA data of the IS document type. If you want to change the data input for the IS document type. Control Number A value that the application using the TPA expects. For more information about the IS document type. Note: You will not be able to continue creating a TPA unless you supply the Agreement ID.. This value is only needed if the application using the TPA uses the Control Number field. The Sender. After you supply the Agreement ID. The value you specify depends on the application that is going to use the TPA. IS Document Type The IS document type that defines the application-specific TPA data. The value for this field must be an integer. see “Changing a TPA Agreement Status” on page 188. For more information about the agreement ID. including spaces. The data status is only applicable when the agreement status is Agreed. You can use up to 254 characters of any type for this field. For more information about statuses.

see “Information You Supply to Define a TPA” on page 178. TN document types) out of the Trading Networks database. see the webMethods EDI Module User’s Guide. For more information about EDI TPAs. For more information about the initialization service. to browse the services and select the one Note: The Export Service is different from the Trading Networks File Export function that exports Trading Networks data (such as profiles. “Exporting and Importing Database Information”.5 . Initialization Service A service to populate the inputs to the variables in the IS document type for the TPA with default values.C H A P T E R 1 0 Tr a d i n g P a r t n e r A g r e e m e n t s ( T PA s ) For this TPA field.. webMethods recommends that you do not use the wm. so data can be exported/imported within the same Trading Networks release from development to production environment. This is optional. Type in the name of the export service located on the server or click Find Service you want to use.b2b. Instead. which is already tailored to a user’s particular requirements. For more information about exporting Trading Networks data to another Trading Networks system.TPA:EDITPA’ screen in the Trading Networks Console. Note: If you create a partner-defined EDITPA from scratch.editn. see Appendix A.b2b.tn..TPA:initService initialization service because it populates the partner-defined EDITPA with hard-coded values other than those in the default EDITPA. 184 webMethods Trading Networks User’s Guide Version 6. Type in the name of the initialization service located on the server or click Find Service to browse the services and select the one you want to use. see “Information You Supply to Define a TPA” on page 178. Export Service Specify A service to convert the data in the Trading Networks TPA to an industry-format trading partner agreement.edi. webMethods recommends that you manually complete each parameter field in the Input for ‘wm. For more information about the export service.

as well as the other TPA fields. Receiver. and Agreement ID fields. To view TPAs 1 2 3 Start the Trading Networks Console. To see detailed information about a specific TPA. Description Specify Optionally. If you need procedures for this step. Specify 1-1024 characters. Receiver. see “Starting the Trading Networks Console” on page 22.. If you clear any of the Sender. Receiver. 5 Click OK to create the TPA.. Managing TPAs The following table describes the tasks you can perform against TPAs: Task “Finding and Viewing TPAs” “Updating TPAs” “Changing a TPA Agreement Status” “Changing the TPA Data Inputs in the IS Document Type” “Deleting a TPA” See Page. You will not be able to save the TPA unless you supply the Sender. specify a description for the TPA in the Description field. Note: Trading Networks disables the OK button until you supply the Sender. and Agreement ID fields.. There is no restriction to the characters that you can use. double click on the row containing the TPA you want more detailed information about.5 185 . Trading Networks will disable the OK button. Trading Networks displays the Agreements Details screen.Managing TPAs For this TPA field.. Select View Agreements. webMethods Trading Networks User’s Guide Version 6. and Agreement ID fields during the creation of the TPA. 185 187 188 190 192 Finding and Viewing TPAs You can use the Agreements screen to find and view TPAs that you have defined.

. Do not use pattern-matching characters (such as “*”. Then fill out the corresponding information as follows. For this TPA Attribute… Sender Specify… The name of the trading partner that has the sender role for the TPA. Type in the name of the sender or click the Select. a b Select Show Query criteria. and Agreement ID fields must be unique for each TPA. For more information about the Select... or Agreed. you can use the search criteria on the Agreements screen to query for specific TPAs. Receiver.C H A P T E R 1 0 Tr a d i n g P a r t n e r A g r e e m e n t s ( T PA s ) 4 If you cannot find the TPA you are looking for. “Selecting a Partner” on page 34.and lowercase letters. Partner” on page 34. button to select the receiver from the Partner Selection Dialog.. “%”. Important! The search-criteria fields are space and character-sensitive.. see “Changing a TPA Agreement Status” on page 188.. For more information about statuses. button to select the sender from the Partner Selection Dialog. see The Agreement ID of the TPA that you want to view. The status of the agreement that you want to view: Proposed.. be sure to use the exact combination of upper. on the toolbar to have Trading Networks display the search To indicate that you want to use one or more of the search criteria. IS Document Type 186 webMethods Trading Networks User’s Guide Version 6. Disabled. For more information about the Select. button. Receiver The name of the trading partner that has the receiver role for the TPA. Type in the name of the IS document type located on the server or click Find IS Document Type to browse the IS document types and select the one you want to search for. Type in the name of the receiver or click the Select. select the checkbox next to each criterion you want to use. Agreement ID Agreement Status button. see “Selecting a Note: The Sender.. or “_”) in the TPA search.5 . The IS document type for the TPA data you want to use.

see the next section. Update the TPA fields you want to change: For information on what you can specify for the fields in the Agreement Details screen. webMethods Trading Networks User’s Guide Version 6. or click Select Date to open a dialog that allows you to select the date from a calendar. select Custom from the list. To specify a date range. Select Agreements Edit. If you need procedures for this step. see step 4 on page 182.Managing TPAs For this TPA Attribute… Timestamp Specify… The time Trading Networks last updated the TPA either when the TPA was created or last updated. see “Updating TPAs” on page 187. Trading Networks displays the Agreement Details screen. see “Information You Supply to Define a TPA” on page 178. To update a TPA 1 2 3 Select the TPA you want to update. Select an entry from the list. see “Finding and Viewing TPAs” on page 185. For more information about queries in Trading Networks. see “About Viewing and Querying Documents” on page 428 Updating TPAs Use the following procedure to update a TPA. You can type in a date value. For more information about the tabs and fields on this screen. see “Defining a TPA” on page 181. Trading Networks updates the Agreements table on the bottom portion of the screen with the query results.5 187 . Then specify dates in the Beginning and Ending fields. Double click to select the partner you want from query results in the Profiles table on the bottom portion of the screen. For procedures on how to change the information in your partner’s profile. For more information about the TPA attribute fields. For instructions on how to change the Agreement Status. “Changing a TPA Agreement Status”. c d Select Run Query on the toolbar.

For more information. For a production setting. When the TPA is in the Proposed status. when you are creating the TPA.C H A P T E R 1 0 Tr a d i n g P a r t n e r A g r e e m e n t s ( T PA s ) Important! You cannot modify or update the Sender. you cannot delete it. see “Deleting a TPA” on page 192. you can delete it. The following table explains what each status is and the changes you can make to the Agreement Status. Initially. as well as to speed up processing. or Agreement ID fields. the agreement status of the TPA might change depending upon business conditions.5 . Partner B would change the agreement status to Agreed. For more information. Changing a TPA Agreement Status The agreement status determines whether the TPA is a draft (Proposed status). Receiver. data values in the IS document type.g. What you can change: The TPA fields. then Partner B might change Partner A’s agreement status to Disabled . You can change the agreement status of the TPA to any other agreement status. For more information.. see “Changing the TPA Data Inputs in the IS Document Type” on page 190. After Partner A pays his payments. All inputs to TPA data variables in the IS document type. Agreed The TPA is in final status. Receiver. final (Agreed status). or whether the TPA is inactive (Disabled status). or Agreement ID field of a TPA. To delete a TPA. the agreement status. select the Agreed status to prevent the accidental deletion of the TPA. and to delete the agreement. 188 webMethods Trading Networks User’s Guide Version 6.so that no further transactions could occur. see “Deleting a TPA” on page 192. Agreement Status Proposed Meaning The TPA is in draft status. Partner A and Partner B) who sell products to one another. 4 For instructions on how to update the inputs for the IS document type. If Partner A is delinquent on payments to Partner B. When the TPA is in the Agreed status. assign the TPA the Proposed status so that you can make modifications to the TPA fields. For example. you must change the agreement status to Proposed or Disabled. with the exception of the Sender. however. in a transaction between two partners (e. see “Changing the TPA Data Inputs in the IS Document Type” on page 190. The agreement status to Disabled or Agreed. Select the Disabled status when you no longer want Trading Networks to use a specific TPA.

If you need procedures for this step. The TPA should not be used. To change a TPA agreement status 1 2 3 4 Start the Trading Networks Console. Click the row containing the TPA you want to change the agreement status for. you must change agreement status from Disabled to Proposed. see “Starting the Trading Networks Console” on page 22. What you can change: The Control Number Note: To modify the data of a TPA. Trading Networks displays the Agreements screen. see “Changing the TPA Data Inputs in the IS Document Type” on page 190 Disabled Use the following procedure to change a TPA agreement status. You can delete a disabled TPA. For more information. Non-modifiable.5 189 . For more information.Managing TPAs Agreement Status Meaning If the Data Status is: Modifiable. For more information. Select View Agreements. For more information. you can change: The Control Number All inputs to TPA data variables in the IS document type. see “Changing the TPA Data Inputs in the IS Document Type” on page 190. see “Changing the TPA Data Inputs in the IS Document Type” on page 190. see “Deleting a TPA” on page 192. you can change: The Control Number Note: To modify the data of the TPA. To change the agreement status: webMethods Trading Networks User’s Guide Version 6. you must change the agreement status from Agreed to Proposed.

Trading Networks displays the new status in the Agreement Status column. Update the TPA data input in the IS document type fields you want to change using one of the following three methods: Note: To access the TPA data inputs to change them. Use the following procedure to change the inputs for the IS document type. Changing the TPA Data Inputs in the IS Document Type The TPA data inputs are the inputs to variables of the IS document type. Use this method to have Trading Networks invoke the initialization service (if one was provided) to set the values of the TPA data input to their defaults. If you need procedures for this step. You can change the inputs by using the IS document type data input dialog buttons located on the right side of the IS document type root diagram: Set Inputs or Reset to Initialization Service. or Right-click and select from the menu items: Proposed. Disabled . Set Inputs for IS Document Type. For more information. Reset to Initialization Service.C H A P T E R 1 0 Tr a d i n g P a r t n e r A g r e e m e n t s ( T PA s ) Press the appropriate status change button: Proposed Agreed -OR- . 190 webMethods Trading Networks User’s Guide Version 6.5 . Use this method to supply the values you want the TPA data inputs to have. or Agreed. see “Changing a TPA Agreement Status” on page 188. Disabled. To change the data inputs in the IS document type 1 2 Select the TPA you want to update. you need to have the following values: 1) the Agreement Status is Proposed or 2) the Agreement Status is Agreed and the Data Status is Modifiable. see “Finding and Viewing TPAs” on page 185.

. When you click this icon. Change the values in the IS document type through the Input for <IS Document Type> dialog. Set Inputs To change the data input in the following manner. Note: The Reset to Initialization Service button is only enabled when an initialization service is supplied. For more information about changing IS Document Types. Trading Networks disables the Reset to Initialization Service button.. Trading Networks invokes the initialization service (if specified) to reset the TPA data inputs of the IS document type to their default values. you will lose any changes that you have made to the IS document type.5 191 . the dialog displays the parameters of the IS document type with the corresponding TPA data values automatically filled in. see the webMethods Developer User’s Guide. If you choose to reset these values. If this field is emptied.. webMethods Trading Networks User’s Guide Version 6. Reset to Initialization Service 3 Click OK to save your changes. You can modify the data values and then save them by selecting OK.Managing TPAs Click this IS document type data input button..

see “Finding and Viewing TPAs” on page 185. see “Deleting a Profile” on page 174. 192 webMethods Trading Networks User’s Guide Version 6. If you accidentally deleted the profile and not the TPA. For more information.5 . Important! Trading Networks does not provide a way to “undelete” the TPA. Trading Networks deletes all of the TPA data from its database. perform the following procedure: To delete a TPA 1 2 Select the TPA you want to delete.tpa:deleteTPA service. You can only delete TPAs with the Proposed or Disabled agreement status. you will need to use the wm. If you want to delete a TPA with an Agreed status. see the Programmer’s Reference Guide. To delete a TPA. If you need procedures for this step. you can delete the invalid TPA. Note: If you are deleting a non-modifiable agreement. For more information.C H A P T E R 1 0 Tr a d i n g P a r t n e r A g r e e m e n t s ( T PA s ) Deleting a TPA When you delete a TPA. You cannot delete TPAs with an Agreed status. click Yes.tn. Select Agreements Delete to delete the TPA. and then Trading Networks allows you to delete the TPA. When Trading Networks prompts you to verify that you want to delete the TPA. Important! Before you delete a profile that is referenced by a TPA. you will need to first change the agreement status to either Proposed or Disabled. you must first delete any related TPAs.

. . . . . .CHAPTER 11 Document Attributes What are Document Attributes? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 Managing Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 Defining Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . .5 193 . . . . . . . . . . . 198 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . .

you will specify which document attributes to include in each document type. Instructions for creating document types appear in Chapter 12. They include: System Attribute SenderID ReceiverID DocumentID UserStatus GroupID ConversationID Signature and SignedBody Description Identification of the trading partner that sent the document Identification of the trading partner that is to receive the document Identification of the document A status that you or a partner has associated with the document Identification within a document that associates this document with other documents in its group Identification within a document that associates this document with other documents in the same conversation of documents The portions of the document that contain a digital signature of the document and the signed data For more information about these system attributes. see “Important Attributes that You Should Extract from an XML Document” on page 210 or “Attributes To Extract From Documents” on page 285. and data type (DATETIME. description. that identify characteristics of the documents. “TN Flat File Document Types”. which identify specific pieces of information that you want to extract from the documents that your trading network will receive. you can specify whether Trading Networks should save the attribute to the database (the default behavior). or STRINGLIST). STRING. “TN XML Document Types” and Chapter 13. You do not need to define them. System attributes are available out of the box. NUMBER LIST. You should define custom document attributes for all types of documents that you expect to receive. known as system attributes. For example. To define a document attribute you specify the attribute’s name. if you want to extract the purchase order number from documents. when you define your TN document types. NUMBER. a document attribute is not associated with a specific document type.C H A P T E R 11 D o c u m e n t A t t r i b u t e s What are Document Attributes? There are two kinds of document attributes: Custom attributes. In addition. 194 webMethods Trading Networks User’s Guide Version 6.5 . Later. DATETIME LIST. Predefined attributes. and you cannot delete them. you might define a document attribute named PO_Number.

Document #2 <!-. . Document #3 <!-. Attributes PO_Number . . . The definition of a document attribute specifies the name. Different kinds of documents have different formats. The definition of a TN document type specifies how to locate the attributes in the specific type of document. . you can indicate whether you require the attribute to be extracted. Trading Networks always saves all system attributes except Signature and SignedBody.What are Document Attributes? Document Attributes and How They Relate to TN document types Document #1 <!-. you can specify that you want Trading Networks to save the document to the database. In addition. When you define a TN document type. If you mark an attribute as required and Trading Networks is unable to extract the attribute from the document.CBL --> <BuyerRefNum> <Reference> <RefNum> 100 </RefNum> </Reference> </BuyerRefNum> TN Document Type Name = CBL PO . For example. If you do this. Attributes PO_Number . type. . . In the TN document type (or in a processing rule). . . Attributes PO_Number .cXML --> <OrderRequestHeader orderID = P01234> . .5 195 . if you use an attribute webMethods Trading Networks User’s Guide Version 6. Trading Networks saves a custom attribute only if the TN document type or processing rule indicates to save that attribute. Trading Networks records the error. . . <POID>A230</POID> Document Attribute Name = PO_Number Type = Number Description = Purchase Order Number TN Document Type Name = cXML PO . and description for a document attribute. you specify the name of the attribute and how Trading Networks is to locate the attribute in the specific type of document. Trading Networks saves the custom attributes it extracts. To identify the attributes. you identify the attributes that you want Trading Networks to extract from the type of document. You can use document attributes to: Locate specific documents that have passed through your network by using the attributes as search criteria in document queries. Note: Regardless of whether you save custom attributes or not. . .OAG --> TN Document Type Name = OAG PO . . so the location of attributes within a document is based on the specific kind of document.

196 webMethods Trading Networks User’s Guide Version 6. For more information about document attributes. You can update any or all fields from the duplicated document attribute.5 . A copy of the document attribute screen appears. Click Duplicate . Procedure Click New (yellow highlight). Perform one of the following procedures to begin a document attribute definition. The New Document Attribute screen appears. Click the row containing the document attribute that you want to duplicate. Method to begin a definition New—The document attribute fields are empty. If you need procedures for this step. Generate reports about documents in your Trading Network. see “Starting the Trading Networks Console” on page 22. Select View Select Types Document Types.000.C H A P T E R 11 D o c u m e n t A t t r i b u t e s that retrieves the total order amount of a purchase order. Document Attributes. Duplicate—The document attribute fields are filled with values from the document attribute that you duplicate. "Setting up Trading Networks to Process Documents" in the webMethods Trading Networks Concepts Guide. you can query documents where the total order amount is over $10. see Chapter 3. Defining Document Attributes To define a document attribute 1 2 3 4 Start the Trading Networks Console.

webMethods Trading Networks User’s Guide Version 6. You can use any character except a single quote ('). STRING. If you do not select this checkbox and the pre-processing actions indicate to save attributes to the database. you might specify the description “The price of an item in a purchase order”. or STRINGLIST) from the list. Description Save 6 Click OK to add the document attribute. DATETIME LIST. You can specify 1 to 256 characters.5 197 . Type The data type of the attribute. Example: If you are defining an attribute for the price of an item in a purchase order. Select the data type (DATETIME. Enabled Whether this attribute is enabled or not. If you select this checkbox and the pre-processing actions indicate to save attributes to the database. Deselect this checkbox if the attribute value is needed during document processing. select this checkbox to enable it. You can specify 1 to 64 characters.. If the document attribute is disabled. NUMBER. you might use the name “LineItemPrice”. Name Specify The name you want to give to the attribute. For more information.Defining Document Attributes 5 Fill in the following fields for the custom attribute you want to add: For this parameter. NUMBER LIST. You can use any character except a single quote (').. see “Enabling Document Attributes” on page 200 or “Disabling Document Attributes” on page 199. A description of the attribute. Optional. Whether this attribute is eligible to be saved to the Trading Networks database. Example: If you are defining an attribute for the price of an item in a purchase order. Trading Networks saves this attribute to the database. Trading Networks does not save this attribute. but does not need to be kept in the database.

click Show All light bulbs) and disabled (darkened light bulbs) items.C H A P T E R 11 D o c u m e n t A t t r i b u t e s Managing Document Attributes The following table describes the tasks you can perform against document attributes: Task “Viewing Document Attributes” “Updating Document Attributes” “Disabling Document Attributes” “Enabling Document Attributes” “Determining the TN Document Types that Use an Attribute” See Page. you can update the display of attributes to include disabled document attributes. then perform the following additional step. 198 199 199 200 201 Viewing Document Attributes You can view document attributes using the Document Attributes screen. to show both enabled (yellow 198 webMethods Trading Networks User’s Guide Version 6. see “Starting the Trading Networks Console” on page 22. Displaying Disabled Document Attributes To display disabled document attributes. If you need procedures for this step. By default. To see the details about a specific document attribute. perform Steps 1 through 4 in the procedure “Viewing Document Attributes” that is described above. However.. To view document attributes 1 2 3 4 Start the Trading Networks Console.5 . Trading Networks does not display disabled document attributes. Select View Select Types Document Types. Document Attributes.. double click the row for that attribute. To display disabled document attributes To display disabled document attributes.

Disabling Document Attributes If you no longer want to use a document attribute. For information on what you can specify. Trading Networks does not display any disabled (darkened light bulbs) items. When you disable a document attribute. Updating Document Attributes To update a document attribute 1 2 3 4 5 6 Start the Trading Networks Console. Trading Networks will continue to extract the document attribute information for existing TN document types that reference this attribute. Update the fields you want to change. Select View Select Types Document Types. Click the row containing the document attribute that you want to update. see “Starting the Trading Networks Console” on page 22. Trading webMethods Trading Networks User’s Guide Version 6. you can disable it. Document Attributes. that is. perform the following step to hide them. However. Important! If this attribute is referenced by a TN document type that you imported into Business Integrator and is used in Business Integrator process models. it does not allow you to select a disabled attribute as an item to be extracted. do not change the name of the attribute. If you need procedures for this step. To hide disabled document attributes To hide disabled document attributes. 7 Click OK to save your changes.5 199 . You can change other settings for the attribute. You can use the attribute as search criteria for displaying documents on the Transaction Analysis screen. Right click and select Edit.Managing Document Attributes Hiding Disabled Document Attributes If disabled document attributes are currently being displayed on the Document Attributes screen. see step 5 on page 197. click Show Enabled to only show enabled (yellow light bulbs) items. Trading Networks prevents you from specifying the document attribute when creating new or updating existing TN document types.

If you need procedures for this step. you can enable it. When you remove a document attribute from the database. Trading Networks places No in the Enabled column to indicate that the document attribute is disabled. the definition for the document attribute is not removed from the database. Note: To permanently remove the document attribute from the database. If you need procedures for this step. Document Attributes. Document Attributes. 200 webMethods Trading Networks User’s Guide Version 6. you must first perform the procedure described in “Displaying Disabled Document Attributes” on page 198. Trading Networks places Yes in the Enabled column to indicate that the document attribute is enabled. See “Enabling Document Attributes” on page 200. see “Starting the Trading Networks Console” on page 22. To disable a document attribute 1 2 3 4 5 Start the Trading Networks Console.5 . Enabling Document Attributes If you disable a document attribute and then later determine that you still need it. Right click and select Enable. if you decide that you need the document attribute. see “Starting the Trading Networks Console” on page 22. Select View Select Types Document Types. you must also remove all TN document types that reference this attribute and all documents that had this attribute extracted from them. Later. When you disable a document attribute.C H A P T E R 11 D o c u m e n t A t t r i b u t e s Networks no longer displays the value of the attribute on the Transaction Analysis screen or the Document Detail screen. Select View Select Types Document Types. Right click and select Disable. your database administrator must remove it. you can enable it and make it available again. Click the row containing the document attribute you want to disable. Important! To perform this procedure. Click the row containing the document attribute you want to enable. To enable document attributes 1 2 3 4 5 Start the Trading Networks Console.

Click Show document type dependencies .Managing Document Attributes Determining the TN Document Types that Use an Attribute You can determine the TN document types that are dependent on a custom attribute. Document Attributes. Select View Select Types Document Types. for example. if you want to disable a document attribute but first want to determine the TN document types that this action will affect. 5 webMethods Trading Networks User’s Guide Version 6. Click the row containing the document attribute for which you want to view TN document type dependencies. That is. This is helpful. If you need procedures for this step. see “Starting the Trading Networks Console” on page 22.5 201 . To determine TN document types that are dependent on a custom attribute 1 2 3 4 Start the Trading Networks Console. you can select a custom attribute and have Trading Networks list the names of all TN document types that are defined to extract the custom attribute that you selected.

5 .C H A P T E R 11 D o c u m e n t A t t r i b u t e s 202 webMethods Trading Networks User’s Guide Version 6.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Namespace Mappings in TN XML Document Types . . .CHAPTER 12 TN XML Document Types What Are TN XML Document Types? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 Options in TN XML Document Types . . . . . . . . . . . . . . . . . . . 204 Identification Information in TN XML Document Types . . . . . . . . . . . 232 Managing TN XML Document Types . . . . . . . . . . . . . 206 Extraction Information In TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 Defining TN XML Document Types . . . . . .5 203 . . . . . . . .

Namespaces are used in an XML document to distinguish between elements that come from different sources. you can specify one or more of the following: Root tag that the XML document must have to match the TN XML document type. which is used to 204 webMethods Trading Networks User’s Guide Version 6. Pipeline variables that must be present when Trading Networks is determining the TN XML document type to use. To define TN XML document types. you should specify namespace mappings to describe the namespaces that XML documents might use. Trading Networks will gray out this unavailable selection. The pipeline variables that you specify must exist for Trading Networks to consider the TN XML document type a match. Trading Networks checks XML documents against the identification information to determine whether the document matches a defined TN XML document type.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s What Are TN XML Document Types? TN XML document types define how Trading Networks recognizes XML documents. Namespace mappings. A set of elements (or tags) from a specific source is assigned to a specific namespace. see “Extraction Information In TN XML Document Types” on page 210. For example. which are XQL queries that Trading Networks performs against the XML document to locate specific nodes in the XML document. and how to pre-process the XML documents. For Trading Networks to extract a value. Optionally. When you define the identification information for a TN XML document type. you can specify the value the pipeline variables must have. you specify the following types of information: Identification information. If the XML documents use namespaces. Identifying queries. Optionally. Each namespace is associated with a URI. in the extraction information. Optionally. see “Identification Information in TN XML Document Types” on page 206. Note: If you are using an OEM version of the Trading Networks. For more information. you might want Trading Networks to transform a STRING value into all uppercase characters. you can specify the value the node must have. For more information.5 . 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. Specifies the attributes (system attributes and custom attributes) that you want Trading Networks to extract from XML documents. the node that the XQL query identifies must exist in the XML document. you cannot create new TN document types in Trading Networks. where to locate attributes within an XML document. The nodes must be present for Trading Networks to consider the TN XML document type a match. You define XQL queries that Trading Networks uses to locate the attributes within the XML documents. Extraction information.

w3. “Large Document Handling”. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 227. see Chapter 5. For more information about XML namespaces.xml:bizdocToRecord service to convert the document content in the BizDocEnvelope to an IData object. For more information about Recognition and processing of XML documents. For more information. Pre-Processing actions are actions that Trading Networks performs before using the processing rule actions to process 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. see the XML Namespace specification at http://www. Trading Networks uses the namespace mappings for both the identifying XQL queries and the XQL queries to extract attributes. For more information. 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. 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. Trading Networks uses the IS document type if you invoke the wm. "Trading Networks Document Processing". Trading Networks uses the namespace mappings you specify when applying XQL queries against the XML document. Processing of large document types. Namespace mappings map the prefixes used by namespaces to the URIs used by those namespaces. A webMethods IS schema that defines the structure of the XML document. Whether you want Trading Networks to perform any or all of the pre-processing actions. webMethods Trading Networks User’s Guide Version 6.org/. When you define namespace mappings in a TN XML document type. Options. see Appendix C. You can use the options to define items for later processing.doc. see “Namespace Mappings in TN XML Document Types” on page 221.What Are TN XML Document Types? uniquely identify the namespace.5 205 . When specifying the options for an XML document.tn. That is. Note: You specify pre-processing actions in both TN XML document types and processing rules.

The value of the root tag within a document The system identifier or public identifier from the document type (DOCTYPE) declaration within an XML document. you must also define namespace mappings for Trading Networks to correctly locate the nodes identified by the XQL queries. For more information. To set up the identification information in a TN XML document type. Trading Networks matches documents against all enabled TN document types. specify one or more of the following items described in the table below: 206 webMethods Trading Networks User’s Guide Version 6. you can set up the TN XML document type to recognize OAG PROCESS_PO_004 documents. Trading Networks uses the extraction information and the options (which are specified in the TN XML document type) only if the document meets the criteria specified by the identification information. Trading Networks cannot determine which of the matching TN document types it should use.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Identification Information in TN XML Document Types Trading Networks checks documents against the identification information to determine whether the document matches a defined TN XML document type. you can set up the TN XML document type to recognize OAG PROCESS_PO_004 documents from a specific sender by specifying that the value of the <LOGICALID> tag within the <SENDER> tag must contain a certain sender's logical ID. see “Namespace Mappings in TN XML Document Types” on page 221. To be even more specific. If a document matches more than one. To be more specific. For example. Pipeline matching variables (name and value).5 . you can set up a TN XML document type that simply recognizes OAG documents. Note: If you are creating identifying queries or extracting information for a large document. see “Defining TN Document Type XQL Queries for Large Documents” on page 544. Each document that passes through your system should match exactly one TN document type. You can define TN XML document types to be very general or very specific. You can specify one or more of the following in the identification information: XQL queries (called identifying queries) that Trading Networks performs against an XML document to determine whether the document contains the nodes identified by the queries Important! If the documents you expect use equivalent namespaces but have different prefixes.

. if the tag you want to match in the document is <cXML> and your query specifies CXML. The following shows the query: /cXML[0]/Header[0]/Sender[0]/Credential[0]/Identity[0] The above query will match if the document contains the following: <cXML> <Header> <Sender> <Credential> <Identity>Industrial Steel Company</Identity> . Industrial Steel Company. Example: To identify a cXML order request. you might specify the following XQL query that assures the OrderRequest tag is in the document: /cXML[0]/Request[0]/OrderRequest[0] To be more specific. Then. you might set up the TN XML document type to match cXML OrderRequest from a specific sender. In addition. If you specify the value “Industrial Steel Company” and the actual value in the document is “IndustRIAL Steel COmpany”. specify the value that it must evaluate to.Identification Information in TN XML Document Types Item Identifying queries Description You can specify one or more XQL queries that locate a specific node in the XML document. the values will not match and the TN XML document type will not be used. if you specify a value for the query. the query will not find the node and the TN XML document type will not be used for the document. . you can optionally specify the value that the node must evaluate to match this TN XML document type. Caution: The XQL queries are case-sensitive. To do this.5 207 . for each identifying query. the value is also case-sensitive. you can add a second identifying query that identifies the Identity tag within the Credential tag that is within the Sender tag. For example. webMethods Trading Networks User’s Guide Version 6. In addition. for example.

Example: To identify a document that has a declared root tag value of cXML. Trading Networks returns specific values for the different data types (e. Note: If you do not include any identification information in a TN XML document type. Example: To identify a document that has the following DOCTYPE declaration.dtd for the value of DOCTYPE identifier: <!DOCTYPE cXML SYSTEM "cXML. Note: For custom attributes that are extracted from an XML document. DATETIMELIST. For more information. These identifiers are located in the document type declaration (DOCTYPE) after either the “SYSTEM” or “PUBLIC” literal string.dtd"> DOCTYPE identifier You can optionally specify the system identifier or public identifier within the XML document. STRING. 208 webMethods Trading Networks User’s Guide Version 6. Trading Networks does not use the TN XML document type. For example. Trading Networks checks to see that both exist in the pipeline. NUMBER. the document might contain the following document type declaration containing the declared root tag: <!DOCTYPE cXML SYSTEM "cXML. you would specify cXML. specify cXML. If you specify only the Name and no Value.g. then Trading Networks checks to see if the Name exists. the Value of the pipeline matching variable. For more information.dtd"> Pipeline Matching Variables You can optionally specify arbitrary pipeline variables for Trading Networks to use to identify the TN XML document type. Specify the Name and optionally. NUMBERLIST.5 . Root tag You can optionally specify the value of the root tag within the XML document that you want documents that match this TN XML document type to have.. see “Extracting Custom Attributes From XML Documents” on page 536. STRINGLIST. you must also define namespace mappings for Trading Networks to correctly locate the nodes identified by the XQL queries. and DATETIME).C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Item Description If the documents use namespaces. If you specify both the Name and the Value of the pipeline matching variable. see “Namespace Mappings in TN XML Document Types” on page 221.

Trading Networks also checks the identifying queries. You can set up processing rules that act on documents with an unknown TN document type. In this situation. Trading Networks cannot extract any information from the document because the TN document type is unknown. 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. the document is considered to be an unknown type. Trading Networks logs a message to the activity log that identifies all the TN document types that the document matched. For a document to match a TN XML document type. Because TN document types indicate what information to extract. Trading Networks looks at all enabled TN XML document type. When an XML Document Does Not Match Any TN Document Types If Trading Networks checks a document against all enabled TN document types and none match. Trading Networks does not extract any information from 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.Identification Information in TN XML Document Types Determining the TN Document Type to Use for an XML Document To determine the TN document type to use for an XML document. For example. Because the TN document type is unknown. webMethods Trading Networks User’s Guide Version 6. This is because Trading Networks does not know which of the matching TN document types to use. you might specify the following: Identifying Query = /cXML[0]/Request[0]/OrderRequest[0] Root tag = cXML An XML document matches this identification information if the tag identified by the identifying query (<OrderRequest>) exists within the document and evaluates to any value and the root tag contains the value cXML. For each TN XML document type.5 209 . Trading Networks first matches the Root tag and DOCTYPE identifier values in the TN XML document type to the XML document. to identify a cXML OrderRequest. You can set up processing rules that act on documents with an unknown TN document type. When an XML Document Matches More Than One TN Document Type If Trading Networks determines that the document matches multiple TN document types. If these match. all the identification criteria that you specify must match. the document is considered to be an unknown type.

Important Attributes that You Should Extract from an XML Document Important information you need to consider extracting are the system attributes: SenderID and ReceiverID—Use this information for processing rules. DocumentID—Extract the document ID from the document if you want Trading Networks to be able to check for a duplicate document. if you extract the document ID. If you do not want Trading Networks to pass the document to process management. For more information about creating process models. The sender and receiver are two of the criteria that Trading Networks uses to determine the processing rule to use for a document. add a variable to the pipeline called prtIgnoreDocument with the value of true. Processing Rules—Extract these system attributes to process a document based on the sender and receiver of the document. Trading Networks also allows you to perform built-in or custom transformations to extracted attributes. You define the actions taken against a document during process management by creating a process model. ConversationID—Extract this system attribute if you want Trading Networks to pass the document to process management after it performs the actions identified by processing rules. analyzing transactions. see “Defining TN Document Type XQL Queries for Large Documents” on page 544. see the webMethods Modeler User’s Guide. it uses the extraction information in the TN XML document type to determine the attributes that it needs to extract from the document. That is. If you are extracting information for a large document. you can refine the list of displayed documents on the Transaction Analysis screen by searching for documents with specific senders and receivers. 210 webMethods Trading Networks User’s Guide Version 6. You need to specify the attributes that identify the pieces of information within the document that you will want to use later. Process Management—Extract these system attributes to make the identity of the sender and receiver available during process management. In addition. You can then set conditions on links in your process models that use the identity of the sender and receiver of a document. see “Processing Rule Criteria” on page 317.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Extraction Information In TN XML Document Types When Trading Networks matches a document to a TN XML document type.5 . Transactions—If you extract these system attributes. if you want Trading Networks to be able to determine whether it has already received a document. and process management. you can refine the list of displayed documents on the Transaction Analysis screen by searching for documents with a specific document ID. For more information.

webMethods Trading Networks User’s Guide Version 6. The following shows an example of an XQL query to identify the ShippingMethod and portions of a CBL document that show what would be selected by the query.5 211 . to be able to query documents based on the total order amount of a purchase order. you should extract any custom attribute that you will want to use later. For example.Extraction Information In TN XML Document Types UserStatus—Extract the user status if the document contains a user status. you can refine the list of displayed documents on the Transaction Analysis screen by searching for documents with specific user statuses. you must specify an XQL query that instructs Trading Networks how to extract the attribute for the particular TN XML document type. For example. select an existing attribute (system or custom) from a list. you need to specify that you want the status from the document extracted. After specifying the attribute. For more information. see “Verifying the Digital Signature of an XML Document” on page 227. In addition. you can type the query or you can load a sample document to help you generate the queries. In addition to the system attributes. if you extract this system attribute. If the documents contain a status that you will want to use in reports. SignedBody and Signature—Extract these system attributes if you want Trading Networks to be able to verify the digital signature of a document. To specify an attribute that you want to extract. you need to specify that you want the total order amount extracted from the document. GroupID—Extract this system attribute if it is important for you to easily access the group ID of a document. The user status is a criterion that Trading Networks uses to determine the processing rule to use for a document. see “Processing Rule Criteria” on page 317. For more information. you might have an attribute named ShippingMethod. To specify the XQL query. and you want the user status to be available so you can process the document based on this user status.

You can use the following XQL query: /PurchaseOrder[0]/Transport[0]/@Direction To extract the ShippingMethod attribute specifically when the direction of the transport is “SupplierToBuyer”. . <Carrier>FedEx</Carrier> . </PurchaseOrder> The XQL query points to this tag. you must also define namespace mappings for Trading Networks to correctly locate the nodes identified by the XQL queries. see Appendix B. Trading Networks stores the value “FedEx” for the ShippingMethod attribute. For example. . . Important! If the XML documents you expect use equivalent namespaces but have different prefixes. Trading Networks cannot extract information for the attribute. If the query does not identify a node in the XML document. 212 webMethods Trading Networks User’s Guide Version 6.5 . . </Transport> .C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s XQL Query for ShippingMethod = /PurchaseOrder[0]/Transport[0]/Carrier[0] <PurchaseOrder> . the query will not find the node and Trading Networks will be unable to extract the information for the attribute. “XQL Reference”. . if the tag you want to match in the document is <Carrier> and your query specifies <CARRIER>. <Transport Direction = "SupplierToBuyer"> . . . use the following query: /PurchaseOrder[0]/Transport[@Direction 'eq' 'SupplierToBuyer']/Carrier[0] The XQL queries are case-sensitive. see “Namespace Mappings in TN XML Document Types” on page 221. Another attribute that you might want to extract from the above document is the direction of the transport. For more information. For examples of XQL queries. .

For more information. You can define your processing rules to use the error information that Trading Networks records when it is unable to extract required attributes: Use the processing rule’s document errors criterion to trigger a processing rule based on whether it contains errors. If Trading Networks completes processing without encountering any further errors. webMethods Trading Networks User’s Guide Version 6. NUMBER. For more information see “Action 1—Execute a Service” on page 330. you can indicate that an attribute is required. Note: If you do not mark an attribute as required. You might mark an attribute as required if you require the attribute information when processing the document or if you just want Trading Networks to indicate that it could not extract the attribute. and Trading Networks sets the processing status to DONE W/ ERRORS when it has completed processing the document. When you indicate that an attribute is required. For more information about the Execute an Integration Server processing actions. Trading Networks records the error in the bizdoc variable. Trading Networks returns specific values for the different data types (e.g. NUMBERLIST. This variable is in the pipeline and is available for your use when Trading Networks is processing the document.. see “Document Recognition Errors Criterion” on page 321. Indicating that Attributes are Required in TN XML Document Types When you define a TN XML document type. and DATETIME). When Trading Networks is unable to extract an attribute that you have marked as required.5 213 . it sets the processing status to DONE. see “Extracting Custom Attributes From XML Documents” on page 536. Trading Networks flags an error if it is unable to extract the document attribute. Trading Networks does not flag an error if it is unable to extract the attribute. DATETIMELIST. see “Action 1—Execute a Service” on page 330.Extraction Information In TN XML Document Types For custom attributes that are extracted from an XML document. STRING. STRINGLIST. Use the processing rule’s Execute a service processing action to inspect the bizdoc variable for the errors that Trading Networks encountered. For more information. You can require the system attributes Signed Body and Signature.

For example. or Sum. you might also need to specify transformation information for the attribute. Specify the format that is used for the date in the document. For more information.. specify Average for the detail. if the sender is identified in the document using a D-U-N-S number. The following table lists the attributes for which you can supply transform information and a description of the information that you can specify. see. Attribute SenderID or ReceiverID Transformation Specify the external ID type that is associated with the information in the document for the sender or receiver. specify the external ID type DUNS for the detail.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Transformation Information for Extracted Attributes of TN Document Types Based on an attribute. if the date is 2000/05/31. For example. “Specifying Built-in Transformation Information for SenderID and ReceiverID” on page 215 Attributes with the data type DATETIME and DATETIME LIST “Specifying Built-In Transformation Information for Attributes with the DATETIME and DATETIME LIST Data Type” on page 215 “Specifying Built-in Transformation Information for Attributes with the STRING or STRING LIST Data Type” on page 216 “Specifying Built-in Transformation Information for Attributes with the NUMBER Data Type” on page 218 Attributes with the data type STRING (other than SenderID or ReceiverID) and STRING LIST Attributes that represent an array of numbers Specify whether you want Trading Networks to alter the string value before storing the value. Maximum. You can write your own service to transform attributes. if you want Trading Networks to average the values in the array and store that for the attribute. how Trading Networks is to transform the value of that attribute based on built-in or custom transformations. i. All attributes “Specifying a Custom Transformation Service” on page 220 214 webMethods Trading Networks User’s Guide Version 6. For example.e. you would specify yyyy/MM/dd for the format.5 .. Specify the built-in transformation you want Trading Networks to take on the array of numbers: Average.. Minimum.

For example.text. . Trading Networks maintains a list of built-in common date/time formats from which you can select. To specify the date/time format. external ID type DUNS.Extraction Information In TN XML Document Types Specifying Built-in Transformation Information for SenderID and ReceiverID If you indicate that you want to extract the SenderID or ReceiverID system attributes from a document. For example. specify the XQL query to identify the location of the receiver information and select the external ID type DUNS for the transformation. If the external ID type used for the sender or receiver information within a document is not in the list or if you have agreed on a non-standard format with a trading partner. select the external ID type Mutually Defined from the list. Be sure to select an external ID type that your partners specify in their profiles. Trading Networks requires you to identify the date format. Specifying Built-In Transformation Information for Attributes with the DATETIME and DATETIME LIST Data Type If you specify an attribute that has the data type DATETIME or DATETIME LIST. Trading Networks stores the value “123456789” for the ReceiverID attribute and associates it with the . The XQL query points to this tag. if you specify you want the ReceiverID extracted from the XML document and the ReceiverID is identified in the document by a D-U-N-S number. XQL Query for ReceiverID = /PurchaseOrder[0]/OrderHeader[0]/DUNS[0] <PurchaseOrder> <OrderHeader> <CorpName>Industrial Steel Company</CorpName> <DUNS>123456789</DUNS> </OrderHeader> . webMethods Trading Networks User’s Guide Version 6. </PurchaseOrder> The Document Types screen that you use to create TN document types contains a list of the external ID types you can select. you need to specify how the sender or receiver is identified within the document. if you want the requested delivery date extracted from the following sample CBL document. if the date/time format you need to use is not in the list. you can type the format you need.5 215 .SimpleDateFormat class. specify the XQL query to identify the location of the RequestedDeliveryDate attribute and specify the date format yyyyMMdd'T'hh:mm:ss. use a pattern string based on the “Time Format Syntax” described for the java. However.

For example. Alternatively. For example. .. value “20000829T01:01:01” for the RequestedDeliveryDate </OrderHeader> attribute and uses the date format you specify to convert the .. If you do not specify transformation information for a string attribute. if the attribute value is “Purchase Order”.5 . Trading Networks saves the data exactly as it extracted it. You can have Trading Networks make a simple alteration to change the case of the extracted string values to all upper. The XQL query points to this tag. .Timestamp. Trading Networks uses the .C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s XQL Query for RequestedDeliveryDate = /PurchaseOrder[0]/OrderHeader[0]/RequestedDeliveryDate[0] <PurchaseOrder> <OrderHeader> <RequestedDeliveryDate>20000829T01:01:01</RequestedDeliveryDate> .. Uppercase Trading Network stores. If you specify this format. Lowercase 216 webMethods Trading Networks User’s Guide Version 6. date to a java. The extracted string attribute value in all uppercase. you can have Trading Networks use the extracted values as substitutions in a string that you supply. The following table describes each of the built-in transformation options you can use for string attributes..or all lowercase. Trading Networks stores “PURCHASE ORDER” for the attribute value. if the extracted attribute value is “Purchase Order”.sql. Trading Networks stores “purchase order” for the attribute value. </PurchaseOrder> Trading Networks extracts the value of the date and uses it and the pattern that you specify to decode the value and convert it to the format that Trading Networks requires to store the date in the database. . Specifying Built-in Transformation Information for Attributes with the STRING or STRING LIST Data Type For attributes (other than SenderID or ReceiverID) with the data type STRING or STRINGLIST. you can specify whether you want Trading Networks to alter the string value before storing. The extracted string attribute in all lowercase.

String Substitution Trading Network stores. the string that Trading Networks stores in the database for the attribute will not contain all the extracted values. you might specify the pattern Items Ordered: {0}.Extraction Information In TN XML Document Types If you specify this format. webMethods Trading Networks User’s Guide Version 6.g.MessageFormat class to substitute the extracted values into the pattern that you specify.text. the string that Trading Networks stores in the database for the attribute will contain the extra arguments (e. Belt clip. {2}. it will only contain the values for the number of arguments you specify in the pattern.. Rapid mobile charger If you place more arguments in the pattern than values that Trading Networks extracts. and specify an XQL query for the attribute that extracts the following array of values: 0 1 2 Cellular phone Belt clip Rapid mobile charger Trading Networks would store the following for the value of the attribute: Items Ordered: Cellular phone. If you specify less arguments in the pattern than values that Trading Networks extracts. {2})..g..5 217 .. For example.. {1}. {0}) you specify in the pattern. Trading Networks uses the java.. The pattern that you specify using the information that Trading Networks extracts to replace the arguments (e.

5]. if the array contains the numbers [2. For example.5.lang. If you want to redefine this parsing behavior. Trading Networks stores the value 3. For example. For example. Trading Networks stores the value 5. 3. if the array contains the numbers [2.Number. 3. 4. The sum of all the numbers in the array. 5]. The smallest number in the array. 218 webMethods Trading Networks User’s Guide Version 6.5 . For more information about custom transformations. 4. 3. Minimum Maximum Sum No format specified Note: When Trading Networks extracts a NUMBER or NUMBER LIST from a document. if the array contains the numbers [2. When the XQL query for an attribute identifies an array of numbers. 4. if the array contains the numbers [2. 5]. 3. 4. For example. The largest number in the array. it uses the number parsing behavior of java. For example. Trading Networks stores the value 2. 3. 5]. if the array contains the numbers [2. Trading Networks stores the value 2. 5]. Trading Networks interprets the value as “100”. you can write a custom attribute transformation. “Specifying a Custom Transformation Service”. if the NUMBER or NUMBER LIST contains the value “100zzz”. instead of throwing an error as it would if the value were “zzz100”. 4. see below. you can specify one of the following built-in formats to transform the array of numbers to a single value for Trading Networks to store: If you specify this format… Average Trading Networks stores… The average value of all the numbers in the array. For example. The first value of the array as the value of the attribute.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Specifying Built-in Transformation Information for Attributes with the NUMBER Data Type You can specify an attribute with NUMBER data type with an XQL query that identifies an array of numbers. Trading Networks stores the value 14.

To store the total number of items ordered in the attribute TotalItems. webMethods Trading Networks User’s Guide Version 6. XQL Query for TotalItems = /PurchaseOrder[0]/ListOfOrderDetail[0]/OrderDetail[]/BaseItemDetail[0]/Quantity[0]/Qty[0] <PurchaseOrder> .Extraction Information In TN XML Document Types The following sample CBL document shows two line items and the quantity to purchase of each. . . <Quantity> <Qty>10</Qty> </Quantity> . . . . The XQL query points to these tags. .5 219 . specify an XQL query that specifies an array of numbers that contains the quantity of each line item. Trading Networks uses the SUM format and stores the value 15 for the TotalItems attribute. </PurchaseOrder> This element of the query indicates to select all occurrences of <OrderDetail> tags. . . <Quantity> <Qty>5</Qty> </Quantity> . and specify the format SUM. . <ListOfOrderDetail> <OrderDetail> <BaseItemDetail> <LineItemNum>1</LineItemNum> . . . . <BaseItemDetail> </OrderDetail> <OrderDetail> <BaseItemDetail> <LineItemNum>2</LineItemNum> . <BaseItemDetail> </OrderDetail> <ListOfOrderDetail> .

use webMethods Developer.rec:DateAttributeTransformService specification.rec:StringAttributeTransformService specification. For more information about the inputs and outputs.5 . The service must implement the input and output variables that are defined in the wm.tn. Data type DATETIME or DATETIME LIST STRING or STRING LIST NUMBER or NUMBER LIST Specification you must use… The service must implement the input and output variables that are defined in the wm. Make sure that your custom transformation service can handle null values or empty strings.. For more information about these specifications. Optional arguments that you can define 220 webMethods Trading Networks User’s Guide Version 6. isArray arg Whether values contains a single value to transform or multiple values to transform. For an array data type (e.tn. The service must implement the input and output variables that are defined in the wm. The following table describes the specification you should use to create the custom transformation service based on the data type. Trading Networks passes the following input variables: Input Value values Meaning One or more values for your service to transform. see the webMethods Trading Networks Built-in Services Reference.g.tn. DATETIME LIST). The specifications are located in the WmTN package. any element in the values array can be null or an empty string. Setting Input and Output Values for Custom Transformation Services For custom transformation services.rec:NumberAttributeTransformService specification. To view these specifications. Note: The values may be null or an empty (zero length) string. see the section “Setting Input and Output Values for Custom Transformation Services” below.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Specifying a Custom Transformation Service Trading Networks allows you to create your own service to perform transformations on extracted attributes.

For example. It should store each as an item in the output variable newValues. To distinguish between the standard elements and the custom elements. the XML document might contain a namespace for the standard elements and another for the custom elements. A set of elements (or tags) from a specific source is assigned to a specific namespace.5 221 . meaning multiple values. XML Documents and Namespaces Namespaces are used in an XML document to distinguish between elements that come from different sources. This section provides information about namespaces. the input variable values will contain only a single item to transform. For example. you might want to include namespace mappings in your TN XML document types. newValues is a Date List of the transformed Strings. Namespace Mappings in TN XML Document Types If you receive XML documents that use namespaces. what namespace mappings are. your service should loop through the items in the values variable and transform each one. Your service should transform the single item and save just a single item in the output variable newValues. Trading Networks expects that you return the transforms values in the following output variable: Output Value newValues Meaning Transformation values of: Date List for DATETIME or DATETIME LIST String List for STRING or STRING LIST Number List for NUMBER or NUMBER LIST. a document might contain elements that are part of a standard and also custom elements. see the webMethods Developer User’s Guide.Namespace Mappings in TN XML Document Types As output. how namespaces affect XQL queries against XML documents. If the input variable isArray is true. webMethods Trading Networks User’s Guide Version 6. and how to set up namespace mappings. For information about creating the service. If the input variable isArray is false. if you are transforming string data.

The documents with a default namespace contain an xmlns attribute that specifies only the URI for a namespace.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s <order xmlns:standard="http://www.com/orderDocs"> <standard:buyer> <standard:DUNS>987654321</standard:DUNS> <standard:company>SMK Products</standard:company> <custom:contact>Mr.standards.org” 222 webMethods Trading Networks User’s Guide Version 6. For example. which defines a namespace.org" xmlns:custom="http://www. When an XML document uses a default namespace. a prefix associated with that namespace. The exception for naming elements in a namespace with a prefix is when the elements belong to the default namespace.5 . Elements are considered to be in the same namespace if they are all associated with the same URI. for example: xmlns=“http://www. which allows you to easily identify the elements that belong to a specific namespace. the elements in the default namespace do not use a prefix. Smith</custom:contact> <custom:customerNum>01031995</custom:customerNum> </standard:buyer> <standard:seller> <standard:DUNS>123456789</standard:DUNS> <standard:company>United Steel</standard:company> <custom:contact>Mr. if a document contains a namespace that is associated with the prefix string standard and the quantity element is in the standard namespace. It is used to uniquely identify the namespace. Each namespace is associated with a URI. The xmlns attribute specifies the URI for a namespace and optionally. When a namespace is associated with a string. the element is represented in the XML document as <standard:quantity>.unitedsteel. this string is used as a prefix when naming the elements in that namespace.standards. Note that the URI does not have to point to anything. Jones</custom:contact> </standard:seller> <standard:LineItem> <standard:LineItemNumber>1</standard:LineItemNumber> <standard:partNumber>C8C8C8</standard:partNumber> <standard:quantity>10</standard:quantity> <custom:description>bar steel</custom:description> </standard:LineItem> </order> This element is in the custom namespace The namespace is associated with a URI that uniquely identifies the The namespace is associated with a string that is used as a prefix in the names of elements The xmlns attribute defines a namespace This element is in the standard namespace XML documents that use namespaces contain the xmlns attribute.

Namespaces are the same if they identify the same URI. not all documents use the same prefix for the same namespace. To accommodate the different prefixes.org/” You have a trading partner that sends you documents. For example.standard. so that the queries find the elements of the XML document as expected. if necessary. identify the same namespace). the TN XML document type contains the following namespace mappings: webMethods Trading Networks User’s Guide Version 6. it can make the appropriate substitutions in the XQL queries. For example. When you create XQL queries to identify elements within the document. one document might use standard for a prefix and another might use CBL_standard. For example. As a result. if you execute the /Order[0]/standard:buyer XQL query against the document that uses the prefix CBL_standard. Namespace Mappings Namespace mappings map the prefixes used by namespaces to the URIs used by those namespaces. but the trading partner uses the following namespace: xmlns:CBL_standard=“http://www. for example. you define namespace mapping to identify all the prefixes that point to the same URI (in other words.org/” Note that the URIs are identical meaning it is the same namespace. the elements in that document might be prefixed with a string. the XQL queries include the prefix. if the above xmlns attributes are used in two different documents.5 223 .org/” As a result. if Trading Networks receives an XML document that contains a prefix that you have in the namespace mappings. you create your TN XML document type using a sample document that uses the following namespace: xmlns:standard=“http://www. identifying queries or queries that locate document attributes. the XQL query will fail. The solution to this problem is namespace mappings. the following xmlns attributes identify the same namespace: xmlns:standard=“http://www.org/” xmlns:CBL_standard=“http://www.standard. not the same prefix.standard. the XQL queries for elements within those documents are different: For example. the XQL query to identify the <standard:buyer> element in the XML document shown above is: /Order[0]/standard:buyer However.standard. however. the prefixes are different. In a TN XML document type.Namespace Mappings in TN XML Document Types How Namespaces Affect Identifying and Attribute XQL Queries If an XML document uses namespaces. the following XQL queries might represent the same elements: /Order[0]/standard:buyer /Order[0]/CBL_standard:buyer However. With this information.

224 webMethods Trading Networks User’s Guide Version 6.org/ http://www. Trading Networks will not match the document to the TN XML document type. if the TN XML document types use identifying queries.com/orderDocs"> <standard:buyer> <standard:DUNS>987654321</standard:DUNS> <standard:company>SMK Products</standard:company> <custom:contact>Mr. and Trading Networks will make the proper substitution for a document that uses the CBL_standard prefix rather than the standard prefix.standards.com/orderDocs"> <CBL_standard:buyer> <CBL_standard:DUNS>987654321</CBL_standard:DUNS> <CBL_standard:company>SMK Products</CBL_standard:company> <custom:contact>Mr. XQL query = /order[0]/standard:buyer <order xmlns:standard="http://www. With the namespace mapping.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Prefix standard CBL_standard URI http://www.org" xmlns:custom="http://www.standard. a TN XML document type definition can use the XQL query /Order[0]/standard:buyer.standards. As a result. the identifying XQL queries and the XQL queries that locate document attributes will fail.org/ With this namespace mapping. the following XQL query will locate the "buyer" element in either of the following documents.unitedsteel.org" xmlns:custom="http://www.5 . Smith</custom:contact> <custom:customerNum>01031995</custom:customerNum> </standard:buyer> </order> <order xmlns:CBL_standard="http://www.unitedsteel. If you do not define namespace mappings. those queries will fail and Trading Networks will not extract the attribute information.standard. Smith</custom:contact> <custom:customerNum>01031995</custom:customerNum> </CBL_standard:buyer> </order> The XQL query points to this element in this document The XQL query points to this element in this document Define namespace mappings for a TN XML document type if the XML documents that your trading partners send to Trading Networks use namespaces that are equivalent but have different prefixes. If the TN XML document type specifies XQL queries to locate and extract attribute information.

com To define a mapping for the default namespace (which does not use a prefix). Additionally. You can define more than one prefix to the same URI.xx.Namespace Mappings in TN XML Document Types To define namespace mappings.com http://www. When defining namespace mappings. use the literal string prefix0 for the prefix. you can have Trading Networks populate the namespace mappings table with the prefix and URIs from the xmlns attributes that define namespaces in the sample document.com http://www.yy. you should not use prefix0 as the prefix in any document. Sample Prefix aaa bbb ccc ddd URI http://www. it performs a literal match of the XQL queries against the document.ww. webMethods Trading Networks User’s Guide Version 6.com The URIs you list in the namespace mappings table do not have to be unique. you can define them manually. or if you are using a sample document. Prefix prefix0 URI http://www.com http://www.xx. keep the following guidelines in mind: Guideline Each prefix in the namespace mappings table for a TN XML document type must be unique.zz.5 225 . If Trading Networks receives a document that uses a prefix not defined in the namespace mappings table.xx.xx. be sure to include a mapping for each prefix/URI combination that you expect to receive in XML documents from your trading partners.xx.com Note: Because Trading Networks uses the literal prefix0 to identify the default namespace. Prefix aaa bbb ccc ddd URI http://www.com http://www.com http://www.yy.com http://www.

xml:bizdocToRecord built-in service.xml:bizdocToRecord built-in service against the document. 226 webMethods Trading Networks User’s Guide Version 6.tn. Save a copy of the document content.tn. This service transforms an XML document into an IS document (IData object) based on the blueprint defined by the specified IS document type.5 .doc. Specify an IS document type if you plan to execute the wm.. determine whether Trading Networks has already received the document. Specifying an IS Document Type for TN XML Document Types You can identify an IS document type that Trading Networks can use to format the documents identified by the TN XML document type. You can select one or more of the following preferences: Verify the digital signature of a document. that is. Use this option. it uses the options you specify. and/or log information to the database. see the webMethods Trading Networks Built-in Services Reference. webMethods IS Document Type webMethods schema to validate against Pre-Processing actions To. Validate the structure of a document using the IS schema that you specified for the webMethods schema to validate again option. Specify actions that you want Trading Networks to perform on documents identified by the TN XML document type before Trading Networks uses the processing rule actions to process the document. Check for duplicate document using built-in or custom services. Associate a webMethods IS schema with documents identified by the TN XML document type.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Options in TN XML Document Types When Trading Networks matches a document to a TN XML document type.. Associate a webMethods IS document type with documents identified by the TN XML document type. attributes.doc.. You identify the IS document type by specifying its fully qualified name. Trading Networks uses the IS schema to validate documents. The Document Types screen allows you to browse webMethods IS document types to locate the one you want to use. For more information about the wm..

Trading Networks cannot verify the digital signature. For more information about how Trading Networks verifies the digital signature. 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. see Appendix B. The signature that Trading Networks extracts must be a PKCS#7 detached signature of the signed body.Options in TN XML Document Types Specifying an IS Schema for TN XML Document Types You can identify an IS schema that maps the structure of the documents identified by the TN XML document type. You specify pre-processing actions in both TN document types and processing rules. the Document Types screen allows you to browse IS schemas to locate the one you want to use. For more webMethods Trading Networks User’s Guide Version 6. the processing actions can access the error information from the pipeline. Specifying Pre-Processing Actions for TN XML Document Type Trading Networks performs pre-processing actions before performing the processing actions defined by a processing rule. To verify that the document arrived unchanged. You can specify the following pre-processing actions for TN document types. “Specifying Pre-Processing Actions for TN XML Document Type” on page 227. This certificate on file with Trading Networks is the one identified in that partner’s profile on the Security tab. see below. Specify an IS schema if you want Trading Networks to be able to validate the structure of an XML document. Trading Networks performs the pre-processing actions in the following order. It also performs the processing actions that are defined in the processing rule. Trading Networks matches the certificate from the digital signature to the certificate that Trading Networks has in the Trading Networks database. the TN document type must instruct Trading Networks to extract the SignedBody and Signature system attributes. To use this pre-processing action. If the partner’s profile does not contain the certificates to use for verification. Verifying the Digital Signature of an XML Document Use the Verify Digital Signature pre-processing action to assure that the document Trading Networks receives has arrived unchanged and that the sender is who it claims to be. Regardless of whether Trading Networks determines the digital signature is valid. To verify that the sender is who it claims to be. "Security within Trading Networks" in the webMethods Trading Networks Concepts Guide. Trading Networks assures the signed body has not changed by verifying the digital signature. You identify the IS schema by specifying its fully qualified name. Verify sub-tab. it continues performing the rest of the pre-processing actions. If the digital signature is not valid. If you do not know the fully qualified name. For more information.5 227 .

228 webMethods Trading Networks User’s Guide Version 6. it continues performing the rest of the pre-processing actions. set the tn.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s information about the pipeline variables that are available to processing actions. the validation service can return many error messages. To validate the structure of the document. Checking for Duplicate of the XML Document Use the Check for Duplicate Document pre-processing action to have Trading Networks determine whether it has already received the document. Validating the Structure of an XML Document Use the Validate Structure pre-processing action to validate the structure of a document against an IS schema. If the document structure is not valid. For more information about the pipeline variables that are available to processing actions. If Trading Networks is instructed to use the Save Document to Database pre-processing action to save information about the document to the database. For more information about this service. Important! If the structure of a document is not valid. Trading Networks checks the document being processed against either built-in services or custom services. Trading Networks also logs the error to the activity log. specify the following: tn. the processing actions can access the error information from the pipeline. Trading Networks also logs the error to the activity log. To use this pre-processing action. To limit the number of error messages.max_errs=10 For more information. see the webMethods Integration Server Built-In Services.doc. It also performs the processing actions that are defined in the processing rule.doc. see “Trading Networks Configuration Properties” on page 42.max_errs property in the Trading Networks properties file. to limit the number of errors to ten.5 .validate. see “Action 1—Execute a Service” on page 330. You can also choose Do not check for duplicate document to have Trading Networks not to check against the documents it has in its database.validate.schema:validate built-in service. For example. If Trading Networks is instructed to use the Save Document to Database pre-processing action to save information about the document to the database. see “Action 1—Execute a Service” on page 330. you must specify an IS schema in the TN XML document type. Trading Networks assures that the XML document matches the structure identified by the IS schema using the pub. Regardless of whether the Trading Networks determines the document structure is valid.

You selected the Document ID. sender and document type—Trading Networks assures that it does not already have a document with the same document ID. sender and receiver—Trading Networks assures that it does not already have a document with the same document ID. you must instruct Trading Networks to extract the DocumentID and SenderID system attributes from the document. To check for a duplicate document using the document ID and sender you must instruct Trading Networks to extract the DocumentID and SenderID system attributes from the document. To check for a duplicate document using the document ID.5 229 . Trading Networks previously received a document and saved it to the database. Document ID. The following lists reasons Trading Networks might be unable to correctly determine whether a document is a duplicate: Trading Networks previously received a document that it did not save to the database and the same document is sent again. Built-in services—Use one of the following built-in duplicate checks: Document ID only—Trading Networks assures that it does not already have a document with the same document ID in its database. and ReceiverID system attributes from the document. and/or ReceiverID system attributes from the document. but did not extract the DocumentID. sender. sender and document type option and Trading Networks was unable to match the document to a TN document type.Options in TN XML Document Types You can have Trading Networks determine whether the document is a duplicate using a built-in or custom duplicate check service. Document ID and sender —Trading Networks assures that it does not already have a document with the same document ID and sender in its database. sender. see “Creating a Duplicate Document Check Service” on page 329. and receiver in its database. you must instruct Trading Networks to extract the DocumentID system attribute from the document. you must instruct Trading Networks to extract the DocumentID. SenderID. Document ID. To check for a duplicate document using the document ID. Note: There could be performance issues if you choose to use custom services for duplicate checking based on the logic in the service you select. and TN document type in its database. Custom services—Use a service that you create to determine whether a document is a duplicate. SenderID. To check for a duplicate document using the document ID and sender. and receiver. sender. For more information. webMethods Trading Networks User’s Guide Version 6.

you select whether Trading Networks is to save all documents (i. it has not determined whether the document has a duplicate. only unique documents. Trading Networks will bypass reliable delivery and invoke the specified delivery service once When you specify this pre-processing action. The following table displays the consequences of not saving specific options: 230 webMethods Trading Networks User’s Guide Version 6. Additionally. you must have Trading Networks save the document to the database. it is available for your use in processing actions that you define in the processing rule. If you do not have Trading Networks perform the Check for Duplicate Document pre-processing action. Certain delivery options require saving the document content to the database. “Checking for Duplicate of the XML Document”. save the document regardless of whether it is unique.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Trading Networks saves the results of the duplicate document check to the pipeline. even if there is a duplicate) or only if the document(s) is unique (i. see “Action 1—Execute a Service” on page 330.. for example.5 . As a result. see “Using Reliable Delivery with Immediate Delivery Method” on page 343 or “Using Reliable Delivery with Scheduled Delivery” on page 344.. you must specify the Check for Duplicate Document pre-processing action. Trading Networks uses the results of the duplicate document check in the Save Document to Database pre-processing action. If you do not select to save the document content and Trading Networks is to use a delivery option that requires document content to be saved. there is no duplicate). and/or log information to the database. if you want Trading Networks to use reliable delivery or scheduled delivery to deliver XML documents. attributes. In addition. For more information about the pipeline variables that are available to processing actions. see the previous section.e. For more information about the Check for Duplicate Document pre-processing action. if you want to deliver a document via a queue. Trading Networks maintains no information about this document after it processes the document. Trading Networks considers the document as having no duplicate and will save the unique document to the database.e. If you want Trading Networks to save document(s) to the database only if it is unique. or do not save the document to the database. In this situation. Saving an XML Document to the Database Use the Save Document to Database pre-processing action to instruct Trading Networks to save a copy of all documents. For more information. You can save a copy of the document(s) content. If you choose to not save the document.

and perform the process actions identified in that matching rule. Content Then the consequences of not saving are. webMethods Trading Networks User’s Guide Version 6. Trading Networks will not match processing rules that use extended criteria. Trading Networks will match to another processing rule...5 231 . You will not be able to view entries from the Activity Log screen.. You will not be able to view content from the Transaction Analysis screen (i. Trading Networks will be unable to locate documents for which you did not save the attributes. you can still use the processing rules extended criteria for the document. Trading Networks would not select that processing rule when reprocessing a document because the value of the Total Amount attribute would not be available and therefore would not match the extended criteria. Instead.e. because you cannot search on any documents that do not have these custom attributes saved. Activity Log You will not be able to view Activity Log entries from the Transaction Analysis screen (i. If you use the Transaction Analysis Custom search criteria. Trading Networks does not perform document recognition again and therefore does not re-extract the attributes. the Content tab will have no data). When Trading Networks resubmits a document. if you use extended criteria to select a processing rule when the value of the custom attribute Total Amount is greater than 10000. If you use the Deliver Document actions.. for example the default processing rule.e. Attribute You will not be able to view custom attributes from the Transaction Analysis screen (i. Trading Networks will not use reliable delivery. it performs document recognition and therefore extracts the attributes again.Options in TN XML Document Types If you do not save this option. For example. attributes will contain only information for system attributes). the Activity Log tab will have no data). You will not be able to resubmit or re-process the document...e. However. You might get different or unexpected results when you reprocess a document. Because the attributes are not saved when you reprocess the document. Note that you can still resubmit a document..

identifying queries that locate nodes that must be present in the document for the TN XML document type to be considered a match and queries that identify the location of attribute information that you want Trading Networks to extract from the document. Alternatively. you cannot create new TN document types in Trading Networks. 232 webMethods Trading Networks User’s Guide Version 6. Trading Networks passes documents on to project management if it extracted a conversation ID from the document. Trading Networks might have received a document for which there is no matching TN document type. Not using a sample document—When you do not use a sample document. To create a TN document type for that document. creating the XQL queries is simplified because you highlight the node in the sample document and Trading Networks forms the query for you. a document with an unknown TN document type. you can use a document that was sent to Trading Networks for processing and is in the Trading Networks database. that is.5 . When you create a TN XML document type. Note: If you are using an OEM version of the Trading Networks. Defining TN XML Document Types How you define TN XML document types depends on whether you have a sample document available when you create the TN document type. Using a sample document—When you use a sample document. For more information about process management. in other words. Trading Networks will gray out this unavailable selection. you specify XQL queries that locate specific nodes in the document. you need to know the required XQL queries and type them in yourself. you can use the document as the sample document when creating the TN document type. see the webMethods Modeler User’s Guide. For example. You can use a sample document that you have stored in your file system.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Note: Trading Networks always saves documents that it is to pass on to process management regardless of the setting of the Save Document to Database pre-processing action.

You can update any or all fields from the duplicated TN XML document type. see “Starting the Trading Networks Console” on page 22. select the XML document type category from the list.5 233 .Defining TN XML Document Types Using a Sample Document to Define a TN XML Document Type Use this procedure when you have a sample document available for defining a TN XML document type. Procedures when you have a sample document loaded 1) 2) 3) 4) Select View Select Types Document Types. and you load a sample document from the file system. and click Open. If you need procedures for this step. and click Open. and you load a sample document from the file system. 5) 6) In the Select File dialog box. Click Select Sample Document . Select Types Duplicate. Duplicate— The TN XML document type fields are filled with values from the TN XML document type that you duplicate. To define a TN XML document type using a sample document 1 2 Start the Trading Networks Console. Click the Identify tab. Perform one of the following procedures to start a new TN XML document type and load a sample document. click the Identify tab. webMethods Trading Networks User’s Guide Version 6. In the Document Types Details dialog box. 1) 2) 3) 4) 5) 6) Click the row containing the TN XML document type that you want to duplicate. browse your file system to locate the XML document that you want to use as a sample. Click Select Sample Document . see “Working with a Sample Document” on page 243. In the Select File dialog box. For a summary of actions you can take against a sample document. In the Create New DocType dialog box. browse your file system to locate the XML document that you want to use as a sample. New XML. Select View Document Types. Method to start a TN XML document type New— The TN XML document type fields are empty.

This field is required. Click the Identify tab. see Chapter 18. Procedures when you have a sample document loaded 1) Use the Transaction Analysis screen to display the sample document that you want to use. Select Transactions Create/Edit Document Type.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Method to start a TN XML document type From Saved Document—The TN XML document type fields are empty and the sample document from the Trading Networks database is loaded for you. click Show Source. type a description for the TN XML document type in the Description field. Perform one or more of the following procedures to specify information that indicates how Trading Networks is to identify documents. 234 webMethods Trading Networks User’s Guide Version 6. 2) 3) Note: Trading Networks displays a tree view of the XML document in the left side on the screen.5 . To view the document source. For details about specifying any of this information. “Managing and Tracking Documents”. If you need procedures for viewing documents on the Transaction Analysis screen. 3 4 5 Type the name you want to give the TN XML document type in the Name field. see “Identification Information in TN XML Document Types” on page 206. Click the row containing the document for which you want to create a TN XML document type. Optionally.

When you select a node. Maximum. STRING LIST. select the node that you want the identifying query to represent. Note: This “filled in” query is for a specific node in the XML document. Trading Networks fills in the Query field with the XQL query for the selected node and displays the value in the Value field. continue with Step 4. or NUMBER data types. Trading Networks displays the Add an identifying query dialog box. or NUMBERLIST data types. and Sum). you need to update the query so that it identifies an array of values.5 235 .Defining TN XML Document Types For this Identify tab parameter… Identifying Queries Use this procedure when using a sample document 1) In the sample document. If you want the TN XML document type to require the identifying query to evaluate to a different value. 3) Click OK. NUMBER (with Average. Trading Networks adds the identifying query to the list on the right. replace the current value in the Value field with the value you want the TN XML document type to use. “XQL Reference”. 2) Right click and select Add an identifying query. If you do not want the TN XML document type to require the identifying query to evaluate to a specific value. But. see Appendix B. For information about XQL queries. webMethods Trading Networks User’s Guide Version 6. Minimum. Trading Networks fills the Query field with the XQL query for the node that you selected and the Value field with the value of the node. clear the Value field. STRING. This node is applicable for DATETIME. if you want to use DATETIME LIST. If you want the TN XML document type to require the identifying query to evaluate to the value in the Value field.

Trading Networks populates the DOCTYPE Identifier field with the value it obtains from the document type declaration in the sample document. DOCTYPE Identifier 236 webMethods Trading Networks User’s Guide Version 6. To view (in the sample document) the node that a query represents. Click the Set button next to the DOCTYPE Identifier field. Trading Networks obtains the value that follows the SYSTEM or PUBLIC literal string in the document type declaration (DOCTYPE) in the sample document. click the row containing the identifying query.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s For this Identify tab parameter… Use this procedure when using a sample document 4) Repeat this procedure for each identifying query that you want to add. Note: If you add an identifying query and then decide you do not need it. then click Show node Root Tag . and then clicking Delete selected identifying query . Click the Set button next to the Root Tag field. you can remove it by clicking on the row containing the identifying query.5 . Trading Networks determines the root tag of the sample document and uses its value to populate the Root Tag field. If both literal strings exist. Trading Networks uses the value after the SYSTEM literal string.

Trading Networks checks to see that both exist in the pipeline. Repeat this procedure for each pipeline matching variable that you want to add. you must supply at least one identifying query. a value for the Root Tag field.5 237 . a b In the sample document. Perform the following procedure for each attribute that you want Trading Networks to extract from documents identified by this TN XML document type. or a pipeline matching variable. The value of the pipeline matching variable. select the node that represents the attribute that you want Trading Networks to extract. Trading Networks displays the Add an attribute dialog box. Note: If you do not specify any identification information in a TN document type. This field is optional. If you specify only the Name and no Value. Trading Networks does not use the TN document type. Right click and select Add an attribute. Trading Networks fills the Query field with the XQL query for the node that you selected. For details about what to specify for these fields. If you specify both the Name and the Value of the pipeline matching variable. a value for the DOCTYPE Identifier field.Defining TN XML Document Types For this Identify tab parameter… Pipeline Matching Use this procedure when using a sample document 1) 2) Click Add New Pipeline Match . Specify the following values in the Add Pipeline Matching dialog box. Trading Networks adds the pipeline matching variable to the list. Important! You must supply at least one criterion that Trading Networks is to use to recognize an XML document. see “Extraction Information In TN XML Document Types” on page 210. 6 Click the Extract tab. Name of the pipeline matching variable. that is. webMethods Trading Networks User’s Guide Version 6. Value. 3) 4) Click OK. then Trading Networks checks to see if the Name exists. Name.

and Sum). Use the Transformation option to specify how Trading Networks is to handle attribute data before storing it in the Trading Networks database. This node is applicable for DATETIME. or NUMBERLIST data types. STRING. 1 Built-in. if you want to use DATETIME LIST. see “Specifying Built-In Transformation Information for Attributes with the DATETIME and DATETIME LIST Data Type” on page 215. Minimum. see “Indicating that Attributes are Required in TN XML Document Types” on page 213. STRING LIST. select the name of the attribute from the list. Select one from the seven different built-in formats or type in your own. You must specify a date format. Has DATETIMEor DATETIME LIST data type Has STRING or STRING LIST data type (but not SenderID or ReceiverID) 238 webMethods Trading Networks User’s Guide Version 6. c d In the Name field. If you want Trading Networks to flag an error if it encounters an error attempting to extract this document attribute. Trading Networks fills in the Description and Type fields based on the document attribute definition. or NUMBER data types. For more information. select the Required check box. You can specify whether you want Trading Networks to alter the string value before storing it to UPPERCASE or LOWERCASE.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Note: This “filled in” query is for a specific node in the XML document. see “Specifying Built-in Transformation Information for SenderID and ReceiverID” on page 215. If the attribute data type is… Is SenderID or ReceiverID e For Transformation… You must specify an external ID type. see “Specifying Built-in Transformation Information for Attributes with the STRING or STRING LIST Data Type” on page 216. For more information. Select an existing built-in transformation provided by Trading Networks. For more information.5 . For more information. Maximum. see “Transformation Information for Extracted Attributes of TN Document Types” on page 214. For more information. NUMBER (with Average. you need to update the query so that it identifies an array of values. The data type of the attribute (shown in the Type field) determines the Built-in or Custom transformation options available. But.

Note: If you add an attribute and then decide you do not need it.5 239 . click the row containing the query. see “Specifying Built-in Transformation Information for Attributes with the NUMBER Data Type” on page 218. For more information. 2 Custom. Click on the Edit Service button. For more information. and then clicking Delete attribute . Click Set Inputs. To do this… Create a new custom transformation Select an existing custom transformation service Set the inputs of the transformation from the selected service Edit an existing service Perform this… Click New Service . Select or create your own service to perform custom transformations on extracted attributes. f Click OK to close the Add an attribute dialog box Important! If you do not extract the system attributes. Click Find Service to browse the IS namespace to locate the one you want to use.Defining TN XML Document Types If the attribute data type is… Has NUMBER data type and the XQL query identifies an array of numbers For Transformation… You should specify the operation that Trading Networks should perform on the numbers in the array. see “Specifying a Custom Transformation Service” on page 220. webMethods Trading Networks User’s Guide Version 6. To view (in the sample document) the node that a query represents. Trading Networks does not have this information available for processing rules or querying documents. then click Show node . you can remove it by clicking on the row containing the attribute.

click Find IS document type to browse webMethods IS document types to locate the one you want to use. For more information.5 . see “Specifying an IS Schema for TN XML Document Types” on page 227. click Set. For information specific to pre-processing actions. click the Namespaces tab and perform one of the following: To populate the namespace mapping table replacing any existing namespace information. Note: When you select a webMethods IS schema. For more information. If you do not know the fully-qualified name. For details about these fields. 240 webMethods Trading Networks User’s Guide Version 6. Trading Networks automatically sets the Validate Structure fields to indicate that you want to validate the structure of the document.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s 7 To define namespace mappings. When you click either Set or Append. click Append. 8 Click the Options tab and fill in the fields. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 227. Trading Networks populates the namespace table with the namespace information from all xmlns attributes in the sample document. see “Specifying an IS Document Type for TN XML Document Types” on page 226 webMethods schema to validate against The fully-qualified name of the IS schema. see “Options in TN XML Document Types” on page 226. For this Options tab parameter… Format an IS document type Specify… The fully-qualified name of the IS document type. For more information about namespaces. To add the namespace information to the current namespace mappings. click Find schema to browse webMethods IS schemas to locate the one you want to use. If you do not know the fully-qualified name. see “Namespace Mappings in TN XML Document Types” on page 221.

To select an existing duplicate check service. For more information about this pre-processing action. click Find Service to browse the IS namespace to locate the one you want to use and then click the Edit Service button if you want to modify the service. see “Checking for Duplicate of the XML Document” on page 228. see. Whether you want Trading Networks to Validate structure or Do not validate structure of the XML document. that is. Validate Structure pre-processing action Check for Duplicate Document pre-processing action Click New Service to create a new custom duplicate check service. Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule. For more information about this pre-processing action.Defining TN XML Document Types For this Options tab parameter… Verify Digital Signature pre-processing action Specify… Whether you want Trading Networks to Verify digital signature or Do not verify digital signature of a document. Trading Networks validates the structure of the XML document against the IS schema you specified in the webMethods schema to validate again option. “Creating a Duplicate Document Check Service” on page 329. see “Verifying the Digital Signature of an XML Document” on page 227. Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule. Note: There could be performance issues if you choose to use custom services for duplicate checking based on the logic in the service you select. Use custom service to check for duplicate document. For more information about how to create a custom duplicate checking service. webMethods Trading Networks User’s Guide Version 6. Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule. If you select to validate. Whether you want Trading Networks to Use built-in service to check for duplicate document. see “Validating the Structure of an XML Document” on page 228.5 241 . determine whether Trading Networks has already received the document. or Do not check for duplicate document. For more information about this pre-processing action.

select from the list whether you want Trading Networks the document’s content. attributes. and/or activity log information to the database. If you select to save documents to the database. 242 webMethods Trading Networks User’s Guide Version 6. see “Saving an XML Document to the Database” on page 230 Important! Keep in mind the pre-processing actions specified in the processing rules can override pre-processing actions specified in a TN document type.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s For this Options tab parameter… Save Document to Database preprocessing action Specify… Whether you want Trading Networks to Save all documents. For more information about this pre-processing action. Save only unique documents. or Do not save documents to the database.5 . For more information. 9 Click OK to create the TN XML document type. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 227. Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule.

then. Trading Networks also updates the Value field with the value of the selected XQL query. Trading Networks creates a new entry for the identifying query and fills in the Query and Value fields of the Add an identifying query dialog box with the XQL query for the selected node and the XQL query’s value. Select the identifying query for which you want to update the XQL query. Add an identifying query—Select a node in the XML document. Menu or Button Right-click menu— Identify Tab Description Right click in the sample document to display the right-click menu. Set DOCTYPE Identifier—Select this menu item to set the DOCTYPE Identifier field with the value from the document type declaration (DOCTYPE) in the sample document. webMethods Trading Networks User’s Guide Version 6. respectively. Right click and select this menu item. Trading Networks uses the value after the SYSTEM literal string.Defining TN XML Document Types Working with a Sample Document The following table provides a summary of the actions you can take against a sample document. Trading Networks uses the value that follows the SYSTEM or PUBLIC literal string in the document type declaration. select the node in the sample document that represents the new query you want to use. Then. Set Root Tag—Select this menu item to set the value of the Root Tag field with the value of the root tag in the sample document. If both literal strings exist.5 243 . Edit selected identifying query—Use to update the XQL query for an identifying query. select this menu item to add a new identifying query to the TN document type. Trading Networks opens the Edit selected identifying query dialog box and replaces the XQL query in the Query field with the XQL query for the selected node.

Trading Networks appends the namespace information that it obtains from the sample document to the existing namespace mappings in the table. Select the attribute for which you want to update the XQL query. When you select Set Namespace Mapping. select the node in the sample document that represents the new query you want to use. Append Namespace Mappings—Select this menu item to populate the namespace mappings table with the namespace information from all xmlns attributes in the sample document. select this menu item to add a new attribute that you want Trading Networks to extract.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Menu or Button Right-click menu— Extract Tab Description Right click in the sample document to display the right-click menu. Right click and select this menu item. Edit Attribute—Use to update the XQL query that identifies where to locate the attribute information. Add an Attribute—Select a node in the XML document. Append— Namespaces tab Use the Append button to populate the namespace mappings table with the namespace information from all xmlns attributes in the sample document. Trading Networks deletes any existing namespace mappings from the table and replaces them with the namespace information that it obtains from the sample document. Trading Networks opens the Edit Attribute dialog box and replaces the XQL query in the Query field with the XQL query for the selected node. Trading Networks creates a new entry for the attribute and fills in the Query field in the Add an Attribute dialog box with the XQL query for the selected node. Trading Networks appends the namespace information that it obtains from the sample document to the existing namespace mappings in the table. then. When you select Append Namespace Mappings. Set Namespace Mapping—Select this menu item to populate the namespace mappings table with the namespace information from all xmlns attributes in the sample document. Then. 244 webMethods Trading Networks User’s Guide Version 6.5 . Right-click menu— Namespaces Tab Right click in the sample document to display the right-click menu.

When you click this button.5 245 . click the Set button next to the Root Tag field To set the DOCTYPE Identifier field with the value from the document type declaration (DOCTYPE) in the sample document. Trading Networks deletes any existing namespace mappings from the table and replaces them with the namespace information that it obtains from the sample document.. Trading Networks evaluates the XQL query you typed in the Query field and displays the value of that query (retrieved from the sample document) in the Value field... Trading Networks uses the value after the SYSTEM literal string. Example: The following sample document is loaded: Test Query—all tabs If XQL query points to this node. Set—Namespaces Tab Use the Set button to populate the namespace mappings table with the namespace information from all xmlns attributes in the sample document.. click the Set button next to the DOCTYPE Identifier field. Trading Networks uses the value that follows the SYSTEM or PUBLIC literal string in the document type declaration. Use this button to test an XQL query that you have typed in the Query field of the Document Type screen. To set the Root Tag field with the value of the root tag in the sample document. If both literal strings exist.Defining TN XML Document Types Menu or Button Set—Identify Tab Description Use the Set buttons to set the Root Tag and/or DOCTYPE Identifier fields with values from the sample document. . Trading Networks displays it’s value webMethods Trading Networks User’s Guide Version 6.

When you click this button. click . On the Identify tab. then.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Menu or Button Description Type the following query in the Query field and click Test Query: Trading Networks updates the Value field to contain the value for TotalLineNum. When on the Extract tab. Trading Networks opens a new window that contains the document source. select an attribute. click .5 . which is 1. select an identifying query. Show Source—all tabs Use this button to display the source of the XML document. Trading Networks highlights (in the sample document) the node that the XQL query for the identifying query represents. (Show Node)— Identify and Extract tabs 246 webMethods Trading Networks User’s Guide Version 6. Click to have Trading Networks highlight the node in the sample document that an XQL query for an identifying query or attribute represents. Trading Networks highlights (in the sample document) the node that Trading Networks would extract for the attribute (based on the query defined for the attribute). then.

select the XML document type category from the list. Procedures when you do not have a sample document loaded 1) 2) 3) 1) 2) 3) Select View Select Types Document Types. webMethods Trading Networks User’s Guide Version 6. see “Identification Information in TN XML Document Types” on page 206. and you load a sample document from the file system. Perform one of the following procedures to start a new TN XML document type. Duplicate— The TN XML document type fields are filled with values from the TN XML document type that you duplicate. If you need procedures for this step. You can update any or all fields from the duplicated TN XML document type. type the name you want to give the TN XML document type. see the Getting Started with Trading Networks manual. 3 4 5 In the Name field. type a description for the TN XML document type in the Description field. Method to start a TN XML document type New— The TN XML document type fields are empty. To define a TN XML document type when you do not have a sample document 1 2 Start the Trading Networks Console. Select Types Duplicate. Perform one or more of the following procedures to specify information that indicates how Trading Networks is to identify documents. Select View Document Types. This field is required. Click the row containing the TN XML document type that you want to duplicate. In the Create New DocType dialog box. For details about specifying any of this information. Optionally. use the following procedure to define a TN XML document type.Defining TN XML Document Types Defining a TN XML Document Type without a Sample Document If you do not have a sample document available. Click the Identify tab.5 247 . New.

If you want the TN XML document type to require the identifying query to evaluate to a specific value.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s For this Identify tab parameter… Identifying Queries Use this procedure when not using a sample document 1) 2) Click Add an identifying query . Type the value of the root tag from within the XML documents that this TN XML document type is to match. “XQL Reference”. Trading Networks displays the Add an identifying query dialog box. Type the value of the system identifier or public identifier from the document type declaration (DOCTYPE) within the XML documents that this TN XML document type is to match. In the Query field. you can remove it by clicking on the row containing the identifying query. type that value in the Value field.5 . 248 webMethods Trading Networks User’s Guide Version 6. For information about XQL queries. Repeat this procedure for each identifying query that you want to add. see Appendix B. and then clicking Deleting an identifying query Root Tag DOCTYPE Identifier . type an XQL query that represents a node in a document that must exist for this TN XML document type to be used for a document. Click OK. 3) 4) 5) Note: If you add an identifying query and then decide you do not need it.

If you specify both the Name and the Value of the pipeline matching variable. . 6 Click the Extract tab. If you want Trading Networks to flag an error if it encounters an error attempting to extract this document attribute. select the name of the attribute from the list. a value for the DOCTYPE Identifier field. Repeat this procedure for each pipeline matching variable that you want to add. Name. This field is optional. type an XQL query that identifies the location of the attribute within an XML document. For information about XQL queries. 3) 4) Click OK. see “Extraction Information In TN XML Document Types” on page 210. a value for the Root Tag field. or a pipeline matching variable. you must supply at least one identifying query. In the Query field. Specify the following values in the Add Pipeline Matching dialog box. Perform the following procedure for each attribute that you want Trading Networks to extract from documents identified by this TN XML document type.Defining TN XML Document Types For this Identify tab parameter… Pipeline Matching Use this procedure when not using a sample document 1) 2) Click Add New Pipeline Match . “XQL Reference”. a b c Click Add an attribute box. Value. For details about what to specify for these fields. Important! You must supply at least one criterion that Trading Networks is to use to recognize an XML document. then Trading Networks checks to see if the Name exists. For more information. see Appendix B. The value of the pipeline matching variable. that is. see “Indicating that Attributes are Required in TN XML Document Types” on page 213. select the Required check box. Trading Networks fills in the Type and Description fields based on the document attribute definition. d webMethods Trading Networks User’s Guide Version 6.5 249 . Name of the pipeline matching variable. Trading Networks displays the Add an attribute dialog In the Name field. If you specify only the Name and no Value. Trading Networks checks to see that both exist in the pipeline. Trading Networks adds the pipeline matching variable to the list.

5 . use the Transformation option to specify how Trading Networks is to handle attribute data before storing it in the Trading Networks database. Has STRING or STRING LIST data type (but not SenderID or ReceiverID) Has NUMBER data type and the XQL query identifies an array of numbers 250 webMethods Trading Networks User’s Guide Version 6. You should specify the operation that Trading Networks should perform on the numbers in the array. see “Transformation Information for Extracted Attributes of TN Document Types” on page 214. 1 Built-in.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s e If necessary. Select one from the seven different built-in formats or type in your own. For more information. Important! If you do not extract the system attributes. see “Specifying Built-In Transformation Information for Attributes with the DATETIME and DATETIME LIST Data Type” on page 215. see “Specifying Built-in Transformation Information for Attributes with the NUMBER Data Type” on page 218. If the attribute data type is… Is SenderID or ReceiverID Has DATETIMEor DATETIME LIST data type For Transformation… You must specify an external ID type. see “Specifying Built-in Transformation Information for SenderID and ReceiverID” on page 215. You can specify whether you want Trading Networks to alter the string value before storing it to UPPERCASE or LOWERCASE. see “Specifying Builtin Transformation Information for Attributes with the STRING or STRING LIST Data Type” on page 216. You must specify a date format. Select an existing built-in transformation provided by Trading Networks. For more information. For more information. Trading Networks does not have this information available for processing rules or querying documents. For more information. For more information. The data type of the attribute (shown in the Type field) determines the Built-in or Custom transformation options available.

specify prefix0. type the prefix for the namespace. a In the Namespace Mappings section of the screen on the right. Perform the following for each namespace mapping you want to add to the table. type the URI for the namespace. For more information. In the Namespace Prefix column. Select or create your own service to perform custom transformations on extracted attributes.5 251 . click Add a namespace mapping b c . Note: If you add an attribute and then decide you do not need it. In the URI Mapping column. you can remove it by clicking on the row containing the attribute. Click on the Edit Service button. For more information about namespaces. see “Specifying a Custom Transformation Service” on page 220. . If you are adding a mapping for the default namespace. Trading Networks adds a row to the namespace mappings table. and then clicking Delete an attribute 7 . webMethods Trading Networks User’s Guide Version 6. Click Find Service to browse the IS namespace to locate the one you want to use. To define namespace mappings. see “Namespace Mappings in TN XML Document Types” on page 221. Important! If you do not extract the system attributes. click the Namespaces tab. Trading Networks does not have this information available for processing rules or querying documents. To do this… Create a new custom transformation Select an existing custom transformation service Set the inputs of the transformation from the selected service Edit an existing service Perform this… Click New Service . Click Set Inputs.Defining TN XML Document Types 2 Custom.

If you need to edit a namespace mapping. Trading Networks automatically sets the Validate Structure fields to indicate that you want to validate the structure of the document. For this Options tab parameter… Format an IS document type Specify… The fully-qualified name of the IS document type. simply type over the existing information. see “Options in TN XML Document Types” on page 226. If you do not know the fully-qualified name. For more information. see “Specifying an IS Schema for TN XML Document Types” on page 227. 252 webMethods Trading Networks User’s Guide Version 6. see “Specifying an IS Document Type for TN XML Document Types” on page 226 webMethods schema to validate against The fully-qualified name of the IS schema. For more information.5 . 8 Click the Options tab and fill in the fields. Note: When you select a webMethods IS schema. For details about these fields. For information about pre-processing actions.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Note: If you add a namespace mapping and then decide you do not need it. If you do not know the fully-qualified name. you can remove it by clicking on the row containing the namespace mapping. click Find IS document type to browse webMethods IS document types to locate the one you want to use. click Find schema to browse webMethods IS schemas to locate the one you want to use. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 227. and then clicking Delete selected namespace mapping .

determine whether Trading Networks has already received the document. see “Verifying the Digital Signature of an XML Document” on page 227. Use custom service to check for duplicate document. To select an existing duplicate check service. that is. Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule. see “Checking for Duplicate of the XML Document” on page 228.5 253 .Defining TN XML Document Types For this Options tab parameter… Verify Digital Signature pre-processing action Specify… Whether you want Trading Networks to Verify digital signature or Do not verify digital signature of a document. or Do not check for duplicate document. see. select from the list whether you want Trading Networks the document’s content. attributes. If you select to save documents to the database. For more information about how to create a custom duplicate checking service. For more information about this pre-processing action. Save only unique documents. Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule. For more information about this pre-processing action. webMethods Trading Networks User’s Guide Version 6. Click New Service to create a new custom duplicate check service. Whether you want Trading Networks to Use built-in service to check for duplicate document. click Find Service to browse the IS namespace to locate the one you want to use and then click the Edit Service button if you want to modify the service. or Do not save documents to the database. “Creating a Duplicate Document Check Service” on page 329 Check for Duplicate Document pre-processing action Save Document to Database preprocessing action Whether you want Trading Networks to Save all documents. Note: There could be performance issues if you choose to use custom services for duplicate checking based on the logic in the service you select. and/or activity log information to the database. Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule.

Managing TN XML Document Types The following table describes the tasks you can perform against TN XML document types: Task “Viewing TN XML Document Types” “Updating TN XML Document Types” “Using a Sample Document when Updating a TN XML Document Type” “Updating a TN XML Document Type without a Sample Document” “Disabling TN XML Document Types” “Enabling TN XML Document Types” “Testing TN XML Document Types” See page.5 .. Trading Networks will bypass reliable delivery and invoke the specified delivery service once. see “Saving an XML Document to the Database” on page 230.. 255 255 255 261 266 267 268 254 webMethods Trading Networks User’s Guide Version 6. For more information.g. Important! Keep in mind the pre-processing actions specified in the processing rules can override pre-processing actions specified in a TN document type. see “Pre-Processing Actions” on page 327. if you want to deliver a document via a queue).C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s For this Options tab parameter… Specify… If you do not select to save the document content and Trading Networks is to use a delivery option that requires document content to be saved (e.. 9 Click OK to create the TN XML document type. For more information about this pre-processing action.

do not change the name of the type. Using a Sample Document when Updating a TN XML Document Type To update a TN XML document type when you have a sample document available. To view TN XML document types 1 2 3 Start the Trading Networks Console. If you need procedures for this step. By default. select Types Show All. However.Managing TN XML Document Types Viewing TN XML Document Types You can view TN XML document types using the Document Types screen. 4 Updating TN XML Document Types As when you define TN XML document types. Trading Networks displays both the TN XML document types and TN flat file document types. Select View Document Types. If you need procedures for this step. To hide disabled TN document types. you can update the display of TN document types to include disabled TN document types. You can change other settings for the attribute. perform the following procedure. see “Starting the Trading Networks Console” on page 22. select Types Show All again. Trading Networks places a check ( ) next to the Show All menu item to indicate that Trading Networks is currently displaying disabled TN document types. Trading Networks removes the check ( ) next to the Show All menu item to indicate that Trading Networks is currently not displaying disabled TN document types. To update a TN XML document type when a sample document is available 1 2 Start the Trading Networks Console. the procedures you use to update a document differ based on whether you have a sample document available when you create the TN document type. webMethods Trading Networks User’s Guide Version 6.5 255 . Trading Networks displays both the TN XML document types and TN flat file document types. Important! If you imported a TN XML document type into Business Integrator to use in Business Integrator process models. Select View Document Types. see “Starting the Trading Networks Console” on page 22. To view disabled TN document types. Trading Networks does not display disabled TN document types.

Use the table below to find the procedure to update the selected tab. “Information on the Partner’s Corporate Tab” on page 132 “Information on the Partner’s Contact Tab” on page 136 “Information on the Partner’s Delivery Method Tab” on page 137 “Information on the Partner’s Extended Fields Tab” on page 143 “Information on the Partner’s Security Tab” on page 144 256 webMethods Trading Networks User’s Guide Version 6. see. browse your file system to locate the XML document that you want to use as a sample.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s 3 Click the row containing information about the TN XML document type that you want to update... For a summary of actions you can take against a sample document. and click Open.. Click Select Sample Document . Perform the following to load the sample document: a b c Click the Identify tab. Go to step 4 on page 147 Go to step 5 on page 151 Go to step 6 on page 153 Go to step 9 on page 159 Go to step 10 on page 160 For more information. Select Types Edit.. Corporate Contact Delivery Method Extended Fields Security Use this procedure. type a new description in the Description field.. see “Working with a Sample Document” on page 243. 7 To update an existing partner profile. To update this tab.5 . Trading Networks displays the Document Type Details dialog for the selected TN XML document type.. 4 5 6 To update the description. select the tab you wish to update. In the Select File dialog box.

But. on the Profile screen. you need to update the query so that it identifies an array of values. For details about specifying any of this information. Right click and select Add an identifying query. or NUMBER data types. or NUMBERLIST data types. see “Identification Information in TN XML Document Types” on page 206. assure that value is in the Value field. Add an entry Edit an entry Delete an entry 8 To update identification information. Note: This “filled in” query is for a specific node in the XML document. click the Identify tab. and Sum). Click OK to close the Add an identifying query dialog box. Minimum. This node is applicable for DATETIME. otherwise. if you want to use DATETIME LIST. Maximum. use the following buttons to supply information to the profile fields: Use this button To.. Trading Networks opens the Add an identifying query dialog box and populates the Query field with the XQL query for the selected node. STRING. If you want the TN document type to require the identifying query to evaluate to a specific value. STRING LIST. select the node that you want the identifying query to represent.5 257 . see Appendix B. NUMBER (with Average. These procedures are the same ones you initially used to create a partner profile. In general.Managing TN XML Document Types Follow the procedures to update the partner profile.. “XQL Reference” webMethods Trading Networks User’s Guide Version 6. clear the Value field. For information about XQL queries. To update this Identify tab parameter … Identifying Queries or Use these procedures when you have a sample document loaded… To add an identifying query—In the sample document.

click the Set button next to the DOCTYPE Identifier field. 258 webMethods Trading Networks User’s Guide Version 6. specify the Name and optionally. DOCTYPE Identifier To update the DOCTYPE Identifier field with the value from the sample document. clear the DOCTYPE Identifier field. Pipeline Matching To add a pipeline matching variable—Click Add New Pipeline Match . click the Set button next to the Root Tag field. click the row containing the pipeline matching variable you want to update and click Edit Selected Pipeline Match . Click OK to save the variable and close the dialog box. To delete an identifying query from the TN document type—Select the row for the identifying query and click Delete selected identifying query Root Tag To update the Root Tag field with the value from the sample document. Trading Networks opens the Edit selected identifying query dialog box and updates the Query field with the XQL query for the selected node and the Value field with the XQL query’s value. Click OK to close the Edit selected identifying query dialog box. In the Add Pipeline Matching dialog box. In the Update Pipeline Matching dialog box. the Value for the pipeline matching variable. clear the Root Tag field.5 . To remove the value from the Root Tag field. Right click and select Edit selected identifying query. select the node that you want the identifying query to represent. To remove the value from the DOCTYPE Identifier field. To update a pipeline matching variable.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s To update this Identify tab parameter … Use these procedures when you have a sample document loaded… To update an identifying query—In the sample document. update the Name and Value fields for that variable. Click OK to save your updates and close the Update Pipeline Matching dialog box.

see . or NUMBER data types. STRING LIST. c d webMethods Trading Networks User’s Guide Version 6. select the name of the attribute from the list. STRING. Important! The TN XML document type must include at least one criterion that Trading Networks can use to recognize a document. To add an attribute—In the sample document.5 259 . click the row containing the pipeline matching variable you want to delete and click Remove Selected Pipeline Match For more information. If necessary. you need to update the query so that it identifies an array of values. NUMBER (with Average. Minimum. Right click and select Add an attribute. The data type of the attribute (shown in the Type field) determines the Built-in or Custom transformation options available. a value for the DOCTYPE Identifier field. that is. see “Indicating that Attributes are Required in TN XML Document Types” on page 213. But. 9 To update extraction information. Trading Networks opens the Add an attribute dialog box and populates the Query field with the XQL query for the selected node. and Sum). a value for the Root Tag field. Maximum. or a pipeline matching variable. This node is applicable for DATETIME. If you want Trading Networks to flag an error if it encounters an error attempting to extract this document attribute.Managing TN XML Document Types To update this Identify tab parameter … Use these procedures when you have a sample document loaded… To delete a pipeline matching variable. if you want to use DATETIME LIST. Note: This “filled in” query is for a specific node in the XML document. For more information. For information about how to specify information on this tab. Fill in the rest of the Add an attribute dialog box by performing the following: a b In the Name field. at least one identifying query. click the Extract tab. or NUMBERLIST data types. select the Required check box. use the Transformation option to specify how Trading Networks is to handle attribute data before storing it in the Trading Networks database. see “Extraction Information In TN XML Document Types” on page 210. select the node that represents the attribute that you want Trading Networks to extract.

You should specify the operation that Trading Networks should perform on the numbers in the array.5 . For more information. Has DATETIMEor DATETIME LIST data type Has STRING or STRING LIST data type (but not SenderID or ReceiverID) Has NUMBER data type and the XQL query identifies an array of numbers Custom transformation. Click Find Service to browse the IS namespace to locate the one you want to use. see “Specifying BuiltIn Transformation Information for Attributes with the DATETIME and DATETIME LIST Data Type” on page 215. For more information. To do this… Create a new custom transformation Select an existing custom transformation service Perform this… Click New Service . Trading Networks does not have this information available for processing rules or querying documents. Select or create your own service to perform custom transformations on extracted attributes. You must specify a date format. You can specify whether you want Trading Networks to alter the string value before storing it to UPPERCASE or LOWERCASE. For more information.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Important! If you do not extract the system attributes. see “Specifying Built-in Transformation Information for SenderID and ReceiverID” on page 215. Built-in transformation. Select an existing built-in transformation provided by Trading Networks: If the attribute data type is… Is SenderID or ReceiverID For Transformation… You must specify an external ID type. For more information. For more information. see “Specifying Builtin Transformation Information for Attributes with the NUMBER Data Type” on page 218. see “Specifying a Custom Transformation Service” on page 220. 260 webMethods Trading Networks User’s Guide Version 6. Select one from the seven different built-in formats or type in your own. see “Specifying Built-in Transformation Information for Attributes with the STRING or STRING LIST Data Type” on page 216.

To update a namespace mapping—Type over the existing information in the namespace mappings table. Click OK to close the Edit Attribute dialog box. Trading Networks closes the screen. see “Namespace Mappings in TN XML Document Types” on page 221. select the node that represents the attribute that you want Trading Networks to extract. To delete a namespace mapping—Select the row for the namespace mapping and click Delete selected namespace mapping . 10 To update namespace mappings. For information about how to specify information on this tab. For information about namespaces. click OK. Right click and select Edit Attribute. Click on the Edit Service button.Managing TN XML Document Types To do this… Set the inputs of the transformation from the selected service Edit an existing service e Perform this… Click Set Inputs. To replace existing namespace mappings with namespace information from the sample document—Click Set. 11 To update options. Click OK to close the Add an attribute dialog box. To update information for an existing attribute—In the sample document. click the Namespaces tab. To delete an attribute from the TN document type—Select the row for the attribute and click Delete selected attribute . 12 After you have made all your changes. Trading Networks adds the namespace information from all xmlns attributes in the sample document to the namespace mappings table. Updating a TN XML Document Type without a Sample Document To update a TN XML document type when you do not have a sample document available. perform the following procedure.5 261 . click the Options tab. Trading Networks opens the Edit Attribute dialog box and updates the Query field with the XQL query for the selected node. To update a TN XML document type without a sample document webMethods Trading Networks User’s Guide Version 6. To append namespace information from the sample document to the existing namespace mappings—Click Append. Trading Networks deletes the existing namespace mappings (if any) and populates the namespace mappings table with the namespace information from all xmlns attributes in the sample document. see step 8 on page 240. For information about what you can specify. see above for the description for adding an attribute.

If you need procedures for this step. NUMBER (with Average. if you want to use DATETIME LIST. 262 webMethods Trading Networks User’s Guide Version 6. Select View Document Types. In the Query field. Click OK to close the Add an identifying query dialog box. Trading Networks displays the Add an identifying query dialog box. Minimum. To update identification information. Maximum. type an XQL query that represents a node in a document that must exist for this TN document type to be used for a document. Select Types Edit. see “Identification Information in TN XML Document Types” on page 206. Click the row containing information about the TN XML document type that you want to update. or NUMBER data types. To update this Identify tab parameter … Identifying Queries Use these procedures when you do not have a sample document… To add an identifying query—Click . click the Identify tab.5 . This node is applicable for DATETIME. see “Starting the Trading Networks Console” on page 22. For details about specifying any of this information. If you want the TN document type to require that the identifying query evaluate to a specific value. or NUMBERLIST data types. Trading Networks displays both the TN XML document types and TN flat file document types.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s 1 2 3 4 5 6 Start the Trading Networks Console. and Sum). But. To update the description. you need to update the query so that it identifies an array of values. Note: This “filled in” query is for a specific node in the XML document. type a new description in the Description field. STRING. STRING LIST. type that value in the Value field.

Root Tag To update the Root Tag field. see Appendix B. webMethods Trading Networks User’s Guide Version 6. To update information for an existing identifying query—Select the row for the identifying query and click Edit selected identifying query . type the value of the root tag from within the XML documents that this TN document type is to match. Update the Query and/or Value fields. To remove the value from the DOCTYPE Identifier field. To remove the value from the Root Tag field.5 263 . clear the DOCTYPE Identifier field. DOCTYPE Identifier To update the DOCTYPE Identifier field.Managing TN XML Document Types To update this Identify tab parameter … Use these procedures when you do not have a sample document… For information about XQL queries. clear the Root Tag field. To delete an identifying query from the TN document type—Select the row for the identifying query and click Delete selected identifying query . Click OK to close the Edit selected identifying query dialog box. click the Set button next to the DOCTYPE identifier field. “XQL Reference”. Trading Networks displays the Edit selected identifying query dialog box.

To add an attribute—Click . select the name of the attribute from the list. Trading Networks displays the Add an attribute dialog box. In the Update Pipeline Matching dialog box. a value for the DOCTYPE Identifier field. For more information. To delete a pipeline matching variable—Click the row containing the pipeline matching variable you want to delete and click Remove Selected Pipeline Match . If you want Trading Networks to flag an error if it encounters an error attempting to extract this document attribute. For information about how to specify information on this tab. specify the Name and optionally. update the Name and optionally. 264 webMethods Trading Networks User’s Guide Version 6. see “Extraction Information In TN XML Document Types” on page 210. a value for the Root Tag field. To update the description. or a pipeline matching variable. see “Indicating that Attributes are Required in TN XML Document Types” on page 213. type a description in the Description field. at least one identifying query. Click OK to save your updates and close the Update Selected Pipeline Match dialog box. 7 To update extraction information. To update a pipeline matching variable—Click the row containing the pipeline matching variable you want to update and click Edit Selected Pipeline Match . In the Add Pipeline Matching dialog box.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s To update this Identify tab parameter … Pipeline Matching Use these procedures when you do not have a sample document… To add a pipeline matching variable—Click Add New Pipeline Match . Click OK to save the variable and close the dialog box. select the Required check box. Important! The TN document type must include at least one criterion that Trading Networks is to use to recognize an XML document. the Value for the pipeline matching variable. click the Extract tab. that is.5 . Fill in the Add an attribute dialog box by performing the following: 1 2 3 In the Name field. the Value fields for that variable.

see “Specifying Built-in Transformation Information for Attributes with the STRING or STRING LIST Data Type” on page 216. Trading Networks displays the Edit Attribute dialog box. see “Specifying Built-In Transformation Information for Attributes with the DATETIME and DATETIME LIST Data Type” on page 215. For more information. To delete an attribute from the TN document type—Select the row for the attribute and click Delete selected attribute . You can specify whether you want Trading Networks to alter the string value before storing it. type an XQL query that identifies the location of the attribute within an XML document. Update the fields to make the changes you want. For more information. see above for the description for adding an attribute. For information about what you can specify. see “Specifying Built-in Transformation Information for Attributes with the NUMBER Data Type” on page 218. use the Detail field to specify how Trading Networks is to handle attribute data before storing it in the Trading Networks database. For more information. specify… You must specify an external ID type.Managing TN XML Document Types 4 In the Query field. 5 . To update information for an existing attribute—Select the row for the attribute and click Edit selected attribute . see “Specifying Built-in Transformation Information for SenderID and ReceiverID” on page 215. For information about XQL queries. webMethods Trading Networks User’s Guide Version 6. If necessary. Select one from the seven different built-in formats or type in your own. Has DATETIME data type Has STRING data type (but not SenderID or ReceiverID) Has NUMBER and the XQL query identifies an array of numbers 6 Click OK to close the Add an attribute dialog box. Click OK to close the Edit Attribute dialog box. If the attribute… Is SenderID or ReceiverID For Detail. see Appendix B. You should specify the operation that Trading Networks should perform on the numbers in the array. “XQL Reference”. For more information.5 265 . You must specify a date format.

Namespace Prefix URI Mapping Specify The prefix for the namespace. To add a namespace mapping—Click namespace mappings table. if you decide that you need the TN document type. To delete a namespace mapping—Select the row for the namespace mapping and click Delete selected namespace mapping 9 . See “Enabling TN XML Document Types” on page 267. you can disable it. your database administrator must remove it. Trading Networks closes the screen. click OK. If you are adding a mapping for the default namespace. you can enable it.5 . you must also remove all documents that are associated with the TN document type. For information about namespaces. Later. . When you remove a TN document type from the database. click the Options tab. click the Namespaces tab..C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s 8 To update namespace mappings. Trading Networks adds a row to the To update a namespace mapping—Type over the existing information in the namespace mappings table. When you disable a TN XML document type.. Disabling TN XML Document Types If you are not using a TN XML document type and no longer want Trading Networks to use it to recognize documents. For information about how to specify information on this tab. specify prefix0. The URI for the namespace. see “Namespace Mappings in TN XML Document Types” on page 221. In this column. 266 webMethods Trading Networks User’s Guide Version 6. see step 8 on page 240. the definition for the TN document type is not removed from the database. To update options. 10 After you have made all your changes. Note: To permanently remove the TN document type from the database.

Trading Networks places No in the Enabled column to indicate that the TN XML document type is disabled. Select View Document Types. see “Starting the Trading Networks Console” on page 22. you must first display inactive TN document types as described in “Viewing TN XML Document Types” on page 255. select Document Types Show All. Important! To enable TN document types.Managing TN XML Document Types To disable a TN XML document type 1 2 3 4 Start the Trading Networks Console. Enabling TN XML Document Types If you disable a TN XML document type and then later determine that you still need it. see “Starting the Trading Networks Console” on page 22.5 267 . If you need procedures for this step. Trading Networks places Yes in the Enabled column to indicate that the TN XML document type is enabled webMethods Trading Networks User’s Guide Version 6. Click the row containing information about the TN XML document type that you want to update. Select Types Enable. Select Types Disable. If you need procedures for this step. Select View Document Types. you can enable it and make it available again. Click the row containing information about the TN XML document type that you want to update. To enable a TN XML document type 1 2 3 4 Start the Trading Networks Console. Note: To view the Enabled column (if it is not currently displayed).

you select the sample document. To perform a test. you should add a TN XML document type to identify the document or update an existing TN document type to identify the document.C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s Testing TN XML Document Types You can test your TN XML document types to determine the TN document types that match a specified document. That is. To test the TN XML document types. Trading Networks does not actually process the document. Documents that match more than one defined TN XML document type. Important! During the test. If your testing finds a document that matches multiple TN document types (also called an ambiguous document). the TN XML document types are set up correctly for this type of document. This type of document would be an unknown TN document type because Trading Networks cannot determine which of the matching TN XML document types to use. Note that Trading Networks does not test the sample document against disabled TN document types. Trading Networks highlights all matching TN XML document types on the Document Types screen. This type of document would be an unknown TN document type if processed by your system. you can test each to determine whether your Trading Networks system will receive: Documents that match exactly one defined TN XML document type. you should update TN document types so that the document matches exactly one TN XML document type. In this situation. If you have samples of all the types of documents that your Trading Networks system will process. If your testing finds a document that does not match any defined TN XML document type. 268 webMethods Trading Networks User’s Guide Version 6. Trading Networks uses the identification information in all TN XML document types to determine all TN document types that match the specified document.5 . This means the Trading Networks does not highlight the disabled TN document types that the document would match. Documents that do not match any of your defined XML TN XML document types. you must have sample documents available in your file system. Trading Networks does not perform any pre-processing or processing actions on the document.

or no TN document types. select the sample document you want to use for the test and click Open. To test TN XML document types 1 2 3 4 Start the Trading Networks Console. webMethods Trading Networks User’s Guide Version 6. Test. see “Starting the Trading Networks Console” on page 22. If you need procedures for this step. From the Select Input Document dialog box. Trading Networks highlights all the TN document types that the sample document matches and displays a message informing you whether the document matched a single TN XML document type. Trading Networks displays the Select Input Document dialog box. multiple TN document types. Select View Select Types Document Types.Managing TN XML Document Types Perform the following procedure to test your TN XML document types for a specified document.5 269 .

5 .C H A P T E R 1 2 T N X M L D o c u m e n t Ty p e s 270 webMethods Trading Networks User’s Guide Version 6.

. . . . . . . . . . . . . . . . 306 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 Defining Document Gateway Services . . . . . . . . . .5 271 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .CHAPTER 13 TN Flat File Document Types Overview . . . . . . . . . . . . 283 Defining TN Flat File Document Types . . . . . . . . 300 Managing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276 TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

flat file data is externalized as a set of records (a list of records containing fields and composites) without any structural information. Whether to perform pre-processing actions (such as validating the data structure and checking for duplicate documents) before executing a processing rule. To provide this information.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s Overview Flat file documents present data in a record-based storage format. In addition to creating a document gateway service. you can transform certain types of attribute data before Trading Networks stores it in the database. In a TN flat file document type you specify: Values of variables within the TN_parms pipeline variable that Trading Networks uses to match the document type to the incoming flat file document. Optional system variables. A document gateway service is the entry point for flat files into Trading Networks. the gateway service passes control to Trading Networks for processing. you create a document gateway service and a corresponding TN flat file document type for each type of document you expect to receive. for example SenderID and ReceiverID in the TN_parms/SenderID and TN_parms/ReceiverID. that is. a document that does not contain metadata. For example. The service should define values for: System attributes.5 . After supplying the values needed in the TN_parms pipeline variable. you might define the document type to match when the TN_parms/Department variable has a value of Billing and the TN_parms/Service_code variable has a value of XYZ. the application receiving the flat file must have knowledge of the flat file’s structure to read its content. Trading Networks’ definition of a flat file is any file or document with a format that is non-describing. In addition. Custom attributes (the document data). your service defines values in a pipeline variable named TN_parms. It is a Java or flow service that you create to provide information to Trading Networks about a flat file. The system and custom attribute values to extract. To provide this structural knowledge. flat files do not have structural information embedded within the data. In other words. you define a corresponding TN flat file document type that Trading Networks will use when it receives the document from the gateway service. Trading Networks will retrieve the flat file information from the TN_parms pipeline variable. respectively. using built-in or custom transformations. for example variables that specify the content type and content encoding you want Trading Networks to use for the document. You can only extract values for the attributes that the gateway service has placed in the TN_parms pipeline variable. Unlike XML files. Because the records are not structured in a flat file document. 272 webMethods Trading Networks User’s Guide Version 6.

Trading Networks tries to identify the type of the document. suppose you defined a document type named Acme_XYZ_Invoices to receive all documents from Acme’s Billing department with the service code XYZ. but that document type does not exist 4 After finding a single matching document type. A BizDocEnvelope represents a routable Trading Networks transaction. For example. which is placed in the pipeline as a variable named bizdoc. Trading Networks adds the extracted attributes to the BizDocEnvelope. it examines the contents of the pipeline variable TN_parms. sending the flat file document to the service as an input stream.5 273 . and searches the pipeline matching key/value pairs in all your enabled TN flat file document types. It webMethods Trading Networks User’s Guide Version 6. Trading Networks logs a recognition error if any of the following conditions are met: The data in the TN_parms pipeline variable does not match the pipeline matching criteria in any document type The data in the TN_parms pipeline variable matches the pipeline matching criteria in multiple document types The data in the TN_parms pipeline variable explicitly identifies the document type to use. (You could have omitted the Service_code value if you wanted to receive Billing department documents with any service code.Overview Run-Time Processing of Flat File Documents Trading Networks processes a flat file document as follows. 1 2 Your trading partner’s client application invokes a specific document gateway service. trying to find a matching document type for the document. and then passes control to Trading Networks for further processing.) Tip! Rather than having Trading Networks search all of your TN flat file document types to find a match. To do this. Doing this eliminates the overhead of that search. You would have defined the following pipeline matching criteria: Key Department Service_code Value Billing XYZ 3 A document would match this document type only if it contains both of those pipeline variables (within TN_parms) and the variables have the specified values. you can explicitly specify in the gateway service the document type to use for processing the document. The document gateway service places information about the flat file into the TN_parms pipeline variable.

such as calculations. If you want Trading Networks to log an error when it cannot extract particular attribute values. Trading Networks can transform the extracted attribute values before storing them into the BizDocEnvelope. is optional. see Chapter 14. Trading Networks places the extracted attribute values into the BizDocEnvelope. it completes processing (assuming it finds no errors) and sets the processing status to DONE. suppose your trading network expects to receive a document whose TN_parms will contain the following attributes: Attribute TN_parms/SenderID TN_parms/ReceiverID TN_parms/DocumentID TN_parms/Department TN_parms/Service_code TN_parms/Invoice_number TN_parms/Amount Value [some value] [some value] [some value] Billing XYZ 123 1000. To extract attribute values. For details. transaction analysis. and more. and Trading Networks adds additional information that it uses for routing and processing. SenderID and ReceiverID are system attributes that Trading Networks always requires in TN_parms. You extract system attribute values if you want to use them as criteria for determining the processing rule to use for a document.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s contains the flat file document. using the optional built-in or custom transformations that you specified. Trading Networks completes processing. process management. Trading Networks looks for the values within the TN_parms pipeline variable. Continuing with the example document type Acme_XYZ_Invoices. such as DocumentID. 5 Trading Networks extracts all system and custom attributes that you defined in the TN flat file document type. You can extract document data to perform any processing you want. 6 Trading Networks performs a processing rule lookup to determine the processing rule to use for the incoming flat file document. it will not log an error. logs the error to the activity log. By default if Trading Networks cannot extract a particular attribute value. In addition.00 You can extract any of these attributes.5 . Extracting all other system attributes. and always extracts. “Processing Rules”. and sets the processing status to DONE W/ERRORS. you can designate those attributes as being required for extraction. In this case. 274 webMethods Trading Networks User’s Guide Version 6.

you can explicitly specify in the gateway service the processing rule to execute for a given document type. 7 Trading Networks executes the optional pre-processing actions that you might have specified when you defined the TN flat file document type. that is.Overview Tip! Trading Networks performs a processing rule lookup for each document. or to use the ones specified in the document type. you can specify whether to use the pre-processing actions specified in the processing rule. Alternatively. to determine the processing rule to use for it. include the following: Verify the digital signature of a document Validate the structure of a document using a flat file schema that you specified in the document type definition Check for duplicate documents. see Chapter 14. 8 Trading Networks executes the processing rule actions. For details. executed in the following order.5 275 . For details. webMethods Trading Networks User’s Guide Version 6. attributes. Trading Networks executes these pre-processing actions before it executes the processing rule that you associate with the document type. thus bypassing the lookup (and its overhead). and/or log information to the database You can also specify this same set of pre-processing actions in the processing rule that you associate with the TN flat file document type. “Processing Rules”. see “Pre-Processing Actions” on page 327. In the processing rule. determine whether Trading Networks has already received the document Save a copy of the document content. These actions.

tn. ConversationID. You must provide your trading partners with the names of the document gateway services that are appropriate for their particular types of documents. Explicitly specify the processing rule to use for processing the document (optional). respectively. see “Reading the Input Stream” on page 278. 2 Use the Trading Networks system attributes and variables (described in “Specifying the Document Gateway Services Outputs” on page 280) to: a Explicitly specify the document type to use for processing the document (optional). Use the system attribute DoctypeID or DoctypeName for this purpose. For details. and/or TN_parms/UserStatus pipeline variables.g. The trading partner’s client application invokes a gateway service. For details. and/or UserStatus in the TN_parms/DocumentID. wm. Optionally specify values for the system attributes DocumentID. TN_parms can include: The custom attributes that you specify (the document data) The Trading Networks system attributes and system variables that you specify. thus eliminating the overhead of that search. that you can use as a model. The WmTNSamples package provides a sample gateway service. see “Converting a Flat File Document to an IS Document” on page 278. TN_parms/GroupID. you can parse the input stream and convert it to an IS document. There is only one input variable: ffdata.. b Specify the external ID values (e.rec:GatewayService specification defines the input and output variables for a document gateway service.5 .samples. TN_parms/ConversationID. The gateway service receives the flat file document as an input stream in the ffdata pipeline variable. A document gateway service returns the output variables ffdata (an object) and TN_parms (an IS document). Optionally. passing it the flat file document.gateway:gateway. GroupID. D-U-N-S numbers) for the sender and receiver of the documents in the TN_parms/SenderID and TN_parms/ReceiverID pipeline variables.tn.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s Defining Document Gateway Services You can create a document gateway service using Java or flow. This is an alternative to having Trading Networks search for a matching document type. Logic to include in a document gateway service 1 Read the input stream. c d 276 webMethods Trading Networks User’s Guide Version 6. The wm.

Use the system variables TN_parms/processingRuleID and TN_parms/processingRuleName for this purpose. f Specify the content type and content encoding you want Trading Networks to use for the document (optional). 4 webMethods Trading Networks User’s Guide Version 6.tn. Invoke either wm. e Place the gateway service’s name into the pipeline to enable documents that invoke this gateway service to be resubmitted if necessary (optional). thus eliminating the overhead of that lookup. This is an alternative to having Trading Networks automatically determine the content type and content encoding of the document.5 277 . Use the system variable TN_parms/$receiveSvc for this purpose.doc. 3 Specify all custom attribute values (the document data) that the matching document type is to extract.tn:receive or wm. Make sure that the name and case you use for the TN_parms pipeline variable match exactly to the attribute name that is defined in the TN flat file document type.ff:routeFlatFile to pass ffdata and TN_parms to Trading Networks. Use the system variables TN_parms/$contentType and TN_parms/$contentEncoding for this purpose.Defining Document Gateway Services This is an alternative to havingTrading Networks look up the appropriate processing rule to use.

you can parse the input stream and convert it to an IS document.io services. To do so.InputStream class to read bytes from the input stream contained in ffdata. In this situation. This service invokes 278 webMethods Trading Networks User’s Guide Version 6. Important! Remember to use InputStream's mark and reset methods so that Trading Networks will be able to read from the beginning of the stream. For descriptions of the pub. You can provide the content type and content encoding to ensure that Trading Networks uses the accurate values. Then you can map information from the converted document to the TN_parms variable. In this case. invoke pub. use the methods of the java. Consult your Java documentation for descriptions of these methods. if a document with a content type of “text/plain” and an encoding of “SJIS“ is submitted to a service and that service passes the document into the pipeline to your gateway service. Trading Networks will lose the bytes read by the gateway service when attempting to save the document content to the BizDocEnvelope. For example. Otherwise. Trading Networks saves the entire pipeline into the repository.5 . see the Flat File Schema Developer’s Guide. Determining the Content Type and Content Encoding If your partners send documents directly to your document gateway service (rather than through an intervening service) Trading Networks will automatically try to determine the content type and content encoding of the submitted flat file document. If your document gateway service is a flow service.io. Important! Perform this action only if absolutely necessary because parsing can be timeconsuming and return very large outputs that consume much memory.gateway:gateway service in the WmTNSamples package. which slows down processing.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s Reading the Input Stream If your document gateway service is a Java service.tn. Converting a Flat File Document to an IS Document Optionally. either your gateway service or the service that invoked it. see the wm. respectively. The WmFlatFile package must be enabled to use these services.samples. The pipeline has a content type of “application/x-wmidatabin“ and a content encoding of “UTF8“.io folder. For examples of how to use the pub.io services. should specify “text/plain“ for TN_parms/$contentType and “SJIS“ for TN_parms/$contentEncoding. the original content type and content encoding will be lost.flatfile:convertToValues. which is a service in the WmFlatFile package (see the Flat File Schema Developer’s Guide). explicitly specify the content type and/or content encoding in the TN_parms/$contentType and the TN_parms/$contentEncoding variables. use the services provided in the WmFlatFile package’s pub. In your document gateway service.

5 279 . Note: Do not convert a document in both the gateway service and the TN document type. see “Validating the Structure of Flat File Documents” on page 295. if you decide you do not need to parse the document in your gateway service. Trading Networks can save or throw away the parsed contents. For details. there is no reason to do that. webMethods Trading Networks User’s Guide Version 6.Defining Document Gateway Services the flat file parser to validate the document’s structure and content. you can still indicate that you want to parse the document to validate its structure using the pre-processing option Validate Structure. it will remain in the pipeline. Alternatively. If you convert a document in the gateway service. based on the flat file schema that you name as input to the service.

This is an alternative to having Trading Networks search for an appropriate document type. The TN document type uses ReceiverID to verify the receiver’s identity. String (optional) The identifier of the flat file document. To determine the document type identifier invoke the wm. DoctypeID is used. String An external ID value specified in the receiver’s profile. Be sure to specify DocumentID if you want to use the Check for Duplicate Document pre-processing action. for example DUNS. and Trading Networks is to use the DocumentID to determine whether documents are duplicates. In the TN document type you must specify the type of the external ID. for example. the gateway service will not function as intended. Examples: /TN_parms/DoctypeID = "5066kt00tttva37r00000009" /TN_parms/DoctypeName = "xCBL_PO" SenderID String An external ID value specified in the sender’s profile. Since TN document type IDs cannot be changed. If you use DoctypeName. and that name is changed later. The TN document type uses SenderID to verify the sender’s identity. see “Checking for Duplicates of the Flat File Document” on page 296. for example DUNS.tn.5 . If you specify both variables. your gateway service will be both more stable and more efficient if you use DoctypeID rather than DoctypeName. ReceiverID DocumentID 280 webMethods Trading Networks User’s Guide Version 6. TN_parms can return: The custom attributes that you specify (the document data) The Trading Networks system attributes and system variables that you specify.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s Specifying the Document Gateway Services Outputs A document gateway service can return the output variables ffdata (an object) and TN_parms (an IS document). thus eliminating the overhead of that search.doctype:list service from Developer to return the name and ID of all your TN document types. the receiver’s D-U-N-S number. In the TN document type you must specify the type of the external ID. for example. which are described below TN_parms variables DoctypeID or DoctypeName Description String (optional) The Trading Networks-generated internal identifier or name of the TN flat file document type that you want Trading Networks to use for the flat file document. the sender’s D-U-N-S number. For details.

ConversationID UserStatus String (optional) A status that you have associated with the flat file document. Use UserStatus if you want it to be available so you can process the document based on the user status. add a variable to the pipeline called prtIgnoreDocument with the value of true. see the webMethods Modeler User’s Guide. be sure the value you specify for ConversationID is reproducible for future documents that will arrive in the same conversation.5 281 . You define the actions taken against a document during process management by creating a process model. webMethods Trading Networks User’s Guide Version 6. Use ConversationID if you want Trading Networks to pass the document to process management after it executes the document type’s processing rule. be sure the value you specify for GroupID is reproducible for future documents that will arrive in the same group. For more information about creating process models. The user status is a criterion that Trading Networks uses to determine the processing rule to use for a document. you can refine the list of displayed documents on the Transaction Analysis screen by searching for documents with specific user statuses. If you expect to receive more documents in the same conversation. String (optional) The identifier in a flat file document that associates this document with other documents in the same conversation of documents. For more information. see “Processing Rule Criteria” on page 317. if you create UserStatus.Defining Document Gateway Services TN_parms variables GroupID Description String (optional) The identifier in a flat file document that associates this document with other documents in its group. In addition. If you expect to receive more documents in the same group. If you do not want Trading Networks to pass the document to process management.

the gateway service will not function as intended.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s TN_parms variables processingRuleID or processingRuleName Description String (optional) The Trading Networks-generated internal identifier or name of the processing rule that you want Trading Networks to use for the flat file document.east:gateway1“. receiver. and TN document type will all be unknown. Note: An important usage consideration is discussed in “Bypassing Lookups for Processing Rules” on page 326. processingRuleID is used. you will be able to resubmit the flat file document if necessary. You can specify $contentType and/or $contentEncoding. $receiveSvc String (optional) The fully qualified name of the document gateway service you are creating. the sender. which will not be able to properly recognize the flat file document. Processing rule IDs cannot be changed. If $receiveSvc is not set and you resubmit the document. if your service is named “gateway1”and is located in the “partners. This is an alternative to having Trading Networks look up the appropriate rule. so your gateway service will be both more stable and more efficient if you use processingRuleID rather than processingRuleName. thus eliminating the overhead of that lookup.5 . If you include values for processingRuleID and processingRuleName (which is unnecessary). and the resubmission will fail. As a result. To determine the identifier. For example. see “Determining the Content Type and Content Encoding” on page 278. String (optional) The content type and encoding you want Trading Networks to use for the flat file document. the fully-qualified name of the service would be “partners. By saving the name of the gateway service. $contentType and $contentEncoding 282 webMethods Trading Networks User’s Guide Version 6.route:list service from Developer to return the name and ID of all your processing rules.tn. If you use processingRuleID and that name is changed. invoke the wm. For more information.tn:receive. Trading Networks resubmits the document to wm.east“ folder. This is an alternative to having Trading Networks automatically determine the content type and content encoding of the submitted flat file document.

Trading Networks ensures that the variable (key) is in the TN_parms regardless of its value. Trading Networks ensures that the variable (key) is in the TN_parms variable and that it has the value that you specified. Doing so eliminates the overhead of the search that Trading Networks would have to perform to find the matching TN flat file document type. Tip! The gateway service can specify a value for either the TN_parms/DoctypeID or TN_parms/DoctypeName variable to explicitly specify the document type to use for the flat file document. If you specify a key without a value. trying to find a matching document type for the document. you define a corresponding TN flat file document type that Trading Networks will use when it receives the document from the gateway service. Specifying values for the variables is optional. In a document type you specify: “Pipeline Matching Criteria Used to Identify the TN Document Type” on page 283 “Attributes To Extract From Documents” on page 285 “Pre-Processing Actions in the TN Flat File Document Type” on page 294 Pipeline Matching Criteria Used to Identify the TN Document Type In your TN flat file document type. The pipeline matching criteria is one or more key/value pairs that identify a document. You would have defined the following criteria: Key Department Service_code Value Billing XYZ A document would match this document type only if it contains both of those variables within TN_parms and the variables have those values.) webMethods Trading Networks User’s Guide Version 6. At run time Trading Networks examines the contents of the TN_parms variable that the gateway service added to the pipeline. (You could have omitted the Service_code value if you wanted to receive Billing department documents with any service code. Then it searches the key/value pairs specified in the pipeline matching criteria of all your enabled TN flat file document types. For example.TN Flat File Document Types TN Flat File Document Types After you define a document gateway service.5 283 . you specify pipeline matching criteria that Trading Networks uses to determine whether to use the document type for the incoming flat file document. suppose you defined a document type named Acme_XYZ_Invoices to receive all documents from Acme’s Billing department with the service code XYZ. If you specify both a key and a value.

Because TN document types indicate the system and custom attributes to extract. Trading Networks does not extract any attribute values. In either of these cases. Because the TN document type is unknown. the document is considered to be an unknown type. Trading Networks cannot extract any attribute values from the document because the TN document type is unknown. 284 webMethods Trading Networks User’s Guide Version 6.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s Error Conditions When Matching Documents To TN Document Types Trading Networks logs an error if any of the following conditions are met: The data in the TN_parms pipeline variable does not match the pipeline matching criteria in any document type —OR— The data in the TN_parms pipeline variable explicitly identifies the document type to use.5 . The data in the TN_parms pipeline variable matches the pipeline matching criteria in multiple document types. the document is considered to be an unknown type because Trading Networks does not know which of the matching TN document types to use. Trading Networks logs a message to the activity log that identifies all the TN document types that the document matched. You can define processing rules that act on documents with an unknown TN document type. 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. 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 define processing rules that act on documents with an unknown TN document type. but that document type does not exist. When this happens. In this situation.

Continuing with the example document type Acme_XYZ_Invoices. Extracting all other system attributes. it will not log an error. you can designate those attributes as being required for extraction. which is in the bizdoc variable Puts the error into the activity log Sets the processing status to DONE W/ERRORS. Trading Networks: Completes processing Logs an error in the BizDocEnvelope. process management. using built-in or custom transformations. is optional. You can extract document data to perform any processing you want. In this case.00 You can extract any of these attributes. such as DocumentID. In addition. such as calculations. If you want Trading Networks to log an error when it cannot extract particular attribute values. Error Conditions When Extracting Attributes By default if Trading Networks cannot find a particular attribute for extraction. You can extract system attributes as well as custom attributes (the document data). transaction analysis. see “System Attributes To Extract From Documents” on page 286. suppose your trading network expects to receive a document whose TN_parms will contain the following attributes: Attribute TN_parms/SenderID TN_parms/ReceiverID TN_parms/DocumentID TN_parms/Department TN_parms/Service_code TN_parms/Invoice_number TN_parms/Amount Value [some value] [some value] [some value] Billing XYZ 123 1000. you can transform extracted attribute values before Trading Networks stores them in the BizDocEnvelope. Trading Networks always extracts the system attributes SenderID and ReceiverID. For more information. and more.TN Flat File Document Types Attributes To Extract From Documents You specify the attribute values to extract from the document’s TN_parms variable. it completes processing (assuming it finds no errors) and sets the processing status to DONE.5 285 . webMethods Trading Networks User’s Guide Version 6. You extract system attribute values if you want to use them as criteria for determining the processing rule to use for a document.

For descriptions of system attributes. Reasons for extracting system attributes are discussed below. it automatically transforms the externals ID in TN_parms/SenderID and TN_parms/ReceiverID into its internal IDs before storing them in the BizDocEnvelope. Search for the flat file document on the Transaction Analysis screen by searching for documents with specific senders and receivers. you can configure the document type’s processing rule to handle the error as follows: Use the processing rule’s Recognition Errors criterion to trigger a processing rule based on whether it contains errors. SenderID and ReceiverID Trading Networks always extracts both of these attributes. you can perform the following tasks. Trading Networks always extracts SenderID and ReceiverID from TN_parms.5 . For more information. This is how Trading Networks verifies the identities of the sender and receiver. On the Extract panel you must select from the pull-down list the type of the external IDs (for example. see “Specifying the Document Gateway Services Outputs” on page 280. so the business process performs different logic based on the sender and 286 webMethods Trading Networks User’s Guide Version 6. Recall that the values of SenderID and ReceiverID are external IDs that should be identical to the external IDs specified in the sender’s and receiver’s profiles. you can then set conditions on transitions in process model. DUNS) for both attributes so that Trading Networks can match the externals ID in TN_parms/SenderID and TN_parms/ReceiverID with the external IDs in the profiles. When Trading Networks has a value for the SenderID and ReceiverID. For more information about the Execute a service processing actions. System Attributes To Extract From Documents You can extract any system attribute that the TN document type’s gateway service places in a document’s TN_parms variable. When Trading Networks finds a match. This variable is in the pipeline and is available for your use when Trading Networks is processing the document. see “Action 1—Execute a Service” on page 330. Use the processing rule’s Execute a service processing action to inspect the bizdoc/Errors variable for the errors that Trading Networks encountered. Extracting all other system attributes is optional. see “Processing Rule Criteria” on page 317. you cannot delete them. see “Document Recognition Errors Criterion” on page 321. For more information. Use the identify of the sender and receiver of the flat file document in the logic of a business process. For example. Specify the sender and receiver as criteria for determining the processing rule to use for the flat file document. When Trading Networks is unable to extract a required attribute.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s In this case. it records the error in the bizdoc/Errors variable.

if you resubmit the document.. If you set up Sender criteria in a processing rule. This is because when you resubmit the document from the Trading Networks Console. Use the Retrieve SenderID from session option as an alternative way to set the value of the SenderID system attribute. Trading Networks creates a user account on the Integration Server for that partner. the user is the IS user account that you used to log in to the Trading Networks Console (e. DUNS). the first time the document arrives.g. For more information about creating process models. For details.5 287 . It could end up matching another processing rule and then go through completely different processing. Recall that when you create a profile. because that is the value determined via the Retrieve SenderID from session option. Trading Networks uses the connected user. The user name is equal to the required external ID. that is. DocumentID When Trading Networks has a value for DocumentID. determine whether Trading Networks has already received the document. However. rather than look in TN_parms\SenderID for the value to use. That means that when the client sent the flat file document to Trading Networks. So. if the required external ID is DUNS and a profile is added for a partner whose D-U-N-S number is 123456789. it must present credentials—it supplies user name 123456789 along with its password. and put that value in the BizDocEnvelope. which will not match sender 123456789 in the Sender criteria of the processing rule. When you create a profile. Search for the flat file document on the Transaction Analysis screen by searching for documents with the specific document ID. when that partner’s client wants to send a flat file document to Trading Networks. then that partner will have an Integration Server user account with the user name 123456789.TN Flat File Document Types receiver of a document. So. that same processing rule will not be selected based on the Retrieve SenderID from session option. the resubmit might fail. Trading Networks would determine the sender of the document based on the user account 123456789. by checking the value of the document ID. see “Checking for Duplicates of the Flat File Document” on page 296. Important! When you resubmit a flat file document with the Retrieve SenderID from session option selected. the criteria matches a processing rule based on the SenderID value 123456789. Determine whether the incoming flat file document is a duplicate. That user name/password pair directly correlates to a Trading Networks partner. webMethods Trading Networks User’s Guide Version 6. find the profile (and therefore the internal ID). So. there is a required external ID type (for example. Search for the flat file document on the Transaction Analysis screen by searching for documents with the specific document ID. If set. it had to present credentials— an Integration Server user name and password. you can perform the following tasks. if Retrieve SenderID from session is set to true in a TN flat file document type. see the webMethods Modeler User’s Guide. Administrator).

Transformation Information for Extracted Attributes of TN Flat File Document Types You can use built-in or custom transformations to transform the following types of attribute data before Trading Networks stores it in the BizDocEnvelope: “Built-in Transformations for SenderID and ReceiverID” on page 288 “Built-In Transformations for DATETIME and DATETIME LIST Data Type Attributes” on page 289 “Built-in Transformations for STRING or STRING LIST Data Type Attributes” on page 289 “Built-in Transformations for NUMBER Data Type Attributes” on page 290 “Custom Transformation Services” on page 292 Built-in Transformations for SenderID and ReceiverID On the Extract panel you must select from the pull-down list the type of the external IDs (for example. DUNS) for both the SenderID and ReceiverID attributes so that Trading Networks can match the externals ID values in TN_parms/SenderID and TN_parms/ReceiverID with the external IDs in the profiles. see the webMethods Modeler User’s Guide. see “Processing Rule Criteria” on page 317.5 .C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s ConversationID You can use ConversationID to pass the document to process management after it performs the actions identified by a processing rule. When Trading Networks finds a match. it automatically transforms the external IDs in TN_parms/SenderID and TN_parms/ReceiverID into its internal IDs before storing them in the BizDocEnvelope. you can perform the following tasks. You define the actions taken against a document during process management by creating a process model. UserStatus When Trading Networks has a value for UserStatus. If you do not want Trading Networks to pass the document to process management. Search for the flat file document on the Transaction Analysis screen by searching for documents with the specific user status. GroupID When Trading Networks has a value for GroupID. For more information about creating process models. For more information. you can search for this flat file and all other flat files that have the same group ID on the Transaction Analysis screen. Specify the user status as a criterion for determining the processing rule to use for the flat file document. 288 webMethods Trading Networks User’s Guide Version 6. add a variable to the pipeline called prtIgnoreDocument with the value true. This is how Trading Networks verifies the identities of the sender and receiver.

Stores the extracted string attribute in all lowercase. use a pattern string based on the “Time Format Syntax” described for the java. Trading Networks stores “purchase order” for the attribute value.5 289 .SimpleDateFormat class. However. if the date/time format you need to use is not in the list. Trading Networks saves the data exactly as it extracted it.text. if the extracted attribute value is “Purchase Order”. Alternatively. Trading Networks extracts the value of the date and uses it and the pattern that you specify to decode the value and convert it to the format that Trading Networks requires to store the date in the BizDocEnvelope. Following are descriptions of the built-in transformation options for string attributes. You can have Trading Networks make a simple alteration to change the case of the extracted string values to all upper. Lowercase webMethods Trading Networks User’s Guide Version 6. you can specify whether you want Trading Networks to alter the string value before storing it. Trading Networks requires you to identify the date format. you can type the format you need. Built-in Transformations for STRING or STRING LIST Data Type Attributes For attributes with the data type STRING or STRING LIST. For example. To specify the date/time format. If you do not specify transformation information for a string attribute.or all lowercase. Trading Networks maintains a list of built-in common date/time formats from which you can select. For example. you can have Trading Networks use the extracted values as substitutions in a string that you supply. if the attribute value is “Purchase Order”.TN Flat File Document Types Built-In Transformations for DATETIME and DATETIME LIST Data Type Attributes If you specify an attribute that has the data type DATETIME or DATETIME LIST. Trading Networks stores “PURCHASE ORDER” for the attribute value. Format Uppercase Description Stores the extracted string attribute value in all uppercase.

5. suppose your document gateway service extracts the names of three items in a purchase order and places them into an attribute named itemName in your TN_parms variable as follows: /TN_parms/itemName = {“WidgetA”.5 . 3. the string that Trading Networks stores for the attribute will not contain all the extracted values. Built-in Transformations for NUMBER Data Type Attributes You can specify an attribute with the NUMBER data type that contains an array of numbers. For example. Stores the smallest number in the array. 5]. “WidgetB”. use this field to specify the following string substitution pattern for itemName: “Item Name: {0}. Minimum 290 webMethods Trading Networks User’s Guide Version 6.MessageFormat class to perform this transformation. if the array contains the numbers [2. For example. If you specify less arguments in the pattern than values that Trading Networks extracts. WidgetB.text.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s Format String Substitution Description Substitutes extracted values with a pattern that you specify. “WidgetC”} Your TN document type would have to include the following: itemName STRING LIST Suppose you want to replace the three names with a single string that contains the three names. it will only contain the values for the number of arguments you specify in the pattern. {2}” Trading Networks would store the following for the value of itemName: Item Name: WidgetA. 4. 3. To do this. Trading Networks uses the java. You can specify one of the following built-in formats to transform the array of numbers to a single value for Trading Networks to store: Format Average Description Stores the average value of all the numbers in the array. 5]. the string that Trading Networks stores for the attribute will contain the extra arguments (e. {2}). For example. Trading Networks stores the value 2. 4. Trading Networks stores the value 3. WidgetC If you place more arguments in the pattern than values that Trading Networks extracts.. {1}. if the array contains the numbers [2.g.

Trading Networks stores the value 2. Trading Networks interprets the value as “100”.lang. For example. suppose your document gateway service extracts the quantity of each item of a purchase order. 4. Stores the sum of all the numbers in the array. 3.Number. For example. Trading Networks stores the value 5. and produce a single number. if the NUMBER or NUMBER LIST contains the value “100zzz”. For example. if the array contains the numbers [2. Sum No format specified Note: When Trading Networks extracts a NUMBER or NUMBER LIST from a document. 4. it uses the number parsing behavior of java. To redefine this parsing behavior. For example. 4. 3. see “Custom Transformation Services” on page 292. it will sum its value (an of quantities). 5]. if the value of totalQuantity is the following array: /TN_parms/totalQuantity = {2. 4. For example. For example. 3. if the array contains the numbers [2. you can write a custom attribute transformation. instead of throwing an error as it would if the value were “zzz100”. 5]. webMethods Trading Networks User’s Guide Version 6. 5} then the value of summedValue will be: /TN_parms/summedValue = 2 + 3 + 4 + 5 and Trading Networks will store the value 14 for totalQuantity. 3. Trading Networks stores the value 14. and you want to sum the quantities of all items. For more information. 5].5 291 . if the array contains the numbers [2.TN Flat File Document Types Format Maximum Description Stores the largest number in the array. Suppose you defined the following attributes in your TN_parms variable and in your TN document type: TN_parms attributes /TN_parms/itemNumber /TN_parms/quantity /TN_parms/totalQuantity TN document type itemNumber NUMBER quantity NUMBER totalQuantity NUMBER summedValue NUMBER LIST If you select the Sum built-in transformation for totalQuantity. Stores the first value of the array as the value of the attribute.

tn. The service must implement the input and output variables defined in the wm. For more information.rec:DateAttributeTransformService specification. DATETIME LIST). isArray will be false if values contains a single value. For an array data type (e.rec:StringAttributeTransformService specification. Optional arguments that you can define.g.tn. isArray Whether values contains a single value to transform or multiple values to transform. use webMethods Developer and look in the WmTN package.5 .rec:NumberAttributeTransformService specification. Make sure that your custom transformation service can handle null values or empty strings. Base your service on the appropriate specification listed below: Data type DATETIME or DATETIME LIST STRING or STRING LIST NUMBER or NUMBER LIST Specification you must use… The service must implement the input and output variables defined in the wm. see the webMethods Trading Networks Built-in Services Reference. Note: The values might be null or an empty (zero length) string.. The service must implement the input and output variables defined in the wm. Trading Networks passes the following input variables: Input Value values Meaning One or more values for your service to transform. To view these specifications.tn. arg 292 webMethods Trading Networks User’s Guide Version 6. otherwise it will be true. any element in the values array can be null or an empty string.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s Custom Transformation Services Trading Networks allows you to create your own service to perform transformations on extracted attributes.

It should store each as an item in the output variable newValues.5 293 .TN Flat File Document Types Trading Networks expects you to return the transformed values in the following output variable: Output Value newValues Meaning Transformation values of: Date List for DATETIME or DATETIME LIST String List for STRING or STRING LIST Number List for NUMBER or NUMBER LIST. if you are transforming string data. For information about creating a service. newValues is a Date List of the transformed Strings. If the input variable isArray is false. Your service should transform the single item and save just a single item in the output variable newValues. If the input variable isArray is true (meaning multiple values). your service should loop through the items in the values variable and transform each one. the input variable values will contain only a single item to transform. see the webMethods Developer User’s Guide. webMethods Trading Networks User’s Guide Version 6. For example.

Verifying the Digital Signature of Flat File Documents This action assures that the document has arrived unchanged and that the sender is who it claims to be. If the digital signature is invalid. For details. if you selected the Save Document to Database pre-processing option and the Activity Log option. see “Pre-Processing Actions” on page 327. which your processing rule can access. Trading Networks: 1 2 3 4 Performs the remainder of the pre-processing actions you specified (if any). you can specify this same set of pre-processing actions in a processing rule. 294 webMethods Trading Networks User’s Guide Version 6. Trading Networks executes them in the following order: “Verifying the Digital Signature of Flat File Documents” on page 294 “Validating the Structure of Flat File Documents” on page 295 “Checking for Duplicates of the Flat File Document” on page 296 “Saving Flat File Documents to the Database” on page 297 These actions are provided as built-in options on the Options tab in the TN document type’s definition. using the inputs and outputs specified in wm. To do this. Adds the error information to the BizDocEnvelope in the pipeline variable bizdoc/Errors. Note: Additionally. or to use the ones specified in the document type.rec:BizDocVerificationService (described in the webMethods Trading Networks Built-in Services Reference).tn.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s Pre-Processing Actions in the TN Flat File Document Type Trading Networks executes pre-processing actions before executing the processing rule that you associate with the TN flat file document type. In the processing rule. Create this service in any user-defined package. Logs the error to the activity log. you can specify whether to use the pre-processing actions specified in the processing rule.5 . Performs the processing actions specified in the processing rule. All actions are optional. This enables you to overwrite the pre-processing actions. select the Verify Digital Signature option on the Options tab in the TN document type’s definition and specify the name of your user-defined verification service.

To implement this action. Adds the error information to the BizDocEnvelope in the pipeline variable bizdoc/Errors. which your processing rule can access. based on the flat file schema that you named in the Parsing schema option. which slows down processing. the Validate Structure option invokes pub. Trading Networks: 1 2 3 Performs the remainder of the pre-processing actions you specified (if any). which is a service in the WmFlatFile package (see the Flat File Schema Developer’s Guide). webMethods Trading Networks User’s Guide Version 6. Trading Networks saves the entire pipeline into the repository. If the document structure is invalid. Note: Alternatively. The Input for Flat File Validation dialog prompts you to select the parsing settings. You only need to specify a flat file schema if you want to validate the structure of the document. it will remain in the pipeline. as described in the Flat File Schema Developer’s Guide.flatfile:convertToValues. Do not convert a document in both locations. (You create flat file schemas in webMethods Developer. Trading Networks will save the parsed contents if you select the keepResults option. there is no reason to do that. if you selected the Save Document to Database pre-processing option and the Activity Log option. This service invokes the flat file parser to validate the document’s structure and content. (You create flat file schemas in webMethods Developer. use the Options tab in the TN document type’s definition to: Select the Validate Structure option.) At run time. You only need to specify a flat file schema if you want to validate the structure of the document. If you convert a document in the gateway service. In this situation. You specify the name of the document’s flat file schema in the Parsing schema option. and converts the flat file document to an IS document. Then you can map information from the converted document to the TN_parms variable. Specify the name of the TN document type’s flat file schema in the Parsing schema option.) Important! Perform this action only if absolutely necessary because parsing can be timeconsuming and return very large outputs that consume much memory. you can perform the same validation and conversion in your document gateway service (see “Converting a Flat File Document to an IS Document” on page 278). and saves the parsed contents if you selected the keepResults option. Logs the error to the activity log.TN Flat File Document Types Validating the Structure of Flat File Documents The Validate Structure action invokes the flat file parser to validate the document’s structure and content against a flat file schema.5 295 . as described in the Flat File Schema Developer’s Guide.

see “Creating a Duplicate Document Check Service” on page 329. Note: A custom duplicate checking service can affect performance. Document ID. and receiver in its database. To check for a duplicate document using the document ID and sender you must instruct Trading Networks to extract the DocumentID and SenderID system attributes from the document. SenderID. Checking for Duplicates of the Flat File Document This action searches the Trading Networks database to determine whether the database has already received the document.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s 4 Performs the processing actions specified in the processing rule. Document ID and sender —Trading Networks assures that it does not already have a document with the same document ID and sender in its database. and receiver. Trading Networks provides the following Check for Duplicate Document options on the Options tab in the TN document type’s definition. Important! If the structure of a document is invalid. you must instruct Trading Networks to extract the DocumentID system attribute from the document. sender and receiver—Trading Networks assures that it does not already have a document with the same document ID. sender. and TN document type in its database. To check for a duplicate document using the document ID. sender. you can create your own service to be executed in the document type. sender.5 . To limit the number of error messages. you must instruct Trading Networks to extract the DocumentID. 296 webMethods Trading Networks User’s Guide Version 6. set the Validate Max Errors option on the Trading Networks Web Manager. you must instruct Trading Networks to extract the DocumentID and SenderID system attributes from the document. To check for a duplicate document using the document ID and sender. To check for a duplicate document using the document ID. sender and document type—Trading Networks assures that it does not already have a document with the same document ID. Alternatively. To create a custom duplicate document check service. depending on its logic. Document ID. Document ID only—Trading Networks assures that it does not already have a document with the same document ID in its database. and ReceiverID system attributes from the document. the validation service can return many error messages.

SenderID. If you fail to select this option. Saving Flat File Documents to the Database This action saves a copy of all documents or only unique documents to the database. You can choose to save: All documents. attributes.TN Flat File Document Types Trading Networks might be unable to correctly determine whether a document is unique if: Trading Networks previously received a document that it did not save to the database. The following table displays the consequences of not saving specific parts of documents: webMethods Trading Networks User’s Guide Version 6. Trading Networks saves the results of the duplicate check to the pipeline. You can save a copy of the document content. Only unique documents. Trading Networks considers the document as having no duplicate and will save the document to the database. Trading Networks previously received a document and saved it to the database. Additionally. Trading Networks previously received a document and saved it to the database. but the document type Extract panel information did not indicate to save the DocumentID. and/or ReceiverID system attributes. and the same document is sent again (see “Saving Flat File Documents to the Database” on page 297). SenderID. and/or ReceiverID system attributes. You must save documents to the database if you want to use reliable delivery or scheduled delivery to deliver the document. Trading Networks was unable to match the document to a TN document type. and/or activity log information to the database. You must also select the Check for Duplicate Document pre-processing option (see “Checking for Duplicates of the Flat File Document”). but the document gateway service did not supply values in the pipeline for DocumentID. regardless of whether they are unique. No documents. so you can use it in the processing rule. Trading Networks uses the results of the duplicate check in the Save Document to Database pre-processing action. For more information.5 297 . see “Using Reliable Delivery with Immediate Delivery Method” on page 343 and “Using Reliable Delivery with Scheduled Delivery” on page 344.

However. Because the attributes are not saved when you reprocess the document. You might get different or unexpected results when you reprocess a document. Attribute You will not be able to view custom attributes from the Transaction Analysis screen (i.e. Trading Networks will bypass reliable delivery and invoke the specified delivery service once.e. if you use extended criteria to select a processing rule when the value of the custom attribute Total Amount is greater than 10000. For example. for example the default processing rule.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s If you do not save this. If Trading Networks is to use a delivery option that requires document content to be saved.. the Content tab will have no data). If you use the Transaction Analysis Custom search criteria. and perform the process actions identified in that matching rule.attempt. For more information. but only if the Trading Networks property tn. attributes will contain only information for system attributes). Trading Networks will not use reliable delivery or scheduled delivery. you can still use the processing rules extended criteria for the document.task. Trading Networks does not perform document recognition again and therefore does not re-extract the attributes.... Trading Networks would not select that processing rule when reprocessing a document because the value of the Total Amount attribute would not be available and therefore would not match the extended criteria. You will not be able to resubmit or re-process the document. see the TN Properties page of the Server Administrator. You will not be able to view content from the Transaction Analysis screen (i. If you use the Deliver Document actions.5 . 298 webMethods Trading Networks User’s Guide Version 6. Content Then the consequences of not saving are... Instead. see“Trading Networks Configuration Properties” on page 42.notPersisted is set to true (the default). Trading Networks will match to another processing rule. For instructions on how to view the online help of the TN Properties page. Trading Networks will not match processing rules that use extended criteria. Trading Networks will be unable to locate documents for which you did not save the attributes.

. Note: Trading Networks always saves documents that will be passed on to process management regardless of the setting of the Save Document to Database pre-processing option.e. For more information about process management.5 299 . see the webMethods Modeler User’s Guide. the Activity Log tab will have no data). webMethods Trading Networks User’s Guide Version 6. When Trading Networks resubmits a document...TN Flat File Document Types If you do not save this. Activity Log You will not be able to view Activity Log entries from the Transaction Analysis screen (i. You will not be able to view entries from the Activity Log screen. Trading Networks passes documents on to process management if it extracted a conversation ID from the document. Note: You can still resubmit a document.. Then the consequences of not saving are.. it performs document recognition and therefore extracts the attributes again.

New. For details about the information you 300 webMethods Trading Networks User’s Guide Version 6.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s Defining TN Flat File Document Types Note: If you are using an OEM version of the Trading Networks. type the name you want to give the TN flat file document type. In the Name field (required). 3 4 5 6 1) 2) 3) Click the row containing the TN flat file document type that you want to duplicate. Click on the Identify panel to specify the criteria that Trading Networks will use to match flat file documents to the document type. Duplicate— The TN flat file document type fields are filled with values from the TN flat file document type that you duplicate. you cannot create new TN document types in Trading Networks. Procedure to perform 1) 2) 3) 4) Select View Select Types Document Types. Select View Document Types. Click on the Configure tab. Click OK. type a description for the TN document type in the Description field. Optionally. Method to start a TN document type New— The TN flat file document type fields are empty. Select Types Duplicate.5 . You can update any or all fields from the duplicated TN flat file document type. To define a TN flat file document type 1 2 Start the Trading Networks Console. Trading Networks will gray out this unavailable selection. If you need procedures for this step. see “Starting the Trading Networks Console” on page 22. Select Flat file for the TN document type category. Perform one of the following procedures to start a new TN flat file document type.

Optional. Trading Networks fills in the Type field based on the document attribute definition. c to view Select the Required check box if you want Trading Networks to throw an error when it cannot extract the attribute. a Add an attribute to extract by clicking Add New Attribute displays the Add an attribute dialog box. Trading Networks Note: Trading Networks always lists SenderID and ReceiverID as attributes to be extracted. To view more details about all of the document attributes. Trading Networks finds a match only if the variable has the specified value. Note: Trading Networks always designates SenderID and ReceiverID as required. click Document Attributes the Document Attributes screen. Specify the following values in the Add Pipeline Matching dialog box. Trading Networks will not have this information available for processing rules or querying documents. c 7 Click OK to save the attribute and close the Add Pipeline Matching dialog box. see “Pipeline Matching Criteria Used to Identify the TN Document Type” on page 283. specify the system attributes and document attributes (document data) that you want Trading Networks to extract from documents. Note: You must specify at least one attribute. click Add New Pipeline Match . You cannot delete them. In the Extract panel. a b In the Pipeline Matching section. Attribute Name Value Specify Name of the TN_parms variable. Important! If you do not extract the system attributes. .5 301 . The value of the TN_parms variable.Defining TN Flat File Document Types specify on this panel. For details about what to specify for these fields. b In the Name field. If you specify a value. select the name of the attribute from the list. webMethods Trading Networks User’s Guide Version 6. see “Attributes To Extract From Documents” on page 285. otherwise Trading Networks will not use the TN document type.

Select a built-in format or type in your own. it sets the processing status to DONE. Built-in. Use the Transform and Argument fields to specify how you want to handle attribute data before storing it in the Trading Networks database. If the attribute data type… Is SenderID or ReceiverID e For Transformation… You must select from the pull-down list the type of the external IDs (for example. Use the Transformation fields to specify how Trading Networks is to handle attribute data before storing it in the Trading Networks database. This is how Trading Networks verifies the identities of the sender and receiver. If set. If Trading Networks completes processing without encountering any further errors. d Use the Retrieve SenderID from session option as an alternative way to set the value of the SenderID system attribute. The data type of the attribute (shown in the Type field) determines the Built-in or Custom transformation options available.5 . see “System Attributes To Extract From Documents” on page 286.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s Note: If you do not mark an attribute as required. see “BuiltIn Transformations for DATETIME and DATETIME LIST Data Type Attributes” on page 289. see “Transformation Information for Extracted Attributes of TN Flat File Document Types” on page 288. Select a built-in transformation provided by Trading Networks. Has DATETIME or DATETIME LIST data type You must specify a date format. For more information. Trading Networks uses the connected user. When Trading Networks finds a match. it automatically transforms the external IDs in TN_parms/SenderID and TN_parms/ReceiverID into its internal IDs before storing them in the BizDocEnvelope. Trading Networks does not flag an error if it is unable to extract the attribute. For more information. DUNS) for both attributes so that Trading Networks can match the externals ID in SenderID and ReceiverID with the external IDs in the profiles. For more information. 302 webMethods Trading Networks User’s Guide Version 6. rather than look in TN_parms\SenderID for the value to use.

Select or create your own service to perform custom transformations on extracted attributes. see “Built-in Transformations for NUMBER Data Type Attributes” on page 290.Defining TN Flat File Document Types If the attribute data type… Has STRING or STRING LIST data type (but not SenderID or ReceiverID) For Transformation… You can specify whether you want Trading Networks to alter the string value to all uppercase or all lowercase before storing it. . For more information. Has NUMBER or NUMBER LIST data type Custom. you can remove it by clicking on the row containing the attribute. Click Set Inputs. You should specify the operation that Trading Networks should perform on the numbers in the array. see “Custom Transformation Services” on page 292. see “Built-in Transformations for STRING or STRING LIST Data Type Attributes” on page 289. For more information. Click OK to save the new attribute and close the Add an attribute dialog box. For more information. Click Find Service to browse the IS namespace to locate the one you want to use. Trading Networks displays the name of the extracted attributes and their built-in or custom transformation services. To do this… Create a new custom transformation Select an existing custom transformation service Set the inputs of the transformation from the selected service Edit an existing service f Perform this… Click New Service . Click on the Edit Service button. Alternatively. you can have Trading Networks use the extracted values as substitutions in a string that you supply. Trading Networks returns to the Extract panel of the Document Type Details screen. and then clicking Delete attribute .5 303 . Note: If you add an attribute and then decide you do not need it. webMethods Trading Networks User’s Guide Version 6.

see “Verifying the Digital Signature of Flat File Documents” on page 294. see “Validating the Structure of Flat File Documents” on page 295. Then you can map information from the converted document to the TN_parms variable. see “Validating the Structure of Flat File Documents” on page 295. click Find schema to browse webMethods flat file schemas to locate the one you want to use. using the inputs and outputs specified in wm. For more information. Validate Structure pre-processing action Invokes the flat file parser to validate the document’s structure and content against the flat file schema you specify in the Parsing schema option. Trading Networks executes this pre-processing action before executing the processing rule that you associate with the TN document type.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s 8 Click the Options tab and specify any of the options. If you do not know the fully qualified name. Verify Digital Signature pre-processing action Executes a user-defined verification service to verify the digital signature of the documents. The Input for Flat File Validation dialog box prompts you to select the parsing settings. Important! Keep in mind that the pre-processing actions specified in the processing rules can override pre-processing actions specified in a TN document type. For details.5 . Trading Networks executes this pre-processing action before executing the processing rule that you associate with the TN document type. see “Pre-Processing Actions” on page 327. and converts the flat file document to an IS document. For more information. Options tab parameter Parsing schema Description The fully qualified name of a webMethods flat file (parsing) schema to use to validate the structure of the documents. For more information.tn. Create the verification service in any user-defined package. 304 webMethods Trading Networks User’s Guide Version 6.rec:BizDocVerificationService (described in the webMethods Trading Networks Built-in Services Reference). You only need to specify a flat file schema if you select the Validate Structure pre-processing option.

To select an existing duplicate service. depending on its logic. “Creating a Duplicate Document Check Service” on page 329. Save Document to Database preprocessing action Specify whether to save all documents. Trading Networks executes this pre-processing action before executing the processing rule that you associate with the TN document type. For details. see “Checking for Duplicates of the Flat File Document” on page 296. click Find Service to browse the IS namespace to locate one and then click the Edit Service button if you want to modify the service. see “Saving Flat File Documents to the Database” on page 297.5 305 . Additionally. attributes. To create a new custom service click New Service . Trading Networks executes this pre-processing action before executing the processing rule that you associate with the TN document type. specify whether to save the document’s content. and/or activity log information. only unique documents. Select a built-in service or use a custom service. see. Note: A custom duplicate checking service may affect performance.Defining TN Flat File Document Types Options tab parameter Check for Duplicate Document pre-processing action Description Searches the database to determine whether the database has already received the document. webMethods Trading Networks User’s Guide Version 6. 9 Click OK to create the TN flat file document type. For more information. For more information. or no documents.

To view disabled TN document types. 306 webMethods Trading Networks User’s Guide Version 6. Select View Document Types.OR -Use the TN_parms/DoctypeName variable in a document gateway service to specify the name of a TN flat file document type to use for a flat file document You can change other settings for the attribute.5 . see “Starting the Trading Networks Console” on page 22.. Trading Networks displays the TN flat file document types as well as the TN XML document types. 4 Updating TN Flat File Document Types Important! Do not change the name of the TN document type if you: Use a TN document type as an input to a step in a process model you created in Modeler -. To view TN flat file document types 1 2 3 Start the Trading Networks Console. To hide disabled TN document types. select Types Show All. Trading Networks places a check ( ) next to the Show All menu item to indicate that it is currently displaying disabled TN document types. Trading Networks removes the check ( ) next to the Show All menu item to indicate that Trading Networks is currently not displaying disabled TN document types. If you need procedures for this step. select Types Show All again.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s Managing TN Flat File Document Types The following table lists the tasks you can perform against TN flat file document types: Task “Viewing TN Flat File Document Types” “Updating TN Flat File Document Types” “Disabling TN Flat File Document Types” “Enabling TN Flat File Document Types” See page. 306 306 308 309 Viewing TN Flat File Document Types You can view all enabled and disabled TN document types..

5 307 . click on the Identify panel. To update identification information. To update the system attributes. Click OK to save your updates and close the Update Pipeline Matching dialog box. Click the row containing the TN flat file document type you want to update. click Add New Pipeline Match the variable and close the dialog box. To select a system attribute to extract. For details about the what to specify on this panel. click on the System Attributes tab. Click OK to save To update a pipeline matching variable. click the Extract panel. select the appropriate check box in front of the attribute name. Select Types Edit. Select View Document Types. For details about what to specify for these fields. click the row containing the pipeline matching variable you want to update and click Edit Selected Pipeline Match .Managing TN Flat File Document Types To update a TN flat file document type 1 2 3 4 5 6 Start the Trading Networks Console. To update the description. see “System Attributes To Extract From Documents” on page 286. see “Starting the Trading Networks Console” on page 22. To delete a pipeline matching variable. see “Pipeline Matching Criteria Used to Identify the TN Document Type” on page 283. If you need procedures for this step. For details about what to specify on this panel. type a new description in the Description field. To add a pipeline matching variable. update the Name and Value fields for that variable. In the Update Pipeline Matching dialog box. To update extraction information. Note: The SenderID and ReceiverID are always selected. see “Attributes To Extract From Documents” on page 285. click the row containing the pipeline matching variable you want to delete and click Remove Selected Pipeline Match 7 8 . Trading Networks displays all TN flat file document types as well as the TN XML document types. Use the Transform and Argument fields to specify detail information for how Trading Networks is to handle attribute data before storing it in the Trading webMethods Trading Networks User’s Guide Version 6. .

you can disable it. For a summary of actions you can take for custom attributes. Trading Networks displays both the TN XML document types and TN flat file document types. To update a custom attribute.5 . see Chapter 11. 11 After you have made all your changes. You can enable it later (see “Enabling TN Flat File Document Types” on page 309). click on the Custom Attributes tab. To view more details about all of the document attributes. Trading Networks closes the screen. When you disable a TN document type. click Edit Selected Attribute . click OK. “Document Attributes”. Then. Select View Document Types. deselect the appropriate check box in front of the attribute name. click Add New Attribute . add a new custom attribute. see “PreProcessing Actions in the TN Flat File Document Type” on page 294. 10 To update options. Custom attributes are the user-defined ones on the Document Attributes screen. For a summary of actions you can take for adding a new system attribute. 9 To update custom attribute information. the definition for the TN document type is not removed from the database. For more information about document attributes. see step 5 on page 197. To delete a custom attribute from the TN document type—Select the row for the attribute and click Remove Selected Attribute . click Document Attributes to view the Document Attributes screen. To add a custom attribute. see step 5 on page 197. If you need procedures for this step. you must also remove all documents that are associated with the TN document type. To deselect a system attribute. click the Options tab. To disable a TN flat file document type 1 2 Start the Trading Networks Console. your database administrator must remove it. 308 webMethods Trading Networks User’s Guide Version 6. see step 7 on page 301.C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s Networks database. Note: To permanently remove the TN document type from the database. For details about these fields. When you remove a TN document type from the database. For a summary of actions you can for take for adding a new custom attribute. Disabling TN Flat File Document Types If you no longer want Trading Networks to use a TN document type. see “Starting the Trading Networks Console” on page 22.

select Document Types Show All. you must first display inactive TN document types as described in “Viewing TN Flat File Document Types” on page 306. Important! To enable TN document types. Enabling TN Flat File Document Types If you disable a TN document type and then later determine that you still need it. If you need procedures for this step. Select Types Enable. To enable a TN flat file document type 1 2 3 4 Start the Trading Networks Console. Click the row containing information about the TN document type that you want to enable. webMethods Trading Networks User’s Guide Version 6. Select View Document Types. Select Types Disable. Trading Networks places No in the Enabled column to indicate that the TN flat file document type is disabled. you can enable it and make it available again. Trading Networks places Yes in the Enabled column to indicate that the TN document type is enabled.Managing TN Flat File Document Types 3 4 Click the row containing information about the TN flat file document type that you want to disable. Note: To view the Enabled column (if it is not currently displayed). see “Starting the Trading Networks Console” on page 22. Trading Networks displays both the TN XML document types and TN flat file document types.5 309 .

5 .C H A P T E R 1 3 T N F l a t F i l e D o c u m e n t Ty p e s 310 webMethods Trading Networks User’s Guide Version 6.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313 Processing Rule Criteria . . . . . . . . .CHAPTER 14 Processing Rules What are Processing Rules? . . . . . . . . . . . 366 Managing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347 About Querying and Viewing Processing Rules . . . . . . . .5 311 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329 Defining Processing Rules . . . . . . . . . . . . . . . . . . . . . 312 Processing Rules Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327 Processing Rule Actions . . . . . . 372 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . 322 Pre-Processing Actions . . . . . . . . . . . . . . . . . 317 Extended Criteria—Using Custom Attributes . . . . . . . . . . . . . . . . .

remoteAliases property correctly. After Trading Networks locates the appropriate processing rule. see Chapter 6. all Trading Networks servers must be set up for cluster synchronization. you can bypass the lookup if you already know which processing rule you want to execute. it performs a processing rule lookup to determine which processing rule to use for a specific document. For each document that Trading Networks is to process. Note: If you are working in a clustered environment. “Large Document Handling”. see Chapter 3. Alternatively. the servers must set the tn.CHAPTER 14 Processing Rules What are Processing Rules? Processing rules specify how you want webMethods Trading Networks (Trading Networks) to process documents. For example. After Trading Networks finds the appropriate processing rule for a document. "Setting up Trading Networks to Process Documents" Delivery methods you can use with Trading Networks.cluster. thus avoiding the overhead of the lookup (see “Bypassing Lookups for Processing Rules” on page 326). 312 webMethods Trading Networks User’s Guide Version 6. see “Shared Database in a Clustered Environment”. The actions you specify in the processing rule can be configured to override the actions that are specified in the TN document type.5 . "Trading Networks Document Processing" in the webMethods Trading Networks Concepts Guide and Appendix C. it performs the pre-processing and processing actions. you might want Trading Networks to send an alert e-mail message to a contact. You can specify pre-processing actions in both the TN document type and the processing rule. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. The pre-processing actions identify actions that Trading Networks performs before performing the processing actions. see Chapter 5. and then deliver the document to the receiver that is identified in the document. That is. it takes the actions that you specify in a processing rule.sync. For more information about how to configure Trading Networks for a clustered environment. For more information about Processing rules. Large document handling.

Processing Rules Order Processing Rules Order If a document matches more than one processing rule. Adding a new processing rule and causing the processing rule order to change may also affect the ordinals of the rules that are not displayed on your query results table. The highlighted processing rule is assigned its original ordinal + 1. Trading Networks uses the first processing rule it encounters. As a result. If you add a new processing rule using this option.5 313 . The processing rules reorder in this way. unfiltered list of processing rules (e. Trading Networks maintains the order of the processing rules by assigning an ordinal to each processing rule. Below— Add a new processing rule below the highlighted rule. Above— Add a new processing rule above the highlighted rule.. All existing processing rules below the highlighted processing rule keep their respective order. The new processing rule is assigned the highlighted rule’s original ordinal + 1. but they are assigned their original ordinal + 1.g.. The table below explains what happens to the order of the processing rules if you add a new processing rule using each of the Add options. The new processing rule is assigned the original ordinal of the highlighted rule. All existing processing rules below the highlighted processing rule keep their respective order but are also assigned their original ordinal + 1. Note: If you are working with a queried list of processing rules. remember that Trading Networks adds the new rule to the full... you have three Add options for processing rules: you can add it above or below an existing processing rule or add the new rule to the bottom of the processing rules list. the order in which you list your processing rules on the Processing Rules screen is important. Adding Processing Rules and the Order of Processing Rules When you add a new processing rule. webMethods Trading Networks User’s Guide Version 6. all of the processing rules)... The highlighted processing rule keeps its original ordinal.

All other processing rules keep their original ordinals.5 . The processing rules reorder in this way.. Ordinal 12 Add new rule ABOVE Processing Rule B. place it here (last) in the list. unfiltered list of processing rules. Ordinal 12 The new rule is ABOVE Processing Rule B and is now Ordinal 12 Processing Rule B is now Ordinal 13 314 webMethods Trading Networks User’s Guide Version 6. The new processing rule is placed in the last position at the bottom of the full... Last—Add a new processing rule to the bottom of the processing rules list.CHAPTER 14 Processing Rules If you add a new processing rule using this option. Add Processing Rule ABOVE Processing Rule B. Ordinal 12 as the rule to add your new processing rule in relation to. Example: The following diagrams demonstrate what happens if you highlight Processing Rule B... If you set up a default processing rule.

Processing Rules Order Add Processing Rule BELOW Processing Rule B.5 315 . Ordinal 12 Add new rule BELOW Processing Rule B. Ordinal 12 Processing Rule B remains Ordinal 12 The new rule is BELOW Processing Rule B and is now Ordinal 13 webMethods Trading Networks User’s Guide Version 6.

Place the default processing rule in the last position of the full.. Adding a new processing rule and causing the processing rule order to change may also affect the ordinals of the rules that are not displayed on your query results table. When you reorder a processing rule.5 . unfiltered processing rules list. Trading Networks reassigns the ordinal number for your selected processing rule and all affected processing rules.g. Ordinal 16. If you are working with a queried list of processing rules. Trading Networks ships with a default processing rule that you can use. see “Setting Up a Default Processing Rule” on page 362. 316 webMethods Trading Networks User’s Guide Version 6. Ordinal15) Default rule remains Ordinal 15 The new rule is LAST. there is no “undo” function that will return the processing rules to their original order. and is now below the Default rule Reordering Processing Rules You can reorder the processing rules by moving them up or down. You should also set up a default processing rule that you want Trading Networks to use when a document does not match any of the other processing rules. Keep rules with specific criteria before rules with general criteria. remember that Trading Networks adds the new rule to the full. unfiltered list of processing rules (e. For more information about the default processing rule. all of the processing rules). Note: If you reorder processing rules.CHAPTER 14 Processing Rules Add Processing LAST Add new rule LAST (below the Default rule.

All processing rule criteria that you specify must match the document information for Trading Networks to use the rule to process the document. you might set up the following criteria: Criterion Sender Receiver Document Type User Status Recognition Errors Value(s) “Any” “Industrial Steel Company” “United Steel” “cXML Order Request” “Needs approval” “has no errors” To match. Sender and Receiver Criteria You can use the sender and/or receiver of a document as criteria in a processing rule. TN document type. You should also set up a default processing rule that you want Trading Networks to use when a document does not match any of the other processing rules. After Trading Networks recognizes the TN document type. unfiltered processing rules list. it extracts the document attributes that are specified in the TN document type. Trading Networks ships with a default processing rule that you can use. see “Setting Up a Default Processing Rule” on page 362. receiver. A document has a sender. you can specify that a processing rule is to apply to documents that have specified senders and receivers.5 317 .. To process a document based on sender/receiver.Processing Rule Criteria Processing Rule Criteria The purpose of the criteria in a processing rule is to identify the documents Trading Networks should process using the processing rule. the possibility of having errors.. see “Processing Rules Order” on page 313. and the extracted custom attribute “Total PO Amount” is greater than 10000. user status. For example. You can set up a processing rule to match one or more of these criteria. You can select one or more partners and/or one or more partner profile groups to be a sender or receiver. and the custom attributes that the TN document type instructed Trading Networks to extract. For more information about the default processing rule. The rest of this section describes the types of criteria you can specify in a processing rule. you must specify that you want Trading Networks to extract the SenderID and ReceiverID system attributes from the document. As another example. Place the default processing rule in the last position of the full. For more information about ordering processing rules. The sender can be any value The receiver must be “Industrial Steel Company” or “United Steel” The TN document type must be “cXML Order Request” The user status must be “Needs approval” The document cannot have errors Keep rules with specific criteria before rules with general criteria. webMethods Trading Networks User’s Guide Version 6. have a specified TN document type.

it considers the sender/receiver an unknown partner. Because it is the TN document type that specifies the attributes to extract. Trading Networks uses the unknown partner for a document in all the following situations: The TN document type is unknown. Trading Networks uses the sender/receiver information from the document and matches it against the ID type information stored in the partner profiles for your partners. Industrial Steel Company). even if the partner is unknown 318 webMethods Trading Networks User’s Guide Version 6. The XQL query (in the TN document type) that identifies the location of the SenderID/ ReceiverID system attributes is not valid. Trading Networks uses Unknown for the sender. If Trading Networks successfully extracts the SenderID/ ReceiverID system attributes from a document and can match it to a partner profile on your Trading Networks system. The TN document type does not instruct Trading Networks to extract the SenderID and ReceiverID system attributes. If a document was sent by one of your partners (for example. Only if the sender/receiver is unknown Only if the sender/receiver that is identified in the document is one of the partners you specify The rule matches… Regardless of the partner that is identified as the sender/receiver in of the document. Trading Networks will not select the rule because it is using the unknown partner for the sender. but Trading Networks cannot determine the sender for one of the above reasons.CHAPTER 14 Processing Rules If Trading Networks cannot determine the sender/receiver of a document. If you have a processing rule that processes documents that are sent by this partner (for example. when the TN document type is not recognized. The value of the SenderID/ ReceiverID system attributes in the document do not match the value of the external ID type of any defined partner on your Trading Networks system. Industrial Steel Company). If you specify this… Any Senders —or— Any Receivers Enterprise Unknown Selected Senders —or— Selected Receivers Only if the sender/receiver that is identified in the document is the local partner.5 . Trading Networks compares the name of the partner (or unknown) to the partner or partners that you specify in the processing rule. it uses the corporation name and unit name specified in the partner profile as the name of the sender and/or receiver. Trading Networks cannot extract any attributes (including SenderID and ReceiverID).

even if the TN document type is unknown Only if the TN document type is unknown Only if the name of the TN document type is one of the TN document types you specify User Status Criterion You can use the user status of a document as a criterion in a processing rule. If a document does not match any TN document type or if it matches multiple TN document types.wm.tn. If you do not extract the User Status system attribute from a document.wm. Trading Networks determines the TN document type that matches the document. its initial value will be null. You can set and change the user status using the following: The following Java methods that are in the Trading Networks Java API: com.doc:changeStatus Processing action that changes the user status The following shows an example of using user status criteria during processing: webMethods Trading Networks User’s Guide Version 6.Processing Rule Criteria Document Type Criterion One of the criteria that you can use in a processing rule is the TN document type of a document.app. Trading Networks compares the name of the TN document type (or unknown) to the TN document type or types that you specify in the processing rule.doc.BizDocEnvelope.tn.tn. You can specify one of the following for the document type criterion in a processing rule: If you specify this… Any Document Types Unknown Selected Document Types The rule matches… Regardless of the TN document type of the document.BizDocStore.5 319 . When Trading Networks has a document that it needs to process.String) The built-in service wm.setUserStatus(String) com.changeStatus(BizDocEnvelope.app. the document is considered an unknown TN document type. To do this.db. The user status is a status that you can associate with a document. it must first attempt to recognize the type of document. Trading Networks sets the TN document type of the document to the name of the matching TN document type.String.

5 . The processing rule also changes the user status to “pending approval”. The alert e-mail contains a URL for a web page that displays the PO. 1 2 2 3 320 webMethods Trading Networks User’s Guide Version 6.CHAPTER 14 Processing Rules User Status and Processing Integration Server Processing Rule TN document type = PO user status = accepted Processing Rule TN document type = PO user status = rejected PO 6 Service handles POs 1 Processing Rule TN document type = PO user status = any 2 TN document type = PO user status = null To: From: Subject: http://tn:5555/PO.dsp Set user status to “accepted” 3 PO Accept Reject 4 PO Set user status to “rejected” 5 Step Description Trading Networks receives a document and recognizes that its TN document type is PO. The processing action in this rule indicates Trading Networks is to send an alert e-mail. The document matches the processing rule that has the criteria that indicates the TN document type must be PO and the document can have any user status. The user clicks the URL to open the web page to view the PO. The web page contains an HTML form that has an Accept button and a Reject button that the user can use to accept or reject the PO. The user status is originally null because Trading Networks was not instructed to extract the User Status system attribute.

which is either “accepted” or “rejected. Similarly. (This criterion does not allow you to process documents based on errors that occur while performing the pre-processing or processing actions.” This processing action in these rules indicates Trading Networks is to invoke a service. code executes.” If the user selects Reject.tn:submit built-in service that sends the document back to the Integration Server for processing.” The document matches either the processing rule that indicates the TN document type must be PO and the user status is “accepted” or the TN document type is PO and the user status is “rejected.doc:changeStatus to set the user status associated with the document to “accepted. 4 5 6 You can set the user status processing rule criterion to one of the following: If you specify this… Any User Status Specified User Status The rule matches… Regardless of the user status of the document. The code for the web form invokes the wm. When the user selects either button. even if the user status is null Only if the user status of the document is one of the user statuses you specify Document Recognition Errors Criterion Another criterion you can use in a processing rule is whether Trading Networks encountered errors while recognizing the TN document type and extracting attributes from the document. for example plain text or EDI.) Trading Networks flags a general error if an identifying XQL query in the TN document type failed. the code uses the built-in service wm. Trading Networks flags a sender error if the XQL query to locate the SenderID system attribute fails or if the external ID of the sender in the document does not match the value of the external ID information for any defined partner.tn. Trading Networks recognizes the TN document type is PO and determines the user status. the code uses the built-in service to set the user status associated with the document to “rejected”. Another example is if the document is identified as an XML document but is actually another format. Trading Networks flags a webMethods Trading Networks User’s Guide Version 6. For example. If the user selects Accept.5 321 . Trading Networks also flags an attribute error if Trading Networks is unable to extract an attribute that is marked as required in the TN document type.Processing Rule Criteria Step Description The user selects either Accept or Reject. This service processes the purchase order appropriately. This is because Trading Networks uses criteria before processing to determine the processing rule to use for processing. this error occurs when the document is identified as an XML document but contains invalid XML.

you can use extended criteria to indicate that Trading Networks is to use the processing rule only if the value of the custom attribute Total PO Amount is greater than 10000. Attribute instructs Trading Networks to look at the value of the specified attribute to determine whether it meets the rest of the criteria for this custom attribute.5 . In addition. 322 webMethods Trading Networks User’s Guide Version 6. you can also use this criterion to set up processing rules that specifically handle error cases.000. the value of the custom attribute will be null. After Trading Networks recognizes the TN document type.000 differently from purchase orders with an amount under $10. for example. This processing criterion is useful to assure that processing occurs only if no errors were encountered during document recognition. For example. When you use extended criteria. it extracts the custom attributes that are specified in the TN document type. Operator instructs Trading Networks how to match the value. you can match based on the value that Trading Networks extracted for the custom attribute. you specify the attribute name. you might want to process purchase orders for an amount over $10. if the value is not null. You can specify any attribute that is defined to your system. and the value the attribute should have. if you have Trading Networks extract the custom attribute. The operator you can specify depends on the data type of the custom attribute. match string values that contain specified characters. If the XQL query for the custom attribute is not valid or it identifies a node that is not in the document. If you extract a custom attribute. you can use the extended criteria to match if Shipping Date is equal to a date you specify. from a document. or match date values before a specified date. you can match a document based on whether the custom attribute value is null or not null.CHAPTER 14 Processing Rules receiver error if the XQL query to locate the ReceiverID system attribute fails or if the external ID of the receiver in the document does not match external ID information for any defined partner. For each custom attribute that you want to use in the extended criteria. match number values that are greater than a specified value. Shipping Date. You can set the error processing rule Content Criteria to one of the following: If you specify this… may have errors has no errors has errors The rule matches… Regardless of whether Trading Networks encountered errors Only if Trading Networks did not encounter any errors Only if Trading Networks did encounter errors Extended Criteria—Using Custom Attributes The extended criteria of a processing rule allow you to process a document based on the values of one or more custom attributes that were extracted from a document. Conversely. Total PO Amount. for example. For example. an operator.

webMethods Trading Networks User’s Guide Version 6. Has no value. The attribute has no value if the XQL query (defined in the TN document type) that Trading Networks used to extract the attribute failed. You do not need to specify a value when you specify this operator.5 323 . Contains the character string that you specify for the value. You do not need to specify a value when you specify this operator. Matches exactly the value that you specify.Extended Criteria—Using Custom Attributes Data Type STRING Operator Is null Matches when the attribute extracted from a document… Has no value. You do not need to specify a value when you specify this operator. Includes the value that you specify. You do not need to specify a value when you specify this operator. Has a value that does not match the value that you specify. Is not null Equals Contains Not equals STRINGLIST Is null Has any value. The attribute has no value if the XQL query for the custom attribute (in the TN document type) did not identify a node in the document. Is not null Includes Has any value.

Has a value that is greater than or equal to the value that you specify. You do not need to specify a value when you specify this operator. The attribute has no value if the XQL query for the custom attribute (in the TN document type) did not identify a node in the document. The attribute has no value if the XQL query for the custom attribute (in the TN document type) did not identify a node in the document. Has a value that is less than the value that you specify. Is not null Equals Less than Greater than Less than or equals Greater than or equals Not equals NUMBERLIST Is null Has any value. Has a value that is less than or equal to the value that you specify. Is not null Includes Has any value. You do not need to specify a value when you specify this operator. Includes the value that you specify. Has a value that does not match the value that you specify.CHAPTER 14 Processing Rules Data Type NUMBER Operator Is null Matches when the attribute extracted from a document… Has no value.5 . You do not need to specify a value when you specify this operator. Has no value. Matches exactly the value that you specify. You do not need to specify a value when you specify this operator. 324 webMethods Trading Networks User’s Guide Version 6. Has a value that is greater than the value that you specify.

You do not need to specify a value when you specify this operator.5 325 . Is a date that is before the date that you specify. You do not need to specify a value when you specify this date list. Is not null Has any value. see “Extracting Custom Attributes From XML Documents” on page 536. Has no value. (Trading Networks does not extract attributes for unknown TN document types. Value along with the operator. The attribute has no value if the XQL query for the custom attribute (in the TN document type) did not identify a node in the document. webMethods Trading Networks User’s Guide Version 6. Trading Networks returns specific values for different attribute data types. Trading Networks might still have a null value for the attribute. The TN document type of the document is unknown.Extended Criteria—Using Custom Attributes Data Type DATETIME Operator Is null Matches when the attribute extracted from a document… Has no value. Is not null Equals Before After DATETIMELIST Is null Has any value. The following lists reasons this might occur: The XQL query for the custom attribute (in the TN document type) did not identify a node in the document. You do not need to specify a value when you specify this operator. Matches exactly the value that you specify. You do not need to specify a value when you specify this operator. instructs Trading Networks how to match documents based on the value of the attribute extracted from the documents. Even when a document contains the attribute information that you specify. The attribute has no value if the XQL query for the custom attribute (in the TN document type) did not identify a node in the document. For more information about these extraction values. Is a date that is after the date that you specify.) Note: For custom attributes that are extracted from an XML document.

To do this. processingRuleName—The name (a String) of the processing rule you want Trading Networks to execute for the flat file document. For more information about these attributes and TN_parms. If you reprocess a document.tn. For more information about the pre-processing actions. Trading Networks will match to another processing rule. Trading Networks only selects the processing rule if all the criteria you specify match. Be careful not to specify a rule that may process your documents inappropriately. If you reprocess a document for which Trading Networks did not save the attributes. invoke the wm. Bypassing Lookups for Processing Rules As previously mentioned. For example. assume the following rules are defined to process purchase orders: Rule 1: Execute for orders >$10000 2: Execute for orders <$10 3: Execute for all other orders Action Perform special handling Discard order Perform standard handling 326 webMethods Trading Networks User’s Guide Version 6. you can still use extended criteria for the document. you can explicitly specify which processing rule to execute for a given document type. processingRuleID is used.5 . see “Processing a Saved Document Again” on page 452. see “Pre-Processing Actions” on page 327. for example the default processing rule. Alternatively. If you include values for both attributes (which is unnecessary). However. and perform the process actions identified in that matching rule.CHAPTER 14 Processing Rules You can specify multiple custom attributes in the extended criteria. it performs a processing rule lookup to determine which processing rule to use for a specific document. Trading Networks does not save the custom attributes. Instead. thus bypassing the lookup (and its overhead). see “Specifying the Document Gateway Services Outputs” on page 280. Trading Networks does not recognize the TN document type again and therefore does not re-extract the attributes.route:list service. Note: If the pre-processing actions do not indicate that Trading Networks is to save the attributes. for each document that Trading Networks is to process. For more information about reprocessing a document. add one of the following system attributes to the TN_parms output variable in your document gateway service: processingRuleID— The Trading Networks-generated identifier (a String) of the processing rule you want Trading Networks to execute for the flat file document. To find this identifier. Trading Networks will not match processing rules that use extended criteria.

Document ID. Trading Networks performs the pre-processing actions in the following order. Use preprocessing actions to instruct Trading Networks to: Verify Digital Signature—Trading Networks verifies the digital signature of a document. Trading Networks matches the certificate from the digital signature to the certificate that Trading Networks has on file for the partner. that is. Pre-Processing Actions Trading Networks performs pre-processing actions before it processes the document using the processing rule actions. Trading Networks assures that the document matches the structure identified by the IS schema (using the pub. sender and document type—Trading Networks assures that it does not already have a document with the same document ID. if it has already received the document. webMethods Trading Networks User’s Guide Version 6.Pre-Processing Actions If you assign the rule 2 identifier as the value of processingRuleID. To verify that the document arrived unchanged. Check for Duplicate Document—Trading Networks determines if there is a duplicate of the document. and TN document type in its database.5 327 . sender. Document ID. You can have Trading Networks determine whether the document is a duplicate using a built-in or custom duplicate check service or have Trading Networks not check for a duplicate document. Built-in services—Use one of the following built-in duplicate checks: Document ID only—Trading Networks assures that it does not already have a document with same document ID in its database. sender.schema:validate built-in service). You can specify pre-processing actions in both the TN document type and the processing rule. Validate Structure—Trading Networks validates the structure of the document against an IS schema. and an application submits an order greater than $10. Trading Networks checks the document being processed against documents it has in its database. sender and receiver—Trading Networks assures that it does not already have a document with the same document ID. To verify that the sender is who it claims to be. Trading Networks assures the signed body has not changed by verifying the digital signature. rule 2 will discard the order. Document ID and sender—Trading Networks assures that it does not already have a document with same document ID and sender in its database. You specify the pre-processing actions in the processing rule to override the actions that are specified in the TN document type. and receiver in its database.

For more information about pre-processing actions for XML documents. see below. Trading Networks will bypass reliable delivery and invoke the specified delivery service once. For more information about pre-processing actions for flat file documents. and/or activity log information to the database. Save Document to Database—Trading Networks saves a copy of the document content. Trading Networks saves the results of the duplicate check to the pipeline. "Setting up Trading Networks to Process Documents" and Chapter 6.CHAPTER 14 Processing Rules Custom services—Use a service that you create to determine whether a document is a duplicate. see Chapter 3. For more information. 328 webMethods Trading Networks User’s Guide Version 6. this information is available for use in the processing actions that you define in the processing rule. for example. Note: There could be performance issues if you choose to use custom services for duplicate checking based on the logic in the service you select. “Creating a Duplicate Document Check Service”. you can indicate in the processing rule that you want Trading Networks to: Use the setting in the TN document type Perform the pre-processing action regardless of the setting in the TN document type Not perform the action regardless of the setting in the TN document type For more information about pre-processing options. Certain delivery options require saving the document content to the database. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. If you do not select to save the document content and Trading Networks is to use a delivery option that requires document content to be saved. As a result. For all pre-processing actions. attributes.5 . if you want to deliver a document via a queue. Trading Networks uses the results of the duplicate check in the Save Document to Database pre-processing action. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 227. see “Pre-Processing Actions in the TN Flat File Document Type” on page 294.

You can define the processing rule actions to instruct Trading Networks either to ignore the document (that is.Processing Rule Actions Creating a Duplicate Document Check Service The service must implement the input and output variables that are defined in the wm. Processing Rule Actions The purpose of the actions in a processing rule is to specify how Trading Networks is to process a document.5 329 . the webMethods system administrator. When Trading Networks finds the processing rule to use for a document (using the criteria).. see the webMethods Trading Networks Built-in Services Reference. Change the user status for the document. For more information about this specification. Trading Networks passes the following input variables: Input Value bizdoc Meaning The BizDocEnvelope that represents the document to perform the duplicate document check on. Send an alert e-mail message to one of the contacts defined for the sender of the document. Trading Networks passes the following output variables: Output Value duplicate Meaning String Whether the service determined the document is a duplicate. Deliver the document to the receiver using a defined delivery method. Primary HTTP. You can have Trading Networks invoke the service synchronously or asynchronously.tn. The service should return either true or false for duplicate. do nothing) or to perform one or more of the following actions in the order listed below: Execute a service that you specify.rec:DupCheckService specification. Trading Networks performs the actions specified in the processing rule to process the document. webMethods Trading Networks User’s Guide Version 6. one of the contacts defined for the receiver of the document. The specification is located in the WmTN package.g. For duplicate checking services. The BizDocEnvelope conforms to the wm. e.tn. Respond to the caller with a message that you specify. or another e-mail that you specify.rec:BizDocEnvelope IS document type.

the service that you want to invoke must exist on the Integration Server. see Chapter 5.5 . "Trading Networks Document Processing" in the webMethods Trading Networks Concepts Guide. The following lists the prerequisite to using the Execute a service action. Trading Networks logs the error in the activity log and continues. see “Creating Services that Recognize Large Document Handling” on page 544. and deliver the document to the receiver. In addition. Prerequisite Before you can use the Execute a service action. attempting to send the alert e-mail message and deliver the document to the receiver. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. you specify the service you want Trading Networks to execute and whether you want Trading Networks to invoke the service synchronously or asynchronously.CHAPTER 14 Processing Rules If you select to have Trading Networks perform more than one of the above actions. When you use the Execute a service action. you can access the Developer from the Processing Rules screen to create the service. if you select to execute a service. In this situation. you can execute a service to send the document to a back-end system for processing or change the content of the document before sending it to the receiver. Delivery methods you can use. For more information about Processing rule actions. 330 webMethods Trading Networks User’s Guide Version 6. if the service specified in the rule does not exist. If Trading Networks encounters an error performing one of the actions. send an alert e-mail message. you can optionally set input values to hardcode input values for the service. For example. For example. For example. it will continue to attempt the other actions. Action 1—Execute a Service Use the Execute a service action to have Trading Networks invoke a service that you specify. Trading Networks performs the actions in the order listed above. Trading Networks will receive an error attempting to invoke the service. If the service does not exist. Trading Networks performs the actions in that order. see Chapter 6. Note: If you are using large document processing. The service can perform any action you want.

For more information about service execution tasks. The results of the service are not available in the pipeline for the other processing actions. asynchronous and service execution task Trading Networks processes the actions immediately. The following table describes the behavior of Trading Networks based on whether you use synchronous. or service execution task: Trading Networks Behavior for the Execute a service Action When does Trading Networks process subsequent processing actions? synchronous Trading Networks waits for the service to complete before it performs the rest of the processing actions. Trading Networks immediately returns to the caller that sent the document for processing. If there are no subsequent processing actions. Asynchronous—Trading Networks attempts to asynchronously execute the service a single time. Trading Networks uses reliable execution to re-execute the service one or more times if the service fails.5 331 . If there are no subsequent processing actions. asynchronous. webMethods Trading Networks User’s Guide Version 6. Trading Networks waits for the service to complete before returning to the caller that sent the document for processing. Service execution task—Trading Networks sets up a service execution task for the asynchronous execution of the service. Trading Networks merges the results from the service into the pipeline. you select one of the following: Synchronous—Trading Networks attempts to synchronously execute the service a single time. see “Service Execution Tasks and Reliable Execution” on page 333. This allows you to use the service results in output templates or in other processing actions.Processing Rule Actions Executing the Service Synchronously or Asynchronously To specify that you want Trading Networks to execute a service synchronously or asynchronously.

Trading Networks returns no additional information to the caller. It returns only the message that you specify with the Respond With action. What if the service throws an exception or does not exist at runtime (i. This includes the results of the service.CHAPTER 14 Processing Rules Trading Networks Behavior for the Execute a service Action What does Trading Networks return to the caller? synchronous If you do not select the Respond With processing action.e. Trading Networks returns the message that you specify with the Respond With action.. Trading Networks does not return the results of the service to the caller. Trading Networks cannot return the results of the service because the service might not be complete. If you do select the Respond With processing action. it was deleted since you created the processing rule)? synchronous.5 . asynchronous and service execution task Trading Networks logs the error to its activity log and continues with the other actions in the processing rule. if any. If you do select the Respond With processing action. However. because Trading Networks performs the Respond With action after it executes the service all information that the service places in the pipeline is available for use in the message that Trading Networks returns to the caller. 332 webMethods Trading Networks User’s Guide Version 6. asynchronous and service execution task If you do not select the Respond With processing action. the results of the service are returned unmodified to the caller that sent the document for processing.

Trading Networks attempts to execute the service subsequent times until the service succeeds or until Trading Networks reaches the maximum retry limit. Trading Networks sets up a service execution task to execute your service.transport.) webMethods Trading Networks User’s Guide Version 6. see “Configuring Tasks Settings” on page 52. When using reliable execution. Trading Networks marks the service execution task as failed. Trading Networks uses the Administrator user account to invoke services.5 333 . A service execution task is a task that Trading Networks performs to asynchronously execute a service using reliable execution. If Trading Networks attempts to execute a service and the service fails. For more information about this property. To determine whether a service was successful or failed. see “Trading Networks Configuration Properties” on page 42. If Trading Networks has reached the maximum retry limit and the service has not successfully executed. When you configure Trading Networks. Service Execution Task Setting Maximum Retries Wait Between Retries Description The number of times you want Trading Networks to attempt to re-execute a service.user property to indicate the user account to use when invoking the service. For instructions on how to configure these settings. Reliable execution is a feature of Trading Networks that allows Trading Networks to automatically retry failed services. The following table lists the system-wide settings for service execution tasks that you can configure. Trading Networks evaluates the value of the status output variable. (Trading Networks uses the Retry Factor along with the Wait Between Retries value to calculate how long to wait for subsequent retry attempts. By default. Your service must set the value of the status output variable to “success” if the service executed successfully or set the value to “fail” if the service did not succeed. The number of milliseconds (ms) you want Trading Networks to wait before making its first attempt to re-execute the service. see “Defining a Processing Rule Based on a Saved Document” on page 361. you define the system-wide settings for service execution tasks. Use the Trading Networks tn.Processing Rule Actions Service Execution Tasks and Reliable Execution When you select service execution task. For more information about the output variables that your service should return. There are also other settings that indicate the maximum number of times that Trading Networks attempts to re-execute a failed service and how long Trading Networks is to wait between the attempts to retry a service after a failed attempt. Trading Networks uses these settings to establish the parameters for the service execution task that governs the execution of the service.

Trading Networks waits 10000 milliseconds before it makes its first retry attempt. Trading Networks multiplies the last wait value (20000 ms) by the Retry Factor (2). This results in 40000 ms. Trading Networks determines the next retry wait period by multiplying the last wait value (10000 ms) by the Retry Factor (2).5 . Trading Networks waits 40000 ms between the second retry attempt and the third retry attempt. Example: The following shows sample values for the settings described in the table above and how they affect the wait times between attempts to re-execute a service. For more information about managing and tracking service execution tasks. Trading Networks calculates the time to wait by multiplying the last wait time by the value you specify for Retry Factor. 334 webMethods Trading Networks User’s Guide Version 6. You can view information about service execution tasks using the Tasks screen of the Trading Networks Console. This results in 20000 ms. Maximum Retries Wait Between Retries Retry Factor Wait until next attempt = = = 3 10000 ms 2 Retry 2 20000 ms Retry 3 40000 ms Retry 1 10000 ms With the above settings. Trading Networks keeps track of the progress and status of each service execution task. If you can correct the problem. you can restart the service execution task to have Trading Networks attempt to execute the service again. If the service execution task fails.CHAPTER 14 Processing Rules Service Execution Task Setting Retry Factor Description The factor you want Trading Networks to use when determining how long to wait before making the second and subsequent attempts to re-execute the service. you can troubleshoot the problem. if the original attempt to execute the service fails. “Service Execution Tasks”. If the first retry attempt fails. see Chapter 20. If the second retry attempt fails. Trading Networks waits 20000 ms between the first failed retry attempt an the second retry attempt.

The input values that are identified in the specification are the IS documents (IData objects) that are in the pipeline during processing. asynchronous. The specification is located in the WmTN package. use the webMethods Developer.5 335 .tn. The specification does not identify any outputs. or service execution task.tn. the input and output variables that are defined in the wm.rec:ReliableProcessingService specification.rec:ProcessingService specification. Trading Networks does not require the service to have specific output values. the input variables that are defined in the wm. The serviceOutput variable is an IS document (IData object) that contains the following String variables: webMethods Trading Networks User’s Guide Version 6. Your service must specify output values that indicate the outcome of the service. See below for additional information about setting the output variables. if you use service execution task. To view the wm.Processing Rule Actions Creating the Service for the Execute a Service Processing Action You create the service that Trading Networks invokes for the Execute a Service processing action.rec:ProcessingService specification. The input values that are identified in the specification are the IS documents (IData objects) that are in the pipeline during processing. However. at a minimum. your service must provide values for the serviceOutput output variable.rec:ReliableProcessingService specification. Input and Output Variables for the Service The following table describes the specification you should use for the service based on whether you select synchronous. The specification is located in the WmTN package.tn. If you use synchronous or asynchronous. Method synchronous and asynchronous Specification You Must Use The service must implement.tn. at a minimum. service execution task The service must implement. use the webMethods Developer. To view the wm.

“Service Execution Tasks”.5 .CHAPTER 14 Processing Rules Variable in the serviceOutput Specify… Whether the service executed successfully or unsuccessfully. Your service must provide one of the following values for the reliable execution feature of Trading Networks to operate correctly: Value success status Meaning The service executed successfully. in addition to the input values specified in the wm. Trading Networks updates the status of the service execution task for this service to DONE. such as.rec:ReliableProcessingService specification. you might want to hardcode some of the values. If the maximum retry limit has not yet been reached. Specify this value if you want to maintain analytical information about how long it took the service to execute.tn.tn.rec:ProcessingService or wm. the number of times Trading Networks has attempted to retry the service. Trading Networks does not attempt to execute the service again. Setting Values for the Input Variables If you create a service that requires input values. an error message that explains why the service failed. The number of milliseconds it took for the service to execute. It is recommended that you provide information for statusMessage if the service fails. it also displays other task-related information. A message that contains more information about the outcome of the service. When your service returns this value. For instructions on how to view tasks. the status of the service execution task remains PENDING and Trading Networks will attempt to re-execute the service after the wait period elapses. You can do this when you set up the processing rule. 336 webMethods Trading Networks User’s Guide Version 6. Optional. for example. transportTime Trading Networks displays the output information described above on the Task Details screen of the Console. Trading Networks updates the status of the service execution task for this service to FAILED. see information about managing tasks in Chapter 20. statusMessage Optional. If the maximum retry limit has been met. In addition. fail The execution of the service failed.

You can create three separate processing rules that all execute this service. and processing rule in the WmTnSamples/config directory. set the input value of the flag to indicate the service should update an entry. set the input value of the flag to indicate the service should add an entry. To run the sample.sample. The second time. Trading Networks will flag the document as a duplicate. update. Input to the service is a flag that indicates the action the service is to take—add. You might want to perform different processing based on whether Trading Networks encountered errors during previous processing.sample..tn. you might create a service that can add. Logic for the Service This service can perform any logic that you want.docError:errorCheck resides in the WmTNSamples package. update.5 337 . For the processing rule that is triggered by a document for which you want to update an entry. The sample service wm. For more information about creating the service.Processing Rule Actions For example. webMethods Trading Networks User’s Guide Version 6. or delete. the document will not be a duplicate. For the processing rule that is triggered by a document for which you want to add an entry. and Trading Networks also provides a sample document. whether a document is a duplicate. or delete an entry for a partner in your back-end system.g. However.docError:errorCheck that demonstrates how to detect for the duplicate document errors in a BizDocEnvelope. submit the document to Trading Networks two times. you set the input values for the flag different for each processing rule. and so on. Trading Networks provides a sample service wm. matching TN document type. e.tn. The first time. see the webMethods Developer User’s Guide.

Trading Networks looks in the sender’s profile for the e-mail addresses of all contacts of the type you selected. 338 webMethods Trading Networks User’s Guide Version 6. Do this by specifying the address of the Simple Mail Transfer Protocol (SMTP) server through which the Integration Server is to issue e-mail messages. see the webMethods Integration Server Administrator’s Guide. Prerequisite Before you can use the Alert e-mail action.CHAPTER 14 Processing Rules Action 2—Send an Alert E-mail Use the Alert e-mail action to send an e-mail message to a specified contact. The following lists the prerequisite to using the Alert e-mail action. Trading Networks logs the error to its activity log and continues with the other actions you specified in the processing rule. your Trading Networks system must be set up to allow Trading Networks to send e-mail messages. Click Save Changes. Recipient of the E-mail Message You can use one of the following as the recipient of the e-mail message: If you select… Sender Specify… The sender’s contacts that are to receive the e-mail message. and the body (or content) of the e-mail message. In the Email Notification section of the screen. Trading Networks will be unable to determine an e-mail address. If you need instructions for starting the webMethods Administrator. For example. 2 3 4 5 When you use the Alert e-mail action. use the following procedure: 1 Start the webMethods Administrator. if any. If the sender is unknown or if the contact type you specify is not defined in the sender’s profile. In this situation. set the SMTP Server field to the domain name or IP address of the SMTP server that you want the Integration Server to use. As a result. In the Settings menu of the navigation menu. click Logging. select “Administrative”. Click Edit logging settings. you specify the recipient that is to receive the e-mail message. if you want Trading Networks to send the e-mail message to the sender's administrative contacts. Trading Networks will be unable to send the e-mail message. the subject line for the e-mail message.5 . To specify the address of the SMTP server.

if you want Trading Networks to send the e-mail message to the receiver's technical contact. Trading Networks will be unable to send the e-mail message. specify it. in addition to specifying the SMTP server. In this situation. If an e-mail address is not specified. assure the e-mail address for the webMethods administrator is defined. Trading Networks will be unable to determine an e-mail address. Trading Networks logs the error to its activity log and continues with the other actions you specified in the processing rule. webMethods Administrator No additional information is required. In this situation. Trading Networks logs the error to its activity log and continues with the other actions you specified in the processing rule. In this situation. Do this using the webMethods Administrator.5 339 . Follow the steps specified in the “Prerequisites” section above. As a result. Before you select webMethods Administrator. E-mail Address The e-mail address of the recipient that is to receive the e-mail message. if any. specify “Technical”. if any. assure an e-mail address is specified for Internal Email field.Processing Rule Actions If you select… Receiver Specify… The receiver’s contacts that are to receive the e-mail message. Trading Networks logs the error to its activity log and continues with the other actions you specified in the processing rule. Trading Networks looks in the receiver’s profile for the e-mail addresses of all contacts of the type you selected. Trading Networks will be unable to send the e-mail message. If the receiver is unknown or if the contact type you specify is not defined in the receiver’s profile. Trading Networks will be unable to send the e-mail message. If the e-mail address you specify is not valid. on page 338. if any. webMethods Trading Networks User’s Guide Version 6. Trading Networks sends the e-mail message to the webMethods administrator. For example. If the webMethods administrator is not defined. However. in Step 4.

For example. You might also want to include a hyperlink that allows the recipient of the e-mail message to view the document. To include information from the pipeline.5 . bold text is used for the output template tags.) If the TN document type is “Purchase Order”.CHAPTER 14 Processing Rules Subject of the E-mail Message You can type any subject line for the e-mail message. The following shows the text you might specify for the body. the sender's corporation name is “Industrial Steel Company”. Body of the E-mail Message You can type any message for the body of the e-mail message. you might want the e-mail message to specify the type of document that was received and from whom it was received. There are no restrictions to the length or characters that you can use. and the organizational unit is “Alloys Division”. (For illustrative purposes. use output template tags. To make the body dynamic. There are no restrictions to the length or characters that you can use. the following shows how the above sample e-mail message body would be rendered: 340 webMethods Trading Networks User’s Guide Version 6. you can include information from the pipeline in the body.

5 341 . This preferred delivery method can be an immediate delivery or queued for polling. you can specify one of four ways to deliver a document—immediate delivery. webMethods Trading Networks (Trading Networks) attempts to deliver a document to the receiver that is identified in the document. If you select preferred protocol.Processing Rule Actions Trading Networks received a Purchase Order document from Industrial Steel Company--Alloys Division. queued for polling.tn. To determine the purchase orders that are waiting for approval. see the Dynamic Server Pages and Output Templates Developer’s Guide manual. you can send an alert e-mail message to the person responsible for approving the purchase order and set the user status to “pending approval”. the pipeline contains the information described in “Action 1—Execute a Service” on page 330. In the processing rule. For example. the pipeline also contains any information that the service placed in the pipeline. webMethods Trading Networks User’s Guide Version 6. The TN document type can be defined to extract a user status from the document. Trading Networks looks up the receiver’s profile and uses the delivery method that is identified as that partner’s preferred delivery method. If the TN document type does not instruct Trading Networks to extract the User Status system attribute or if the XQL query for the User Status system attribute (specified in the TN document type) does not identify a node in the document. You can specify 1-255 characters for the user status. Action 3—Change User Status Use the User Status action to change the user status that is associated with a document. In addition. For details about the output template tags that you can use. The User Status action is useful to assign a status to a document that you will use when performing document queries or generating reports. or preferred protocol.doc/view?docId=000233AB907ED1234 When Trading Networks executes the Alert E-mail action. In this case. scheduled delivery. you can query documents searching for documents with the user status “pending approval”. There is no restriction to the characters you can use for user status. which gives the user status an initial value. if the processing rule specifies the Execute a service action and the service is executed synchronously. the initial value of user status is null. Action 4—Deliver the Document to the Receiver When a processing rule includes the Deliver Document By processing action. you specify the status that you want Trading Networks to associate with the document. The user status is a status that you can associate with a document. When you use this processing rule action. You can view the document at http://wMTN:5555/invoke/wm. you might require that purchase orders be approved.

The following lists the prerequisite to using the Deliver Document By action. Trading Networks invokes the delivery service to deliver a document to a trading partner. see “Information on the Partner’s Delivery Method Tab” on page 137. the TN document type must indicate that Trading Networks is to extract the ReceiverID system attribute from the document. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. Trading Networks uses the receiver information to determine the partner to which to deliver the document. An immediate delivery service is a service that acts on a single document to delivery the document to a single partner. In addition to the above delivery methods. If the service does not update the receiver. Trading Networks will not deliver the document to the partner that service specified as the receiver – unless that service updates the receiver in the bizdoc in the pipeline.CHAPTER 14 Processing Rules Important! Trading Networks uses the receiver that is extracted from the document. If you use the Execute a service action and the executed service updates the receiver identified in the original document. see Chapter 6. For more information about Delivery methods in Trading Networks.) that Trading Networks provides is associated with a built-in immediate delivery service that Trading Networks provides. Secondary HTTP. webMethods provides the following immediate delivery methods: Primary E-mail Primary FTP Primary FTPS Primary HTTP Primary HTTPS Secondary E-mail Secondary FTP Secondary FTPS Secondary HTTP Secondary HTTPS Each immediate delivery method (Primary HTTP. 342 webMethods Trading Networks User’s Guide Version 6.5 . Trading Networks delivers the document to the receiver identified when it initially received the document for processing. etc. you can create immediate delivery services and register them with Trading Networks to define your own custom immediate delivery methods. Delivery information on the partner’s profile. Prerequisite To use the Deliver Document By action. Immediate Delivery When the Deliver Document By processing action indicates Immediate Delivery. Trading Networks attempts to deliver a document directly to the receiving partner.

To keep track of the attempts to deliver a document. Trading Networks establishes a delivery task. see Chapter 6. The number of milliseconds (ms) you want Trading Networks to wait before making its first attempt to redeliver the document. Trading Networks automatically uses reliable delivery to deliver a document to a partner one or more times based on the settings that you define in the profile for each of your partners. Note: You can also use reliable delivery by invoking the built-in service. Immediate delivery services. (Trading Networks uses the Retry Factor along with the Wait Between Retries value to calculate how long to wait for subsequent retry attempts when delivering documents using an immediate delivery method. see “What is an Immediate Delivery Service?” on page 410. Using Reliable Delivery with Immediate Delivery Method If the pre-processing actions specify that Trading Networks is to save the document content to its database.5 343 . Trading Networks uses these settings to establish the parameters for the delivery task that governs the delivery of the document. Trading Networks calculates the time to wait by multiplying the last wait time by the value you specify for Retry Factor. The following table lists the reliable delivery settings that you define in the Delivery Method tab of the partner’s profile. wm. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide.tn.) The factor you want Trading Networks to use when determining how long to wait before making the second and subsequent attempts to redeliver the document when using an immediate delivery method. Reliable Delivery Setting Delivery Maximum Retries Wait Between Retries Description The number of times you want Trading Networks to attempt to redeliver a document.Processing Rule Actions For more information about Immediate delivery methods. Retry Factor webMethods Trading Networks User’s Guide Version 6. When using reliable delivery with an immediate delivery method.delivery:deliver.

For more information about Scheduled delivery. Trading Networks batches documents that are then delivered at scheduled times. Using Reliable Delivery with Scheduled Delivery Trading Networks automatically uses reliable delivery for a scheduled delivery method. Once you select a queue for the scheduled delivery method. see “Scheduled Delivery Queues” on page 378. Each queued delivery task that is associated with a document is a row in the same table of the Trading Networks database. Trading Networks looks up a queue in the receiver’s profile. You can select to use a public queue or to use a specific partner’s private queue. Reliable delivery is a feature of Trading Networks where Trading Networks attempts to deliver a document to a partner one or more times based on settings that you define.CHAPTER 14 Processing Rules For more information about Delivery options.. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. Trading Networks supports two types of queues—public queues and private queues. see Chapter 6. Note: If you select Receiver’s Queue. see Chapter 6. Trading Networks makes the document pollable (Queue for polling). It is a set of rows in the Trading Networks database. Trading Networks also creates the delivery task for the document and places the delivery task in the queue specified by the processing rule. “Delivery Tasks”. Scheduled Delivery When the Deliver Document By processing action indicates scheduled delivery. For scheduled delivery. then Trading Networks will be unable to deliver the document by this method and instead. Public/Private queues and scheduled delivery.5 . Delivery tasks. does not define a queue). The queue specified in the processing rule is a scheduled delivery queue that you have previously defined. Note: The queue is not a queue in the traditional sense. the next time Trading Networks runs a scheduled delivery service and reads documents from that specified queue. all documents in that queue will be delivered.e. see Chapter 19. To specify how many times Trading Networks attempts to re-deliver a document that is 344 webMethods Trading Networks User’s Guide Version 6. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. If the receiver’s profile does not contain a queued delivery method (i.

Customized delivery services.5 345 . Note: You can also use reliable delivery by invoking the built-in service. Reliable Delivery Setting Delivery Maximum Retries Description The number of times you want Trading Networks to attempt to redeliver a document. Delivery tasks. you define reliable delivery settings in the profile for each of your partners. Trading Networks establishes a delivery task. but the receiving partner’s profile does not contain a queued delivery webMethods Trading Networks User’s Guide Version 6. “Scheduled Delivery Queue States” on page 390 Scheduled delivery services. wm. see Chapter 19. for example. When using reliable delivery with a scheduled delivery method. Secondary HTTPS is specified but the profile does not contain a Secondary HTTPS delivery method. Unlike for the immediate delivery method. see “What is a Scheduled Delivery Service?” on page 410. see “Information on the Partner’s Delivery Method Tab” on page 137.Processing Rule Actions scheduled for delivery. Or. another example is that if the scheduled delivery method is Receiver’s Queue. “Delivery Tasks” Queued for Polling Trading Networks queues a document for polling when the Deliver Document By processing action indicates one of the following: The Queue for polling selection The Receiver’s Preferred Protocol selection and the preferred protocol (delivery method) is Queue for polling The receiving partner’s profile does not specify a delivery method. For more information about Delivery information on the partner’s profile. Trading Networks does not use the Wait Between Retries and Retry Factor settings for reliable delivery with scheduled delivery because the queue’s delivery schedule dictates how often to retry delivery attempts. Trading Networks only uses only the following reliable delivery setting that you define in the Delivery Method tab of the partner’s profile.tn.delivery:deliver. see “Adding and Registering New Delivery Services” on page 421. To keep track of the attempts to deliver a document.

For more information about Delivery options. it places the document in an internally-defined queue. 346 webMethods Trading Networks User’s Guide Version 6.g. see Chapter 6. see “Defining Queue for Polling” on page 394. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. When you use the Respond With action. Queue for polling. Instead. For more information about Partner’s preferred delivery method. you can create customized delivery services and register them with Trading Networks to define your own custom delivery methods. see “Information on the Partner’s Delivery Method Tab” on page 137. Trading Networks waits for a partner to poll for the documents. Trading Networks returns all the documents in the queue for which that partner is the receiver. HTTP) to use to poll for the document and how frequently to poll for documents. Action 5—Respond With a Message Use the Respond With action to have Trading Networks return a specified message to the caller that sent the document to be processed. Customized delivery services.CHAPTER 14 Processing Rules method (i. Trading Networks looks up the receiver’s profile and uses the delivery method that is identified as that partner’s preferred delivery method. does not define a queue). then Trading Networks makes the document pollable (Queue for polling). In addition to the above delivery methods. When a specific partner polls for documents. you must specify the message you want Trading Networks to return and the content type of the message.e. Trading Networks does not deliver the documents that are in this queue. The receiving partners define the protocol (e. This preferred delivery method can be an immediate delivery or queued for polling. When Trading Networks queues the document for polling. see “Adding and Registering New Delivery Services” on page 421.5 .. Preferred Protocol If you select Receiver’s Preferred Protocol..

webMethods Trading Networks User’s Guide Version 6.sync. the servers must set the tn.cluster. The message you specify is the acknowledgement that is returned. This action returns the confirmation that the purchase order was received and processed. specify the content type.remoteAliases property correctly. you can include information from the pipeline in the body. text/xml. There are no restrictions to the length or characters that you can use. Defining Processing Rules Use this procedure to define a processing rule on the Processing Rule Details screen. for example. The pipeline contains the information described in “Action 1—Execute a Service” on page 330 of this user’s guide. interfacing with a back-end system. or if the message is in plain text. specify the content-type text/plain. all Trading Networks servers must be set up for cluster synchronization.Defining Processing Rules Specifying the Message You can type any message. use output template tags. For details about the output template tags that you can use. For more information about how to configure Trading Networks for a clustered environment. if the processing rule specifies the Execute a service action and the service is executed synchronously. To include information from the pipeline. That is. In addition. Specifying the Content Type In addition to specifying the message. For example. see “Shared Database in a Clustered Environment”. the pipeline also contains any information that the service placed in the pipeline. see the Dynamic Server Pages and Output Templates Developer’s Guide manual. Note: If you are working in a clustered environment. You can set up a processing rule that uses the Execute a service action and the Respond With action: The Execute a service action could asynchronously invoke a service that performs the appropriate processing for the purchase order.5 347 . To make the body dynamic. if the message is an XML document. An example of using the Respond With action would be to send an acknowledgement for a purchase order. The Respond With action could return an acknowledgement that just indicates that the purchase order was received. you must indicate the content type of the message.

Method to start a processing rule Add — To add a new processing rule in a specific order relative to a selected processing rule. Trading Networks adds the new rule to the bottom of the processing rules list.CHAPTER 14 Processing Rules To define a processing rule 1 2 Start the Trading Networks Console. Duplicate— Add a new processing rule that is a duplicate of an existing one.5 . Select Rules following: a b c Add and then one of the Above— Add a new processing rule above the highlighted processing rule. All other processing rules keep their original ordinal numbers. 1) 348 webMethods Trading Networks User’s Guide Version 6. Note: Make sure you place the Default processing rule in the last position in the filter processing rules list. see “Starting the Trading Networks Console” on page 22. Click the row containing the processing rule that you want to duplicate. If you need procedures for this step. Below— Add a new processing rule below the highlighted processing rule. For more information about the default processing rule. For more information about adding processing rules. see “Setting Up a Default Processing Rule” on page 362 3) Trading Networks displays a blank Processing Rule Details screen for you to complete. see “Adding Processing Rules and the Order of Processing Rules” on page 313 Procedures 1) 2) Click the row where you want to add the new processing rule. Select View Processing Rules. Last—Add a new processing rule to the bottom of the full unfiltered processing rules list. Perform one of the following procedures to add a new processing rule.

Specify 1-255 characters. Trading Networks lists the name of the Enterprise profile in parentheses. There is no restriction to the characters that you can use. Procedures 2) Select Rules Duplicate.5 349 . Select one of the following: Any to use this rule for documents regardless of the sender. 3 On the Processing Rule Details screen. deselect the default Enabled field. If you do not want this processing rule to be enabled. see “Processing Rule Criteria” on page 317. Optionally. For more information. Trading Networks copies the processing rule fields with values from the processing rule that you duplicate. webMethods Trading Networks User’s Guide Version 6. Click the Criteria tab and fill in the fields to identify documents that should be processed using this rule. specify the name you want to give the processing rule in the Name field. For this Criteria tab parameter… Sender 4 5 6 Specify… The sender(s) identified in the documents that you want to process with this rule. A document must meet all the criteria that you specify on both the Criteria and Extended Criteria tabs for Trading Networks to use the processing rule to process the document. Unknown to use this rule for documents for which the sending partner is not known. There is no restriction to the characters that you can use. Specify 1-64 characters. specify a description for the processing rule in the Description field. Enterprise to use this rule for documents that identify the local partner (the partner that is the hub of the trading network) as the sender.Defining Processing Rules Method to start a processing rule You can update any or all fields from the duplicated processing rule.

Click OK.. c To specify a partner profile group: a b Click the Select Profile Group(s). button. see “Selecting a Partner” on page 34. Trading Networks lists the name of the Enterprise profile in parentheses. For more information about the Select Profile Group(s).5 . 350 webMethods Trading Networks User’s Guide Version 6... Receiver The receiver(s) identified in the documents that you want to process with this rule. Select one of the following: Any to use this rule for documents regardless of the receiver. c For more information about these processing rules fields. button. button.. button.CHAPTER 14 Processing Rules For this Criteria tab parameter… Specify… Selected to use this rule for documents that identify one or more of the specified partner profiles and/or partner profile groups as the sender. You can select multiple partner profile groups using the <Shift> and <Ctrl> keys. Select a partner profile group from the Partner Groups Dialog. see “Selecting a Partner” on page 34. To specify a partner profile: a b Click the Select Profile(s). Unknown to use this rule for documents for which the receiving partner is not known. Click OK. Select a partner profile from the Partner Selection Dialog. For more information about the Select Profile(s). You can select multiple partners using the <Shift> and <Ctrl> keys... Enterprise to use this rule for documents that identify the local partner (the partner that is the hub of the trading network) as the receiver. see “Sender and Receiver Criteria” on page 317...

Select one of the following: Any to use this rule for documents regardless of the TN document type. webMethods Trading Networks User’s Guide Version 6. see “Selecting a Partner” on page 34..... Select a partner profile from the Partner Selection Dialog.. Click OK. c To specify a partner profile group: a b Click the Select Profile Group(s). button. For more information about the Select Profile Group(s). Document Type The TN document type(s) of the documents that you want to process with this rule. For more information about the Select Profile(s). see “Selecting a Partner” on page 34. To specify a partner profile: a b Click the Select Profile(s). Unknown to use this rule for documents with unknown TN document types. see “Sender and Receiver Criteria” on page 317. c For more information about these processing rules fields.. button.Defining Processing Rules For this Criteria tab parameter… Specify… Selected to use this rule for documents that identify one or more of the specified partner profiles and/or partner profile groups as the receiver. button.. Click OK.. You can select multiple partner profile groups using the <Shift> and <Ctrl> keys. Select a partner profile group from the Partner Groups Dialog. button.5 351 .You can select multiple partners using the <Shift> and <Ctrl> keys.

Type each user status you want to allow on a separate row in the table. see “Document Recognition Errors Criterion” on page 321 . Has errors to use this rule for documents that contain errors. see “Document Type Criterion” on page 319 User Status The user status of the documents that you want to process using this rule. Select one of the following from the list: May have errors to use this rule for documents regardless of whether the document contains errors. delete the row containing the user status by clicking Delete Selected For more information about these fields. You can select multiple partners using the <Shift> and <Ctrl> keys. To remove a user status from the table. For more information about using this button. see “Selecting TN Document Types” on page 36. 352 webMethods Trading Networks User’s Guide Version 6. type the user status. Has no errors to use this rule for documents that do not contain errors. To specify TN document types: a b Click the Select Document Type button. c For more information about these fields. then. Click OK. Select the row containing the TN XML document type or TN flat file document type that you want from the Document Type Selection Dialog. To add a user status to the table.5 . click Add New to add a row. see “User Status Criterion” on page 319. Specified to use this rule for documents with the specified user statuses. For more information about these fields. Recognition Errors Whether the documents that you want to process using this rule contain errors.CHAPTER 14 Processing Rules For this Criteria tab parameter… Specify… Selected to use this rule for documents with the specified TN document types. Select one of the following: Any to use this rule for documents regardless of the user status.

For more information about pre-processing actions for XML documents. A document must meet all the criteria that you specify on both the Criteria and Extended Criteria tabs for Trading Networks to use the processing rule to process the document. For example. either type in the date and time or click to open a dialog that allows you to select the date from a calendar. type the numeric value. For each custom attribute that you want to use. 2001 at 2:30 pm. Specify the value you want Trading Networks to use when matching documents to the processing rule. specify 2001-08-29 14:30:00. if you want to specify the date/time August 29. Select an attribute from the list. To specify a date and time. The operator you want Trading Networks to use with the value you specify. Trading Networks checks all pre-processing actions. select Equal if you want Trading Networks to match documents that have the exact value you specify for Value. (Use a 24-hour clock for the hour field. For example. (Trading Networks uses the current time.). type the characters in the string. By default. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 227. specify the following Content Criteria: For this Extended Criteria tab parameter… Attribute Specify… The custom attribute that you want Trading Networks to use to select documents. use the format yyyy-mm-dd hh:mm:ss. For webMethods Trading Networks User’s Guide Version 6. To specify a number. To specify a string.and lowercase letters because Trading Networks performs a case-sensitive match.5 353 .) If you type a date and time.Defining Processing Rules 7 Click the Extended Criteria tab to specify custom attributes that you want Trading Networks to use as criteria for matching processing rules. You do not need to specify a value if you select is null or is not null for Operator Operator Value 8 Click the Pre-Processing tab and fill in the fields to specify the pre-processing actions you want Trading Networks to perform for documents that meet the criteria specified in this processing rule. Be sure to use the exact combination of upper. hh.

5 . select whether you Trading Networks should use the: Document ID only. sender and receiver. both the Document ID and sender. sender and document type. Validate Structure Whether you want Trading Networks to validate the structure of documents. Do not verify digital signature to never verify digital signatures or digitally sign documents that Trading Networks processes with this processing rule. 354 webMethods Trading Networks User’s Guide Version 6. Check for Duplicate Document Whether you want Trading Networks to determine whether it already received the document. Validate structure to always validate the structure of the documents that Trading Networks processes with this processing rule. Do not validate structure to never validate the structure of the documents that Trading Networks processes with this processing rule. Select one of the following: Defer to Document Type to use the Check for Duplicate Document setting that is specified in the TN document type for the document. If you select Use built-in services to check for duplicate document. Select one of the following: Defer to Document Type to use the Verify setting that is specified in the TN document type for the document.CHAPTER 14 Processing Rules more information about pre-processing actions for flat file documents. Select one of the following: Defer to Document Type to use the Validate setting that is specified in the TN document type for the document. Verify digital signature to always verify digital signatures or digitally sign documents that Trading Networks processes with this processing rule. For this Pre-Processing tab parameter… Verify Digital Signature Specify… Whether you want Trading Networks to verify the digital signatures of documents. or the Document ID. the Document ID. Use built-in services to check for duplicate document of XML or flat file documents against a Trading Networks built-in service. see “PreProcessing Actions in the TN Flat File Document Type” on page 294.

To edit an existing custom duplicate service.5 355 . click New service . To create a new custom duplicate service. Note: There could be performance issues if you choose to use custom services for duplicate checking based on the logic in the service you select. click Find Service to browse the IS namespace to locate the one you want to use.Defining Processing Rules For this Pre-Processing tab parameter… Specify… Use custom services to check for duplicate document against a custom duplicate checking service. Click the Edit Service button if you want to modify the service. For more information about creating a duplicate checking service. click on the Edit Service button. Save Document to Database Whether you want Trading Networks to save a copy of document content to the database. webMethods Trading Networks User’s Guide Version 6. To select an existing duplicate service. “Creating a Duplicate Document Check Service” on page 329. Select one of the following: Defer to Document Type to use the Save Document to Database setting that is specified in the TN document type for the document. Do not check for duplicate document to never check the uniqueness of the documents that Trading Networks processes with this processing rule.

g. Do not save to never save the document content and attributes of the documents that Trading Networks processes with the processing rule. If you select Save. if you want to deliver a document via a queue). Trading Networks displays the above three items (Content.CHAPTER 14 Processing Rules For this Pre-Processing tab parameter… Specify… Save to always save a copy of the document contents. and Activity Log) by default. Trading Networks will bypass reliable delivery and invoke the specified delivery service once. When you select the Save option.. Select one of the following: all documents—to save the selected information for all documents regardless of whether they are unique. and/or activity log information that Trading Networks processes with this processing rule. Activity Log—to save activity log criteria relative to the document. Attributes—to save the custom attributes of the document. attributes. only unique documents—to save the selected information for documents only if they are unique. Attributes. 356 webMethods Trading Networks User’s Guide Version 6. select whether you want to save the document only if it is unique. Select the information you want to save to the database by specifying the following: Content—to save the content of the document.5 . Note: If you do not select to save the document content and Trading Networks is to use a delivery option that requires document content to be saved (e.

send an alert e-mail message. click Edit Service. see“Action 1—Execute a Service” on page 330. click OK. After specifying inputs. c To set inputs for the service. Type in values for the parameters you want to hardcode an input value. a Perform one of the following to specify the service you want Trading Networks to invoke for the processing action: To specify an existing service. For more information about the Execute a service processing rule action. Specify the service you want Trading Networks to invoke for the document and how you want Trading Networks to invoke the service. click New Service (folder with yellow highlight) to open the Developer to create the service. d webMethods Trading Networks User’s Guide Version 6. Complete your selections for each processing rule action as explained below. see “Creating Services that Recognize Large Document Handling” on page 544. select asynchronous. To invoke the service asynchronously and use a service execution task. deselect the appropriate checkbox in the Enable column on the left. To invoke the service asynchronously. To disable a processing rule action.Defining Processing Rules 9 Click the Action tab and select one or more of the following processing rule actions. The default for a new processing rule is to have all five actions enabled. click Find Service select the one you want to use. click Set Inputs. select synchronous. to browse the services and To create a new service. 1) Execute a service. For more information about creating services. select service execution task.5 357 . If you are using large document processing. and deliver the document to the receiver. Trading Networks performs the actions in the order they are listed on the Processing Rules screen. Trading Networks displays the corresponding panel for each action on the right side of the screen. Important! If you select more than one action. When you select a processing rule action. Trading Networks performs the actions in that specific order. see “Processing Rule Actions” on page 329. For more information. Trading Networks opens the Developer from which you can update the service. Optionally. see the webMethods Developer User’s Guide. b Specify how to invoke the service: To invoke the service synchronously. Trading Networks displays the input parameters for the service. If you need to update the service. if you select to execute a service. For example. you can also hardcode input parameters for the service.

Subject. For more information about the Alert E-mail processing rule action. see “Defining a Processing Rule Based on a Saved Document” on page 361. select the contact type from the list.CHAPTER 14 Processing Rules 2) Alert E-mail—Compose an e-mail message to send to a specified contact. Sender to send the e-mail to a sender contact. and body of the e-mail message in the To. see “Body of the E-mail Message” on page 340. specify the e-mail address. You can include output template tags to create a dynamic message. For more information about the User Status processing rule action. To use a larger input window to specify the body. Then. 358 webMethods Trading Networks User’s Guide Version 6. see “Action 2— Send an Alert E-mail” on page 338. For more information on this field. subject line.. There are no limits to the length or the characters you can specify. There are no limits to the length or the characters you can specify. Type a character string for the body of your e-mail. respectively. 3) Change User Status—Specify the user status you want to associate with the document. and Body fields. Receiver to send the e-mail to a receiver contact. In the Change to field. Subject Body Type a character string for the subject of your e-mail. For this Alert e-mail field… To Specify. E-mail address to specify a specific address. specify a character string containing 1-255 characters. For more information on these fields. click Expand. see “Recipient of the E-mail Message” on page 338. Then. Then.5 . select the contact type from the list. One of the following addressees: webMethods Administrator to send the e-mail to the webMethods administrator. Specify the recipient. There is no restriction on the characters you can use..

all documents in that queue will be delivered. Specify an immediate delivery method from the list. Scheduled Delivery indicates that documents matching the processing rule will not be delivered immediately. see “Action 4—Deliver the Document to the Receiver” on page 341 Select this Deliver Document field… Queue for polling For.. Receiver’s Preferred Protocol Immediate Delivery Scheduled Delivery Specify the scheduled delivery queue to use from the list. The delivery method that is identified as the receiving partner’s preferred delivery method. but will be queued and delivered later by scheduled delivery.5 359 . For more information. If you do not save the document. Important! If you select the Scheduled Delivery processing action. The scheduled delivery queue can be a public or private queue (Receiver’s queue). Select Receiver’s queue to place documents that match this processing rule in the receiving partner’s selected queue. This preferred delivery method can be an immediate delivery or queued for polling.. Trading Networks queues a document for polling. see “Defining Queue for Polling” on page 394.Defining Processing Rules 4) Deliver Document By—Specify the delivery method you want to use to deliver the document. Trading Networks maintains no information about this document after it processes the document. Select the public queue from the list of registered public queues. see “Immediate Delivery” on page 342. you must use the Save Document to Database preprocessing action. see “Scheduled Delivery” on page 344 and “Scheduled Delivery Queues” on page 378. The next time Trading Networks runs a scheduled delivery service and reads documents from the specified queue. For more information about queues and scheduled delivery. For more information. For more information about the Deliver Document By processing rule action. webMethods Trading Networks User’s Guide Version 6.

For example. and all changes you made to the order of the rules. see “Action 5—Respond With a Message” on page 346. if the message is and XML document. rules you disabled or enabled. click Expand. rules you changed. Message 10 Click OK. type “text/xml”. and saves all changes you have made to processing rules. Trading Networks closes the Processing Rule Details screen. For this Respond With field… Content type Type… The content type of the message in the Content type field. To use a larger input window to specify the message. 360 webMethods Trading Networks User’s Guide Version 6. The message in the Message field. You can include output template tags to create a dynamic message. There are no limits to the length or the characters you can specify. This includes saving all new rules you added.CHAPTER 14 Processing Rules 5) Respond With —Specify the message you want to return to the caller that sent the document and the content type of the message. For more information about the Respond With processing rule action. Specify a character string.5 .

attribute. webMethods Trading Networks User’s Guide Version 6. You can make any changes to the criteria. Check for duplicate document—Set to use the setting in the TN document type for the duplicate check pre-processing action. When Trading Networks creates the processing rule. that is. Extended Criteria Pre-Processing Trading Networks does not set any extended criteria. Action Trading Networks sets the processing action to ignore the document. Trading Networks sets the pre-processing actions as follows: Verify digital signature—Set to always verify the digital signature of the document. Save document to database—Set to always save a copy of the document content.Defining Processing Rules Defining a Processing Rule Based on a Saved Document You can have Trading Networks create a processing rule based on a document that you have saved in the Trading Networks database. or processing actions. if any. Receiver criterion—Set to the receiver that is associated with the document. Document type criterion—Set to the TN document type that was used for the document or unknown if it the document did not match a TN document type. it sets the criteria. Validate structure—Set to always validate the structure of the document. pre-processing actions. pre-processing actions. User status criterion—Set to the value of the user status that is associated with the document. that is. extended criteria. either the sender identified within a document or unknown. either the receiver identified within a document or unknown. and/or activity log information. and actions as follows: Processing Rule Tab Criteria How Trading Networks Defines the Information on the Tab Trading Networks sets the processing rule criteria as follows: Sender criterion—Set to the sender that is associated with the document. extended criteria.5 361 .

then. To change the processing actions.CHAPTER 14 Processing Rules To define a processing rule based on a saved document 1 2 3 4 5 Use the Transaction Analysis screen to display the sample document that you want to use. Trading Networks saves the processing rule and closes the Processing Rule Details screen. update the settings as you want. For information about how to update the settings. To change the custom attribute (extended) criteria. and may have errors. see step 7 on page 353. any user status. Click the row containing the document that you want to view. see “Processing Rules Order” on page 313. To change the pre-processing actions. then. Click OK. The pre-processing actions in the default processing rule indicate that Trading Networks should use the settings in the TN document type. To change the criteria. select the Pre-Processing tab. select the Action tab. any document that Trading Networks receives will meet the criteria of the default processing rule. select the Extended Criteria tab. unfiltered processing list. The criteria of this processing rule matches a document that has any sender. You should not change the criteria. In other words. 6 7 8 Note: Trading Networks saves the new rule at the top of the list of processing rules. see “Ordering the Processing Rules” on page 363. The default rule specifies no extended criteria. For information about how to update the settings. then. any receiver. However. update the settings as you want. update the settings as you want. For instructions on how to move the processing rule to another position in the list.5 . If you do update the default processing rule. see step 9 on page 357. make sure that it remains last in the full. You can update the default processing rule to change any settings. you might want to update the pre-processing and processing actions. then. For information about how to update the settings. Setting Up a Default Processing Rule Trading Networks is shipped with a default processing rule that has the name Default rule. see step 8 on page 353. Select View Transaction Analysis. The processing action is to change the user status of the document to “IGNORED”. 362 webMethods Trading Networks User’s Guide Version 6. For information about how to update the settings. update the settings as you want. select the Criteria tab. any TN document type. For more information about ordering processing rules. Select Transactions Create Processing Rule. see step 6 on page 349.

webMethods Trading Networks User’s Guide Version 6. Note: If you reorder processing rules.Defining Processing Rules Use the following procedure to update and set up your default processing rule. Ordering the Processing Rules The order in which you list your processing rules on the Processing Rules screen is important. update the pre-processing actions. 5 Note: If you do update the Default rule. Because Trading Networks looks for processing rules in this order. Then. Trading Networks matches document information against the criteria that is specified in a processing rule. Select View Processing Rules. click the Pre-Processing tab. make sure that it remains last in the full. Then. see “Processing Rules Order” on page 313. For more information about how Trading Networks works with the order of processing rules. Trading Networks matches documents against processing rules in the order the rules are listed on the Processing Rules screen. Double-click on the row for the default processing rule that is named Default rule. 6 Click OK. Trading Networks closes the Processing Rule Details screen and saves the changes to the processing rule. For each document. For information about what you can specify. If you need procedures for this step. To update the default processing rule 1 2 3 4 Start the Trading Networks Console. unfiltered processing list. see “Starting the Trading Networks Console” on page 22.5 363 . click the Action tab. you should keep rules with specific criteria before rules with general criteria. The default processing rule is listed last (on the bottom of the full unfiltered list). For information about what you can specify. The default processing rule should always be last. To update the pre-processing actions. there is no “undo” function that will return the processing rules to their original order. see step 8 on page 353. update the processing actions. see step 9 on page 357. To update the processing actions. It uses the first processing rule that matches to process the document.

see “Starting the Trading Networks Console” on page 22. Rules Rules Move Move Above Below Inserts the selected processing rule. For more information. Note: If you reorder processing rules. To move more than one contiguous block of rules at a time. you can test the order of your processing rules to assure you have them in the correct order. To order processing rules 1 2 3 Start the Trading Networks Console. If you need procedures for this step.CHAPTER 14 Processing Rules Use the following procedure to order processing rules. 364 webMethods Trading Networks User’s Guide Version 6. To move a processing rule. 5 6 Highlight the processing rule you want to move your selected rule in relation to.. see “Testing the Order of Processing Rules” below. Above the highlighted rule Below the highlighted rule Trading Networks reassigns the ordinal numbers for all affected processing rules. Select View Processing Rules. you can highlight multiple processing rules using the <Shift> key.5 . see “Processing Rules Order” on page 313. perform the following to move your selected processing rule: Click this. click the rule you wish to move.. If you want.. 4 Click Rules Move Select to select the processing rule (s) you want to move.. Once you have highlighted the location. Repeat this step until the processing rules are listed in the order you want. You can order the processing rules in any direction. there is no “undo” function that will return the processing rules to their original order. For more information. The default processing rule should always be listed last. Note: You can only move and reorder processing rules if their ordinals are contiguous.

If you find that Trading Networks is not using the correct processing rule. View Processing Rules. If you need procedures for this step. For more information about disabling processing rules.Defining Processing Rules Testing the Order of Processing Rules You can test the order of your processing rules to assure Trading Networks selects the correct processing rules for your documents. Perform the following procedure to test the order of your processing rules. Test. you select the sample document. Trading Networks displays the Select Input Document dialog box. see “Disabling Processing Rules” on page 373. select the sample document you want to use for the test and click Open. That is. Note that Trading Networks does not test the sample document against disabled processing rules even if the Processing Rules screen is currently displaying disabled processing rules. Important! During the test. webMethods Trading Networks User’s Guide Version 6. To test the processing rules. and highlights the corresponding processing rules. This means Trading Networks does not highlight the disabled processing rules that the document would match. perform the following procedure to display it: a b 2 3 Start the Trading Networks Console. you must have sample documents available in your file system.5 365 . To perform a test. The first highlighted processing rule in the list is the one Trading Networks would use to process the document. see “Starting the Trading Networks Console” on page 22. Trading Networks does not actually process the document. Trading Networks performs the following actions on the document: Recognizes the TN document type Extracts attributes as specified in the TN document type Determines all the processing rules the document matches Trading Networks highlights the matching processing rules on the Processing Rules screen. Trading Networks informs you of the number of matches for which the sample document information meets the processing rule criteria. Trading Networks does not perform any pre-processing or processing actions on the document. To test the order of processing rules 1 If the Processing Rules screen is not currently displayed. Select Rules From the Select Input Document dialog box. you can re-order the rules.

The Processing Rules screen contains a table that displays the processing rules from your query results. you simply select that saved query. query Trading Networks for the processing rule(s) in which you are interested.5 . “Running Queries in Trading Networks”. For more information about different query functions you can perform. specify some or all of the following: Basic search criteria How to display Detail view information about selected processing rules.CHAPTER 14 Processing Rules About Querying and Viewing Processing Rules You can use the query function of the Processing Rules screen to find and view information about all of the processing rules in Trading Networks. Trading Networks searches for processing rules that meet all search criteria that you specify. You can use basic search criteria to select processing rules that: Have specified senders Have specified receivers Are of a specified TN document type Have a specified user status Have a specified processing rule name 366 webMethods Trading Networks User’s Guide Version 6. To find a specific processing rule. The basic search criteria includes most of the basic processing rule criteria. that is. You can select to display summary information or detailed information for each processing rule that is listed in the table. you can save the query settings. including the ones available out-ofthe box and the processing rules you have created. If you plan to use the same query many times. the information found on the Criteria tab of the Processing Rules Details screen. Trading Networks returns the following information in the processing rules table: Processing rules that meet your search criteria in a filtered table format. Specific information about a selected processing rule in a summary section below the table. Basic Search Criteria for Processing Rules Use the Basic Criteria tab to search for processing rules. When you want to use the same query again. To set up a query and display information for viewing processing rules. see Chapter 16.

TN document types. and processing rule criteria for the selected processing rule. You can customize this filtered processing rules table to indicate the columns you want Trading Networks to display and how you want the rows sorted using the options on the Detail View tab. Select View Processing Rules. user statuses. sender. Trading Networks displays the query results in the processing rules table. see “Starting the Trading Networks Console” on page 22. receiver. it displays the filtered results of your processing rule query.About Querying and Viewing Processing Rules Were modified in a specified time period Have a specified ordinal number Detail View of Processing Rules After Trading Networks selects the processing rules that match the basic search criteria that you specify. and if a processing rule is enabled. on the toolbar. 3 4 Select Run Query table. If you need procedures for this step. processing rule name. Each column corresponds to basic information that Trading Networks maintains about a processing rule: ordinal number. webMethods Trading Networks User’s Guide Version 6. To find and view a specific processing rule 1 2 Start the Trading Networks Console. Trading Networks displays the processing rules Perform one of the following to view processing rule information from the table: To see summary information for a processing rule: a With your cursor.5 367 . The summary information contains: the processing rule name. Note: Trading Networks displays the last query run on the Trading Networks Console. Finding and Viewing Processing Rules Use the following procedure to find and view processing rule(s). Trading Networks displays corresponding summary information about the highlighted processing rule in a summary section below the processing rules table. single click on the selected row. which lists the requested processing rules information. description.

Trading Networks displays the Basic Criteria and Detail View tabs. For more information on how to change the information on the Processing Rule Details screen. see “Updating Processing Rules” on page 373.5 . b To change the display format of the processing rules table: a b 5 Select Show Query and Detail View tabs. If you cannot find the processing rule you are looking for. 368 webMethods Trading Networks User’s Guide Version 6.CHAPTER 14 Processing Rules To see the detailed information for a specific processing rule: a With your cursor. select the checkbox next to each criterion you want to use. you can perform a more detailed query to refine the results on the processing rules table. Trading Networks displays the Basic Criteria Go to step 7 to change the table format using the Detail View tab. see “Defining Processing Rules” on page 347. select the Basic Criteria tab and fill in the fields to specify basic search criteria. On the Processing Rule Details screen. For more information about the tabs and fields on this screen. Edit the information. double click on the row containing the processing row you want more detailed information about. Trading Networks displays the Processing Rule Details screen for the selected processing rule. 6 To narrow down the list of processing rules from which to choose. on the toolbar. Select Show Query on the toolbar. you can: 1 2 View the information. To indicate that you want to use one or more of the basic search criteria. Then fill out the corresponding information as follows.

webMethods Trading Networks User’s Guide Version 6. or the Select Profile Group(s) button. For more information about the Criteria tab. button. where the processing rule sender was set to Any in the Criteria tab). Select the individual sender(s) and/or sender group(s) from the Partner Selection Dialogue or the Profile Group(s) Dialog. For example. If you do not select this option.. if you select an individual sender (Partner 1). the query returns all rules where any of the following conditions are met: The sender is Partner 1 The sender is any group that Partner 1 is a member of The rule has a sender criteria of Any If you do not select this option.About Querying and Viewing Processing Rules For this Basic Criteria tab parameter… Sender Select the checkbox and specify… The sender of the processing rule you want to view.. see step 6 on page 349. the query returns all rules where any of the following conditions are met: The sender is Group A The sender is a member of Group A The rule has a sender criteria of Any (that is. button or the Select Profile Group(s). see “Selecting a Partner” on page 34. click the Select Profile(s)...5 369 . the query returns only those rules where the sender is Partner 1. To specify one or more senders. select Perform Implicit Matching to implicitly expand the query results to reflect group membership of your selected sender(s). For more information about the Select Profile(s). Optionally.. the query returns only those rules where the sender is Group A. if you select a sender group (Group A). Similarly..

see “Selecting a Partner” on page 34. For more information about the Criteria tab. User Status The user status of the documents that processed by this processing rule. button. Document Type The TN document type of the documents processed with this processing rule.. Type in a character string contained in the processing rule name. then.5 . . This option works the same way it works for sender queries.. To specify one or more receivers. see step 6 on page 349 To specify a TN document type. Optionally. click Add New type the user status in the newly added row. or the Select Profile Group(s) button. To specify a user status for the query. button or the Select Profile Group(s). click the Select Profile(s). select Perform Implicit Matching to implicitly expand the query results to reflect group membership of your selected receiver(s).. 370 webMethods Trading Networks User’s Guide Version 6. Select the individual receiver(s) and/or receiver group(s) from the Partner Selection Dialogue or the Profile Group(s) Dialog.. where the processing rule TN document type was set to Any in the Criteria tab. That is. click the Select Document Type button.. Select Includes rules where document type is “Any” to search for processing rules that were used for any documents regardless of the TN document type. For more information about the Select Profile(s). Select the TN document type from the Document Type Selection Dialog. To remove a user status from a query. select the row containing the user status you want to delete and then click Delete Selected Rule Name . The name of the processing rule.CHAPTER 14 Processing Rules For this Basic Criteria tab parameter… Receiver Select the checkbox and specify… The receiver of the processing rule you want to view..

You can type in a date value. or click Select Date to open a dialog that allows you to select the date from a calendar. Ordinals The ordinal for the processing rule that you are searching for.About Querying and Viewing Processing Rules For this Basic Criteria tab parameter… Select the checkbox and specify… You can use the pattern-matching characters “%” in the processing rule name search. In the Search Order panel. check each field that you want Trading Networks to include in the Detail view. To specify a date range. For example Type this: %str str% str%str To find: Any string beginning with "str" Any string ending with "str" Any string beginning and ending with "str" Last Modified Time The time Trading Networks last updated the processing rule either when the processing rule was created or last updated. To change the search order. Trading Networks always displays the Ordinals and Rule Name columns. 7 Select the Detail View tab and fill in the fields to specify how Trading Networks displays information in the processing rules table. You can specify an ordinal range by using the From and To fields to indicate the beginning and end of the range. b webMethods Trading Networks User’s Guide Version 6. The ordinal corresponds to the order placement where Trading Networks has assigned the rule you are searching for in the processing rules list. a In the Display Column panel. select Custom from the list. select the search order that you want Trading Networks to follow when performing a query. Trading Networks displays the Senders and Receivers columns by default. Trading Networks displays a column for each checked field. Then specify dates in the Beginning and Ending fields. Select an entry from the list. use the up and down buttons.5 371 .

see “About Viewing and Querying Documents” on page 428. see “Detail View of Processing Rules” on page 367. 373 373 374 374 372 webMethods Trading Networks User’s Guide Version 6. For more information about the Detail view.CHAPTER 14 Processing Rules Select this. To do this. see “Updating Processing Rules” on page 373. select the criteria you want to have .5 ... For more information on how to change the information on the Processing Rule Details screen. select the criteria you want to have precedence from the Search Order list and then click precedence from the Search Order list and then click .. Select the processing rule you want from the Processing Rules table on the bottom portion of the screen. Move a search criteria down.. For more information about the tabs and fields on this screen. see “Defining Processing Rules” on page 347. Managing Processing Rules The following tables lists the tasks you can perform against processing rules: Task “Updating Processing Rules” “Disabling Processing Rules” “Enabling Processing Rules” “Deleting Processing Rules” See page... For more information about queries in Trading Networks. Trading Networks displays the processing rules table with the results from the refined query. 8 9 Select Run Query on the toolbar. Move a search criteria up.

To update the pre-processing actions. Click the row containing the processing rule you want to update. For information about how to update the settings. type a new description in the Description field. click the Criteria tab. update the processing actions. Trading Networks closes the Processing Rule Details screen and saves the changes to the processing rule. To update the extended criteria for the processing rule.5 373 . You can specify 1-64 characters. 11 Click OK. click the Extended Criteria tab. Then. You can specify 1-256 characters. For information about how to update the settings. see step 7 on page 353. To update the description. update the pre-processing actions. update the fields. update the fields. To update a processing rule 1 2 3 4 5 6 7 8 Start the Trading Networks Console. To update the criteria for the processing rule. you can disable it. click the Pre-Processing tab. see step 9 on page 357. For information about how to update the settings. Then. Disabling Processing Rules If you want Trading Networks to temporarily stop using a processing rule. see step 8 on page 353. Select View Processing Rules. click the Action tab. Then. see “Deleting Processing Rules” on page 374. perform the following procedure. If you no longer need the processing rule and want to permanently remove it. For information about what you can specify.Managing Processing Rules Updating Processing Rules To update a processing rule. When determining the processing rule to use for a document. There is no restriction to the characters that you can use. Select Rules Edit. If you need procedures for this step. you can enable it. Then. see “Enabling Processing Rules” on page 374. Trading Networks does not match the document against processing rules that are disabled. webMethods Trading Networks User’s Guide Version 6. you can delete it. There is no restriction to the characters that you can use. see step 6 on page 349. To update the name. When you want Trading Networks to use the processing rule again. 9 10 To update the processing actions. type a new name in the Name field. see “Starting the Trading Networks Console” on page 22.

4 Enabling Processing Rules If you disable a processing rule and then later determine that you want Trading Networks to use it again. Trading Networks places No in the Enabled column to indicate that the processing rule is disabled. Click the row containing the processing rule(s) you want to disable. To enable a processing rule 1 2 3 Start the Trading Networks Console.CHAPTER 14 Processing Rules To disable a processing rule 1 2 3 Start the Trading Networks Console. see “Starting the Trading Networks Console” on page 22. You will not be able to recover it later. see “Starting the Trading Networks Console” on page 22. You can select multiple processing rules using the <Shift> (for a contiguous block of rules) and <Ctrl> (for more than one non-contiguous processing rule) keys. Select Rules Disable. Click the row containing the processing rule(s) you want to enable. Select View Processing Rules. Trading Networks places Yes in the Enabled column to indicate that the processing rule is enabled. Select Rules Enable. it is removed from the Trading Networks system. If you need procedures for this step. 374 webMethods Trading Networks User’s Guide Version 6. 4 Deleting Processing Rules If you no longer need a processing rule. This is an actual delete of the processing rule. Select View Processing Rules. you can delete it. You can select multiple processing rules using the <Shift> (for a contiguous block of rules) and <Ctrl> (for more than one non-contiguous processing rule) keys. Select View Processing Rules. If you need procedures for this step.5 . To delete a processing rule 1 2 Start the Trading Networks Console. The processing rule is not deactivated. see “Starting the Trading Networks Console” on page 22. If you need procedures for this step. you can enable it.

d 4 Click the row containing the processing rule(s) you want to delete. In the Display Column panel. Now you can see the disabled processing rules (No in the Enabled column).5 375 . Trading Networks displays the processing rules If you want to delete a processing rule that is currently disabled. Click Yes to delete. Important! This is an actual delete of the processing rule. Select Run Query on the toolbar. The processing rule is not deactivated. make sure that disabled processing rules are visible on the processing rules table. on the toolbar. Trading Networks confirms that you want to delete the selected processing rule(s). Trading Networks updates the processing rules table. webMethods Trading Networks User’s Guide Version 6. 5 Select Rules Delete. on the toolbar. You can select multiple processing rules using the <Shift> (for a contiguous block of rules) and <Ctrl> (for more than one non-contiguous processing rule) keys. You will not be able to recover it later.Managing Processing Rules 3 Select Run Query table. check the Enabled field so that Trading Networks includes it in the Detail view. Trading Networks displays the Basic Criteria Select the Detail View tab. it is removed from the Trading Networks system. To do so: a b c Select Show Query and Detail View tabs.

5 .CHAPTER 14 Processing Rules 376 webMethods Trading Networks User’s Guide Version 6.

. . . . . . . . . . . . . 390 Defining Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384 Scheduled Delivery Queue States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380 Delivery Schedule for Queues . . . . . . . . . . . . . . . .5 377 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .CHAPTER 15 Queues in Trading Networks What is a Queue? . . . 396 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378 Defining Public Queues . . 394 Viewing Documents in a Queue . . 378 Scheduled Delivery Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Note that a Trading Networks queue is not a queue in the traditional sense. Scheduled delivery and the Deliver Document By processing action. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. Delivery information on the partner’s profile. All scheduled deliveries use reliable delivery. see “Information on the Partner’s Delivery Method Tab” on page 137. Complete the queue settings on the Delivery Method tab.5 . see Chapter 6. see Chapter 6. Trading Networks delivers them based on a schedule defined for the queue. Scheduled Delivery Queues A scheduled delivery queue is a queue for batching documents to be sent to the receiving partners at scheduled times. it contains delivery tasks that are associated with documents. 378 webMethods Trading Networks User’s Guide Version 6. You define one or more queues that Trading Networks uses for scheduled delivery. You select the scheduled delivery method in the processing rules with the Deliver Document By processing action. see step 6 on page 153.CH A P T E R 1 5 Q ue u es in Tr ad in g N et w o r ks What is a Queue? A queue in Trading Networks is a grouping of outbound documents that can be delivered in batch. Trading Networks supports queues for two different purposes— scheduled delivery and polling. For more information about delivery methods and queues. rather. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. see “Scheduled Delivery” on page 344. select Queue for delivery on the Protocol field for the Delivery Method tab. Trading Networks does not deliver them immediately. Instead. Instead. For instructions. For instructions. For more information about Scheduled delivery and queues. see step 7 on page 155. When documents are placed in a queue. Reliable delivery is a feature of Trading Networks where Trading Networks attempts to deliver a document to a partner one or more times based on settings that you define in the Delivery Method tab of the partner’s profile: In your partner’s profile. A scheduled delivery queue does not contain documents. it is a set of rows in the Trading Networks database.

webMethods Trading Networks User’s Guide Version 6. For more information about Scheduled delivery services. It is this delivery task that Trading Networks places in the queue. “Delivery Tasks”. see. Trading Networks also creates a delivery task that maintains information about the delivery of the document. The delivery schedule defines the times that Trading Networks is to invoke the scheduled delivery service to deliver the batched documents that correspond to the delivery tasks that are in the queue. The queue will only contain delivery tasks that correspond to documents that are to be delivered to the partner defined by the profile. Trading Networks supports two types of scheduled delivery queues—public and private: Type of queue Public Queues—A queue that can contain delivery tasks that correspond to documents that are aimed for multiple receiving partners. Delivery tasks.Scheduled Delivery Queues As a result.. You configure public queues using the Tools menu of the Console. when Trading Networks schedules a document for delivery. For more information. You define private queues in the partner’s profile on the Delivery Method tab..5 379 . Private Queues—A queue that contains only delivery tasks that correspond to documents aimed for a specific receiving partner. see Chapter 19. For more information. see below. see “Information on the Partner’s Delivery Method Tab” on page 137 and refer to step 7 on page 155. When you define a queue for scheduled delivery. For more information about how to configure public queues. “Defining Public Queues” on page 380. you associate a delivery schedule and scheduled delivery service with the queue. see “What is a Scheduled Delivery Service?” on page 410.

The public queue fields are filled with values from the public queue that you duplicate. Click Edit queue.5 . including adding. Select the public query for which you want to update and click to select. and you can update any or all fields from the duplicated public queue. Click Copy Selected public queue fields. 1 Select the public query for which you want to update and click to select. edit. or copy a public queue 1 2 3 Start the Trading Networks Console. editing. This section describes how to define public queues. Procedures Click Add New 1 to add a new public queue. Edit— Edit an existing public queue’s fields. Perform one of the following procedures to add a new public queue or to edit or duplicate an existing one. see “Starting the Trading Networks Console” on page 22.CH A P T E R 1 5 Q ue u es in Tr ad in g N et w o r ks Defining Public Queues A public queue is a queue that can contain delivery tasks that correspond to documents that are aimed for multiple receiving partners. to copy the selected 2 380 webMethods Trading Networks User’s Guide Version 6. If you need procedures for this step. To add. Select Tools Registry Public Queues. to edit the selected public 2 Copy— Use this function to rapidly create queues and schedules with roughly the same values. copying. Use the following procedure to add a public queue to Trading Networks or to edit or duplicate an existing public queue. and deleting public queues. Method to select queue New— The public queue fields are empty.

If you created a custom delivery service and registered them with Trading Networks. Delivery Service Select a scheduled delivery service that will deliver documents from the queue. and transfertype) and then click OK to set the inputs. Specify the following parameters to add or edit a public queue to Trading Networks: For this Public Queues Settings parameter… Queue Name Specify… The name you want the public queue to have.Defining Public Queues 3 Select the Settings tab. if they exist. transfermode. For more information about custom delivery services. then you can associate your custom scheduled delivery services with the queues that you define. which uses FTP to deliver documents to a single destination. For more information about scheduled delivery services. specify the required inputs (host. Select the delivery service from Batch FTP or any custom created scheduled delivery services. A scheduled delivery service acts on multiple documents to deliver those documents to one or more partners. Batch FTP (wm. Trading Networks provides a single scheduled delivery service.5 381 .tn. see “What is a Scheduled Delivery Service?” on page 410. These public queue names appear on the Delivery Method tab of your partner’s profile.tn. If you selected Batch FTP for your delivery service. See the description of the wm.transport:batchFtp service in the webMethods Trading Networks Built-in Services Reference for a description of the inputs into this service. webMethods Trading Networks User’s Guide Version 6.transport:batchFtp service). see “Adding and Registering New Delivery Services” on page 421. You can specify a string of up to 225 characters and you can specify any alphanumeric character. Set Inputs Click the Set Inputs button to set the inputs for the delivery service you selected. Public queues that you define here are the ones in your partner’s profile. Out-of-the-box.

All delivery tasks that are in the queue when you disable it remain in the queue. Trading Networks will once again invoke the scheduled delivery service that is associated with the queue to deliver the documents that correspond to those delivery tasks. 382 webMethods Trading Networks User’s Guide Version 6. If you enable or drain the queue. or 2) if a processing rule has been placed on the wrong queue and you need to change the rule and/or reassign some tasks to another queue. The state of a scheduled delivery queue determines: 1) whether Trading Networks can add delivery tasks to the queue and 2) whether Trading Networks can deliver documents associated with the delivery tasks in the public queue. There are two reasons you might wish to disable a queue.5 . Disable Queue Disable a queue when you want Trading Networks to neither add additional delivery tasks into a queue nor act on the delivery tasks in the queue. 1) If the delivery service is defective and you need to debug and fix it.CH A P T E R 1 5 Q ue u es in Tr ad in g N et w o r ks For this Public Queues Settings parameter… Queue State Specify… Set the state of the public queue. Select from the following queue states: Enable Queue Enable a queue when you want Trading Networks to be able to both add delivery tasks into a queue and invoke the scheduled delivery service that is associated with the queue to deliver the documents that correspond to the delivery tasks.

Drain a queue if you want to empty it. so you can delete it. update delivery services). You can also drain a queue to perform maintenance changes (e. If you use the webMethods Administrator to view scheduled user tasks. The wm. webMethods Trading Networks User’s Guide Version 6.queuing:deliverBatch service for each delivery queue you have saved. 5 Click Save. Select the scheduling option you would like for the delivery service. See “Delivery Schedule for Queues” on page 384 for more information about the Schedule tab parameters to specify.queuing:deliverBatch service handles exceptions and logging.. and invokes the scheduled delivery service you specified for the delivery queue. but you do want Trading Networks to continue to invoke the scheduled delivery service that is associated with the queue to deliver the documents that correspond to the delivery tasks. the data passed to the service will be lost and the service will be unable to deliver documents. Important! Do not attempt to use the webMethods Administrator to change the schedule for a delivery service! If you do so.Defining Public Queues For this Public Queues Settings parameter… Specify… Drain Queue Drain a queue when you do not want Trading Networks to add additional delivery tasks into a queue. you will see a scheduled invocation of the wm. Suspend Delivery Suspend a queue when you want Trading Networks to be able to add additional delivery tasks into a queue.tn. You might suspend a queue if a trading partner indicates that it is temporarily unable to accept documents. 4 Select the Schedule tab to schedule when Trading Networks is to invoke the scheduled delivery service to deliver the documents in the public queue. change queue settings.5 383 .tn.g. but you do not want Trading Networks to invoke the scheduled delivery service that is associated with the queue to deliver the documents that correspond to the delivery tasks. Always use the Trading Networks Console to change the delivery schedule and other queue settings.

Trading Networks executes the delivery service repeatedly at an interval you specify. 384 webMethods Trading Networks User’s Guide Version 6. To delete public queues 1 2 3 4 Start the Trading Networks Console. the data passed to the service will be lost and the service will be unable to deliver documents. Select Tools Registry Public Queues. Always use the Trading Networks Console to change the delivery schedule and other queue settings For more information about scheduled delivery services. which acts on the delivery tasks in the queue to deliver the corresponding batched documents. Delivery Schedule for Queues This section describes how often you want Trading Networks to invoke the scheduled delivery service that is associated with a queue. see “Starting the Trading Networks Console” on page 22. you also associate a delivery schedule and a scheduled delivery service with the queue. Trading Networks runs the delivery service on the day(s) and at the time(s) that you specify either during a specified date range or indefinitely Important! Do not attempt to use the webMethods Administrator to change the schedule for a delivery service! If you do so.5 .CH A P T E R 1 5 Q ue u es in Tr ad in g N et w o r ks Use the following procedure to delete public queues from Trading Networks. Click Delete to delete the selected public queue. The delivery service acts on the delivery tasks in the queue when and how often you specify on the Schedule tab: Run Once. If you need procedures for this step. Complex Interval. Trading Networks executes the delivery service a single time. Simple Interval. see “What is a Scheduled Delivery Service?” on page 410. When you define a scheduled delivery queue. The delivery schedule defines the times that Trading Networks invokes the scheduled delivery service. Select the public query for which you want to update and click to select.

For example. Trading Networks does not act on new tasks added to the queue. the delivery tasks remain in the queue. At that time. Trading Networks executes the delivery service (specified on the Settings tab) for the first time immediately after you add the delivery task. webMethods includes the Run Once option for use in a development environment. By default. if you specify a repeat interval of 3600 seconds. suppose your delivery service is scheduled to run every minute. Trading Networks will start the next subsequent execution even though the previous one has not yet completed. webMethods Trading Networks User’s Guide Version 6. There may be times however when you want Trading Networks to wait for a delivery service to complete execution before it starts the next scheduled execution of the service. Trading Networks continues to execute the delivery service at the interval you specify. To have Trading Networks wait for the service to complete before beginning its next scheduled execution. For example. For example. Using the Simple Interval Option When you schedule a queue delivery using the Simple Interval option. If the scheduled delivery service fails to deliver documents associated with the delivery tasks in the queue. when you initialize server. the server throws an exception. These tasks will remain in the queue with a QUEUED status. When using the Run Once option. there is no end date or time associated with a repeating delivery task.5 385 . once scheduled delivery service is invoked. With the Simple Interval option. but sometimes takes longer than that to complete. Note: If the scheduled run-time occurs when the server is not running. Trading Networks uses the scheduled delivery service to act on all the delivery tasks in the queue. Trading Networks will not act on the QUEUED tasks again unless you update the queue schedule. Also. specify 86400 seconds for the interval. use the Complex Interval option.Delivery Schedule for Queues Using the Run Once Option When you schedule a queue delivery using the Run Once option. Trading Networks executes the delivery service (specified on the Settings tab) one time on the date and at the time that you specify. described below. You specify the interval in seconds. Because the queue is set up to run the scheduled delivery service only one time. check the Do not overlap task box. when you schedule a delivery service to repeat. if you want Trading Networks to execute the delivery service every 24 hours. By default. If you want to specify an end date or time. Trading Networks starts the task and schedules the next execution for 3600 seconds after the previous execution began. Trading Networks continues to execute the delivery service until you change the queue schedule. Trading Networks bases the repeat interval on when the task starts. delivery tasks can get “stuck” in the queue.

If you leave this field blank. Use the format yyyy/mm/dd to specify the date. The date on which you want Trading Networks to execute the delivery service for the last time. Trading Networks combines all your selections to determine when to execute the scheduled delivery service. The time at which you want Trading Networks to begin executing the delivery service. If you leave this field blank. If you do not select an item in one of the above settings. The hours of the days that you want Trading Networks to execute the delivery service. Trading Networks executes the task at the first date specified by the remaining settings. For example. Use the format yyyy/mm/dd to specify the date. If you leave this field blank. The time on the last date at which you want Trading Networks to execute the delivery service. Start Time End Date End Time Run Mask Settings Months Days Weekdays Hours Minutes The months (January through December) that you want Trading Networks to execute the delivery service. The minute of the hour that you want Trading Networks to execute the delivery service. The days of the week (Sunday through Saturday) that you want Trading Networks to execute the delivery service. If you leave this field blank. Trading Networks uses 00:00:00 (midnight). Trading Networks executes the service for an indefinite period of time. Trading Networks uses 00:00:00 (midnight). if you do not specify a 386 webMethods Trading Networks User’s Guide Version 6. Specify any combination of the following settings to indicate when and how often you want Trading Networks to execute the scheduled delivery service: Complex Interval Setting Start Date Indicates… The date on which you want Trading Networks to execute the delivery service for the first time.5 .CH A P T E R 1 5 Q ue u es in Tr ad in g N et w o r ks Using the Complex Interval Option The Complex Interval option offers the greatest flexibility for specifying when you want Trading Networks to execute the delivery service for the queue. The days of the months (1 through 31) that you want Trading Networks to execute the delivery service. Use the format hh:mm:ss to specify the time (using a 24-hour clock). Trading Networks assumes all items for the selection. Use the format hh:mm:ss to specify the time (using a 24-hour clock).

March no selection Monday 14 30 Every Monday in the months of January. for an indefinite period of time. If you do not specify an End Date to specify a date range.5 387 .m. If you do not select any items for any of the settings. If you use the Start Date and End Date to specify a date range. Trading Networks executes the scheduled delivery service every minute from the time you add the task.. All delivery tasks added to the queue after the End Date are “stuck” in the queue. February.. The following shows examples of how to use the Complex Interval settings: If you want the delivery service to execute. in other words. Trading Networks assumes you want the service to execute every month. every day. Trading Networks executes the delivery service for an indefinite period of time. Trading Networks will not act on the queued tasks again unless you update the queue schedule. 2002/01/01 00:10:00 2002/12/31 00:00:00 (or leave blank) no selection 28 no selection 0 0 leave blank leave blank leave blank leave blank January.. Trading Networks assumes you want the service to execute every month. and March at 2:30 p.. and every minute.Delivery Schedule for Queues month. Start Date Start Time End Date End Time Months Days Weekdays Hours Minutes webMethods Trading Networks User’s Guide Version 6. The 28th day of every month at midnight for the year 2002. Trading Networks executes the delivery service at the scheduled times until the end of the time period. every hour. all week days. For this setting: Start Date Start Time End Date End Time Months Days Weekdays Hours Minutes Specify. February.

. or edit or copy an existing one as follows: To add a new public queue. Select Tools Registry Public Queues.. 2002. You can add a new queue. For this setting: Start Date Start Time End Date End Time Months Days Weekdays Hours Minutes Specify. Select a public queue for scheduling a delivery. If you need procedures for this step. To edit an existing public queue. Start Date Start Time End Date End Time Months Days Weekdays Hours Minutes To schedule the execution of a delivery service for a public queue 1 2 3 Start the Trading Networks Console.CH A P T E R 1 5 Q ue u es in Tr ad in g N et w o r ks If you want the delivery service to execute.. . select the queue and click Edit 388 webMethods Trading Networks User’s Guide Version 6. Every hour of every Tuesday of the month of June..5 . 2002. click Add New . see “Starting the Trading Networks Console” on page 22. 2002/06/01 00:00:00 (or leave blank) 2002/06/30 23:59:59 June no selection Tuesday no selection 0 2002/06/01 00:00:00 (or leave blank) 2002/06/30 23:59:59 June no selection Tuesday no selection no selection Every minute of every hour of every Tuesday of the month of June.

5 389 . Simple Interval. Subsequent invokes are governed by the interval. When you add or update a simple interval schedule for a queue that is Enabled or Draining. For example. Trading Networks uses 00:00:00 (midnight). Use the format yyyy/mm/dd to specify the date. specify 13:00:00. If you select. If you check the Do not overlap task box. if you want Trading Networks to execute the service on March 11.. 2002. check Do not overlap task. webMethods Trading Networks User’s Guide Version 6.. The date on which you want Trading Networks to execute the service in the Date field. Trading Networks invokes the service immediately. if you want Trading Networks to execute the service at 1:00:00 p.. specify 1:00:00. but sometimes takes longer than that to complete. Run Once Specify.. Select Run Once. suppose your delivery service is scheduled to run every minute. Trading Networks will start the next execution even though the previous one has not yet completed. see “Using the Run Once Option” on page 385“. see “Using the Simple Interval Option” on page 385. or Complex Interval to indicate when and how often you want Trading Networks to execute the delivery service for the specified queue.. For more information about using this option. By default. If you leave this field blank. Use the format hh:mm:ss to specify the time (using a 24-hour clock).m. Trading Networks will wait for the service to complete before beginning its next scheduled execution. Simple Interval The number of seconds that you want Trading Networks to wait between executions of the service in the Interval field. For example. select the queue and click Copy Selected The fields of the copied queue are filled with values from the queue that you copied. .Delivery Schedule for Queues To copy an existing public queue. 4 5 Select the Schedule tab. The time at which you want Trading Networks to execute the service in the Time field. For example. If you want Trading Networks to wait for a delivery service to complete execution before it starts the next scheduled execution of the service. For more information about using this option. You can update any or all fields from the copied public queue..m. if you want Trading Networks to execute the service at 1:00:00 a. specify 2002/03/11.

Use the Run Mask parameters to indicate when you want Trading Networks to execute the service. For the End Time. For End Date. If you omit the Start Date. if you want the time period in which to run this service to end on June 4. specify 2002/05/03 for Start Date and 13:00:00 for Start Time. Trading Networks cannot place delivery tasks into the queue or deliver documents that are associated with delivery tasks in the queue. Scheduled Delivery Queue States You can manage your scheduled delivery queues by enabling. When you want the first execution of this service by specifying a beginning date and time in the Start Date and Start Time fields. For Start Date. Disabled 390 webMethods Trading Networks User’s Guide Version 6. draining. These actions change the state of the queue. and suspending them. State Enabled Meaning Trading Networks can place delivery tasks into the queue and can invoke the scheduled delivery service to deliver the documents that are associated with the delivery tasks in the queue. If you omit Start Time.m.m..CH A P T E R 1 5 Q ue u es in Tr ad in g N et w o r ks If you select. For Start Time.. use the format hh:mm:ss (using a 24-hour clock).. 2002 at 1:00:00 p. For example. For examples of setting these parameters. use the format hh:mm:ss (using a 24-hour clock). which defines whether Trading Networks can add delivery tasks into a queue and whether Trading Networks can deliver the documents that correspond to the delivery tasks in the queues. use the format yyyy/mm/dd. Complex Interval Specify. 2002 at 2:00:00 a. Trading Networks uses 00:00:00 (midnight). the first execution occurs on the first date as indicated by the Run Mask parameters. If you omit End Time.5 ... disabling. specify 2002/06/04 for End Date and 02:00:00 for End Time. 6 Click Save. see “Using the Complex Interval Option” on page 386. Trading Networks uses 00:00:00 (midnight). Omitting End Date indicates that you want this service to execute for an indefinite period of time. When you want the last execution of this service to run by specifying an ending date and time in the End Date and End Time fields. For example.. if you want the time period in which to run this service to begin be on May 3. use the format yyyy/mm/dd.

When the Deliver Document By processing action of a processing rule specifies to use a queue that is disabled. but Trading Networks cannot deliver documents that are associated with delivery tasks that are in the queue. Trading Networks can place delivery tasks into the queue.5 391 . All delivery tasks that are in the queue when you disable it remain in the queue. Disable a queue when you want Trading Networks to neither add additional delivery tasks into a queue nor act on the delivery tasks in the queue. the delivery fails because Trading Networks cannot place the delivery task in the queue. If you enable or drain the queue. disable. Changing the State of a Scheduled Delivery Queue The following table lists the actions you can take to change the state of a queue along with information about each queue state. Suspended The procedure you use to enable. Trading Networks will once again invoke the scheduled delivery service that is associated with the queue to deliver the documents that correspond to those delivery tasks.Scheduled Delivery Queue States State Drained Meaning Trading Networks cannot place delivery tasks into the queue. but Trading Networks can invoke the scheduled delivery service to deliver the documents that are associated with the delivery tasks in the queue. Disabled webMethods Trading Networks User’s Guide Version 6. or suspend a queue depends on whether the queue is a public queue or a private queue. Trading Networks sets the delivery task status to FAILED and logs a message to the activity log. drain. Meaning Enable Enable a queue when you want Trading Networks to be able to both add delivery tasks into a queue and invoke the scheduled delivery service that is associated with the queue to deliver the documents that correspond to the delivery tasks. Two reasons that you might want to disable a queue are 1) to debug and correct a delivery service that is used for the queue or 2) correct a processing rule that is assigning documents to the wrong queue.

You can also drain a queue to perform maintenance changes (e. Select Tools Registry Public Queues. but you do want Trading Networks to continue to invoke the scheduled delivery service that is associated with the queue to deliver the documents that correspond to the delivery tasks. Drain a queue if you want to empty it. Changing the State of a Public Queue To state of a public queue. When the Deliver Document By processing action of a processing rule specifies to use a queue that is drained.5 . You might suspend a queue if a trading partner indicates that it is temporarily unable to accept documents. select the queue that you want to change from the Queue Name list on the left side of the screen. If you enable or drain the queue. In the Public Queues screen. so you can delete it. update delivery services).g. If you need procedures for this step. In this situation. perform the following procedure: To change the queue state of a public queue 1 2 3 Start the Trading Networks Console. see “Starting the Trading Networks Console” on page 22. 4 392 webMethods Trading Networks User’s Guide Version 6. but you do not want Trading Networks to invoke the scheduled delivery service that is associated with the queue to deliver the documents that correspond to the delivery tasks.. Trading Networks sets the delivery task status to FAILED and logs a message to the activity log. Trading Networks will once again invoke the scheduled delivery service that is associated with the queue to deliver the documents that correspond to those delivery tasks. All delivery tasks that are in the queue when you suspend it remain in the queue.CH A P T E R 1 5 Q ue u es in Tr ad in g N et w o r ks Meaning Drained Drain a queue when you do not want Trading Networks to add additional delivery tasks into a queue. Suspended Suspend a queue when you want Trading Networks to be able to add additional delivery tasks into a queue. Click Edit Selected . the delivery fails because Trading Networks cannot place the delivery task in the queue. change queue settings.

Drain Queue. select the queue state you want: Enable Queue. For more information. 6 Click Save. on the toolbar. Disable Queue. Next to the Use Private Queue option. Drain Queue. 4 Perform one of the following to identify partner with which the private queue is associated: To select from all partners: Select a partner from the Profiles table on the bottom portion of the screen. select the queue state you want: Enable Queue. or Suspend Delivery. Select View Trading Partners. 10 Click OK. 5 6 7 8 9 Select the Delivery Method tab of the partner profile. or Suspend Delivery. see “Starting the Trading Networks Console” on page 22. see “Finding and Viewing Profiles” on page 168. click the Edit button. 11 Click Save. Select the Settings tab. For Queue State. perform the following procedure: To enable a private queue 1 2 3 Start the Trading Networks Console.5 393 . Disable Queue.Scheduled Delivery Queue States 5 Select the Settings tab. If you need procedures for this step. Note: Trading Networks displays the last query run on the Trading Networks Console.Trading Networks displays the Basic Criteria and Select Show Query Detail View tabs. For Queue State. To narrow down the list of partners from which to choose: Perform a profile search. Changing the State of a Private Queue To state of a private queue. Click Edit Destination to update the New Protocol sub-tab. webMethods Trading Networks User’s Guide Version 6.

or suspend this queue. Setting up Queue for Polling to Poll on a Partner ’s System This section describes how Trading Networks queues documents for polling and how the receiving partner polls for documents. This queue is always enabled. 2 Optionally. Your trading partners that poll your system for documents determine the method (e. Trading Networks handles the management of the queue for polling. HTTP) you want to use when polling for documents that reside in your partners’ systems and how frequently you want your Trading Networks system to poll your partners’ systems for documents. disable. see “Information on the Partner’s Delivery Method Tab” on page 137. To set up your Trading Networks system so it polls for documents on a partner’s system.CH A P T E R 1 5 Q ue u es in Tr ad in g N et w o r ks Defining Queue for Polling The queue for polling is an internally-defined queue that contains documents. see “Information on the Partner’s Delivery Method Tab” on page 137.. For more information. Trading Networks returns all documents in the queue for which the polling partner is the receiver.g. perform the following: : To set up Queue for polling 1 Define the polling method and polling frequency. HTTP) to use when requesting documents in your queue and how frequently to poll your system for documents. Instead.g. You can define the polling method (e. Trading Networks waits for a partner to poll for the documents. For more information about the polling information in your partner’s profile. The polling method specifies how your Trading Networks system accesses a partner’s system to request queued documents. Trading Networks does not deliver the documents in this queue. When a specific partner polls for documents. The polling method and polling frequency you use for a specific partner is defined on the Delivery Method tab of the partner’s profile. The polling frequency specifies how often your Trading Networks system polls one of your partner’s system for documents. These settings are defined on a per partner basis. drain.. 394 webMethods Trading Networks User’s Guide Version 6.5 . For more information. indicate that the preferred way you want to receive documents is through polling by setting the Preferred Protocol in your profile to Queue for polling. You cannot enable. see “Information on Your Delivery Method Tab” on page 111. You specify them on the Delivery Method tab of the partner’s profile.

If the watt. webMethods Trading Networks User’s Guide Version 6. To do so. If you are running webMethods Trading Networks. the partner server will be unable to request the documents queued for it on the hub server.Defining Queue for Polling Setting up Queue for Polling for webMethods for Partners This section describes how to set up queue for polling for a server running webMethods for Partners. where ServerDirectory is the directory in which you installed the Integration Server running webMethods for Partners.partner=HostName 2 3 Note: Note: If the watt.partner property is missing or set incorrectly. After you add or update the property.server.server. you need to first shut down the Integration Server running webMethods for Partners. Locate the server configuration file at <ServerDirectory>\config\server. If the property exists but is set incorrectly. The property should be set to the host name for the hub Integration Server.partner property exists and is set properly.cnf. To set up Queue for polling 1 Make sure the partner Integration Server running webMethods for Partners and the hub Integration Server running webMethods Trading Networks have the correct license keys (that is. For example. the partner server will throw an exception when attempting to request queued documents. ensure that the watt.5 395 . the partner server uses the partner key and the hub server uses the hub key). add or update the property. there is no additional setup. restart the Integration Server. In the server configuration file.server.” the property would be watt.partner property is missing or incorrect.server. if the host name for the hub Integration Server were “HostName.

For more information on how to use this tab see step 6 on page 445. click the Custom Criteria tab and fill in the fields.5 . To specify the columns you want displayed in the detail view. perform the following procedure. it updates the processing status of the document to indicate that it is in a queue. Viewing Documents that are Scheduled for Delivery When Trading Networks places a document in the queue for scheduled delivery. After the scheduled delivery service that is associated with the queue delivers the document. To specify that you want to view documents that are queued for delivery. but has not yet been successfully delivered to the receiving partner. it changes the processing status of the document to QUEUED. You can use the Transaction Analysis screen to list documents that are in queues. This indicates the document is in a scheduled delivery queue. Select View Transaction Analysis. If you need procedures for this step. on the toolbar to display the query panels if they are not already Select Show Query displayed. 396 webMethods Trading Networks User’s Guide Version 6. To view documents that are scheduled for delivery 1 2 3 4 Start the Trading Networks Console. Fill in any other basic criteria to refine your search as you want.CH A P T E R 1 5 Q ue u es in Tr ad in g N et w o r ks Viewing Documents in a Queue When Trading Networks places a document or delivery task associated with a document in a queue. 5 6 To use custom search criteria to refine your search. click the Detail View tab and fill in the fields. For more information on what you can specify see step 5 on page 445. For more information on what you can specify see step 4 on page 442. select the Processing Status check box. Trading Networks updates the status to one of the following: DONE—if Trading Networks delivered the documents without error DONE W/ ERRORS—if Trading Networks encountered errors when attempting to deliver the document To view the documents in your system that are scheduled for delivery. and select QUEUED from the list. see “Starting the Trading Networks Console” on page 22. Click the Basic Criteria tab and fill in the fields to specify basic search criteria.

Viewing Documents in a Queue

7

Select Run Query on the toolbar. Trading Networks updates the Transactions table in the bottom panel.

Viewing Documents that are Queued for Polling
When Trading Networks places a document in the queue for polling, it changes the processing status of the document to POLLABLE. This indicates the document is available for the receiving partner to poll for it. After the receiving partner polls and receives the document, Trading Networks updates the status to one of the following: ACCEPTED—if the receiving partner picked up the document and indicated that it was processed successfully ACCEPTED W/ ERRORS—if the receiving partner picked up the document, but encountered errors while attempting to process the document To view the pollable documents in your system that are queued for a partner, perform the following procedure. To view pollable documents 1 2 3 4 Start the Trading Networks Console. If you need procedures for this step, see “Starting the Trading Networks Console” on page 22. Select View Transaction Analysis. on the toolbar to display the query panels if they are not already

Select Show Query displayed.

Click the Basic Criteria tab and fill in the fields to specify basic search criteria. To specify that you want to view pollable documents, select the Processing Status check box, and select POLLABLE from the list. Fill in any other basic criteria to refine your search as you want. For more information on what you can specify see step 4 on page 442.

5 6

To use custom search criteria to refine your search, click the Custom Criteria tab and fill in the fields. For more information on what you can specify see step 5 on page 445. To specify the columns you want displayed in the detail view, click the Detail View tab and fill in the fields. For more information on how to use this tab see step 6 on page 445. Select Run Query on the toolbar. Trading Networks updates the Transactions table in the bottom panel.

7

webMethods Trading Networks User’s Guide Version 6.5

397

CH A P T E R 1 5 Q ue u es in Tr ad in g N et w o r ks

398

webMethods Trading Networks User’s Guide Version 6.5

CHAPTER

16

Queries in Trading Networks
Running Queries in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400 Enabling the Query Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402 Creating and Saving a Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404 Selecting and Running a Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405 Updating the Search Criteria for a Saved Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406 Saving a New Query Based on an Existing Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407 Reverting to a Saved Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407 Deleting Saved Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

webMethods Trading Networks User’s Guide Version 6.5

399

C H A P T E R 1 6 Q u e r i e s i n Tr a d i n g N e t w o r k s

Running Queries in Trading Networks
You can perform queries in most of the Trading Networks Console screens. The query functions that you can access are dependent on the screen view you have selected from the Selector Panel buttons. For example, if you are using the Trading Partners screen, the query functions you can perform for profiles on the Basic Criteria, Custom Criteria, and Detail View query tabs are different than the query functions that you can access on the Basic Criteria and Detail View query tabs on the Processing Rules screen. However, the basic query functions that you can access on the Trading Networks Console toolbar are the same. To perform queries in Trading Networks, use the query buttons on the Console toolbar, as shown below in the example below.
Location of the query toolbar on the Trading Partners screen

Query toolbar on the Trading Partners screen

Enlarged view of the Query toolbar

Queries List

400

webMethods Trading Networks User’s Guide Version 6.5

Running Queries in Trading Networks

The following table lists the query functions that correspond with the Trading Networks Console toolbar, along with a description of each function. This query toolbar item...

Represents... Show Query. Displays the query panels for a screen. Hide Query. Removes the query panels from a screen. Run Query. Runs the query using the settings you specified on the query panels.

[Queries List]

Queries List. Drop-down list of all saved queries. Trading Networks displays the last query run on the Console Save Query. Updates the current query by saving the changes you have made to the query criteria Save Query As. Creates a new saved query by saving the query criteria that you specified. Revert to Saved Query. Reverts the query information and resets it to the saved query settings in the database. Delete Query. Deletes the currently selected query.

Trading Networks lists all of the saved queries in the Queries List on the toolbar.

webMethods Trading Networks User’s Guide Version 6.5

401

C H A P T E R 1 6 Q u e r i e s i n Tr a d i n g N e t w o r k s

Enabling the Query Functions
To perform queries in Trading Networks, first enable the query tabs so that you can view and access the query tabs. For example, the query functions may not initially appear on your Console screen, as shown below.
The Trading Partners screen with no query tabs displayed

Display area showing only the query results table (e.g,. Profiles table)

Use the following buttons on the very left of the toolbar to display the query tabs and panels. Can you see query panels? No Yes Click this button... Show Query Hide Query To perform this action... Display the query panels. Remove/Hide the query panels.

402

webMethods Trading Networks User’s Guide Version 6.5

Enabling the Query Functions

So, to view the above Trading Partners screen with the query tabs, click Show Query the toolbar.
Trading Partners screen displayed with query tabs

on

Display area showing query tabs...

... and the query results table (e.g, Profiles table) below

Using the Query panel of the toolbar, you can perform basic search functions: create and save a query, select and run a query, revert back to the original query, and delete a query.

webMethods Trading Networks User’s Guide Version 6.5

403

C H A P T E R 1 6 Q u e r i e s i n Tr a d i n g N e t w o r k s

Creating and Saving a Query
If you plan to use the same query multiple times, you can save the query. Trading Networks adds the query to the drop-down list of saved queries located on the Query section of the toolbar. When you want to use the same query again, you simply select that saved query. To create and save a query 1 2 Enable the query panel. For instructions, see “Enabling the Query Functions” on page 402. For each of the query tabs, select the checkbox next to each criterion you want to use for your query, then fill out the corresponding information. Note: The screen information Trading Networks displays for each query tab will vary on what function you have selected. For example, the Basic Criteria tab for the Trading Partners profile screen view will differ from the Basic Criteria tab for the Processing Rules screen. a For the Basic Criteria query tab: If it appears on this screen Trading Partners Processing Rules Transaction Analysis Activity Log For more information to fill out this tab, see: Step 4a of “About Querying and Viewing Profiles” on page 166 Step 6a of “Finding and Viewing Processing Rules” on page 367 Step 4 of “Transaction Analysis Basic Search Criteria” on page 429 Step 4 of “Viewing Entries that Relate to Enterprise or a Partner” on page 498

b

For the Custom Criteria query tab: If it appears on this screen Trading Partners Transaction Analysis Activity Log For more information to fill out this tab, see: Step 4b of “About Querying and Viewing Profiles” on page 166 Step 5 of “Transaction Analysis Custom Search Criteria” on page 437 Step 5 of “Viewing Entries that Relate to Enterprise or a Partner” on page 498

404

webMethods Trading Networks User’s Guide Version 6.5

Selecting and Running a Query

c

For the Detail View query tab: If it appears on this screen Trading Partners Processing Rules Transaction Analysis For more information to fill out this tab, see: Step 4c of “About Querying and Viewing Profiles” on page 166 Step 7 of “Finding and Viewing Processing Rules” on page 367 Step 6 of “Transaction Analysis Custom Search Criteria” on page 437

d

A query function is available for the TPAs and tasks. For these elements... Agreements (TPAs) Delivery Tasks Service Execution Tasks For more information about the query pane, see: “Finding and Viewing TPAs” on page 185 “Finding and Viewing Delivery Tasks” on page 472 “Finding and Viewing Service Execution Tasks” on page 485

3

To run the query, select Run Query on the toolbar. Trading Networks displays the query results table in the bottom panel. For more information, see “Navigating Through the Results Table” below. To save the query, select Save As... on the toolbar.

4 5 6

In the Save as dialog box, type the name you want to give the query in the Query Name field. Click OK. Trading Networks adds the query to the list of saved queries, which is located on the toolbar.

Selecting and Running a Query
To run an existing query, perform the following procedure. To select and run a query 1 2 Enable the query panel. For instructions, see “Enabling the Query Functions” on page 402. Trading Networks displays the last query that was run in this screen view. Select the query from the list of saved queries, which is located on the toolbar.

webMethods Trading Networks User’s Guide Version 6.5

405

C H A P T E R 1 6 Q u e r i e s i n Tr a d i n g N e t w o r k s

3

To run the query, select Run Query on the toolbar. Trading Networks displays the query results in the results table in the bottom panel.

Navigating Through the Results Table
Use the following buttons (located in the lower right corner of the screen) to help you move through the results table: Button When you click this button, Trading Networks… Displays the first page of the document query results. Displays the previous page of document query results. Displays the next page of document query results. Displays the last page of document query results.

Updating the Search Criteria for a Saved Query
After you save a document query, you can update the search criteria for the saved document query. To update a saved document query 1 2 3 Enable the query panel. For instructions, see “Enabling the Query Functions” on page 402. Select the query for which you want to update search criteria from the list of saved queries, which is located on the toolbar. Make your changes to the search criteria for the saved query by updating the fields on the query tabs. Re-run the query by selecting Run Query on the toolbar. Trading Networks updates the results table displayed in the bottom panel Select Save Query on the toolbar to re-save the query with your updates.

4

5

406

webMethods Trading Networks User’s Guide Version 6.5

Saving a New Query Based on an Existing Query

Saving a New Query Based on an Existing Query
You can create a new query based on an existing query. To save a new query based on an existing query 1 2 3 Enable the query panel. For instructions, see “Enabling the Query Functions” on page 402. Select the existing query to base the new query on from the list of saved queries, which is located on the toolbar. Make your changes to the search criteria for the new query by updating the fields on the query tabs. Re-run the modified query by selecting Run Query on the toolbar. Trading Networks updates the results table displayed in the bottom panel with the information from the newly created query. Select Save Query As to save the new query with your changes.

4

5 6

In the Save as dialog box, type the name you want to give the query in the Query Name field. Click OK. Trading Networks adds the query to the list.

Reverting to a Saved Query
If after you update the query panels and run a query, you decide that you do not want Trading Networks to save the new query settings and instead want Trading Networks to redisplay results using the original saved query, you can revert the query settings to the those of the saved query. To revert to a saved query, after running a new query, select Revert to Saved Query . Trading Networks updates the query panels to display the settings for the saved query, runs the saved query, and displays the query results Note: The Revert to Saved Query function is only available after you change query settings and run the query.

webMethods Trading Networks User’s Guide Version 6.5

407

For instructions. Click Yes to verify that you want to delete the query. see “Enabling the Query Functions” on page 402.C H A P T E R 1 6 Q u e r i e s i n Tr a d i n g N e t w o r k s Deleting Saved Queries If you no longer need a saved query you can delete it. Select Delete Query .5 . Perform the following procedure to delete a saved query. which is located on the toolbar. 3 408 webMethods Trading Networks User’s Guide Version 6. Select the query you want to delete from the list of saved queries. To delete a query 1 2 Enable the query panel.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410 Creating an Immediate Delivery Service . . . . . .CHAPTER 17 Delivery Services What is a Delivery Service? . . . . .5 409 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .411 Creating a Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . . . . . 413 Adding and Registering New Delivery Services . . . . . . . . . . . . . .

you. Note: Use the Trading Networks tn. Trading Networks uses scheduled delivery services during scheduled delivery. etc. The new delivery methods you add by adding new immediate delivery services are available for you to select when you define processing rules.user property to indicate the user account to use when invoking a delivery service.CHAPTER 17 Delivery Services What is a Delivery Service? A delivery service is a service that webMethods Trading Networks (Trading Networks) invokes to deliver documents to trading partners. Trading Networks uses the Administrator user account to invoke services. You can: Add new delivery services—When you add a new immediate delivery service.5 . For more information about this property. What is an Immediate Delivery Service? An immediate delivery service is a service that acts on a single document to deliver the document to a single partner.. see “Trading Networks Configuration Properties” on page 42. Secondary HTTP.) that Trading Networks provides is associated with a default immediate delivery service that Trading Networks also provides. By default. Trading Networks supports two types of delivery services—immediate and scheduled delivery. "Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. What is a Scheduled Delivery Service? A scheduled delivery service is a service that acts on multiple documents to deliver those documents to one or more partners. see Chapter 6. You can associate a single scheduled delivery service with one or more delivery queues. You can create immediate delivery services that deliver documents in ways not provided by webMethods.transport. add new immediate delivery methods. etc. in effect. For more information about immediate and scheduled delivery services. Trading Networks displays the immediate delivery methods you add on the Processing Rules screen in the Immediate Delivery list of the Deliver Document By processing action. you can create new delivery services to replace the default services. Primary HTTP.) Each immediate delivery method (Primary HTTP. Secondary HTTP. Delivery queues also 410 webMethods Trading Networks User’s Guide Version 6. Scheduled delivery is a way to batch multiple documents that are acted on (delivered) at scheduled times. Trading Networks invokes an immediate delivery service when the Deliver Document By processing action in a processing rule indicates to use an immediate delivery method (e. Replace existing delivery services—If one or more of the default immediate delivery services that webMethods provides does not meet your needs. You associate scheduled delivery services with delivery queues.g.

tn. Trading Networks invokes the scheduled delivery service at the times dictated by the delivery schedule. at a minimum. a queue name or Receiver’s Queue). When the Deliver Document By processing action indicates to use scheduled delivery (i. which uses FTP to deliver documents to a single destination.tn. and then closes the connection. If you want to deliver batches of documents in a different way. webMethods provides a single scheduled delivery service. It is a set of rows in the Trading Networks database. Trading Networks displays the scheduled delivery services in the lists of services that you can associate with a queue.5 411 . attempt to deliver the document. Your service must provide values for the serviceOutput output variable. The serviceOutput variable is an IS document (IData object) that contains the following String variables: webMethods Trading Networks User’s Guide Version 6. Trading Networks creates a delivery task for the document that is to be delivered and places the delivery task into the queue. delivers all the documents. Each queued delivery task that is associated with a document is a row in the same table of the Trading Networks database.e.transport:batchFtp service. Creating an Immediate Delivery Service An immediate delivery service must handle a single document that is passed to the service as input. use the webMethods Developer. After you add new scheduled delivery services. the input and output variables that are defined in the specification wm. Your immediate delivery service must implement. It is the responsibility of the scheduled delivery service to retrieve the document. The specification is located in the WmTN package. you can create custom scheduled delivery services and register them with Trading Networks. The output values specified by the specification indicate the outcome of the service. When the schedule associated with the queue indicates. This service opens a connection. The scheduled delivery service retrieves the list of delivery tasks that are in the queue. Trading Networks places delivery tasks in the queues. “Queues in Trading Networks”. you can define your delivery queues to use your custom scheduled delivery services. and update the status of the delivery task to indicate whether the delivery was successful or not.rec:DeliveryServiceSignature.. To view this specification. The input value defined by the specification is the document to be delivered.Creating an Immediate Delivery Service have delivery schedules associated with them. the wm. Trading Networks invokes the scheduled delivery service. For more information about queues. Note: The queue is not a queue in the traditional sense. see Chapter 15.

tn. You pass this service the BizDocEnvelope that represents the document and the service returns the delivery content. use the wm. For information about creating the service. Optional.rec:BizDocEnvelope). The delivery of the document failed. If you do. statusMessage transportTime output Optional.tn. The number of milliseconds it took for the service to deliver the document. Your service must provide one of the following values: Value success fail Meaning The delivery of the document was successful. If the document is not considered large. the service returns the delivery content as a Java InputStream object.tn. see the webMethods Trading Networks Built-in Services Reference. response bytes received from an HTTP post.doc:getDeliveryContent service regardless of whether Trading Networks considers the document large or not. A delivery-specific message about the outcome of the delivery. Important! Do not save your immediate delivery service in the WmTN package or any other webMethods package that contains webMethods software. see “Creating Services that Recognize Large Document Handling” on page 544. This service determines whether to handle the document as large. when you upgrade the webMethods software. see Appendix C. Note: If you are using large document processing. If the document is considered large. Return information from the delivery service. For more information about handling of large documents. Retrieving the Content of a Document for Immediate Delivery To obtain the document content that needs to be delivered.doc:getDeliveryContent service. Optional. “Large Document Handling”. for example.tn. You can use the wm. your service will be lost.CHAPTER 17 Delivery Services Variable in the serviceOutput status Specify… Whether the service executed successfully or unsuccessfully. For more information about the wm. 412 webMethods Trading Networks User’s Guide Version 6.doc:getDeliveryContent service and the structure of the BizDocEnvelope (wm. the service returns the delivery content as a byte array.5 . see the webMethods Developer User’s Guide.

which you can use as a reference implementation to write your own scheduled delivery schedule. webMethods Trading Networks User’s Guide Version 6.5 413 . your scheduled delivery service might have to take other actions as well. Your scheduled delivery service must retrieve each delivery task and act on it individually. To perform these functions. For example. see “Creating Services that Recognize Large Document Handling” on page 544. this is the only required input variable. the wm. and then closes the connection.Creating a Scheduled Delivery Service Creating a Scheduled Delivery Service A scheduled delivery service must act on a batch of delivery tasks.) Important! Do not save your scheduled delivery service in the WmTN package or any other webMethods package that contains webMethods software. see “Required Logic to Include in the Scheduled Delivery Service” on page 415. define the inputs and outputs to use for the variables described in this section. when you upgrade the webMethods software.tn. Inputs and Outputs for a Scheduled Delivery Service When you create your scheduled delivery service. and update the status of the delivery task. delivers all the documents. (The wm. your service will be lost. Your scheduled delivery service will use this value as input to the wm.tn.tn.queuing:getQueuedTask service to retrieve a delivery task. webMethods provides a single scheduled delivery service. Note: If you are using large document processing. Inputs for Scheduled Delivery Service The following table lists the input variables that your scheduled delivery service should expect: Variable queue Data Type String Description The name of the queue that contains the delivery tasks on which your scheduled delivery service is to act.transport:batchFtp service opens a connection. deliver the document associated with the delivery task. For more information.transport:batchFtp service. your scheduled delivery service might need to open a connection to a remote machine before it delivers documents and close the connection after it has delivered all the documents. If you do. It is the responsibility of the scheduled delivery service to retrieve each delivery task.

CHAPTER 17 Delivery Services Variable other variables Data Type n/a Description Define any other input variables that your scheduled delivery service requires. For more information about defining public queues. For example. Trading Networks allows you to set these variables.5 . see “Defining Public Queues” on page 380. see “Retrieving the Content of a Document for Immediate Delivery” on page 412. Other variables that you need to define typically depend on the transport protocol your service will use to deliver the documents. it will supply the inputs you specify when you defined the queue. 414 webMethods Trading Networks User’s Guide Version 6. When Trading Networks invokes your delivery service. an additional input variable would be the directory in which to place the documents that are being delivered. Outputs for Scheduled Delivery Service The following table lists the output variables that your scheduled delivery service must return: Variable logMsg Data Type String Description Text that describes the result of the scheduled delivery service. it is the result of the scheduled delivery service as a whole. For more information. for a service that uses FTP. Retrieving the Content of a Document for Scheduled Delivery You retrieve the document content that needs to be delivered by a scheduled delivery service in the same manner that you retrieve delivery content for an immediate delivery service. When you define a public or private queue. This is not the status of acting on a single delivery task in the queue.

Typically.rec:Task IS document type com. For more information about the com..wm.queuing:getQueuedTask service and process delivery tasks until the queue is empty. see the webMethods Trading Networks Built-in Services Reference.tn.5 415 .tn. Instead. Trading Networks uses this variable to calculate the amount of time it takes to transmit the document.delivery. that is. you pass it the name of the queue from which you want a delivery task and the service returns the oldest task in the queue. see the webMethods Trading Networks Java API Reference documentation. the status of the delivery task is updated from QUEUED to DELIVERING. your scheduled delivery service should invoke the wm. Do not update or drop this variable from the pipeline.tn.delivery.tn.tn.GuaranteedJob object The task that is returned includes the document to be delivered. the wm.tn. IS document (IData object) that has a structure defined by the wm.queuing:getQueuedTask service returns null for the task variable.queuing:getQueuedTask service places the timeDequeued variable in the pipeline.rec:Task IS document type. For more information about the wm. How the delivery task is represented depends on whether your scheduled delivery service is written as a flow service or a Java service: For this type of service… Flow service Java Service Task represented as.queuing:getQueuedTask When you invoke this service.tn.GuaranteedJob object.Creating a Scheduled Delivery Service Required Logic to Include in the Scheduled Delivery Service The following table lists actions that you must include in all scheduled delivery services and the built-in service to use to accomplish each action.wm. When you retrieve a task from the queue..app.tn. webMethods Trading Networks User’s Guide Version 6.app. until you have processed each of the QUEUED delivery tasks in the queue. the task is not removed from the queue. Note: The wm. When the queue is empty. Action Retrieve a delivery task from a queue Built-in service to use wm.

which indicates that the next time the queue schedule invokes your delivery service. the service updates the task status to FAILED. To indicate the outcome of the delivery. set the following input variables to the wm. The wm.queuing:updateQueuedTask service also takes care of logging the results of the delivery to the activity log. set statusMsg to the value of the returned text string.tn. it should deliver the document that is returned with the task information. 416 webMethods Trading Networks User’s Guide Version 6.tn. set the status variable to fail statusMsg If the transport protocol that your scheduled delivery service uses returns a text string message.CHAPTER 17 Delivery Services Action Deliver the document Built-in service to use Use one of the built-in services in the pub.5 .client folder or one of your own custom transport services. the service updates the task status to QUEUED. the service updates the task status to the DONE. If the maximum retry count has been reached.queuing:updateQueuedTask service: Variable status Setting If the delivery attempt was successful. the service updates the task’s retry count. If status is fail.queuing:updateQueuedTask service uses the returned status to update the delivery task status: If status is success. set the status variable to success If the delivery attempt was unsuccessful. If the maximum retry count has not been reached.tn.queuing:updateQueuedTask After your scheduled delivery service attempts to deliver the document that is associated with a delivery task.tn. The wm. Update the delivery task wn. this delivery task will be available to retrieve and re-attempt to deliver the document. After your scheduled delivery service retrieves a delivery task. the service must update the task to indicate whether the delivery was successful or not.

For example. the queue is not empty). your service can then close the connection to the remote server. For more information. success or fail) Retrieve the next delivery task from the queue Close the connection to the remote server The actions in bold are items that all scheduled delivery services should perform. The above shows only a sample of one way to create the service.tn. For more information. see “Required Logic to Include in the Scheduled Delivery Service” on page 415. For example.5 417 .Creating a Scheduled Delivery Service Typical Logic to Include in the Scheduled Delivery Service A typical scheduled delivery service might deliver all the batched documents to a single destination. a cd (change directory) is performed to navigate to the appropriate directory.. for the FTP protocol.transport:batchFtp scheduled delivery service. Retrieve a delivery task from the queue If the queue is empty Exit the service Open a connection to the remote server While queue is not empty Attempt to deliver the document associated with the delivery task Update the task with the results of the delivery (e. After your scheduled delivery service has acted on the delivery tasks in the queue. you might want to combine several documents and transmit them as one large document or might want to limit the number of documents sent to a destination in a single invocation of your service. which webMethods provides. behaves in this manner and is a good sample to refer to when creating your own scheduled delivery service. the queue is empty. after performing the LOGIN to connect to the remote server.transport:batchFtp Service” on page 419. The wm. You might have different requirements for your service.tn. see “The wm.queuing:getQueuedTask service. The following shows steps you might want to include in your scheduled delivery service to deliver all documents to the same destination. You can determine whether the queue is empty by invoking the wm. Some transport protocols require additional actions after opening a connection and before you begin delivering documents.tn. As shown above. If this service returns null. the scheduled delivery service might need to make a connection to a remote server. webMethods Trading Networks User’s Guide Version 6.g. The typical approach is to open the connection after you have determined that the queue has delivery tasks in it (that is.

and you want to exit your scheduled delivery service due to a failure. If your scheduled delivery service needs to take action in response to an exception. invokes your scheduled delivery service and passes your service information about the queue.tn. In response to an exception.tn. This wm.flow:getLastError built-in service to detect whether an exception was thrown. map meaningful text to this variable 418 webMethods Trading Networks User’s Guide Version 6.queuing:deliverBatch service to increment the current delivery task’s retry count and log the exception to the activity log.queuing:deliverBatch service is invoked.tn.tn.tn. To provide this information. The wm. use the following flow operation: EXIT $flow and signal FAILURE The above flow operation causes the wm. the wm.5 .queuing:deliverBatch service increments the retry count for the current delivery task and logs the exception to the activity log. be sure you specify meaningful information in: failure-message property of the EXIT flow operation logMsg variable in Pipeline out. You provide the information that Trading Networks logs to the activity log. use the pub.queuing:deliverBatch service catches any exceptions thrown by your scheduled delivery service or the underlying transport service that your services uses to deliver the document. If you are creating your scheduled delivery service using the flow language. the wm. in turn.CHAPTER 17 Delivery Services Handling Exceptions When the queue schedule dictates.queuing:deliverBatch service.

Creating a Scheduled Delivery Service The wm.tn. which is shown below.5 419 . wm. The wm. use the webMethods Developer to view it.transport:batchFtp Service webMethods provides one scheduled delivery service.tn. To view more information about the service.transport:batchFtp Service 1 2 3 4 5 6 7 8 9 10 11 12 13 webMethods Trading Networks User’s Guide Version 6. This service delivers a batch of documents using the FTP protocol to a single destination.tn. Use this service as a model if you are creating your own custom scheduled delivery service.transport:batchFtp. It is written in the flow language.

is null.string:concat service is 226. fileExtension. the file was transmitted successfully.CHAPTER 17 Delivery Services Flow Operations 1 Description The INVOKE flow operation invokes the wm.client. the file extension is the value specified for the fileExtension variable.ext. If the queue contains delivery tasks.tn. and exit the service. the MAP flow operation sets the value of the status variable in Pipeline Out to “success”. the queue is empty. map a message to the output variable. For any other return code the other MAP flow operation sets the value of the status variable in Pipeline Out to “fail”. If the return code from the pub.ftp:put service that transmits the file using FTP. For more information. If the cd to the specified directory fails. An input to the wm. In this case. An input to the wm. map text to the output variable. logMsg. 2 3 4 5 6 7 8 9 10 This INVOKE flow operation invokes the pub. The file name will be internalID. If this variable was specified. If this variable was not specified. In this case. The REPEAT flow operation causes the service to loop over the delivery tasks in the queue.transport:batchFtp service is the variable. and exit the service.doc:getDeliveryContent to retrieve the document content to be delivered. task. 420 webMethods Trading Networks User’s Guide Version 6. attempt to log in to the remote FTP server. Note that this service is for all files regardless of whether Trading Networks considers a document large.queuing:getQueuedTask service to retrieve the first delivery task from the queue. directory.tn. where internalID is the webMethods generated internal ID for the document and ext is the file extension. The operations in the SEQUENCE flow operation form the file name to use for the document being delivered.string:concat service to append a period to the internal ID.tn.transport:batchFtp service is the variable. see Appendix C. logMsg.tn. The BRANCH flow operation determines the file extension. The first INVOKE flow operation in the sequence invokes the pub. cd to the specified directory. “Large Document Handling”.5 . The INVOKE flow operation invokes wm. Otherwise. the file extension defaults to “xml”. If the variable. The service returns the task information in the task variable.

For example. After looping through all delivery tasks.queuing:updateQueuedTask service to update the status of the delivery task. Trading Networks uses the name you supply to identify the delivery service in the Console: For an immediate delivery service. For a scheduled delivery service.tn. All transport-level exceptions cause the current invocation of the wm. you assign the delivery service a service name.5 421 . Adding and Registering New Delivery Services If you need to deliver documents via a method that is not provided by one of the default delivery services. After you register the new delivery service.transport:batchFtp service will be invoked again for the delivery queue. the queue is empty. according to the queue’s schedule. Trading Networks displays the name among the scheduled delivery services that you can associate with a queue. If the service returned null. the Trading Networks Console lists the corresponding new delivery method on the Processing Rule Detail screen with the Deliver document action.tn. continue in the REPEAT loop. the name you specify becomes the name of a new immediate delivery method.transport:batchFtp service to terminate. One of the inputs to the service is status that was set to either “success” or “fail”.Adding and Registering New Delivery Services Flow Operations 11 Description The first INVOKE flow operation invokes the wm.queuing:getQueuedTask service returned a delivery task. 13 Note that the wm. wm.tn.queuing:getQueuedTask service to retrieve the next delivery task from the delivery queue. you might want to create an immediate delivery service that delivers a message into a message queuing system. exit the REPEAT loop.tn.transport:batchFtp service does not do any exception handling. The wm.tn.tn. log out of the remote FTP server.queuing:deliverBatch. When you register a delivery service. and the exception will be handled by its caller. see “Creating Services that Recognize Large Document Handling” on page 544.tn. webMethods Trading Networks User’s Guide Version 6. Note: If you are using large document processing. 12 If the wm. The second INVOKE flow operation invokes the wm. you can add or register a new delivery service.

You can execute the wm. For more information about this service. One of the input variables of the wm. see “Creating a Scheduled Delivery Service” on page 413 For large document processing. To execute the service from the Developer.delivery:registerService built-in service to register your new delivery service. that is. Note: If you use your own Java development environment.delivery:registerService built-in service from the webMethods Developer to register your new delivery service. Select Test Run.5 . perform the following steps: a b Select the wm. webMethods provides the jcode utility. For immediate delivery services. see the webMethods Trading Networks Built-in Services Reference.delivery:registerService service from the Navigation Panel. see the webMethods Developer User’s Guide. see “Creating Services that Recognize Large Document Handling” on page 544. you must place it in a package. see “Creating an Immediate Delivery Service” on page 411 For scheduled delivery services.tn. For more information. The value you specify for serviceName becomes the name of the delivery method that the Trading Networks Console displays in lists that contain all delivery methods.CHAPTER 17 Delivery Services To add a new delivery service. When you create the service. 2 Execute the wm.delivery:registerService built-in service is serviceName. you need to use a jcode utility to put the Java code into the webMethods IS namespace. The webMethods Developer displays a dialog box for you to enter input: 422 webMethods Trading Networks User’s Guide Version 6.tn. Do not place it in the WmTN or WmTNWeb packages because it will be overwritten when you upgrade Trading Networks. place it in a package and folder.tn. For general information about creating services. perform the following procedure: To add and register a new delivery service 1 Use the webMethods Developer (or your own Java development environment) to create the delivery service. see the webMethods Developer User’s Guide.tn.

When you leave host blank or specify localhost.5 423 .Adding and Registering New Delivery Services c Fill in the input parameters: For this parameter. If the delivery service resides on the local machine. e. Trading Networks uses “localhost”. Trading Networks assumes that the delivery service is on the local server.g.. specify localhost or leave host blank.. If you leave host blank. This is the name that Trading Networks displays in lists in the Trading Networks Console. Message Queue. The name you want to assign to the delivery service. Note: Do not use the same serviceName as any existing immediate or scheduled delivery service.... serviceName Specify. webMethods Trading Networks User’s Guide Version 6. host The host name of the Integration Server.

Note: The password will be securely managed by the Integration Server’s Password Manager.. Specify.CHAPTER 17 Delivery Services For this parameter.. To invoke a delivery service on a remote server. Trading Networks ignores user if host is localhost or left blank. For this type… Immediate Scheduled Specify… false (default) true d Click OK. If you leave host blank. e.5 . If the delivery service is on the local machine.. This is true even if the value you specify is the host name for the local machine. Whether you are adding an immediate or scheduled delivery service. "Security within Trading Networks" in the webMethods Trading Networks Concepts Guide. Trading Networks assumes the delivery service is on a remote server.g. For details.delivery:registerService service. this will consume resources unnecessarily. Trading Networks opens an HTTP connection and posts the document to be delivered.g. 424 webMethods Trading Networks User’s Guide Version 6. The service name of the new delivery service you want to use. Trading Networks ignores user if password is localhost or left blank.. messageQueue. e.deliveryServices. Important! A host value other than localhost or blank will cause Trading Networks to open an HTTP connection to the host for every document delivered. When you specify any other value for host.. do not specify a value for port. password ifc service scheduled The fully-qualified folder name of the new delivery service you want to use.tn.. A user name of a User account that has the authority to execute the wm. port user The port number for the Integration Server. TNCustomize. see Appendix B. The password for the user account identified in user.

Adding and Registering New Delivery Services Note: To make changes to the parameters you specified when adding the delivery service (e. remove the service using wm.5 425 . follow this “To add and register a new delivery service” procedure again on to re-register the service specifying your changes.. to specify a different service): First.g.delivery:removeService Then.tn. webMethods Trading Networks User’s Guide Version 6.

5 .CHAPTER 17 Delivery Services 426 webMethods Trading Networks User’s Guide Version 6.

. . . . . .5 427 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451 Processing a Saved Document Again . . . . . 454 Archiving and Deleting Documents . . . . . 456 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . 452 Reprocessing a Saved Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .CHAPTER 18 Managing and Tracking Documents About Viewing and Querying Documents . . . . . . 428 Viewing Documents in Your System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442 Viewing Documents in a Partner’s System . . . . . . . . . . . . . . . . . . . . . . . . 452 Resubmitting a Saved Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Additionally.5 . "Tracking and Analyzing Run-Time Information in Trading Networks" in the webMethods Trading Networks Concepts Guide. When you want to use the same query again. To set up a query and display information for viewing documents. For more information about process management. For more information about different query functions you can perform. If you plan to use the same query many times. specify some or all of the following: Basic search criteria Custom search criteria How to display detail information about selected documents For more information about transaction analysis. see “Viewing Large Documents that Trading Networks Has Processed” on page 549. For more information about setting your pre-processing preferences see: “Pre-Processing Actions” on page 327. “Running Queries in Trading Networks”. To view large documents. use Trading Networks Web Manager.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s About Viewing and Querying Documents You can use the Transaction Analysis screen to view information about the documents that Trading Networks has saved to its database. you simply select that saved query. see Chapter 8. Trading Networks always saves the attributes and activity log information for the document. Note: If you are using an OEM version of the Trading Networks. 428 webMethods Trading Networks User’s Guide Version 6. see the webMethods Modeler User’s Guide. the Transaction Analysis feature is not available through the Trading Networks Console. To view documents. first query the database for the documents in which you are interested. see Chapter 16. if Trading Networks is to pass the document on to process management. To view documents. Note: Trading Networks saves documents when instructed to do so by pre-processing actions that are set in the TN document type definition or the processing rule. you can save the query settings. Trading Networks returns information about the documents that meet the search criteria that you specify and displays the query results in table view on the Detail View tab.

see “Transaction Analysis Custom Search Criteria” on page 437.5 429 . such as the date Trading Networks received the document. a part of a specific conversation Were received in a specified time period webMethods Trading Networks User’s Guide Version 6. use the custom search criteria. You can use basic search criteria to select documents that: Have specified senders Have specified receivers Are of a specified TN document type Have a specified processing status Have a specified user status Have a specified document ID Have a specified group ID Have a specified conversation ID. Note: To search for documents based on custom attributes that Trading Networks extracted from documents. For more information about searching based on custom attributes. that is. Trading Networks searches for documents that match both criteria.About Viewing and Querying Documents Transaction Analysis Basic Search Criteria Use the Basic Criteria tab to search for documents based on the system document attributes and other standard information that Trading Networks maintains for documents. Trading Networks searches for documents that meet all criteria that you specify. You can specify both basic and custom search criteria.

(Trading Networks does not extract attributes for unknown TN document types. it also maintains information about the partner that is identified as the sender within the document.. Trading Networks matches the value of the SenderID attribute along with its associated ID type (e.g. How Trading Networks selects the documents if you specify a partner: Trading Networks matches the partner you specify to the sender of the documents it has stored in the database. When Trading Networks saves a document to its database. You specify a partner in your network (or your own enterprise) as the sender. The TN document type of the document is unknown. it associates that partner as the sender of the document.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s Basic Criteria Sender Descriptions Use to: Select all documents that have a specified sender. DUNS) against ID type information stored in partner profiles on your system. For example. How Trading Networks selects the documents if you specify an unknown sender: Trading Networks selects documents for which it did not associate a sender (See “Reasons Trading Networks might not select a document” above). Trading Networks determines the sender of a document by using the SenderID system attribute that it extracted from the document. The following lists reasons a query might not discover documents that were sent by a specified sender: Trading Networks could not extract the SenderID system attribute from the document because the TN document type definition did not instruct Trading Networks to do so or because the XQL query specified in the TN document type definition was invalid. When it finds a matching profile. 430 webMethods Trading Networks User’s Guide Version 6. You can also select all documents that have an unknown sender. it cannot select the document in a query even when a document was sent by the sender you specify. the D-U-N-S number in the document is incorrect.) The ID type for the SenderID attribute is not specified in the partner profile of the corresponding partner. Reasons Trading Networks might not select a document: If Trading Networks did not associate a sender with a document.5 . for example. if the value of the SenderID attribute is 123456789 and the ID type is DUNS. The document contains the incorrect external ID. Trading Networks looks at profiles to find a profile that specifies the ID type DUNS equal to 123456789.

For example. if the value of the ReceiverID attribute is 123456789 and the ID type is DUNS. webMethods Trading Networks User’s Guide Version 6. The following lists reasons a query might not discover documents with the specified receiver: Trading Networks could not extract the ReceiverID system attribute from the document because the TN document type definition did not instruct Trading Networks to do so or because the XQL query specified in the TN document type definition was invalid. the D-U-N-S number in the document is incorrect. (See “Reasons Trading Networks might not select a document” above). it associates that partner as the receiver of the document. When it finds a matching profile. for example. Reasons Trading Networks might not select a document: If Trading Networks did not associate a receiver with a document. Trading Networks looks at profiles to find a profile that specifies the ID type DUNS equal to 123456789. How Trading Networks selects the documents if you specify an unknown receiver: Trading Networks selects documents for which it did not associate a receiver. Trading Networks matches the value of the ReceiverID attribute along with its associated ID type (e. You specify a partner in your network (or your own enterprise) as the receiver. The document contains the incorrect external ID.) The ID type for the receiver attribute is not specified in the partner profile of the corresponding partner. When Trading Networks saves a document to its database. it cannot select the document in a query even when a document has the receiver that you specify.5 431 .About Viewing and Querying Documents Basic Criteria Receiver Descriptions Use to: Select all documents that have a specified receiver. (Trading Networks does not extract attributes for unknown TN document types. How Trading Networks selects the documents if you specify a partner: Trading Networks matches the partner you specify to the receiver of the documents it has stored in the database. it also maintains information about the partner that is identified as the receiver within the document.. You can also select all documents that have an unknown receiver. DUNS) against ID type information stored in partner profiles on your system. Trading Networks determines the receiver of a document by using the ReceiverID system attribute that it extracted from the document. The TN document type of the document is unknown.g.

You specify the name of a TN document type that you have defined for your Trading Networks system. it saved the document and the TN document type as unknown. The following lists reasons a query might not discover documents with the specified TN document type: Trading Networks received the document before the TN document type you specified was defined. The identifying queries specified in the TN document type definition did not identify the document. For example. How Trading Networks selects documents with the specified TN document type: Trading Networks stores the TN document type with each document it stores in its database. How Trading Networks selects documents with an unknown TN document type: If Trading Networks was unable to determine a TN document type when it received the document. 432 webMethods Trading Networks User’s Guide Version 6. Trading Networks selects documents that have an unknown TN document type. you can search for all documents that Trading Networks determined was the TN document type for cXML purchase orders. It selects all documents with the TN document type that you specify. You can also search for all documents for which the TN document type is unknown.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s Basic Criteria Type Descriptions Use to: Select all documents that have a specified TN document type.5 . Trading Networks could not identify it as that type of document. if you have a TN document type that identifies cXML purchase orders. Reasons Trading Networks might not select a document: You might have documents of the specified TN document type that Trading Networks does not have marked as such in its database. Because the TN document type did not exist when the document was received.

The following processing actions (if specified in the processing rule) might not be completed yet: Execute a service—If Trading Networks invoked the service asynchronously. Deliver document—The document might not be delivered to the receiving partner yet. The document has not yet been successfully delivered. DONE W/ ERRORS Trading Networks has completed document recognition and processing. Deliver document—The document might not be delivered to the receiving partner yet. Trading Networks has completed document recognition and processing. Select one of the processing statuses from the list. Trading Networks might have been unable to match the document to a TN document type. or Trading Networks might have been unable to extract a document attribute that was marked as required in a TN document type. NEW PENDING QUEUED Trading Networks has received the document but has not recognized the document yet.About Viewing and Querying Documents Basic Criteria Processing Status Descriptions Use to: Select all documents that have the specified processing status.5 433 . errors occurred during document recognition and/or document processing. the service might not have finished execution yet. The receiving partner has not picked up the document yet. However. Trading Networks has received the document and placed it in a scheduled delivery queue. DONE webMethods Trading Networks User’s Guide Version 6. The following processing actions (if specified in the processing rule) might not be completed yet: Execute a service—If Trading Networks invoked the service asynchronously. POLLABLE Trading Networks queued the document for the receiving partner. the service might not have finished execution yet. For example. Trading Networks has recognized the document but has not completed processing the document.

The receiving partner has picked up the document and successfully performed document recognition and routing for the document. How Trading Networks selects documents: As Trading Networks processes a document. user-defined services can abort processing by invoking the wm. Trading Networks completes the processing for the original document. Trading Networks matches the processing status you specify to the processing statuses that are associated with the documents. Trading Networks encountered an internal error. In this situation. Descriptions ACCEPTED Trading Networks queued the document for the receiving partner.tn. but sets the processing status of the new document to “ABORTED”. a document triggers a processing rule that creates and submits a new document that triggers the same processing rule again. Note: The processing (system) status is not a system attribute.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s Basic Criteria Processing Status continued. it updates the processing status that is associated with a document.5 . Trading Networks queued the document for the receiving partner. see the webMethods Trading Networks Built-in Services Reference. Trading Networks typically uses this status in one of the following situations: Trading Networks detected an infinite loop in the processing rules. The receiving partner has picked up the document and encountered errors when processing the document. ACCEPTED W/ ERRORS ABORTED 434 webMethods Trading Networks User’s Guide Version 6.. That is..route:abort built-in service. For more information about this service. Trading Networks encountered a fatal error before completing the processing specified by the processing rule. In addition. You should not modify it as it is for Trading Networks internal use only.

The following lists reasons a query might not discover documents with the specified document ID: Trading Networks did not extract the DocumentID system attribute from the document. Reasons Trading Networks might not select a document: If Trading Networks cannot determine the document ID of a document. How Trading Networks selects documents: You can set a user status for a document by extracting the User Status system attribute from the document.About Viewing and Querying Documents Basic Criteria User Status Descriptions Use to: Select all documents that have the specified user status. using the change user status action in a processing rule. How Trading Networks selects documents: Trading Networks matches the document ID you specify to the value of the DocumentID system attribute that it extracted from the document. The TN document type of the document is unknown.tn. Document ID Use to: Select all documents that have a specified document ID.doc:changeStatus built-in service. or by using the wm.5 435 . webMethods Trading Networks User’s Guide Version 6. it cannot select the document in a query even when a document has the document ID that you specify. How Trading Networks selects documents: Trading Networks searches the database for a document that has the Trading Networks internal ID you specified. (Trading Networks. Type the internal ID in the text box. Type the user status in the text box. Trading Networks assigns each document an internal ID when it processes the document. Internal ID Use to: Select the document that has the specified internal ID. Trading Networks matches the user status you specify to the user statuses associated with the documents.

The following lists reasons a query might not discover documents with the specified group ID: Trading Networks did not extract the GroupID system attribute from the document. it cannot select the document in a query even when a document has the conversation ID that you specify. How Trading Networks selects documents: Trading Networks matches the conversation ID you specify to the value of the ConversationID system attribute that it extracted from the document. it cannot select the document in a query even when a document has the group ID that you specify.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s Basic Criteria Group ID Descriptions Use to: Select all documents that have a specified group ID. Trading Networks will gray out this selection.) 436 webMethods Trading Networks User’s Guide Version 6. (Trading Networks does not extract attributes for unknown TN document types.5 . Note: If you are using an OEM version of the Trading Networks. Reasons Trading Networks might not select a document: If Trading Networks cannot determine the group ID of a document.) Conversation ID Use to: Select all documents that have a specified conversation ID. The following lists reasons a query might not discover documents with the specified conversation ID: Trading Networks did not extract the ConversationID system attribute from the document. How Trading Networks selects documents: Trading Networks matches the group ID you specify to the value of the GroupID system attribute that it extracted from the document. Reasons Trading Networks might not select a document: If Trading Networks cannot determine the conversation ID of a document. that is. (Trading Networks does not extract attributes for unknown TN document types. The TN document type of the document is unknown. The TN document type of the document is unknown. you can view all documents that Trading Networks has received that are part of the conversation you identify by the conversation ID that you specify. this Trading Networks’ feature is unavailable.

This means to find specific transactions. for example. Attribute instructs Trading Networks to look at the value of the specified attribute to determine whether it meets the rest of the criteria for this custom attribute. Note: Trading Networks saves information about the document from when the document was first received and processed. Trading Networks selects documents that have timestamps from the day or time period that you specify. match number values that are greater than a specified value. you need to specify information from when the document was first received. If the document is saved to the database. The operator you can specify depends on the data type of the attribute. You can specify any attribute that is defined to your system. Operator instructs Trading Networks how to match the value.) How Trading Networks selects documents: When Trading Networks receives a document.5 437 . or match date values before a specified date. webMethods Trading Networks User’s Guide Version 6. you need to specify the original D-U-N-S number. For example. if you set up Trading Networks to extract the custom attribute Order Date. Trading Networks stores the timestamp with the document. For example. an operator. match string values that contain specified characters. Transaction Analysis Custom Search Criteria Use the Custom Criteria tab to search for documents based on the custom attributes that Trading Networks extracted from documents. if a partner’s D-U-N-S number has changed since the document was received. For each custom attribute that you want to use to select documents.About Viewing and Querying Documents Basic Criteria Date Received Descriptions Use to: Select all documents that Trading Networks received on a specific day or during a specified time period. it records the timestamp when the document is received. and the value the attribute should have. (Date Received is the date Trading Networks processed the document. you can search for all documents with the Order Date equal to a specified date. which contains the date a purchase order was submitted. you specify the attribute name.

Contains the character string that you specify for the value. You do not need to specify a value when you specify this operator. Is not null Equals Not equals Contains STRINGLIST Is null Has any value. You do not need to specify a value when you specify this operator. You do not need to specify a value when you specify this operator.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s Data Type STRING Operator Is null Matches when the attribute extracted from a document… Has no value. The TN document type does not instruct Trading Networks to extract the attribute. The attribute value has no value if: XQL query (defined in the TN document type) that Trading Networks used to extract the attribute failed. The attribute value has no value if: XQL query (defined in the TN document type) that Trading Networks used to extract the attribute failed. Is not null Includes Has any value. 438 webMethods Trading Networks User’s Guide Version 6. You do not need to specify a value when you specify this operator. Has a value that does not match the value that you specify. Includes the value that you specify. The TN document type does not instruct Trading Networks to extract the attribute. Matches exactly the value that you specify.5 . Has no value.

Matches exactly the value that you specify.5 439 . You do not need to specify a value when you specify this operator. Has a value that is less than or equal to the value that you specify. Has a value that is greater than or equal to the value that you specify. Is not null Equals Not equals Greater than or equals Less than or equals Less than Greater than NUMBERLIST Is null Has any value. Has a value that is greater than the value that you specify. Has no value. The attribute value has no value if: XQL query (defined in the TN document type) that Trading Networks used to extract the attribute failed.About Viewing and Querying Documents Data Type NUMBER Operator Is null Matches when the attribute extracted from a document… Has no value. Has a value that does not match the value that you specify. The TN document type does not instruct Trading Networks to extract the attribute. The attribute value has no value if: XQL query (defined in the TN document type) that Trading Networks used to extract the attribute failed. You do not need to specify a value when you specify this operator. You do not need to specify a value when you specify this operator. Is not null Includes Has any value. Has a value that is less than the value that you specify. Includes the value that you specify. You do not need to specify a value when you specify this operator. webMethods Trading Networks User’s Guide Version 6. The TN document type does not instruct Trading Networks to extract the attribute.

Matches exactly the value that you specify. Is a date that is before the date that you specify. Trading Networks was not instructed to save the attribute. Trading Networks might not select the document for the following reasons: Trading Networks did not extract the attribute from the document. instructs Trading Networks how to select documents based on the value of the attribute stored with documents. Is not null Has any value.5 . Value. along with the operator. You do not need to specify a value when you specify this date list. Even when a document contains the attribute information that you specify. The attribute value has no value if: XQL query (defined in the TN document type) that Trading Networks used to extract the attribute failed. Is a date that is after the date that you specify. You do not need to specify a value when you specify this date list. The TN document type does not instruct Trading Networks to extract the attribute. Trading Networks searches for documents 440 webMethods Trading Networks User’s Guide Version 6. You do not need to specify a value when you specify this operator. Has no value. The TN document type does not instruct Trading Networks to extract the attribute. Is not null Equals Before After DATETIME LIST Is null Has any value.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s Data Type DATETIME Operator Is null Matches when the attribute extracted from a document… Has no value. The TN document type of the document is unknown. You do not need to specify a value when you specify this operator. The attribute value has no value if: XQL query (defined in the TN document type) that Trading Networks used to extract the attribute failed.) You can specify you want Trading Networks to search for documents that have specified information for multiple custom attributes. (Trading Networks does not extract attributes for unknown TN document types.

if a document is related to others. You can customize the display table to indicate the columns you want Trading Networks to display and how you want the rows sorted. if specified. Detail View of Documents After Trading Networks selects the documents that match the basic and custom search criteria that you specify. NUMBER LIST. webMethods Trading Networks User’s Guide Version 6. Each column corresponds to information that Trading Networks maintains about a document. In addition. “Working with Tables” on page 33. it displays the requested document information. Trading Networks displays the information in a table format of the documents in the Detail view. Using the Detail View tab. such as the date received. or DATETIME LIST) in the Detail view. you can view a list of the related documents.About Viewing and Querying Documents that meet all the criteria you specify—all the custom search criteria and basic search criteria. TN document type. You can view the extracted attributes along with their values and the document content. you cannot view array-type attributes (STRING LIST. or any of the document attributes (system or custom) that it has extracted from documents. you can select to display details for each document that is listed. For more information about customizing the display of your table format. However.5 441 .

Select the TN document type from the list. The processing status of the documents that you want to view. select the checkbox next to each criterion you want to use. Click the Basic Criteria tab and fill in the fields to specify basic search criteria. Select the sender from the list. use Trading Networks Web Manager. If you need procedures for this step. Select View Click Transaction Analysis. Select the status from the list. To indicate that you want to use one or more of the basic search criteria. To view documents. To view documents in your system 1 2 3 4 Start the Trading Networks Console. see “Starting the Trading Networks Console” on page 22. Select the receiver from the list.5 . Then fill out the corresponding information as follows: For this Basic Criteria tab parameter… Sender Receiver Type Specify… The name of the partner who sent the documents you want to view. Processing Status 442 webMethods Trading Networks User’s Guide Version 6. to display the query panels if they are not already displayed.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s Viewing Documents in Your System Perform the following procedure to search for view document information that is stored in the Trading Networks database in your system. Note: If you are using an OEM version of the Trading Networks. The name of the partner who is the receiver of the documents you want to view. The name of the TN document type that Trading Networks identified this document as. the Transaction Analysis feature is not available through the Trading Networks Console.

For example. You can use the following pattern matching characters: Character % (percent) _ (underscore) Example: _t_p D%t matches: Stop. Document ID The document ID that Trading Networks extracted from the document. specify ‘Pending_Approval’. This field is case-sensitive.and lowercase letters. This field is case-sensitive. if you want to search for entries with the user status Pending_Approval. enclose the string you specify in quotes.5 443 . if you want to search for entries with the document ID 5f_4%32. Type the user status in the text box. specify ‘5f_4%32’.and lowercase letters. Document Test but not: Documents. enclose the string you specify in quotes. be sure to use the exact combination of upper. stop. You can use the following pattern matching characters: Character % (percent) _ (underscore) Matches… Zero or more characters A single character To search for an entry that contains the % or _ characters.Viewing Documents in Your System For this Basic Criteria tab parameter… User Status Specify… The user status of the documents that you want to view. be sure to use the exact combination of upper. Polled Document Matches… Zero or more characters A single character To search for an entry that contains the % or _ characters. webMethods Trading Networks User’s Guide Version 6. For example. step but not: sstop. stoop matches: Document.

This field is case-sensitive. select Custom from the list. specify ‘5f_4%32’. 444 webMethods Trading Networks User’s Guide Version 6. specify ‘5f_4%32’. You can use the following pattern matching characters: Character % (percent) _ (underscore) Matches… Zero or more characters A single character To search for an entry that contains the % or _ characters. For example.and lowercase letters.and lowercase letters. if you want to search for entries with the conversation ID 5f_4%32. This field is case-sensitive. Select an entry from the list. if you want to search for entries with the group ID 5f_4%32. For more information. To specify a date range. Then specify dates in the Beginning and Ending fields.5 . If you decide you do not want to use a criterion that you have filled out. For example. enclose the string you specify in quotes. Conversation ID The conversation ID that Trading Networks extracted from the document. be sure to use the exact combination of upper. You can use the following pattern matching characters: Character % (percent) _ (underscore) Matches… Zero or more characters A single character To search for an entry that contains the % or _ characters. uncheck the check box for that criterion. see “Transaction Analysis Basic Search Criteria” on page 429. enclose the string you specify in quotes. be sure to use the exact combination of upper. or click to open a dialog that allows you to select the date from a calendar. Date Received The date Trading Networks received the document. You can type in a date value.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s For this Basic Criteria tab parameter… Group ID Specify… The group ID that Trading Networks extracted from the document.

and lowercase letters because Trading Networks performs a casesensitive search. specify 2000-08-29 14:30:00. The operator you want Trading Networks to use with the value you specify. webMethods Trading Networks User’s Guide Version 6. For example. if you want to specify the date/time August 29. see “Transaction Analysis Custom Search Criteria” on page 437. Specify the value you want Trading Networks to use when querying for documents. type the characters in the string. (Use a 24-hour clock for the hour field. hh.). specify the following: For this Custom Criteria tab parameter… Attribute Operator Specify… The custom attribute that you want Trading Networks to use to select documents. Value For more information. type the numeric value. 2000 at 2:30 pm. select Equals if you want Trading Networks to select all documents that have the exact value you specify for Value. To specify a string. You do not need to specify a value if you select Is null or Is not null for Operator. Be sure to use the exact combination of upper.5 445 . Trading Networks displays a column for each checked field. Select an attribute from the list. In the Standard Attributes section. For each custom attribute that you want to use to query documents.Viewing Documents in Your System 5 Click the Custom Criteria tab and fill in the fields to specify custom search criteria. use the format yyyy-mm-dd hh:mm:ss. For example. either type in the date or click to open a dialog that allows you to select the date from a calendar. check each standard attribute field that you want Trading Networks to include in the Detail view. To specify a date. 6 Click the Detail View tab and fill in the fields to specify how Trading Networks displays information in the Detail view. To specify a number. If you type a date.

To move attributes to the Selected Attributes list: Select this. Trading Networks updates the Transactions table on the bottom portion of the screen with the query results. For more information about changing the table format Trading Networks displays... To move all custom attributes to the Selected Attributes list To move some but not all attributes to the Selected Attributes list. Select the Attribute on which Trading Networks is to sort from the list. Then. To remove some but not all attributes from the Selected Attributes list.. NUMBER LIST. If you decide you do not want Trading Networks to display information for attributes in the Selected Attributes list. select fields that you want Trading Networks to include in the Detail view. To do this. indicate how you want Trading Networks to sort the information it displays in the Detail view. see “Viewing Document Attributes and Document Content” on page 448. For more information about the Detail View tab. see “Detail View of Documents” on page 441. select one or more fields in the Available Attributes list and then click . Trading Networks displays a column for each field in the Selected Attributes list. select the attributes you do not want included in the display from the Selected Attributes list and then click To remove all custom attributes from the Selected Attributes list. see “Working with Tables” on page 33.. Note: Trading Networks can only sort attributes if they are selected for the view. For more information about the attributes. move the attributes back to the Available Attributes list: Select this. To do this. 7 Click the Run Query button on the toolbar.. or DATETIME LIST) in Transaction Analysis. In the Sort By section. Trading Networks cannot view or sort array-type attributes (STRING LIST..C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s In the Custom Attributes section. 446 webMethods Trading Networks User’s Guide Version 6.. select Ascending or Descending.5 ..

Use the Select. the partner can use the queries when accessing your system to view documents in your system.5 447 . the query is set up to find documents in which your corporation is identified as the sender. see “Starting the Trading Networks Console” on page 22.Viewing Documents in Your System For more information about the different query functions that you can perform for document queries. see “Processing a Saved Document Again” on page 452. You might want to create your queries using the Trading Partners selection if you plan to save the query and want to associate the query with a specific partner. For more about saving queries. similarly. Select View Transaction Analysis. webMethods Trading Networks User’s Guide Version 6. The one difference between the two selections is the results of the webMethods-defined Sent and Received saved queries that are shipped with Trading Networks.. For more information about the Select. the query is set up to find documents in which the selected partner’s corporation is identified as the sender. see the following table: Query Function “Updating the Search Criteria for a Saved Query” “Saving a New Query Based on an Existing Query” “Reverting to a Saved Query” “Deleting Saved Queries” See page.... button to select the partner with which you want to associate the document query. Select the partner from the Partner Selection Dialog. the Received query is set up to find documents in which your corporation is identified as the receiver. When you use the Sent query from Enterprise. When you use the Sent query from Trading Partners. Select View Trading Partners. the Received query is set up to find documents in which the selected partner’s corporation is identified as the receiver.. 4 5 Select the sender from the Partner Selection Dialog. page 406 page 407 page 407 page 408 Viewing Documents Using the Trading Partners Selection You can view documents in your system by selecting Trading Partners from the View menu rather than selecting Enterprise. You can perform identical searches from the Trading Partners selection and the Enterprise selections. similarly. If you save queries in this way. To view documents in your system using the Partner selection in the Selector Panel 1 2 3 Start the Trading Networks Console. button. If you need procedures for this step.. see “Selecting a Partner” on page 34.

Select Transactions View Document. Click the row containing the document for which you want to view document attributes and the document content. Show/Hide Query to display To create the document query and view the documents. it displays the pipeline for the content. and/or activity log information if instructed to do so by either the TN document type and/or the processing rule. NUMBER LIST. If you do not save a copy of the document content. attributes. Trading Networks saves the document as the pipeline it received when the document was sent. Trading Networks displays the list of parts. If a document is a single-part document. Trading Networks displays the name of one document part and the content of that single part. if Trading Networks receives and saves a non-XML document. or DATETIME LIST) in the Detail view of the query panel. To view document attributes and document content for a document 1 On the Transaction Analysis screen. If a document has multiple parts. select the Attributes tab. perform step 4 through step 7 from the procedure “Viewing Documents in Your System” on page 442. rather than display the content as XML data. 2 3 4 To view the document attributes. perform the following procedure. 448 webMethods Trading Networks User’s Guide Version 6. you can view the document content. However.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s 6 7 If the query panels are not displayed. and/or activity log information. attributes. The content of the document is typically XML. Note: You cannot view array-type attributes (STRING LIST. Trading Networks lists the names of the parts. Trading Networks can display single or multiple part documents. In addition. Viewing Document Attributes and Document Content For any document saved to the database. Trading Networks maintains no information about this document after it processes the document. To view the attributes and content for a document. You can view each part by selecting the name of the part that you want to view.5 . select Transactions the query panels. In this case. you can view the values of the document attributes that Trading Networks extracted from the document. first perform the procedure in “Viewing Documents in Your System” on page 442 to display a list of documents that contains the document in which you are interested. Note: Trading Networks only saves a copy of the document content.

doc:relateDocuments built-in service to relate the purchase order to the acknowledgment that you send in response to the purchase order. use the Detail view. select the name of the part that you want to view.Viewing Documents in Your System 5 To view the document content. you might use the wm. If the document contains multiple parts. if you receive a purchase order. webMethods Trading Networks User’s Guide Version 6. select Transactions View Detail/Summary to switch to the Detail view. you can relate documents to one another.tn. Trading Networks automatically relates documents that are part of a conversation. Then. Click the row containing the document for which you want to view related documents. you might set the service input as follows: fromDoc—the purchase order toDoc—the purchase order acknowledgement relationship—POACK When there are relationships between documents. In this example. To relate documents.doc:relateDocuments built-in service. If you are currently using the Summary view. In addition. first perform the procedure in “Viewing Documents in Your System” on page 442 to display a list of documents that contains the document you are interested in. you can easily view all the documents in the same conversation that Trading Networks has received. “Delivery Tasks” on page 465. use the wm. Note: You can click also the Activity Log tab and Tasks tab to view the activity log entries and tasks that are associated with this document. To view related documents 1 2 On the Transaction Analysis screen. For more information. select the Content tab.tn. Viewing Related Documents Related documents are documents that are associated with one another in some way. To view the related documents.5 449 . at the top of the screen. and “Service Execution Tasks” on page 481. perform the following procedure. see “The Activity Log” on page 495. you can view documents that are related. This built-in service takes as input: fromDoc—the document that you want to relate another document to toDoc—the document you want to relate to fromDoc relationship—a string that describes the relationship For example. if a document is part of a conversation. For example.

csv file.csv file in Microsoft Access allowing you to further analyze the data. You can also open the file in other applications.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s 3 Select Transactions View Related Documents.. You can select the type of extension to use for the exported file. see “Scheduled Delivery Queues” on page 378.5 . When a document is scheduled for delivery. see Chapter 15. For instructions on how to view pollable documents. if you export the data to a . e. Viewing Pollable Documents Pollable documents are documents that are queued for a trading partner. . The receiving partner’s Trading Networks will periodically poll your system to determine whether any documents are queued for it.csv. Another example is that you can open a . When you define the queue. see “Viewing Documents that are Queued for Polling” on page 397. and places the delivery task into a queue that you defined. After data is exported to the file. Viewing Documents that are Scheduled for Delivery Scheduled delivery allows you to batch documents to be delivered at scheduled times. you can export the information to a file. “Queues in Trading Networks”. For example. creates a delivery task to manage the delivery of the document. 450 webMethods Trading Networks User’s Guide Version 6.txt or .g. For more information about queuing documents for partners. For instructions on how to view documents that are scheduled for delivery. you associate a delivery schedule that indicates when Trading Networks attempts to deliver the documents. Exporting Detail View Information to a File To print the information that Trading Networks displays in the Detail view of the Transaction Analysis screen or make the information available for other applications. Trading Networks changes the processing status to QUEUED. you can print the file. For more information about scheduled delivery and queues. you can open the file in Microsoft Excel allowing you to create charts and reports based on the data. see “Viewing Documents that are Scheduled for Delivery” on page 396.

Viewing Documents in a Partner’s System Perform the following procedure to export the information that Trading Networks displays in the Detail view to a text file. View Detail/Summary 3 4 5 6 In the Export Query Results as Comma-Separated Values dialog box. If you need procedures for this step. If a partner uses Web Manager. if a partner uses Trading Networks Web Manager. Click OK. You can cut-and-paste the query that Trading Networks displays for use in the other application. select Transactions to switch to the Detail view. you must supply the user name and password that has partner authority. a third-party reporting tool. you might be able to access information from a Web browser. Trading Networks displays a dialog specifying the amount of data saved. see “Starting the Trading Networks Console” on page 22. Perform the procedures in either “Viewing Documents in Your System” on page 442 or “Viewing Documents Using the Trading Partners Selection” on page 447 to list the information you want to export. If you are currently using the Summary view. Determining the SQL for a Document Query To view the SQL query that Trading Networks is currently using against its database to obtain the document information in the display. To access the HTML pages of Web Manager. for example.5 451 . select Transactions View SQL. specify the file to which you want to save the exported information from the Detail view. Viewing Documents in a Partner ’s System You cannot use the Trading Networks Console to view information in a partner’s system. Select Transactions Export Query Results. Check with your partner to see if you can access their system using Web Manager. However. You might want to use this query in another application. ask them for the URL you must use to access it. webMethods Trading Networks User’s Guide Version 6. To export the Detail view information to a file 1 2 Start the Trading Networks Console. Click Save.

When Trading Networks resubmits a document. Reprocess: Trading Networks simply reprocesses the document. it performs document recognition and therefore extracts the attributes again. For more information about the Save Document to Database pre-processing action.5 . if the document did not match any of your TN document type definitions or the document triggered the incorrect processing rule. If you are resubmitting a flat file document. Create or modify a TN document type definition to recognize the document before processing the document again. see the following section. 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 When to use resubmit: Use resubmit if the document was not recognized when it was originally received. “Considerations When Resubmitting a Flat File Document” for more information. and processes the document. “PreProcessing Actions in the TN Flat File Document Type” on page 294. Prerequisite for resubmitting: Document content must be saved. You might want to process a document again. Resubmitting a Saved Document When you resubmit a document. 452 webMethods Trading Networks User’s Guide Version 6. and “Pre-Processing Actions” on page 327. for example. Note: You can still resubmit a document even if you do not save the attributes.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s Processing a Saved Document Again If you save documents to the database. The processing that Trading Networks performs depends on whether you select the resubmit function or the reprocess function: Resubmit: Trading Networks recognizes the document again. extracts the attributes. see: “Specifying Pre-Processing Actions for TN XML Document Type” on page 227. you can have Trading Networks process a document again.

the processing rule that Trading Networks selects might not be the one that you expect. If the TN flat file document type uses the Retrieve SenderID from session option.5 453 . Administrator).g. For more information about flat file documents. If $receiveSvc was not set. receiver. during the resubmit. If the user logged into the Console is not a partner. which will not be able to properly recognize the flat file document. the sender. the active user is the IS user account that you used to log in to the Trading Networks Console (e. In either of these cases. “TN Flat File Document Types”. and TN document type will all be unknown. Use of the Retrieve SenderID from session option in a TN flat file document type might not work as you expect. webMethods Trading Networks User’s Guide Version 6.Trading Networks sends the document to wm. and the resubmission of the flat file document will fail.tn:receive. Trading Networks will retrieve the active user as the sender of the resubmitted flat file document. consider the following: Trading Networks needs to know the gateway service to which to submit. Trading Networks might select a different processing rule for the resubmitted flat file document. If the user logged into the Console happens to be associated with a partner on your system. As a result. if $receiveSvc was set to the gateway service. Typically. This information should have been set by the gateway service when Trading Networks originally received the document. If the user logged into the Console is not the same partner that originally sent the flat file document. see Chapter 13. a processing rule that uses the sender criteria will not match the resubmitted flat file because the sending user is not a partner.Resubmitting a Saved Document Considerations When Resubmitting a Flat File Document When resubmitting flat file documents. Trading Networks invokes that gateway service. The gateway service must have set the $receiveSvc variable within the TN_parms variable in the pipeline (/Tn_parms/$receiveSvc) to the fullyqualified service name of the gateway service. the user account you use to log in to the Console is not associated with a partner in your trading network. it might not be the original partner that sent the flat file document.. Because you are resubmitting the document from the Trading Networks Console. When you resubmit the document.

the fully qualified name of the service would be “partners.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s Steps to Resubmit a Saved Document To resubmit a document. Perform the procedures in either “Viewing Documents in Your System” on page 442 or “Viewing Documents Using the Trading Partners Selection” on page 447 to list the document that you want to reprocess. validate. or save the document. see “Defining Document Gateway Services” on page 276 in Chapter 13.east:gateway1“. select Transactions to switch to the Detail view.5 . If you reprocess a document for 454 webMethods Trading Networks User’s Guide Version 6. To resubmit a document 1 2 Start the Trading Networks Console. For example. specify the processing status DONE W/ ERRORS for the processing status in the basic criteria. 4 5 Select Transactions Resubmit. if your service is named “gateway1“ and is located in the “partners. View Detail/Summary Note: If you are resubmitting a flat file document. Note: To find documents that were processed but encountered errors in the recognition process. perform the following procedure. 3 If you are currently using the Summary view. the document gateway service must have already set the $receiveSvc variable within TN_parms (/Tn_parms/$receiveSvc) to the fully-qualified service name of the gateway service. Click Yes to verify that you want to resubmit the document. If you need procedures for this step. Reprocessing a Saved Document When you reprocess a document. see “Starting the Trading Networks Console” on page 22. Trading Networks does not recognize the TN document type again and therefore does not re-extract the attributes. Trading Networks performs the following processing: Performs a processing rule lookup to determine the rule to use Performs the processing actions identified in the matching processing rule Note: When reprocessing a saved document.east“ folder. When you reprocess a document. “TN Flat File Document Types”. Trading Networks does not perform preprocessing actions—verify. For more information about setting up a document gateway service. check uniqueness.

Then. Note: To find documents that were processed but encountered errors in the recognition process. To reprocess a document 1 2 Start the Trading Networks Console. For more information about the Save Document to Database pre-processing action.5 455 . When to use reprocess: Use reprocess if the document did not trigger the appropriate processing rule when it was originally received. Instead. If you need procedures for this step. Note: If you are using extended criteria in your processing rules. Trading Networks will match to another processing rule. “PreProcessing Actions in the TN Flat File Document Type” on page 294. for example the default processing rule. see “Starting the Trading Networks Console” on page 22. and perform the processing actions identified in that matching rule. and “Pre-Processing Actions” on page 327. Another situation is if you change the user status of the document and want to advance the document to the next step of processing. Perform the procedures in either “Viewing Documents in Your System” on page 442 or “Viewing Documents Using the Trading Partners Selection” on page 447 to list the document that you want to reprocess. select Transactions to switch to the Detail view. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 227. View Detail/Summary webMethods Trading Networks User’s Guide Version 6.Reprocessing a Saved Document which Trading Networks saved the document content but not the attributes. process the document again. Trading Networks will not match processing rules that use extended criteria (route based on custom attributes). the custom attributes must also be saved. Steps to Reprocess a Saved Document To reprocess a document. Trading Networks does not perform document recognition again and therefore does not re-extract the attributes. Prerequisite for reprocessing: Document content must be saved. specify the processing status DONE W/ ERRORS for the processing status in the basic criteria. 3 If you are currently using the Summary view. When you reprocess the document. the extended criteria of the processing rule will fail if Trading Networks does not have the custom attributes saved. perform the following procedure. Create or modify the processing rules so the document triggers the correct rule.

Additionally. you can choose to archive documents contained in any or all of the non-archival tables listed below. and more. non-archival Trading Networks tables except that the archival tables do not contain primary keys. The archival tables mirror the tables that Trading Networks uses for its normal operation: Corresponding table that Trading Networks uses for normal operation BizDoc BizDocContent BizDocAttribute BizDocArrayAttribute BizDocRelationship DeliveryJob ActivityLog BizDocUniqueKeys EDITracking Archival Table ARCHIVE_BizDoc ARCHIVE_BizDocContent ARCHIVE_BizDocAttribute ARCHIVE_BizDocArrayAttribute ARCHIVE_BizDocRelationship ARCHIVE_DeliveryJob ARCHIVE_ActivityLog ARCHIVE_BizDocUniqueKeys ARCHIVE_EDITracking Data in the archival tables is identical to the data in the normal. it removes the document information and the references to the document from all non-archival tables in the database. receiver. it moves document information into archival tables.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s 4 5 Select Transactions Reprocess.5 . system status. such as the document ID. That is. foreign keys or unique column constraints. After a 456 webMethods Trading Networks User’s Guide Version 6. Archiving and Deleting Documents You can set up Trading Networks to perform data archival and deletion. Archiving Documents When Trading Networks archives a document. sender. You do not have to archive a document before deleting it. you specify how many days after a document is received that you want Trading Networks to archive and delete the document. Using the “basic” archival and deletion feature. you can choose to archive only selected parts of documents. The “configurable” archival and deletion feature provides much greater flexibility than the “basic” deletion feature. Click Yes to verify that you want to reprocess the document. Trading Networks provides a built-in service that enables you to selectively archive documents based on additional criteria. When Trading Networks archives a document.

deleteAfterDays system property. it removes all document information (whether in the archival tables or non-archival tables) from the database. In the Settings menu of the navigation panel. Deleting Documents When Trading Networks deletes a document.archive. and schedule when you want the archive and deletion service to run. In the Solutions menu of the navigation panel. For example. after a document is archived.archive. click Trading Networks. To set the archival and deletion system properties 1 2 Open the Server Administrator if it is not already open. Setting Up Basic Archival and Deletion To set up the “basic” document archival and deletion feature. or Activity Log screens.5 457 . The Server Administrator opens a new browser window to display Trading Networks-specific pages. Click Edit TN Properties Settings. Tasks. the archived information is no longer available from the Trading Networks Console or Web Manager. Setting How Many Days to Retain Documents before Archival and Deletion Set the tn. you add Trading Networks system properties to the Trading Networks properties file. click TN Properties.Archiving and Deleting Documents document is archived. Set the tn. If you want Trading Networks to only delete documents and not archive them. Note: The “configurable” deletion feature will delete all documents from archival tables.archive.deleteAfterDays system property to specify how many days Trading Networks should keep a document from the time it was received before deleting it. specify only the tn. 3 4 webMethods Trading Networks User’s Guide Version 6.archiveAfterDays system property to specify how many days Trading Networks should keep a document from the time it is received before archiving it. you cannot alter this behavior. you will no longer be able to view information about it on the Transaction Analysis.

archive.deleteAfterDays How many days after Trading Networks receives the document that Trading Networks should delete it. Its fully qualified service name is: wm.tn. If you do not specify this property or if you specify 0 for this property. Scheduling When To Archive and Delete Documents You must schedule when you want Trading Networks to periodically run the archival and deletion service to archive and delete files.5 . Specify a value from 0 through 730365. Trading Networks does not archive documents. use the Server Administrator to set up a user task that executes the archive and delete service.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s 5 Add or update the following properties: For this system property … tn.archive:archive.deleteAfterDays=60 6 Click Save Changes. If you do not specify this property or if you specify 0 for this property. Click Create a scheduled task. add the following: tn. Trading Networks is shipped with the archive and delete service.archive. see the webMethods Integration Server Administrator’s Guide. In the Server menu of the navigation area. 458 webMethods Trading Networks User’s Guide Version 6. Example: If you want Trading Networks to delete documents 60 days after they are received.archive. Example: If you want Trading Networks to archive documents 30 days after they are received.archiveAfterDays Specify … How many days after Trading Networks receives the document that Trading Networks should archive it. To schedule when to archive and delete documents 1 2 3 Open the Server Administrator. To schedule the execution of the service. click Scheduler. Specify a value from 0 through 730365. add the following: tn.archiveAfterDays=30 tn. If you need instructions. Trading Networks does not delete documents.archive.

5 459 . that you want the server to wait until the current occurrence of the task completes before repeating the task. Whether you want the task to run anywhere in your cluster of servers. Complex Repeating The date and time of the first execution of the service in the Start Date and Start Time fields and how often after the initial execution that you want the service to run using the parameters in the Run Mask field.archive:archive Administrator That you want the server to maintain this user task in the event that the server is restarted by selecting the Persist after restart checkbox.tn. specify that you want the service to be executed periodically.Archiving and Deleting Documents 4 Set the Service Information parameters as follows: For this parameter… folder:subfolder:service Run As User Persistence Specify… wm. Clustering 5 In the Schedule Type and Details section of the screen. specify the additional parameters to indicate when and how often you want the archival and deletion service to run. Then. Note: The service executes for the first time immediately after you schedule the user task. select the Repeat from end of invocation checkbox to indicate that if the current occurrence of the task is not complete when the interval elapses. For example. 2001. In the Repeating field. see the webMethods Integration Server Clustering Guide. starting on March 15.m. For more information on clusters. specify the following parameters: webMethods Trading Networks User’s Guide Version 6. if you want the service to run once every 24 hours. Example: To specify that you want the service to execute daily at 10 p. If you select… Repeating Specify… The number of seconds that you want the server to wait between executions of the service in the Interval field. by selecting either Repeating or Complex. specify 86400.

tn. To set the configurable archival and deletion service 1 2 3 4 Open the Developer if it is not already open. which are described in the webMethods Trading Networks Built-in Services Reference. 6 Click Save Tasks.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s If you select… Specify… Start Date Start Time End Date End Time Months Days Weekly Days Hours Minutes 2001/3/15 22:00:00 leave blank leave blank no selection no selection no selection 22 0 Note: Note: Omitting the End Date and End Time indicates that the service is to run indefinitely. open the folders wm in service extendedArchive. 460 webMethods Trading Networks User’s Guide Version 6. Save the values. you specify values for the input parameters of the built-in archive and deletion service wm.tn.5 . and schedule when you want the service to run.archive:extendedArchive service. In the WmTN package.extendedArchive. Setting Up Configurable Archival and Deletion To set up the “configurable” document archival and deletion feature. Note: For more information about these parameters. tn archive and double-click the built- Specify values for the input parameters of the wm. see information about scheduling services in the webMethods Integration Server Administrator’s Guide.

use the Developer to create a wrapper service that executes the archive and delete service. see the webMethods Integration Server Clustering Guide. If you need instructions. Trading Networks is shipped with the archive and delete service. click Scheduler. specify the additional parameters to indicate when and how often you want the archival and deletion service to run.tn. To schedule the execution of the service. Clustering 7 In the Schedule Type and Details section of the screen. For more information on clusters. specify that you want the service to be executed periodically. Then.archive:extendedArchive. webMethods Trading Networks User’s Guide Version 6.tn. Then use the Server Administrator to set up a user task that executes the archive and delete service. Whether you want the task to run anywhere in your cluster of servers.5 461 .Archiving and Deleting Documents Scheduling When To Archive and Delete Documents You must schedule when you want Trading Networks to periodically run the archival and deletion service to archive and delete files. see the webMethods Integration Server Administrator’s Guide. by selecting either Repeating or Complex. To set the archival and deletion system properties 1 2 3 4 5 6 Open the Developer if it is not already open. Click Create a scheduled task. Set the Service Information parameters as follows: For this parameter… folder:subfolder:service Run As User Persistence Specify… Your wrapper service Administrator That you want the server to maintain this user task in the event that the server is restarted by selecting the Persist after restart checkbox. Open the Server Administrator. Its fully qualified service name is: wm.archive:extendedArchive. Create a wrapper service that invokes the service wm. In the Server menu of the navigation area.

5 . specify the following parameters: Start Date Start Time End Date End Time Months Days Weekly Days Hours Minutes 2001/3/15 22:00:00 leave blank leave blank no selection no selection no selection 22 0 Note: Note: Omitting the End Date and End Time indicates that the service is to run indefinitely. starting on March 15. Note: The service executes for the first time immediately after you schedule the user task. specify 86400. Example: To specify that you want the service to execute daily at 10 p. For example.m. select the Repeat from end of invocation checkbox to indicate that if the current occurrence of the task is not complete when the interval elapses. 462 webMethods Trading Networks User’s Guide Version 6. In the Repeating field. that you want the server to wait until the current occurrence of the task completes before repeating the task. 2001.C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s If you select… Repeating Specify… The number of seconds that you want the server to wait between executions of the service in the Interval field. Complex Repeating The date and time of the first execution of the service in the Start Date and Start Time fields and how often after the initial execution that you want the service to run using the parameters in the Run Mask field. if you want the service to run once every 24 hours.

webMethods Trading Networks User’s Guide Version 6.5 463 . 8 Click Save Tasks. see information about scheduling services in the webMethods Integration Server Administrator’s Guide.Archiving and Deleting Documents Note: For more information about these parameters.

C H A P T E R 1 8 M a n a g i n g a n d Tr a c k i n g D o c u m e n t s 464 webMethods Trading Networks User’s Guide Version 6.5 .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467 Finding and Viewing Delivery Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 About Viewing Delivery Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475 Stopping a Delivery Task for Immediate Delivery . 472 Running Delivery Tasks Queries . . 478 Reassigning a Delivery Task to Another Server . . . . . . . . . . . . .5 465 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477 Deleting Delivery Tasks . . . . . . . . . . . . . . . 476 Restarting an Immediate Delivery Task . . . . . . . . . . . . . . . .CHAPTER 19 Delivery Tasks What is a Delivery Task? . . . . . . 479 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

"Delivering Documents to Partners" in the webMethods Trading Networks Concepts Guide. 466 webMethods Trading Networks User’s Guide Version 6. There are two types of delivery tasks—delivery tasks for immediate deliveries and delivery tasks for scheduled deliveries. Trading Networks also always uses reliable delivery for a scheduled delivery. Configuring tasks setting. see Chapter 6. When Trading Networks queues a document for delivery. For more information about Delivery tasks and reliable delivery.g. Trading Networks attempts to deliver a document using an immediate delivery method when a processing rule uses the Deliver Document By processing action and the Immediate Delivery checkbox is selected. Trading Networks uses an immediate delivery method (e. Trading Networks uses reliable delivery and creates a delivery task for the immediate delivery only when it is instructed by the Save Document to Database pre-processing action to save the document content. Primary HTTP or Secondary FTP) to deliver a document directly to the receiving partner. Trading Networks attempts to deliver a document using a scheduled delivery method when a processing rule uses the Deliver Document By processing action and the Scheduled Delivery checkbox is selected.5 . Reliable delivery is a feature of Trading Networks where Trading Networks attempts to deliver a document to a partner one or more times based on settings that you define. Scheduled deliveries—For a scheduled delivery. and then delivered at scheduled times. Trading Networks uses reliable delivery for both immediate and scheduled deliveries. Trading Networks places a document to be delivered in a public or private delivery queue to be batched. see “Configuring Tasks Settings” on page 52.C H A P T E R 1 9 D e l i v e r y Ta s k s What is a Delivery Task? A delivery task is information that webMethods Trading Networks (Trading Networks) maintains for a document that Trading Networks is delivering using reliable delivery.. Immediate deliveries—For an immediate delivery. it always saves the document content to the database.

Trading Networks calculates the time to wait by multiplying the last wait time by Retry Factor. For a description of task statuses. For a scheduled delivery. Trading Networks uses the Time To Wait value along with the Retry Factor to calculate how long to wait for subsequent retry attempts. For example. Maximum number of times Trading Networks is to attempt to re-deliver the document as defined in the partner’s profile. If you plan to use the same query many times. Timestamp from the last time Trading Networks updated the delivery task. first specify a query to identify the delivery tasks in which you are interested.5 467 . you can name and save the query. The type of task. To view tasks. Status of the delivery task. The factor Trading Networks uses to calculate how long to wait before making the second and subsequent attempts to re-deliver a document when using an immediate delivery method. the Tasks feature is not available through the Trading Networks Console. Timestamp from when Trading Networks created the delivery task. Task Status Delivery Method Retry Limit Retry Factor webMethods Trading Networks User’s Guide Version 6. Trading Networks returns information about the delivery tasks that meet the search criteria in your query. you simply select it.About Viewing Delivery Tasks About Viewing Delivery Tasks To view delivery tasks. including the name of the service. for an immediate delivery. Delivery method that Trading Networks is to use to deliver the document. Task Type is “Delivery”. Trading Networks displays Scheduled Delivery Service and provides additional information about the scheduled delivery service. This is usually the last time Trading Networks attempted to deliver the document. Delivery Method might be Primary HTTP or Secondary HTTPS. The following lists the information that Trading Networks maintains for a delivery task: Information in a delivery task Task ID Task Type Time Created Time Updated Description A unique identifier that Trading Networks assigns to the delivery task. use Trading Networks Web Manager. For a delivery task. Note: If you are using an OEM version of the Trading Networks. When you want to reuse the query. see “Delivery Task Statuses” on page 469.

The value of Status can be: “success” after Trading Networks has delivered the document successfully “fail” if Trading Networks has not yet delivered the document successfully blank if Trading Networks is using a schedule delivery and has not yet made an attempt to deliver the document Status Message The status message returned with the response from the last attempt Trading Networks made to deliver the document. The Server ID is the host name of the machine on which the Integration Server is installed. For scheduled delivery. For more information on clusters. The Server ID is useful when the Integration Server is in a clustered environment. Status Whether the last attempt to deliver the document was successful or not. 404 Authorization required). Identification of the Integration Server that is processing this delivery task.g. 200 OK) or unsuccessfully (e. Transport Time Server ID 468 webMethods Trading Networks User’s Guide Version 6. if the delivery method is HTTP.g. For scheduled delivery. number of milliseconds it took the delivery service to send the document to the receiving partner and wait for a response. For more information on server configuration parameters.. if the delivery method is HTTP. Trading Networks uses the Time To Wait value along with the Retry Factor to calculate how long to wait for subsequent retry attempts. Trading Networks attempts to deliver as dictated by the schedule that is associated with the queue. Number of milliseconds Trading Networks is to wait before making its first attempt to redeliver the document when using an immediate delivery method. On the last attempt to deliver the document. see the webMethods Integration Server Clustering Guide.C H A P T E R 1 9 D e l i v e r y Ta s k s Information in a delivery task Retries Time To Wait Description Number of times Trading Networks has already attempted to redeliver the document. The response can indicate the document was sent successfully (e.5 . Transport Time is the number of milliseconds it took Trading Networks to post the document until it received a response from the post. see the appendix defining the server configuration parameters in the webMethods Integration Server Administrator’s Guide. For example. Trading Networks does not use Time To Wait and Retry Factor because it does not need to determine how long to wait before the next retry.. Status Message might be “200 OK”. For example.

but the document has not been successfully delivered yet. The data. Trading Networks has attempted to deliver the document one or more times. and the maximum retry limit has been reached DONE Trading Networks has successfully delivered the document n/a PENDING webMethods Trading Networks User’s Guide Version 6. but the maximum retry limit has not been reached FAILED—if the delivery is unsuccessful. For private queues.g. Trading Networks displays the internal partner ID. this is the name of the queue in which the document resides. Task Output Delivery tasks remain in the Trading Networks system until you delete them or until the document with which the delivery task is associated is archived or deleted. an XML document). if the delivery method is Primary HTTP. For more information about archiving and deleting documents.About Viewing Delivery Tasks Information in a delivery task Queue Name Description If Trading Networks queued this document for scheduled delivery. then Task Output would contain the XML document.5 469 . Task Statuses for Immediate Deliveries The following table lists the task statuses associated with a delivery task for an immediate delivery. if any. see ““Archiving and Deleting Documents” on page 456. Delivery Task Statuses The tasks statuses for delivery tasks are different based on whether the delivery task is for an immediate delivery or a scheduled delivery.. Next Status PENDING—after Trading Networks makes its first attempt to deliver the document DONE—if the delivery completes successfully PENDING—if the delivery is unsuccessful. returned from a successful delivery of a document. and the post returns output (e. Task Status NEW Meaning Trading Networks has just created the delivery task and has not attempted to deliver the document yet. For example.

Task Status QUEUED Meaning Trading Networks has added the delivery task to the queue.5 . you need to create an Integration Server trigger that subscribes to the wm. Note: The scheduled delivery service acts on all of the delivery tasks that have a QUEUED status. Trading Networks has reached the maximum retry limit for the document and was unable to deliver the document.tn. Next Status DELIVERING—when the scheduled delivery service reads the delivery task from the queue 470 webMethods Trading Networks User’s Guide Version 6.rec:TaskFailure IS document type. These delivery tasks include all of the QUEUED delivery tasks already in the queue and any new QUEUED tasks added to the queue before the execution of the delivery service. For more information.C H A P T E R 1 9 D e l i v e r y Ta s k s Task Status STOPPED Meaning Trading Networks has stopped the delivery due to a manual user request. Note: If you want to be notified when tasks fail. Trading Networks has invoked the scheduled delivery service to deliver the document zero or more times. but the document has not been successfully delivered yet. see the PublishSubscribe Developer’s Guide. Next Status PENDING—if the delivery task is restarted PENDING—if the delivery task is restarted FAILED Task Statuses for Scheduled Deliveries The following table lists the task statuses associated with a delivery task for a scheduled delivery.

you need to create an Integration Server trigger that subscribes to the wm.5 471 . and the maximum retry limit has been exceeded DONE The scheduled delivery service successfully delivered the document that is associated with the delivery task.rec:TaskFailure IS document type. Next Status DONE—if the delivery completes successfully QUEUED—if the delivery is unsuccessful.About Viewing Delivery Tasks Task Status DELIVERING Meaning The scheduled delivery service is currently working with this delivery task to attempt to deliver the corresponding document. but the maximum retry limit has not been exceeded FAILED—if the delivery is unsuccessful. see the PublishSubscribe Developer’s Guide. The scheduled delivery service was unable to deliver the document that is associated with the delivery task and the maximum retry limit has been exceeded Note: If you want to be notified when tasks fail.tn. For more information. n/a FAILED QUEUED—if the delivery task is restarted webMethods Trading Networks User’s Guide Version 6.

472 webMethods Trading Networks User’s Guide Version 6. Trading Networks displays the Task Details screen. To indicate that you want to view delivery tasks. use Trading Networks Web Manager. If you need procedures for this step. a b Select Show Query criteria. you can use the search criteria on the Tasks screen to query for specific tasks. on the toolbar to have Trading Networks display the search 4 . Note: If you are using an OEM version of the Trading Networks. Select View Tasks. You can view all delivery tasks or search for tasks based on the following criteria: Partner—partner that is to receive the document that is being delivered Task Status—status of the delivery task Delivery method—how Trading Networks is to deliver the document to the partner (e. select the checkbox associated with each criterion that you want to use and fill in the corresponding information as described below: For this parameter. To see detailed information about a specific delivery task. the Tasks feature is not available through the Trading Networks Console. Primary HTTP) Time created—time Trading Networks created the delivery task To find and view delivery tasks in your system 1 2 3 Start the Trading Networks Console. Task Type Specify The type of task. see “Starting the Trading Networks Console” on page 22. To view tasks..5 . If you cannot find the delivery task you are looking for.To specify the delivery tasks that you want to view.C H A P T E R 1 9 D e l i v e r y Ta s k s Finding and Viewing Delivery Tasks Use the Tasks screen to find and view delivery tasks in your Trading Networks system. select: Delivery from the list..g.. double click on the row containing the task you want more detailed information about.

do not use this criterion. Scheduled delivery – To view delivery tasks for scheduled delivery that use the same scheduled delivery service. or click to open a dialog that allows you to select the date from a calendar. uncheck the checkbox for that criterion. Delivery Method How Trading Networks is to deliver the document to the partner. Then specify dates in the Beginning and Ending fields. Primary HTTP).. select Custom from the list.. To view delivery tasks regardless of the date that Trading Networks created them. For more information about how to select a partner.g. To view delivery tasks of all statuses. Task Status The status of the delivery tasks you want to view. do not use this criterion.. Type in the name of the partner or click the Select. To specify a date range. The list that Trading Networks returns in response to your query might contain delivery tasks in several queues because a single schedule delivery service can be associated with multiple queues.Finding and Viewing Delivery Tasks For this parameter. Time Created The date Trading Networks created the delivery task.. select an immediate delivery method from the list. You can type in a date value. Select the delivery method from the list. select the name of the schedule delivery service from the list. Select an entry from the list. Partner Specify The partner that is to receive the document that is being delivered by the delivery tasks that you want to view. To view delivery tasks regardless of the delivery method being used. Select the status from the list. webMethods Trading Networks User’s Guide Version 6. see “Selecting a Partner” on page 34. Immediate delivery – To view delivery tasks for immediate deliveries that use the same delivery method (e. If you decide you do not want to use a criterion that you have filled out.5 473 . button to select a partner from the Partner Selection Dialog.. do not use this criterion.

you can export the information to a text file.csv. Trading Networks updates the Tasks table on the bottom portion of the screen with the query results. You can select the type of extension to use for the exported file. To view delivery tasks associated with a specific document 1 Perform the steps described in “Viewing Documents in Your System” on page 442 to have Trading Networks list information about the document in which you are interested. see step 4 on page 472.g. Select Transactions Select the Tasks tab. Trading Networks displays the Tasks Details screen. To view the details for a delivery task. 2 3 4 5 Perform a delivery task query. you can print the file. Select Run Query on the toolbar. When you export the information. After data is exported to the file. double click the row containing that delivery task. Select the row containing the document for which you want to view delivery tasks.5 . Trading Networks updates the Tasks table on the bottom portion of the screen with the query results. double click the row containing that delivery task.C H A P T E R 1 9 D e l i v e r y Ta s k s 5 6 Select Run Query on the toolbar. separating the values with commas.txt or . . on the toolbar to display the query panels if they are not View Document.. you can view delivery tasks associated with a specific document. Trading Networks places the information into the file. e. To view the details for a delivery task. Viewing the Delivery Tasks Associated with a Document Rather than viewing all the delivery tasks in your system. You can also open the file in other 474 webMethods Trading Networks User’s Guide Version 6. To further refine the list of delivery tasks. perform the following steps: a b Select Show Query already displayed. For instructions how to fill out the fields in the query panel to select the delivery tasks that you want to view. c d Exporting Delivery Task Information to a File To print the delivery task information that Trading Networks displays on the Tasks screen or make the information available for other applications.

Another example is that you can open a . see “Starting the Trading Networks Console” on page 22.Running Delivery Tasks Queries applications. specify the file to which you want to save the exported delivery task information.5 475 . see the following table: Query Function “Enabling the Query Functions” “Creating and Saving a Query” “Selecting and Running a Query” “Updating the Search Criteria for a Saved Query” “Saving a New Query Based on an Existing Query” “Reverting to a Saved Query” “Deleting Saved Queries” See page. For example. Perform the following procedure to export the delivery task information that Trading Networks displays to a text file. For more information about the different query functions that you can perform for delivery task queries. Click Save. Trading Networks adds the delivery task query to the list of saved queries on the tool bar. Running Delivery Tasks Queries If you plan to use the same delivery task query many times. if you export the data to a . page 402 page 404 page 405 page 406 page 407 page 407 page 408 webMethods Trading Networks User’s Guide Version 6. To export the delivery task information to a file 1 2 3 4 5 Start the Trading Networks Console.. you can save the query. Perform the procedures in “Finding and Viewing Delivery Tasks” on page 472 to list the information you want to export. Trading Networks displays a dialog specifying the amount of data saved. When you want to reuse the query.csv file in Microsoft Access allowing you to further analyze the data. If you need procedures for this step. Select Tasks Export Query Results. you simply select it from the queries list. you can open the file in Microsoft Excel allowing you to create charts and reports based on the data.csv file. In the Export Query Results as Comma-Separated Values dialog box. Click OK..

5 . button to select the partner from the Partner Selection Dialog. Trading Networks updates the Tasks table on the bottom portion of the screen with the query results. disable or suspend the queue where the task resides. If you need procedures for this step. see “Trading Networks in a High Availability Environment” on page 44. Select the Partner field and select the partner that is to receive the document you want to stop. you can stop the delivery task for immediate delivery. You might also want to stop a delivery task if you are running Trading Networks in a clustered environment and you want to reassign the delivery task to another server in the cluster. 476 webMethods Trading Networks User’s Guide Version 6.C H A P T E R 1 9 D e l i v e r y Ta s k s Stopping a Delivery Task for Immediate Delivery If you want to stop the delivery of a document.. and select Delivery from the list. enable the queue. You might want to stop a delivery task if the receiver of the document cannot receive the document at the current time. Perform the following procedure to stop a delivery task for immediate delivery: To stop a delivery task for immediate delivery 1 2 3 4 5 Start the Trading Networks Console. 6 7 8 Select Run Query on the toolbar. To indicate that you want to work with delivery tasks. For more information about how to select a partner. see “Starting the Trading Networks Console” on page 22. Select View Tasks. a Note: If you want to stop a scheduled delivery task. Select the task you want to stop by clicking the row for the delivery task.. For information on running Trading Networks in a clustered environment. Select Tasks Stop to stop the delivery task. click the Task Type checkbox. see “Selecting a Partner” on page 34. Type in the name of the partner or click the Select. When you want to restart the delivery. on the toolbar to display the query panels if they are not already Select Show Query displayed.

webMethods Trading Networks User’s Guide Version 6. see “Starting the Trading Networks Console” on page 22. To indicate that you want to work with delivery tasks. When you restart a delivery task. on the toolbar to display the query panels if they are not already Select Show Query displayed. Select View Tasks. click the Task Type checkbox. button to select a partner from the Partner Selection Dialog. Perform the following procedure to restart an immediate delivery task: To restart an immediate delivery task 1 2 3 4 5 Start the Trading Networks Console. and select Delivery from the list. For more information about how to select a partner.. If you need procedures for this step. When a delivery task is restarted and the delivery is an immediate delivery. set the Task Status field to STOPPED. Trading Networks then attempts to deliver the document again up to the number of attempts defined by the Maximum Retry Limit setting. To list failed delivery tasks. Select the Partner field and select the partner that is to receive the document you want to restart. Note: You can restart only tasks that were started on the Integration Server to which the Trading Networks Console currently has an open session. enable the queue that was previously disabled or suspended.5 477 . see “Selecting a Partner” on page 34. 6 Select the Task Status check box. To list stopped delivery tasks. Trading Networks resets the task status to PENDING and sets the Retries value to 0.. Type in the name of the partner or click the Select. you can restart it. Note: If you want to restart a scheduled delivery task. set the Task Status field to FAILED. If a delivery task has failed and you have resolved the problem that caused the failure. you can restart it. Trading Networks attempts to deliver the document again.Restarting an Immediate Delivery Task Restarting an Immediate Delivery Task If you previously stopped a delivery task for immediate delivery. You can only restart delivery tasks that have the task status STOPPED or FAILED.

You might want to delete delivery tasks that have the task status DONE because the documents have already been successfully delivered. select the Task Type checkbox. Trading Networks updates the Tasks table on the bottom portion of the screen with the query results. Select View Tasks. on the toolbar to display the query panels if they are not already Select Show Query displayed. Note: You can delete delivery tasks for both immediate and scheduled deliveries. To delete delivery tasks. perform a delivery task query. Trading Networks updates the Tasks table on the bottom portion of the screen with the query results. and select Delivery from the list. Perform the following procedure to manually delete a delivery task: To manually delete a delivery task 1 2 3 4 5 Start the Trading Networks Console. see step 4 on page 472. You might also want to delete delivery tasks with the tasks status FAILED if you cannot correct the problem or do not want Trading Networks to attempt to deliver the document again. Deleting Delivery Tasks Trading Networks automatically deletes delivery tasks when the document that is associated with a delivery task is either archived or deleted.5 . If you need procedures for this step. To indicate that you want to work with delivery tasks. see “Starting the Trading Networks Console” on page 22. To find the delivery task that you want to delete. you can manually delete delivery tasks. Select Run Query on the toolbar. you enter a query to display the tasks that you want to delete.C H A P T E R 1 9 D e l i v e r y Ta s k s 7 8 9 Select Run Query on the toolbar. Trading Networks deletes all delivery tasks that result from the query. Select the task you want to restart by clicking the row for the delivery task. b 478 webMethods Trading Networks User’s Guide Version 6. Select Tasks Restart to restart the delivery task. a For instructions how to fill out the fields in the query panel to select the delivery tasks that you want to view. If you do not use the archival and deletion feature of Trading Networks.

If the server is not running. click the Task Type checkbox. you can reassign delivery tasks that have a NEW.g. The server ID is the host name of the machine on which the Integration Server is installed. To find the delivery task that you want to reassign. you need to specify the server ID of the server to which you want to reassign the delivery task.. Select Run Query on the toolbar. If you have a clustered environment (that is. you can only reassign delivery tasks that have the status STOPPED or FAILED. or FAILED status. perform a delivery task query. a For instructions how to fill out the fields in the query panel to select the delivery tasks that you want to view. If the server on which the delivery task currently resides is running. Select View Tasks. If you update the Anonymous ACL or use a different ACL to protect these services. Trading Networks invokes the wm. see step 4 on page 472. The server to which you are reassigning the task must be running. click Yes. Perform the following procedure to reassign a delivery task: To reassign a delivery task to another server 1 2 3 4 5 Start the Trading Networks Console. To indicate that you want to work with delivery tasks. the server has failed for some reason). When Trading Networks prompts you to verify that you want to remove all displayed delivery tasks. multiple Integration Servers that share a single database). PENDING. you can reassign a delivery task to another server in the cluster. on the toolbar to display the query panels if they are not already Select Show Query displayed.server:connect and wm. Note: When reassigning a task. STOPPED.Reassigning a Delivery Task to Another Server 6 Select Tasks Delete to delete the displayed delivery tasks. Trading Networks might be unable to reassign tasks. As installed. Reassigning a Delivery Task to Another Server Each delivery task is associated with the Integration Server on which it was started. b webMethods Trading Networks User’s Guide Version 6. You might want to reassign a delivery task if for some reason you can no longer use the Integration Server on which a delivery task was started (e.5 479 . these services are protected by the Anonymous ACL.server:ping services. If you need procedures for this step. see “Starting the Trading Networks Console” on page 22. When you reassign a delivery task. Trading Networks updates the Tasks table on the bottom portion of the screen with the query results. and select Delivery from the list.

Select Tasks Reassign. Specify the server ID of the server to which you want to reassign the task in the Server ID to assign the task to field. 480 webMethods Trading Networks User’s Guide Version 6. Trading Networks displays a dialog box.5 .C H A P T E R 1 9 D e l i v e r y Ta s k s 6 7 8 9 Select the delivery task you want to reassign by clicking the row for the delivery task. Click OK.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489 Stopping a Service Execution Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482 Finding and Viewing Service Execution Tasks . . . . . . . . . . . . . . . 492 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . .5 481 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482 About Viewing Service Execution Tasks . . . . . .CHAPTER 20 Service Execution Tasks What is a Service Execution Task? . . . . . . . . . . . . . . . . . . . . . . . . . 490 Deleting Service Execution Tasks . . . . . . . . . . . . . . . 491 Reassigning a Service Execution Task to Another Server . . . . . . . . . . . . . . . . 489 Restarting a Service Execution Task . . . . . . . . . . . . . . 485 Running Service Execution Tasks Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C H A P T E R 2 0 S e r v i c e E x e c u t i o n Ta s k s What is a Service Execution Task? A service execution task is a task that webMethods Trading Networks (Trading Networks) performs to asynchronously execute a service using reliable execution. use Trading Networks Web Manager. Note: If you are using an OEM version of the Trading Networks.5 . Task Type is “Service execution”. 482 webMethods Trading Networks User’s Guide Version 6. see Chapter 5. Timestamp from when Trading Networks created the service execution task. The following lists the information that Trading Networks maintains for a service execution task: Information in a service execution task Task ID Task Type Time Created Description A unique identifier that Trading Networks assigns to the task. Configuring tasks setting. you simply select it. For a service execution task. Trading Networks sets up a service execution task to keep track of information about its attempts to execute the service. The type of task. When you want to reuse the query. If you plan to use the same query many times. Trading Networks returns information about the service execution tasks that meet the search criteria that you specified in your query. To view tasks. For more information about Service execution tasks. Reliable execution is a feature of Trading Networks that allows Trading Networks to automatically retry failed services. you can name and save the query. "Trading Networks Document Processing" in the webMethods Trading Networks Concepts Guide. You define the system-wide parameters that Trading Networks uses to determine how many times to attempt to re-execute a service and how often to attempt the retries. see “Configuring Tasks Settings” on page 52. Trading Networks attempts to execute the service subsequent times until the service succeeds or until Trading Networks reaches the maximum retry limit. the Tasks feature is not available through the Trading Networks Console. first specify a query to identify the service execution tasks in which you are interested. If Trading Networks attempts to execute a service and the service fails. About Viewing Service Execution Tasks To view service execution tasks.

These task statuses are only applicable to delivery tasks. Note: The QUEUED and DELIVERY task statuses are not applicable for service execution tasks. Task Status Delivery Method Delivery Method is not applicable for service execution tasks. Maximum number of times Trading Networks is to attempt to re-execute the service as defined in the reliable execution configuration settings. STOPPED—Trading Networks has stopped the task due to a manual user request. but the service has not been completed successfully.About Viewing Service Execution Tasks Information in a service execution task Time Updated Description Timestamp from the last time Trading Networks updated the service execution task. Trading Networks sets the Delivery Method to wm. This is usually the last time Trading Networks attempted to re-execute the service. Trading Networks considers a service execution successful when the service return values include Status set to “success”. Trading Networks considers an attempt to execute a service failed when the service return values include Status set to “fail”. Status of the service execution task. In other words. Retry Limit webMethods Trading Networks User’s Guide Version 6. the return values indicated that the service failed. Trading Networks executed the service the maximum times and each time the service was executed. It will be one of the following: NEW—Trading Networks just created the service execution task and has not attempted to execute the service yet. FAILED—Trading Networks has reached the maximum retry limit for the task and was unable to successfully execute the service. DONE—Trading Networks has successfully executed the service. Internally.tn.5 483 .route:invokeWrapper for service execution tasks. PENDING—Trading Networks has attempted to execute the service one or more times.

484 webMethods Trading Networks User’s Guide Version 6. The service must provide this value. If the service does not return a value for this field.C H A P T E R 2 0 S e r v i c e E x e c u t i o n Ta s k s Information in a service execution task Retry Factor Description The factor Trading Networks uses to calculate how long to wait before making the second and subsequent attempts to re-execute the service. Retries Time To Wait Status Status Message Transport Time Server ID Queue Name Task Output Service execution tasks remain in the Trading Networks system until you delete them or until the document with which the service execution task is associated is archived or deleted. The value the service returned for Status Message. Status is “success” if service executed successfully. Queue Name is not applicable for service execution tasks. see the webMethods Integration Server Clustering Guide.5 . Identification of the Integration Server that is processing this service execution task. The service output from the last attempt to execute the service. For more information on clusters. it will be blank. Status is “fail” if service failed. see ““Archiving and Deleting Documents” on page 456. The Server ID is useful when the Integration Server is in a clustered environment. The time it took to execute the service on its last attempt to execute the service.) Whether the last attempt to execute the service was successful or not. Number of milliseconds Trading Networks is to wait before making its first attempt to re-execute the service. Number of times Trading Networks has already attempted to re-execute the service. see the appendix defining the server configuration parameters in the webMethods Integration Server Administrator’s Guide. (Trading Networks uses the Time To Wait value along with the Retry Factor to calculate how long to wait for subsequent retry attempts. For more information on server configuration parameters. The Server ID is the host name of the machine on which the Integration Server is installed. Trading Networks calculates the time to wait by multiplying the last wait time by Retry Factor. For more information about archiving and deleting documents.

Task Type Specify The type of task. a b Select Show Query criteria. If you cannot find the service execution task you are looking for.Finding and Viewing Service Execution Tasks Finding and Viewing Service Execution Tasks Use the Tasks screen to find and view service execution tasks in your Trading Networks system. Trading Networks displays the Task Details screen.To specify the service execution tasks that you want to view. Select View Tasks. select the checkbox associated with each criterion that you want to use and fill in the corresponding information as described below: For this parameter. double click on the row containing the task you want more detailed information about. Note: If you are using an OEM version of the Trading Networks. To indicate that you want to view delivery tasks. see “Starting the Trading Networks Console” on page 22.. you can use the search criteria on the Tasks screen to query for specific tasks. You can view all service execution tasks or search for tasks based on the following criteria: Partner—partner identified as the receiver in the document that caused the service execution Task status—status of the service execution task Time created—time Trading Networks created the service execution task To view service execution tasks in your system 1 2 3 Start the Trading Networks Console. select: Execution service from the list. use Trading Networks Web Manager.5 485 . webMethods Trading Networks User’s Guide Version 6.. on the toolbar to have Trading Networks display the search 4 . To view tasks. To see detailed information about a specific service execution task. the Tasks feature is not available through the Trading Networks Console. If you need procedures for this step.

or click to open a dialog that allows you to select the date from a calendar. To specify a date range. the query will not return any service execution tasks because these task statuses do not apply to service execution tasks. You can type in a date value. do not use this criterion. Then specify dates in the Beginning and Ending fields..C H A P T E R 2 0 S e r v i c e E x e c u t i o n Ta s k s For this parameter. do not use this criterion. To view the details for a service execution task. select Custom from the list. or FAILED) from the list. Task Status The status of the service execution tasks you want to view.. see “Selecting a Partner” on page 34. 486 webMethods Trading Networks User’s Guide Version 6. Select the status (NEW. For more information about how to select a partner. This field is not applicable to service execution tasks. uncheck the checkbox for that criterion. Trading Networks displays the Tasks Details screen. If you decide you do not want to use a criterion that you have filled out.. Select an entry from the list.. (These task statuses only apply to delivery tasks.5 . Note: If you select QUEUED or DELIVERING. To view service execution tasks regardless of the date that Trading Networks created them. Type in the name of the partner or click the Select. DONE. do not select the checkbox for Delivery Method. button to select a partner from the Partner Selection Dialog. 5 6 Select Run Query on the toolbar. STOPPED. Partner Specify The partner that is to receive the document that triggered the execution of this service. The date Trading Networks created the service execution task. Trading Networks updates the Tasks table on the bottom portion of the screen with the query results.) Delivery Method Time Created Nothing. PENDING. To view service execution tasks of all statuses. double click the row containing that service execution task.

You can view the service execution tasks that are associated with documents that you have saved in the Trading Networks system. To view the details for a service execution task. Select Transactions Select the Tasks tab. To view service tasks associated with a document 1 Perform the steps described in “Viewing Documents in Your System” on page 442 to have Trading Networks list information about the document in which you are interested. Click the row containing the document for which you want to view service execution tasks. Trading Networks uses reliable execution to execute the service and creates a service execution task to govern and keep track of its attempts to execute the service. select Transactions View Detail/Summary to change the display. see step 4 on page 485. For instructions how to fill out the fields in the query panel to select the service execution tasks that you want to view. Trading Networks updates the Tasks table on the bottom portion of the screen with the query results. perform the following steps: a b Select Show Query already displayed. c d webMethods Trading Networks User’s Guide Version 6. it determines the processing rule it is to use to process that document. on the toolbar to display the query panels if they are not View Document.Finding and Viewing Service Execution Tasks Viewing the Service Execution Tasks Associated with a Document When Trading Networks receives a document. If you are not currently using the Detail view on the Transaction Analysis screen. If the processing rule indicates that Trading Networks is to execute a service by creating an asynchronous task. To further refine the list of service execution tasks. Select Run Query on the toolbar. double click the row containing that service execution task. 2 3 4 5 6 Perform a service execution task query.5 487 .

separating the values with commas.csv file. you can export the information to a text file. Click OK.5 . Trading Networks places the information into the file. Perform the procedures in “Finding and Viewing Service Execution Tasks” on page 485 to list the information you want to export. You can select the type of extension to use for the exported file..txt or . see “Starting the Trading Networks Console” on page 22. e.g.C H A P T E R 2 0 S e r v i c e E x e c u t i o n Ta s k s Exporting Service Execution Task Information to a File To print the service execution task information that Trading Networks displays on the Tasks screen or make the information available for other applications. 488 webMethods Trading Networks User’s Guide Version 6. you can print the file. Click Save.csv. If you need procedures for this step. To export the service execution task information to a file 1 2 3 4 5 Start the Trading Networks Console. Perform the following procedure to export the service execution task information that Trading Networks displays to a text file. You can also open the file in other applications. When you export the information. Trading Networks displays a dialog specifying the amount of data saved. After data is exported to the file. you can open the file in Microsoft Excel allowing you to create charts and reports based on the data. In the Export Query Results as Comma-Separated Values dialog box. For example. . Another example is that you can open a .csv file in Microsoft Access allowing you to further analyze the data. specify the file to which you want to save the exported service execution task information. if you export the data to a . Select Tasks Export Query Results.

page 402 page 404 page 405 page 406 page 407 page 407 page 408 Stopping a Service Execution Task If you want to stop the execution of a service. Select View Tasks. You might want to stop a service execution task if you are running Trading Networks in a clustered environment and you want to reassign the service execution task to another server in the cluster. When you want to reuse the query. you can save the query. Perform the following procedure to stop a service execution task: To stop a service execution task 1 2 3 4 Start the Trading Networks Console. see “Trading Networks in a High Availability Environment” on page 44. select the Task Type checkbox.5 489 . For information on running Trading Networks in a clustered environment. you simply select it from the queries list. webMethods Trading Networks User’s Guide Version 6. see “Starting the Trading Networks Console” on page 22. To indicate that you want to work with service execution tasks.Running Service Execution Tasks Queries Running Service Execution Tasks Queries If you plan to use the same service execution task query many times. and select Service execution from the list. on the toolbar to display the query panels if they are not already Select Show Query displayed. Trading Networks adds the service execution task query to the list of saved queries on the tool bar.. For more information about the different query functions that you can perform for service execution task queries. If you need procedures for this step.. you can stop the service execution task. see the following table: Query Function “Enabling the Query Functions” “Creating and Saving a Query” “Selecting and Running a Query” “Updating the Search Criteria for a Saved Query” “Saving a New Query Based on an Existing Query” “Reverting to a Saved Query” “Deleting Saved Queries” See page.

Perform the following procedure to restart a service execution task: To restart a service execution task 1 2 3 4 5 Start the Trading Networks Console. and select Service execution from the list. select the Task Status check box. select the Task Type checkbox. To list stopped tasks.5 . Trading Networks then attempts to re-execute the service again up to the number of attempts defined by the Retry Limit setting. To indicate that you want to work with service execution tasks. Trading Networks updates the Tasks table on the bottom portion of the screen with the query results. and set the Task Status field to FAILED. select the Task Status check box. Select Run Query on the toolbar. When a service execution task is restarted. When you restart a service execution task. you can restart it. 6 490 webMethods Trading Networks User’s Guide Version 6. Trading Networks updates the Tasks table on the bottom portion of the screen with the query results. Select Tasks Stop to stop the service execution task. on the toolbar to display the query panels if they are not already Select Show Query displayed. you can restart it. see “Starting the Trading Networks Console” on page 22.C H A P T E R 2 0 S e r v i c e E x e c u t i o n Ta s k s 5 6 7 Select Run Query on the toolbar. Restarting a Service Execution Task If you previously stopped a service execution task. and set the Task Status field to STOPPED. You can restart only service execution tasks that have the task status STOPPED or FAILED. If you need procedures for this step. Select the task you want to stop by clicking the row for the service execution task. If a service execution task has failed and you have resolved the problem that caused the failure. Note: You can restart only tasks that were started on the Integration Server to which the Trading Networks Console currently has an open session. Trading Networks attempts to re-execute the service again. To list failed tasks. Select View Tasks. Trading Networks resets the task status to PENDING and sets the Retries value to 0.

You might want to delete service execution tasks that have the task status DONE because the services have already been successfully executed. Trading Networks deletes all service execution tasks that result from the query. you can manually delete service execution tasks. Deleting Service Execution Tasks Trading Networks automatically deletes service execution tasks when the document with which a service execution task is associated is either archived or deleted.Deleting Service Execution Tasks 7 8 Select the task you want to restart by clicking the row for the service execution task. select the Task Type checkbox. perform a service execution query. You might also want to delete service execution tasks with the tasks status FAILED if you cannot correct the problem or do not want Trading Networks to attempt to re-execute the services again. you enter a query to display the tasks that you want to delete. and select Service execution from the list. If you do not use the archival and deletion feature of Trading Networks. see “Starting the Trading Networks Console” on page 22l. To indicate that you want to work with service execution tasks. see step 4 on page 485. Select View Tasks. a For instructions how to fill out the fields in the query panel to select the service execution tasks that you want to view. When Trading Networks prompts you to verify that you want to remove all displayed service execution tasks. Perform the following procedure to manually delete a service execution task: To manually delete a service execution task 1 2 3 4 5 Start the Trading Networks Console. Select Tasks Restart to restart the service execution task. on the toolbar to display the query panels if they are not already Select Show Query displayed. If you need procedures for this step. To delete service execution tasks.5 491 . Trading Networks updates the Tasks table on the bottom portion of the screen with the query results. click Yes. b 6 Select Tasks Delete to delete the displayed service execution tasks. Select Run Query on the toolbar. webMethods Trading Networks User’s Guide Version 6. To find the service execution task that you want to delete.

perform a service execution task query. and select Service execution from the list.server:ping services. To indicate that you want to work with service execution tasks. The server to which you are reassigning the task must be running. you can reassign service execution tasks that have a NEW. If you need procedures for this step. If the server on which the service execution task currently resides is running.C H A P T E R 2 0 S e r v i c e E x e c u t i o n Ta s k s Reassigning a Service Execution Task to Another Server Each service execution task is associated with the Integration Server on which it was started. Trading Networks might be unable to reassign tasks. You might want to reassign a service execution task if for some reason you can no longer use the Integration Server on which a service execution task was started (e. a For instructions how to fill out the fields in the query panel to select the service execution tasks that you want to view.g. To find the service execution task that you want to reassign.5 . STOPPED or FAILED status. The server ID is the host name of the machine on which the Integration Server is installed. If the server is not running. Trading Networks updates the Tasks table on the bottom portion of the screen with the query results. see “Starting the Trading Networks Console” on page 22. on the toolbar to display the query panels if they are not already Select Show Query displayed. Select Run Query on the toolbar. Note: When reassigning a task. these services are protected by the Anonymous ACL. Select View Tasks. Perform the following procedure to reassign a service execution task: To reassign a service execution task to another server 1 2 3 4 5 Start the Trading Networks Console. When you reassign a service execution task.. the server has failed for some reason). you can reassign a service execution task to another server in the cluster. you can only reassign service execution tasks that have the status STOPPED or FAILED. see step 4 on page 485. PENDING. Trading Networks invokes the wm. you need to specify the server ID of the server to which you want to reassign the service execution task. If you update the Anonymous ACL or use a different ACL to protect these services. select the Task Type checkbox. multiple Integration Servers that share one database). If you have a clustered environment (that is.server:connect and wm. b 492 webMethods Trading Networks User’s Guide Version 6. As installed.

webMethods Trading Networks User’s Guide Version 6. Select Tasks Reassign. Specify the server ID of the server to which you want to reassign the task in the Server ID to assign the task to field. Trading Networks displays a dialog box. Click OK.Reassigning a Service Execution Task to Another Server 6 7 8 9 Select the service execution task you want to reassign by clicking the row for the service execution task.5 493 .

5 .C H A P T E R 2 0 S e r v i c e E x e c u t i o n Ta s k s 494 webMethods Trading Networks User’s Guide Version 6.

. . . . .5 495 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503 Running Activity Log Queries . . . . 498 Deleting Activity Log Entries . . . . . . . . .CHAPTER 21 The Activity Log What is the Activity Log? . . . 496 Viewing the Activity Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . .

“Managing and Tracking Documents”. You can use the Activity Log screen of the Trading Networks Console to view the activity log. The activity log contains the following information for each entry: Field Timestamp Type Class Description The timestamp when Trading Networks added the entry to the activity log. An identification of the type of activity that caused Trading Networks to add the entry. "Tracking and Analyzing Run-Time Information in Trading Networks" in the webMethods Trading Networks Concepts Guide. Class is set to Envelope if the message relates to the Trading Networks activity of attempting to extract the envelope attributes from a document. Type will be Error. For more information about this pre-processing action. processed.CHAPTER 21 The Activity Log What is the Activity Log? The activity log is a log that Trading Networks maintains to record the activity that occurs: When you perform administrative actions for your Trading Networks system While managing your partners While documents are being received. The Transaction Analysis screen. For a list of the classifications. For more information about The activity log. see “Activity Class Values” on page 497. processed. Warning. Additionally. see Chapter 8. or Message (informational). The severity level of the entry. if you want to view tasks that are associated with a specific document. see Chapter 18.5 . you can use the Transaction Analysis screen to view detail information for a specific document. 496 webMethods Trading Networks User’s Guide Version 6. and delivered Trading Networks only records activity log entries while documents are being received. and delivered if instructed to do so by the Save Document to Database pre-processing action. see “PreProcessing Actions” on page 327. For example.

The complete message that Trading Networks records in the activity log to describe the activity. User Name is the user name that the client supplied or the value from the client certificate that represents the user name. For example.tn:log built-in service to add entries to the activity log. and/or SenderID. ReceiverID.5 497 .What is the Activity Log? Field User Name Description The user name of the current webMethods user when the activity occurred. if the Trading Networks client was authenticated by your Integration Server. Brief Message is Query Failed. it either supplied a user name and password of a webMethods user account or presented a client certificate. if the full message is describing an error that Trading Networks encountered executing an XQL query. GroupID. Other unspecified error messages and warnings Processing documents using processing rules Recognizing TN document types (before extracting document attributes) Saving a document to the database Validating a document against an IS schema Verifying the digital signature of a document webMethods Trading Networks User’s Guide Version 6. DocumentID. In this case. A shortened version of the full message that identifies the type of message in the entry. For example. when a Trading Networks client sends a document to your Integration Server to be processed. Brief Message Full Message Activity Class Values The following lists the values that Trading Networks uses for the Activity class. you can specify any value you want for Activity class. Activity class Delivery Envelope General Processing Recognition Saving Validation Verification Trading Networks uses the activity class when it adds entries related to… Performing reliable document delivery Extracting any of the envelope attributes—ConversationID. If you use the wm.

CHAPTER 21 The Activity Log Viewing the Activity Log You can use the Trading Networks Console to view activity log entries. That partner can be either the local partner (Enterprise) or one of the other partners in the network. click the Basic Criteria tab..5 . Warning. Trading Networks sets the activity class to Recognition when adding entries related to using the TN document types to recognize a document Activity type that identifies the severity level of the entry. see “Starting the Trading Networks Console” on page 22. for example. Then. select the checkbox next to each criterion that you want to use and fill in the corresponding information as described below: 498 webMethods Trading Networks User’s Guide Version 6.e. i. or Message (informational) The text of the activity log message Date when Trading Networks added the activity log entry Viewing Entries that Relate to Enterprise or a Partner When Trading Networks adds entries that relate to a partner in the trading network to the activity log. To view activity log entries that relate to your Trading Networks system 1 2 3 4 Start the Trading Networks Console. To specify basic search criteria. Entries that relate to a partner in the Trading Networks system are for the following types of activities: Business document exchange activities where the partner is the sender Errors that occur during reliable delivery whether the partner is the sender or the receiver To view activity log entries that relate to your Trading Networks system. You can view all activity log entries or search for specific entries based on: Partner associated with the entry Activity class that identifies the Trading Networks function associated with the entry. it associates the entries with the specific partner. on the toolbar to display the query panels if they are not already Select Show Query displayed. If you need procedures for this step. perform the following procedure. Error. Select View Activity Log.

specify ‘Doc_ignored’.5 499 . see “Activity Class Values” on page 497. enclose the string you specify in quotes. Note: There is no way to do an exact character match. This field is case-sensitive. Polled Document Matches… Zero or more characters A single character To search for an entry that contains the % or _ characters. step but not: sstop. be sure to use the exact combination of upper. be sure to use the exact combination of upper. A character string that identifies the text of the brief message of the entries you want to view. webMethods Trading Networks User’s Guide Version 6. if you want to search for entries that have a brief message that contains Doc_ignored.and lowercase letters. Activity Class Activity Type Brief Message The type of entry you want to view. select that partners name from the list. Document Test but not: Documents. select an activity class from the Activity Class list.and lowercase letters. type the activity class in the Activity Class field. select the partner name of the local partner from the list. For descriptions of the values that Trading Networks uses for activity class. For example. To view the entries that are related to the local partner (Enterprise). You can use the following pattern matching characters: Character % (percent) _ (underscore) Example: _t_p D%t matches: Stop. stop.Viewing the Activity Log For this Basic Criteria tab parameter… Partner Specify… The partner whose activity log entries you want to view. To view the entries associated with another partner. stoop matches: Document. To specify an activity class that your site has defined. or Message. Warning. This field is case-sensitive. Select a partner name from the list. Select Error. The activity class associated with the entries you want to view. To specify an activity class that Trading Networks uses.

5 . specify ‘Documents_persisted 100%’. 5 To specify advanced search criteria. You can type in a date value. If you decide you do not want to use a criterion that you have filled out.CHAPTER 21 The Activity Log For this Basic Criteria tab parameter… Timestamp Specify… The date Trading Networks added the entry to the activity log. deselect the checkbox for that criterion. Select a user from the list. For example. This field is case-sensitive. select Custom from the list. To specify a date range. 500 webMethods Trading Networks User’s Guide Version 6. Note: There is no way to do an exact character match. You can use the following pattern matching characters: Character % (percent) _ (underscore) Matches… Zero or more characters A single character To search for an entry that contains the % or _ characters. If you decide you do not want to use a criterion that you have filled out. or click to open a dialog that allows you to select the date from a calendar. deselect the checkbox for that criterion. Then specify dates in the Beginning and Ending fields. A character string that identifies the text of the full message of the entries you want to view. be sure to use the exact combination of upper.and lowercase letters. enclose the string you specify in quotes. Then. select the checkbox next to each criterion that you want to use and fill in the corresponding information as described below: For this Advanced tab parameter… User Name Full Message Specify… The user name of the current webMethods user when the activity occurred. if you want to search for entries with the full message that contain Documents_persisted 100%. click the Advanced tab.

Note: You can also view activity log entries that relate to any partner on your network when you use the Partner selection in the Selector Panel. The selection criteria in the query panel of the Activity Log screen are identical whether using the Enterprise or Trading Partners selection of the Selector Panel. If you need procedures for this step. If you do not save activity log entries.Viewing the Activity Log 6 Select Run Query on the toolbar.5 501 . Trading Networks updates the Log table on the bottom portion of the screen with the query results. Note: Trading Networks only saves activity log entries that pertain to the processing of a document if instructed to do so by either the TN document type and/or the processing rule. To further refine the list of entries. 3 4 5 6 Select the Activity Log tab. use Trading Networks Web Manager. see “Starting the Trading Networks Console” on page 22. To view documentrelated activity log entries. To view activity log entries that relate to a document 1 2 Start the Trading Networks Console. the Activity Log tab will have no data for you to view. Perform the steps described in “Viewing Documents in Your System” on page 442 to have Trading Networks list information about the document for which you are interested. perform the following steps. Select Transactions View Document. Viewing Entries that Relate to a Document To view activity log entries that relate to a specific document. the Transactions Analysis feature is not available through the Trading Networks Console. webMethods Trading Networks User’s Guide Version 6. : Note: If you are using an OEM version of the Trading Networks. Click the row containing the document for which you want to view activity log entries. perform the following procedure.

To view the details for an activity log entry.CHAPTER 21 The Activity Log a b Click to display the query panels if they are not already displayed. Trading Networks updates the Log table on the bottom portion of the screen with the query results. if you export the data to a . Perform an activity log query. specify the file to which you want to save the exported activity log information. see step 4 on page 498. separating the values with commas. you can open the file in Microsoft Excel allowing you to create charts and reports based on the data..csv file in Microsoft Access allowing you to further analyze the data. e. c d Exporting Activity Log Information to a File To print the activity log information that Trading Networks displays on the Activity Log screen or make the information available for other applications. For example. Trading Networks displays a dialog specifying the amount of data saved. After data is exported to the file. For instructions how to fill out the fields in the query panel to select the delivery tasks that you want to view. 502 webMethods Trading Networks User’s Guide Version 6. Select Log Export Query Results. Click Save. You can select the type of extension to use for the exported file. see “Starting the Trading Networks Console” on page 22. To export the activity log information to a file 1 2 3 4 5 Start the Trading Networks Console. you can print the file. Click OK. double click the row containing that entry. Trading Networks places the information into the file.txt or.5 . In the Export Query Results as Comma-Separated Values dialog box. If you need procedures for this step. you can export the information to a text file. .csv. Select Run Query on the toolbar. Perform the following procedure to export the activity log information that Trading Networks displays to a text file.csv file. You can also open the file in other applications. Perform the procedures in “Viewing Entries that Relate to Enterprise or a Partner” on page 498 to list the information you want to export. When you export the information. Another example is that you can open a .g.

Click . Trading Networks adds the activity log query to the list of saved queries on the tool bar.Deleting Activity Log Entries Deleting Activity Log Entries Trading Networks automatically deletes activity log entries when the documents with which entries are associated are either archived or deleted. When Trading Networks prompts you to verify that you want to remove the activity log entries. Perform the procedures in either “Viewing Entries that Relate to Enterprise or a Partner” on page 498 or “Viewing Entries that Relate to a Document” on page 501 to list the activity log entries that you want to delete.5 503 . you can save the query. see “Starting the Trading Networks Console” on page 22. page 402 page 404 page 405 page 406 page 407 page 407 page 408 webMethods Trading Networks User’s Guide Version 6. Trading Networks deletes all activity log entries that result from the query. If you need procedures for this step. you simply select it from the queries list.. see the following table: Query Function “Enabling the Query Functions” “Creating and Saving a Query” “Selecting and Running a Query” “Updating the Search Criteria for a Saved Query” “Saving a New Query Based on an Existing Query” “Reverting to a Saved Query” “Deleting Saved Queries” See page. However. When you want to reuse the query. 3 Running Activity Log Queries If you plan to use the same activity log query many times. For more information about the different query functions that you can perform for activity log queries. click Yes.. you can manually delete activity log entries. you query the activity log to display the entries that you want to delete. To delete activity log entries. Perform the following procedure to manually delete activity log entries: To delete activity logs entries 1 2 Start the Trading Networks Console.

5 .CHAPTER 21 The Activity Log 504 webMethods Trading Networks User’s Guide Version 6.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 505 . . . . . . . . . . . . . . . . . 509 Migrating Profile Fields . . . . . . . . . . . . . . . . . . . . . . .APPENDIX A Exporting and Importing Database Information About Exporting and Importing Database Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514 Migrating Custom Document Attributes . . . . . . . . . . . . . . . . 518 Migrating Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507 Dependencies For Trading Networks Objects . . . 506 Trading Networks Objects that You Can Export and Import . . . . . . . . . 526 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521 Using the tnexport and tnimport Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519 Importing Database Information from the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513 Migrating TN Document Types . . . . . . 519 Exporting Database Information from the Console . . . . . . . . . 515 Migrating Trading Partner Agreements (TPAs) . . . . . . 515 Migrating Processing Rules . . . . . . . . . . 508 Migrating Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

You place the file in a location available to the target Trading Networks system and import the data from the file into the database on the target Trading Networks system. see “Separate Database for Each Instance of Trading Networks” on page 47..g. document attributes. enabled. Important! The export/import feature is only for migrating Trading Networks objects between databases on your system that use the same version of Trading Networks. 506 webMethods Trading Networks User’s Guide Version 6. When you export Trading Networks objects. The Trading Networks Console does not indicate which are disabled. It is not for: Migrating database information from one version of Trading Networks to another. For more information. for example.. You can create the Trading Networks objects on one instance of Trading Networks. enabled. deleted) of the Trading Networks objects that you migrate. or deleted. Trading Networks maintains the current state (e. TN document types.g. profiles) from one database to another. Trading Networks Console makes Trading Networks objects available for export regardless of whether they are disabled or deleted. You have changed the type of database you are using. then use export/import to migrate the Trading Networks objects to the databases of the other Trading Networks instances. you changed from an Oracle database to a SQL Server database. Use the export/import feature when: You want to deploy from a development environment to a production environment. Sharing Trading Networks objects with trading partners. disabled.APPENDIX A Exporting and Importing Database Information About Exporting and Importing Database Information webMethods Trading Networks (Trading Networks) provides an export/import feature to allow you to migrate Trading Networks objects (e. Trading Networks creates a file that contains the data you exported. You are using multiple instances of Trading Networks.5 . and you want each Trading Networks instance to have its own database with identical Trading Networks objects.

see “Using the tnexport and tnimport Utilities” on page 526. To export data using the Console. you use the Export Data dialog box. webMethods Trading Networks User’s Guide Version 6. for example. document content. see “Migrating Profiles” on page 509.Trading Networks Objects that You Can Export and Import Trading Networks Objects that You Can Export and Import You can export/import the Trading Networks objects listed below. You cannot export/import information about the documents that are in your system. Profile fields. TN document types. see “Migrating Trading Partner Agreements (TPAs)” on page 518. see “Migrating Custom Document Attributes” on page 515. see “Migrating Profile Fields” on page 513. see “Migrating Processing Rules” on page 515. see “Migrating Queries” on page 519. Queries that you defined for Console screens. see “Migrating TN Document Types” on page 514. tasks. to import. Profiles. Processing rules. use the Import Data dialog box. Trading Partner Agreements (TPAs). and activity log entries. Custom document attributes.5 507 . Trading Networks displays a tree structure in these dialog boxes that contains the items that are available for you to export/import. Note: To export/import using the command line utilities.

For example. but not all of the dependencies. Export Data dialog with a TN document type that has dependencies selected Note: The Import Data dialog box shows some.APPENDIX A Exporting and Importing Database Information Dependencies For Trading Networks Objects In the Export Data dialog boxes. if the selected item requires additional items. when you create a custom document attribute. For example. Trading Networks lists the custom attributes and the duplicate checking service in the Dependencies area of the dialog. Why You Should Use Export/Import to Migrate Dependencies For each Trading Networks object that you create.5 . Trading Networks generates an internal ID for the object. For example. if you create a TN document 508 webMethods Trading Networks User’s Guide Version 6. when you select an item in the tree structure. For example. Trading Networks shows these dependencies in the Dependencies area of the dialog. Trading Networks generates an internal ID that uniquely identifies that custom attribute in the Trading Networks system. the Import Data dialog box cannot display the IS Service dependencies because these dependencies are not recorded in the exported file. Trading Networks uses its internal IDs to associate Trading Networks objects with one another. if you select a TN document type that references custom attributes and a duplicate checking service for the Check for Duplicate Document pre-processing action.

The TN document type that you migrated references the internal ID generated on the source system and will not match the internal ID generated for the custom attribute that you recreated on the target system..tn. Data for: Standard profile fields Extended profile fields Certificate information on the Security tab of the profile. Dependencies Profile Groups Delivery Methods External ID Types Contact Types For more information. use the following items in the Export Data and Import Data dialog boxes: Items in Export/Import Data Dialog box Partner Data Use to migrate. For example.g.5 509 . As a result. Migrating Profiles To migrate profiles. For more information. the target Trading Networks system generates a different internal ID for the custom attribute. None External ID Types External ID types referenced by the profiles on your system.. DUN. see “Partner Data Dependencies” on page 511. Trading Networks will use the internal ID of the custom attribute to associate it with the TN document type. if you have a TN document type that references a custom attribute and you migrate the TN document type. These include all the standard external ID types (e. see “Partner Data” on page 510. you should also migrate the custom attribute.dictionary:addIDType service. DUNS+4) that are installed with Trading Networks and all custom external ID types that you add using the wm. Trading Networks lists all external ID types defined in the database..Migrating Profiles type that references the custom attribute. If you recreate the custom attribute on the target system. when you migrate a Trading Networks object that requires other Trading Networks objects. webMethods Trading Networks User’s Guide Version 6. you should migrate the dependent objects using export/import as well.

tn.. Partner Data Trading Networks lists each partner by its corporation name under the Partner Data item. Trading Networks lists all contact types defined in the database. None Important! You cannot use export/import to share your profile with a partner.. Partner Data in the Export Data or Import Data dialog box Note: The Enterprise profile is also listed by its corporation name. It is not listed under Enterprise.dictionary:addContactType service.APPENDIX A Exporting and Importing Database Information Items in Export/Import Data Dialog box Contact Types Use to migrate. Technical and Administrative) that are installed with Trading Networks and all custom contact types that you add using the wm.e.5 . Contact types referenced by the profiles on your system. 510 webMethods Trading Networks User’s Guide Version 6. These include both the standard contact types (i.. When you export your (Enterprise) profile. Trading Networks records that the profile is the Enterprise profile. Dependencies None Profile Groups Profile groups that you have registered on your Trading Networks system. Trading Networks does not allow you to import the Enterprise system from your system into a partner's system.

Delivery Methods The delivery methods that are defined in the profile. Primary HTTP).dictionary:addIDType service.g. the Security Data element will not be listed under Partner Data in the tree. so no action is needed.tn. If the profile uses custom external ID types that you added using the wm. One element for each extended profile field. Partner Data Element Profile Dependencies Profile Groups Description The profile groups that are identified in the partner’s profile. If the profile has no information on the Security tab. see “Dependencies For Trading Networks Objects” on page 508.Migrating Profiles For each partner that is listed under Partner Data. webMethods Trading Networks User’s Guide Version 6. Select these items to migrate the data for the extended profile fields for the specific partner. The profile can only contain standard delivery methods that are installed with Trading Networks (e. Select this item to migrate the data for the standard profile fields for the specific partner. migrate the those external ID types using the External ID Types item. You do not need to migrate these unless they have been deleted from the target system. Trading Networks lists the following elements: Profile.. If you have not defined extended fields. Trading Networks also lists standard external ID types. For more information about dependencies. Select this item to migrate the certificate information from the Security tab of the partner's profile. External ID Types The external ID types that are used by the profile. no extended field elements will be listed under Partner Data in the tree.5 511 . Use the Profile Groups tree element to migrate the profile groups. Partner Data Dependencies The following table shows the dependencies for Partner Data. Security Data.

they are also required if referenced by the Receiver’s Queue delivery method in a profile. migrate those contact types using the Contact Types item.dictionary:addContactType service. The profile field definition for the extended profile field. For more information. 512 webMethods Trading Networks User’s Guide Version 6. Be sure to use the exact queue name with the same combination of upper and lowercase letters when defining the queue on the target system. To create the queues on the target system. Security Data Profile The partner’s profile. If the profile uses custom contact types that you added using the wm. Extended Profile Fields Field Definition Profile The partner’s profile.tn. For more information. ensure you move the scheduled delivery services that are associated with the queues to the target system.5 . Manually create the required queue on the target system. Trading Networks also lists standard contact types. You migrate the profile when you select the Profile element under Partner Data. for queues Trading Networks relates the queue to the profile by its name. you can do one of the following: Use the tnexport and tnimport utilities to export all public and private queues. Profiles that Use Queues Although the Dependencies does not list queues (public or private). In addition to migrating the queue.APPENDIX A Exporting and Importing Database Information Partner Data Element Dependencies Contact Types Description The contact types that are used by the profile. see “Using the tnexport and tnimport Utilities” on page 526. Note: Although Trading Networks typically associates related items by internal IDs that it generates (as described in “Dependencies For Trading Networks Objects” on page 508). Use the Field Definitions item to migrate the definition for the extended profile field. Review the profiles you want to export/import and migrate the queues if needed. You migrate the profile when you select the Profile element under Partner Data. You do not need to migrate these unless they have been deleted from the target system. see “Migrating Profile Fields” on page 513.

dictionary:addFieldGroup service. If the profile field belongs to a standard field group (e. Delivery) that was installed with Trading Networks. Corporation.tn. including the standard field groups that are installed with Trading Networks (e. Corporation. Trading Networks lists the field group to which the profile field belongs in Dependencies. You do not need to migrate standard field groups. Field Definitions Dependencies When you select a profile field under the Field Definitions item.. migrate the field groups using the Field Group item. Dependencies Field Group For more information. Delivery.g.dictionary:addFieldGroup service. Definitions for standard and extended profile fields. webMethods Trading Networks User’s Guide Version 6. None Field Groups Profile field groups that you added to your system on the Extended Field group of a profile or by using the wm.Migrating Profile Fields Migrating Profile Fields To migrate profile fields.tn. use the following items in the Export Data and Import Data dialog boxes: Items in Export/Import Data Dialog box Field Definitions Use to migrate.5 513 . Trading Networks lists all field groups. see “Partner Data” on page 510. see “Field Definitions Dependencies” on page 513. Trading Networks lists the standard field group..g. For more information. Note: To migrate the data for profile fields. use the Partner Data item. You only need to migrate custom field groups that you add. If the profile field belongs to a custom field group that you added on the Extended Fields tab of a profile or by using the wm. For more information about dependencies. Contact)... see “Dependencies For Trading Networks Objects” on page 508.

use the following items in the Export Data and Import Data dialog boxes: Items in Export/Import Data Dialog box Document Types Use to migrate. ensure that you move the IS services to the target Trading Networks system. None Document Type Dependencies The following table shows the dependencies for Document Types. Dependencies IS Services Description The fully-qualified name of the following types of services that you can specify in a TN document type: Duplicate checking service for the Check for Duplicate Document pre-processing action Custom attribute transformation services if specified for an attributes to extract. DocType Categories (which is a sub-item under Binary Data) Categories of documents (e. If a TN document type that you are migrating uses either or both of these types of services. see “Document Type Dependencies” on page 514. All Trading Networks systems will have the TN document type categories. see “Dependencies For Trading Networks Objects” on page 508. Dependencies IS Services Attributes For more information.. For more information about dependencies. 514 webMethods Trading Networks User’s Guide Version 6.. XML and Flat File). Definitions for TN document types. You do not need to migrate them.g.APPENDIX A Exporting and Importing Database Information Migrating TN Document Types To migrate TN document types.5 ..

use the following item in the Export Data and Import Data dialog boxes. and you cannot delete nor alter their definitions. Trading Networks maintains processing rules in a specific order. When you select to export and import processing rules.Migrating Custom Document Attributes Dependencies Attributes Description The custom document attributes that are associated with the TN document type.. Note: You do not need to migrate system attributes because the system attributes are defined when you install Trading Networks. see “Processing Rules Dependencies” on page 516. Items in Export/Import Data Dialog box Document Attributes Use to migrate. see “Migrating Custom Document Attributes” on page 515. This is webMethods Trading Networks User’s Guide Version 6.5 515 . For more information. Use the Attributes item to migrate the custom attributes for the TN document type. be aware of the order of the processing rules. use the following item in the Export Data and Import Data dialog boxes.. Processing rules Dependencies IS Services Delivery Methods For more information... Items in Export/Import Data Dialog box Processing Rules Use to migrate. Dependencies None Migrating Processing Rules To migrate processing rules. Definitions for custom document attributes. Migrating Custom Document Attributes To migrate custom document attributes.

tn. the order is not necessarily maintained. in the order the processing rules appear in the Selected items list of the Export Data and Import Data dialog boxes. ensure that you move the IS services to the target Trading Networks system. see “Dependencies For Trading Networks Objects” on page 508. Dependencies IS Services Description The fully-qualified names of the following types of services that you can specify in a processing rule: Service you identify with the Execute a Service processing action Duplicate checking service for the Check for Duplicate Document pre-processing action if a custom service is specified If a processing rule that you are migrating uses either or both of these types of services. you can select to: Append the imported processing rules to the end of the existing list of processing rules in the target Trading Networks system Replace all the processing rules in the target Trading Networks system with the imported processing rules Processing Rules Dependencies The following table shows the dependencies for Processing Rules. Delivery Methods The immediate delivery method that is used in the Deliver Document By action of the processing rule. 516 webMethods Trading Networks User’s Guide Version 6. If the processing rule uses a standard immediate delivery method that was installed with Trading Networks (e. in other words. Primary HTTP). ensure that you move the corresponding IS services to the target Trading Networks system.g. no action is needed.5 .delivery:registerService service to register the IS service using the same delivery method name. For more information about dependencies. When you import processing rules.) When you select processing rules to export and import.APPENDIX A Exporting and Importing Database Information the order in which Trading Networks selects a processing rule to use for processing an incoming document.. Trading Networks maintains the list of processing rules that you want to export and import in the order you select them. and use the wm. If the processing rule uses a custom immediate delivery method that you added. (Trading Networks uses the first processing rule that matches.

Migrating Processing Rules Although the Dependencies does not list the following Trading Networks objects. To create the queues on the target system. In addition to migrating the queue. you can do one of the following: Use the tnexport and tnimport utilities to export all public and private queues. Queues referenced by a Scheduled Delivery used by the Deliver Document By processing action. Review the processing rules you want to export/import and migrate the following if appropriate. see “Migrating Custom Document Attributes” on page 515. see “Migrating Profiles” on page 509. see “Migrating TN Document Types” on page 514. Manually create the required queue on the target system. ensure you move the scheduled delivery service that are associated with the queue to the target system. webMethods Trading Networks User’s Guide Version 6. Profiles for senders identified in the Sender criterion on the Criteria tab of the processing rule. they are also required if referenced in a processing rule.5 517 . Note: Although Trading Networks typically associates related items by internal IDs that it generates (as described in “Dependencies For Trading Networks Objects” on page 508). Profiles for the receivers identified in the Receiver criterion on the Criteria tab of the processing rule. For more information. see “Using the tnexport and tnimport Utilities” on page 526. Custom document attributes identified on the Extended Criteria tab of the processing rule. TN document types identified in the Document Type criterion on the Criteria tab of the processing rule. for queues Trading Networks relates the queue to the profile by its name. see “Migrating Profiles” on page 509. Be sure to use the exact queue name with the same combination of upper and lowercase letters when defining the queue on the target system.

A TPA is associated with two trading partners on your system. see “Migrating Profiles” on page 509. one that acts as the sender and one that acts as the receiver. Items in Export/Import Data Dialog box Agreements Use to migrate. Migrate the profiles for the sender and receiver. see “Agreements Dependencies” on page 518.5 . The fully-qualified names of the following types of services that you can specify in a TPA: Initialization service Export service If a TPA that you are migrating uses either or both of these types of services. IS Services 518 webMethods Trading Networks User’s Guide Version 6.. For more information.. Dependencies Profiles Description The profiles that are associated with the TPA. ensure that you move the IS services to the target Trading Networks system. see “Dependencies For Trading Networks Objects” on page 508. Ensure that you migrate this IS document type to the target Trading Networks system. IS document types The fully-qualified name of the IS document type that defines the structure of the TPA data. TPAs Dependencies Profiles IS Services IS Document Types For more information.APPENDIX A Exporting and Importing Database Information Migrating Trading Partner Agreements (TPAs) To migrate Trading Partner Agreements (TPAs). For more information about dependencies. use the following item in the Export Data and Import Data dialog boxes. Agreements Dependencies The following table shows the dependencies for Agreements.

Trading Networks displays the Export Data dialog box. see “Starting the Trading Networks Console” on page 22.. queries you defined for the Transaction Analysis screen to search for specific documents).. If you need procedures for this step. To migrate all of your queries. Items in Export/Import Data Dialog box Query (a sub-item under Binary Data) Use to migrate.. To export database information 1 2 Start the Trading Networks Console. use the following item in the Export Data and Import Data dialog boxes. perform the following procedure.5 519 . All queries that you have defined for all screens of the Trading Networks Console: Trading Partners Document Types Processing Rules Agreements Transaction Analysis Tasks Activity Log Dependencies None Exporting Database Information from the Console To export database information.g. The Available Items contains a tree structure that lists the database items that are available for you to export. webMethods Trading Networks User’s Guide Version 6. Select File Export.Migrating Queries Migrating Queries You can migrate all the queries you have defined for the Trading Networks Console screens (e.

if you want to move all processing rules. “Partner Data Dependencies” on page 511 “Field Definitions Dependencies” on page 513 “Document Type Dependencies” on page 514 “Processing Rules Dependencies” on page 516 520 webMethods Trading Networks User’s Guide Version 6.. then click . When you select one of the following types of items in the Available Items list. select the parent element and click . specify the file to which you want Trading Networks to write the database information..APPENDIX A Exporting and Importing Database Information 3 Select the items that you want to export by populating the Selected Items list. see. check the Dependencies to determine whether there are other items you should export as well. Item Partner Data Field Definitions Document Types Processing Rules 4 5 Click OK. To select an item in the tree along with all of its child elements. In the Save File dialog box. For example. For more information about dependencies. Select one or more items from the Available Items list.5 . select the Processing Rule item and click . To move all items: To move some but not all items: Click to move all items from the Available Items list to the Selected Items list. Then. Note: The file that contains the exported data is a binary-encoded file. click Save.

For more information about how to use this dialog box. For the following items in the Import Data dialog box: Document Types Document Attributes Partner Data: Profiles Field Groups Contact Types Trading Networks. see “Importing Items that Have the Same Name as Existing Items” on page 521. For more information. see “Specifying How to Import Processing Rules” on page 524. For information about how to force the overwrite of identically named items without displaying the Overwrite dialog box.5 521 .Importing Database Information from the Console Importing Database Information from the Console When importing data. Importing Items that Have the Same Name as Existing Items If you select to import an item that has the name as an item that already exists in the target database.. Specify how you want to import processing rules: Append the imported processing rules to the end of the existing list of processing rules in the target Trading Networks system Replace all the processing rules in the target Trading Networks system with the imported processing rules For more information.. see “Suppressing the Overwrite Dialog Box and Forcing the Overwrite of Items” on page 523. Displays the Overwrite dialog box. Trading Networks handles the situation based on the type of item that is being imported. webMethods Trading Networks User’s Guide Version 6. you need to: Determine how to handle importing items that have the same name as existing items in the target system. see “Using the Overwrite Dialog Box” on page 522.

external ID types. and agreements. Uses the Overwrite Rules option to determine how to import the processing rules. Trading Networks will prompt you to determine whether to overwrite the item in the target database: Document Types Document Attributes Partner Data (Profiles only) Field Groups Contact Types 522 webMethods Trading Networks User’s Guide Version 6. Does not display the Overwrite dialog box. the import process will throw an exception if it encounters an identically named item in the target database that is assigned a different internal ID. Attempts to add the identically named item to the target database.APPENDIX A Exporting and Importing Database Information For the following items in the Import Data dialog box: Field Definitions External ID Types Agreements Binary Types Partner Data: Security Data Extended Field Data Processing Rules Trading Networks.5 . see “Dependencies For Trading Networks Objects” on page 508. see “Specifying How to Import Processing Rules” on page 524. Important! Although Trading Networks does not prompt you to overwrite when you import field definitions.. For more information about internal IDs. For more information. Using the Overwrite Dialog Box When you attempt to import any of the following items and the same type of item with an identical name already exists in the target database..

Yes to All No No to All Suppressing the Overwrite Dialog Box and Forcing the Overwrite of Items If you want Trading Networks to automatically overwrite identically named items in the target database. Selecting No to All denies Trading Networks the permission to overwrite the Trading Networks object described in the Overwrite dialog box and all subsequent identically named items that Trading Networks might encountered during the import process. select the Force Import checkbox on the Import Data dialog box. When you select No to All Trading Networks no longer displays the Overwrite dialog box for identically named items. Trading Networks does not display the Overwrite dialog box. Selecting Yes to All grants Trading Networks permission to overwrite the Trading Networks object described in the Overwrite dialog box and all subsequent identically named items that Trading Networks might encountered during the import process. No identically named items are imported. webMethods Trading Networks User’s Guide Version 6.5 523 .Importing Database Information from the Console The Overwrite dialog box allows you to select one of the following options: Overwrite dialog option Yes Description Selecting Yes grants Trading Networks permission to overwrite only the Trading Networks object described in the Overwrite dialog box. Selecting No denies Trading Networks the permission to overwrite the Trading Networks object described in the Overwrite dialog box. When you select the Force Import checkbox. Trading Networks does not import the item described in the Overwrite dialog box. It overwrites identically named items without prompting for confirmation. When you select Yes to All Trading Networks no longer displays the Overwrite dialog box for identically named items.

. Click the Select File icon to open the Select File dialog box to identify the file that contains the database information that you want to import. Select the Overwrite Rules checkbox Replaces all the processing rules in the target Trading Networks system with the imported processing rules.5 . If you need procedures for this step. use the Overwrite Rules checkbox on the Import Data dialog to indicate how you want Trading Networks to import the processing rules.APPENDIX A Exporting and Importing Database Information Specifying How to Import Processing Rules When you select to import processing rules. Appends the imported processing rules to the end of the existing list of processing rules in the target Trading Networks system.. 524 webMethods Trading Networks User’s Guide Version 6.. Do not select the Overwrite Rules checkbox Trading Networks. perform the following procedure. see “Starting the Trading Networks Console” on page 22.. Procedure for Importing Database Information from the Console To import database information. Select File Import. To import database information 1 2 3 Start the Trading Networks Console. Trading Networks populates the Available Items list with the items contained in the file you select. If you. Note: The appended rules will be in the order in which they appear in the Selected Items list on the Import Data dialog box. Then. Trading Networks displays the Import Data dialog box. click Open. Note: The processing rules maintain the order in which they appear in the Selected Items list on the Import Data dialog box.

5 525 . If you do not select the Force Import checkbox. select the parent element and click . For more information. This dialog lists each item that has an error. select the Processing Rule item and click . and you want Trading Networks to replace all the processing rules in the target database with the processing rules that you import. see. “Partner Data Dependencies” on page 511 “Field Definitions Dependencies” on page 513 “Document Type Dependencies” on page 514 “Processing Rules Dependencies” on page 516 webMethods Trading Networks User’s Guide Version 6. For example. then click . When you select one of the following types of items in the Available Items list. select the Overwrite Rules checkbox. For more information.. Item Partner Data Field Definitions Document Types Processing Rules 7 Click OK. see “Specifying How to Import Processing Rules” on page 524. Select one or more items from the Available Items list. select the item in the Name column. Note: If there are any import errors. see “Importing Items that Have the Same Name as Existing Items” on page 521 and “Suppressing the Overwrite Dialog Box and Forcing the Overwrite of Items” on page 523. To move all items: To move some but not all items: Click to move all items from the Available Items list to the Selected Items list.Importing Database Information from the Console 4 If you want Trading Networks to automatically import identically named items that exist in the target database without prompting for confirmation. Select the items that you want to export by populating the Selected Items list. 5 If you want to import processing rules.. check the Dependencies to determine whether there are other items you should import as well. For more information about dependencies. 6 To select an item in the tree along with all of its child elements. select the Force Import checkbox. Trading Networks displays the Import Errors dialog. see “Using the Overwrite Dialog Box” on page 522 for how to use the Overwrite dialog box. if you want to move all processing rules. To see more details of the error.

APPENDIX A Exporting and Importing Database Information Using the tnexport and tnimport Utilities In addition to exporting and importing data using the Trading Networks Console. binfile is the path and file name to which you want to export the data. if you specify you want to export processing rules. you can export and import data using the command line utilities tnexport and tnimport. If the file already exists. 526 webMethods Trading Networks User’s Guide Version 6. but cannot be read by humans. Run these utilities from the following directory: webMethods6\IntegrationServer\packages\WmTN\bin Use these utilities to perform a bulk transfer of data from one Trading Networks system to another. Indicates you want to export all the TN document types. If the file already exists. all processing rules defined in the Trading Networks database are exported.5 . Note: Binary output is much smaller than the XML output. Trading Networks uses a directory relative to the directory from which you are running the tnexport utility. Trading Networks overwrites it. The directory in which you want the output file placed must already exist. xmlfile is the path and file name to which you want to export the data. If you specify a relative path. For example. If you specify a relative path. Trading Networks overwrites it. -xml xmlfile Use the -xml option to export the data to an XML file. tnexport Utility Use the tnexport utility to export all objects of the selected types. The directory in which you want the output file placed must already exist. options is one or more of the following: -attribs -types Indicates you want to export all the document attributes. Trading Networks uses a directory relative to the directory from which you are running the tnexport utility. The format of the tnexport command line is as follows: tnexport outfile options where: outfile is one of the following: -bin binfile Use the -bin option to export the data to a binary file.

processing rules. and you want the utility to create the ExportedData. and all the extended field definitions to the XML file \TradingNetworks\ExportedData.xml -profiles -extflds -flddefs You want to export all data in the Trading Networks database to the binary file ExportedData. Indicates you want to export all public and private queues. and profile groups that you might have added. Use the following command line: tnexport -bin ExportedData. Indicates you want to export all the definitions for field groups and all the definitions for the profile fields in those groups. public queue. TN document types. Indicates you want to export the values for the extended fields that are in the profiles.bin.5 527 . external ID types. -flddefs -lkup -queues -securityData -tpas -all Examples You want to export all profiles. Indicates you want to export all the trading partner agreements (TPAs). custom extended fields. that is. Indicates you want to export all the definitions for contact types. custom contact types. Indicates that you want to export all objects. all attributes. all extended field values in the profiles.Using the tnexport and tnimport Utilities -rules -profiles -extflds Indicates you want to export all the processing rules. profiles. profile field groups.bin file in the same directory as where you are running the utility. and TPAs. Indicates you want to export all the profiles. Use the following command line: tnexport -xml \TradingNetworks\ExportedData.bin -all webMethods Trading Networks User’s Guide Version 6. field definitions.xml. Indicates the you want to export all certificate information from the Security tabs of all profile. extended field values.

xmlfile is the path and file name of the XML file that contains the data to import. -xml xmlfile options is one or more of the following: -db Indicates that you actually want to import the information and write it to the Trading Networks database. Use the -xml option to import the data from an XML file. The file you specify must contain data that you previously exported from a Trading Networks database using either the tnexport utility or the Trading Networks Console. Note: After using the tnimport utility. 528 webMethods Trading Networks User’s Guide Version 6. If you specify a relative path. The format of the tnexport command line is as follows: tnimport infile options where: infile is one of the following: -bin binfile Use the -bin option to import the data from a binary file.5 .APPENDIX A Exporting and Importing Database Information tnimport Utility Use the tnimport utility to import all data in a specified file. you must reload the WmTN package to be able to use the imported data. Trading Networks looks for the directory relative to the directory from which you are running the tnimport utility. This is useful for testing purposes. If you specify a relative path. If you do not specify this option. Trading Networks looks for the directory relative to the directory from which you are running the tnimport utility. binfile is the path and file name of the binary file that contains the data to import. the tnimport utility will only load and print information about the data in your file.

profiles. and you want the tnimport utility to append the imported processing rules to the existing list of processing rules rather than overwrite the processing rules. You do not want to import it into your database. the import fails.bin -db -rrappend webMethods Trading Networks User’s Guide Version 6.xml -db -force You want to view information about the data in the input file ExportedData.bin You want to import all data in the binary file ExportedData. You do not want to overwrite objects that have the same name as those in the input file. TN document types.5 529 . Examples You want to import the data in the XML file \TradingNetworks\ExportedData. the tnimport utility completely replaces the current processing rules in your database. You want the tnimport utility to overwrite objects that have the same name as those in the input file. and TPAs.bin that resides in the same directory as the tnimport utility. profile field definitions. If you do not specify this option and an object with the same ID already exists in the Trading Networks database. profile field groups.xml. Use the following command line: tnimport -bin ExportedData.Using the tnexport and tnimport Utilities -force Indicates whether you want the tnimport utility to overwrite existing data with the same ID that already exists in the Trading Networks database. -rrappend Indicates whether you want the tnimport utility to append the processing rules in the input file to the current list of processing rules. If you do not specify this option. This applies only to importing processing rules. Use the following command line: tnimport -xml \TradingNetworks\ExportedData. and you want to completely overwrite the current list of processing rules. Use the following command line: tnimport -bin ExportedData. This option only applies when importing document attributes.bin that resides in the same directory as the tnimport utility.

5 .APPENDIX A Exporting and Importing Database Information 530 webMethods Trading Networks User’s Guide Version 6.

. . 532 Example XQL Queries .5 531 . . . . . . . . . . . . . . . . . 532 Sample XML File . . . . . . . . . . .APPENDIX B XQL Reference XQL Reference Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533 Extracting Custom Attributes From XML Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

</degree> <award>Pulitzer</award> <publication>Still in Trenton</publication> <publication>Trenton Forever</publication> </author> 532 webMethods Trading Networks User’s Guide Version 6.50</price> <subscription price='24' per='year'/> </magazine> <book style='novel' id='myfave'> <title>Trenton Today.5 . Sample XML File The example XQL queries in the next section reference the following XML file.D. Trenton Tomorrow</title> <author> <first-name>Toni</first-name> <last-name>Bob</last-name> <degree from='Trenton U'>B.org/TandS/QL/QL98/pp/xql.0'?> <!-.w3.This file represents a fragment of a book store database. <?xml version='1.APPENDIX B XQL Reference XQL Reference Information Use the following link for more information about the W3C. --> <bookstore specialty='novel'> <book style='autobiography'> <title>Seven Years in Trenton</title> <author> <first-name>Joe</first-name> <last-name>Bob</last-name> <award>Trenton Literary Review Honorable Mention</award> </author> <price>12</price> </book> <book style='textbook'> <title>History of Trenton</title> <author> <first-name>Mary</first-name> <last-name>Bob</last-name> <publication> Selected Short Stories of <first-name>Mary</first-name> <last-name>Bob</last-name> </publication> </author> <price>55</price> </book> <magazine style='glossy' frequency='monthly'> <title>Tracking Trenton</title> <price>2. World Wide Web Consortium reference information for XQL: http://www.html.A.</degree> <degree from='Harvard'>Ph.

//author //author/first-name bookstore/*/title //@style bookstore/book/price/@exchange //book[excerpt] webMethods Trading Networks User’s Guide Version 6.com/schema/'> <my:title>Who's Who in Trenton</my:title> <my:author>Robert Bob</my:author> </my:book> </bookstore> Example XQL Queries The following table lists sample XQL queries. find all book elements containing at least one child excerpt element.Example XQL Queries <price intl='canada' exchange='0.placeholder-name-here. Find the exchange attributes of price elements that are contained inside book elements that are contained in a bookstore element.7'>6.</p> <definition-list> <term>Trenton</term> <definition>misery</definition> </definition-list> </excerpt> </book> <my:book style='leather' price='29.5 533 . Find all title elements that are grandchildren of bookstore elements. Find all style attributes anywhere within the current document.</p> <p>But then all nights in Trenton seem dark and stormy to someone who has gone through what <emph>I</emph> have. Find all first-name elements within an author element anywhere in the current document.50</price> <excerpt> <p>It was a dark and stormy night. Anywhere within the current document.50' xmlns:my='http://www. XQL Query /bookstore Description To find the root element (bookstore) of the document Find all author elements anywhere within the current document.

find all author elements that contain at least one degree element or award element and at least one publication element. Anywhere within the current document. Anywhere within the current document. find all degree elements where the from attribute is not equal to “Harvard”. find all author elements that contain more than one publication element.5 .APPENDIX B XQL Reference XQL Query //book[excerpt]/author[degree] Description Anywhere within the current document. find all author elements containing at least one child degree element that are contained inside a book element that has at least one excerpt element. Find the first two books anywhere within the current document. find all book elements containing at least one excerpt element and at least one title element. Anywhere within the current document. Anywhere within the current document. find all book elements with the namespace my. Find the title element with a my prefix within a book element with a my prefix that is a child of the root node of the document. //book[excerpt][title] //author[(degree $or$ award) $and$ publication] //degree[@from $ne$ 'Harvard'] //(book/author)[end()] //my:book /*/my:book/my:title //book[index() $le$ 1] //author[publication!count() $gt$ 1] //author[$any$ last-name = 'Bob'] 534 webMethods Trading Networks User’s Guide Version 6. Find all author elements where at least one of the last-name elements is "Bob" anywhere within the current document. Anywhere within the current document. find the last author element from the entire set of author elements that are contained within book elements. Anywhere within the current document.

find all book elements and all author elements that are children of book elements. Find all the author elements that have last-name elements that contain the string "Bo.5 535 .')] //book[@style/regex("no.*" Find the first comment element starting from the root of the current document." and another single character. Find all the book elements that have a style attribute that contains the regular expression pattern "no.*")] /comment()[0] webMethods Trading Networks User’s Guide Version 6.Example XQL Queries XQL Query //book $union$ //book/author Description Anywhere within the current document. /bookstore/book/author[lastname/regex('Bo.

an empty String) {“value”} (String List with one element) {“value”. null} (String List with two elements) {null. Extracting STRINGLIST or STRING ATTRIBUTES This table shows the values Trading Networks stores for a STRINGLIST or STRING attribute based on the value returned by the XQL query of: /node/item What the XQL query returns XML Data <node></node> <node> <item></item> </node> How Trading Networks stores the results as a: STRINGLIST null {null} (String List with one element.APPENDIX B XQL Reference Extracting Custom Attributes From XML Documents For custom attributes that are extracted from an XML document. “value”} (String List with two elements) STRING null null <node> <item>value</item> </node> <node> <item>value</item> <item></item> </node> <node> <item></item> <item>value</item> </node> 536 webMethods Trading Networks User’s Guide Version 6. In some cases. Trading Networks returns specific values for different attribute data types: STRINGLIST and STRING NUMBERLIST and NUMBER DATETIMELIST and DATETIME The following tables demonstrate the values that Trading Networks returns using the example XQL query of: /node/item.5 . the query returns a null value.“value”} (String List with two elements) null “value” “value” (result always returned as a String List) null {““} (String List with one element. a null String) {“value”} (String List with one element) {“value”. ““} (String List with two elements) {““.

”valueb”} (String List with four elements) STRING null “valuea” Extracting NUMBERLIST or NUMBER ATTRIBUTES This table shows the values Trading Networks stores for a NUMBERLIST or NUMBER attribute based on the value returned by the XQL query of: /node/item What the XQL query returns XML Data <node></node> <node> <item></item> </node> How Trading Networks stores the results as a: NUMBERLIST null {null} (Number List with one element.““. a null element) {“123”} (Number List with one element) {“123”. null.5 537 . null} (Number List with two elements) {null.””.Extracting Custom Attributes From XML Documents What the XQL query returns XML Data <node> <item></item> <item></item> </node> <node> <item>valuea</item> <item> </item> <item></item> <item>valuez</item> </node> How Trading Networks stores the results as a: STRINGLIST {null. ““} (String List with two elements) {““.“123”} (Number List with two elements) null (result always returned as a String List) null {““} (String List with one element. “”} (String List with two elements) {“valuea”. ”valueb”} (String List with four elements) (result always returned as a String List) {““. null} (String List with two elements) {“valuea”. “123”} (String List with two elements) NUMBER null null <node> <item>123</item> </node> <node> <item>123</item> <item></item> </node> <node> <item></item> <item>123</item> </node> “123” “123” webMethods Trading Networks User’s Guide Version 6. an empty String) {“123”} (String List with one element) {“123”. null.

a null element) (result always returned as a String List) null {““} (String List with one element. null} (Datetime List with two elements) “2004/12/31” “2004/12/31” 538 webMethods Trading Networks User’s Guide Version 6.null. “”} (String List with two elements) {“123”. ““. null.”456”} (String List with four elements) NUMBER null “123” Extracting DATETIMELIST or DATETIME ATTRIBUTES This table shows the values Trading Networks stores for a NUMBERLIST or NUMBER attribute based on the value returned by the XQL query of: /node/item What the XQL query returns XML Data <node></node> <node> <item></item> </node> How Trading Networks stores the results as a: DATETIMELIST null {null} (Datetime List with one element. ““} (String List with two elements) DATETIME null null <node> <item>2004/12/31</item> </node> <node> <item>2004/12/31</item> <item></item> </node> {“2004/12/31”} (Datetime List with one element) {“2004/12/31”. an empty String) {“2004/12/31”} (String List with one element) {“2004/12/31”.””.APPENDIX B XQL Reference What the XQL query returns XML Data <node> <item></item> <item></item> </node> <node> <item>123</item> <item> </item> <item></item> <item>456</item> </node> How Trading Networks stores the results as a: NUMBERLIST {null. null} (Number List with two elements) {“123”.”456” } (Number List with four elements) (result always returned as a String List) {““.5 .

””.null. “123”} (String List with two elements) DATETIME null {““.5 539 . ““. “”} (String List with two elements) {“2004/12/31”.”200 5/01/31”} (Datetime List with four elements) null (result always returned as a String List) {““. null.”2006/01/31”} (String List with four elements) “2004/12/31” I webMethods Trading Networks User’s Guide Version 6.Extracting Custom Attributes From XML Documents What the XQL query returns XML Data <node> <item></item> <item>2004/12/31</item> </node> <node> <item></item> <item></item> </node> <node> <item>2004/12/31</item> <item> </item> <item></item> <item>2005/01/31</item> </node> How Trading Networks stores the results as a: DATETIMELIST {null. null} (Datetime List with two elements) {“2004/12/31”. “2004/12/31”} (Datetime List with two elements) {null.

APPENDIX B XQL Reference 540 webMethods Trading Networks User’s Guide Version 6.5 .

. . . . . . 543 Defining TN Document Type XQL Queries for Large Documents . . . . . . . . . . . . . . . . . . . . . . . . . . 548 Viewing Large Documents that Trading Networks Has Processed . . . . . . . . . . . . . . .APPENDIX C Large Document Handling Overview of Large Document Handling . . . . . . . . . 544 Creating Services that Recognize Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . 542 What You Need to Do to Use Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542 Features Not Available for Large Documents . . . . . . 544 Sending Large XML Documents for Processing . . . . . . . . . . .5 541 . . . . . . . . . . . . . . . . . . . 549 webMethods Trading Networks User’s Guide Version 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

APPENDIX C Large Document Handling Overview of Large Document Handling As installed. To use large document handling you must: Ensure your system meets the minimum hardware requirements. As installed. Trading Networks can encounter memory constraint problems. 542 webMethods Trading Networks User’s Guide Version 6. Trading Networks does not use this feature for any documents. Redefine the XQL queries in your TN document types. so they do not require Trading Networks to read the entire document content into memory. when webMethods Trading Networks (Trading Networks) receives a document. For more information see. see “Minimum Hardware Requirements for Large Document Handling” on page 56”. it keeps the document’s content in memory during processing. To learn more about Trading Networks large document processing. to have Trading Networks write large document content to hard disk drive space (called tspace) and keep a pointer to the large document content in memory rather than the document content itself. For more information. see Chapter 5. “Configuring Trading Networks for Large Document Handling” on page 56. “Defining TN Document Type XQL Queries for Large Documents” on page 544.5 . What You Need to Do to Use Large Document Handling You must set up Trading Networks to use large document handling. "Trading Networks Document Processing" in the webMethods Trading Networks Concepts Guide. that is. For more information see. for example: When Trading Networks attempts to execute an XQL query against a document during document recognition When Trading Networks attempts to perform pre-processing and processing actions defined You can set up Trading Networks to behave differently for large documents. If a document is large. Set configuration properties that determine when and how Trading Networks uses large document handling.

and continues document processing. logs a message to the activity log. Verify pre-processing action–The service that Trading Networks uses to verify the digital signature of a document does not support large document handling. the document is saved in the Trading Networks database. Validate pre-processing action–The validation service that Trading Networks uses to validate the structure of a document does not support large document handling.Features Not Available for Large Documents Code custom services to recognize when a document is large and take the appropriate actions based on whether the document content is in memory or written to hard disk drive space. and continues document processing. “Creating Services that Recognize Large Document Handling” on page 544. If a processing rule indicates that Trading Networks is to use queue for polling as the delivery method for a large document. Trading Networks does not validate the document.5 543 . Trading Networks logs a message to the activity log and continues processing. Features Not Available for Large Documents The following Trading Networks features are not available for large documents: Queue for polling delivery method–Trading Networks does not schedule large documents for polling. This affects the following services that you create: Services specified with the Execute a service processing action Immediate and scheduled delivery services that you add For more information see. When Trading Networks processes a large document and is instructed to validate the document structure. If the pre-processing actions indicated that the document be saved. Trading Networks does not verify the digital signature. Ensure IS clients (trading partners) do not use the $xmldata variable to send large XML documents to Trading Networks. webMethods Trading Networks User’s Guide Version 6. When Trading Networks processes a large document and is instructed to verify the document’s digital signature. The document is not available for your partner to poll. logs a message to the activity log.

A failed attribute query causes Trading Networks to be unable to extract the attribute information from the document. see “Action 1—Execute a Service” on page 330.5 . For more information about specifying identifying queries and queries for extracting document attributes in TN XML document types. Trading Networks reads a set number of bytes of the document into memory. see “Creating an Immediate Delivery Service” on page 411 and “Creating a Scheduled Delivery Service” on page 413.. Creating Services that Recognize Large Document Handling You can create services that act on documents that Trading Networks receives. Trading Networks does not necessarily read the entire document content into memory to perform the XQL queries.xqlThreshold) to define the number of bytes that Trading Networks reads. For example. Important! Large XML files that are sent to Trading Networks for processing must contain the XML declaration (e. If the XQL query identifies a node that is in the portion of the document that is not in memory. the XQL queries you define for identifying and attribute queries. must match to nodes in the first portion of the document that Trading Networks reads into memory. that is. see Chapter 12. Immediate and scheduled delivery services.APPENDIX C Large Document Handling Defining TN Document Type XQL Queries for Large Documents When defining TN XML document types. the query will fail.. Trading Networks throws an exception when attempting to process the document. These services are: Services specified with the Execute a service processing action in a processing rule. a processing rule that might match documents that are considered large can also match documents that do not meet the large document requirement that you configure.g. If a large XML document contains any blank space before the XML declaration. If the processing rule invokes a 544 webMethods Trading Networks User’s Guide Version 6. you should code them to handle documents that are considered large and documents that are not considered large. For more information.xml..) as the first line. For more information. Because Trading Networks only reads in a set number of bytes. You set a configuration property (tn. A failed identifying query causes Trading Networks not to select the TN document type for the document. see “Configuring Trading Networks for Large Document Handling” on page 56. <?xml. For more information. When you create these services. Instead. When a document is considered large. you can include two types of XQL queries: identifying queries and queries to extract document attributes. code them to recognize when the document content is in memory or when the service must retrieve the document content from hard disk drive space. “TN XML Document Types”.

indicates whether the document is stored in memory (if the document is not considered large) or on hard disk drive space (if the document is considered large). Trading Networks keeps information about the document in the pipeline in the bizdoc variable.tn. Fields within the bizdoc indicate whether Trading Networks considers the document large.5 545 . webMethods Trading Networks User’s Guide Version 6.rec:BizDocEnvelope IS document type. Note: The structure of bizdoc is defined by the wm. and therefore. Determining Where the Document Content is Stored Regardless of whether a document is considered large or not.Creating Services that Recognize Large Document Handling service. it must take appropriate actions to obtain the document content whether the document content is in memory or on hard disk drive space.

If the document contains at least one large part. If StorageType is null. LargePart?. the document is in the hard disk drive space. If the part is large.5 . is true. 546 webMethods Trading Networks User’s Guide Version 6. LargeDocument? is true. the document is in the Content object.APPENDIX C Large Document Handling Using Fields in bizdoc to Determine Where the Document Content is Stored If StorageType is “tspace”.

tn. the service returns a byte array that contains the retrieved bytes of the document content.Creating Services that Recognize Large Document Handling Use the following fields in bizdoc to determine whether the document is stored in memory or on the hard disk drive space: LargePart?–This field that is within the ContentParts field. If you specified bytes for getAs. How you want Trading Networks to retrieve the document content. For example. If you indicate that you want the webMethods Trading Networks User’s Guide Version 6. When you invoke this service. The part name of the content that you want to retrieve. Trading Networks sets StorageType to tspace and leaves the Content variable null.doc:getContentPartData service to retrieve the document content from the hard disk drive space. Its value is true if Trading Networks considers the content part large. otherwise it is false. specify the index into the document where you want Trading Networks to start retrieving content.tn. LargeDocument?–This field indicates whether any of the content parts of the document are large. its value is true. If a content part is considered large. If the document is not considered large.doc:getContentPartData service to retrieve a specified number of bytes. byteCount If you indicate that you want the wm. specify 0. Retrieving Document Content from Hard Disk Drive Space Use the wm. If all content parts are not considered large. indicates whether the content part is considered large. specify the number of bytes of content that you want Trading Networks to retrieve. its value is false. If at least one of the content parts is considered large. Specify one of the following: bytes—to retrieve a specified number of bytes of the document content stream — to obtain the document content using a Java InputStream object startIndex If you specified bytes for getAs. to retrieve document content from the beginning. specify the following as input: Input Variable BizDocEnvelope partName getAs Description The BizDocEnvelope that Trading Networks created for the document.5 547 . Trading Networks stores the document content in the Content variable and leaves StorageType null.

Programmatically Finding Nodes in a Large Document You might need to locate specific nodes within an XML document.tn.APPENDIX C Large Document Handling wm. The sample code is located in the WmTNSamples package. To send the XML documents.. you need the original document content (i. the service retrieves the delivery content using a Java InputStream object. When sending a document that Trading Networks considers large.doc:getContentPartData service to retrieve using a stream. the service returns a byte array that contains the retrieved delivery content. to obtain the value of a node or to validate the structure of an XML document. the content Trading Networks received before processing). For more information about sending XML documents to Trading Networks.doc:getDeliveryContent service to retrieve the document content. see the Building Your Trading Network manual. Excel client. 548 webMethods Trading Networks User’s Guide Version 6. Sending Large XML Documents for Processing To have Trading Networks process XML documents. If the document is considered large.e. do not submit the document using the $xmldata variable. create an IS service or IS client (Java client. Retrieving the Content for Document Delivery To deliver a document. the service returns a Java InputStream object.5 . The service determines whether the document is considered large or not.tn. For more information about other methods you can use to submit XML documents (besides the $xmldata variable). Note that you can invoke this service for all documents. If the document is not considered large. For more information about creating clients. You can invoke this service for all documents. C/C++ client. Visual Basic client. When you invoke this service. or browser-based client). Use the wm. send them to the Integration Server. see the chapter about creating client code in the webMethods Developer User’s Guide. webMethods provides sample code you can review to determine how to code your service to locate specific nodes within an XML document without reading the document into memory. specify the following as input: Input Variable BizDocEnvelope Description The BizDocEnvelope that Trading Networks created for the document. see the chapter about passing XML data to services in the webMethods Developer User’s Guide. that is whether a document is considered large or not. for example.

you can view the Document Details screen (Transactions View Document). From the Transaction Analysis screen. Trading Networks lists the documents on the Transaction Analysis screen.Viewing Large Documents that Trading Networks Has Processed Viewing Large Documents that Trading Networks Has Processed You can use the Trading Networks Console to view large documents. Click to display the previous 1.5 549 . Content tab of Document Details screen Click to display the next 1. webMethods Trading Networks User’s Guide Version 6.000 bytes.000 bytes. The Content tab of the Document Details screen displays 1.000 bytes of the document.

APPENDIX C Large Document Handling 550 webMethods Trading Networks User’s Guide Version 6.5 .

282 $contentType variable 282 $receiveSvc variable 282. 138 on partner profile 154 defined 496 error logged to. 500 list of fields for each entry 496 printing 502 queries 503 saving data 502 saving queries 503 selector panel button 28 timestamp 496. 500 user name 497. 500 viewing entries 498 for partner 499 using Enterprise 498 using Partner 498 activity type on activity log 496.tn/receive URL for your profile 112. 262 using sample document 235. 257 A ABORTED processing status 434 ACCEPTED processing status 434 and queue for polling 397 ACCEPTED W/ERRORS processing status 434 and queue for polling 397 ACL. 499 values 497 activity log activity class. 499 webMethods Trading Networks User’s Guide Version 6. actions Active profile status for partner profile 164 change status to 176 for your profile 116 change status to 129 activity class case-sensitive 499 error messages 497 on activity log 496. See activity class Activity Log tab 501 activity type 496. 153 delivery service 422 extended fields 98 external ID 118. for XML document 228 exporting information as comma-separated values 502 from to a file 502 full message 497. 499 Advanced tab 500 and Tasks tab 449 Basic Criteria tab 498 brief message 497. 120 external ID type 148 identifying queries to XML document types not using sample document 248. See processing rules. See pre-processing actions processing rules. 454 /invoke/wm. 153 corporation information 147 default processing rule last 314.5 551 . 151. 499 adding address for your profile 119 address on a partner profile 148 CA certificates to partner profile 161 CA certificates to your profile 127 certificates to partner profile 161 certificates to your profile 126 contact 121. Administrators group 23 actions pre-processing.Index Index Symbols "Any” document type in processing rule query 370 $contentEncoding variable 278. 348 delivery method 123. 124.

list of 458 repeating 459. 226 IS schema with TN XML document type 226 parsing schema with TN flat file document type 279.sync. 338 e-mail address as recipient of message 339 prerequisites for processing rule action 338 recipient 338 receiver 339 sender 338 webMethods Administrator 339 aliases identifying servers in a cluster 49 remote server for clustered environment 48 tn.Index partners planning for 82 profile 132. 45 ambiguous document. 295 profiles with profile groups 109. on Activity Log 500 agreed agreement status 188 and data status 180 cannot delete TPA with this status 192 changes you can make 188 Agreement Details screen 181 Agreement ID TPA 178 TPA query 186 agreement status agreed 188 changing 188 disabled 188 list of changes you can make 188 proposed 188 TPA query 186 updating 189 Agreements screen See also TPA selector panel button 27 Alert e-mail action 90.archive:deleteAfterDays system property 458 array byte. 357. 380 address adding for your profile 119 adding on partner profile 148 deleting for your profile 119 deleting on partner profile 152 editing 119 administrators ACL and user name 23 Trading Networks 37 Advanced tab. 135. delivery content returned 412 of numbers 218 flat file document 290 for XML document 214 associating documents 449 IS document type with TN XML document type 77. execute a service as 331. 433 552 webMethods Trading Networks User’s Guide Version 6.tn.tn. 461 properties.remoteAliases server property 44.archive:archive service 459 wm.5 .archive:deleteAfterDays system property 458 wm. 462 scheduling of 458.archive:archiveAfterDays system property 458 tn. Java 319 archiving clustering 459. 461 documents 456 and delivery tasks 469 persistence 459. 150 query with trading partner 447 schema with TN document type 77 asynchronous. 120. defined 268 Anonymous ACL 479. and order of 313 profile group 55 public queues 55. 492 any document type criteria in processing rule 319 receiver criteria in processing rule 318 sender criteria in processing rule 318 API. 461 tn.cluster. 146 to webMethods for Partners 145 private key in partner profile 162 private key to your profile 128 processing rules.

368 profiles 167 transaction analysis 429.tn. list of 26 data input for IS document type 190 selector panel. 138 for FTPS delivery location 124 for your profile 112.5 . See custom attributes Custom Criteria tab 445 data type.doc.xml:bizdocToRecord 226 wm. 419 Batch FTP scheduled delivery service.doc:relateDocuments 449 wm.tn. See Basic Criteria tab batch delivery tasks 413 batch documents scheduled delivery 344 queue 378 service 410 single destination 417 viewing 450 wm.xml:bizdocToRecord 226 brief message on activity log 497.doc:changeStatus 319 wm.tn.tn. IS 23 553 webMethods Trading Networks User’s Guide Version 6. 138 large documents 545 wm.tn.queuing:deliverBatch service 418 wm.tn.tn. in search 167.dictionary:addIDTypes 108 wm.Index attributes See also document attributes Attributes tab 448 custom. 417.tn. 446 processing rule search order 371 processing rules 364 Console. 442 basic operations for Console 31 basic search criteria. See webMethods Developer B2B Integration Server. See webMethods Integration Server (IS) Basic Criteria tab See also basic search critera activity log 498 for documents 429 processing rules 366.dictionary:addFieldGroup 113.tn. altering 216. 136 wm.queuing:updateQueuedTask 416 buttons arrows to reposition custom attributes 35. See wm. 437 Extended Criteria tab 353 how to sort 446 search criteria for documents 437 search criteria for profiles 167 system. 144 case string value.transport:batchFtp service 381 bizdoc for FTP delivery location 124 for your profile 112. 499 built-in services 327 pub. list of 26 selector panel.tn. 143 wm.dictionary:addContactType 109.transport:batchFtp service 413.queuing:getQueuedTask 415 wm. See system attributes average saving value for document attributes 218 for flat file document 290 for XML document 214 B B2B Developer.doc.tn. on Console 26 to navigate the Results table from a query 406 C CA certificates adding to partner profile 161 adding to your profile 127 and webMethods Integration Server’s list of trusted CA certificates 113.dictionary:addIDType 108 wm.delivery:registerService 422 wm. 289 XQL queries 212 case-sensitive activity class 499 ConversationID 444 DocumentID 443 GroupID 444 IS password 23 IS user name 23 password.schema:validate 228 wm. 171.tn.tn.tn.

Extended Criteria tab 353 XQL queries 207 Certificate Chain field for partner profile 145.app. 371 profiles 168 columns. Detail View documents 441 processing rules 367. when archiving and deleting 459. 160 viewing. on Proxies tab 64 user name. 390 Run Mask settings 386 scheduling delivery service 386 settings 386 complex repeating. See CA certificates default certificate sets 114 deleting from partner profile 162 deleting from your profile 127 digitally sending documents 144.cluster. 386. processing rule action 341 Check for Duplicate Document pre-processing action See also duplicate document check flat file document 296 processing rules 327 XML document 228 check uniqueness.notifyPropertyChange property 42 tn.remoteAliases property 49.sync.String) 319 com. See duplicate document check closing sessions close Console 37 session on the server 19 on other servers 24 clustered environment 44 clustering.db. in partner profile 161 viewing.Index password. 161 for your profile 114.doc. String. IS 23 user name. 312 columns.tn. 65 query values 208 user name.app. 312 tn. in your profile 126 changing agreement status 188 IS document type inputs 190 private queue state 393 profile status to Active 129 profile status to Inactive 129 public queue state 392 scheduled delivery queue states 391 table format 33 processing rules 371 TPA data inputs 190 user status. 462 components of Trading Networks Console 25 configuration database 43 document delivery 51 for clustered environment 48 554 webMethods Trading Networks User’s Guide Version 6. for server preferences 62 user name. 461 configuring Trading Networks for 48 notifying when change in cached memory 49 Trading Networks properties change 49 user accounts created 49 properties 48 reassigning delivery task in 479 reassigning service execution task in 492 setting up servers 44.cluster.5 .tn.wm.BizDocStore.changeStatus(BizDocEnvelope. on Proxies tab 64. Custom Criteria tab 171 Value.setUserStatus(String) 319 comma-separated values. exporting activity log as 502 service execution task to a file 488 Complex Interval examples of how to use 387 on Schedule tab 157. when starting Console 23 user status. when archiving and deleting 459.BizDocEnvelope.wm. how to reposition and sort information in 33 com. on Basic Criteria tab 443 Value. 126 certificates See also digital certificates adding to partner profile 161 adding to your profile 126 CA.

transport:batchFtp service 413 via proxy server 63 connection pools.5 . 295 TPA and exporting to industry-standard 180 copying See also duplicating document attributes 182.tn. 151. standard field 89 profile 106 creating duplicate document check 329 immediate delivery service 411 profile group profile 55 partner 146 your own 115 scheduled delivery service 413 555 webMethods Trading Networks User’s Guide Version 6. shared database in non-clustered environment 46 database 43 Integration Server 23 load balancer 46 remote server 417 secure connection 62 using wm. 401 user and Retrieve SenderID from session 287. 151. 153 deleting 123 editing 121.flatfile:convertToValues service 278. 453 contact adding 121. list of 26 starting 22 tables 33 toolbar 30. 149 fields for partner 147 fields for your profile 118 corporation information adding 147 logo.Index settings other tasks 61 overriding when starting server 19 profile 50 Trading Networks and Integration Server (IS) 20 configuration properties 42 connecting to Console. See corporate logo name. 196 document content to database 355 not copying data to new database 43 public queues 380 Corporate tab external ID types 120. configuring 43 Console basic operations 31 closing 37 components of 25 customizing preferences 61 diagram of 25 processing rules ordering 314 display area 29 familiarizing yourself with 25 menu bar 26 panes 31 proxy server 63 refreshing 30 screen name 29 selector panel buttons. 153 Contact tab fields for partner 151 fields for your profile 121 content types and Respond with processing action 347 control number of TPA 179 conventions used in this document 15 ConversationID Basic Criteria tab 444 case-sensitive 444 document search criteria 436 that you want to view 444 extracting for flat file 288 for flat file documents 281 extracting for XML documents 210 search criteria 444 system attribute 194 converting pub.

446 Custom Criteria tab 445 custom document search criteria 437 Detail View tab 35. 445 profiles 167. for queries 445 custom service duplicate document check 328.Index Criteria tab list of fields 349 processing rules document errors 352 document types 351 receiver 350 sender 349 user status 352 custom attributes.tn. 215 in search criteria 167.5 .transport:batchFtp delivery service 413 search criteria documents 437. 446 Extended Criteria tab in processing rules 322. 170 transaction analysis 437. 218 NUMBER LIST for flat file document 291 for XML document 218 STRING extended profile field 97 for flat file 289 for flat file document 289 for XML document 214. 215 DATETIME LIST for flat file document 289 for XML document 214. 329 large document handling 543 D data status modifiable 180 non-modifiable 180 only when agreement status is Agreed 180 data types DATETIME for flat file 289 for flat file document 289 for XML document 214. 216 STRING LIST for flat file document 289 for XML document 214. 216 database and delivery queue 411 clustered environment 44 exporting data from command line 526 information 506 using tnexport utility 526 exporting and importing 507 identifying services sharing database 49 556 webMethods Trading Networks User’s Guide Version 6. 353 extracting for flat file 285 for XML documents 211 moving in Detail view 35. for queries 171 trading partner profiles 170 transaction analysis attribute 445 operator 445 value. 171. 445 custom attributes 194 changing the order of 35. See custom attributes Console setting preferences 61 scheduled delivery service and wm. 446 processing rule criteria 322 Custom Criteria tab list of fields profiles 170 transaction analysis 445 profiles attribute 170 operator 171 value. 437 NUMBER for flat file document 290 for XML document 214.

144 default data type 100 delivery service. alternative to 421 extended field value 97 namespaces 222 port number for FTP 123 on partner profile 137 on your profile 111 port number for FTPS 123 on partner profile 137 on your profile 111 port number for HTTP 123 on partner profile 137 on your profile 111 port number for HTTPS 123 on partner profile 137 on your profile 111 processing rule 316. permanently deleting processing rules 375 debug mode. 317 Add Last option 314.cnf parameters. 215 transaction analysis custom search 440 Days. 155 certificates. See online help from TN Properties page defining document attributes 196 document gateway service outputs 276.Index importing data from command line 526 information 506 using tnimport utility 526 migrating to another database 506 non-clustered environment 45 password for 43 properties 43 saving flat file documents to 297 saving XML documents to 230 separate database for each instance of Trading Networks 47 URL and location of 43 user name for 43 date range delivery task query 473 service execution task query 486 TPA query 187 date received Basic Criteria tab 444 defined 437 document search criteria 437 DATEIMTELIST data type 325 DATETIME data type 325 documents search 440 for XML document 214 specifying detail information for attributes 215 for flat file document 289 transaction analysis custom search 440 DATETIME LIST data type documents search 440 for flat file document 289 for XML document 214. Integration Server 19 Decrypt/Encrypt sub-tab (on Security tab) for partner profiles 144. from partner profile 162 certificates. 280 document types 72.5 . Refer to the Glossary in the Trading Networks Concepts Guide Delete Query toolbar button 401 deleting address 119. 348 listed last 363 profile field value 100 server 61 string data type 97. Run Mask setting 386 deactivating vs. 126 list of trusted CA certificates 113. 80 processing rules 81. 100 values for properties. 347 based on a saved document 362 public queue 380 scheduled delivery service inputs 413 scheduled delivery service outputs 414 TPA 181 XML document types 232 definitions. 152. from your profile 127 contact 123 delivery method 124 delivery tasks. 160 for your profile 113. manually 478 disabled extended fields 103 557 webMethods Trading Networks User’s Guide Version 6.

your TN system to supply when connecting to partner’s system 139 polling 142. on partner profile 141. 158. 138 on partner profile 154 method.5 . 138 on partner profile 154 password. See delivery service tab. 484 service name 421 tab. 344 large documents. for partner to update your profile to the partner’s system 166 password. 123 queue for polling 112. 159 558 webMethods Trading Networks User’s Guide Version 6. 149 flat file document types 308 partner’s profile 175 private key 128 in partner profile 163 processing rules 374 profile 174 referenced by TPA 192 profile group association 150 public queues 384 saved document queries 408 scheduling of archival and deletion service 458. See scheduled delivery service service. See delivery method polling. 141 retry factor 142. not applicable to 483. 345 e-mail address 139 for your profile 112 on partner profile 139 fields. See large documents maximum retries 141. 124 on partner profile 141. See delivery tasks Delivery Maximum Retries 141 delivery method 158. 137 location for your profile 124 Location field 112. 343. 343. 159. 158. out-of-box 111 use as preferred protocol for your profile 112. 158 Delivery Maximum Retries. 153 maximum retries 141. 141 retry factor 142. for your profile 123 fields. See preferred protocol protocol 123 on partner profile’s Delivery Method tab 137. 345 preferred. 153 deleting 124 on partner profile 155 delivery task 467 query 473 search criteria 473 editing 123. 433 prerequisites for 342 protocol 111. 343 service execution task. 461 TPA 192 XML document types 266 deliver document immediate delivery methods and reliable delivery 343. See Delivery Method tab tasks. on partner profile 153 host 111. 158.Index external ID 121. 343. 155 viewing 472 wait between retries 158 Delivery Method tab Delivery Maximum Retries. 159 processing rule action 341. 153 on your profile’s Delivery Method tab 111. 137 queue for polling 112. processing rules 343. 345 delivery method adding 123. See delivery tasks location 124 for your profile 112. 343 wait between retries 53. 141. See Delivery Method tab Trading Networks. See delivery queue schedule. See queue for polling queue. 159. 345 multiple times 343 polling frequency 142 polling method 142. 343 delivering task status 471 delivery See also document delivery and deliver document activity class 497 jobs.

422 re-registering 425 schedule complex options (Complex Interval) 386 to repeat (Simple Interval) 385 to run once 385 scheduled. on partner profile 141. 477 stopped task status 470 559 webMethods Trading Networks User’s Guide Version 6. task statuses 469 information. 155 use public queue 139 user name 138 Wait Between Retries. 153 on your profile 111. processing rules 343 delivery queue defined in Trading Networks 411 delivery schedule 410 scheduled delivery service 410 delivery service adding and registering 422 adding new service 421 Batch FTP 381 defined 410 executing 422 execution task queries 489 host name of Integration Server 423 immediate. on partner profile 141.tn. 484 retry factor 467. 343 Use as preferred protocol. 477. 158 Wait Between Retries. on partner profile 137 protocol 123 on partner profile 137. 484 viewing 472 stop for immediate delivery 476. 485 immediate deliveries. list of 423 Java code 422 password 424 port number of Integration Server 424 private queue 156 registering 421. for your profile 111 port. task statuses 470 search criteria for 472 viewing task 472 server ID 468. for your profile 112. list of 467 managing 466 new task status 469 pending task status 469 printing 474 queries 475 query 472 queued task status 470 reassigning to another server 479 reliable delivery 466 restarting 477 retries 468. partner’s profile 155 Retry Factor 142. 471 finding 472.delivery:registerService built-in service 422 delivery tasks and reliable delivery 343. 424 name of delivery method 423 serviceOutput IS document type 411 user name of User account 424 webMethods Developer 422 wm. 479 status 468. configuration 53 Wait Between Retries. 478 configuration settings 52 defined 466 deleting manually 478 delivering task status 471 delivery method 467 done task status 469. 159.Index port 123 port. 123 Queue for delivery. See scheduled delivery service service name 421. 471 exporting as comma-separated values 475 exporting information to a file 474 failed task status 470. 345 cannot stop for scheduled delivery 476.5 . 484 delivery task query 473 message 468. See immediate delivery service input parameters. 124 Use as preferred protocol. 484 retry limit 467 saving queries 475 scheduled delivery queue 378 scheduled delivery.

tn. 171. public queue state 382 disabled agreement status 188 document attributes 198. 402 Query toolbar buttons for the Trading Partners screen 400 location on Console screen 400 Trading Networks Console 25 user status and processing 320 Using fields in bizdoc to determine location of document content 546 wm. See webMethods Developer diagram of document attributes and how it relates to TN document types 195 processing rules ordering 314 Query tabs displayed 30. 199 hiding 199 extended fields 98. permanently removing extended fields 103 XML document types 266 your profile 129 disconnecting Trading Networks Console from Integration Server 19 display area on Trading Networks screen 29 Display Column panel processing rules query 375 560 webMethods Trading Networks User’s Guide Version 6. 371 profiles 168 custom attributes 35. 308 inactive status of TPA 188 state of scheduled delivery queue 390 XML document types 255. See certificates digital signatures verifying 144. 102. 441 buttons.transport:batchFtp service 419 digital certificates. 485 in your system 472 tasks associated with a document 474 when automatically deleted 469 Detail View after search 367. 103 displaying 101 flat file document types 306. 175 document attributes 199 extended fields 102 flat file document types 308 partner’s profile 175 permanently removing flat file document type from database 308 permanently removing XML document type from database 266 processing rules 373 vs. 445 Transaction Analysis screen 448 Developer. 446 rows 367 sorting attributes 446 standard attributes 35. 266 disabled extended fields 103 disabling a profile 129.5 . 446 profile 171 repositioning attributes 35. verifying for flat file 294 for flat file document 294 for XML document 227 pre-processing action 354 disable action 391 Disable Queue. navigation arrows 406 columns documents 441 processing rules 367. 403 hidden 29. 446 defined 428 exporting information to a file 450 moving selected custom attributes 35.Index task ID 467 task manager 52 task output 469 task status 469 task type 467 time created 467. 160 digital signatures. 472 time to wait before retry 468 time updated 467 tracking 466 transport time 468 viewing 472.

Index

Display Column panel, processing rules query 371 displaying, See viewing DOCTYPE identifier 206, 208 Identify tab 236, 248, 258, 263 DoctypeID, extracting for flat file documents 280 DoctypeName, extracting for flat file documents 280 document attributes custom, See also custom attributes copying 182, 196 custom 194 DATETIME data type 325 for flat file 289 for XML document 214 DATETIME LIST data type 440 DATETIMELIST data type 325 defining 196 detail information for XML documents 214 determining TN document type dependencies 201 disabled 198 disabling 199 enabling 200 generating reports 196 list of 197 lowercase 216, 289 managing 198 new with empty fields 146, 196, 235, 247, 348, 349 NUMBER data type 218, 324 for flat file document 290 for XML document 214 NUMBERLIST data type 324 purchase order, as example of extracted string attributes 216, 289 requiring extraction from flat file document types 285 requiring extraction from XML documents 213 saving average value of 218, 290 for XML document 214 maximum value of 218, 291 for flat file document 291 minimum value of 218 for flat file document 290 sum value of 218 for flat file document 291

STRING data type 323 for flat file 289 for XML document 214 string substitution 217, 290 STRINGLIST data type 323 system attributes, See also system attributes TN_parms 276, 280 transform for XML document 214 updating 199 uppercase 216, 289 using as search criteria 195 viewing 198, 448 related activity log entries 449 document delivery action, See deliver document and processing rules configuration 51 deliver document by processing rule action 341 delivery tasks, See delivery tasks from email address 51 immediate delivery methods and reliable delivery 343, 344 large documents, See large documents processing rules, See deliver document and processing rules reliable delivery 466 and immediate delivery 343 and scheduled delivery 344 screen, to view delivery tasks 472 selector panel button 28 task manager 52 tn.mail.from property 51 tn.mail.subject property 51 tn.task.sweepTime property 52 via e-mail, configuration settings 51 viewing delivery tasks in your Trading Networks system 472 document errors Criteria tab 352 criterion 321, 352 has criteria 322 has no criteria 322 may have criteria 322 processing rule criterion 321, 352 list of 322

561

webMethods Trading Networks User’s Guide Version 6.5

Index

document gateway service $contentEncoding variable for flat file document 278 $receiveSvc variable for resubmitting flat file document 454 defined 70, 272 inputs and outputs 276 outputs, list of 276, 280 overview 272 resubmitting flat file document 454 service signature for 276 wm.tn.doc.ff:routeFlatFile 277 wm.tn.samples.gateway:gateway 276 wm.tn:receive 277 document types See also IS document types See also TN document types See also flat file document types See also XML document types DOCTYPE identifier 236 processing rule criterion 319, 351 selector panel button 27 documentation additional 16 conventions used 15 feedback 16 DocumentID Basic tab 443 case-sensitive 443 duplicate document for flat file document 296 for XML document 229 pre-processing action 327 extracting for flat file documents 280 extracting for XML documents 210 of document that you want to view 443 search criteria 435, 443 system attribute 194 documents 542 ACCEPTED status, change to 397 ACCEPTED W/ERRORS status, change to 397 ambiguous 268 archiving 456 archiving properties, list of parameters 458

attributes, See document attributes basic search criteria, list of 366, 429 batch, and scheduled delivery queue 378 deleting saved queries 408 delivery, See document delivery digitally signing 144, 160 DONE status, change to 396 DONE W/ERRORS status, change to 396 errors, See document errors extracting attributes for processing 71 flat files, See flat file documents gateway service, See document gateway service large, See large documents managing 428 matching to flat file document type 294 matching to XML document type 226 partner as receiver 431 as sender 430 pollable 450 POLLABLE status, change to 397 printing information about 450 processing a saved document again 452 reprocessing 454, 455 resubmitting 452, 454 queue for polling 397 QUEUED status, change to 396 recognition, See recognition retrieving content with wm.tn.doc:getDeliveryContent service 412 reverting to saved queries 407 saving queries 404 scheduled delivery queue 396 search criteria basic list 429 custom 437 SQL query 451 tracking 428 types, See document types types, See TN document types

562

webMethods Trading Networks User’s Guide Version 6.5

Index

unknown receiver 431 sender 430 TN document type 432 updating saved queries 406 viewing 428 activity log entries related to 449 content 448 delivery tasks associated with 474 in a queue 396 in your system using Partner 447 pollable documents 397 related documents 449 scheduled delivery documents 396 service execution tasks associated with 487 XML, See XML document done delivery task status 469, 471 service execution task status 483 DONE processing status 433 and scheduled delivery queue 396 DONE W/ERRORS processing status 433 and scheduled delivery queue 396 draft status of TPA, proposed 188 drain action, scheduled delivery queue 392 Drain Queue, public queue state 383 drained state, scheduled delivery queue 391 D-U-N-S number, as ID type 120, 149 duplicate See also copying document, See duplicate document check flat file document type 300 XML document type 233 duplicate document check 327 Check for Duplicate Document processing action 327 custom services 328 DocumentID for XML document 229, 296 pre-processing action 327 for flat file document 296 ReceiverID 327 SenderID 327 TN document type 327

wm.tn.rec:DupCheckService specification 329 XML document 228

E
ebXML wm.ip.ebMXL.cpa.rec:tpaDataSchema 179 wm.ip.ebxml.cpa:initTPA 181 e-delivery service, example of scheduling times 385 EDI control number and TPA 179 wm.b2b.editn.TPA:EDITPA 179 wm.b2b.editn.TPA:initService 181 Edit menu option 26 editing address 119 contact 121, 151, 153 delivery method 123, 153 extended field 125 external ID 118, 120 public queues 380 e-mail address 90 address as recipient of e-mail message 339 Alert action 90, 338 configuration settings for document delivery 51 delivery location for partner 139 for your profile 112, 124 example of message body 340 from address 51 partner to deliver to 139 pipeline information 340, 347 recipients, list of 338 standard field 90 subject when delivering document 51 enable, See enabling enabled document types, See also disabled document types flat file document types 309 state, scheduled delivery queue 390 XML document types 267

563

webMethods Trading Networks User’s Guide Version 6.5

Index

enabling a profile 129, 176 document attributes 200 extended fields 103 flat file document types 309 partner’s profile 164, 176 processing rules 374 public queue state 382 queue state 382 scheduled delivery queue state 391 toolbar button for showing just enabled 199, 201 XML document types 267 your profile 129 encoding, $contentEncoding variable for flat file document 278 Encrypt sub-tab See Decrypt/Encrypt sub-tab End Date, Complex Interval setting 386 End Time, Complex Interval setting 386 Enterprise in processing rule 318 profile 106 profile query 166 query for profile 166 selector panel icon 26 viewing activity log entries using Enterprise 498 vs. Trading Partners view, for Sent and Received queries 447 envelope activity class 497 error messages Activity class 497 limit number of 228, 296 logged to activity log for XML document 228 profile fields 116, 163 errors document recognition, processing rule criterion 352 document, See document errors import database 525 invalid e-mail 339 OutOfMemory when parsing 278, 295 parsing (OutOfMemory) 278, 295 undefined webMethods administrator 339 unknown receiver in e-mail address 339 unknown sender in e-mail address 338

example of CBL document and XQL query and NUMBER data type 219 Complex Interval delivery service settings 387 e-mail message body 340 namespace affecting XQL queries 223 in XML document 221 mappings 223 processing rules ordering 314 purchase order as example of extracted string attributes 216 purchase order, as example of extracted string attributes 289 scheduling delivery service times 385 service execution task parameters 53 standard profile field entries 89 uses for processing rules 81 execute a service asynchronously 331, 357, 433 delivery 422 how often task manager runs 52 prerequisites for processing rule action 330 processing rule action 330, 433 reliable execution 331 service execution task 331 setting input values 336 synchronously 331, 357 EXIT flow operation 418 export service of TPA 180 vs. export function 184 exporting activity log information 502 database information 506 from Console 519 items you can export 507 tnexport utility 526 delivery task information 475 detail view information 450 query results, activity log 502 service execution task information 488 extended criteria attributes you can select 322 operator 322 tab, See Extended Criteria tab value of custom attribute 325

564

webMethods Trading Networks User’s Guide Version 6.5

Index

Extended Criteria tab 353 attribute 353 operator 353 value 353 extended fields adding 98 custom profiles search criteria 167 defined 84, 88 disabled 98, 102 disabling 102 editing 125 enabling 103 Group 125 managing 101 permanently remove vs. disable 103 profile 97 tab, See Extended Fields tab viewing 164 for your profile 101, 125 on partner profile 159, 163 extended profile fields, See extended fields external ID information adding 118, 120 deleting 121, 149 editing 118, 120 external ID type adding 148 Corporate tab on Profile screen 120, 149 ReceiverID for flat file 215 for flat file documents 286, 288 for XML document 214 required type 50 SenderID for flat file documents 286, 288 for XML document 214, 215 tn.required.idType to specify required type 50 extracting attributes from documents 71 information for TN document type 214

custom attributes for flat file 285 for XML document 211 information for XML document 210, 214 system attributes for XML document 210

F
failed delivery task status 470, 471 service execution task status 483 failure and exiting scheduled delivery service 418 message, EXIT flow operation 418 ffdata, output for flat file document 276, 280 fields extended, See also extended fields extended, See extended fields profile, See also profile fields required 88 standard 84, 88 that you define 84, 88 webMethods-defined 84, 88 File menu option 26 File Screen function 26 files .csv file 450, 475, 488, 502 .txt file 450, 475, 488, 502 exporting delivery information to 474 detail view information to 450 service execution information to 488 sample XML 532 script 18 server.sh script file 18 Trading Networks properties file 42 final status of TPA, agreed 188 finding delivery tasks 472, 485 processing rules 366, 367 profiles 166 TPAs 185

565

webMethods Trading Networks User’s Guide Version 6.5

Index

flat file document types See also flat file documents 539 associated with parsing schema 279, 295 attributes in the definition 283 defining 283 definition of 272 disabled 306 disabling 308 document gateway service, See document gateway service duplicate 300 enabling 309 Extract panel 301 Identify panel 300 new with empty fields 300 non-matching 284 options 294 Options tab 304 parsing schema 304 permanently removing from database 308 requiring extraction of attributes 285 schema, see flat file schema unknown 284 viewing 306 flat file documents converting the input stream to an IS document 278, 295 defined 272 digital signature, verifying flat file document 294 document gateway service 454 See also document gateway service document types 283 See also flat file document types duplicate document check 296 ffdata 276, 280 reading the input stream 278 resubmitting 454 saving document to database 297 TN_parms 276, 280 wm.tn.doc.ff:routeFlatFile 277 wm.tn.samples.gateway:gateway 276 wm.tn:receive 277 flat file schema and flat file document structure validation 295 associated with document type 279, 295

flow services delivery task 415 writing document gateway services as flow services 276 flow services, writing document gateway services as flow services 278 FTP delivery location, for your profile 112, 124, 138 delivery location, on partner profile 154 port number 123 port number, for your profile 111 port number, on partner profile 137 protocol, on partner’s profile 137 protocol, on your profile 111 wm.tn.transport:batchFtp delivery service 411 FTPS delivery location, for your profile 112, 124, 138 delivery location, on partner profile 154 port number 123 port number, for your profile 111 port number, on partner profile 137 protocol, on partner’s profile 137 protocol, on your profile 111 full message on activity log 497, 500

G
gateway service, See document gateway service group Administrators ACL 23 Extended Fields tab 125 profile group, defining 135, 150 profile group, deleting 150 GroupID Basic Criteria tab 444 case-sensitive 444 document search criteria 436 extracting for flat file documents 281 extracting for XML documents 211 of document that you want to view 444 search criteria 444 system attribute 194

566

webMethods Trading Networks User’s Guide Version 6.5

Index

H
handling exceptions, and wm.tn.queuing:deliverBatch service 418 hard disk drive space, and storing large documents 547 has errors processing rule criteria 322 has no errors processing rule criteria 322 Help menu option 26 Hide query toolbar button 401 hiding disabled document attributes 199 flat file document types 306 XML document types 255 queries panels 448 toolbar button for 401 high availability environment 4