Title 

Page

Trading Networks Version 7.1 webMethods Trading Networks

Administrator’s Guide
Copyright
&  Docu‐
ment ID

Cerebra, Glue, Infravio X‐Broker, Infravio X‐Registry, Infravio, My webMethods Server, My webMethods, webMethods Access, webMethods Administrator, 
webMethods Broker, webMethods Central Configuration, webMethods Dashboard, webMethods Designer, webMethods Developer, webMethods Fabric, 
webMethods Glue, webMethods Infrastructure Data Collector, webMethods Infravio X‐Broker, webMethods Infravio X‐Registry, webMethods Installer, 
webMethods Integration Server, webMethods logo, webMethods Mainframe, webMethods Manager, webMethods Modeler, webMethods Monitor, 
webMethods Optimize for Infrastructure, webMethods Optimize for Process, webMethods Optimize, webMethods Portal, webMethods Process Engine, 
webMethods Servicenet, webMethods Task Engine, webMethods Trading Networks, webMethods Workflow, and webMethods are either registered 
trademarks or trademarks of webMethods, Inc.
Acrobat, Acrobat, and Reader are registered trademarks of Adobe Systems Incorporated.  Amdocs and ClarifyCRM are registered trademarks of Amdocs.  
Ariba is a registered trademark of Ariba, Inc.  BEA, BEA WebLogic Server, Jolt, and Tuxedo are registered trademarks, and BEA WebLogic Platform is a 
trademark of BEA Systems, Inc.  Action Request System, BMC Software, PATROL, and Remedy are registered trademarks of BMC Software, Inc.  BroadVision 
is a registered trademark of BroadVision, Inc.  Chem eStandards and CIDX are trademarks of CIDX, The Chemical Industry Data Exchange.  SiteMinder and 
Unicenter are registered trademarks of CA, Inc.  PopChart is a registered trademark of CORDA Technologies, Inc.  Kenan and Arbor are registered trademarks 
of Alcatel‐Lucent.  Data Connection and SNAP‐IX are registered trademarks of Data Connection Corporation.  D&B and D‐U‐N‐S are registered trademarks of 
Dun & Bradstreet Corporation.  Eclipse is a trademark of Eclipse Foundation, Inc.  Entrust is a registered trademark of Entrust, Inc.  papiNet is a registered 
trademark of the European Union and the United States.  Financial Information eXchange, F.I.X, and F.I.X Protocol are trademarks of FIX Protocol Ltd.  
UCCnet and eBusinessReady are registered trademarks, and 1SYNC and Transora are trademarks of GS1 US.  Hewlett‐Packard, HP, HP‐UX, OpenView, PA‐
RISC, and SNAplus2 are trademarks of Hewlett‐Packard Company.  i2 is a registered trademark of i2 Technologies, Inc.  AIX, AS/400, CICS, ClearCase, DB2, 
Domino, IBM, Informix, Infoprint, Lotus, Lotus Notes, MQSeries, OS/390, OS/400, RACF, RS/6000, SQL/400, S/390, System/390, VTAM, and WebSphere, and 
z/OS are registered trademarks; and Communications System for Windows NT, DB2 Universal Database, IMS, MVS, and SQL/DS are trademarks of IBM 
Corporation.   InnoDB is a trademark of Innobase Oy.  Itanium is a registered trademark of Intel Corporation.  Linux is a registered trademark of Linus 
Torvalds.  W3C is a registered trademark, and X Window System is a trademark of the Massachusetts Institute of Technology.  MetaSolv is a registered 
trademark of Metasolv Software, Inc.  ActiveX, Microsoft, Outlook, Visual Basic, Visual SourceSafe, Windows, Windows NT, and Windows Server are 
registered trademarks of Microsoft Corporation.   Six Sigma is a registered trademark of Motorola, Inc.  Firefox and Mozilla are registered trademarks of the 
Mozilla Foundation.  MySQL is a registered trademark of MySQL AB.  nCipher is a trademark of nCipher Corporation Ltd.   Eclipse is a trademark of Eclipse 
Foundation, Inc.  Entrust is a registered trademark of Entrust, Inc.  papiNet is a registered trademark of the European Union and the United States.  Financial 
Information eXchange, F.I.X, and F.I.X Protocol are trademarks of FIX Protocol Ltd.  UCCnet and eBusinessReady are registered trademarks, and 1SYNC and 
Transora are trademarks of GS1 US.  Hewlett‐Packard, HP, HP‐UX, OpenView, PA‐RISC, and SNAplus2 are trademarks of Hewlett‐Packard Company.  i2 is a 
registered trademark of i2 Technologies, Inc.  AIX, AS/400, CICS, ClearCase, DB2, Domino, IBM, Informix, Infoprint, Lotus, Lotus Notes, MQSeries, OS/390, 
OS/400, RACF, RS/6000, SQL/400, S/390, System/390, VTAM, and WebSphere, and z/OS are registered trademarks; and Communications System for Windows 
NT, DB2 Universal Database, IMS, MVS, and SQL/DS are trademarks of IBM Corporation.  InnoDB is a trademark of Innobase Oy.  Itanium is a registered 
trademark of Intel Corporation.   Teradata is a registered trademark of NCR Corporation. 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.  SUSE is a registered trademark 
of Novell, Inc.  Appia is a registered trademark and Javelin Technologies is a trademark of NYFIX, Inc.  CORBA is a registered trademark of Object 
Management Group, Inc.  JD Edwards, OneWorld, Oracle, PeopleSoft, Siebel, and Vantive are registered trademarks; and Infranet, PeopleSoft Pure Internet 
Architecture, Portal, and WorldSoftware are trademarks of Oracle Corporation.  Perforce is a trademark of Perforce Software.  JBoss and Red Hat are 
registered trademarks of Red Hat, Inc.  PIP and RosettaNet are trademarks of RosettaNet, a non‐profit organization.   SAP and R/3 are registered trademarks 
of SAP AG.  PVCS is a registered trademark of Serena Software, Inc.  SWIFT and SWIFTNet are registered trademarks of Society for Worldwide Interbank 
Financial Telecommunication SCRL.  SPARC and SPARCStation are registered trademarks of SPARC International, Inc.  BAAN and SSA are registered 
trademarks; and SSA Global is a trademark of SSA Global Technologies, Inc.  EJB, Enterprise JavaBeans, Java, JavaServer, JDBC, JSP, J2EE, Solaris, Sun, and 
Sun Microsystems are registered trademarks; and Java Naming and Directory Interface, JavaServer Pages, SOAP with Attachments API for Java, and SunSoft 
are trademarks of Sun Microsystems, Inc.  Sybase is a registered trademark of Sybase, Inc.  VERITAS is a registered trademark, and VERITAS Cluster Server is 
a trademark of Symantec Corporation.  UNIX is a registered trademark of The Open Group.  Unicode is a trademark of Unicode, Inc.  VeriSign is a registered 
trademark of Verisign, Inc. 
Software AG and all Software AG product names are either trademarks or registered trademarks of Software AG. 
Other product and company names mentioned herein may be the trademarks of their respective owners.
Copyright © 2007 webMethods, Inc. All rights reserved.
Copyright © 2007 Software AG and/or its suppliers, Uhlandstrasse 12, 64297 Darmstadt, Germany. All rights reserved.

Document ID: TN-AG-71-20070831

 Contents

Contents

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

Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Part I. Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Chapter 1. Integration Server and Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Starting the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Starting the Integration Server from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Shutting Down the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Configuring Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Chapter 2. Trading Networks User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Starting the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Opening and Closing Sessions on Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Familiarizing Yourself with the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
The Selector Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Selecting Trading Networks Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Selecting a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Selecting TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Coordinating Your Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Closing the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Trading Networks Web Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Chapter 3. Configuring webMethods Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Trading Networks Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Configuring the Trading Networks Database Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Trading Networks in a High Availability Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Shared Trading Networks Database in a Clustered Environment . . . . . . . . . . . . . . . . . . . . 44
Shared Trading Networks Database in a Non-Clustered Environment . . . . . . . . . . . . . . . . 45
Separate Trading Networks Database for Each Instance of Trading Networks . . . . . . . . . 46
Configuring Trading Networks for a Clustered Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Configuring Profile Settings for the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

webMethods Trading Networks Administrator’s Guide Version 7.1 3

 Contents

Configuring E-mail Settings for Document Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Configuring Tasks Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Enabling Task Failure Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Configuring Trading Networks for Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Minimum Hardware Requirements for Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . 55
Steps for Configuring Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Setting Properties in the Trading Networks Properties File . . . . . . . . . . . . . . . . . . . . . . . . . 56
Increasing the Size of the Largest Document that Can Be Saved When Using DB2 . . . . . 57
Configuring the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Other Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Chapter 4. Configuring My webMethods to Work with Trading Networks . . . . . . . . . . . . 61

Central User Management—How Integration Server Authorizes My webMethods Users . . . . . . . . . 62
How Trading Networks Uses Central User Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Setting Up Central User Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Configuring Central User Management in Integration Server . . . . . . . . . . . . . . . . . . . . . . . 63
Identifying Trading Networks Server to My webMethods Server . . . . . . . . . . . . . . . . . . . . . 63
How the Integration Server Authenticates a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
How the Integration Server Authorizes a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
How Trading Networks Adds My webMethods Roles to ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Defining Trading Networks Administrators for My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Granting My webMethods Users the Authority to Execute Trading Networks Services . . . . . . . . . . . 67
Controlling Access to Administrator Pages and Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Access Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Functional Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Defining Role-Based Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Role-Based Access is Cumulative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Data and Actions Governed by Role-Based Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Data and Actions Governed by General Functional Permissions . . . . . . . . . . . . . . . . . . . . 71
Data and Actions Governed by Data Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Setting Up Role-Based Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Granting General Functional Permissions to a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Removing General Functional Permissions from a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Defining Data Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
About Defining Data Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Defining Data Sets and Granting Roles Permissions to Act on the Data Set . . . . . . . . . . . 76
Removing Data Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
How Trading Networks Uses My webMethods Roles Privileges . . . . . . . . . . . . . . . . . . . . . . . . . 80
Configuring How Long My webMethods Waits for a Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Configuring Resubmission and Reprocessing Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

webMethods Trading Networks Administrator’s Guide Version 7.1 4

 Contents

Settings for BAM on Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Setting the Property in the Trading Networks Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Configuring the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Chapter 5. Setting up Analysis of Trading Networks Transaction Data . . . . . . . . . . . . . . 85

What is BAM on Trading Networks? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Configure TN Document Types for BAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Updating a TN Document Type for Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Configuration Required for Monitoring Trading Networks Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Chapter 6. Planning Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Task 1: Identify the Types of Transactions to Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Task 2: Determine the Important Document Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Task 3: Define the Types of Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Task 4: Define Information to Maintain about Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Task 5: Create Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Task 6: Define Actions to Perform Against Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Task 7: Add Partners to Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Task 8: Configure Trading Networks for BAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Part II. Managing Trading Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Chapter 7. About Trading Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

How to Manage Partners in Your Trading Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Defining the Information You Want to Collect about Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Creating Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Adding Profiles for Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Information Trading Networks Maintains in a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Partner Identification Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
External IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Profile Group Membership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Delivery Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Delivery Method Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
General Partner Delivery Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Extended Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Steps to Setting up Profiles in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

webMethods Trading Networks Administrator’s Guide Version 7.1 5

 Contents

Profile Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Chapter 8. Defining and Managing Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

What are Profile Fields? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Required Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Viewing Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Updating Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Adding Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Viewing Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Duplicating an Existing Profile Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Updating Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Disabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Enabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Chapter 9. Defining and Managing Your Profile (Your Enterprise) . . . . . . . . . . . . . . . . . . 145

Creating Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Viewing Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Updating Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Updating Your Corporation Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Managing Your External IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Managing Addresses for Your Corporation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Managing the Contacts in Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Managing Your Profile Group Memberships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Managing Delivery Methods in Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Managing Your Profiles Extended Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Managing the My webMethods Users Associated with Your Profile . . . . . . . . . . . . . . . . . . . . . . 157
Managing Security Information in Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Adding Certificate Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Managing Certificate Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Enabling Your Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Disabling Your Profile—Changing the Status to Inactive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Chapter 10. Defining and Managing Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Adding Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Searching for Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Performing a Keyword Search for Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Performing an Advanced Search for Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Viewing Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

webMethods Trading Networks Administrator’s Guide Version 7.1 6

 Contents

Updating Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Updating the Corporation Information in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Managing External IDs in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Managing Addresses for the Corporation in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Managing Contacts in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Managing the Partner Profile Group Memberships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Managing Reliable Delivery and Polling Settings in a Partner Profile . . . . . . . . . . . . . . . . . . . . . 178
Managing Delivery Methods in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Updating Extended Fields in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Managing the My webMethods Users Associated with the Partner’s Profile . . . . . . . . . . . . . . . . 184
Managing Security Information in Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Adding Certificate Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Managing Certificate Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Copying a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Suspending Delivery for a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Resuming Delivery for a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Deleting a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Disabling a Partner’s Profile—Changing the Status to Inactive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Enabling a Partner’s Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Searching for Certificates that Are Expired or Expiring Soon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Searching for Expired Partner Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Searching for Partner Certificates that Will Expire Soon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Chapter 11. Defining and Managing Profile Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

What are Profile Groups? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Defining a Profile Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Searching for Profile Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Performing a Keyword Search for Profile Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Updating a Profile Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Deleting a Profile Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Chapter 12. Defining and Managing Trading Partner Agreements (TPAs) . . . . . . . . . . . . . 203
What is a Trading Partner Agreement (TPA)? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Information You Supply to Define a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Defining a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Managing TPAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Finding and Viewing TPAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Updating TPAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Changing a TPA Agreement Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Changing the TPA Data Inputs in the IS Document Type . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Deleting a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

webMethods Trading Networks Administrator’s Guide Version 7.1 7

 Contents

Part III. Defining Transaction Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

Chapter 13. Defining and Managing Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . 221

What are Document Attributes? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Defining Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Managing Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Viewing Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Displaying Disabled Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Hiding Disabled Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Updating Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Disabling Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Enabling Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Determining the TN Document Types that Use an Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Chapter 14. Defining and Managing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . 231

What Are TN XML Document Types? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Identification Information in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Determining the TN Document Type to Use for an XML Document . . . . . . . . . . . . . . . . . . . . . . 237
When an XML Document Does Not Match Any TN Document Types . . . . . . . . . . . . . . . . 237
When an XML Document Matches More Than One TN Document Type . . . . . . . . . . . . . . 238
Extraction Information In TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Important Attributes that You Should Extract from an XML Document . . . . . . . . . . . . . . . . . . . . 238
Indicating that Attributes are Required in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . 241
Transformation Information for Extracted Attributes of TN Document Types . . . . . . . . . . . . . . . 242
Specifying Built-in Transformation Information for SenderID and ReceiverID . . . . . . . . . . . 243
Specifying Built-In Transformation Information for Attributes with the DATETIME and
DATETIME LIST Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Specifying Built-in Transformation Information for Attributes with the STRING or
STRING LIST Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Specifying Built-in Transformation Information for Attributes with the NUMBER Data Type 246
Specifying a Custom Transformation Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Setting Input and Output Values for Custom Transformation Services . . . . . . . . . . . . 248
Namespace Mappings in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
XML Documents and Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
How Namespaces Affect Identifying and Attribute XQL Queries . . . . . . . . . . . . . . . . . . . . . 251
Namespace Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Options in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Specifying an IS Document Type for TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . 254
Specifying an IS Schema for TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Disabling Processing Rule Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Specifying Pre-Processing Actions for TN XML Document Type . . . . . . . . . . . . . . . . . . . . . . . . 256

webMethods Trading Networks Administrator’s Guide Version 7.1 8

 Contents

Verifying the Digital Signature of an XML Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

Validating the Structure of an XML Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Checking for Duplicate of the XML Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Saving an XML Document to the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Defining TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Using a Sample Document to Define a TN XML Document Type . . . . . . . . . . . . . . . . . . . . . . . . 262
Working with a Sample Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Defining a TN XML Document Type without a Sample Document . . . . . . . . . . . . . . . . . . . . . . . 275
Managing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Viewing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Updating TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Using a Sample Document when Updating a TN XML Document Type . . . . . . . . . . . . . . . 283
Updating a TN XML Document Type without a Sample Document . . . . . . . . . . . . . . . . . . . 289
Disabling TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Enabling TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Testing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

Chapter 15. Defining and Managing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . 297
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Run-Time Processing of Flat File Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Defining Document Gateway Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Reading the Input Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Determining the Content Type and Content Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Converting a Flat File Document to an IS Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Specifying the Document Gateway Services Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Pipeline Matching Criteria Used to Identify the TN Document Type . . . . . . . . . . . . . . . . . . . . . . 309
Error Conditions When Matching Documents to TN Document Types . . . . . . . . . . . . . . . . 310
Attributes To Extract From Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Error Conditions When Extracting Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
System Attributes To Extract From Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
SenderID and ReceiverID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
DocumentID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
ConversationID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
UserStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
GroupID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Transformation Information for Extracted Attributes of TN Flat File Document Types . . . . 314
Built-in Transformations for SenderID and ReceiverID . . . . . . . . . . . . . . . . . . . . . . . . 314
Built-In Transformations for DATETIME and DATETIME LIST Data Type Attributes . 314
Built-in Transformations for STRING or STRING LIST Data Type Attributes . . . . . . . 315

webMethods Trading Networks Administrator’s Guide Version 7.1 9

 Contents

Built-in Transformations for NUMBER Data Type Attributes . . . . . . . . . . . . . . . . . . . . 316

Custom Transformation Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Disabling Processing Rule Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Pre-Processing Actions in the TN Flat File Document Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Verifying the Digital Signature of Flat File Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Validating the Structure of Flat File Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Checking for Duplicates of the Flat File Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Saving Flat File Documents to the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Defining TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Managing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Viewing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Updating TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Disabling TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Enabling TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

Chapter 16. Defining and Managing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

What are Processing Rules? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Processing Rules Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Adding Processing Rules and the Order of Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Reordering Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Processing Rule Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Sender and Receiver Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Document Type Criterion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
User Status Criterion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Document Recognition Errors Criterion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Extended Criteria—Using Custom Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Bypassing Lookups for Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Skip Processing Rule Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Bypass Lookup by Explicitly Specifying the Processing Rule . . . . . . . . . . . . . . . . . . . . . . . 350
Pre-Processing Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
Creating a Duplicate Document Check Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
Processing Rule Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Action 1—Execute a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Executing the Service Synchronously or Asynchronously . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Service Execution Tasks and Reliable Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Creating the Service for the Execute a Service Processing Action . . . . . . . . . . . . . . . . . . . 358
Input and Output Variables for the Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Setting Values for the Input Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Logic for the Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

webMethods Trading Networks Administrator’s Guide Version 7.1 10

 Contents

Action 2—Send an Alert E-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

Recipient of the E-mail Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Subject of the E-mail Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Body of the E-mail Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Action 3—Change User Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Action 4—Deliver the Document to the Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Immediate Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Using Reliable Delivery with Immediate Delivery Method . . . . . . . . . . . . . . . . . . . . . . 367
Scheduled Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Using Reliable Delivery with Scheduled Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Queued for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Preferred Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Action 5—Respond With a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Specifying the Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Specifying the Content Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Defining Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Defining a Processing Rule Based on a Saved Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Setting Up a Default Processing Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Ordering the Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Testing the Order of Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
About Querying and Viewing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Basic Search Criteria for Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Detail View of Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Finding and Viewing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Managing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Updating Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Disabling Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Enabling Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Deleting Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

Part IV. Setting Up Document Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401

Chapter 17. Defining and Managing Queues in Trading Networks . . . . . . . . . . . . . . . . . . . 403

What is a Queue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
About Scheduled Delivery Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Types of Scheduled Delivery Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Private Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

webMethods Trading Networks Administrator’s Guide Version 7.1 11

 Contents

Delivery Schedule for Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

Using the Run Once Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Using the Fixed Interval Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Using a Custom Interval Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Scheduled Delivery Queue States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Defining Private Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Defining Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Searching for Public Queues Using My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Performing a Keyword Search for Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Deleting Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Changing the State of a Private Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
Changing the State of a Public Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
About Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Defining Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Additional Queue for Polling Setup for webMethods for Partners . . . . . . . . . . . . . . . . . . . . . . . . 418
Viewing Documents that Are Queued for Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

Chapter 18. Creating Delivery Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

What is a Delivery Service? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
What is an Immediate Delivery Service? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
What is a Scheduled Delivery Service? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Creating an Immediate Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Retrieving the Content of a Document for Immediate Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Creating a Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Inputs and Outputs for a Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Inputs for Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Outputs for Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Retrieving the Content of a Document for Scheduled Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Required Logic to Include in the Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Typical Logic to Include in the Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Handling Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
The wm.tn.transport:batchFtp Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
Adding and Registering New Delivery Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

Part V. Appendices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

Appendix A. Queries in Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

Running Queries in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
Enabling the Query Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Creating and Saving a Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

webMethods Trading Networks Administrator’s Guide Version 7.1 12

 Contents

Selecting and Running a Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

Navigating Through the Results Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
Updating the Search Criteria for a Saved Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
Saving a New Query Based on an Existing Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
Reverting to a Saved Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Deleting Saved Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

Appendix B. Archiving and Deleting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449

About Archiving and Deleting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
Archiving Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
Deleting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
Setting Up Basic Archival and Deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
Setting How Many Days to Retain Documents before Archival and Deletion . . . . . . . . . . . . . . . 451
Scheduling When To Archive and Delete Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Setting Up Configurable Archival and Deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Scheduling When To Archive and Delete Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454

Appendix C. Exporting and Importing Database Information . . . . . . . . . . . . . . . . . . . . . . 457

About Exporting and Importing Database Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Trading Networks Objects that You Can Export and Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
How Trading Networks Detects Items in Target System Before Importing Them . . . . . . . . . . . . . . . . 459
Dependencies For Trading Networks Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Migrating Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Partner Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Partner Data Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Migrating Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
Field Definitions Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
Migrating TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
Document Type Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Migrating Custom Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Migrating Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Processing Rules Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Migrating Trading Partner Agreements (TPAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Migrating Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Migrating Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Public Queues Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Migrating Data Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
How to Migrate Data Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Data Permission Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
Exporting Database Information from the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
Importing Database Information from the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

webMethods Trading Networks Administrator’s Guide Version 7.1 13

 Contents

Importing Items that Match With Those in the Target System . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Using the Overwrite Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Suppressing the Overwrite Dialog Box and Forcing the Overwrite of Items . . . . . . . . . . . . 477
Procedure for Importing Database Information from the Console . . . . . . . . . . . . . . . . . . . . . . . . 477
Using the tnexport and tnimport Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
tnexport Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
tnimport Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481

Appendix D. Trading Networks Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . 483

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Updating Properties on the Server Settings Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Alphabetical Listing of the Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Cluster Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
Database Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Database Query Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Debugging Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
Document Archiving Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
Document Delivery Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
Document Validation Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
Flat File Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
Large Document Handling Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Localization Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Performance Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
Profile Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
Task Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Miscellaneous Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512

Appendix E. XQL Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

XQL Reference Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Sample XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Example XQL Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
Extracting Custom Attributes From XML Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
Extracting STRINGLIST or STRING ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
Extracting NUMBERLIST or NUMBER ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
Extracting DATETIMELIST or DATETIME ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526

webMethods Trading Networks Administrator’s Guide Version 7.1 14

 Contents

Appendix F. Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

Overview of Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
What You Need to Do to Use Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
Features Not Available for Large Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Defining TN Document Type XQL Queries for Large Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Creating Services that Recognize Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Determining Where the Document Content is Stored . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
Retrieving Document Content from Hard Disk Drive Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Retrieving the Content for Document Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Sending Large XML Documents for Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Viewing Large Documents that Trading Networks Has Processed . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

Part VI. Deprecated Console Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537

Appendix G. Managing Profile Fields Using the Console . . . . . . . . . . . . . . . . . . . . . . . . . . 539

What are Profile Fields? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
Required Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
Viewing Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
Updating Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
Adding Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Viewing Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
Updating Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
Disabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
Enabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554

Appendix H. Managing Your Profile Using the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . 557

Creating Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Viewing Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Updating Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Updating Your Corporation Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Managing Addresses for Your Corporation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Managing Your External IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
Managing Your Profile Group Memberships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
Managing the Contacts in Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
Managing Delivery Methods in Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
Managing Your Profiles Extended Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
Managing Security Information in Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
Enabling Your Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
Disabling Your Profile—Changing the Status to Inactive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569

webMethods Trading Networks Administrator’s Guide Version 7.1 15

 Contents

Appendix I. Managing Partner Profiles Using the Console . . . . . . . . . . . . . . . . . . . . . . . . 571

Adding Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Informing the Partner of the User Name and Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Retrieving the Partner’s User Name and Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Supplying the User Account Information to Your Partner . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Searching for Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Basic Search Criteria for Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Custom Search Criteria for Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Detail View of Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Finding and Viewing Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
Updating Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
Updating the Corporation Information in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
Managing Addresses for the Corporation in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
Managing External IDs in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Managing the Partner Profile Group Memberships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Managing Contacts in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Managing Delivery Methods in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
Managing Reliable Delivery and Polling Settings in a Partner Profile . . . . . . . . . . . . . . . . . . . . . 590
Updating Extended Fields in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
Managing Security Information in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
Deleting a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Disabling a Partner’s Profile—Changing the Status to Inactive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Enabling a Partner’s Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596

Appendix J. Managing Profile Groups Using the Console . . . . . . . . . . . . . . . . . . . . . . . . 597

What are Profile Groups? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
Defining Profile a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
Viewing the List of Profile Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
Updating a Profile Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
Associating Profiles with Profile Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Deleting a Profile Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599

Appendix K. Managing Queues Using the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601

About Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
About Scheduled Delivery Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Types of Scheduled Delivery Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Private Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603

webMethods Trading Networks Administrator’s Guide Version 7.1 16

 Contents

Delivery Schedule for Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603

Using the Run Once Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Using the Fixed Interval Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Using a Complex Interval Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Scheduled Delivery Queue States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Defining Private Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Defining Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Deleting Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Changing the State of a Private Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Changing the State of a Public Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
About Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Defining Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Additional Queue for Polling Setup for webMethods for Partners . . . . . . . . . . . . . . . . . . . . . . . . 615
Viewing Documents that Are Queued for Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616

webMethods Trading Networks Administrator’s Guide Version 7.1 17

 Contents

webMethods Trading Networks Administrator’s Guide Version 7.1 18

 About This Guide

About This Guide

This manual describes how to configure Trading Networks and how to plan for your 
trading network. It provides procedures for setting up Trading Networks to build your 
trading network and how to manage an existing 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. It also describes how to define how you 
want Trading Networks to process business documents that are sent to your trading 
network. 

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

Document Conventions

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

webMethods Trading Networks Administrator’s Guide Version 7.1 19

 About This Guide

Additional Information
The webMethods Advantage Web site at http://advantage.webmethods.com provides you 
with important sources of information about webMethods products:
Troubleshooting Information. The webMethods Knowledge Base provides 
troubleshooting information for many webMethods products. 
Documentation Feedback. To provide feedback on webMethods documentation, go to 
the Documentation Feedback Form on the webMethods Bookshelf.
Additional Documentation. Starting with 7.0, you have the option of downloading the 
documentation during product installation to a single directory called 
“_documentation,” located by default under webMethods installation directory. In 
addition, you can find documentation for all webMethods products on the 
webMethods Bookshelf.

webMethods Trading Networks Administrator’s Guide Version 7.1 20

 Part I. Getting Started

Chapter 1, “Integration Server and Trading Networks”

Chapter 2, “Trading Networks User Interfaces”

Chapter 3, “Configuring webMethods Trading Networks”

Chapter 4, “Configuring My webMethods to Work with Trading Networks”

Chapter 5, “Setting up Analysis of Trading Networks Transaction Data”

Chapter 6, “Planning Your Network”

webMethods Trading Networks Administrator’s Guide Version 7.1 21

 I. Getting Started

webMethods Trading Networks Administrator’s Guide Version 7.1 22

Chapter 1. Integration Server and Trading Networks

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Starting the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Shutting Down the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Configuring Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

webMethods Trading Networks Administrator’s Guide Version 7.1 23

 1. Integration Server and Trading Networks

Overview
To use webMethods Trading Networks (Trading Networks), you must start the 
Integration Server. Because Trading Networks is seamlessly integrated into the 
webMethods platform, all configuration, administration, and management tasks that you 
can perform for the webMethods Integration Server also apply to the Trading Networks.

For more information about the architecture and components of webMethods Trading 

Networks, see Chapter 1, ʺOverview of webMethods Trading Networksʺ in the 
webMethods Trading Networks Concepts Guide.

This chapter describes basic tasks that you will need to perform when using the server, 
specifically, how to start and shut down the server.

Starting the Integration Server

The Integration Server must be running for:
You to set up and manage Trading Networks and for your partners to submit 
documents to the trading network. 
You to use the Trading Networks functions in My webMethods.

You to use the Console or Trading Networks Web Manager.

Note:  For Trading Networks to function properly, the WmPublic package must be 
enabled. For more information on the WmPublic package and how to assure a package is 
enabled, see the webMethods Integration Server Administrator’s Guide.

To start the Integration Server on Microsoft Windows

On the Start menu, select Programs > webMethods > Servers > webMethods Integration Server.

Note: When you installed the Trading Networks, you installed additional packages into 
the webMethods Integration Server. Installing the Trading Networks added functionality 
to the webMethods Integration Server.

webMethods Trading Networks Administrator’s Guide Version 7.1 24

 1. Integration Server and Trading Networks

To start the Integration Server on UNIX

1 Locate the server.sh script file that you modified for your environment when you 
installed the server. 
2 Execute this script.

Important! Run this script when logged in as a non‐root user. Running the script as root 
might reduce the security of your system.

Starting the Integration Server from the Command Line

There are times when it is useful to start the Integration Server from the command line. 
Starting the Integration Server this way allows you to override certain configuration 
settings. It also lets you start the Integration Server in “debug” mode, so you can record or 
display the activity occurring in the Integration Server. For instructions on how to start 
the Integration Server from the command line and a description of the parameters you can 
specify, see the webMethods Integration Server Administrator’s Guide.

Shutting Down the Integration Server

Shut down the server to stop the Integration Server and all active sessions. When you shut 
down the Integration Server, the Trading Networks automatically closes its session on the 
server. When you start the server again, you can restore the console’s session on the server. 

To shut down the server

1 Open the Server Administrator if it is not already open. 
To open the Server Administrator, start your browser and point it to the host and port 
where the Integration Server is running.
Example
If the server were running on port 4040 on a machine called QUICKSILVER, type:
http://QUICKSILVER:4040

2 In the upper right corner of any Server Administrator screen, click the Shutdown and
Restart link.

webMethods Trading Networks Administrator’s Guide Version 7.1 25

 1. Integration Server and Trading Networks

3 Select whether you want the server to wait before shutting down or to shutdown 
immediately.
Delay number minutes or until all client sessions are complete. Specify the number of 
minutes you want the Integration Server to wait before shutting down. 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).
Immediate. The server and all active sessions terminate immediately.
For instructions on how to view the active sessions, see the webMethods Integration 
Server Administrator’s Guide.
4 Click Shutdown.

Configuring Trading Networks

You can configure the Trading Networks to suit your site. For example, you can specify 
the database you want to use and the parameters that control how Trading Networks 
delivers documents. For complete information, see Chapter 3, “Configuring webMethods 
Trading Networks”.

webMethods Trading Networks Administrator’s Guide Version 7.1 26

Chapter 2. Trading Networks User Interfaces

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Trading Networks Web Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

webMethods Trading Networks Administrator’s Guide Version 7.1 27

 2. Trading Networks User Interfaces

Overview
webMethods Trading Networks (Trading Networks) has the user interfaces described in 
the table below:

User Interface Description

My webMethods My webMethods is a web‐based, administration and monitoring 
user interface for managing your webMethods components. For 
Trading Networks functions, you can use it to define profiles, 
profile groups, and public queues; perform some configuration 
tasks; and monitor Trading Networks transactions, service 
execution tasks, delivery tasks, and activity logs. The administrative 
tasks are described in this guide. For information about monitoring 
transactions, tasks, and the activity log, see the webMethods Trading 
Networks User’s Guide.
Trading Networks The Trading Networks Console (Console) is a standalone Java GUI. 
Console You can also use it to perform the same functions that are available 
through My webMethods. Additionally, the Console can be used to 
define trading partner agreements (TPAs), custom attributes, TN 
document types, and processing rules.
This user interface will be deprecated in a future release.
Trading Networks Trading Networks Web Manager (Web Manager) is also a Web 
Web Manager interface. However, unlike My webMethods, Web Manager is 
specific to Trading Networks; other webMethods components do 
not use this user interface.
This user interface provides a limited set of the functionality that is 
available through My webMethods and the Console. For more 
information about Web Manager, see the 6.5 version of the 
webMethods Trading Networks Web Manager Administrator’s Guide, 
which is available on webMethods Advantage.
This user interface is deprecated and will not be available in a future 
release.

Because Trading Networks server runs within the Integration Server, to use Trading 
Networks the Integration Server must be started. Also all tasks you perform to configure, 
administer, and manage the Integration Server also affect Trading Networks.
In addition, the Integration Server must be running to use any of the user interfaces to 
perform Trading Networks tasks. 

webMethods Trading Networks Administrator’s Guide Version 7.1 28

 2. Trading Networks User Interfaces

My webMethods
My webMethods is a web‐based, administration and monitoring user interface for 
managing your webMethods components. The following table lists the My webMethods 
pages that you use to perform Trading Networks actions.

Important! Functionality available via the My webMethods user interface is based on the 
permissions assigned to your My webMethods roles. If you do not have all permissions, 
My webMethods might not display pages, buttons, and/or other user interface controls 
required to perform the actions describe in this guide. If a procedure instructs you to use 
an item that is not available, see your system administrator about acquiring the proper 
permissions to allow you to perform the action.

Navigation Selections Use to...

Administration > Set data permissions for a My webMethods role that indicate 
System-Wide > B2B the actions users in that role can take against Trading 
Permissions > Data Networks data. For more information, see “Defining Role‐
Permissions Based Access” on page 70.
Administration > Set the general functional permissions for a My webMethods 
System-Wide > B2B role that indicate the Trading Networks actions that users in 
Permissions > General that role can perform. Specifically, you can identify the My 
Functional Permissions webMethods roles that can:
Manage public queues

Manage profile groups

Create a partner profile

Delete a partner profile

Manage extended profile fields

Add external ID types

Show the SQL query for a search

webMethods Trading Networks Administrator’s Guide Version 7.1 29

 2. Trading Networks User Interfaces

Navigation Selections Use to...

Manage BAM configuration for Trading Networks

View user preferences

Edit user preferences

View Trading Networks configuration properties

Edit Trading Networks configuration properties

Query expiring partner certificates
For more information, see “Defining Role‐Based Access” on 
page 70.
Administration > Manage profiles and profile fields. You can:
Integration > B2B > Partner
Profiles Add, edit, and/or delete partner profiles. For more 
information, see Chapter 9, “Defining and Managing 
Your Profile (Your Enterprise)” and Chapter 10, 
“Defining and Managing Partner Profiles”.
Add, edit, and/or delete extended profile fields. For 
more information, see Chapter 8, “Defining and 
Managing Profile Fields”.
Administration > Add, edit, and/or delete partner profile groups. For more 
Integration > B2B > Profile information, see Chapter 11, “Defining and Managing 
Groups Profile Groups”.
Administration > Query for partner certificates that are expired or expiring 
Integration > B2B > Partner soon. For more information, see “Searching for Certificates 
Certificates that Are Expired or Expiring Soon” on page 195.
Administration > Add, edit, and/or delete public queues. For more 
Integration > B2B > Public information, see Chapter 17, “Defining and Managing 
Queues Queues in Trading Networks”.
Administration > Configure the TN document types for BAM (Business 
Integration > B2B > Activity Monitoring) and globally enable all the TN 
Business Monitoring document types for monitoring.
For more information, see Chapter 5, “Setting up Analysis of 
Trading Networks Transaction Data”.
Administration > Set administrative settings. For information about Trading 
Integration > B2B Settings Networks administrative preferences, see “Configuring My 
> Administrative webMethods to Work with Trading Networks” on page 61. 
Preferences

webMethods Trading Networks Administrator’s Guide Version 7.1 30

 2. Trading Networks User Interfaces

Navigation Selections Use to...

Administration > Set Trading Networks Server properties. For instructions for 
Integration > B2B Settings setting Trading Networks properties from My webMethods, 
> Server Settings see “Trading Networks Configuration Properties” on 
page 42. For a description of the properties, see Appendix D, 
“Trading Networks Configuration Properties”.
Monitoring > Integration > Track and manage documents that Trading Networks has 
Transactions processed by querying the Trading Networks database. For 
more information, see webMethods Trading Networks User’s 
Guide.
Monitoring > Integration > View the status and detail of delivery and service execution 
Tasks tasks. You can also stop, restart, reassign, or delete tasks. For 
more information, see webMethods Trading Networks User’s 
Guide.
Monitoring > Integration > Access the activity log that records the activity occurring 
Activity Log 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, see webMethods Trading Networks User’s 
Guide.
Monitoring > Integration > Set user preferences for using My webMethods to perform 
User Preferences Trading Networks functions. For information about user 
preferences for Trading Networks pages in My 
webMethods, see the webMethods Trading Networks User’s 
Guide.
Monitoring > Business > Monitor and analyze the Trading Networks transaction data 
Business Overview using webMethods Optimize for B2B. At run time, view the 
data in a graphical or a tabular format. For more information 
about monitoring the transaction data, see the webMethods 
Trading Networks User’s Guide.

For more information about My webMethods, see the Getting Started with My webMethods 

guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 31

 2. Trading Networks User Interfaces

Trading Networks Console

Use the Trading Networks Console to perform functions such as managing your trading 
partners, configuring how documents are exchanged through your network, and 
performing real‐time monitoring and analysis.
This section provides procedures for how to start and exit from the Console. In addition, it 
contains information to help you become familiar with how to use the Console.

Starting the Trading Networks Console

Use the following procedure to start the Trading Networks Console on your workstation.

Important! Make sure that the Integration Server with which you want to use the Console is 
running. You cannot work with the Console if the server is not running.

To start the Trading Networks Console

1 On the Start menu, select Programs > webMethods > Trading Networks Console.

2 In the Open Session dialog box, complete the following:

In this field... Specify...

Server The host name and port of the Integration Server in 
ServerName:PortNum format.
Example  localhost:5555

Note: Servers to which you have successfully logged on in the 
past are listed in the Server list. You can select a server from 
this list or type a different server name and port number.

webMethods Trading Networks Administrator’s Guide Version 7.1 32

 2. Trading Networks User Interfaces

In this field... Specify...

User Name The name of a valid user account on this server. (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.)

Note: The user name must be a member of a group belonging 
to the Developers ACL because Trading Networks launches 
the Developer for some tasks, such as: specifying a service for 
a processing rule or a delivery queue; specifying a custom 
duplicate checking service or custom attribute transformation 
service for a TN document type; browsing for an IS document 
type for a TPA; and setting inputs for a TPA.

For the user name, specify the exact combination of upper‐ 
and lower‐case characters; IS user names are case‐sensitive.
Password The password for the user account in User Name. Use the exact 
combination of upper‐ and lower‐case characters; IS 
passwords are case‐sensitive.
Use secure Whether the connection will be made through HTTP or 
connection HTTPS. To open a session on the selected server using the 
Secure Socket Layer (SSL), select this check box. 
Use proxy server Whether the Trading Networks opens a session on the server 
through the default proxy server. To open a session on the 
selected server using your proxy server, select this check box. 
For information about defining default proxy servers, see 
webMethods Trading Networks User’s Guide. 

3 Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 33

 2. Trading Networks User Interfaces

Opening and Closing Sessions on Servers

When you start Trading Networks, you are prompted to log on to the Integration Server 
that you want to work with. The Trading Networks Console maintains an open session on 
that server until you exit the Console or switch to another server.
You can open a session on only one webMethods Integration Server at a time. Before you 
switch to another server, you must first close the session on the current server.

Important! While the Trading Networks Console has an open session on a Integration 
Server, you are using a licensed seat for that server. When you are not actively using 
Trading Networks, you might want to close the session on the server or close the Console 
to free a seat on the server for others to use. 

To close a session on the current server

1 Save any work that you want to keep.
2 Select File > Close Session.

To open a session on a different server

1 Select File > Open Session.

Note:  If you already have a session opened on a Integration Server, Trading Networks 
automatically closes the session you have on that server. If you have unsaved work, 
you are prompted to save it.
2 Complete the Opening Session to Integration Server dialog box. See step 2 on page 32 
for instructions.
3 Click OK.

Familiarizing Yourself with the Trading Networks Console

The Trading Networks Console screen contains several different parts; that is, the menu 
bar, the selector panel with selector panel buttons, the screen name, the toolbar, and the 
display area. For a description of these items, see the webMethods Trading Networks User’s 
Guide.

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.

webMethods Trading Networks Administrator’s Guide Version 7.1 34

 2. Trading Networks User Interfaces

The following table lists the selector panel buttons, along with a description of each 
button. You change the screen view of the Trading Networks Console by selecting one of 
these selector panel buttons.
Because you can also access the screens using the View menu, you might want to choose to 
remove the selector panels from the display. To turn the buttons on/off, select View >
Buttons. 

Selecting Trading Networks Objects

This Selector Panel

icon... Performs this function...
Add, edit, and view the profile information for your corporation, 
the host of the Trading Networks system. Enterprise is also referred 
Enterprise to as the local partner, meaning the partner hosting the network. 
[Deprecated] For more information about your company’s profile, see Chapter 9, 
“Defining and Managing Your Profile (Your Enterprise)”.
In addition, you can access the Profile Fields screen from the 
Enterprise profile screen.
Managing your Enterprise profile and profile fields is available via 
My webMethods and is now deprecated in the Console.
Trading Partner: Displays information for a trading partner in your 
trading network. To select a different partner for which you want 
Trading Partners to view information, perform a query on the Profiles list. Note that 
[Deprecated] this list also includes your Enterprise partner as well. For more 
information about your partner’s profile, see Chapter 10, 
“Defining and Managing Partner Profiles”. 
In addition, you can access the Profile Fields screen from the 
Trading Partners profile screen.
Managing partner profiles and profile fields is available via My 
webMethods and is now deprecated in the Console.
Define and manage TN document types, specify attributes for 
Trading Networks to extract from the document, and specify 
Document Types options for pre‐processing. In addition, you can access the 
Document Attribute screen from the Document Types screen. 
For more information about TN document types, see Chapter 14, 
“Defining and Managing TN XML Document Types” and 
Chapter 15, “Defining and Managing TN Flat File Document 
Types”.

webMethods Trading Networks Administrator’s Guide Version 7.1 35

 2. Trading Networks User Interfaces

This Selector Panel

icon... Performs this function...
Define and manage processing rules, which Trading Networks 
uses to determine how to process the documents sent to your 
Processing Rules Trading Networks system. 
For more information about processing rules, see Chapter 16, 
“Defining and Managing Processing Rules”.
Define and manage Trading Partner Agreement (TPA) parameters 
that will specify how to govern transactions between two trading 
Agreements partners. You can also view and query TPAs.
For more information about TPAs, see Chapter 12, “Defining and 
Managing Trading Partner Agreements (TPAs)”.
Track and manage documents in your system by querying the 
Trading Networks database for the documents in which you are 
Transaction interested.
Analysis For more information about transaction analysis, see the 
[Deprecated] webMethods Trading Networks User’s Guide.
Transaction analysis is available via My webMethods and is now 
deprecated in the Console.
View the status and detail of delivery and service execution tasks. 
You can also restart or delete tasks.
Tasks [Deprecated]
For more information about tasks, see the webMethods Trading 
Networks User’s Guide.
Managing tasks is available via My webMethods and is now 
deprecated in the Console.
Access the activity log that records the activity occurring within 
the Trading Networks system. This includes activity while 
Activity Log managing your partners; while documents are being received, 
[Deprecated] processed, and delivered; as well as administrative actions 
performed for your Trading Networks system.
For more information about the activity log, see the webMethods 
Trading Networks User’s Guide.
Managing the activity log is available via My webMethods and is 
now deprecated in the Console.

webMethods Trading Networks Administrator’s Guide Version 7.1 36

 2. Trading Networks User Interfaces

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 Click   Select. Trading Networks displays the Partner Selection Dialog.

2 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.
3 Click OK to select the partner profile(s).

4 If you want to search for a specific profile, click   Show Query on the toolbar. Trading 

Networks expands the Partner Selection dialog to show the Basic Criteria, Custom
Criteria, and Detail View tabs.
For more information about searching for partner profiles, see “Searching for Partner 
Profiles” on page 576. 

5 To run the query, click the   Run Query toolbar button. 

6 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 37

 2. Trading Networks User Interfaces

b 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  .

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.

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 TN 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).
2 To view disabled TN document types, select Types > Show All. Trading Networks places 
a check (D) next to the Show All menu item to indicate that Trading Networks is 
currently displaying disabled TN document types.

webMethods Trading Networks Administrator’s Guide Version 7.1 38

 2. Trading Networks User Interfaces

3 Select the row containing information about the TN XML document type or TN flat 
file document type that you want. 
Trading Networks displays the Document Type Details dialog for the selected TN 
document type.
4 Click OK.
For more information about using the Console to work with TN document types, see 
Chapter 14, “Defining and Managing TN XML Document Types” and Chapter 15, 
“Defining and Managing 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

Select File > Exit. 

Trading Networks Web Manager

Trading Networks Web Manager is deprecated.Web Manager provides a limited set of the 
functionality that is available through My webMethods and the Console. For example, 
Web Manager users can view profiles, search for documents, and check the status of 
documents. For more information about Web Manager, see the 6.5 version of the 
webMethods Trading Networks Web Manager Administrator’s Guide, which is available on 
webMethods Advantage.

webMethods Trading Networks Administrator’s Guide Version 7.1 39

 2. Trading Networks User Interfaces

webMethods Trading Networks Administrator’s Guide Version 7.1 40

Chapter 3. Configuring webMethods Trading Networks

Trading Networks Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Configuring the Trading Networks Database Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Configuring Trading Networks for a Clustered Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Configuring Profile Settings for the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . 50

Configuring E-mail Settings for Document Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Configuring Tasks Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Configuring Trading Networks for Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Other Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

webMethods Trading Networks Administrator’s Guide Version 7.1 41

 3. Configuring webMethods Trading Networks

Trading Networks Configuration Properties

You perform most Trading Networks configuration tasks by updating the Trading 
Networks properties, which appear in:
webMethods7\IntegrationServer\packages\WmTN\config\properties.cnf
You can update the configuration properties using the Administration > Integration > B2B 
Settings > Server Settings page in My webMethods. The procedures in this chapter 
describe how to access the Administration > Integration > B2B Settings > Server Settings 
page.

Important! When you use the Server Settings page and save your updated properties, 
Trading Networks updates all properties with the values from the Server Settings page, 
including those that you might not have altered.
This is important if you are using Trading Networks in a clustered environment and have 
the tn.cluster.notifyPropertyChange property set to true. Using the Server Settings page to 
update properties when you are in a clustered environment will cause Trading Networks 
to synchronize all properties each time you use the Server Settings page. If you want the 
servers in the cluster to maintain different values for some of the properties, set the 
tn.cluster.notifyPropertyChange property to false, and maintain the properties for each server 
individually.

To the Trading Networks configuration properties

In My webMethods: Administration > Integration > B2B Settings > Server Settings.

To see a list of the Trading Networks configuration properties and a description of each, 
see Appendix D, “Trading Networks Configuration Properties”.

webMethods Trading Networks Administrator’s Guide Version 7.1 42

 3. Configuring webMethods Trading Networks

Configuring the Trading Networks Database Settings

When you installed Trading Networks, you specified the following database connection 
parameters:
The JDBC driver—The name of the JDBC driver for Trading Networks database.

The location of the database—A URL to specify the location of the Trading Networks 

database.
A user name and password—If the Trading Networks database requires a user name and 
password to connect to it, you identified the user name and password that Trading 
Networks must supply.
Database properties—If you want Trading Networks to supply any additional database 
properties when connecting to the Trading Networks database, you identified the 
database properties.
If you want to change these parameters (for example, to adjust the minimum and 
maximum connections), see the webMethods Installation Guide for general instructions.

Important! If you change the database after using Trading Networks, Trading Networks 
does not copy the data in the current database to the new database. However, you can use 
the Trading Networks export and import facility to export data from your existing 
database. Then, after you change the database, you can import the exported information 
into the new database. For more information, see Appendix C, “Exporting and Importing 
Database Information”.

Trading Networks in a High Availability Environment

To meet your high availability requirements, you might need to use multiple instances of 
Trading Networks. When you use multiple instances of Trading Networks, you must 
decide whether to share a single Trading Networks database among the Trading 
Networks instances. The following lists possible scenarios:
If you cluster your Integration Servers, you should share a single Trading Networks 
database among the Trading Networks instances.
If you do not cluster your Integration Servers (e.g., when one of your adapters does 
not work in a clustered environment), you can still share a single Trading Networks 
database among the Trading Networks instances.
You can also use multiple Trading Networks instances that each use their own 
database.

webMethods Trading Networks Administrator’s Guide Version 7.1 43

 3. Configuring webMethods Trading Networks

Shared Trading Networks Database in a Clustered Environment

For this option, Trading Networks is running on two or more Integration Servers that are 
in a clustered environment, and you configure all Trading Networks systems to use the 
same database. 

Shared Database in a Clustered Environment

Setting up the  Set the tn.cluster.sync.remoteAliases server property for each instance 
servers of Trading Networks. For more information about this property, 
see “Cluster Properties” on page 487.
Be sure that all Integration Server system properties are identical 
for all servers in the clusters. The Integration Server system 
properties are in the 
webMethods7\IntegrationServer\config\server.cnf file

Be sure that the application code you need Trading Networks to 
execute (e.g., delivery services, services invoked from processing 
rules, etc.) 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.
See the webMethods Integration Server Clustering Guide for more 
information about running servers in a cluster.
Behavior of  Changes you make to Trading Networks objects (e.g., profiles, 
Trading  attributes, TN document types, processing rules, etc.), are 
Networks automatically shared by all servers that share the database.
Changes you make to Trading Networks server properties using 
the Administration > Integration > B2B Settings > Server Settings 
page or by invoking the wm.tn.admin:setProperties service are 
automatically replicated to all servers in the cluster. For more 
information about the wm.tn.admin:setProperties service, see the 
webMethods Trading Networks Built‐in Services Reference.
Note: If you change the server properties by directly editing the 
webMethods7\IntegrationServer\packages\WmTN\config\pr
operties.cnf file, you must manually make your changes to the 
properties.cnf file for each server.

All configuration data and run‐time data (e.g., documents 
received from partners, activity log, etc.) is shared among all 
instances of Trading Networks in the cluster.

webMethods Trading Networks Administrator’s Guide Version 7.1 44

 3. Configuring webMethods Trading Networks

Shared Trading Networks Database in a Non-Clustered Environment

For this option, you configure two or more instances of Trading Networks to use the same 
database. The instances of Trading Networks are not running on servers in a clustered 
environment.

Shared Database in a Non-Clustered Environment

Setting up the  Set the tn.cluster.sync.remoteAliases server property for each instance 
servers of Trading Networks that will be sharing the database. This is 
required even though the servers are not clustered. For more 
information about this property, see “Cluster Properties” on 
page 487.
Define remote aliases for each server sharing the database. You 
set remote aliases using the Server Administrator. This is 
required even though the servers are not clustered.
Be sure that all Integration Server system properties are identical 
for all servers. The Integration Server system properties are in the 
webMethods7\IntegrationServer\config\server.cnf file.

Be sure that the application code you need Trading Networks to 
execute (e.g., delivery services, services invoked from processing 
rules, etc.) is available on all servers.
If you want each instance of Trading Networks to have the same 
Web Manager configuration, be sure to configure Web Manager 
the same for each instance of Trading Networks.
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.g., long‐running conversations).
To use My webMethods or the Console query paging feature 
(e.g., Next Page, Previous Page, First Page, Last Page), when you 
start My webMethods or the Console, be sure to connect it to one 
of the Trading Networks instances. That is, specify the host name 
and port name of one of the Trading Networks instances that 
share the database, and do not specify the virtual IP address 
defined by the load balancer.

webMethods Trading Networks Administrator’s Guide Version 7.1 45

 3. Configuring webMethods Trading Networks

Shared Database in a Non-Clustered Environment

Behavior of  Changes you make to Trading Networks objects (e.g., profiles, 
Trading  attributes, TN document types, processing rules, etc.), are 
Networks automatically shared by all servers that share the database.
Changes you make to Trading Networks server properties using 
the Administration > Integration > B2B Settings > Server Settings 
page or by invoking the wm.tn.admin:setProperties service are 
automatically replicated to all servers that share the database. For 
more information about the wm.tn.admin:setProperties service, see the 
webMethods Trading Networks Built‐in Services Reference.
Note: If you change the server properties by directly editing the 
webMethods7\IntegrationServer\packages\WmTN\config\pr
operties.cnf file, you must manually make your changes to the 
properties.cnf file for each server.

All run‐time data (e.g., documents received from partners, 
activity log, etc.) is shared among all instances of Trading 
Networks that share the database.

Separate Trading Networks Database for Each Instance of Trading Networks

For this option, you have multiple instance of Trading Networks running, but you 
configure each to use its own database. Each instance of Trading Networks is unaware of 
other the other instances of Trading Networks.

Separate Database for Each Instance of Trading Networks

Setting up the  If you want each instance of Trading Networks to have identical 
servers versions of Trading Networks objects (e.g., profiles, attributes, 
TN document types, processing rules, etc.), you must use the 
Trading Networks’ import/export feature to copy the data from 
one server to the other. For more information, see Appendix C, 
“Exporting and Importing Database Information”.

webMethods Trading Networks Administrator’s Guide Version 7.1 46

 3. Configuring webMethods Trading Networks

Separate Database for Each Instance of Trading Networks

If you want all servers to have identical configurations, you must 
ensure that:
All Integration Server system properties are identical for all 
servers. The Integration Server system properties are in the 
webMethods7\IntegrationServer\config\server.cnf file.

All Trading Networks server properties are identical for all 
servers. The Trading Networks server properties are in the 
webMethods7\IntegrationServer\packages\WmTN\config
\properties.cnf file. You can view and set these properties 
from the Administration > Integration > B2B Settings > Server 
Settings page of the My webMethods.
If you want all instances of Trading Networks to be able to handle 
all incoming documents, be sure that the application code you 
need Trading Networks to execute (e.g., delivery services, 
services invoked from processing rules, etc.) is available on all 
servers.
You cannot cluster the Integration Servers because the Trading 
Networks database is not shared.
Behavior of  Changes you make to Trading Networks objects (e.g., profiles, 
Trading  attributes, TN document types, processing rules, etc.), are not 
Networks shared by all servers. You need to make the changes to each 
instance of Trading Networks if you want to keep them in sync.
Changes you make to Trading Networks server properties are not 
replicated to all servers. You need to make the changes to each 
instance of Trading Networks if you want to keep them in sync.
An instance of Trading Networks does not share its run‐time data 
(e.g., documents received from partners, activity log, etc.) 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. For 
example, 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 47

 3. Configuring webMethods Trading Networks

Configuring Trading Networks for a Clustered Environment

If Trading Networks is running on an Integration Server in a cluster of servers, you can 
configure Trading Networks so that the data cached in memory, user accounts, and 
Trading Networks properties are synchronized on all servers in the cluster. These 
synchronizations are controlled by the tn.cluster.notifyCacheChange, tn.cluster.notifyProfileAddUser, 
and tn.cluster.notifyPropertyChange properties in the properties.cnf file. For information on 
these properties, see “Cluster Properties” on page 487.

To configure Trading Networks for a clustered environment

T

1 On each Integration Server in the cluster, create a remote server alias for the other 
servers in the cluster. For example, if you have two servers (Server1 and Server2) in 
the cluster, you would create a remote server alias for Server2 on Server1, and a 
remote server alias for Server1 on Server2. For information on how to create a remote 
server alias, see webMethods Integration Server Administrator’s Guide.

Important! If you have already created a remote server alias so the server is part of an 
Integration Server cluster (without Trading Networks), you need to create an 
additional remote server alias for the server specifically for the Trading Networks 
cluster.

2 To update the Trading Networks properties.cnf file for each Integration Server in the 
cluster, perform the following: 
a In My webMethods: Administration > Integration > B2B Settings > Server Settings.
b Add or update the following properties:

For this property... Specify...

tn.cluster.sync.remoteAliases The remote server aliases you created in step 1.
tn.query.threshold The number of rows of query results that 
Trading Networks stores in the session object.
If you are using Trading Networks in a cluster, 
Trading Networks should not store query 
results in the session object. To prevent Trading 
Networks from storing query results in the 
session object, set this property to “-1”. 
Example: To indicate that you do not want 
Trading Networks to store query results in a 
session object because you are using Trading 
Networks in a cluster, specify the following:
tn.query.threshold=-1

webMethods Trading Networks Administrator’s Guide Version 7.1 48

 3. Configuring webMethods Trading Networks

c Ensure the following properties are set to true:

Set this property to true... To notify all servers in the cluster about...

tn.cluster.notifyCacheChange A change to data cached in memory
tn.cluster.notifyProfileAddUser New user accounts
tn.cluster.notifyPropertyChange A change to Trading Networks properties

Important! When you use the Administration > Integration > B2B Settings > Server 
Settings page and save your updated properties, Trading Networks updates all 
properties with the values from the Server Settings page, including those that you 
might not have altered.
This is important if you are using Trading Networks in a clustered environment 
and have the tn.cluster.notifyPropertyChange property set to true. Using the Server 
Settings page to update properties when you are in a clustered environment will 
cause Trading Networks to synchronize all properties each time you use the 
Server Settings page. If you want the servers in the cluster to maintain different 
values for some of the properties, set the tn.cluster.notifyPropertyChange property to 
false, and maintain the properties for each server individually.

For a description of the properties used in this procedure, see ““Cluster 
Properties” on page 487.
d Click Save.
After completing the above procedure, the data cached in memory, user accounts, and 
Trading Networks properties are automatically synchronized on all Integration Servers in 
the cluster. To turn one of these synchronizations off for a server, modify the respective 
property in the Trading Networks properties.cnf file. For example, if you wanted to 
manually control user account creation, you would disable automatic user account 
creation by turning off the tn.cluster.notifyProfileAddUser property.

webMethods Trading Networks Administrator’s Guide Version 7.1 49

 3. Configuring webMethods Trading Networks

Configuring Profile Settings for the Trading Networks Console

When you use the Console to add a profile for a partner, Trading Networks can create an 
Integration Server user account for the partner. Trading Networks uses the value of one of 
the external IDs (e.g., D‐U‐N‐S number) that you specify in the profile for the user name. 
The external ID that Trading Networks uses is the value of the default external ID type. 
You configure the default external ID type that Trading Networks uses for the IS user 
account.
When you create a profile from Console, if you do not want Trading Networks to define 
an Integration Server user account for a profile, you can configure Trading Networks so 
that it never creates an Integration Server user account.

Note: When you create a profile using My webMethods, Trading Networks does not 
automatically create a user account, and you cannot configure it to do so. However, you 
can always associate one or more My webMethods user accounts with a profile. For more 
information, see “Managing the My webMethods Users Associated with the Partner’s 
Profile” on page 184. For information about a My webMethods user account is used, see 
“Central User Management—How Integration Server Authorizes My webMethods 
Users” on page 62.

To configure profile settings, perform the following procedure:

To configure profile settings that Trading Networks when a user create a profile from the Console

1 In My webMethods: Administration > Integration > B2B Settings > Server Settings.

2 Set whether Trading Networks should create a user account when a profile is added.
To indicate that Trading Networks should not create an IS user account, add or 
update the tn.default.userCreation to false.
To indicate that Trading Networks should create an IS user account:
1 Add or update the tn.default.userCreation to true. 
2 To identify the external ID to use for the IS user account created for a profile 
that is added from the Console, add or update the tn.default.idType property. 
Specify the external ID type (e.g., DUNS) that Trading Networks uses for the 
user name of an IS user account that it creates for the partner.
3 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 50

 3. Configuring webMethods Trading Networks

Configuring E-mail Settings for Document Delivery

You can configure settings Trading Networks uses when delivering documents via an 
e‐mail message, specifically, the “from” e‐mail address and subject line that you want 
Trading Networks to use in the e‐mail messages.

To configure e-mail settings for document delivery

1 In My webMethods: Administration > Integration > B2B Settings > Server Settings.

2 Add or update the following properties to configure how Trading Networks performs 
document delivery: 

For this property... Specify...

tn.mail.from 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” e‐
mail address [email protected], specify the following: 
[email protected]
tn.mail.subject The subject line you want Trading Networks to use 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 subject line 
“Document from IFC”, specify the following:
tn.mail.subject=Document from IFC

3 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 51

 3. Configuring webMethods Trading Networks

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. You can 
configure settings that Trading Networks uses when processing these tasks. For more 
information about these tasks, see “Using Reliable Delivery with Immediate Delivery 
Method” on page 367 and “Service Execution Tasks and Reliable Execution” on page 356.

Note: If you want to be notified when tasks fail, you need to create an Integration Server 
trigger that subscribes to the wm.tn.rec:TaskFailure IS document type. For more information, 
see the Publish‐Subscribe Developer’s Guide.

To configure tasks settings

1 In My webMethods: Administration > Integration > B2B Settings > Server Settings.

2 Add or update the following property to configure settings that affect both delivery 
and service execution tasks:

For this property... Specify...

tn.task.sweepTime The number of seconds the reliable task manager thread 
remains idle before checking for tasks it needs to perform 
(for example, a task to deliver a document or execute a 
service). The task manager thread becomes idle when all 
tasks are completed, failed, or in the wait period between 
attempts.
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. 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 52

 3. Configuring webMethods Trading Networks

The value you specify for tn.task.sweepTime can affect how long Trading Networks waits 
between attempts to retry a task. Typically, the wait between retries value is governed 
by one of the following:

Type of task Wait between retries is governed by…

Delivery The Wait between retries value on the Delivery Method tab of the 

receiving partner’s profile. 
Service execution The tn.task.ttw property value. 

However, Trading Networks could wait as long as the tn.task.sweepTime value. If the 
task manager thread is idle when the wait between retries value expires, the task 
manager thread will not wake up to process the task until the tn.task.sweepTime value 
expires.
3 Add or update the following properties to configure settings that affect only service 
execution tasks. 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.

For this property... Specify...

tn.task.maxRetries The number of times you want Trading Networks to attempt to 
re‐execute a service. Specify a whole number. 
tn.task.ttw 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. (Trading Networks uses the 
tn.task.retryFactor value along with the tn.task.ttw value to calculate 
how long to wait for subsequent retry attempts.) 
tn.task.retryFactor  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. Trading 
Networks calculates the time to wait by multiplying the last 
wait time by the tn.task.retryFactor value. Specify a whole number 
greater than zero for tn.task.retryFactor.
 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 53

 3. Configuring webMethods Trading Networks

For this property... Specify...

tn.task.maxRetries =  3
tn.task.ttw =  10000ms
tn.task.retryFactor =  3

Retry 1 Retry 2 Retry 3

Wait until next attempt 10000 ms 30000 ms 90000 ms

4 Click Save.

Enabling Task Failure Notification

If you want to be notified when a task fails, make sure the tn.task.notifyFailure property is set 
to “true”. When this property is true, Trading Networks publishes an IS document with 
the format defined by the wm.tn.rec:TaskFailure IS document type. 
You can create an Integration Server trigger that subscribes to IS documents of this IS 
document type. For information on creating an Integration Server trigger, see Publish‐
Subscribe Developer’s Guide.

To configure Trading Networks to publish an IS document when a task fails

To

1 In My webMethods: Administration > Integration > B2B Settings > Server Settings.

2 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... Specify...

tn.task.notifyFailure Either true or false. 
true if you want Trading Networks to publish an IS 
document
false if you do not want Trading Networks to publish an 
IS document

3 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 54

 3. Configuring webMethods Trading Networks

Configuring Trading Networks for Large Document Handling

As installed, Trading Networks acts on all documents in the same manner regardless of 
their size. You can configure Trading Networks to handle large documents differently. 
You also configure the document size that Trading Networks should treat as large. For 
more information about the areas in Trading Networks that are affected by large 
document handling, see Appendix F, “Large Document Handling”.

To learn more about large document handling, see the section about large document 

handling in Chapter 5, ʺTrading Networks Document Processingʺ in the webMethods 
Trading Networks Concepts Guide.

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. 

Required Recommended

Hard Disk Space RAM # of CPUs Hard Disk Space RAM # of CPUs

100 MB† 512 MB 1CPU 256 MB† 1 GB 2CPU

†
Note that this is only the space required for normal processing. 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. It does not account for 
the hard disk drive space that is necessary for temporarily saving the large documents 
during processing. To use large document handling, you need to define hard disk drive 
space where Trading Networks can temporarily save documents (rather than store them 
in memory). 
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. For example, if your typical concurrent document load is 10, you would 
need a hard disk drive space that is 10 to 15 times the combined size of the documents 
being processed concurrently.

webMethods Trading Networks Administrator’s Guide Version 7.1 55

 3. Configuring webMethods Trading Networks

Steps for Configuring Large Document Handling

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.

Setting Properties in the Trading Networks Properties File

To configure Trading Networks to use large document handling, perform the following 
procedure. 

To configure Trading Networks for large document handling

T

1 In My webMethods: Administration > Integration > B2B Settings > Server Settings.

2 Add or update the following properties:

For this property... Specify...

tn.BigDocThreshold How many bytes a document must contain for Trading 
Networks to consider the document to be large. Specify one of 
the following:
-n: Specify a negative number to have Trading Networks 
consider no documents as large. Trading Networks processes 
all documents in the traditional manner, reading the document 
content into memory during processing. The default is ‐1.
0: Specify zero to have Trading Networks consider all 
documents as large. Because all documents that Trading 
Networks receives contains more than 0 bytes, Trading 
Networks uses large document handling for all documents.
n: Specify a positive whole number to indicate the number of 
bytes over which Trading Networks considers a document 
large. For example, if you specify the following, Trading 
Networks considers all documents greater than 1,000,000 bytes 
as large:
tn.BigDocThreshold=1000000
tn.xml.xqlThreshold The number of bytes that Trading Networks reads into 
memory to perform the XQL queries in a TN XML document 
type. In your TN XML document types, if you have XQL 
queries that point to nodes beyond the number of bytes that 
Trading Networks reads, the queries will fail. For more 
information, see “Defining TN XML Document Types” on 
page 261.

webMethods Trading Networks Administrator’s Guide Version 7.1 56

 3. Configuring webMethods Trading Networks

For this property... Specify...

Specify a positive whole number. For example, if the XQL 
queries that you specify reference nodes in the first 50,000 
bytes of the document, specify the following:
tn.xml.xqlThreshold=50000

If you do not specify a value for tn.xml.xqlThreshold, Trading 
Networks uses the number of bytes that you specify for 
tn.BigDocThreshold. If you do not specify a value for 
tn.BigDocThreshold, or if the value that you specify is negative, 
Trading Networks defaults to 1,000 bytes. Trading Networks 
needs to read at least 1,000 bytes to perform document 
recognition.

3 Click Save.

Increasing the Size of the Largest Document that Can Be Saved When Using DB2
When defining columns for a DB2 database, DB2 requires that you specify a size limit. 
When defining the Trading Networks database, the DB2 SQL script defines the size of the 
BizDocContent.Content field in the BIZDOCCONTENT table to have a 2M size limit. As a 
result, the largest document that Trading Networks can save to the DB2 database is 2M.
If you are using a DB2 database for the Trading Networks database and want to save 
documents that are larger than 2M, you must update the size limit for the 
BizDocContent.Content field to accommodate the largest document you expect to process.
Similarly, if you use the Trading Networks Archive tables, you must also update the size 
of the ARCHIVE_BizDocContent.Content field.

webMethods Trading Networks Administrator’s Guide Version 7.1 57

 3. Configuring webMethods Trading Networks

Configuring the Integration Server

In addition to setting configuration properties for Trading Networks, you also need to 
configure settings for the webMethods Integration Server. To configure the Integration 
Server, update the following properties in the Integration Server configuration file:
webMethods7\IntegrationServer\config\server.cnf
Before you edit the configuration file, shut down the Integration Server. After you make 
the changes, restart the server.

For this property... Specify...

watt.server.tspace. The absolute directory path of the hard disk drive space where 
location Trading Networks is to temporarily store large documents 
rather than keep them in memory. Each file that the Integration 
Server stores in this directory is given the name 
DocResxxxxx.dat, where xxxxx is a value that can vary in length 
and character. The directory you specify is on the same 
machine as the Integration Server. For example:
For Windows:
watt.server.tspace.location=D:\LargeDocTemp

For UNIX:
watt.server.tspace.location=/opt/webmethods/
tspace
If you do not specify a value for 
watt.server.tspace.location, Trading Networks uses the 
value defined by the Java system property java.io.tmpDir, 
which defaults to the value of the environment variable Temp 
on most platforms.

Note: If you are setting up large document handling for multiple 
webMethods components (e.g., Trading Networks, 
webMethods EDI Module, and webMethods RosettaNet 
Module), use this property to define a single hard disk drive 
location. All components use the same location and the 
Integration Server manages allotting space to each component.

webMethods Trading Networks Administrator’s Guide Version 7.1 58

 3. Configuring webMethods Trading Networks

For this property... Specify...

watt.server.tspace.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.server.tspace.location property. 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, an error 
message is displayed on the server console and the document is 
not stored. Specify any positive whole number of bytes. The 
default is 52,428,800 bytes (50 MB). For example:
watt.server.tspace.max=30000000

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. For example, if your typical concurrent 
document load is 10, you would need a hard disk drive space 
that is 10 to 15 times the combined size of the documents being 
processed concurrently.

Note: If you are setting up large document handling for multiple 
webMethods components, all components use this property. 
The Integration Server ensures that the hard disk drive space 
use for all components does not exceed the value you specify.

watt.server. The maximum number of milliseconds that you want the 
keepAliveTimeout Integration Server to wait for a response after making a request 
to read from a network InputStream.
When you submit a document using a Java InputStream over a 
network to the Integration Server, the Integration Server makes 
a request to read from the InputStream. The Integration Server 
waits the amount of time you specify with the 
watt.server.keepAliveTime property for a response. If the 
Integration Server does not receive a response in the specified 
amount of time, it times out with the error “Connection reset by 
peer”.
Specify a whole number greater than zero. It is recommended 
that you set this property to 180000 (3 minutes), for example:
watt.server.keepAliveTimeout=180000

webMethods Trading Networks Administrator’s Guide Version 7.1 59

 3. Configuring webMethods Trading Networks

For this property... Specify...

The default value is 15000 (15 seconds).

Note: The value you specify with watt.server.keepAliveTime 
does not need to be long enough to accommodate reading the 
entire document. Rather it is just to accommodate the length of 
time it takes to receive a response to a read request.

Other Configuration Settings

For instructions on how to perform the following configuration tasks, 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

webMethods Trading Networks Administrator’s Guide Version 7.1 60

Chapter 4. Configuring My webMethods to Work with Trading
Networks

Central User Management—How Integration Server Authorizes My webMethods Users . . . . . 62

Defining Trading Networks Administrators for My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . 66

Granting My webMethods Users the Authority to Execute Trading Networks Services . . . . . . . 67

Controlling Access to Administrator Pages and Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Defining Role-Based Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Configuring How Long My webMethods Waits for a Response . . . . . . . . . . . . . . . . . . . . . . . . . 81

Configuring Resubmission and Reprocessing Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Settings for BAM on Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

webMethods Trading Networks Administrator’s Guide Version 7.1 61

 4. Configuring My webMethods to Work with Trading Networks

Central User Management—How Integration Server Authorizes

My webMethods Users
To use My webMethods as an administration and monitoring user interface for Trading 
Networks, you must configure Central User Management in Integration Server. Central 
User Management is a feature that allows Integration Server to use the credentials of a My 
webMethods user account to authenticate a user and to determine whether the user is 
authorized for an action.

How Trading Networks Uses Central User Management

Trading Networks uses Central User Management for the following:
When a My webMethods user who has Trading Networks administrator authority 
wants to perform an action that requires My webMethods Server to execute a service 
on the Integration Server, the user can be authenticated and the request authorized by 
presenting the user’s My webMethods user credentials. 

Note: After Central User Management is set up, you still need to take action to grant 
a My webMethods user Trading Networks administrator authority. For 
instructions, see “Defining Trading Networks Administrators for My 
webMethods” on page 66.

When a My webMethods user wants to view Trading Networks data and/or perform 
Trading Networks actions, My webMethods Server invokes Trading Networks 
services on the Integration Server to satisfy the request. When issuing the requests, 
My webMethods Server presents the credentials of the logged in My webMethods 
user to authenticate the user and authorize the request. For more information, see 
“Granting My webMethods Users the Authority to Execute Trading Networks 
Services” on page 67.

Note: After Central User Management is set up, you need to perform additional 
actions to authorize users to perform various Trading Networks actions from My 
webMethods. For more information, see “Defining Role‐Based Access” on page 70.

When a Trading Networks partner sends a document to Trading Networks, it invokes 
a Trading Networks service, for example, wm.tn:receive. The Trading Networks partner 
can invoke the service using the credentials of a My webMethods user account. For 
information about assigning partners a My webMethods user account, see “Managing 
the My webMethods Users Associated with the Partner’s Profile” on page 184 in the 
Chapter 10, “Defining and Managing Partner Profiles”.

webMethods Trading Networks Administrator’s Guide Version 7.1 62

 4. Configuring My webMethods to Work with Trading Networks

Setting Up Central User Management

To set up Central User Management so that My webMethods can be used as a Trading 
Networks user interface, perform the following steps:
1 Configure the Integration Server to use Central User Management. For more 
information, see “Configuring Central User Management in Integration Server” on 
page 63.
2 Identify the Integration Server that My webMethods should interact with for Trading 
Networks requests. For more information, see “Identifying Trading Networks Server 
to My webMethods Server” on page 63.
After Central User Management is set up, My webMethods users can be authorized to 
perform Trading Networks functions by making them members of My webMethods roles. 
For more information, see “How the Integration Server Authorizes a User” on page 64.

Configuring Central User Management in Integration Server

For instructions for how to configure Integration Server to use Central User Management, 
see the webMethods Integration Server Administrator’s Guide.
The configuration task that must be completed in order for Trading Networks to use 
Central User Management is connecting Integration Server to the My webMethods Server 
(MWS) database component.

Identifying Trading Networks Server to My webMethods Server

You must identify the Integration Server on which Trading Networks is running so that 
My webMethods knows the correct host name and port to use to interact with Trading 
Networks.

To identify the Trading Networks Server to My webMethods Server

1 In My webMethods:
Administration > Integration > B2B Settings > Administrative Preferences.
2 In the TRADING NETWORKS SERVER panel, fill in the following fields:

Field Specify

Server Hostname Host name or IP address of the server that host the Trading 

Networks Server.
Server Port Port number for the Trading Networks Server.

3 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 63

 4. Configuring My webMethods to Work with Trading Networks

How the Integration Server Authenticates a User

When using Central User Management, when the Integration Server receives a user name 
and password to authenticate, it first attempts to authenticate the user using its own user 
account definitions. If the user is not defined among IS user accounts, Integration Server 
then uses Central User Management. It determines whether the user account is defined in 
My webMethods, and if so, ensures the user supplied valid My webMethods credentials.

How the Integration Server Authorizes a User

To authorize a request, the Integration Server determines whether the user can access the 
requested IS service; access to IS services is protected by Access Control Lists (ACLs). 
When using Central User Management, you can add My webMethods groups and roles to 
the Allowed list of ACLs. As a result, Integration Server will allow access to the service if 
the ACL allows access to the group or role to which theMy webMethods user belongs.
The following table lists the ACLs used for Trading Networks functionality, the 
corresponding My webMethods roles, how the roles are added to the ACL, and how users 
are added to the My webMethods role.
r

Corresponding My How My webMethods users are

IS ACL webMethods role How the role is added to the ACL added to the My webMethods role
TNAdministrators TN Administrators The TN Administrators role is  You must manually add My 
added to the Allowed list of  webMethods users to the TN 
the TNAdministrators ACL at  Administrators Role. For 
startup. For more  instructions, see “Defining 
information, see “How  Trading Networks 
Trading Networks Adds My  Administrators for My 
webMethods Roles to ACLs”  webMethods” on page 66
on page 65.

webMethods Trading Networks Administrator’s Guide Version 7.1 64

 4. Configuring My webMethods to Work with Trading Networks

Corresponding My How My webMethods users are

IS ACL webMethods role How the role is added to the ACL added to the My webMethods role
TNMWSUsers TN MWS Users The TN MWS Users role is  When a My webMethods role 
added to the Allowed list of  is given general functional 
the TNMWSUSers ACL at  permissions or data 
startup. For more  permissions, that role is 
information, see “How  added as a member of the TN 
Trading Networks Adds My  MWS Users role. For more 
webMethods Roles to ACLs”  information about general 
on page 65. functional permissions and 
data permissions, see 
“Defining Role‐Based Access” 
on page 70.
TNPartners TN Partners The TN Partners role is added  When you use My 
to the Allowed list of the  webMethods to define a 
TNPartners ACL at startup.  profile for a partner, you can 
For more information, see  associate one or more My 
“How Trading Networks  webMethods users with the 
Adds My webMethods Roles  profile. Trading Networks 
to ACLs” on page 65. automatically adds users 
associated with a profile to 
the TN Partners role. For 
instructions about associating 
My webMethods users with a 
profile, see “Managing the 
My webMethods Users 
Associated with the Partner’s 
Profile” on page 184 in 
Chapter 10, “Defining and 
Managing Partner Profiles”.

How Trading Networks Adds My webMethods Roles to ACLs

When you start the Integration Server and Trading Networks server is started, Trading 
Networks determines:
Whether Central User Management is configured, and

Whether the My webMethods TN Administrators, TN MWS Users, and TN Partners 
roles exist

webMethods Trading Networks Administrator’s Guide Version 7.1 65

 4. Configuring My webMethods to Work with Trading Networks

If both Central User Management is configured and the My webMethods roles exist, 
Trading Networks adds the My webMethods roles to their corresponding ACLs. That is 
Trading Networks adds:
TN Administrators role to the TN Administrators ACL

TN MWS Users role to the TNMWSUsers ACL

TN Partners role to the TNPartners ACL
After Trading Networks maps the My webMethods roles to their corresponding ACLs, it 
updates the watt.WmTN.mwsMap property, which is in the Integration Server server.cnf 
file. Trading Networks sets the watt.WmTN.mwsMap property to the Trading Networks 
version number. After this property is updated, Trading Networks will no longer attempt 
to map the My webMethods roles to their corresponding ACLs at startup.
If you want to force Trading Networks to create these mappings again, you can edit the 
Integration Server server.cnf file and remove the watt.WmTN.mwsMap property. As a 
result, when Trading Networks starts up again, it will go through its processing to create 
the mappings.

Defining Trading Networks Administrators for My webMethods

Trading Networks administrator authority allows the users to:
Perform Trading Networks administrative task in My webMethods, which are 
described in this chapter. 
View all Trading Networks data and perform all Trading Networks actions within 
My webMethods. 
In addition, the Trading Networks administrator authority extends to all Trading 
Networks functions accessed via the Integration Server.
To grant Trading Networks administrator authority to a My webMethods user, make any 
of the following a member of the TN Administrators role:
The user itself

A group to which the user belongs

A role to which the user belongs
The following procedure describes how to assign a My webMethods user to the role. To 
learn more role membership, including making groups or roles members of a role, see the 
My webMethods Server Administrator’s Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 66

 4. Configuring My webMethods to Work with Trading Networks

Note: If the user to which you want to grant Trading Networks administrator authority 
does not already have a My webMethods user account, create a user account for the user. 
You create a user using the Administration > System‐Wide > User Management > Users 
page. For instructions, see the My webMethods Server Administrator’s Guide.

To grant a user Trading Networks administrator authority

1 In My webMethods:
Administration > System-Wide > User Management > Roles.

2 On the Roles page, click   EDIT in the row for the TN Administrators role.

3 Click the Members tab.
4 Click Edit Members.
5 Use the SELECT PRINCIPAL(S) dialog to add the My webMethods user to the role. 
For help with this step, see information about editing the membership of a static role 
in the My webMethods Server Administrator’s Guide.
6 Click Apply to close the SELECT PRINCIPAL(S) dialog.
7 Click Save to save the changes to the TN Administrators role.

Granting My webMethods Users the Authority to Execute

Trading Networks Services
When a My webMethods user issues a request that requires access to Trading Networks 
data, My webMethods Server, in turn, attempts to execute a Trading Networks service on 
the Integration Server to perform the requested action, and then displays the results in My 
webMethods. To execute the service, My webMethods Server uses the credentials of the 
logged in My webMethods user. As a result, the My webMethods user must have the 
correct privileges in the Integration Server to execute the service.
In the Integration Server, the Trading Networks services are protected by the 
TNMWSUsers ACL. To allow My webMethods users to execute the service, the My 
webMethods “TN MWS Users” role must be added to the Allowed list of the 
TNMWSUsers ACL. 
After the TN MWS Users role is made a member of the TNMWSUsers ACL, further action 
is still required to allow a user to perform a Trading Networks actions. You still need to 

webMethods Trading Networks Administrator’s Guide Version 7.1 67

 4. Configuring My webMethods to Work with Trading Networks

grant the user’s role the appropriate data permissions and/or general functional 
permissions. For more information, see “Defining Role‐Based Access” on page 70.

To add the TN MWS Users role to the TNMWS ACL

You do not need to take any action. The TN MWS Users role is added to the Allowed list 
of the TNMWSUSers ACL at installation.

Controlling Access to Administrator Pages and Actions

The My webMethods TN Administrators role is predefined with the access privileges and 
general functional privileges that allows users in the role to access Trading Networks 
pages and perform Trading Networks actions. This section describes the predefined 
privileges.

Access Privileges
My webMethods access privileges identify the My webMethods pages that a role is 
allowed to view. The TN Administrators role is predefined to allow users that are 
members of the TN Administrators role to view all pages related to Trading Networks. 
Below shows the settings on the Access Privileges tab of the TN Administrators role. On the 
Access Privileges tab for a role, the grayed out selections are those that Trading Networks 
sets automatically based on the data permissions and general functional permissions. 
Because the TN Administrators have all data permission and general functional 
privileges, these are all selected.
The selections that you can edit are those that must be assigned to the TN Administrators 
role. If you change the predefined selections shown below, the system will reset them 
when My webMethods Server is restarted.

webMethods Trading Networks Administrator’s Guide Version 7.1 68

 4. Configuring My webMethods to Work with Trading Networks

The Monitoring > Integration > B2B selections allow

administrators to view pages for monitoring
transactions, tasks, and the activity log. Additionally,
allows them to view the page to update their own user
preferences. For information about these pages and
actions, see the webMethods Trading Networks User’s
Guide.

The Administration > System-Wide > B2B

Permissions selections allow administrators to view
pages they use to assign role-based access. For more
information, see “Defining Role-Based Access” on
page 70.

The Administration > Integration > B2B selections

allow administrators to view pages they use to manage
trading partners. For more information, see Part II,
“Managing Trading Partners”.

The Administration > Integration > B2B Settings

selections allow administrators to view pages they use
to define settings for how Trading Networks works with
My webMethods and to configure Trading Networks
server configuration properties.

Functional Privileges
My webMethods functional privileges identify the actions that a role can perform. The TN 
Administrators role is predefined to allow users that are members of the TN 
Administrators role to perform all Trading Networks actions.
Most Trading Networks actions are governed by data permissions and general functional 
permissions. For more information about those actions, see “Defining Role‐Based Access” 
on page 70.
The only setting on the Functional Privileges tab for Trading Networks is to allow roles to 
define settings for how Trading Networks works with My webMethods. This selection 

webMethods Trading Networks Administrator’s Guide Version 7.1 69

 4. Configuring My webMethods to Work with Trading Networks

must be assigned to the TN Administrators role. If you change the predefined selection 
shown below, the system will reset it when My webMethods Server is restarted.

Defining Role-Based Access

Role‐based access allows you to grant or restrict access to Trading Networks functionality 
within My webMethods based on the role membership of My webMethods users. That is, 
to view Trading Networks data (for example, information about a delivery task) and to 
perform actions against that data (for example, restart a task), you must be a member of 
role to which that permission has been granted. 
The two types of permissions are general functional permissions and data permissions. 
The data and actions that you control using each are distinct. For more information about:
General functional permissions, see “Data and Actions Governed by General 
Functional Permissions” on page 71.
Data permissions, see “Data and Actions Governed by Data Permissions” on page 72.

Note: Trading Networks role‐based access is only applicable to access via My 
webMethods. There is no role‐based access in Trading Networks Console. A Console user 
continues to have administrative privileges to perform all functions available in the 
Console.

Role-Based Access is Cumulative

If a user belongs to multiple My webMethods roles, the user can perform the actions 
granted to all of the roles that the user is a member of. 

Data and Actions Governed by Role-Based Access

This section describes the data and actions governed by:
General functional permissions

Data permissions

webMethods Trading Networks Administrator’s Guide Version 7.1 70

 4. Configuring My webMethods to Work with Trading Networks

Data and Actions Governed by General Functional Permissions

The following table describes the Trading Networks general functional permissions that 
you can assign to grant access to Trading Networks functionality in My webMethods. The 
table lists the data governed by each general functional permission and the actions a role 
can perform when assigned the permission. For more information about granting 
permissions, see “Granting General Functional Permissions to a Role” on page 74.

Functional permission Actions a role can perform when assigned this functional permission
Manage Public Queues Use the Administration > Integration > B2B > Public Queues 
page to manage (add, edit, delete) all public queues.
Manage Profile Groups Use the Administration > Integration > B2B > Profile Groups 
page to manage (add, edit, delete) all profile groups.
Create Partner Profile Create new profiles for partners. If a user’s role is granted this 
functional permission, Trading Networks displays the Add
Profile button on the Administration > Integration > B2B > 
Partner Profiles page.
Delete Partner Profile Delete any partner profile. If a user’s role is granted this 
functional permission, Trading Networks displays the Delete 
button on the Administration > Integration > B2B > Partner 
Profiles page.
Manage Extended Profile Manage (add, edit, delete) all extended profile fields. If a 
Fields user’s role is granted this functional permission, Trading 
Networks displays the Manage Extended Fields button on the 
Extended Fields tab of a profile.
Add External ID Types Add new external ID types that can be used in profiles. If a 
user’s role is granted this functional permission, Trading 
Networks displays the Add ID Type button on the External IDs 
tab of a profile.
Show SQL View the SQL Trading Networks uses to search the database 
for data. This is for a search that was issued from a Trading 
Networks search panel within My webMethods. If a user’s 
role is granted this functional permission, Trading Networks 
displays the Show SQL button on the search panel where this 
feature is supported.
Manage TN BAM Use the Administration > Integration > B2B > Business 
Configuration Monitoring page to manage business activity monitoring 
(BAM) of TN document types. A user in a role with this 
permission can analysis‐enable TN document types.
View User Preferences Use the Monitoring > Integration > B2B > User Preferences 
page to view (but not update) user preferences.

webMethods Trading Networks Administrator’s Guide Version 7.1 71

 4. Configuring My webMethods to Work with Trading Networks

Functional permission Actions a role can perform when assigned this functional permission
Edit User Preferences Use the Monitoring > Integration > B2B > User Preferences 
page to update user preferences.
View Trading Networks Use the Administration > Integration > B2B Settings > Server 
Server properties Settings page to view (but not update) the settings for the 
Trading Networks Server properties.
Edit Trading Networks Use the Administration > Integration > B2B Settings > Server 
Server properties Settings page to edit Trading Networks Server properties.
Query Expiring Use the Administration > Integration > B2B > Partner 
Certificates Certificates page to query partner certificates that have 
expired or that will expire soon.

Data and Actions Governed by Data Permissions

To set data permissions, you must first define data sets. A data set is composed of profiles, 
transactions, tasks, and activity log entries. For more information, see “About Defining 
Data Sets” on page 76. After defining a data set, you then specify the roles that can act on 
the data in the data set. For each role, you define permissions that indicate the actions the 
role can take against the data.
The following table describes the Trading Networks data permissions that you can assign 
to a role. For more information about granting data permissions, see “Defining Data 
Permissions” on page 75.

Items Actions you can assign to the role

Profiles in the data set View profile information

Edit profile settings
Transactions (Trading  Reprocess transactions
Networks documents) in 
the data set Resubmit transactions

Edit user status attribute of transactions

Edit comments associated with transactions

View content of transactions

Edit content of transactions

webMethods Trading Networks Administrator’s Guide Version 7.1 72

 4. Configuring My webMethods to Work with Trading Networks

Items Actions you can assign to the role

Delivery tasks and/or  View tasks
Service execution tasks in 
the data set Restart tasks

Stop tasks

Delete tasks

Reassign tasks
Activity log entries in the  View activity log entries
data set
Delete activity log entries

Setting Up Role-Based Access

By default, My webMethods users have no access to Trading Networks data. To grant 
access, you grant access to the roles that users are members of.
The following describes the general tasks for setting up Trading Networks role‐based 
access in My webMethods. Each step describes where you can find more‐detailed 
instructions for completing the step.

To set up Trading Networks role-based access in My webMethods

1 Define the roles to which you want to grant access. You define roles using the 
Administration > System‐Wide > User Management > Roles page. For more 
information about defining roles, see the My webMethods Server Administrator’s Guide.
2 Add members to the roles you want to use for Trading Networks role‐based access.
You can make My webMethods users, groups, and/or roles members of a My 
webMethods role. For more information about defining roles, see the My webMethods 
Server Administrator’s Guide.
3 Assign Trading Networks general functional permissions to roles. 
For a description of the general functional permissions, see “Data and Actions 
Governed by General Functional Permissions” on page 71. For instructions for 
defining general functional privileges, see “Granting General Functional Permissions 
to a Role” on page 74.

webMethods Trading Networks Administrator’s Guide Version 7.1 73

 4. Configuring My webMethods to Work with Trading Networks

4 Assign Trading Networks data permissions to roles. 
For a description of data permissions, see “Data and Actions Governed by Data 
Permissions” on page 72. For instructions for defining data permissions, see 
“Defining Data Permissions” on page 75. The general steps are:
a Define the data sets for which you want to assign data permissions. Consider how 
you want to provide access when defining your data sets. 
For example, you might want to create a single data set that identifies all Trading 
Networks data so that you can assign various roles different access to all Trading 
Networks data. You might want to allow one role to only view all the data and 
another role to view all the data and also resubmit and reprocess transactions.
Another example is that you might want to allow all access rights to a role, but 
only to a limited set of data. In this case, you would define multiple data sets, 
each identifying the data on which a role can act. 
For information about defining data sets, see, “About Defining Data Sets” on 
page 76. 
b Identify the roles that can act on the data set.
c For each role, edit the permissions to identify the actions that the role can perform 
against the data set.

Granting General Functional Permissions to a Role

For a description of the general functional permissions, see “Data and Actions Governed 
by General Functional Permissions” on page 71.
Before performing the procedure in this section, you must define the roles to which you 
want to assign general functional permissions. To define roles, use the Administration > 
System‐Wide > User Management > Roles page. For more information about defining 
roles, see the My webMethods Server Administrator’s Guide.

To grant a general functional permission to one or more roles

1 In My webMethods:
Administration > System-Wide > B2B Permissions > General Functional Permissions.

2 Click   EDIT in the row containing the general functional permission that you grant 
to one or more roles.

webMethods Trading Networks Administrator’s Guide Version 7.1 74

 4. Configuring My webMethods to Work with Trading Networks

3 In the SELECT ROLE(S) dialog:
a Search for the roles to populate the Available list by typing a string contained in the 
name(s) of the roles you want and clicking Search.
b To select the roles to which you want to grant permission, move the roles to the 
Selected list.
c Click Apply.

Removing General Functional Permissions from a Role

If you no longer want a role to have a general functional permission, you can remove the 
permission.

To remove a general functional permission from a role

1 In My webMethods:
Administration > System-Wide > B2B Permissions > General Functional Permissions.

2 Click   EDIT in the row containing the general functional permission that you want 
to remove from a role.
3 In the SELECT ROLE(S) dialog:
a Move the role from which you want to remove permission from the Selected list to 
the Available list.
b Click Apply.

Defining Data Permissions

Define data permissions to control access to profiles, transactions, tasks, and activity log 
entries. To indicate the profiles, transactions, tasks, and activity log entries to which you 
want to control access, you define a data set. After you define a data set, you can then 
grant permissions to act on the data set. For a description of the data permissions, see 
“Data and Actions Governed by Data Permissions” on page 72.

webMethods Trading Networks Administrator’s Guide Version 7.1 75

 4. Configuring My webMethods to Work with Trading Networks

About Defining Data Sets

You define data sets by specifying profiles and TN document types. The table below 
describes how Trading Networks includes profiles, transactions, tasks, and activity log 
entries in the data set based on the profiles and TN document types you specify.

This data is included

in the data set... Based on... Limited to...
profiles Profiles defined in the  The profiles identified in the data set 
data set definition definition.
transactions Profiles and TN  Transactions where:
document types in 
the data set definition The sender or receiver of the 
transactions is associated with a 
profile identified in the data set,
‐AND‐
The transactions use a TN document 
type identified in the data set.
tasks Profiles and TN  Task associated with the transactions in 
(delivery and/or document types in  the data set.
service execution) the data set definition
activity log entries Profiles and TN  Activity log entries associated with the 
document types in  profiles and transactions in the data set.
the data set definition

Defining Data Sets and Granting Roles Permissions to Act on the Data Set
Before granting data permissions, you must define the roles to which you want to assign 
data permissions. To define roles, use the Administration > System‐Wide > User 
Management > Roles page. For more information about defining roles, see the My 
webMethods Server Administrator’s Guide.

To define data sets and grant roles permission to act on a data set

1 In My webMethods:
Administration > System-Wide > B2B Permissions > Data Permissions.
2 Click Add Data Set.
3 In the Rule Name field, type a name for the data permission rule.
4 Select the Dataset tab, if it is not already selected.

webMethods Trading Networks Administrator’s Guide Version 7.1 76

 4. Configuring My webMethods to Work with Trading Networks

5 Define the profiles to include in the data set using the PROFILES panel:
a Select whether you want to include all or a subset of profiles in the data set.
To include all profiles, select All Profiles and continue with step step 6.
To include a subset of the profiles, select Custom selection and continue with 
step 5b below.
b If you selected Custom selection, you can do one or more of the following to 
identify the profiles in the data set:
Make the profile list relative to the logged in My webMethods user. 

1 Select Self Profiles.

Note: When checking permissions, Trading Networks includes profiles that 
are associated with the logged in My webMethods user. For more information 
about associating a My webMethods user with a profile, see “Managing the 
My webMethods Users Associated with the Partner’s Profile” on page 184 in 
the Chapter 10, “Defining and Managing Partner Profiles”.
Identify profiles to include in the profile list.

1 Click   Edit above the Profiles box.
2 In the SELECT MEMBERS TO ADD dialog box, search for the profiles 
you might want to add to the data set. The system populates the 
AVAILABLE PARTNERS list with the search results.
3 To select the profiles to add to the data set, move the profiles to the 
SELECTED PARTNERS list.
4 Click OK.

Identify profiles to include in the profile list based on their profile group membership.

1 Click   Edit above the Profile Groups box.

2 Search for the profile groups you might want to add to the data set. 
The system populates the AVAILABLE list with the search results.
3 To select the profile groups to add to the data set, move the profile 
groups to the SELECTED list.
Click OK.

Note: All profile that is a member of the selected profile group is part of the 
profile list. 

webMethods Trading Networks Administrator’s Guide Version 7.1 77

 4. Configuring My webMethods to Work with Trading Networks

6 Define the TN document types to include in the data set using the DOCUMENT TYPES
panel:
a Select whether you want to include all or a subset of TN document types in the 
data set.
To include all TN document types, select All Document Types and continue with 
step step 7.
To include a subset of the profiles, select Selected document types and continue 
with step 6b below.
b If you selected Selected document types:

1 Click   Edit.
2 To select the TN document types to add to the data set, move the TN 
document types to the SELECTED list.
3 Click OK.
7 Click Permissions tab.
8 Add one or more roles to which you want to grant data permissions to act on the data 
in the data set. You must add at least one role. To add a role:
a Click Add Role.
b In the SELECT ROLE(S) dialog:
1 Search for the roles to populate the Available list by typing a string contained 
in the name(s) of the roles you want and clicking Search.
2 To select the roles to which you want to grant permission, move the roles to 
the Selected list.
3 Click Apply.
c Repeat step 8 for each role you want to add.
9 Grant data permissions to the roles you added in step 8. For each role:

a Click   Edit in the row containing the role to which you want to grant data 
permissions. 
b In the EDIT PERMISSIONS dialog box, select the check boxes for the permissions 
you want to assign the role and clear the check boxes for the permissions you do 
not want the role to have.
c Repeat step 9 for each role you added in step 8.
10 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 78

 4. Configuring My webMethods to Work with Trading Networks

Removing Data Permissions

To remove data permissions, you can:
Remove the data permission rule completely, which removes the data set and all the 
permissions
Retain the data permission rule and data set definition, but remove a role from the 
rule so that the role no longer has data permissions for the data set.

To remove a data permission completely, both data set and permissions

1 In My webMethods:
Administration > System-Wide > B2B Permissions > Data Permissions.
2 Select the data permission rules that you want to remove.
3 Click Delete.

To remove a data permissions for a data from a role

1 In My webMethods:
Administration > System-Wide > B2B Permissions > Data Permissions.
2 Click Data Set Name from which you want to remove a role’s permission.
3 Click the Permissions tab.
4 Select the roles that you want to remove.
5 Click Delete.
6 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 79

 4. Configuring My webMethods to Work with Trading Networks

How Trading Networks Uses My webMethods Roles

Privileges
When you add or update a role in My webMethods, you can typically assign the My 
webMethods role access privileges, functional privileges, and for some webMethods 
products, also data‐level security. The following table describes how Trading Networks 
uses these privileges.

Privilege How Trading Networks uses the privileges

My webMethods Access Access privileges define the pages a My webMethods user can 
Privileges access (or view). The My webMethods pages that are used for 
Trading Networks are listed with the other pages in the access 
privileges for a role. However, you do not need to manually 
set the access privileges. When you assign a role Trading 
Networks data permissions and/or general functional 
privileges, Trading Networks automatically sets the access 
privileges for that role to allow the role access to the 
appropriate pages. For more information about data 
permissions and general functional privileges, see “Defining 
Role‐Based Access” on page 70.
My webMethods Functional privileges define the actions a role can perform 
Functional Privileges within My webMethods. However, you do not assign Trading 
Networks privileges using the Functional Privileges tab of a My 
webMethods role. Instead, you grant roles the ability to 
perform Trading Networks actions by setting data 
permissions or general functional privileges for a role. For 
more information about data permissions and general 
functional privileges, see “Defining Role‐Based Access” on 
page 70.
My webMethods Data‐level security defines the data on which a role can act. 
Data-level Security (DLS) You do not assign Trading Networks data‐level security using 
the Data Level Security tab of a My webMethods role. Instead, 
you grant roles Trading Networks data permissions. For more 
information about data permissions and general functional 
privileges, see “Defining Role‐Based Access” on page 70.

webMethods Trading Networks Administrator’s Guide Version 7.1 80

 4. Configuring My webMethods to Work with Trading Networks

Configuring How Long My webMethods Waits for a Response

When a My webMethods user issues a request that requires access to Trading Networks 
data, My webMethods Server, in turn, attempts to execute a Trading Networks service on 
the Integration Server to perform the requested action. The service that My webMethods 
Server executes is a Web service. You configure how long My webMethods Server waits 
for a response from the service before timing out the requested action.
.

To configure how long My webMethods waits for a response

1 In My webMethods:
Administration > Integration > B2B Settings > Administrative Preferences.
2 In the Web Service Timeout field, which is in the GENERAL panel, specify the number of 
seconds that My webMethods Server should wait for a response from a Trading 
Networks Web service. The default is 60 seconds.
3 Click Save.

Configuring Resubmission and Reprocessing Settings

You can configure the following limits for resubmitting and reprocessing documents:
The maximum size of a document (in kilobytes) that you want allow a My 
webMethods user to edit and resubmit. 
A My webMethods user can view the content of a document from the Monitoring > 
Integration > B2B > Transactions page. When viewing the contents of a document, if 
the document is the size you specify for Edit for Resubmit Maximum Size or smaller, the 
Edit for Resubmit button will be available. If a document is greater than the value you 
specify the Edit for Resubmit button will not be available. 
The maximum number of documents that a My webMethods user can resubmit or 
reprocess at one time.
.

To configure resubmission and reprocessing settings

1 In My webMethods:
Administration > Integration > B2B Settings > Administrative Preferences.

webMethods Trading Networks Administrator’s Guide Version 7.1 81

 4. Configuring My webMethods to Work with Trading Networks

2 In the GENERAL PANEL, fill in the following fields:

Field Specify

Edit for Resubmit Maximum Size The maximum size of a document (in kilobytes) 

that you want allow a user to edit and resubmit. 
Reprocessing/Resubmission Limit The maximum number of documents that a My 
webMethods user can resubmit or reprocess at 
one time.

3 Click Save.

Settings for BAM on Trading Networks

If you want to enable Trading Networks transaction data for BAM, you must set the 
configuration properties in the Trading Networks properties file and in the Integration 
Server configuration file.
For information about how to configure Trading Networks to monitor its transaction data, 
see Chapter 5, “Setting up Analysis of Trading Networks Transaction Data”.

Setting the Property in the Trading Networks Properties File

To enable Trading Networks for BAM, perform the following procedure:

To configure Trading Networks settings for BAM

1 In My webMethods: Administration > Integration > B2B Settings > Server Settings.

2 Add or update the following property to enable Trading Networks for BAM:

For this property... Specify...

tn.bam.monitoring. Either true or false. 
enable
true if you want the analysis and monitoring of Trading 
Networks transaction data.
false if you do not want the analysis and monitoring of 
Trading Networks transaction data. By default, the value 
is false.

3 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 82

 4. Configuring My webMethods to Work with Trading Networks

Configuring the Integration Server

In addition to setting the configuration property for Trading Networks, you must also 
configure the settings for the webMethods Integration Server. To configure the 
Integration Server, update the following property in the Integration Server configuration 
file:
webMethods7\IntegrationServer\config\server.cnf
Before you edit the configuration file, shut down the Integration Server. After you make 
the changes, restart the server.

For this property... Specify...

watt.server.optimize.monitoring Either true or false. 
Setting to true initializes the Integration Server 
and Broker for monitoring. It creates a JMS queue 
in Broker that allows the passing of events from 
Trading Networks to Optimize for B2B.
Setting to false does not initialize the Integration 
Server and Broker for monitoring.

For more information about Integration Server configuration file, see the webMethods 
Integration Server Administrator’s Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 83

 4. Configuring My webMethods to Work with Trading Networks

webMethods Trading Networks Administrator’s Guide Version 7.1 84

Chapter 5. Setting up Analysis of Trading Networks
Transaction Data

What is BAM on Trading Networks? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Configure TN Document Types for BAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Updating a TN Document Type for Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Configuration Required for Monitoring Trading Networks Data . . . . . . . . . . . . . . . . . . . . . . . . . . 90

webMethods Trading Networks Administrator’s Guide Version 7.1 85

 5. Setting up Analysis of Trading Networks Transaction Data

What is BAM on Trading Networks?

You can BAM (Business Activity Monitoring) enable the Trading Networks transactions; 
that is, you can integrate Trading Networks with BAM for monitoring and analysis of its 
transaction data. This allows you to view, monitor, and analyze the data based on the 
business requirements you might have. For example, identify any potential setbacks likely 
to occur in the business and thus determine a way to overcome the setbacks.
Trading Networks integrates with BAM using webMethods Optimize for B2B. Optimize 
for B2B analyzes the data it receives from Trading Networks and saves it in its database. 
You can access this saved data to view or generate reports via My webMethods.
To indicate what transaction data to monitor, you configure the TN document types.
For information about the working of BAM on Trading Networks transaction data, see the 
webMethods Trading Networks Concepts Guide.
To configure BAM for Trading Networks transaction data, you must perform the 
following tasks:

For more information about the

Step Task procedure, see

1 Configure TN document types for BAM. “Configure TN Document 

1

Types for BAM” on page 87.

2 Configure event maps and deploy them to Optimize webMethods Optimize for 

2
.
for B2B. Process Administrator’s Guide.

3 Configure KPI Hierarchies. webMethods Optimize for 

3
.
Process Administrator’s Guide.

4 Configure KPIs by associating facts with webMethods Optimize for 

4
.
dimensions as per your requirement. Process Administrator’s Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 86

 5. Setting up Analysis of Trading Networks Transaction Data

Configure TN Document Types for BAM

To identify the transaction data you want to monitor, you configure TN document types 
by selecting the document attributes for which you want to collect monitoring data. The 
data of the attributes that you configure forms the data for analysis and monitoring.

To configure a TN document type for monitoring

1 In My webMethods: Administration > Integration > B2B Partners > Business Monitoring. 

My webMethods displays the Document Types page that displays all the TN 
document types available in Trading Networks.
2 On the Document Types page, select the B2B Documents Monitoring option when you 
want to enable the Trading Networks transaction data for monitoring. After you 
select this option, Trading Networks and Integration Server are automatically 
initialized for monitoring. 
If you do not select this option, you cannot monitor the Trading Networks transaction 
data.
Note: You can initialize Trading Networks and Integration Server for monitoring 
either by selecting the B2B Documents Monitoring option or by setting the server 
configuration properties for each of them. For more information about setting the 
properties, see “Settings for BAM on Trading Networks” on page 82.
3 In the Name field, click the name of the TN document type. Trading Networks 
displays the Document Type Attributes page so that you can configure the attributes for 
monitoring.
4 On the Document Type Attributes page, fill in the following fields:

Field Specify

EventMap Event map name for this TN document type.
Name
Send BAM Select any of the following options to indicate when Trading 
Event After Networks must pass the events of the TN document type to Optimize 
for B2B:
Service Execution

Document Delivery

Other

webMethods Trading Networks Administrator’s Guide Version 7.1 87

 5. Setting up Analysis of Trading Networks Transaction Data

Field Specify

Send BAM Select the above options based on the following conditions:

Event After
Select either Service Execution or Document Delivery option only 
(continued)
when the processing rule for the TN document type you are 
monitoring has both the Execute a Service and Delivery
Document By processing actions associated with it. You do this 
to avoid sending duplicate events to Optimize for B2B. For 
example, if you select the option Service Execution, then 
Trading Networks sends the events only after the associated 
service identified in the processing rule completes execution.
Select the Other option when the processing rule for the TN 
document type you are monitoring has one of either the 
Execute a Service or Delivery Document By processing actions 
(but not both), or when the processing rule has neither of 
these processing actions associated with it. Other is the default 
option.
If you select an incorrect option, Trading Networks will not pass the 
events to Optimize for B2B. An incorrect option is when the TN 
document type that you are monitoring is associated with the 
processing action other than the option you selected, for example, if 
the processing rule uses Execute a Service and you select the Document
Delivery option.

Note: It is recommended that you select the options Service Execution or 

Document Delivery only when the TN document type you are 
monitoring has both the Execute a Service or Delivery Document By 
processing actions associated with it. For all other cases, select the 
option Other. Because each TN document type can be mapped to a set 
of processing rules, ensure that you select the appropriate option.

For more information about processing rule actions, see Chapter 16, 
“Defining and Managing Processing Rules”.
Attribute Select the system attributes and the custom attributes that you want 
Name to monitor. The system attributes, Sender ID, Receiver ID, and Internal ID 
are always monitored. Therefore, you find these attribute fields 
grayed out.
Maximum For the system attributes and the custom attributes that use a list, 
Number of specify the maximum number of items you might send to Optimize 
Items for B2B for monitoring.
The system attributes that use a list are Sender Profile Group and the 
Receiver Profile Group.

webMethods Trading Networks Administrator’s Guide Version 7.1 88

 5. Setting up Analysis of Trading Networks Transaction Data

5 Click Save and Configure Event Map. This saves the selection of the attributes in Trading 

Networks and displays the Add/Edit Event Map page. 
6 On the Add/Edit Event Map page, specify the event and the event map information 
for the document attributes, and then deploy the event to Optimize for B2B. For 
information about the steps of specifying the event and the event map information, 
see the webMethods Optimize for Process Administrator’s Guide.
7 Create the KPI Hierarchies and the KPIs based on which the Trading Networks 
transaction data is analyzed. For information about the procedure of creating the KPI 
Hierarchies and the KPIs, see the webMethods Optimize for Process Administrator’s 
Guide.

Updating a TN Document Type for Monitoring

You can update the monitoring configuration of a TN document type by either selecting 
more attributes for monitoring, or by de‐selecting any of the already selected attributes for 
monitoring.

To update a TN document type for monitoring

1 In My webMethods: Administration > Integration > B2B Partners > Business Monitoring. 

My webMethods displays the DocType List page that displays all the TN document 
types available in Trading Networks.
2 Click the name of the TN document type that you want to update.
Note: It is recommended that you disable the TN document type for monitoring, and 
then update it.
3 Either select more attributes for monitoring or deselect the attributes that you do not 
want for monitoring.
4 Click Save and Configure Event Map. The Add/Edit Event Map page is displayed.
5 In step 3, if you selected attributes for monitoring, you must create event maps for 
those attributes. You can also update the KPI hierarchies and KPIs based on the 
changes you made in the attributes. For more information about updating event 
maps, KPI hierarchies and KPIs, see the webMethods Optimize for Process 
Administrator’s Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 89

 5. Setting up Analysis of Trading Networks Transaction Data

Configuration Required for Monitoring Trading Networks Data

You can evaluate Trading Networks‐specific data based on transaction status, task status, 
etc. to get results on successful transactions, the percentage of documents resubmitted or 
reprocessed, and so on. Because these data are dimensions, you cannot analyze them 
using Optimize for B2B. Thus, to evaluate such data, you must create the custom 
attributes for their data and then create the KPIs. Perform the following procedure:
1 Create the attributes in the required TN document type such as:
Total Count 
Successful Transaction Count
Resubmit Count
Reprocess Count
Successful Delivery Count
2 Configure and enable the TN document type for monitoring.
3 Create the required KPIs, for example, using the Successful Transaction Count 
attribute. Create a KPI for total count and another KPI for successful transactions 
count. Create another composite KPI using these two KPIs that divides the successful 
transaction count with the total count to get a percentage of successful transactions. 
You can follow the same procedure for evaluating data on other attributes that you 
created.
4 After configuring the required KPIs, associate a service execution task with the TN 
document typeʹs processing rule that updates the attributes after the completion of 
the service execution.

For more information about:

Creating custom attributes, see Chapter 13, “Defining and Managing Document 
Attributes”.
Configuring and enabling TN document types for monitoring, see “Configure TN 
Document Types for BAM” on page 87.
Creating KPIs, see the webMethods Optimize for Process Administrator’s Guide.

Configuring the processing rule action, see Chapter 16, “Defining and Managing 
Processing Rules”

webMethods Trading Networks Administrator’s Guide Version 7.1 90

Chapter 6. Planning Your Network

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Task 1: Identify the Types of Transactions to Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Task 2: Determine the Important Document Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Task 3: Define the Types of Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Task 4: Define Information to Maintain about Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Task 5: Create Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Task 6: Define Actions to Perform Against Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Task 7: Add Partners to Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Task 8: Configure Trading Networks for BAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

webMethods Trading Networks Administrator’s Guide Version 7.1 91

 6. Planning Your Network

Introduction
Before you begin planning your network, it is helpful if you have a basic understanding of 
Trading Networks. For more information, see the webMethods Trading Networks Concepts 
Guide.
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; 
however, based on your unique situations, you might want (or need) to perform the tasks 
in an alternative order. The general order of tasks is:

Task Description See page...

1. Identify the types of transactions that Trading Networks will  93
need to handle.
2. Determine the pieces of information within documents that are  95
of interest to you and define this information to Trading 
Networks.
3. Define the types of documents you want Trading Networks to  96
recognize.
4. Determine the information that you want to maintain about  104
your partners; use this information to define the profiles you 
want to keep about partners.
5. Create the profile for your own corporation. 105
6. Define the actions that you want Trading Networks to take  105
against the documents it receives.
7. Add partners to your network. 106
8. Configure and enable Trading Networks to analyze and  106
monitor its transaction data using Optimize for B2B.

Tasks 1 through 6 define the behavior of your trading network. After you perform these 
tasks, you have defined the document attributes, TN document types, profile fields, and 
processing rules that determine how Trading Networks processes documents that enter 
your system.
You might want to perform these tasks in a development environment. After Tasks 1 
through 6 are completed, you can use your development system to test your trading 
network to ensure it processes documents as you intended. If problems arise, you can 
correct them. After you ensure your trading network is defined properly, migrate your 
information to a production environment.
You can migrate your document attributes, TN document types, profile fields, processing 
rules, and your profile into your production system using the export and import facility 

webMethods Trading Networks Administrator’s Guide Version 7.1 92

 6. Planning Your Network

that Trading Networks provides. For more information, see Appendix C, “Exporting and 
Importing Database Information”.
After you have migrated information to your production system, you can perform Task 7; 
that is, add partners to your network.
Perform Task 8 only if you want to BAM enable Trading Networks, that is, you want to 
analyze and monitor the transaction data for business purposes. You must complete all 
the tasks from 1 to 7 to perform this task. For more information about enabling BAM on 
Trading Networks, see the webMethods Trading Networks Concepts Guide.
The following sections provide more information about each task required to set up your 
trading network. 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.

Task 1: Identify the Types of Transactions to Process

To exchange documents with trading partners, you need to define the types of documents 
that your Trading Networks system will receive. This first task is to identify the 
transaction types that your Trading Networks system will receive, for example, purchase 
orders, confirmations, etc. In addition, you need to determine the variations of each 
transaction. For example, you might receive EDI, cXML, and CBL purchase orders.

Task 1: Identify the Types of Transactions to Process

Step Action D

1. Determine types of transactions. You should know the types of transactions 

you will be exchanging with your trading partners (your suppliers, 
business partners, etc.). For example, you might send documents that 
represent purchase orders, acknowledgements, available to promise, 
etc.
2. Determine variations of transaction types. This is applicable for XML 
documents only. For each type of transactions, determine the variations 
of that transaction that you receive. For example, you might receive 
purchase orders in cXML, OAG, and CBL.
3. Obtain sample files. This is applicable for XML documents only. Although 
it is not necessary, it is helpful if you can obtain a representative sample 
document for each variation of a transaction type. Place the samples in 
a directory that you will have available when using the Trading 
Networks Console. 

webMethods Trading Networks Administrator’s Guide Version 7.1 93

 6. Planning Your Network

Task 1: Identify the Types of Transactions to Process

Step Action D

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

webMethods Trading Networks Administrator’s Guide Version 7.1 94

 6. Planning Your Network

Task 2: Determine the Important Document Information

To process and analyze the types of information that pass through your network, you can 
have Trading Networks extract information from documents. The information that 
Trading Networks extracts is available to determine how to process the document and for 
you to use for reporting. 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.
For Trading Networks to extract information, you have to define the pieces of information 
within documents that are important to you. Trading Networks refers to these pieces of 
information as document attributes. The following system attributes are provided for you:
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; 
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. You do not need to define them, and 
you cannot delete them.
To identify other pieces of information within a document that are of interest, you can 
define custom document attributes. For example, you might be interested in the total 
amount of purchase orders you receive; in this case, define a custom attribute for total 
purchase order. Typically, the documents for all variations of a transaction type have the 
same pieces of information. For example, a cXML purchase order, OAG purchase order, 
and CBL purchase order all have some piece of information that represents the total 
purchase amount. You do not define multiple custom attributes, one for each variation of 
a transaction type—define a single custom attribute that can be used for all variations of 
the transaction type.

webMethods Trading Networks Administrator’s Guide Version 7.1 95

 6. Planning Your Network

For each piece of information (attribute) that is of interest to you, complete the following 
tasks:

Task 2: Determine the Important Document Information

Step Action D
1. Identify the attribute. Select a name for the attribute and the data type 
(STRING, NUMBER, or DATETIME) for the value of the attribute. 
Optionally, you might want to give the attribute a description.
2. Define the custom document attribute. Use the Trading Networks Console 
and the information from Step 1 to define the attribute. For instructions, 
see “Defining Document Attributes” on page 224.

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, you can define the TN 
document types for each of the variations of documents that Trading Networks will 
receive for a transaction.
When documents are first received, Trading Networks uses the TN document types to 
recognize the type of document and perform actions based on the TN document type. 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. The 
pre‐processing actions indicate whether Trading Networks is to verify the document’s 
digital signature, validate the structure of the document, determine whether the 
document has been received before, and/or save the document to the Trading Networks 
database.

webMethods Trading Networks Administrator’s Guide Version 7.1 96

 6. Planning Your Network

For each variation of a transaction, complete the following tasks:

Task 3: Define the Types of Documents

Step Action D
1. Determine how to recognize documents of this type. Identify the contents of the 
document that uniquely indicate that a document is this variation of a 
transaction.
For XML documents: For example, if you are defining a cXML purchase 
order, 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. 
To identify specific nodes within an XML document, you specify an 
XQL query. If you have a sample document available, when you use 
the Trading Networks Console to define the TN XML document 
type, you can have Trading Networks load the sample for your use in 
creating the XQL queries. When a sample document is loaded, you 
can select the node in the sample document and Trading Networks 
creates the query for you. For details about what you can use to 
identify a TN XML document type, read “Identification Information 
in TN XML Document Types” on page 234.
For flat file documents: you can specify arbitrary pipeline variables to 
identify a TN flat file document type. 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 details, read “Pipeline Matching Criteria Used to 
Identify the TN Document Type” on page 309.
2. Determine the attributes that you want to create from documents of this type. You 
can have Trading Networks create any or all of the system and custom 
attributes from XML and flat file documents. 
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. If you have a sample 
document available, when you use the Trading Networks Console to 
define the TN document type, you can have Trading Networks load 
the sample for your use in creating the XQL queries. When a sample 
document is loaded, you can select the node that contains the 
attribute information and Trading Networks creates the query for 
you. For details about specifying XML document attributes, read 
“Extraction Information In TN XML Document Types” on page 238.

webMethods Trading Networks Administrator’s Guide Version 7.1 97

 6. Planning Your Network

Task 3: Define the Types of Documents

Step Action D
2.  For flat file documents: For each attribute that you want to create from a 
cont... flat file document, specify the system and custom (user‐defined) 
attributes that you want Trading Networks to extract from TN_parms 
and place in the bizdoc. These are attributes that Trading Networks 
can save to the database to use later. For details about specifying flat 
file document attributes, read “Attributes To Extract From 
Documents” on page 310.
For Trading Networks to perform some pre‐processing and processing 
actions, you must extract certain system attributes. 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 Function it affects…

SenderID Processing rule search criteria—To process 
documents based on the sender of the document, 
you need to extract the SenderID. For example, you 
might want all documents from a specific sender 
to be handled in a special way. (For more 
information, see “Processing Rule Criteria” on 
page 341.)
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 must extract the 
SenderID. (For more information, see “Checking 
for Duplicate of the XML Document” on page 257 
and “Checking for Duplicates of the Flat File 
Document” on page 321.)
Alert E‐mail processing actions—To send an e‐
mail message to a contact at the sender’s 
corporation, you need to extract the Sender ID. 
You set up contacts when you define profiles for a 
partner, which is handled in a later task. (For more 
information, see “Action 2—Send an Alert E‐mail” 
on page 361.)

Note: Typically, you should always extract the SenderID 
system attribute.

webMethods Trading Networks Administrator’s Guide Version 7.1 98

 6. Planning Your Network

Task 3: Define the Types of Documents

Step Action D
2.  System Attribute Function it affects…
cont...
ReceiverID Processing rule search criteria—To process a 
document based on receiver of the document, you 
need to extract the ReceiverID. For example, you 
might want all documents that are sent to a 
specific receiver to be handled in a special way. 
(For more information, see “Processing Rule 
Criteria” on page 341.)
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, you must extract the 
ReceiverID. (For more information, see “Checking 
for Duplicate of the XML Document” on page 257 
and “Checking for Duplicates of the Flat File 
Document” on page 321.)
Alert e‐mail processing action—To send an e‐mail 
message to a contact at the receiver’s corporation, 
you need to extract the ReceiverID. You set up 
contacts when you define profiles for a partner, 
which is handled in a later task. (For more 
information, see “Action 2—Send an Alert E‐mail” 
on page 361.)
The Deliver Document By processing action—If you 
want Trading Networks to deliver the document 
to the receiver, you need to extract the ReceiverID. 
(For more information, see “Action 4—Deliver the 
Document to the Receiver” on page 365.)

Note: Typically, you should always extract the 
ReceiverID system attribute

webMethods Trading Networks Administrator’s Guide Version 7.1 99

 6. Planning Your Network

Task 3: Define the Types of Documents

Step Action D
2.  System Attribute Function it affects…
cont...
DocumentID 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 need to extract the 
DocumentID. (For more information, see “Checking for 
Duplicate of the XML Document” on page 257 and 
“Checking for Duplicates of the Flat File Document” 
on page 321.)

Note: Typically, you should always extract the 
DocumentID system attribute.

SignedBody and  The Verify Digital Signature pre‐processing action—If 

Signature you want Trading Networks to be able to verify the 
digital signature of XML documents, you need to 
extract the SignedBody and Signature. (For more 
information, see “Verifying the Digital Signature of an 
XML Document” on page 256. To verify the digital 
signature of flat file documents, see “Verifying the 
Digital Signature of Flat File Documents” on 
page 319.)
ConversationID 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, you need to extract the 
conversation ID. (For more information, see 
“Important Attributes that You Should Extract from 
an XML Document” on page 238 or “Specifying the 
Document Gateway Services Outputs” on page 306.)
processingRule Rather than have Trading Networks look up the 
ID appropriate rule for a flat file document, use this 
attribute to explicitly specify the processing rule, thus 
eliminating the overhead of that lookup. (For more 
information, see “Specifying the Document Gateway 
Services Outputs” on page 306.)

webMethods Trading Networks Administrator’s Guide Version 7.1 100

 6. Planning Your Network

Task 3: Define the Types of Documents

Step Action D
2.  DoctypeID Rather than have Trading Networks search for an 
cont... 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 306.)
UserStatus 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 306.)
GroupID 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 306.)
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 
an 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 Built‐in 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 254.
4. 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 255.
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 320.

webMethods Trading Networks Administrator’s Guide Version 7.1 101

 6. Planning Your Network

Task 3: Define the Types of Documents

Step Action D
5. 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 256 and “Pre‐Processing Actions in the TN Flat 
File Document Type” on page 319.
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 256.
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 319.
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 257.
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 320.

webMethods Trading Networks Administrator’s Guide Version 7.1 102

 6. Planning Your Network

Task 3: Define the Types of Documents

Step Action D
5.  Check the for duplicate document of a document; that is, has Trading 
cont... 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 367.
Disable processing rule processing for the document—You can 
indicate that you do not want Trading Networks to search for a 
processing rule to process this document. In this case, —Trading 
Networks will not perform any processing rule actions against the 
document. You might want to disable processing rule processing if 
the document is to be processed as part of a business process. 
Keep in mind that if processing rule processing is enabled, the 
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 261 and 
“Defining TN Flat File Document Types” on page 325.

webMethods Trading Networks Administrator’s Guide Version 7.1 103

 6. Planning Your Network

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 Action D
1. Review the standard profile fields that are provided. Determine whether the 
standard fields meet your needs. To see a description of the type of 
information in profiles, see “Information Trading Networks Maintains 
in a Profile” on page 113.
For a list of the standard fields that you can change, “Standard Profile 
Fields” on page 130.
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 130. For instructions on how to 
update whether fields are required or not, see “Updating Standard 
Profile Fields” on page 139.
3. 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. For 
instructions on how to define extended profile fields, see “Extended 
Profile Fields” on page 137 and “Adding Extended Profile Fields” on 
page 140. 

webMethods Trading Networks Administrator’s Guide Version 7.1 104

 6. Planning Your Network

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 146.

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 Chapter 17, “Defining and Managing 
Queues in Trading Networks” 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.

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 Designer 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 Getting Started with 
Business Process Management and webMethods Designer online help.

Processing rules and conversation scripts are extremely flexible. To understand all of the 
capabilities of processing rules and how to set them up, see “Defining and Managing 
Processing Rules” on page 335.

webMethods Trading Networks Administrator’s Guide Version 7.1 105

 6. Planning Your Network

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 create the 
profile using the gathered information. For instructions, see “Adding Partner Profiles” on 
page 166.
After a partner is added to your network, you can start exchanging business documents 
with the partner.

Task 8: Configure Trading Networks for BAM

You configure Trading Networks for BAM only if you want to analyze and monitor its 
transaction data for business purposes, for example, analyzing purchase order volume 
from a partner, analyzing average invoice amount sent to a partner, monitor error trends, 
and so on. 
You configure the required existing TN document types to indicate the transaction data 
that you want to monitor. Based on the configuration, Trading Networks passes the 
monitoring data as events to Optimize for B2B, which analyzes the data based on the KPIs 
you define at design time. At run time, My webMethods Server retrieves the analyzed 
data from Optimize for B2B’s database and allows you to view the data in a graphical or 
tabular format.
For information about BAM with Trading Networks, see the webMethods Trading Networks 
Concepts Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 106

 6. Planning Your Network

If you want BAM on Trading Networks transaction data, complete the following tasks:

Task 8: Configure Trading Networks for BAM

Step Action
1. Add the following components to your Trading Networks network:
webMethods Broker: Broker acts as a messaging system to pass the 
events from Trading Networks to Optimize for B2B. It uses a JMS 
(Java Messaging System) queue to stack the data. Optimize for B2B 
subscribes the data for analysis from this queue.
For information about connecting the Broker, see webMethods 
Integration Server Administrator’s Guide.
webMethods Optimize for B2B: Analyzes and allows the monitoring of 
Trading Networks transaction data. You also create events, KPI 
hierarchies, and KPIs for the document attributes in Optimize for 
B2B using My webMethods. For information about events, KPI 
hierarchies, and KPIs, see webMethods Optimize for Process 
Administrator’s Guide.
For information about connecting the Optimize for B2B, see 
webMethods Installation Guide.
2. Configure Trading Networks and Integration Server to enable BAM on Trading
Networks transaction data. Set the required properties and settings in 
Trading Networks properties file and Integration Server’s 
configuration file. You can perform further tasks only after this 
configuration. 
For more information about how to do the configuration, see “Settings 
for BAM on Trading Networks” on page 82. 
3. Configure the TN document type for monitoring. Select an existing TN 
document type for configuration, and specify the system attributes and 
the custom attributes to be monitored. 
Use My webMethods to configure the TN document type. 
For instructions about configuring the TN document type, see 
Chapter 5, “Setting up Analysis of Trading Networks Transaction Data”

webMethods Trading Networks Administrator’s Guide Version 7.1 107

 6. Planning Your Network

Task 8: Configure Trading Networks for BAM

Step Action
4. Create the event maps for each document attribute. In Optimize for B2B, you 
create event maps for the document attributes you selected for 
monitoring by associating each of them to a fact, dimension, or a 
transaction. At run time, Trading Networks collates the document 
attributes for monitoring and associates each with their respective 
event maps to create events. Trading Networks then passes the events 
to Broker.
Use My webMethods to create the event maps.
For information about run‐time processing of monitoring data, see 
webMethods Trading Networks Concepts Guide.
For information about creating the event maps, see “Configure TN 
Document Types for BAM” on page 87 and webMethods Optimize for 
Process Administrator’s Guide.
5. Create the KPI Hierarchies and the KPIs. In Optimize for B2B, create the KPI 
hierarchies and the associated KPIs using My webMethods. Optimize 
for B2B analyzes the data based on these KPIs.
For more information about creating KPI hierarchies and KPIs, see the 
webMethods Optimize for Process Administrator’s Guide.
6. Enable the TN document type for analysis. After you finish the 
configuration, you can enable that TN document type for analysis. 
After enabled, Trading Networks monitors every document it receives 
that is associated with that TN document type.
Use My webMethods to enable the TN document type for analysis.
For information about enabling the TN document types for analysis, 
see “Configure TN Document Types for BAM” on page 87.

webMethods Trading Networks Administrator’s Guide Version 7.1 108

 Part II. Managing Trading Partners

Chapter 7, “About Trading Partners”

Chapter 8, “Defining and Managing Profile Fields”

Chapter 9, “Defining and Managing Your Profile (Your Enterprise)”

Chapter 10, “Defining and Managing Partner Profiles”

Chapter 11, “Defining and Managing Profile Groups”

Chapter 12, “Defining and Managing Trading Partner Agreements (TPAs)”

webMethods Trading Networks Administrator’s Guide Version 7.1 109

 II. Managing Trading Partners

webMethods Trading Networks Administrator’s Guide Version 7.1 110

Chapter 7. About Trading Partners

How to Manage Partners in Your Trading Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Information Trading Networks Maintains in a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Steps to Setting up Profiles in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Profile Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

webMethods Trading Networks Administrator’s Guide Version 7.1 111

 7. About Trading Partners

How to Manage Partners in Your Trading Network

Every corporation in your network, including your own corporation, requires a profile in 
the Trading Networks system. A profile is a summary of information about a corporation 
that is a part of a trading network. 
Your profile (Enterprise) contains information that you define about your corporation.

A partner’s profile is information about a partner 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. Trading Networks is 
only aware of partners for which it has a profile. 

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

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 fields that are provided out‐of‐the‐box and that incorporate the 
majority of the information that you will want to collect about a partner. 
Extended fields are fields that you define to extend the standard profile.
You can define and manage profile fields using My webMethods and Trading Networks 
Console. For more information about working with profile fields:
Using My webMethods, see Chapter 8, “Defining and Managing Profile Fields” 

Using Console, see Appendix G, “Managing Profile Fields Using the Console” 
For a description of the information that Trading Networks includes in a profile and to 
view the information, see “Information Trading Networks Maintains in a Profile” on 
page 113. 

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.

webMethods Trading Networks Administrator’s Guide Version 7.1 112

 7. About Trading Partners

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 create profiles for your 
partners. 

Information Trading Networks Maintains in a Profile

The following sections describe the information that Trading Networks maintains in a 
profile.

Partner Identification Information

The following table lists the fields that Trading Networks uses to describe a corporation. 
These fields are located:
In My webMethods in the Partner Details panel of the Partner Profile page.

In Trading Networks Console on the Corporate tab of the Profile screen. 

Field Description
Corporation Name The name of the partner’s corporation, for example, 
“Industrial Steel Company”.
Organization Unit The name of the organizational unit or division within the 
partner’s corporation, for example, “Sales and Marketing”.
In the Console, the field name is Unit Name.
Status The status of the profile. For more information, see “Profile 
Statuses” on page 127.
In the Console, the Status field is not listed in the profile 
details. The status is shown only in the list of profiles.

webMethods Trading Networks Administrator’s Guide Version 7.1 113

 7. About Trading Partners

Field Description
Preferred Language The Preferred Language option is for use only by other 
webMethods components (e.g., webMethods RosettaNet 
Module) for localization purposes. Optionally, specify the 
preferred language of the partner. Trading Networks does 
not use this option for its own processing.
Partner Type The type of software the corporation uses to interact with the 
trading network. 
Value Meaning

webMethods Trading The corporation uses webMethods 

Networks Trading Networks.
webMethods for A partner in the network that is using 
Partners webMethods for Partners.
Web Browser A partner in the network that is using 
a Web browser.
Other/Unknown A partner in the network that is not 
using one of the other types of 
software. For example, this might be a 
partner that is using a webMethods 
Integration Server (without Trading 
Networks) or a marketplace.

Note: This feature is deprecated and not available in My 
webMethods.

External IDs
Trading Networks maintains external IDs for a partner and uses those external IDs to 
identify sending and receiving partners that are identified within a document. For 
example, within a document, the sending partner might be identified by its D‐U‐N‐S 
number. Trading Networks uses the value of the D‐U‐N‐S number that it finds in the 
document and matches it to profiles in its system. When it finds a profile with an external 

webMethods Trading Networks Administrator’s Guide Version 7.1 114

 7. About Trading Partners

ID of type DUNS that matches the value from the document, it determines the sender of 
the document is the partner with the matching profile.
The following table lists the fields that Trading Networks uses for external IDs. These 
fields are located:
In My webMethods on the External IDs tab of the Partner Profile page.

In Trading Networks Console on the Corporate tab of the Profile screen. 

Field Description
ID Type The type of identification that a corporation uses within 
documents. 
In the Console, the field name is External ID Type.
Value The alpha‐numerical value for the external ID type. For 
example, if ID type is “DUNS”, Value is the partner’s D‐U‐N‐S 
number.

The external IDs can be used when creating a user account that is associated with the 
profile. You can associate the profile with one or more My webMethods user accounts 
and/or an Integration Server user account. 
When you define or edit a profile in My webMethods you can optionally associate the 
profile with My webMethods user accounts. One method to defining a user account is 
to have Trading Networks create a My webMethods user account and use the value of 
an external ID that you select as the user name for the account.
When you define a profile using the Trading Networks Console, Trading Networks 
can automatically create an Integration Server user account. You configure whether 
you want Trading Networks to create the user account using the tn.default.userCreation 
configuration property. When Trading Networks creates the user account, it uses the 
value of the default external ID as the user name of the user account. You configure the 
default external ID using the tn.default.idType.
When you associate a user account with the profile, the user account receives Trading 
Networks partner authority. This allows the partner that the profile defines to use the user 
account to access your Trading Networks system. For example, when the partner sends a 
document to your Trading Networks system, the user can supply the user name and 
password of the user account associated with their profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 115

 7. About Trading Partners

Addresses
You can identify one or more addresses for a corporation. The following table lists the 
fields that Trading Networks uses for address. These fields are located:
In My webMethods on the Addresses tab of the Partner Profile page.

In Trading Networks Console on the Corporate tab of the Profile screen. 

Field Description
Country The country where the partner’s corporation is located, for 
example “USA”.
Address The street address of the partner’s corporation, for example, 
“123 Main Street”.
City The city where the partner’s corporation is located, for 
example, “Los Angeles”.
State/Province The state or province where the partner’s corporation is 
located, for example, “California”.
Postal Code The postal code (for example, a zip code) for the state or 
province where the partner’s corporation is located, for 
example, “90001”.

Contacts
You can define information about the people you interact with in a corporation, for 
example, the names and phone numbers of your contacts. The following table lists the 
fields that Trading Networks uses for contacts. These fields are located:
In My webMethods on the Contacts tab of the Partner Profile page or in the dialog box 
you use to add or edit a contact listed on the Contacts tab.
In Trading Networks Console on the Contact tab of the Profile screen. 

webMethods Trading Networks Administrator’s Guide Version 7.1 116

 7. About Trading Partners

Field Description
Name This column contains the list of contacts defined for a partner’s 
corporation. It is a combination of the Last Name and First Name 
fields.
This column is listed only in Trading Networks Console on the 
Contact tab of the Profile screen. In My webMethods, a Name list is 
not necessary because aTrading Networks displays one row for 
each contact you have defined for a partner on the Partner Profile 
Contacts tab.
Contact Type The type of contact, for example, “Administrative”.

Note: Out‐of‐the‐box, Trading Networks provides pre‐defined 
contact types. You can add additional contact types by using the 
built‐in service wm.tn.dictionary:addContactType. For more information, 
see the webMethods Trading Networks Built‐in Services Reference. 

Title The contact’s job title, for example, “Trading Network 
Administrator”.
In the Console, the field name is Role.
Last Name The contactʹs last name (surname).
First Name The contactʹs first (given) name.
E-Mail The contactʹs e‐mail address.

Note: In the Console on the Processing Rules screen, Trading 
Networks allows you to select a contact type for the Alert e-mail 
processing action. The Alert e-mail processing action instructs 
Trading Networks to send an e‐mail message to the contacts of the 
selected contact type. If an e‐mail address is not specified for a 
contact of the selected contact type, Trading Networks cannot send 
the e‐mail message. For more information, see “Action 2—Send an 
Alert E‐mail” on page 361.

Telephone The contactʹs telephone number, for example, “1‐800‐555‐1234”.
Extension The contactʹs extension number.
Pager The contactʹs pager number, for example, “1‐330‐555‐7890”.
Fax The contactʹs fax number, for example, “1‐888‐555‐4897”.
Country The country where the contact is located, for example, “USA”.
Address The street address of the contact, for example, “123 Main Street, 
Suite 456”. 

webMethods Trading Networks Administrator’s Guide Version 7.1 117

 7. About Trading Partners

Field Description
City The city where the contact is located, for example, “Los Angeles”
State/Province The state or province where the contact is located, for example, 
“California”.
Postal Code The postal code (for example, a zip code) for the state or province 
where the contact is located, for example, “90001”.

Profile Group Membership

You can associate profiles with profile groups. A profile can belong to more than one 
profile group. Before you can associate profiles with a profile group, you must define 
profile groups. You can define profile groups from My webMethods and from the Trading 
Networks Console.
My webMethods. For more information about how to create profile groups using My 
webMethods, Chapter 11, “Defining and Managing Profile Groups”.
You can view the profile groups on the Profile Group Membership tab of the Partner 
Profile page.
Trading Networks Console. For more information about how to create profile groups 
using Trading Networks Console, see Appendix J, “Managing Profile Groups Using 
the Console”.
You can view the profile groups on the Corporate tab of the Profile screen.

Delivery Settings
Trading Networks maintains the methods in which it can deliver a document to a partner. 
You must define the methods you want Trading Networks to use to deliver documents 
and provide information that is specific to the partner. For example, if you want Trading 
Networks to be able to deliver a document using HTTP, you might define the Primary 
HTTP delivery method. When you define this delivery method, you must provide the 
partners host name and port that it uses to listen for HTTP requests.
You can access the delivery settings in the following locations:
In My webMethods on the Delivery Settings tab of the Partner Profile page.

In Trading Networks Console on the Delivery Method tab of the Profile screen. 

webMethods Trading Networks Administrator’s Guide Version 7.1 118

 7. About Trading Partners

Delivery Method Settings

You can define multiple delivery methods for a profile. Trading Networks uses the fields 
in the following table for delivery methods. Trading Networks does not list all fields for 
all delivery methods. When you select a delivery method, Trading Networks lists the 
fields for the selected delivery method.

Field Description
Delivery Method The name of a delivery method that Trading Networks can use when 
delivering documents to the partner.
In the Console, the field name is Protocol.

Note: Trading Networks provides (out‐of‐the‐box) delivery methods 
for delivering documents via e‐mail (SMTP), HTTP, HTTPS, FTP, and 
FTPS. If you require another method (e.g., delivering into a message 
queuing system), see Chapter 18, “Creating Delivery Services”. This 
chapter describes how to add your own delivery methods. 

Host The partner’s host name or IP address, for example, 
“IndustrialSteel.com”. This option is only valid for HTTP, HTTPS, 
FTP, and FTPS protocols.
Port The port number on which the partner listens for incoming requests, 
for example, “5555”. This option is only valid for HTTP, HTTPS, FTP, 
and FTPS protocols.
Location The location to use when sending a document to the partner. 
For this Delivery
Method… Use this Location…

HTTP or HTTPS The URL that Trading Networks is to use 
when sending documents. Trading Networks 
automatically fills in the Location with 
/invoke/wm.tn/receive, the standard URL 
for document exchange.
FTP or FTPS The directory path that Trading Networks is 
to use when sending documents. The file 
name of the file is the internal ID that Trading 
Networks generates for the document when 
Trading Networks receives it. 
For XML documents, the file extension is 
xml, e.g., 0a010154f70ddbf900000203.xml.
For flat file documents, the file extension 
is dat

webMethods Trading Networks Administrator’s Guide Version 7.1 119

 7. About Trading Partners

Field Description
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, HTTPS, FTP, or FTPS). If you do not know 
what to specify for User Name, contact the partner.

Note: This field is for a partner profile only; Trading Networks does 
not display it for your (Enterprise) profile.

Password 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, HTTPS, FTP, or FTPS). 

Note: Passwords used in scheduled delivery queues (public and 
private) are stored in the Trading Networks database in binary‐
encoded form (not in clear text). It is not possible for Trading 
Networks to encrypt passwords used in scheduled delivery queues; 
because trading partners are allowed to create custom scheduled 
delivery services, Trading Networks cannot anticipate which user‐
defined input variable might be a password. For more information, 
see Appendix B, ʺSecurity within Trading Networksʺ in the 
webMethods Trading Networks Concepts Guide.

Note: This field is for a partner profile only; Trading Networks does 
not display it for your (Enterprise) profile.

E-mail The e‐mail address to use when delivering documents to the partner, 
for example, “[email protected]”. 
Use as The delivery method that the partner prefers be used to deliver 
preferred documents to the partner’s system. If the Use as preferred protocol is not 
protocol selected for any delivery method, Trading Networks uses Queue for
Polling. 

If you select the Delivery Method “Queue for delivery”, displays the additional fields in the 
following table.

Note: You cannot select either the public or private queue as the preferred protocol.

webMethods Trading Networks Administrator’s Guide Version 7.1 120

 7. About Trading Partners

Queue for delivery

Field Description
Use Public Queue Indicates you are defining a delivery method to deliver documents 
to the partner by placing documents in a public scheduled 
delivery queue. A public queue is a queue that can contain 
documents for multiple receiving partners. For more information 
about public queues, see “Defining Public Queues” on page 413.
When use this delivery method, you select the name of the public 
queue you want Trading Networks to use.
Use Private Queue Indicates you are defining a delivery method to deliver documents 
to a private scheduled delivery queue. A private queue contains 
only documents for the partner defined by the profile.
When you use this delivery method, you must define the 
following fields as well:
Field Description

Delivery The delivery service to use for the private queue. 
Select the delivery service from the list. For more 
information, see “Adding and Registering New 
Delivery Services” on page 433.
In the Console, the field name is Delivery Service.
Inputs tab The inputs for the delivery service you selected.
In the Console, the corresponding field is the Set Inputs 
button.
State The state of the queue (Enable Queue, Drain Queue, 
Suspend Delivery, or Disable Queue). For more 
information about queue states, see “Scheduled 
Delivery Queue States” on page 408.
In the Console, the field name is Queue State.

webMethods Trading Networks Administrator’s Guide Version 7.1 121

 7. About Trading Partners

Queue for delivery

Field Description
Process The schedule of when Trading Networks is to invoke 
Queue the delivery service that will deliver documents from 
this queue. For more information, see “Delivery 
Schedule for Queues” on page 405. The available 
options are:
Run Once. Trading Networks executes the delivery 
service a single time. For more information, see 
“Using the Run Once Option” on page 406 
Simple Interval. Trading Networks executes the 
delivery service repeatedly at an interval you 
specify. For more information, see “Using the 
Fixed Interval Option” on page 407. 
Custom Interval. 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. For more information, see 
“Using a Custom Interval Option” on page 407.
In the Console, these fields are on the Schedule tab.

General Partner Delivery Settings

The following table lists the delivery settings fields that are not specific to any one 
delivery method and that Trading Networks uses only in partner profiles; these fields are 
not in your (Enterprise) profile.

Delivery Method
Tab Field Description
Delivery Maximum The number of times you want Trading Networks to attempt to 
Retries redeliver a document to the partner’s system. 
If you specify 0, Trading Networks attempts to redeliver a 
document five times. This is the default.

Note: Trading Networks uses the Delivery Maximum Retries, Wait

Between Retries, and Retry Factor for reliable delivery with 
immediate delivery methods.
Trading Networks uses also uses the Delivery Maximum Retries for 
scheduled delivery methods.

webMethods Trading Networks Administrator’s Guide Version 7.1 122

 7. About Trading Partners

Delivery Method
Tab Field Description
Wait Between The number of milliseconds (ms) you want Trading Networks to 
Retries wait before making its first attempt to redeliver the document to 
the partner’s system. Trading Networks uses the Retry Factor along 
with the Wait Between Retries value to calculate how long to wait for 
subsequent retry attempts.
If you specify 0, Trading Networks uses 20000 milliseconds (20 
seconds) for Wait Between Retries. This is the default.

Note: Trading Networks only uses the Wait Between Retries and Retry

Factor options for reliable delivery with immediate delivery 
methods. Trading Networks does not use the Wait Between Retries 
and Retry Factor settings for scheduled delivery because the 
queue’s delivery schedule dictates how often to retry delivery 
attempts.

Retry Factor 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. Trading Networks calculates the time to 
wait by multiplying the last wait time by Retry Factor. Specify a 
whole number greater than zero for Retry Factor. 
Example: The following shows sample values for the reliable 
delivery settings and how they affect the wait times between 
attempts to redeliver a document.
Delivery Maximum Retries =     3
Wait Between Retries =     10000 ms
Retry Factor =     2
Retry 1 Retry 2 Retry 3

Wait until next attempt 10000 ms 20000 ms 40000 ms

Note: For more information about reliable delivery, see “Using 
Reliable Delivery with Immediate Delivery Method” on page 367 
and “Using Reliable Delivery with Scheduled Delivery” on 
page 368.

webMethods Trading Networks Administrator’s Guide Version 7.1 123

 7. About Trading Partners

Delivery Method
Tab Field Description
Polling Method The method (e.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. Select the method 
from the list. If you do not want your Trading Networks system to 
poll for documents, select the blank entry.
Polling Frequency How often Trading Networks is to poll the partner’s system to 
retrieve documents that the partner has queued for your system. 
Specify a number of minutes that is zero or greater. If you specify 
zero, Trading Networks will not poll.

Note: Setting the polling frequency too low can have an adverse 
effect on Trading Networks performance.

Suspend delivery Whether you want Trading Networks to suspend delivery for this 

partner. When delivery is suspended, Trading Networks does not 
deliver documents to the partner. For documents where the 
partner is the receiving partner:
For immediate deliveries, the deliveries fail.

For deliveries that use reliable delivery or scheduled deliveries 
where the partner is the receiving partner, Trading Networks 
holds the delivery tasks until delivery is resumed for this 
partner. 
This field is not available in the Console.

Extended Fields
Trading Networks lists the extended fields that you define for profiles in the following 
locations:
In My webMethods on the Extended Fields tab of the Partner Profile page.

In Trading Networks Console on the Extended Fields tab of the Profile screen. 

Users
You can optionally associate one or more My webMethods users with a profile. The My 
webMethods user accounts associated with a profile are listed on the Users tab of a profile 
in My webMethods. 
When you associate a user account with the profile, the user account receives Trading 
Networks partner authority. This allows the partner that the profile defines to use the user 

webMethods Trading Networks Administrator’s Guide Version 7.1 124

 7. About Trading Partners

account to access your Trading Networks system. For example, when the partner sends a 
document to your Trading Networks system, the user can supply the user name and 
password of the user account associated with their profile.

Certificates
Trading Networks maintains partner certificates in the profile in the following locations. 
In My webMethods on the Certificates tab of the Partner Profile page.

In Trading Networks Console on the Security tab of the Profile screen. 
The following table lists the types of certificate information that you define:

Type Description
Sign/Verify Certificate information that Trading Networks uses to sign a 
document or verify the digital signature.
In the your (Enterprise) profile, you can supply a certificate 
information that Trading Networks uses to digitally sign 
documents that your enterprise sends to partners. Trading 
Networks digitally signs a document when the built‐in service 
wm.tn.doc:sign is invoked. For more information about this service, 
see the webMethods Trading Networks Built‐in Services Reference.
In a partner profile, Trading Networks uses the certificate 
information to verify the digital signature of documents that were 
digitally signed by the partner. Trading Networks verifies a 
digital signature when instructed to do so by the Verify Digital
Signature pre‐processing action. For more information, see 
“Verifying the Digital Signature of an XML Document” on 
page 256 and “Verifying the Digital Signature of Flat File 
Documents” on page 319.
If you include the private key in this certificate information, 
Trading Networks can also use this certificate information to 
digitally sign documents on behalf of the partner. You might have 
the private key if the profile describes an internal group, for 
example a department within your corporation

webMethods Trading Networks Administrator’s Guide Version 7.1 125

 7. About Trading Partners

Type Description
Encrypt/Decrypt Certificate information that Trading Networks uses to decrypt or 
encrypt information.
In the your (Enterprise) profile, you can supply a certificate 
information that Trading Networks uses to decrypt documents 
that your enterprise receives from partners.
In a partner profile, Trading Networks uses the certificate 
information to encrypt information that is being sent to a partner.
If you include the private key in this certificate information, this 
certificate information can also be used to decrypt documents that 
were encrypted with the partner’s public key. You might have the 
private key if the profile describes an internal group, for example 
a department within your corporation.
Trading Networks maintains this information for other webMethods 
components (e.g., webMethods RosettaNet Module) that take 
advantage of this feature. You can also add your own functionality 
that takes advantage of this certificate information. You can obtain the 
certification information by using built‐in services.
In the Console, this is referred to as Decrypt/Encrypt.

Note: Trading Networks does not check to see whether the CA that 
signed the certificate is included in the list of trusted CAs that the 
webMethods Integration Server maintains. For more information, see 
security information in webMethods Integration Server Administrator’s 
Guide.

SSL A certificate that enables Trading Networks to act as an SSL client to 
connect to a remote secure server.
In the Console, this is referred to as SSL Client.

webMethods Trading Networks Administrator’s Guide Version 7.1 126

 7. About Trading 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:

D Task For more information, see...

1 Set up the profile fields for  Chapter 8, “Defining and Managing Profile 
profiles Fields”
2 Create your own profile Chapter 9, “Defining and Managing Your 
Profile (Your Enterprise)”
3 Add partners by adding  Chapter 10, “Defining and Managing Partner 
their profiles to your  Profiles”
system

Profile Statuses
Profiles can have one of the statuses listed in the following table: 

Status Meaning
Active You have filled in the profile and Trading Networks has 
programmatically determined that all profile fields (standard and 
extended) are valid. You have enabled the profile to set the status 
to “Active”.
Your (Enterprise) profile must be enabled before you can exchange 
documents with partners. Additionally, if you enable a partner’s 
profile, you will be able to exchange documents with that partner.
Inactive You have disabled the profile.
Either you have just added the profile, but not yet enabled it, or 
you have disabled the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 127

 7. About Trading Partners

webMethods Trading Networks Administrator’s Guide Version 7.1 128

Chapter 8. Defining and Managing Profile Fields

What are Profile Fields? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Viewing Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Updating Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Adding Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Viewing Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Duplicating an Existing Profile Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Updating Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Disabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Enabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Note: This chapter describes how to define and manage profile fields using My 
webMethods. The same functionality in the Trading Networks Console is deprecated. If 
you need instructions for using the Console to define and manage profile fields, see 
Appendix G, “Managing Profile Fields Using the Console”. 

webMethods Trading Networks Administrator’s Guide Version 7.1 129

 8. Defining and Managing Profile Fields

What are Profile 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 fields that are provided out‐of‐the‐box and 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.
For more information, see “Standard Profile Fields” on page 130.
Extended fields are fields that you define to extend the standard profile. 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.
For more information, see “Extended Profile Fields” on page 137.

For more information about profile fields, see Chapter 2, ʺTrading Partnersʺ in the 

webMethods Trading Networks Concepts Guide

Required Fields
A required field is one that you want supplied for all profiles. Several of the standard 
fields, as defined out‐of‐the‐box, are required. Those that are not, you can mark as 
required if you want. When you add extended fields, you can mark them as required. All 
profiles on your system must have a value for required profile fields.
When you create your own profile or add a profile for a partner, you must supply 
information for all required fields before Trading Networks will allow you to enable the 
profile. When you are filling in a profile, Trading Networks places an asterisk (*) next to 
the required fields, so you can easily determine the fields that are required.

Standard Profile Fields

The standard profile fields are fields that are provided out‐of‐the‐box. Although Trading 
Networks has many standard fields, you can view and update only a subset of the 
standard fields.

webMethods Trading Networks Administrator’s Guide Version 7.1 130

 8. Defining and Managing Profile Fields

The following table lists the standard profile fields that you can update. For each field, the 
table lists a description of what each field is, how Trading Networks uses the field, and 
any consequences if a field is not included in a partner profile.

Standard Field Description

Corporation Name What it is: This field identifies the name of the corporation, for 
example, “Industrial Steel Company”. The following shows where 
it is located within the profile:
My webMethods Panel Field Name

Partner Details  Corporation Name

How it is used: Trading Networks uses this field (along with the Unit
Name, if specified) to identify your enterprise or a partner within 
the network. 
If not specified: Trading Networks will not have a name to use to 
identify for the partner.
Unit Name What it is: This field identifies a unit name or division name within 
the corporation, for example, “Sales and Marketing”. The 
following shows where it is located within the profile:
My webMethods Panel Field Name

Partner Details Organization Unit

How it is used: Trading Networks uses this field (along with the 
Corporation Name) to identify your enterprise or a partner within the 
network.
If not specified: Trading Networks will use only the Corporation Name 
for identification.
Preferred Language What it is: This field is used by other webMethods components (e.g., 
webMethods RosettaNet Module) for localization purposes. The 
following shows where it is located within the profile: 
My webMethods Panel Field Name

Partner Details Preferred Language

How it is used: Trading Networks does not use this information. It is 
maintained for other webMethods components.
If not specified: The information will not be available.

webMethods Trading Networks Administrator’s Guide Version 7.1 131

 8. Defining and Managing Profile Fields

Standard Field Description

Preferred Delivery What it is: This field identifies which delivery method the partner 
Method prefers to receive documents with. The following shows where it is 
located within the profile:
My webMethods tab Field Name

Delivery Settings tab Use as preferred protocol

How it is used: If a processing rule is configured to deliver a 
document using the preferred protocol, the partner’s delivery 
method that is selected as the preferred protocol will be used.
If not specified: The preferred protocol defaults to Queue for polling.
E-mail What it is: This field identifies an e‐mail address for a contact, for 
example, “[email protected]”. The following shows 
where it is located within the profile:
My webMethods tab Field Name

Contacts tab E-mail
How it is used: Trading Networks allows you to select a contact type 
in a processing rule for the Alert e-mail action. The Alert e-mail action 
instructs Trading Networks to send an e‐mail message to the 
contacts associated with the selected contact type. If the e‐mail 
address is not specified for a contact of the selected contact type, 
Trading Networks cannot send the e‐mail message to that contact. 
For more information on the Alert e-mail action in a processing rule, 
see “Action 2—Send an Alert E‐mail” on page 361.
If not specified: If the contact is referenced in the Alert e-mail action of 
a processing rule, Trading Networks will not be able to send an e‐
mail message. 
Fax What it is: This field identifies the fax number for a contact, for 
example, “1‐888‐555‐4897”. The following shows where it is 
located within the profile:
My webMethods tab Field Name

Contacts tab Fax
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

webMethods Trading Networks Administrator’s Guide Version 7.1 132

 8. Defining and Managing Profile Fields

Standard Field Description

First Name What it is: This field identifies the contactʹs first name. The following 
shows where it is located within the profile:
My webMethods tab Field Name

Contacts tab First Name

How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile.
Pager What it is: This field identifies the pager number for a contact, for 
example, “1‐330‐555‐7890”. The following shows where it is 
located within the profile:
My webMethods tab Field Name

Contacts tab Pager
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 
Role What it is: This field identifies the contactʹs job title, for example, 
“Trading Network Administrator”. The following shows where it 
is located within the profile:
My webMethods tab Field Name

Contacts tab Title
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile.
Last Name What it is: This field identifies the contactʹs last name. The following 
shows where it is located within the profile:
My webMethods tab Field Name

Contacts tab Last Name

How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 133

 8. Defining and Managing Profile Fields

Standard Field Description

Extension 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, use the Extension field to identify the contactʹs 
extension. The following shows where it is located within the 
profile:
My webMethods tab Field Name

Contacts tab Extension
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 
Telephone What it is: This field identifies the telephone number for a contact, 
for example, “1‐800‐555‐1234”. The following shows where it is 
located within the profile:
My webMethods tab Field Name

Contacts tab Telephone
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 
Address What it is: This field identifies the first line of the street address, for 
example, “595 Main Street”. The following shows where it is 
located within the profile:
My webMethods tab Field Name

Addresses tab Address
Contacts tab
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the Address as a required field, Trading Networks 

will require the Address field in all locations.

webMethods Trading Networks Administrator’s Guide Version 7.1 134

 8. Defining and Managing Profile Fields

Standard Field Description

AddressLine2 What it is: This field identifies the second line of the street address, 
for example, “Suite 556”. The following shows where it is located 
within the profile:
My webMethods tab Field Name

Addresses tab AddressLine2
Contacts tab
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the AddressLine2 as a required field, Trading 
Networks will require the AddressLine2 field in all locations.

AddressLine3 What it is: This field identifies the third line of the street address, for 

example, “ATTN Billing Department”. The following shows where 
it is located within the profile:
My webMethods tab Field Name

Addresses tab AddressLine3
Contacts tab
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the AddressLine3 as a required field, Trading 
Networks will require the AddressLine3 field in all locations.

webMethods Trading Networks Administrator’s Guide Version 7.1 135

 8. Defining and Managing Profile Fields

Standard Field Description

City What it is: This field identifies the city in an address, for example, 
“Los Angeles”. The following shows where it is located within the 
profile:
My webMethods tab Field Name

Addresses tab AddressLine3
Contacts tab
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the City as a required field, Trading Networks 
will require the City field in all locations.

Country What it is: This field identifies the country in an address, for 

example, “USA”. The following shows where it is located within 
the profile:
My webMethods tab Field Name

Addresses tab Country
Contacts tab
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the Country as a required field, Trading Networks 
will require the Country field in all locations.

webMethods Trading Networks Administrator’s Guide Version 7.1 136

 8. Defining and Managing Profile Fields

Standard Field Description

State/Province What it is: This field identifies the state or province in an address, 
for example, “California”. The following shows where it is located 
within the profile:
My webMethods tab Field Name

Addresses tab State/Province
Contacts tab
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the State/Province as a required field, Trading 
Networks will require the State/Province field in all locations.

Postal Code What it is: This field identifies the postal code (for example, ZIP 

code) for the state or province in an address, for example, “90001”. 
The following shows where it is located within the profile:
My webMethods tab Field Name

Addresses tab Postal Code

Contacts tab
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the Postal Code as a required field, Trading 

Networks will require the Postal Code field in all locations.

Extended Profile Fields

If after reviewing the standard profile you determine that you want to maintain additional 
information about partners, you can define extended profile fields.
When you define an extended profile field, you specify the following:
The name you want the extended profile field to have. 

The name of the profile field group that you want Trading Networks to assign to the 
profile field. Trading Networks provides the groups—Address, Corporation, Custom, 
Contact, Delivery, and External ID. You can add additional groups. 

webMethods Trading Networks Administrator’s Guide Version 7.1 137

 8. Defining and Managing Profile Fields

A description you want Trading Networks to display for the extended profile field. 

The data type of the extended profile field—string or binary.

The default value of the extended profile field. You can supply this information only if 
the data type is string.
The maximum length of the value that can be supplied for the profile field. You can 
supply this information only if the data type is string.
The valid values that can be supplied for the profile field. You can supply this 
information only if the data type is string.
You can change all information for an extended field, including its name. 

Important!  Use caution when changing fields from required to not required. If you have 
services that use the field or if you might create or update services that use the field, the 
information might not be available if the partner is not required to supply it.
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 updated 
extended profile fields. This is true even when the updated extended profile fields has a 
default value

Viewing Standard Profile Fields

To view the standard profile fields that Trading Networks allows you to update, perform 
the following procedure.

To view standard profile fields

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise or edit a partner profile.
3 Click Extended Fields tab in the profile you are viewing.
4 Click Manage Extended Fields. 
You will be prompted to save any changes you might have made to the profile you 
were viewing. To work with the extended fields, click Save and Proceed.
5 Click the Standard tab, if it not already selected.

webMethods Trading Networks Administrator’s Guide Version 7.1 138

 8. Defining and Managing Profile Fields

Updating Standard Profile Fields

Perform the following procedure to update information for standard profile fields. 

To update a standard profile field

1 View the standard fields. If you need procedures for this step, see “Viewing Standard 
Profile Fields” on page 138.

2 Click   in the ACTIONS column in the row containing the profile field you want to 
edit.
3 Update the field(s) you want to change: 

For this Standard

tab parameter... Specify...

Required Whether the profile field is required or not. Select the check 
box to make the field required. If you do not want it to be 
required, clear the check box.

Important! Use caution when changing fields from required to 
not required. Trading Networks uses some standard fields for 
its processing, so if you change a field so that it is not required 
and a partner opts to not supply that information, Trading 
Networks might be prevented from performing a function that 
you will require. 

To determine how Trading Networks uses each standard field 
and the effect of not specifying a field, see “Standard Profile 
Fields” on page 130.
Description The description you want the profile field to have. You can 
replace the current description or add more detail to it. 
You can specify 1‐1024 characters. You can specify any 
characters; there are no restrictions.

4 Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 139

 8. Defining and Managing Profile Fields

Adding Extended Profile Fields

To add an extended profile field to the profiles you maintain on your system, perform the 
following procedure. When you use this procedure, Trading Networks provides a blank 
form for you to use to fill in the details for the new profile field. If you want to add a field 
that is similar to an existing extended field, use the procedure in “Duplicating an Existing 
Profile Field” on page 142. When you duplicate an existing extended field, the form for 
the new field is pre‐filled with information from the field that you select to duplicate.

Note: If you already have profiles in your system and then add extended profile fields that 
are required, you must manually edit the existing profiles for the newly added extended 
profile fields. This is true even when you define default values for the added extended 
profile fields.

To add an extended profile field

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise or edit a partner profile.
3 Click Extended Fields tab in the profile you are viewing.
4 Click Manage Extended Fields. 
You will be prompted to save any changes you might have made to the profile you 
were viewing. To work with the extended fields, click Save and Proceed.
5 Click Add Extended Field.
6 Fill in the fields for the new extended field:

For this Extended

tab parameter... Specify...

Name The name you want to assign the new extended profile field. 
For example, if you send catalogs to clients and you want to 
maintain the type of catalog the partner is to receive, you 
might define an extended profile field named “Catalog Type”.
Specify 1‐32 characters. You can specify any characters; there 
are no restrictions.
Enabled Whether the profile field is enabled or disabled. To enable the 
profile field, select the Enabled check box. 
Required Whether the profile field is required or not. Select the check 
box to make the field required. If you do not want it to be 
required, clear the check box.

webMethods Trading Networks Administrator’s Guide Version 7.1 140

 8. Defining and Managing Profile Fields

For this Extended

tab parameter... Specify...

Group The group you want Trading Networks to assign the extended 
profile field to. 
To assign the field to an existing group, select a group 
from the list. 
To assign the field to a new group, in the Add New Group 
section of the dialog box, type the name in the Name field 
and click Add Group.
Description Optional. A description of the profile field. 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.
Specify 1‐1024 characters. You can specify any characters; 
there are no restrictions.
Data Type The data type of the profile field. Select either String or Binary 
from the list. If you specify String, you can specify a maximum 
length, default value, and valid values for the profile field. 
Maximum Length Optional. The maximum number of characters that you want 
to allow someone to specify for the profile field. If you do not 
specify a maximum length, there is no limit placed on the 
profile field. You can specify Maximum Length only when Data
Type is String.
Default Optional. The default value for a profile field. You can specify 
Default only when Data Type is String. 
Specify 1‐128 characters. You can specify any characters; there 
are no restrictions.
Valid Values Optional. These are values that you want Trading Networks to 
accept for this profile field. For each valid value, perform the 
following:

1. Click  .
2. Type in a valid value.

Note: If you need to remove a value that you added, click  .
If you specify valid values, Trading Networks displays a list of 
the values that can be selected when filling out a profile. You 
can specify Valid Values only when Data Type is String.

7 Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 141

 8. Defining and Managing Profile Fields

Viewing Extended Profile Fields

To view the extended profile fields that are defined on your system, perform the following 
procedure: 

To view extended profile fields

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise or edit a partner profile.
3 Click Extended Fields tab in the profile you are viewing.
4 Click Manage Extended Fields. 
You will be prompted to save any changes you might have made to the profile you 
were viewing. To work with the extended fields, click Save and Proceed.
5 Click the Extended tab, if it not already selected.

Duplicating an Existing Profile Field

In addition to adding a new extended field by filling in a blank form, as described in 
“Adding Extended Profile Fields” on page 140, you can also add a new field that is similar 
to an existing extended field. When you duplicate an existing extended field, the form for 
the new field is pre‐filled with information from the field that you select to duplicate.

To add a new extended profile field by duplicating an existing extended field

1 View the extended fields. If you need procedures for this step, see “Viewing Extended 
Profile Fields” on page 142.

2 Click   in the ACTIONS column in the row containing the profile field you want to 
duplicate.
3 In the Name field, supply a name for the new field.
4 Alter any of the rest of the fields for the new extended field. For a description, of what 
you can specify, see step 6 on page 140.
5 Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 142

 8. Defining and Managing Profile Fields

Updating Extended Profile Fields

You can change all information for an extended profile field, including its name.

Note: Use caution when changing fields from required to not required. If you have services 
that use the field or if you might create or update services that use the field, the 
information might not be available if the partner is not required to supply it.
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 updated 
extended profile fields. This is true even when the updated extended profile fields has a 
default value

To update an extended profile field

1 View the extended fields. If you need procedures for this step, see “Viewing Extended 
Profile Fields” on page 142.

2 Click   in the ACTIONS column in the row containing the profile field you want to 
edit.
3 Update the field(s) you want to change. For a description, of what you can specify, see 
step 6 on page 140.
4 Click OK.

Disabling Extended Profile Fields

If you no longer want to use an extended profile field, you can disable it. When you 
disable an extended profile field, Trading Networks no longer displays it in profiles. 
Trading Networks does not delete the field definition from the database or any 
information stored for the field in partner profiles.
Because the field is no longer displayed in profiles, if you create new profiles after 
disabling a field, the new profile will not contain information for the disabled field. Use 
caution when disabling fields. 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.

Note: To permanently remove the extended profile field from the database, your database 
administrator must remove it. Before you can remove the field, you must first remove all 
rows from the PartnerProfileField table that reference the profile field you want to delete. 

webMethods Trading Networks Administrator’s Guide Version 7.1 143

 8. Defining and Managing Profile Fields

To disable an extended profile field

1 View the extended fields. If you need procedures for this step, see “Viewing Extended 
Profile Fields” on page 142.

2 Click   in the ACTIONS column in the row containing the profile field you want to 
disable.
3 Clear the check box in the Enabled field.
4 Click OK.

Enabling Extended Profile Fields

If you disable an extended profile field and then later determine that you still need it, you 
can enable it. 
If the profile field you are enabling is a required field, you might need to take further 
action. If you added partner profiles while the profile field was disabled, the profiles that 
were added in the interim do not contain information for the required field. You will need 
to manually update the profiles to supply the missing information. For instructions on 
how to update a partner profile, see “Updating Your Profile” on page 148.
To enable an extended profile field, perform the following procedure.

Important! To perform this procedure, you must first perform the procedure described in 
“Disabling Extended Profile Fields” on page 143.

To disable an extended profile field

1 View the extended fields. If you need procedures for this step, see “Viewing Extended 
Profile Fields” on page 142.

2 Click   in the ACTIONS column in the row containing the profile field you want to 
disable.
3 Select the check box in the Enabled field.
4 Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 144

Chapter 9. Defining and Managing Your Profile (Your
Enterprise)

Creating Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Viewing Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Updating Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Enabling Your Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Disabling Your Profile—Changing the Status to Inactive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Note: This chapter describes how to define and manage your profile using My 
webMethods. The same functionality in the Trading Networks Console is deprecated. If 
you need instructions for using the Console to define and manage your profile, see 
Appendix H, “Managing Your Profile Using the Console”. 

webMethods Trading Networks Administrator’s Guide Version 7.1 145

 9. Defining and Managing Your Profile (Your Enterprise)

Creating Your Own Profile

The following procedure describes how to create your profile specifying the minimum 
fields to save. You can then add additional information to your profile. For descriptions 
for how to specify information on the all tabs of the profile, see “Updating Your Profile” 
on page 148.
Although this section describes how to create the base profile, then edit the profile to add 
additional information, you can add all information when creating the profile. You can 
make your changes to multiple tabs and save one time.

To create your base profile

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click Create My Enterprise.
Trading Networks displays a page that you use to fill in the fields for your profile.
3 In the Partner Details panel, fill in the following fields:

Field Specify...

Corporation The name of your corporation, for example, “Industrial Steel 
Name Company”.
Organization Optionally, the name of the organizational unit or division within 
Unit your corporation, for example, “Sales and Marketing”.
Status Whether you want your profile enabled or disabled.
To enable the profile, select Active.

To disable the profile, select Inactive.
Note: You should keep the profile Inactive until you have completed 
filling in all the information you require in a profile, for example, 
delivery methods, users, etc.
Preferred Optionally, the language preference you use if needed for another 
Language webMethods component (e.g., webMethods RosettaNet Module).

webMethods Trading Networks Administrator’s Guide Version 7.1 146

 9. Defining and Managing Your Profile (Your Enterprise)

4 Add at least one external ID to your profile. To add each external ID, perform the 
procedure below. Be sure to include an external ID type for each type of identification 
that you use in documents. You can specify an unlimited number of external ID types.
a Click the External IDs tab.
b If the external ID type you want to use is not yet available, perform the following 
to add it:
1 Click Add ID Type.
2 In the Type Name file, specify the name of the new external ID type.
3 Click OK.
c To add the external ID, click Add ID.
d Fill in the following fields:

Field Specify...

ID Type The external ID type you want to use.
Note: You can add multiple external IDs that use the same type.
ID Value The value of the external ID type. For example, if you selected DUNS 
and your D‐U‐N‐S number is 987654321, specify 987654321 for ID
Value. The maximum length you can specify for an external ID is 128 
characters.

e Click OK.
5 You can do one of the following:
Continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Viewing Your Profile

To view your profile, perform the following procedure.

To view your profile

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.

webMethods Trading Networks Administrator’s Guide Version 7.1 147

 9. Defining and Managing Your Profile (Your Enterprise)

Updating Your Profile

To update your profile, perform the following procedure. Fields that you must specify are 
marked with an asterisk (*):
“Updating Your Corporation Information” on page 149

“Managing Your External IDs” on page 149

“Managing Addresses for Your Corporation” on page 151

“Managing the Contacts in Your Profile” on page 152

“Managing Your Profile Group Memberships” on page 154

“Managing Delivery Methods in Your Profile” on page 154

“Managing Your Profiles Extended Fields” on page 156

“Managing the My webMethods Users Associated with Your Profile” on page 157

“Managing Security Information in Your Profile” on page 159

Note: Although the last step of each profile indicates that you should save the profile, you 
can edit several tabs of the profile before saving.

After you have completed your profile, you still might need to update it from time to 
time, for example, the following lists some reasons for updating your own partner profile:
Information about your corporation has changed (name, address, etc.).

Information for one of your contacts has changed, for example, the contactʹs e‐mail 
address has changed or possibly you have a new contact to replace an existing one.
You have changed the port number on which Trading Networks listens for incoming 
requests.
You have added extended profile fields that you need to fill in for your profile.

You want to change the default certificate that Trading Networks uses to digitally 
sign documents.

webMethods Trading Networks Administrator’s Guide Version 7.1 148

 9. Defining and Managing Your Profile (Your Enterprise)

Updating Your Corporation Information

You can add or change your corporation information.

To update the corporation information in your profile

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.
3 In the Partner Details panel, update any of the following fields:

Field Specify...

Corporation The name of your corporation, for example, “Industrial Steel 
Name Company”.
Organization The name of the organizational unit or division within your 
Unit corporation, for example, “Sales and Marketing”.
Status Whether you want your profile enabled or disabled.
To enable the profile, select Active.

To disable the profile, select Inactive.
Preferred The language preference you use if needed for another 
Language webMethods component (e.g., webMethods RosettaNet Module).

4 You can do one of the following:
Continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Managing Your External IDs

You can add, edit, and delete external IDs. Be sure to include an external ID type for each 
type of identification that you use in documents. You can specify an unlimited number of 
external ID types.

To update the external IDs in your profile

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.

webMethods Trading Networks Administrator’s Guide Version 7.1 149

 9. Defining and Managing Your Profile (Your Enterprise)

3 Click the External IDs tab.
4 To add an external ID:
a If the external ID type you want to use is not yet available, perform the following 
to add it:
1 Click Add ID Type.
2 In the Type Name file, specify the name of the new external ID type.
3 Click OK.
b To add the external ID, click Add ID.
c Fill in the following fields:

Field Specify...

ID Type The external ID type you want to use.
Note: You can add multiple external IDs that use the same type.
ID Value The value of the external ID type. For example, if you selected DUNS 
and your D‐U‐N‐S number is 987654321, specify 987654321 for ID
Value. The maximum length you can specify for an external ID is 
128 characters.

d Click OK.
5 To edit an external ID, change the information in the row containing the external ID 
that you want to update. You can:
Select a new external ID type from the ID TYPE list.
Type a new value in the VALUE field.
6 To delete an external ID:
a Select the check boxes beside the external IDs that you want to delete.
b Click Delete.
Note: Your profile must contain at least one external ID.
7 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 150

 9. Defining and Managing Your Profile (Your Enterprise)

Managing Addresses for Your Corporation

You can add, edit, and delete addresses for your corporation.

To update the addresses for your corporation

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.
3 Click the Addresses tab.
4 To add an address:
a Click Add Address.
b Fill in the following fields:

Field Specify...

Address The street address for your corporation, for example, “123 
Address Line 2 Main Street, Suite 456”.
Address Line 3
City The city where your corporation is located, for example, “Los 
Angeles”.
State/Province The state or province where your corporation is located, for 
example, “California”.
Postal Code The postal code (for example, a zip code) for the state or 
province where your corporation is located, for example, 
“90001”.
Country The country where your corporation is located, for example, 
“USA”.

c Click OK.
5 To edit an existing address:

a Click   in the EDIT column for the address you want to edit.
b Update the fields. For a description, see step 4b above.
c After updating the fields, click OK.
6 To delete an address:
a Select the check boxes beside the addresses that you want to delete.
b Click Delete.

webMethods Trading Networks Administrator’s Guide Version 7.1 151

 9. Defining and Managing Your Profile (Your Enterprise)

7 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Managing the Contacts in Your Profile

You can add contacts, edit contact information, or remove contacts from your profile.

To update the contacts in your profile

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.
3 Click the Contacts tab.
4 To add a contact:
a Click Add Contact.
b Fill in the following fields:

Field Specify...

Contact Type The type of contact, for example, “Administrative”. Select a 

contact type from the list.
Title The contact’s job title, for example, “Trading Network 
Administrator”.
Last Name The contactʹs last (surname) name.
First Name The contactʹs first (given) name.
E-Mail The contactʹs e‐mail address, for example, 
“[email protected]”.
Telephone The contactʹs telephone number, for example, 
“1‐800‐555‐1234”.
Extension The contactʹs extension number. If the telephone number in the 
Telephone field identifies the main line for the corporation, use 
the Extension field to identify the contactʹs extension. 
Pager The contactʹs pager number, for example, “1‐330‐555‐7890”.
Fax The contactʹs fax number, for example, “1‐888‐555‐4897”.

webMethods Trading Networks Administrator’s Guide Version 7.1 152

 9. Defining and Managing Your Profile (Your Enterprise)

Field Specify...

Country The country where your corporation is located, for example, 
“USA”.
Address The street address for the contact, for example, “123 Main 
Address Line 2 Street, Suite 456”.
Address Line 3
City The city where the contact is located, for example, “Los 
Angeles”.
State/Province The state or province where the contact is located, for example, 
“California”.
Postal Code The postal code (for example, a zip code) for the state or 
province where the contact is located, for example, “90001”.

c Click OK.
5 To edit a contact:

a Click   in the EDIT column for the address you want to edit.
b Update the fields. For a description, see step 4b above.
c After updating the fields, click OK.
6 To delete a contact:
a Select the check boxes beside the contacts that you want to delete.
b Click Delete.
7 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 153

 9. Defining and Managing Your Profile (Your Enterprise)

Managing Your Profile Group Memberships

You can add or remove your profile from profile groups.

Note: You can only associate profiles with a profile group if there are profile groups 
defined in the database. To add a new profile group, see “Defining a Profile Group” on 
page 198.

To mange your profile group membership

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.
3 Click the Profile Group Membership tab.
4 Add your profile to profile groups, identify the profile groups you want your profile a 
member of by moving the groups from the AVAILABLE GROUPS list to the GROUPS THIS
PARTNER BELONGS TO list.
5 Remove your profile from profile groups that you no longer want to be a member of 
by moving the groups from the GROUPS THIS PARTNER BELONGS TO list to the 
AVAILABLE GROUPS list.
6 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Managing Delivery Methods in Your Profile

You can add, edit, or delete delivery methods. Delivery methods specify how partners are 
to deliver documents to your Trading Networks system. The Deliver document processing 
action uses the settings on the Delivery Settings tab. 

To update delivery methods in your profile

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.
3 Click the Delivery Settings tab.

webMethods Trading Networks Administrator’s Guide Version 7.1 154

 9. Defining and Managing Your Profile (Your Enterprise)

4 To add a delivery method to your profile:
a Click Add Delivery Method.
b Select the delivery method you want to add to from the Delivery Method list.
Trading Networks redisplays the dialog listing the field required for the selected 
method.
c Fill in the following fields:

Delivery Methods Field Specify...

Primary FTP Host The host name or IP address of your system, for 

Primary FTPS example, “IndustrialSteel.com”.
Primary HTTP
Port The port number on which your system listens 
Primary HTTPS
for incoming requests, for example, “5555”.
Secondary FTP
Secondary FTP Note: If you do not supply a port number, 
Secondary HTTP Trading Networks uses the following defaults: 
Secondary HTTPS HTTP—80; HTTPS—443; FTP or FTPS—21.
Location Where to deliver documents when using this 
delivery method.
For HTTP or HTTPS, specify the URL partners 
should use to send documents to your 
system via HTTP or HTTPS. This is typically 
the following:
/invoke/wm.tn/receive 

For FTP or FTPS, specify a directory path on 

the machine identified by Host and Port to 
which your partners should deliver 
documents. 
Primary E-mail E-mail The e‐mail address to which you want a partner 
Secondary E-mail to deliver documents, for example, 
“[email protected]”

d If you prefer that partners use this delivery method to deliver documents to your 
Trading Networks system, select the Use as preferred protocol check box.
If the Use as preferred protocol is not selected for any delivery method, Trading 
Networks uses the Queue for polling delivery method.
e Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 155

 9. Defining and Managing Your Profile (Your Enterprise)

5 To edit a delivery method:

a Click   in the EDIT column for the delivery method you want to edit.
b Update the fields. For a description, see step 4c above.
c If you prefer that partners use this delivery method to deliver documents to your 
Trading Networks system, select the Use as preferred protocol check box.
If the Use as preferred protocol is not selected for any delivery method, Trading 
Networks uses the Queue for polling delivery method.
d After updating the fields, click OK.
6 To delete a delivery method:
a Select the check boxes beside the delivery methods that you want to delete.
b Click Delete.
7 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Managing Your Profiles Extended Fields

You can edit the values for the extended fields.

To update extended field values in your profile

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.
3 Click the Extended Fields tab.
4 Update the values for any of the extended fields.
Note: If you do not know what to specify for an extended field and the description 
does not indicate what to specify, contact your Trading Networks administrator to 
determine what to specify. 

webMethods Trading Networks Administrator’s Guide Version 7.1 156

 9. Defining and Managing Your Profile (Your Enterprise)

5 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Managing the My webMethods Users Associated with Your

Profile
You can associate one or more My webMethods user accounts with your profile. For more 
information about how Trading Networks works with My webMethods user accounts, 
see “Central User Management—How Integration Server Authorizes My webMethods 
Users” on page 62.
To associate a My webMethods user account, you can have Trading Networks:
Define a new My webMethods user account where you specify the user name and 
password and associate that user account with your profile
Associate an existing My webMethods user account with your profile

Define a new My webMethods user account where Trading Networks uses the values 
of one of the external IDs defined in your profile as the user name for the account and 
then associate that user account with your profile.

To manage the My webMethods user accounts associated with your profile

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.
3 Click the Users tab.
4 To add a new My webMethods user account where you specify the user name and 
password and associate that user account with your profile:
a Click Add Users.
b Select Add new user.

webMethods Trading Networks Administrator’s Guide Version 7.1 157

 9. Defining and Managing Your Profile (Your Enterprise)

c In the User Information section of the dialog, fill in the following fields:

Field Specify...

User name The user name that you want to assign to the user you are adding.

The user ID can be 1 through 255 characters and can contain only 
alphanumeric ASCII characters with no spaces. The user ID is not 
case sensitive.
Note: My webMethods Server adds the user ID to the internal 
system directory service using the case you specify. My 
webMethods Server typically regards user IDs as case‐insensitive; 
however, My webMethods Server uses the case you specify for 
actions that are case‐sensitive, for example, HTTP authentication.
Password The password for the new user.
Confirm The same password you specified in the Password field.
Password

d Click OK.
5 To associate an existing My webMethods user account with your profile:
a Select Add existing user.
b In the Search for Available Users, specify a single keyword that is contained in the 
first name, last name, e‐mail address, or user name of the user account that you 
want to associate with the profile.
c Click Go.
d To associate users with your profile, move the users from the AVAILABLE USERS to 
the SELECTED USERS list.
e Click OK.
6 To add a new My webMethods user account where you use the value of one of your 
external IDs as the user name for the user account and associate that user account 
with your profile:
a Select Add user from external ID.
b Select the external ID you want to use from the External ID list.

webMethods Trading Networks Administrator’s Guide Version 7.1 158

 9. Defining and Managing Your Profile (Your Enterprise)

c In the User Information section of the dialog, fill in the following fields:

Field Specify...

External ID The external ID you want to use.
Note: The value for the external ID must be 1 through 255 
characters and can contain only alphanumeric ASCII characters 
with no spaces. 
Note: The user ID is not case sensitive; however, My webMethods 
Server adds the user ID to the internal system directory service 
using the case used for the external ID value. My webMethods 
Server uses this case for actions that are case‐sensitive, for 
example, HTTP authentication.
Password The password for the new user.
Confirm The same password you specified in the Password field.
Password

d Click OK.
7 To remove My webMethods user accounts that are associated with your profile.
a Select the check boxes beside the user accounts that you want to delete.
b Click Remove.
Note: Trading Networks does not delete the user accounts. 
8 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Managing Security Information in Your Profile

You can:
Add certificate sets

Manage certificates and private keys in existing certificate sets

Delete certificate sets
When you add a certificate, be sure also to add the CA certificate(s) and private key that 
are associated with the certificate. The certificates, CA certificates, and private keys must 
reside in your file system. Trading Networks can import files that have a .der, .cer, or .p7b 

webMethods Trading Networks Administrator’s Guide Version 7.1 159

 9. Defining and Managing Your Profile (Your Enterprise)

extension. If you import a .der file, Trading Networks appends it to the existing certificate 
chain list. However, if you import a .cer or .p7b file, Trading Networks replaces the 
certificate chain list with the .cer or .p7b file.
Likewise, if you add a private key, be sure also to add the certificate and CA certificate(s) 
that are associated with the private key.

Adding Certificate Sets

You can add certificate sets that Trading Networks uses during processing.

Add this type of

certificate set... To…
SSL Client Enable Trading Networks to act as an SSL client to connect to a 
remote secure server.
Decrypt/Encrypt Decrypt documents that your Enterprise receives from partners.
Sign/Verify Digitally sign documents that your Enterprise sends to partners.

When looking for a certificate set to use, Trading Networks first looks for a certificate set 
associated with a specific partner. For example, if Trading Networks needs to digitally 
sign a document to send to partner A, it first looks in your profile to determine whether 
you have a certificate set for partner A. If you do, Trading Networks uses those 
Sign/Verify certificates. If it does not have a set of certificates for the specific partner, 
Trading Networks uses the Default certificate set.

To add certificate sets to your profile

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.
3 Click the Certificates tab.
4 To add the default certificate set:

a Under the Default branch of the tree on the Certificates tab, click   in the EDIT 
column for the certificates a you want to add (SSL, Encrypt/Decrypt, or Sign/Verify).
b To add the private key, click Browse and use the Choose File dialog box to select 
the private key file.
c To add a certificate, click Add Certificate, then click Browse and use the Choose File 
dialog box to select the certificate file.
d Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 160

 9. Defining and Managing Your Profile (Your Enterprise)

5 To add certificate sets that you want Trading Networks to use when with specific 
partners:
a Click Add Certificate Set.
b Use the search panel to search for the partners you want to add certificate sets for. 
For instructions for how to search for the partner profiles:
Keyword searches, see “Performing a Keyword Search for Partner Profiles” 
on page 169
Advanced search, see “Performing an Advanced Search for Partner Profiles” 
on page 170
Saved search, see the Getting Started with My webMethods guide
Trading Networks populates the AVAILABLE PARTNERS list with the results of 
your search.
c Select the profiles that you want to add certificate sets for by moving the profiles 
from the AVAILABLE PARTNERS list to the SELECTED PARTNERS list.
d Click OK.
Trading Networks adds a branch to the tree for each partner you selected.
e For each partner, perform the following to add a certificate set for that partner:
1 Expand the tree for the partner.

2 Click   in the EDIT column for the certificates you want to add (SSL, 
Encrypt/Decrypt, or Sign/Verify).
3 To add the private key, click Browse and use the Choose File dialog box to 
select the private key file.
Note: If you add a private key, be sure also to add the certificate and CA 
certificate(s) that are associated with the private key.
4 To add a certificate, click Add Certificate; then click Browse and use the Choose 
File dialog box to select the certificate file.
5 Click OK.
6 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 161

 9. Defining and Managing Your Profile (Your Enterprise)

Managing Certificate Sets

You can add new certificates to or remove certificates from existing certificate sets. 
Additionally, you can add private keys to or remove private keys from existing certificate 
sets.

To manage certificate sets

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.
3 Click the Certificates tab.
4 Expand the branch for the certificate set that you want to work with.

5 Click   in the EDIT column for the certificates you want to update (SSL, 
Encrypt/Decrypt, or Sign/Verify).
6 To remove the private key, select the Clear Private Key check box.
7 To add or update the private key, click Browse and use the Choose File dialog box to 
select the private key file.
8 To add a new certificate:
a To add a certificate, click Add Certificate; then click Browse and use the Choose File 
dialog box to select the certificate file.
b Click OK.

9 To remove a certificate, in the Certificates section of the screen, click   in the REMOVE 
column for the certificate you want to remove.
10 Click OK.
11 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 162

 9. Defining and Managing Your Profile (Your Enterprise)

Enabling Your Profile—Changing the Status to Active

Before you can exchange documents with partners, you must enable your profile by 
updating your status to “Active”. Enabling your profile allows you to exchange 
documents with partners. When you enable your profile, Trading Networks changes the 
status of the profile to “Active”. 
For more information about statuses, see “Profile Statuses” on page 127.

To enable your profile

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.
3 In the Partner Details panel, select Active from the Status list.
4 You can do one of the following:
Continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Disabling Your Profile—Changing the Status to Inactive

When you disable your profile, Trading Networks changes the status of your profile to 
“Inactive”. As a result, you will not be able to exchange documents with your partners. 
For more information about statuses, see “Profile Statuses” on page 127.

To disable your profile

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click My Enterprise.
3 In the Partner Details panel, select Inactive from the Status list.
4 You can do one of the following:
Continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 163

 9. Defining and Managing Your Profile (Your Enterprise)

webMethods Trading Networks Administrator’s Guide Version 7.1 164

Chapter 10. Defining and Managing Partner Profiles

Adding Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Searching for Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Viewing Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Updating Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Copying a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Suspending Delivery for a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Deleting a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Disabling a Partner’s Profile—Changing the Status to Inactive . . . . . . . . . . . . . . . . . . . . . . . . 193

Enabling a Partner’s Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Searching for Certificates that Are Expired or Expiring Soon . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Note: This chapter describes how to define and manage partner profiles using My 
webMethods. The same functionality in the Trading Networks Console is deprecated. If 
you need instructions for using the Console to define and manage partner profiles, see 
Appendix I, “Managing Partner Profiles Using the Console”. 

webMethods Trading Networks Administrator’s Guide Version 7.1 165

 10. Defining and Managing Partner Profiles

Adding Partner Profiles

If you are using Trading Networks, you can add as many partners as you want. If you are 
using webMethods for Partners and do not already have a partner, you can add a single 
partner; webMethods for Partners allows you to maintain only a single partner. When you 
add a profile, you are adding a partner to your network.
Before you can create partner profiles, fulfill the following prerequisites:

Prerequisite
1 Create and enable your Enterprise profile. For instructions, see “Creating Your Own 
Profile” on page 146 and “Enabling Your Profile—Changing the Status to Active” 
on page 163.
2 Review the fields you need to fill out for partner profiles.
3 For each partner, obtain the partner information that you require in the profiles on 
your system and have this information available when you create the profile.

Perform the procedure in this section to add a partner profile and fill in the minimum 
fields to create the profile. For instructions for how to add additional information to the 
profile, see “Updating Partner Profiles” on page 171. Although this section describes how 
to create the base profile, then edit the profile to add additional information, you can add 
all information when creating the profile. You can make your changes to multiple tabs 
and save one time.
If you want to add a partner profile that is similar to an existing profile, use the procedure 
in “Copying a Partner Profile” on page 190. When you copy an existing profile, the form 
for the new profile is pre‐filled with information from the profile that you select to copy.

To create a base partner profile

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click Add Profile.
Trading Networks displays a page that you use to fill in the fields for the profile.
3 In the Partner Details panel, fill in the following fields:

Field Specify...

Corporation The name of the partner’s corporation, for example, “Industrial 
Name Steel Company”.
Organization Optionally, the name of the organizational unit or division within 
Unit the corporation, for example, “Sales and Marketing”.

webMethods Trading Networks Administrator’s Guide Version 7.1 166

 10. Defining and Managing Partner Profiles

Field Specify...

Status Whether you want the profile enabled or disabled.
To enable the profile, select Active.

To disable the profile, select Inactive.
Note: You should keep the profile Inactive until you have completed 
filling in all the information you require in a profile, for example, 
delivery methods, users, etc.
Preferred Optionally the language preference the partner uses if needed for 
Language another webMethods component (e.g., webMethods RosettaNet 
Module).

4 Add at least one external ID to the profile. To add each external ID, perform the 
procedure below. Be sure to include an external ID type for each type of identification 
that the partner uses in documents. You can specify an unlimited number of external 
ID types.
a Click the External IDs tab.
b If the external ID type you want to use is not yet available, perform the following 
to add it:
1 Click Add ID Type.
2 In the Type Name file, specify the name of the new external ID type.
3 Click OK.
c To add the external ID, click Add ID.
d Fill in the following fields:

Field Specify...

ID Type The external ID type you want to use.
Note: You can add multiple external IDs that use the same type.
ID Value The value of the external ID type. For example, if you selected DUNS 
and your D‐U‐N‐S number is 987654321, specify 987654321 for ID
Value. The maximum length you can specify for an external ID is 128 
characters.

e Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 167

 10. Defining and Managing Partner Profiles

5 You can do one of the following:
Continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Searching for Partner Profiles

The following table lists tasks related to searching for partner profiles and where to find 
more information about each task.

Task For more information, see...

Search for partner profiles with corporation  “Performing a Keyword Search for 
names and external IDs that contain  Partner Profiles” on page 169
keywords that you specify.
Perform a detailed search for partner  “Performing an Advanced Search for 
profiles. Partner Profiles” on page 170
Set the following search options for the  Getting Started with My webMethods 
Administration > Integration > B2B >  guide
Partner Profiles page:
The search tab that Trading Networks 
displays when initially displaying the 
Partner Profiles page
The search you want Trading Networks 
to execute, if any, when initially 
displaying the Partner Profiles page
The maximum number of search results 
you want Trading Networks to display 
in response to a search

webMethods Trading Networks Administrator’s Guide Version 7.1 168

 10. Defining and Managing Partner Profiles

Task For more information, see...

Set the following display options for how  Getting Started with My webMethods 
Trading Networks displays search results  guide
on the Administration > Integration > B2B > 
Partner Profiles page:
The number of rows that you want 
Trading Networks to display on each 
page of the search results
How the search results are sorted

The columns displayed and the order of 
the columns
Save searches for partner profiles. Getting Started with My webMethods 
guide
Re‐execute saved searches for partner  Getting Started with My webMethods 
profiles. guide

Performing a Keyword Search for Partner Profiles

Use a keyword search to find partner profiles based on their corporation names and 
external IDs. 

To perform a keyword search for partner profiles

1 In My webMethods: Administration > Integration > B2B > Partner Profiles

2 Click the Keyword tab if it is not already displayed.
3 In the text box, type a keyword. The search will find all profiles that contain the 
keyword in an external ID value or the corporation name. The search is case 
insensitive.
When typing a keyword, you can use the following wildcard characters:

* to match zero or more characters
? to match a single character

If you separate keywords with a space, Trading Networks searches for profiles where 
the keywords are in either the external IDs or the corporation name; however, both 
keywords must be present for Trading Networks to find a match. For example, if you 
specify abc corp, Trading Networks would return a profile with an external ID value 
that is abc and the corporation name is corp. However, if neither the external IDs nor 

webMethods Trading Networks Administrator’s Guide Version 7.1 169

 10. Defining and Managing Partner Profiles

the corporation name contain abc, even if the corp name is corp, Trading Networks 
would not return the profile because the keyword abc is not present. 
If you put the keywords in quotes, Trading Networks searches for profiles where all 
keywords are in either the external ids and/or corporation name. For example, if you 
specify “abc corp”, Trading Networks returns profiles where the external IDs 
contain abc corp and/or where the corporation name contains abc corp.
If you leave the text box blank, Trading Networks searches for all partner profiles that 
you are authorized to view. For more information about how to specify keywords, see 
the Getting Started with My webMethods guide.
4 Click Go to execute the search.

Performing an Advanced Search for Partner Profiles

Use an advanced search to specify detailed criteria to search for specific partner profiles.

To perform an advanced search for partner profiles

1 In My webMethods: Administration > Integration > B2B > Partner Profiles.

2 Click the Advanced tab if it is not already displayed.
3 In the text box, optionally type a keyword that is contained in the corporation names 
and external IDs of the profiles you want to find. For more information about how to 
specify the keyword, see step 3 in “Performing a Keyword Search for Partner Profiles” 
on page 169.
For more information about how to specify keywords, see the Getting Started with My 
webMethods guide.
4 Specify one or more filters. For each filter:
a Select a search field from the FIELD NAME list.
b Select the operator you want to use to compare the field from the OPERATOR list.
c Specify the value you want to use in the comparison in the VALUE field.
d If you want to add another filter, click Add and repeat step 4.
If you do not want to add another filter, continue with step 5.

webMethods Trading Networks Administrator’s Guide Version 7.1 170

 10. Defining and Managing Partner Profiles

5 Specify whether Trading Networks is to search for profiles that match all of the search 
criteria or search for profiles that match any of the criteria that you specify.
To specify that Trading Networks is to match all criteria, select AND from the 
Search Condition list.
To specify that Trading Networks is to match any of the criteria, select OR from 
the Search Condition list.
Note: If you specify multiple criteria for a single field, when forming the query to 
search for profiles, Trading Networks always uses an OR condition between each 
criteria, regardless of what you specify for the Search Condition field. 
6 Click Go to execute the search.

Viewing Partner Profiles

To view a partner profile, perform the following procedure.

To view a partner profile

1 Search for the profile you want to view. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To view the profile, click   in the ACTION column. 

Updating Partner Profiles

To update a partner profile, perform the following procedure. Fields that you must 
specify are marked with an asterisk (*):
“Updating the Corporation Information in a Partner Profile” on page 172

“Managing External IDs in a Partner Profile” on page 173

“Managing Addresses for the Corporation in a Partner Profile” on page 174

“Managing Contacts in a Partner Profile” on page 175

“Managing the Partner Profile Group Memberships” on page 177

“Managing Reliable Delivery and Polling Settings in a Partner Profile” on page 178

“Managing Delivery Methods in a Partner Profile” on page 180

“Updating Extended Fields in a Partner Profile” on page 183

webMethods Trading Networks Administrator’s Guide Version 7.1 171

 10. Defining and Managing Partner Profiles

“Managing the My webMethods Users Associated with the Partner’s Profile” on 
page 184
“Managing Security Information in Your Profile” on page 186

Note: Although the last step of each profile indicates that you should save the profile, you 
can edit several tabs of the profile before saving.

Updating the Corporation Information in a Partner Profile

You can add or change the corporation information.

To update the corporation information in a profile

1 Search for the profile you want to update. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 In the Partner Details panel, update any of the following fields:

Field Specify...

Corporation The name of the partner’s corporation, for example, “Industrial 
Name Steel Company”.
Organization The name of the organizational unit or division within the partner’s 
Unit corporation, for example, “Sales and Marketing”.
Status Whether you want the profile enabled or disabled.
To enable the profile, select Active.

To disable the profile, select Inactive.
Preferred The language preference the partner uses if needed for another 
Language webMethods component (e.g., webMethods RosettaNet Module).

4 You can do one of the following:
Continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 172

 10. Defining and Managing Partner Profiles

Managing External IDs in a Partner Profile

You can add, edit, and delete external IDs. Be sure to include an external ID type for each 
type of identification that the partner uses in documents. You can specify an unlimited 
number of external ID types.

To update external IDs for a partner profile

1 Search for the profile you want to update. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 Click the External IDs tab.
4 To add an external ID:
a If the external ID type you want to use is not yet available, perform the following 
to add it:
1 Click Add ID Type.
2 In the Type Name file, specify the name of the new external ID type.
3 Click OK.
b To add the external ID, click Add ID.
c Fill in the following fields:

Field Specify...

ID Type The external ID type you want to use.
Note: You can add multiple external IDs that use the same type.
ID Value The value of the external ID type. For example, if you selected DUNS 
and your D‐U‐N‐S number is 987654321, specify 987654321 for ID
Value. The maximum length you can specify for an external ID is 
128 characters.

d Click OK.
5 To edit an external ID, change the information in the row containing the external ID 
that you want to update. You can:
Select a new external ID type from the ID TYPE list.
Type a new value in the VALUE field.

webMethods Trading Networks Administrator’s Guide Version 7.1 173

 10. Defining and Managing Partner Profiles

6 To delete an external ID:
a Select the check boxes beside the external IDs that you want to delete.
b Click Delete.
Note: The profile must contain at least one external ID.
7 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Managing Addresses for the Corporation in a Partner Profile

You can add, edit, and delete addresses for the corporation.

To update the addresses for a corporation in a profile

1 Search for the profile you want to update. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 Click the Addresses tab.
4 To add an address:
a Click Add Address.
b Fill in the following fields:

Field Specify...

Address The street address for the partner’s corporation, for example, 
Address Line 2 “123 Main Street, Suite 456”.
Address Line 3
City The city where the partner’s corporation is located, for 
example, “Los Angeles”.
State/Province The state or province where the partner’s corporation is 
located, for example, “California”.

webMethods Trading Networks Administrator’s Guide Version 7.1 174

 10. Defining and Managing Partner Profiles

Field Specify...

Postal Code The postal code (for example, a zip code) for the state or 

province where the partner’s corporation is located, for 
example, “90001”.
Country The country where the partner’s corporation is located, for 
example, “USA”.

c Click OK.
5 To edit an existing address:

a Click   in the EDIT column for the address you want to edit.
b Update the fields. For a description, see step 4b above.
c After updating the fields, click OK.
6 To delete an address:
a Select the check boxes beside the addresses that you want to delete.
b Click Delete.
7 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Managing Contacts in a Partner Profile

You can add, edit, or delete contacts. You can specify an unlimited number of contacts. 

To update contacts for a partner profile

1 Search for the profile you want to update. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 Click the Contacts tab.

webMethods Trading Networks Administrator’s Guide Version 7.1 175

 10. Defining and Managing Partner Profiles

4 To add a contact:
a Click Add Contact.
b Fill in the following fields:

Field Specify...

Contact Type The type of contact, for example, “Administrative”. Select a 

contact type from the list.
Title The contact’s job title, for example, “Trading Network 
Administrator”.
Last Name The contactʹs last (surname) name.
First Name The contactʹs first (given) name.
E-Mail The contactʹs e‐mail address, for example, 
“[email protected]”.
Telephone The contactʹs telephone number, for example, 
“1‐800‐555‐1234”.
Extension The contactʹs extension number. If the telephone number in the 
Telephone field identifies the main line for the corporation, use 
the Extension field to identify the contactʹs extension. 
Pager The contactʹs pager number, for example, “1‐330‐555‐7890”.
Fax The contactʹs fax number, for example, “1‐888‐555‐4897”.
Country The country where your corporation is located, for example, 
“USA”.
Address The street address for the contact, for example, “123 Main 
Address Line 2 Street, Suite 456”.
Address Line 3
City The city where the contact is located, for example, “Los 
Angeles”.
State/Province The state or province where the contact is located, for example, 
“California”.
Postal Code The postal code (for example, a zip code) for the state or 
province where the contact is located, for example, “90001”.

c Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 176

 10. Defining and Managing Partner Profiles

5 To edit a contact:

a Click   in the EDIT column for the address you want to edit.
b Update the fields. For a description, see step 4b above.
c After updating the fields, click OK.
6 To delete a contact:
a Select the check boxes beside the contacts that you want to delete.
b Click Delete.
7 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Managing the Partner Profile Group Memberships

You can add or remove the profile from profile groups.

Note: You can only associate profiles with a profile group if there are profile groups 
defined in the database. To add a new profile group, see “Defining a Profile Group” on 
page 198.

To update the profile group membership for the profile

1 Search for the profile you want to update. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 Click the Profile Group Membership tab.
4 Add the partner profile to profile groups, identify the profile groups by moving the 
groups from the AVAILABLE GROUPS list to the GROUPS THIS PARTNER BELONGS TO list.
5 Remove the partner profile from profile groups that you no longer want it to be a 
member of by moving the groups from the GROUPS THIS PARTNER BELONGS TO list to 
the AVAILABLE GROUPS list.

webMethods Trading Networks Administrator’s Guide Version 7.1 177

 10. Defining and Managing Partner Profiles

6 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Managing Reliable Delivery and Polling Settings in a Partner

Profile
Trading Networks uses reliable delivery settings when delivering documents to a partner 
and reliable delivery is being used. For more information about reliable delivery, see 
“Using Reliable Delivery with Immediate Delivery Method” on page 367 and “Using 
Reliable Delivery with Scheduled Delivery” on page 368. 
Trading Networks uses the polling settings to polling for documents that are waiting in 
the partner’s system.

To update reliable delivery and polling settings in a partner profile

1 Search for the profile you want to update. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 Click the Delivery Settings tab.
Note: You can also use the Delivery Settings tab to manage delivery methods. For more 
information, see “Managing Delivery Methods in a Partner Profile” on page 180.
4 Update the following reliable delivery settings using the following fields:

Field Description

Delivery Maximum Retries The number of times you want Trading Networks to 

attempt to re‐deliver a document to the partner when 
Trading Networks is using reliable delivery. Specify a 
whole number.
Note: The Delivery Maximum Retries, Wait Between Retries, 
and Retry Factor options are only used when Trading 
Networks is using reliable delivery (delivery tasks). The 
Delivery Maximum Retries option is used for both 
immediate and scheduled delivery methods.

webMethods Trading Networks Administrator’s Guide Version 7.1 178

 10. Defining and Managing Partner Profiles

Field Description

Wait Between Retries 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. Trading Networks uses the Retry Factor along 
with the Wait Between Retries value to calculate how long 
to wait for subsequent retry attempts.
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). 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.
Retry Factor 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. 
Trading Networks calculates the time to wait by 
multiplying the last wait time by Retry Factor. Specify a 
whole number greater than zero for Retry Factor.

5 Update the following polling settings:

Field Description

Polling Method The method (e.g., Primary HTTP) that your Trading 

Networks system uses to contact the partner’s system to 
request queued documents. Select the method from the 
list.
Note: If you do not want your Trading Networks system 
to poll for documents, select the blank entry.
Polling Frequency How often in minutes you want your Trading Networks 
to poll the partner’s system for documents.

6 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 179

 10. Defining and Managing Partner Profiles

Note: For more information about the Suspend Delivery check box, see “Suspending 

Delivery for a Partner” on page 191.

Managing Delivery Methods in a Partner Profile

You can add, edit, or delete delivery methods. Delivery methods specify how your 
Trading Networks system delivers documents to the partner associated with a profile. 
The Deliver document processing action uses the settings on the Delivery Method tab. For 
more information about the Deliver Document By processing action, see “Action 4—Deliver 
the Document to the Receiver” on page 365.

To update delivery methods for a partner profile

1 Search for the profile you want to update. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 Click the Delivery Settings tab.
Note: You can also use the Delivery Settings tab to manage reliable delivery and polling 
settings. For more information, see “Managing Reliable Delivery and Polling Settings 
in a Partner Profile” on page 178.
4 To add a delivery method to your profile:
a Click Add Delivery Method.
b Select the delivery method you want to add to from the Delivery Method list.
Trading Networks redisplays the dialog listing the field required for the selected 
method.

webMethods Trading Networks Administrator’s Guide Version 7.1 180

 10. Defining and Managing Partner Profiles

c Fill in the following fields:

Delivery Methods Field Specify...

Primary FTP Host The host name of the partner’s system, for 

Primary FTPS example, “IndustrialSteel.com”.
Primary HTTP
Port The port number on which the partner’s system 
Primary HTTPS
listens for incoming requests, for example, 
Secondary FTP
“5555”.
Secondary FTP
Secondary HTTP Note: If you do not supply a port number, 
Secondary HTTPS Trading Networks uses the following defaults: 
HTTP—80; HTTPS—443; FTP or FTPS—21.
Location Where to deliver documents when using this 
delivery method.
For HTTP or HTTPS, specify the URL Trading 
Networks is to use when sending a 
document to the partner’s system, for 
example, “cgi‐bin/acceptOrder”. If the 
partner is using Trading Networks, this is 
typically the following:
/invoke/wm.tn/receive 

For FTP or FTPS, specify the directory path 

on the partner’s system identified by Host 
and Port. Trading Networks delivers the 
document to this directory.
User The user name that your Trading Networks 
Name system is to supply when connecting to the 
partner’s system to deliver documents.
The user account can be either an Integration 
Server user account or My webMethods user 
account; however, it must be a user account that 
has partner authority; that is, a member of the 
TNPartners IS group.
Note: If you do not know what to specify for 
User Name, contact the partner.
Password The password that your Trading Networks 
system is to supply (along with User Name) 
when connecting to the partner’s system.

webMethods Trading Networks Administrator’s Guide Version 7.1 181

 10. Defining and Managing Partner Profiles

Delivery Methods Field Specify...

Primary E-mail E-mail The e‐mail address to which you want a partner 

Secondary E-mail to deliver documents, for example, 
“[email protected]”
Queue for delivery Use The public queue you want to use. 
Public
Select the Use Public Queue and then select the 
Queue
name of a public queue from the list.
Use The definition of the private queue. 
Private
For instructions for how to define a private 
Queue
queue, see “Defining Private Queues” on 
page 410.

d If the partner prefers that your system uses this delivery method to deliver 
documents to the partner’s system, select the Use as preferred protocol check box.
If the Use as preferred protocol is not selected for any delivery method, Trading 
Networks uses the Queue for polling delivery method.
Note: You cannot select the Queue for delivery as the preferred protocol.
e Click OK.
5 To edit a delivery method:

a Click   in the EDIT column for the delivery method you want to edit.
b Update the fields. For a description, see step 4c above.
c If the partner prefers that your system uses this delivery method to deliver 
documents to the partner’s system, select the Use as preferred protocol check box.
If the Use as preferred protocol is not selected for any delivery method, Trading 
Networks uses the Queue for polling delivery method. You cannot select the Queue
for delivery as the preferred protocol.
d After updating the fields, click OK.
6 To delete a delivery method:
a Select the check boxes beside the delivery methods that you want to delete.
b Click Delete.

webMethods Trading Networks Administrator’s Guide Version 7.1 182

 10. Defining and Managing Partner Profiles

7 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Updating Extended Fields in a Partner Profile

You can edit the values for the extended fields.

To update extended fields in a partner profile

1 Search for the profile you want to update. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 Click the Extended Fields tab.
4 Update the values for any of the extended fields.
Note: If you do not know what to specify for an extended field and the description 
does not indicate what to specify, contact your Trading Networks administrator to 
determine what to specify. 
5 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 183

 10. Defining and Managing Partner Profiles

Managing the My webMethods Users Associated with the

Partner ’s Profile
You can associate one or more My webMethods user accounts with the profile. For more 
information about how Trading Networks works with My webMethods user accounts, 
see “Central User Management—How Integration Server Authorizes My webMethods 
Users” on page 62.
To associate a My webMethods user account, you can have Trading Networks:
Define a new My webMethods user account where you specify the user name and 
password and associate that user account with your profile
Associate an existing My webMethods user account with your profile

Define a new My webMethods user account where Trading Networks uses the values 
of one of the external IDs defined in your profile as the user name for the account and 
then associate that user account with your profile.

To manage the My webMethods user accounts associated with the profile

1 Search for the profile you want to update. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 Click the Users tab.
4 To add a new My webMethods user account where you specify the user name and 
password and associate that user account with the partner profile:
a Click Add Users.
b Select Add new user.

webMethods Trading Networks Administrator’s Guide Version 7.1 184

 10. Defining and Managing Partner Profiles

c In the User Information section of the dialog, fill in the following fields:

Field Specify...

User name The user name that you want to assign to the user you are adding.

The user ID can be 1 through 255 characters and can contain only 
alphanumeric ASCII characters with no spaces. The user ID is not 
case sensitive.
Note: My webMethods Server adds the user ID to the internal 
system directory service using the case you specify. My 
webMethods Server typically regards user IDs as case‐insensitive; 
however, My webMethods Server uses the case you specify for 
actions that are case‐sensitive, for example, HTTP authentication.
Password The password for the new user.
Confirm The same password you specified in the Password field.
Password

d Click OK.
5 To associate an existing My webMethods user account with the partner profile:
a Select Add existing user.
b In the Search for Available Users, specify a single keyword that is contained in the 
first name, last name, e‐mail address, or user name of the user account that you 
want to associate with the profile.
c Click Go.
d To associate users with the partner profile, move the users from the AVAILABLE
USERS to the SELECTED USERS list.
e Click OK.
6 To add a new My webMethods user account where you use the value of one of the 
partner’s external IDs as the user name for the user account and associate that user 
account with the partner profile:
a Select Add user from external ID.
b Select the external ID you want to use from the External ID list.

webMethods Trading Networks Administrator’s Guide Version 7.1 185

 10. Defining and Managing Partner Profiles

c In the User Information section of the dialog, fill in the following fields:

Field Specify...

External ID The external ID you want to use.
Note: The value for the external ID must be 1 through 255 
characters and can contain only alphanumeric ASCII characters 
with no spaces. 
Note: The user ID is not case sensitive; however, My webMethods 
Server adds the user ID to the internal system directory service 
using the case used for the external ID value. My webMethods 
Server uses this case for actions that are case‐sensitive, for 
example, HTTP authentication.
Password The password for the new user.
Confirm The same password you specified in the Password field.
Password

d Click OK.
7 To remove My webMethods user accounts that are associated with the partner profile.
a Select the check boxes beside the user accounts that you want to delete.
b Click Remove.
Note: Trading Networks does not delete the user accounts.
8 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Managing Security Information in Your Profile

You can:
Add certificate sets

Manage certificates and private keys in existing certificate sets

Delete certificate sets
When you add a certificate, be sure also to add the CA certificate(s) and private key that 
are associated with the certificate. The certificates, CA certificates, and private keys must 
reside in your file system. Trading Networks can import files that have a .der, .cer, or .p7b 

webMethods Trading Networks Administrator’s Guide Version 7.1 186

 10. Defining and Managing Partner Profiles

extension. If you import a .der file, Trading Networks appends it to the existing certificate 
chain list. However, if you import a .cer or .p7b file, Trading Networks replaces the 
certificate chain list with the .cer or .p7b file.
Likewise, if you add a private key, be sure also to add the certificate and CA certificate(s) 
that are associated with the private key.

Adding Certificate Sets

You can add certificate sets that Trading Networks uses during processing.

Add this type of

certificate set... To…
SSL Client Enable Trading Networks to act as an SSL client to connect to a 
remote secure server.
Decrypt/Encrypt Encrypt information that is being sent to a partner.
Sign/Verify Verify the digital signature of documents that were digitally 
signed by this partner.

When looking for a certificate set to use, Trading Networks first looks for a certificate set 
associated with a specific partner. For example, if Trading Networks needs to verify the 
digital signature of partner A, it first looks for a partner A certificate set. If found, Trading 
Networks uses those Sign/Verify certificates. If it does not have a set of certificates for the 
specific partner, Trading Networks uses the Default certificate set.

To add certificate sets to the profile

1 Search for the profile you want to update. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 Click the Certificates tab.
4 To add the default certificate set:

a Under the Default branch of the tree on the Certificates tab, click   in the EDIT 
column for the certificates a you want to add (SSL, Encrypt/Decrypt, or Sign/Verify).
b To add the private key, click Browse and use the Choose File dialog box to select 
the private key file.

webMethods Trading Networks Administrator’s Guide Version 7.1 187

 10. Defining and Managing Partner Profiles

c To add a certificate, click Add Certificate, then click Browse and use the Choose File 
dialog box to select the certificate file.
d Click OK.
5 To add certificate sets that you want Trading Networks to use when with specific 
partners:
a Click Add Certificate Set.
b Use the search panel to search for the partners you want to add certificate sets for. 
For instructions for how to search for the partner profiles:
Keyword searches, see “Performing a Keyword Search for Partner Profiles” 
on page 169
Advanced search, see “Performing an Advanced Search for Partner Profiles” 
on page 170
Saved search, see the Getting Started with My webMethods guide
Trading Networks populates the AVAILABLE PARTNERS list with the results of your 
search.
c Select the profiles that you want to add certificate sets for by moving the profiles 
from the AVAILABLE PARTNERS list to the SELECTED PARTNERS list.
d Click OK.
Trading Networks adds a branch to the tree for each partner you selected.
e For each partner, perform the following to add a certificate set for that partner:
1 Expand the tree for the partner.

2 Click   in the EDIT column for the certificates you want to add (SSL, 
Encrypt/Decrypt, or Sign/Verify).
3 To add the private key, click Browse and use the Choose File dialog box to 
select the private key file.
Note: If you add a private key, be sure also to add the certificate and CA 
certificate(s) that are associated with the private key.
4 To add a certificate, click Add Certificate; then click Browse and use the Choose 
File dialog box to select the certificate file.
5 Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 188

 10. Defining and Managing Partner Profiles

6 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Managing Certificate Sets

You can add new certificates to or remove certificates from existing certificate sets. 
Additionally, you can add private keys to or remove private keys from existing certificate 
sets.

To manage certificate sets

1 Search for the profile you want to update. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 Click the Certificates tab.
4 Expand the branch for the certificate set that you want to work with.

5 Click   in the EDIT column for the certificates you want to update (SSL, 
Encrypt/Decrypt, or Sign/Verify).
6 To remove the private key, select the Clear Private Key check box.
7 To add or update the private key, click Browse and use the Choose File dialog box to 
select the private key file.
8 To add a new certificate:
a To add a certificate, click Add Certificate; then click Browse and use the Choose File 
dialog box to select the certificate file.
b Click OK.

9 To remove a certificate, in the Certificates section of the screen, click   in the REMOVE 
column for the certificate you want to remove.
10 Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 189

 10. Defining and Managing Partner Profiles

11 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Copying a Partner Profile

In addition to adding a new partner profile by filling in a blank form, as described in 
“Adding Partner Profiles” on page 166, you can also add a new partner profile that is 
similar to an existing profile. When you copy an existing profile, the form for the new 
profile is pre‐filled with information from the partner that you select to copy.

To add a new partner profile by copying an existing profile

1 Search for the profile you want to copy. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 Click   in the ACTION column in the row containing the partner profile you want to 
copy.
3 In the Partner Details panel, fill in the following fields:

Field Specify...

Corporation The name of the partner’s corporation, for example, “Industrial 
Name Steel Company”.
Organization Optionally, the name of the organizational unit or division within 
Unit the corporation, for example, “Sales and Marketing”.
Status Whether you want the profile enabled or disabled.
To enable the profile, select Active.

To disable the profile, select Inactive.
Note: You should keep the profile Inactive until you have completed 
filling in all the information you require in a profile, for example, 
delivery methods, users, etc.
Preferred Optionally the language preference the partner uses if needed for 
Language another webMethods component (e.g., webMethods RosettaNet 
Module).

webMethods Trading Networks Administrator’s Guide Version 7.1 190

 10. Defining and Managing Partner Profiles

4 Click the External IDs tab and add external IDs for the partner. For instructions, see 
“Managing External IDs in a Partner Profile” on page 173.
5 Make any other changes you need to make to the profile. For instructions, see the 
sections in “Updating Partner Profiles” on page 171.

Suspending Delivery for a Partner

At times you might want to suspend delivery for a partner, for example, if a partner’s 
server is unavailable. When delivery is suspended, in general, Trading Networks holds 
documents rather than attempting to deliver them. The table below describes Trading 
Networks actions based on the type of delivery:

Type of Delivery Trading Networks actions when delivery is suspended

Immediate delivery that uses Delivery tasks for the partner are assigned the HELD 
reliable delivery status. As a result, Trading Networks will not attempt 
to deliver the documents.
When delivery is resumed for the partner, Trading 
Networks changes the status to PENDING. As a 
result, Trading Networks will begin attempting to 
deliver the document.
Immediate delivery that does not Delivering documents will fail. Because Trading 
use reliable delivery Networks does not save the document to the 
database, it cannot hold the delivery.
Schedule delivery Delivery tasks for the partner are assigned the HELD 
status. As a result, Trading Networks will not attempt 
to deliver the documents.
When delivery is resumed for the partner, Trading 
Networks changes the status to QUEUED. As a result, 
Trading Networks will begin attempting to deliver 
the document.

Reliable service execution tasks are also affected when deliveries are suspended. When 
delivery is suspended for a partner, Trading Networks assigns the service execution tasks 
a HELD status. As a result, Trading Networks does not attempt to execute the services. 
When delivery is resumed, Trading Networks updates the task statuses to PENDING and 
as a result, Trading Networks attempts to execute the services.

webMethods Trading Networks Administrator’s Guide Version 7.1 191

 10. Defining and Managing Partner Profiles

To suspend delivery for a partner

1 Search for the profile of the partner for whom you want to suspend delivery. If you 
need procedures for this step, see “Performing a Keyword Search for Partner Profiles” 
on page 169 or “Performing an Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 Click the Delivery Settings tab.
4 To suspend delivery, select the Suspend Delivery check box, which is in the SETTINGS 
panel.

Resuming Delivery for a Partner

If you previously suspended delivery for a partner, use this procedure to resume delivery.

To resume delivery for a partner

1 Search for the profile of the partner for whom you want to resume delivery. If you 
need procedures for this step, see “Performing a Keyword Search for Partner Profiles” 
on page 169 or “Performing an Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 Click the Delivery Settings tab.
4 To resume delivery, clear the Suspend Delivery check box, which is in the SETTINGS 
panel.

Deleting a Profile
When you delete a profile from the Trading Networks Console, Trading Networks 
removes most of the profile data from its database, but keeps all documents, entries, and 
TPAs that are associated with the partner. You are no longer able to view the profile or any 
related TPAs.
If you decide to delete a profile, you must also delete all related TPAs before deleting the 
profile.

Note: You cannot delete your own Enterprise profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 192

 10. Defining and Managing Partner Profiles

Trading Networks does not provide a way to “undelete” a profile. If a partner sends you a 
document after you delete its profile, Trading Networks treats the document as if it came 
from an unknown partner.

Important! When you delete a partner’s profile, Trading Networks does not delete the 
associated user accounts. To delete an My webMethods user account, see the My 
webMethods Server Administrator’s Guide. To delete an Integration Server user account, see 
the webMethods Integration Server Administrator’s Guide.

To delete a partner profile

1 Search for the profile(s) you want to delete. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.
2 Select the check boxes beside the partner profiles that you want to delete.
3 Click Delete.

Disabling a Partner ’s Profile—Changing the Status to Inactive

When you disable a profile, Trading Networks changes the status of the profile to 
“Inactive”. When you disable a partner’s profile, you will not be able to exchange 
documents with that partner. As a result, disabling a profile can be thought of as 
temporarily removing a partner from your network. If the partner attempts to send you 
documents while its profile is disabled, 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 administrator

Responds to the sender with an HTTP 403 message if the document was sent using 
HTTP.
For more information about profile statuses, see “Profile Statuses” on page 127.

To disable a partner profile

1 Search for the profile you want to disable. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

webMethods Trading Networks Administrator’s Guide Version 7.1 193

 10. Defining and Managing Partner Profiles

2 To edit the profile, click   in the ACTION column.
3 In the Partner Details panel, select Inactive from the Status list.
4 You can do one of the following:
Continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

Important! When you disable a partner’s profile, Trading Networks does not disable 
nor delete any My webMethods or Integration Server user accounts that are 
associated with the profile. Use My webMethods to delete a My webMethods user 
account; for more information, see the My webMethods Server Administrator’s Guide. 
Use the Server Administrator to delete an Integration Server user account; for more 
information, see webMethods Integration Server Administrator’s Guide.

Enabling a Partner ’s Profile—Changing the Status to Active

When you enable a profile, Trading Networks changes the status of the profile to “Active”. 
When you enable a partner’s profile, you will be able to exchange documents with that 
partner. As a result, enabling a profile can be thought of as re‐establishing a partner into 
your network. For more information about profile statuses, see “Profile Statuses” on 
page 127.

To enable a partner profile

1 Search for the profile you want to enable. If you need procedures for this step, see 
“Performing a Keyword Search for Partner Profiles” on page 169 or “Performing an 
Advanced Search for Partner Profiles” on page 170.

2 To edit the profile, click   in the ACTION column.
3 In the Partner Details panel, select Active from the Status list.
4 You can do one of the following:
Continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the 
profile. 
Click Save and Close to save the changes and close the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 194

 10. Defining and Managing Partner Profiles

Searching for Certificates that Are Expired or Expiring Soon

You can search for partner certificates that are expired or for partner certificates that are 
expiring soon.

Searching for Expired Partner Certificates

To find expired certificates, perform the following procedure.

To search for partner certificates that are expired or that are expiring soon

1 In My webMethods: Administration > Integration > B2B > Partner Certificates.

2 Select Expired from the EXPIRING RANGE list.
3 Click Go.

Searching for Partner Certificates that Will Expire Soon

To find certificates that are expiring soon, perform the following procedure.

To search for partner certificates that are expired or that are expiring soon

1 In My webMethods: Administration > Integration > B2B > Partner Certificates.

2 To use predefined time period, select the time period from the EXPIRING RANGE list. 
For example, if you select Today, Trading Networks searches for certificates that will 
expire today.
Note: If you select Expired, Trading Networks searches for expired certificates.
Use Custom to specify a custom time period. See below for more information.
3 To specify a custom time period:
a Select Custom from the EXPIRING RANGE list. 
b Use the calendar pickers to specify a Start Date and End Date, then select the 
numbers for the hours and minutes from their respective lists.
4 Click Go.

webMethods Trading Networks Administrator’s Guide Version 7.1 195

 10. Defining and Managing Partner Profiles

webMethods Trading Networks Administrator’s Guide Version 7.1 196

Chapter 11. Defining and Managing Profile Groups

What are Profile Groups? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Defining a Profile Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Searching for Profile Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Updating a Profile Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

Deleting a Profile Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Note: This chapter describes how to define and manage profile groups using My 
webMethods. The same functionality in the Trading Networks Console is deprecated. If 
you need instructions for using the Console to define and manage profile groups, see 
Appendix J, “Managing Profile Groups Using the Console”. 

webMethods Trading Networks Administrator’s Guide Version 7.1 197

 11. Defining and Managing Profile Groups

What are Profile Groups?

A profile group is a logical user‐defined group that you associate a profile with. For 
example, you can create a group profile named “Buyers” to associate all of your partner 
profiles who are buyers in your trading network.

Defining a Profile Group

To define profile groups, perform the following procedure.

To define a profile group

1 In My webMethods: Administration > Integration > B2B > Profile Groups.

2 Click Add Profile Group.
3 Type a name for the group in the Name field.
4 Optionally, type a description of the group in the Description field.
5 To add members to the group:
a Click Add Members.
b Search for profiles that you want to make members of the group. 
For instructions for how to search for the profiles,
Keyword searches, see “Performing a Keyword Search for Partner Profiles” 
on page 169
Advanced search, see “Performing an Advanced Search for Partner Profiles” 
on page 170
Saved search, see the Getting Started with My webMethods guide
Trading Networks populates the AVAILABLE PARTNERS list with the results of 
your search.
c Select the profiles that you want to member of the profile group by moving the 
profiles from the AVAILABLE PARTNERS list to the SELECTED PARTNERS list.
d Click OK.
6 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 198

 11. Defining and Managing Profile Groups

Searching for Profile Groups

The following table lists tasks related to searching for profile groups and where to find 
more information about each task.

Task For more information, see...

Search for profile groups with group names  “Performing a Keyword Search for 
that contain keywords that you specify. Profile Groups” on page 200
Set the following search options for the  Getting Started with My webMethods 
Administration > Integration > B2B > Profile  guide
Groups page:
The search tab that Trading Networks 
displays when initially displaying the 
Partner Profiles page
The search you want Trading Networks 
to execute, if any, when initially 
displaying the Partner Profiles page
The maximum number of search results 
you want Trading Networks to display 
in response to a search
Set the following display options for how  Getting Started with My webMethods 
Trading Networks displays search results  guide
on the Administration > Integration > B2B > 
Partner Profiles page:
The number of rows that you want 
Trading Networks to display on each 
page of the search results
How the search results are sorted

The columns displayed and the order of 
the columns
Save searches for partner profiles. Getting Started with My webMethods 
guide
Re‐execute saved searches for partner  Getting Started with My webMethods 
profiles. guide

webMethods Trading Networks Administrator’s Guide Version 7.1 199

 11. Defining and Managing Profile Groups

Performing a Keyword Search for Profile Groups

Use a keyword search to find profile groups based on their group names. 

To perform a keyword search for profile groups

1 In My webMethods: Administration > Integration > B2B > Profile Groups

2 Click the Keyword tab if it is not already displayed.
3 In the text box, type a keyword that is contained in the group names of the profile 
groups you want to find.
If you leave the text box blank, Trading Networks searches for all profile groups that 
you are authorized to view. For more information about how to specify keywords, see 
the Getting Started with My webMethods guide.
4 Click Go to execute the search.

Updating a Profile Group

To update a profile group, perform the following procedure.

To update a profile group

1 Search for the profile group you want to update. If you need procedures for this step, 
see “Searching for Profile Groups” on page 199.

2 To edit the profile, click   in the EDIT column.
3 To update the profile group’s name, type a new name in the Name field. 
4 To update the description, type a new description in the Description field.
5 To add members to the group, see the instructions in step 5 in “Defining a Profile 
Group” on page 198.
6 To remove members from the group:
a Select the check boxes beside the members that you want to remove.
b Click Delete.
Note: Trading Networks does not delete the profile; it only removes it from the profile 
group.
7 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 200

 11. Defining and Managing Profile Groups

Deleting a Profile Group

To delete a profile group, perform the following procedure.

To delete profile groups

1 Search for the profile groups you want to delete. If you need procedures for this step, 
see “Searching for Profile Groups” on page 199.
2 Select the check boxes beside the profile groups that you want to delete.
3 Click Delete.

webMethods Trading Networks Administrator’s Guide Version 7.1 201

 11. Defining and Managing Profile Groups

webMethods Trading Networks Administrator’s Guide Version 7.1 202

Chapter 12. Defining and Managing Trading Partner
Agreements (TPAs)

What is a Trading Partner Agreement (TPA)? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

Information You Supply to Define a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

Defining a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Managing TPAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

webMethods Trading Networks Administrator’s Guide Version 7.1 203

 12. Defining and Managing Trading Partner Agreements (TPAs)

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. To use a 
TPA, both partners in the agreement must have existing profiles in Trading Networks. 
Trading Networks uses the profiles to ensure that the partners are valid for that Trading 
Networks system.

For more information about TPAs, see Chapter 2, ʺTrading Partnersʺ in the webMethods 

Trading Networks Concepts Guide.

To view TPAs and their data in Trading Networks, first specify a query to identify the 
TPAs in which you are interested. You can query TPAs by the following fields: Sender, 
Receiver, Agreement ID, Timestamp, Agreement Status, and IS Document Type. Trading Networks 
returns information about the TPAs that meet the search criteria that you specified in your 
query.

Information You Supply to Define a TPA

When you define a TPA, you supply the following information: sender, receiver, 
agreement ID, IS document type, data status, services (export and initialization), and 
optionally, a description.

TPA Information Description

Sender Name of the trading partner that has the sender role in the TPA. 
You select the sender from the profiles defined on your Trading 
Networks system, including your own profile (Enterprise).

Note: A TPA is an agreement between two partners in your 
network; one that fulfills the sender role during document 
exchange, and the other that fulfills the receiver role. Both the 
sender and receiver in a TPA must be a partner in your Trading 
Networks system that has an existing profile.

Receiver Name of the trading partner that has the receiver role in the TPA. 
You select the receiver from the profiles defined on your Trading 
Networks system, including your own profile (Enterprise).
Agreement ID An application‐specific field that uniquely identifies the type of 
agreement between two partners. 

webMethods Trading Networks Administrator’s Guide Version 7.1 204

 12. Defining and Managing Trading Partner Agreements (TPAs)

TPA Information Description

IS Document Type An IS document type that specifies the data that you define in the 

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

webMethods Trading Networks Administrator’s Guide Version 7.1 205

 12. Defining and Managing Trading Partner Agreements (TPAs)

TPA Information Description

Data Status This field applies only when the Agreement Status is Agreed. 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). The data 
status can be one of the following:
Modifiable ‐ the TPA data can be changed

Non-modifiable ‐ the TPA data cannot be changed

Note: Trading Networks uses the data status only after the TPA has 
an Agreed status. For more information about TPA statuses, see 
“Changing a TPA Agreement Status” on page 214. For more 
information about changing the TPA data defined in the IS 
document type, see “Changing the TPA Data Inputs in the IS 
Document Type” on page 216.

Export Service A service that exports a Trading Networks TPA and converts it to 

an industry‐standard format. After creating a TPA, if you need to 
obtain the industry‐standard format of a TPA, you can execute 
your export service. Defining an export service is optional.

Note: The format of the industry‐standard agreement will not be 
the same as the format of a Trading Networks TPA. When using 
the TPA feature for your own custom application, you can create 
an export service that converts the Trading Networks TPA to the 
industry‐standard format that you require. 

webMethods Trading Networks Administrator’s Guide Version 7.1 206

 12. Defining and Managing Trading Partner Agreements (TPAs)

TPA Information Description

Initialization A service that sets default values for the IS document type data of 
Service the TPA. Defining an initialization service is optional. You can set 
this field to point to an IS service that can provide the initial values 
for that data.
When using the TPA feature for your own custom application, you 
can create an initialization service that populates the parameters in 
the IS document type with default values. Some webMethods’ 
components that take advantage of the TPA feature supply an 
initialization service. For example, the webMethods EDI Module 
supplies the service wm.b2b.editn.TPA:initService that populates the 
EDITPA with the default values for an EDI TPA. The webMethods 
ebXML Module supplies the wm.ip.ebxml.cpa:initTPA initialization 
service. 
For more information about EDI TPAs, see the webMethods EDI 
Module User’s Guide. For more information about ebXML CPAs, 
see the webMethods ebXML User’s Guide
Description This is an optional field that you can use to specify a description 
for the TPA. Specify 1‐1024 characters. There is no restriction to the 
characters that you can use.

Defining a TPA
You define TPAs on the Agreement Details screen of the Trading Networks Console. 
After you set the attributes of your TPA on the top portion of this screen and select the IS 
document type, Trading Networks displays the corresponding IS document type data tree 
on the bottom panel of the screen. The right side of this panel displays the input values 
(TPA data inputs) to variables of the IS document type.
Use the following procedure to define a TPA.

To define a TPA

1 In Trading Networks Console: View > Agreements.

Trading Networks displays the Agreements screen.

webMethods Trading Networks Administrator’s Guide Version 7.1 207

 12. Defining and Managing Trading Partner Agreements (TPAs)

2 Perform one of the following procedures to create a new TPA.

Method to create a TPA Procedures

New—The TPA fields are  Select Agreements > New. Trading Networks 

empty. displays the Agreement Details screen to allow 
you to fill in the information for the TPA.
Duplicate—The TPA fields are  c Click the row containing the name of the TPA 
filled with values from the  agreement that you want to duplicate.
TPA agreements that you 
d Select Agreements > Duplicate. Trading 
duplicate. You can update 
Networks displays the Agreement Details 
any or all fields from the 
screen.
duplicated TPA agreement.
You can use this function to 
create a template TPA.

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

Note: The Sender, Receiver, and Agreement ID fields must be unique for each TPA. After 

you create a TPA, you cannot change or update these fields of the TPA.

For this TPA field... Specify

Sender Name of the trading partner that has the sender role in the 
transaction the TPA will govern. Type in the name of the 

sender or click the   Select button to select the sender from 
the Partner Selection Dialog. This list includes your own 
profile (Enterprise).
For EDI, to create a template that you will duplicate to create 
other TPAs, you can use the default value of Unknown.
For more information about how to select a sender, see 
“Selecting a Partner” on page 37.

webMethods Trading Networks Administrator’s Guide Version 7.1 208

 12. Defining and Managing Trading Partner Agreements (TPAs)

For this TPA field... Specify

Receiver Name of the trading partner that has the receiver role in the 
transaction the TPA will govern. Type in the name of the 

receiver or click the   Select button to select the receiver 

from the Partner Selection Dialog. This list includes your own 
profile (Enterprise). For EDI, to create a template that you will 
duplicate to create other TPAs, you can use the default value 
of Unknown.
For more information about how to select a receiver, see 
“Selecting a Partner” on page 37.
Agreement ID An identifier that indicates the type of agreement between the 
two partners. The Sender, Receiver, and Agreement ID values 
together uniquely identify a TPA.

Note: You will not be able to continue creating a TPA unless 
you supply the Agreement ID. After you supply the Agreement
ID, you can: create the TPA or continue to supply data for the 
remaining fields.

The value you specify depends on the application that is 
going to use the TPA. You can use up to 254 characters of any 
type for this field, including spaces. For more information 
about the agreement ID, see “Information You Supply to 
Define a TPA” on page 204.
IS Document Type The IS document type that defines the application‐specific 
TPA data. The TPA data is used to govern the exchange of 
documents between the two partners.
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. Trading 
Networks displays the data tree input values of the selected 
IS document type in the bottom panel of the Agreement 
Details screen.
For more information about the IS document type, see 
“Information You Supply to Define a TPA” on page 204. If 
you want to change the data input for the IS document type, 
see “Changing the TPA Data Inputs in the IS Document 
Type” on page 216.

webMethods Trading Networks Administrator’s Guide Version 7.1 209

 12. Defining and Managing Trading Partner Agreements (TPAs)

For this TPA field... Specify

Control Number A value that the application using the TPA expects. This value 

is only needed if the application using the TPA uses the 
Control Number field.
The value for this field must be an integer. The default value 
is zero (0).
Data Status Whether you want to be able to modify the values of the TPA 
data of the IS document type. The data status is only 
applicable when the agreement status is Agreed.
For more information about statuses, see “Changing a TPA 
Agreement Status” on page 214.
Export Service A service to convert the data in the Trading Networks TPA to 
an industry‐format trading partner agreement. For more 
information about the export service, see “Information You 
Supply to Define a TPA” on page 204.
Type in the name of the export service located on the server 

or click  Find Service to browse the services and select the 

one you want to use.

Note: The Export Service is different from the Trading 

Networks File > Export function that exports Trading 
Networks data (such as profiles, TN document types) out of 
the Trading Networks database, so data can be 
exported/imported within the same Trading Networks 
release from development to production environment. 

For more information about exporting Trading Networks 
data to another Trading Networks system, see Appendix C, 
“Exporting and Importing Database Information”.

webMethods Trading Networks Administrator’s Guide Version 7.1 210

 12. Defining and Managing Trading Partner Agreements (TPAs)

For this TPA field... Specify

Initialization Service A service to populate the inputs to the variables in the IS 

document type for the TPA with default values. This is 
optional. For more information about the initialization 
service, see “Information You Supply to Define a TPA” on 
page 204.
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.

Note: If you create a partner‐defined EDITPA from scratch, 
you should not use the wm.b2b.editn.TPA:initService initialization 
service because it populates the partner‐defined EDITPA with 
hard‐coded values other than those in the default EDITPA, 
which is already tailored to a user’s particular requirements. 
Instead, you should manually complete each parameter field 
in the Input for ‘wm.b2b.edi.tn.TPA:EDITPA’ screen in the 
Trading Networks Console. For more information about EDI 
TPAs, see the webMethods EDI Module User’s Guide.

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

4 Click OK to create the TPA.

Note: Trading Networks disables the OK button until you supply the Sender, Receiver, and 
Agreement ID fields. If you clear any of the Sender, Receiver, and Agreement ID fields during 
the creation of the TPA, Trading Networks will disable the OK button, as well as the other 
TPA fields. You will not be able to save the TPA unless you supply the Sender, Receiver, 
and Agreement ID fields.

webMethods Trading Networks Administrator’s Guide Version 7.1 211

 12. Defining and Managing Trading Partner Agreements (TPAs)

Managing TPAs
The following table describes the tasks you can perform against TPAs:

Task See Page...

“Finding and Viewing TPAs” 212
“Updating TPAs” 214
“Changing a TPA Agreement Status” 214
“Changing the TPA Data Inputs in the IS Document Type” 216
“Deleting a TPA” 218

Finding and Viewing TPAs

You can use the Agreements screen to find and view TPAs that you have defined.

To view TPAs

1 In Trading Networks Console: View > Agreements.

2 To see detailed information about a specific TPA, double click on the row containing 
the TPA you want more detailed information about. Trading Networks displays the 
Agreements Details screen.
3 If you cannot find the TPA you are looking for, you can use the search criteria on the 
Agreements screen to query for specific TPAs. 

a Select   Show Query on the toolbar to have Trading Networks display the search 

criteria.
b To indicate that you want to use one or more of the search criteria, select the check 
box next to each criterion you want to use. Then fill out the corresponding 
information as follows. 

Important! The search‐criteria fields are space and character‐sensitive; be sure to use 
the exact combination of upper‐ and lowercase letters. Do not use pattern‐matching 
characters (such as “*”, “%”, or “_”) in the TPA search.

webMethods Trading Networks Administrator’s Guide Version 7.1 212

 12. Defining and Managing Trading Partner Agreements (TPAs)

For this TPA

Attribute… Specify…

Sender 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 
button to select the sender from the Partner Selection Dialog. 

For more information about the   Select button, see 
“Selecting a Partner” on page 37.

Note: The Sender, Receiver, and Agreement ID fields must be 

unique for each TPA.

Receiver The name of the trading partner that has the receiver role for 

the TPA. Type in the name of the receiver or click the  Select 
button to select the receiver from the Partner Selection Dialog. 

For more information about the   Select button, see 
“Selecting a Partner” on page 37.
Agreement ID The Agreement ID of the TPA that you want to view.
Agreement Status The status of the agreement that you want to view: Proposed, 
Disabled, or Agreed. For more information about statuses, see 
“Changing a TPA Agreement Status” on page 214.
IS Document Type The IS document type for the TPA data you want to use. 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.
Timestamp The time Trading Networks last updated the TPA either when 
the TPA was created or last updated. Select an entry from the 
list. To specify a date range, select Custom from the list. Then 
specify dates in the Beginning and Ending fields. 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.

For more information about the TPA attribute fields, see “Information You Supply to 
Define a TPA” on page 204.

c Select   Run Query on the toolbar. Trading Networks updates the Agreements 

table on the bottom portion of the screen with the query results.

webMethods Trading Networks Administrator’s Guide Version 7.1 213

 12. Defining and Managing Trading Partner Agreements (TPAs)

d Double click to select the partner you want from query results in the Profiles table 
on the bottom portion of the screen. Trading Networks displays the Agreement 
Details screen. 
For more information about the tabs and fields on this screen, see “Defining a 
TPA” on page 207.
For procedures on how to change the information in your partner’s profile, 
see “Updating TPAs” on page 214.

Updating TPAs
Use the following procedure to update a TPA.

To update a TPA

1 Select the TPA you want to update. If you need procedures for this step, see “Finding 
and Viewing TPAs” on page 212.
2 Select Agreements > Edit. 
3 Update the TPA fields you want to change: 
For information on what you can specify for the fields in the Agreement Details 
screen, see step 3 on page 208. 
For instructions on how to change the Agreement Status, see the next section, 
“Changing a TPA Agreement Status”.

Important! You cannot modify or update the Sender, Receiver, or Agreement ID field of a 

TPA.

4 For instructions on how to update the inputs for the IS document type, see “Changing 
the TPA Data Inputs in the IS Document Type” on page 216.

Changing a TPA Agreement Status

The agreement status determines whether the TPA is a draft (Proposed status), final (Agreed 
status), or whether the TPA is inactive (Disabled status). You can change the agreement 
status of the TPA to any other agreement status. 
Initially, when you are creating the TPA, assign the TPA the Proposed status so that you can 
make modifications to the TPA fields, data values in the IS document type, the agreement 
status, and to delete the agreement. For a production setting, select the Agreed status to 
prevent the accidental deletion of the TPA, as well as to speed up processing.
Select the Disabled status when you no longer want Trading Networks to use a specific 
TPA. For example, in a transaction between two partners (e.g., Partner A and Partner B) 
who sell products to one another, the agreement status of the TPA might change 

webMethods Trading Networks Administrator’s Guide Version 7.1 214

 12. Defining and Managing Trading Partner Agreements (TPAs)

depending upon business conditions. If Partner A is delinquent on payments to Partner B, 
then Partner B might change Partner A’s agreement status to Disabled ‐ so that no further 
transactions could occur. After Partner A pays his payments, however, Partner B would 
change the agreement status to Agreed.
The following table explains what each status is and the changes you can make to the 
Agreement Status.

Agreement Status Meaning

The TPA is in draft status. When the TPA is in the Proposed status, 
Proposed you can delete it. For more information, see “Deleting a TPA” on 
page 218.
What you can change:
The TPA fields, with the exception of the Sender, Receiver, or 
Agreement ID fields.
All inputs to TPA data variables in the IS document type. For 
more information, see “Changing the TPA Data Inputs in the 
IS Document Type” on page 216. 
The agreement status to Disabled or Agreed.
The TPA is in final status. When the TPA is in the Agreed status, you 
Agreed cannot delete it. To delete a TPA, you must change the agreement 
status to Proposed or Disabled. For more information, see “Deleting a 
TPA” on page 218.
If the Data Status is:
Modifiable, you can change:
The Control Number
All inputs to TPA data variables in the IS document type. 
For more information, see “Changing the TPA Data Inputs 
in the IS Document Type” on page 216. 
Non-modifiable, you can change:
The Control Number

Note: To modify the data of the TPA, you must change the 
agreement status from Agreed to Proposed. For more information, see 
“Changing the TPA Data Inputs in the IS Document Type” on 
page 216.

webMethods Trading Networks Administrator’s Guide Version 7.1 215

 12. Defining and Managing Trading Partner Agreements (TPAs)

Agreement Status Meaning

The TPA should not be used. You can delete a disabled TPA. For 
Disabled more information, see “Deleting a TPA” on page 218.
What you can change:
The Control Number

Note: To modify the data of a TPA, you must change agreement 
status from Disabled to Proposed. For more information, see 
“Changing the TPA Data Inputs in the IS Document Type” on 
page 216

Use the following procedure to change a TPA agreement status.

To change a TPA agreement status

1 In Trading Networks Console: View > Agreements.

Trading Networks displays the Agreements screen.
2 Click the row containing the TPA you want to change the agreement status for.
3 To change the agreement status:

Press the appropriate status change button:  Proposed,  Disabled, or 

Agreed
-OR-
Right‐click and select from the menu items: Proposed, Disabled, or Agreed.
Trading Networks displays the new status in the Agreement Status column. 

Changing the TPA Data Inputs in the IS Document Type

The TPA data inputs are the inputs to variables of the IS document type. 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.
Set Inputs for IS Document Type. Use this method to supply the values you want the TPA 
data inputs to have.
Reset to Initialization Service. 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. 

webMethods Trading Networks Administrator’s Guide Version 7.1 216

 12. Defining and Managing Trading Partner Agreements (TPAs)

Use the following procedure to change the inputs for the IS document type.

To change the data inputs in the IS document type

1 Select the TPA you want to update. If you need procedures for this step, see “Finding 
and Viewing TPAs” on page 212.
2 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, 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. For more information, see “Changing a TPA Agreement Status” 
on page 214.

Click this IS document

type data input button... To change the data input in the following manner...

Change the values in the IS document type through the 
Set Inputs Input for <IS Document Type> dialog. When you click this 
icon, the dialog displays the parameters of the IS document 
type with the corresponding TPA data values 
automatically filled in. You can modify the data values and 
then save them by selecting OK. For more information 
about changing IS Document Types, see the webMethods 
Developer User’s Guide. 
Reset to Trading Networks invokes the initialization service (if 
Initialization specified) to reset the TPA data inputs of the IS document 
Service type to their default values. If you choose to reset these 
values, you will lose any changes that you have made to 
the IS document type.

Note: The Reset to Initialization Service button is only enabled 

when an initialization service is supplied. If this field is 
emptied, Trading Networks disables the Reset to Initialization
Service button. 

3 Click OK to save your changes.

webMethods Trading Networks Administrator’s Guide Version 7.1 217

 12. Defining and Managing Trading Partner Agreements (TPAs)

Deleting a TPA
When you delete a TPA, Trading Networks deletes all of the TPA data from its database.

Important! Trading Networks does not provide a way to “undelete” the TPA. 

Important! Before you delete a profile that is referenced by a TPA, you must first delete any 
related TPAs. If you accidentally deleted the profile and not the TPA, you can delete the 
invalid TPA. For more information, see “Deleting a Profile” on page 192.

You can only delete TPAs with the Proposed or Disabled agreement status. You cannot delete 
TPAs with an Agreed status. If you want to delete a TPA with an Agreed status, you will 
need to first change the agreement status to either Proposed or Disabled, and then Trading 
Networks allows you to delete the TPA.
To delete a TPA, perform the following procedure:

To delete a TPA

1 Select the TPA you want to delete. If you need procedures for this step, see “Finding 
and Viewing TPAs” on page 212.
2 Select Agreements > Delete to delete the TPA. When Trading Networks prompts you to 
verify that you want to delete the TPA, click Yes.

Note: If you are deleting a non‐modifiable agreement, you will need to use the 
wm.tn.tpa:deleteTPA service. For more information, see the Programmer’s Reference Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 218

 Part III. Defining Transaction Processing

Chapter 13, “Defining and Managing Document Attributes”

Chapter 14, “Defining and Managing TN XML Document Types”

Chapter 15, “Defining and Managing TN Flat File Document Types”

Chapter 16, “Defining and Managing Processing Rules”

webMethods Trading Networks Administrator’s Guide Version 7.1 219

 III. Defining Transaction Processing

webMethods Trading Networks Administrator’s Guide Version 7.1 220

Chapter 13. Defining and Managing Document Attributes

What are Document Attributes? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

Defining Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

Managing Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

webMethods Trading Networks Administrator’s Guide Version 7.1 221

 13. Defining and Managing Document Attributes

What are Document Attributes?

There are two kinds of document attributes:
Custom attributes, which identify specific pieces of information that you want to 
extract from the documents that your trading network will receive. For example, if 
you want to extract the purchase order number from documents, you might define a 
document attribute named PO_Number.
Predefined attributes, known as system attributes, that identify characteristics of the 
documents. System attributes are available out of the box. You do not need to define 
them, and you cannot delete them. They include:

System Attribute Description

SenderID Identification of the trading partner that sent the document
ReceiverID Identification of the trading 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
Signature and  The portions of the document that contain a digital signature of 
SignedBody 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 238 or “Attributes To Extract From 
Documents” on page 310.
You should define custom document attributes for all types of documents that you expect 
to receive; a document attribute is not associated with a specific document type. Later, 
when you define your TN document types, you will specify which document attributes to 
include in each document type. Instructions for creating document types appear in 
Chapter 14, “Defining and Managing TN XML Document Types” and Chapter 15, 
“Defining and Managing TN Flat File Document Types”.
To define a document attribute you specify the attribute’s name, description, and data 
type (DATETIME, DATETIME LIST, NUMBER, NUMBER LIST, STRING, or STRINGLIST). In addition, 
you can specify whether Trading Networks should save the attribute to the database (the 
default behavior).

webMethods Trading Networks Administrator’s Guide Version 7.1 222

 13. Defining and Managing Document Attributes

Document Attributes and How They Relate to TN document types

Document #1 TN Document Type

The definition of a Name = OAG PO
<!-- OAG -->
document attribute .
The definition of a TN specifies the name, type, .
document type specifies and description for a .
how to locate the attributes document attribute. Attributes
in the specific type of <POID>A230</POID> PO_Number
document. .
.
.
Document Attribute
Name = PO_Number
Type = Number
Description = Purchase Order Number
TN Document Type
Name = cXML PO
. Document #2 Document #3 TN Document Type
. <!-- cXML --> <!-- CBL --> Name = CBL PO
. .
Attributes <OrderRequestHeader <BuyerRefNum> .
PO_Number orderID = P01234> <Reference> .
. . <RefNum> Attributes
. . 100 PO_Number
. . </RefNum> .
</Reference> .
</BuyerRefNum> .

When you define a TN document type, you identify the attributes that you want Trading 
Networks to extract from the type of document. Different kinds of documents have 
different formats, so the location of attributes within a document is based on the specific 
kind of document. To identify the attributes, you specify the name of the attribute and 
how Trading Networks is to locate the attribute in the specific type of document. In 
addition, you can indicate whether you require the attribute to be extracted. If you mark 
an attribute as required and Trading Networks is unable to extract the attribute from the 
document, Trading Networks records the error.
In the TN document type (or in a processing rule), you can specify that you want Trading 
Networks to save the document to the database. If you do this, Trading Networks saves 
the custom attributes it extracts. Trading Networks saves a custom attribute only if the TN 
document type or processing rule indicates to save that attribute. 

Note: Regardless of whether you save custom attributes or not, Trading Networks always 
saves all system attributes except Signature and SignedBody.

webMethods Trading Networks Administrator’s Guide Version 7.1 223

 13. Defining and Managing Document Attributes

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. For example, if you use an attribute 
that retrieves the total order amount of a purchase order, you can query documents 
where the total order amount is over $10,000.
Generate reports about documents in your Trading Network.

For more information about document attributes, see Chapter 3, ʺSetting up Trading 

Networks to Process Documentsʺ in the webMethods Trading Networks Concepts Guide.

Defining Document Attributes

Use the following procedure to define document attributes.

Note: If new attributes are created while you have an open My webMethods session, those 
attributes will not be included in My webMethods displays until you log out then back 
into My webMethods or until you refresh your cache in My webMethods. For more 
information about how to refresh your My webMethods cache, see information about My 
webMethods user preferences in the webMethods Trading Networks User’s Guide.

To define a document attribute

1 In Trading Networks Console: View > Document Types.

2 Select Types > Document Attributes.
3 Perform one of the following procedures to begin a document attribute definition.

Method to begin a definition Procedure

New—The document attribute 
fields are empty. Click   New (yellow highlight). The New 
Document Attribute screen appears.
Duplicate—The document  Click the row containing the document attribute 
attribute fields are filled with  that you want to duplicate.
values from the document 
attribute that you duplicate.
Click   Duplicate. A copy of the document 
You can update any or all  attribute screen appears.
fields from the duplicated 
document attribute.

webMethods Trading Networks Administrator’s Guide Version 7.1 224

 13. Defining and Managing Document Attributes

4 Fill in the following fields for the custom attribute you want to add: 

For this parameter... Specify

Name The name you want to give to the attribute. You can specify 
1 to 64 characters. You can use any character except a single 
quote (ʹ).
Example: If you are defining an attribute for the price of an item 
in a purchase order, you might use the name “LineItemPrice”.
Type The data type of the attribute. Select the data type (DATETIME,
DATETIME LIST, NUMBER, NUMBER LIST, STRING, or STRINGLIST) 
from the list.
Description Optional. A description of the attribute. You can specify 1 to 
256 characters. You can use any character except a single quote 
(ʹ). 
Example: If you are defining an attribute for the price of an item 
in a purchase order, you might specify the description “The 
price of an item in a purchase order”.
Enabled Whether this attribute is enabled or not. If the document 
attribute is disabled, select this check box to enable it. For more 
information, see “Enabling Document Attributes” on page 228 
or “Disabling Document Attributes” on page 227.
Save Whether this attribute is eligible to be saved to the Trading 
Networks database. 
If you select this check box and the pre‐processing actions 
indicate to save attributes to the database, Trading 
Networks saves this attribute to the database.
If you do not select this check box and the pre‐processing 
actions indicate to save attributes to the database, Trading 
Networks does not save this attribute. Deselect this check 
box if the attribute value is needed during document 
processing, but does not need to be kept in the database.

5 Click OK to add the document attribute.

webMethods Trading Networks Administrator’s Guide Version 7.1 225

 13. Defining and Managing Document Attributes

Managing Document Attributes

The following table describes the tasks you can perform against document attributes:

Task See Page...

“Viewing Document Attributes” 226
“Updating Document Attributes” 227
“Disabling Document Attributes” 227
“Enabling Document Attributes” 228
“Determining the TN Document Types that Use an Attribute” 229

Viewing Document Attributes

You can view document attributes using the Document Attributes screen. By default, 
Trading Networks does not display disabled document attributes. However, you can 
update the display of attributes to include disabled document attributes.

To view document attributes

1 In Trading Networks Console: View > Document Types.

2 Select Types > Document Attributes.
3 To see the details about a specific document attribute, double click the row for that 
attribute.

Displaying Disabled Document Attributes

To display disabled document attributes, perform Steps 1 through 4 in the procedure 
“Viewing Document Attributes” that is described above, then perform the following 
additional step.

To display disabled document attributes

To display disabled document attributes, click   Show All to show both enabled (yellow 

light bulbs) and disabled (darkened light bulbs) items.

webMethods Trading Networks Administrator’s Guide Version 7.1 226

 13. Defining and Managing Document Attributes

Hiding Disabled Document Attributes

If disabled document attributes are currently being displayed on the Document Attributes 
screen, perform the following step to hide them.

To hide disabled document attributes

To hide disabled document attributes, click   Show Enabled to only show enabled 

(yellow light bulbs) items. Trading Networks does not display any disabled (darkened 
light bulbs) items.

Updating Document Attributes

To update a document attribute

1 In Trading Networks Console: View > Document Types.

2 Select Types > Document Attributes.
3 Click the row containing the document attribute that you want to update.
4 Right click and select Edit.
5 Update the fields you want to change. For information on what you can specify, see 
step 4 on page 225.
6 Click OK to save your changes.

Disabling Document Attributes

If you no longer want to use a document attribute, you can disable it. When you disable a 
document attribute, Trading Networks prevents you from specifying the document 
attribute when creating new or updating existing TN document types; that is, it does not 
allow you to select a disabled attribute as an item to be extracted. 
Trading Networks will continue to extract the document attribute information for existing 
TN document types that reference this attribute. You can use the attribute as search 
criteria when displaying documents in My webMethods or in the Trading Networks 
Console; however, Trading Networks no longer displays the value of the attribute in the 
details for a transaction. 
When you disable a document attribute, the definition for the document attribute is not 
removed from the database. Later, if you decide that you need the document attribute, 
you can enable it. See “Enabling Document Attributes” on page 228.

webMethods Trading Networks Administrator’s Guide Version 7.1 227

 13. Defining and Managing Document Attributes

Note: To permanently remove the document attribute from the database, your database 
administrator must remove it. When you remove a document attribute from the database, 
you must also remove all TN document types that reference this attribute and all 
documents that had this attribute extracted from them.

To disable a document attribute

1 In Trading Networks Console: View > Document Types.

2 Select Types > Document Attributes.
3 Click the row containing the document attribute you want to disable.
4 Right click and select Disable. Trading Networks places No in the Enabled column to 
indicate that the document attribute is disabled.

Enabling Document Attributes

If you disable a document attribute and then later determine that you still need it, you can 
enable it and make it available again.

Important! To perform this procedure, you must first perform the procedure described in 
“Displaying Disabled Document Attributes” on page 226.

To enable document attributes

1 In Trading Networks Console: View > Document Types.

2 Select Types > Document Attributes.
3 Click the row containing the document attribute you want to enable.
4 Right click and select Enable. Trading Networks places Yes in the Enabled column to 
indicate that the document attribute is enabled.

webMethods Trading Networks Administrator’s Guide Version 7.1 228

 13. Defining and 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. That 
is, 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. This is 
helpful, for example, if you want to disable a document attribute but first want to 
determine the TN document types that this action will affect. 

To determine TN document types that are dependent on a custom attribute

1 In Trading Networks Console: View > Document Types.

2 Select Types > Document Attributes.
3 Click the row containing the document attribute for which you want to view TN 
document type dependencies.

4 Click   Show document type dependencies.

webMethods Trading Networks Administrator’s Guide Version 7.1 229

 13. Defining and Managing Document Attributes

webMethods Trading Networks Administrator’s Guide Version 7.1 230

Chapter 14. Defining and Managing TN XML Document Types

What Are TN XML Document Types? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Identification Information in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

Extraction Information In TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

Namespace Mappings in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

Options in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

Defining TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

Managing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

webMethods Trading Networks Administrator’s Guide Version 7.1 231

 14. Defining and Managing TN XML Document Types

What Are TN XML Document Types?

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

webMethods Trading Networks Administrator’s Guide Version 7.1 232

 14. Defining and Managing TN XML Document Types

When you define namespace mappings in a TN XML document type, Trading 
Networks uses the namespace mappings you specify when applying XQL queries 
against the XML document. That is, Trading Networks uses the namespace mappings 
for both the identifying XQL queries and the XQL queries to extract attributes. For 
more information, see “Namespace Mappings in TN XML Document Types” on 
page 249.
Options. You can use the options to define items for later processing. When specifying 
the options for an XML document, you can specify: 
An IS document type that defines the structure of the XML document and that 
can be used to parse the XML document into an IData object. Trading Networks 
uses the IS document type if you invoke the wm.tn.doc.xml:bizdocToRecord service to 
convert the document content in the BizDocEnvelope to an IData object. For more 
information, see “Specifying an IS Document Type for TN XML Document Types” 
on page 254.
An IS schema that defines the structure of the XML document. Trading Networks 
uses this IS schema if you indicate you want to Trading Networks to perform the 
pre‐processing action to validate the structure of the XML document. For more 
information, see “Specifying an IS Schema for TN XML Document Types” on 
page 255.
Whether you want Trading Networks to perform any or all of the pre‐processing 
actions. Pre‐Processing actions are actions that Trading Networks performs before 
using the processing rule actions to process the XML document. For more 
information, see “Specifying Pre‐Processing Actions for TN XML Document 
Type” on page 256.

Note: You specify pre‐processing actions in both TN document types and 
processing rules. If processing rule routing is enabled, Trading Networks has 
access to the pre‐processing actions specified in a processing rule. 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. 

Whether you want Trading Networks to process a document using a processing 
rule or want to prevent Trading Networks from performing processing rule 
actions. When you disable processing rule routing, Trading Networks performs 
the pre‐processing actions defined by the TN document type; however, it does not 
search for a processing rule, nor does it perform any processing rule actions. You 
might want to disable use of a processing rule, for example, if you want Trading 
Networks to send a document to the Process Engine to be processed as part of a 
business process and do not need Trading Networks to perform any processing 

webMethods Trading Networks Administrator’s Guide Version 7.1 233

 14. Defining and Managing TN XML Document Types

rule actions. For more information, see “Disabling Processing Rule Routing” on 
page 255.

For more information about 

Recognition and processing of XML documents, see Chapter 5, ʺTrading Networks 
Document Processingʺ.
Processing of large document types, see Appendix F, “Large Document Handling”.

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 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, you must also define namespace mappings for Trading Networks to correctly 
locate the nodes identified by the XQL queries. For more information, see 
“Namespace Mappings in TN XML Document Types” on page 249.

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.
Pipeline matching variables (name and value).
You can define TN XML document types to be very general or very specific. For example, 
you can set up a TN XML document type that simply recognizes OAG documents. To be 
more specific, you can set up the TN XML document type to recognize OAG 
PROCESS_PO_004 documents. To be even more specific, 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 234

 14. Defining and Managing TN XML Document Types

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. 

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 530.

Each document that passes through your system should match exactly one TN document 
type. Trading Networks matches documents against all enabled TN document types. If a 
document matches more than one, Trading Networks cannot determine which of the 
matching TN document types it should use. 
To set up the identification information in a TN XML document type, specify one or more 
of the following items described in the table below: 

Item Description
Identifying You can specify one or more XQL queries that locate a specific node 
queries in the XML document. In addition, for each identifying query, you 
can optionally specify the value that the node must evaluate to match 
this TN XML document type.
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, you might set up the TN XML document type to 
match cXML OrderRequest from a specific sender. To do this, you 
can add a second identifying query that identifies the Identity tag 
within the Credential tag that is within the Sender tag. Then, specify the 
value that it must evaluate to, for example, Industrial Steel 
Company. 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>
.
.
.

webMethods Trading Networks Administrator’s Guide Version 7.1 235

 14. Defining and Managing TN XML Document Types

Item Description
Caution: 
The XQL queries are case‐sensitive. For example, if the tag you 
want to match in the document is <cXML> and your query 
specifies CXML, the query will not find the node and the TN 
XML document type will not be used for the document. In 
addition, if you specify a value for the query, the value is also 
case‐sensitive. If you specify the value “Industrial Steel 
Company” and the actual value in the document is “IndustRIAL 
Steel COmpany”, the values will not match and the TN XML 
document type will not be used. 
 If the documents use namespaces, you must also define 
namespace mappings for Trading Networks to correctly locate 
the nodes identified by the XQL queries. For more information, 
see “Namespace Mappings in TN XML Document Types” on 
page 249.

Note: For custom attributes that are extracted from an XML 
document, Trading Networks returns specific values for the different 
data types (e.g., STRINGLIST, STRING, NUMBERLIST, NUMBER, 
DATETIMELIST, and DATETIME). For more information, see “Extracting 
Custom Attributes From XML Documents” on page 523.

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.
Example: To identify a document that has a declared root tag value of 
cXML, you would specify cXML. For example, the document might 
contain the following document type declaration containing the 
declared root tag:
<!DOCTYPE cXML SYSTEM "cXML.dtd">
DOCTYPE You can optionally specify the system identifier or public identifier 
identifier within the XML document. These identifiers are located in the 
document type declaration (DOCTYPE) after either the “SYSTEM” or 
“PUBLIC” literal string.
Example: To identify a document that has the following DOCTYPE 
declaration, specify cXML.dtd for the value of DOCTYPE identifier:
<!DOCTYPE cXML SYSTEM "cXML.dtd">

webMethods Trading Networks Administrator’s Guide Version 7.1 236

 14. Defining and Managing TN XML Document Types

Item Description
Pipeline You can optionally specify arbitrary pipeline variables for Trading 
Matching Networks to use to identify the TN XML document type. Specify the 
Variables Name and optionally, the Value of the pipeline matching variable. If 
you specify both the Name and the Value of the pipeline matching 
variable, Trading Networks checks to see that both exist in the 
pipeline. If you specify only the Name and no Value, then Trading 
Networks checks to see if the Name exists.

Note: If you do not include any identification information in a TN XML document type, 
Trading Networks does not use the TN XML document type.

Determining the TN Document Type to Use for an XML

Document
To determine the TN document type to use for an XML document, Trading Networks 
looks at all enabled TN XML document type. For each TN XML document type, Trading 
Networks first matches the Root tag and DOCTYPE identifier values in the TN XML 
document type to the XML document. If these match, Trading Networks also checks the 
identifying queries. 
For a document to match a TN XML document type, all the identification criteria that you 
specify must match. For example, to identify a cXML OrderRequest, 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.

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, the document is considered to be an unknown type. Because Trading Networks 
cannot match the document to a TN document type:
Trading Networks cannot extract any attribute information from the document; a TN 
document type identifies the attribute information to extract.
Processing rule routing will be enabled for this document; a TN document type is 
where routing can be disabled.
When the TN document type is unknown, Trading Networks attempts to process the 
document with an unknown TN document type by performing the actions identified in 

webMethods Trading Networks Administrator’s Guide Version 7.1 237

 14. Defining and Managing TN XML Document Types

the processing rule that the document triggers. You can define 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, 
the document is considered to be an unknown type. This is because Trading Networks 
does not know which of the matching TN document types to use. In this situation, 
Trading Networks logs a message to the activity log that identifies all the TN document 
types that the document matched and treats the document as an unknown document. For 
more information, see “When an XML Document Does Not Match Any TN Document 
Types” above.
You can change this behavior by configuring Trading Networks to use the first TN 
document type that matches an incoming document. To do so, set the Trading Networks 
configuration property, tn.check.ambiguous.docs, to false. For more information, see 
Appendix D, “Trading Networks Configuration Properties”.

Extraction Information In TN XML Document Types

When Trading Networks matches a document to a TN XML document type, it uses the 
extraction information in the TN XML document type to determine the attributes that it 
needs to extract from the document. You need to specify the attributes that identify the 
pieces of information within the document that you will want to use later. Trading 
Networks also allows you to perform built‐in or custom transformations on extracted 
attribute values. If you are extracting information for a large document, see “Defining TN 
Document Type XQL Queries for Large Documents” on page 530.

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, analyzing 
transactions, and process management.
Processing Rules—Extract these system attributes to process a document based on 
the sender and receiver of the document. The sender and receiver are two of the 
criteria that Trading Networks uses to determine the processing rule to use for a 
document. For more information, see “Processing Rule Criteria” on page 341. 
Transactions—If you extract these system attributes, when viewing documents in 
My webMethods or the Console, you can refine the list of displayed documents to 
those with specific senders and receivers.
Process Management—Extract these system attributes to make the identity of the 
sender and receiver available during process management. You can then set 

webMethods Trading Networks Administrator’s Guide Version 7.1 238

 14. Defining and Managing TN XML Document Types

conditions on links in your process models that use the identity of the sender and 
receiver of a document.
DocumentID—Extract the document ID from the document if you want Trading 
Networks to be able to check for a duplicate document. That is, if you want Trading 
Networks to be able to determine whether it has already received a document. In 
addition, if you extract the document ID, when viewing documents in My 
webMethods or the Console, you can refine the list of displayed documents to those 
with a specific document ID.
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. You define the actions taken against a document during process 
management by creating a process model. For more information about creating 
process models, see the Getting Started with Business Process Management guide and the 
webMethods Designer online help. If you do not want Trading Networks to pass the 
document to process management, add a variable to the pipeline called 
prtIgnoreDocument with the value of true.

UserStatus—Extract the user status if the document contains a user status, and you 
want the user status to be available so you can process the document based on this 
user status. The user status is a criterion that Trading Networks uses to determine the 
processing rule to use for a document. For more information, see “Processing Rule 
Criteria” on page 341. In addition, if you extract this system attribute, when viewing 
documents in My webMethods or the Console, you can refine the list of displayed 
documents to those with specific user statuses.
GroupID—Extract this system attribute if it is important for you to easily access the 
group ID of a document.
SignedBody and Signature—Extract these system attributes if you want Trading 
Networks to be able to verify the digital signature of a document. For more 
information, see “Verifying the Digital Signature of an XML Document” on page 256.
In addition to the system attributes, you should extract any custom attribute that you will 
want to use later. For example, to be able to query documents based on the total order 
amount of a purchase order, you need to specify that you want the total order amount 
extracted from the document. If the documents contain a status that you will want to use 
in reports, you need to specify that you want the status from the document extracted.
To specify an attribute that you want to extract, select an existing attribute (system or 
custom) from a list. After specifying the attribute, you must specify an XQL query that 
instructs Trading Networks how to extract the attribute for the particular TN XML 
document type. To specify the XQL query, you can type the query or you can load a 
sample document to help you generate the queries. For example, you might have an 
attribute named ShippingMethod. 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 239

 14. Defining and Managing TN XML Document Types

XQL Query for ShippingMethod = /PurchaseOrder[0]/Transport[0]/Carrier[0]

<PurchaseOrder>
.
.
.
<Transport Direction = "SupplierToBuyer">
.
.
.
<Carrier>FedEx</Carrier>
.
.
The XQL query points to this tag. Trading
. Networks stores the value “FedEx” for the
</Transport> ShippingMethod attribute.
.
.
.
</PurchaseOrder>

Another attribute that you might want to extract from the above document is the direction 
of the transport. 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”, use the following query:
/PurchaseOrder[0]/Transport[@Direction 'eq' 'SupplierToBuyer']/Carrier[0]
The XQL queries are case‐sensitive. For example, if the tag you want to match in the 
document is <Carrier> and your query specifies <CARRIER>, the query will not find the node 
and Trading Networks will be unable to extract the information for the attribute. For 
examples of XQL queries, see Appendix E, “XQL Reference”.

Important!
If the XML documents you expect use equivalent namespaces but have different 
prefixes, you must also define namespace mappings for Trading Networks to correctly 
locate the nodes identified by the XQL queries. For more information, see 
“Namespace Mappings in TN XML Document Types” on page 249.
If the query does not identify a node in the XML document, Trading Networks cannot 
extract information for the attribute.

For custom attributes that are extracted from an XML document, Trading Networks 
returns specific values for the different data types (e.g., STRINGLIST, STRING, NUMBERLIST, 
NUMBER, DATETIMELIST, and DATETIME). For more information, see “Extracting Custom 
Attributes From XML Documents” on page 523.

webMethods Trading Networks Administrator’s Guide Version 7.1 240

 14. Defining and Managing TN XML Document Types

Indicating that Attributes are Required in TN XML Document

Types
When you define a TN XML document type, you can indicate that an attribute is 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.
When you indicate that an attribute is required, Trading Networks flags an error if it is 
unable to extract the document attribute, and Trading Networks sets the processing status 
to DONE W/ ERRORS when it has completed processing the document.

Note:
If you do not mark an attribute as required, Trading Networks does not flag an error if 
it is unable to extract the attribute. If Trading Networks completes processing without 
encountering any further errors, it sets the processing status to DONE.
You can require the system attributes Signed Body and Signature.

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. For more information, see “Document Recognition 
Errors Criterion” on page 345.
Use the processing rule’s Execute a service processing action to inspect the bizdoc 
variable for the errors that Trading Networks encountered. When Trading Networks 
is unable to extract an attribute that you have marked as required, Trading Networks 
records the error in the bizdoc variable. This variable is in the pipeline and is available 
for your use when Trading Networks is processing the document. For more 
information see “Action 1—Execute a Service” on page 354. For more information 
about the Execute an Integration Server processing actions, see “Action 1—Execute a 
Service” on page 354.

webMethods Trading Networks Administrator’s Guide Version 7.1 241

 14. Defining and Managing TN XML Document Types

Transformation Information for Extracted Attributes of TN

Document Types
Based on an attribute, you might also need to specify transformation information for the 
attribute, i.e., how Trading Networks is to transform the value of that attribute based on 
built‐in or custom transformations. The following table lists the attributes for which you 
can supply transform information and a description of the information that you can 
specify.

Attribute Transformation For more information, see...

SenderID or ReceiverID Specify the external ID type that  “Specifying Built‐in 
is associated with the information  Transformation 
in the document for the sender or  Information for SenderID 
receiver. For example, if the  and ReceiverID” on 
sender is identified in the  page 243
document using a D‐U‐N‐S 
number, specify the external ID 
type DUNS for the detail.
Attributes with the  Specify the format that is used for  “Specifying Built‐In 
data type DATETIME the date in the document. For  Transformation 
and DATETIME LIST example, if the date is 2000/05/31,  Information for 
you would specify yyyy/MM/dd  Attributes with the 
for the format. DATETIME and 
DATETIME LIST Data 
Type” on page 243
Attributes with the  Specify whether you want  “Specifying Built‐in 
data type STRING  Trading Networks to alter the  Transformation 
(other than SenderID  string value before storing the  Information for 
or ReceiverID) and  value. Attributes with the 
STRING LIST STRING or STRING LIST 
Data Type” on page 244
Attributes that  Specify the built‐in  “Specifying Built‐in 
represent an array of  transformation you want Trading  Transformation 
numbers Networks to take on the array of  Information for 
numbers: Average, Minimum,  Attributes with the 
Maximum, or Sum. For example, if  NUMBER Data Type” on 
you want Trading Networks to  page 246
average the values in the array 
and store that for the attribute, 
specify Average for the detail.
All attributes You can write your own service  “Specifying a Custom 
to transform attributes. Transformation Service” 
on page 248

webMethods Trading Networks Administrator’s Guide Version 7.1 242

 14. Defining and Managing 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, you need to specify how the sender or receiver is identified within the 
document. For example, 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, specify 
the XQL query to identify the location of the receiver information and select the external 
ID type DUNS for the transformation.

XQL Query for ReceiverID = /PurchaseOrder[0]/OrderHeader[0]/DUNS[0]

<PurchaseOrder>
<OrderHeader>
<CorpName>Industrial Steel Company</CorpName>
<DUNS>123456789</DUNS>
</OrderHeader>
. The XQL query points to this tag. Trading Networks stores
. the value “123456789” for the ReceiverID attribute and
. associates it with the external ID type DUNS.
</PurchaseOrder>

The Document Types screen that you use to create TN document types contains a list of 
the external ID types you can select. 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.

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 requires you to identify the date format. Trading Networks maintains a list of 
built‐in common date/time formats from which you can select. However, if the date/time 
format you need to use is not in the list, you can type the format you need. 
To specify the date/time format, use a pattern string based on the “Time Format Syntax” 
described for the java.text.SimpleDateFormat class. For example, if you want the 
requested delivery date extracted from the following sample CBL document, specify the 
XQL query to identify the location of the RequestedDeliveryDate attribute and specify the 
date format yyyyMMdd'T'hh:mm:ss.

webMethods Trading Networks Administrator’s Guide Version 7.1 243

 14. Defining and Managing TN XML Document Types

XQL Query for RequestedDeliveryDate = /PurchaseOrder[0]/OrderHeader[0]/RequestedDeliveryDate[0]

<PurchaseOrder>
<OrderHeader>
<RequestedDeliveryDate>20000829T01:01:01</RequestedDeliveryDate>
.
.
The XQL query points to this tag. Trading Networks uses
. the value “20000829T01:01:01” for the
</OrderHeader> RequestedDeliveryDate attribute and uses the date format
. you specify to convert the date to a java.sql.Timestamp.
.
.
</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. You can have Trading Networks make a simple alteration to change the case of 
the extracted string values to all upper‐ or all lowercase. Alternatively, you can have 
Trading Networks use the extracted values as substitutions in a string that you supply. If 
you do not specify transformation information for a string attribute, Trading Networks 
saves the data exactly as it extracted it.
The following table describes each of the built‐in transformation options you can use for 
string attributes.

If you specify this

format... Trading Network stores...
Uppercase The extracted string attribute value in all uppercase. For example, 
if the extracted attribute value is “Purchase Order”, Trading 
Networks stores “PURCHASE ORDER” for the attribute value.
Lowercase The extracted string attribute in all lowercase. For example, if the 
attribute value is “Purchase Order”, Trading Networks stores 
“purchase order” for the attribute value.

webMethods Trading Networks Administrator’s Guide Version 7.1 244

 14. Defining and Managing TN XML Document Types

If you specify this

format... Trading Network stores...
String Substitution The pattern that you specify using the information that Trading 
Networks extracts to replace the arguments (e.g., {0}) you specify 
in the pattern. Trading Networks uses the 
java.text.MessageFormat class to substitute the extracted values 
into the pattern that you specify.
For example, you might specify the pattern 
Items Ordered: {0}, {1}, {2}, and specify an XQL query for 
the attribute that extracts the following array of values:

0 Cellular phone
1 Belt clip
2 Rapid mobile charger

Trading Networks would store the following for the value of the 
attribute:
Items Ordered: Cellular phone, Belt clip, Rapid mobile charger
If you place more arguments in the pattern than values that 
Trading Networks extracts, the string that Trading Networks 
stores in the database for the attribute will contain the extra 
arguments (e.g., {2}). If you specify less arguments in the pattern 
than values that Trading Networks extracts, the string that 
Trading Networks stores in the database for the attribute will not 
contain all the extracted values; it will only contain the values for 
the number of arguments you specify in the pattern.

webMethods Trading Networks Administrator’s Guide Version 7.1 245

 14. Defining and Managing TN XML Document Types

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. When the XQL query for an attribute identifies an array of numbers, 
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… Trading Networks stores…
Average The average value of all the numbers in the array. For example, if 
the array contains the numbers [2, 3, 4, 5], Trading Networks stores 
the value 3.5.
Minimum The smallest number in the array. For example, if the array 
contains the numbers [2, 3, 4, 5], Trading Networks stores the 
value 2.
Maximum The largest number in the array. For example, if the array contains 
the numbers [2, 3, 4, 5], Trading Networks stores the value 5.
Sum The sum of all the numbers in the array. For example, if the array 
contains the numbers [2, 3, 4, 5], Trading Networks stores the 
value 14.
No format  The first value of the array as the value of the attribute. For 
specified example, if the array contains the numbers [2, 3, 4, 5], Trading 
Networks stores the value 2.

Note: When Trading Networks extracts a NUMBER or NUMBER LIST from a document, it uses 

the number parsing behavior of java.lang.Number. For example, if the NUMBER or NUMBER
LIST contains the value “100zzz”, Trading Networks interprets the value as “100”, instead 
of throwing an error as it would if the value were “zzz100”. If you want to redefine this 
parsing behavior, you can write a custom attribute transformation. For more information 
about custom transformations, see below, “Specifying a Custom Transformation Service”.

webMethods Trading Networks Administrator’s Guide Version 7.1 246

 14. Defining and Managing TN XML Document Types

The following sample CBL document shows two line items and the quantity to purchase 
of each. To store the total number of items ordered in the attribute TotalItems, specify an 
XQL query that specifies an array of numbers that contains the quantity of each line item, 
and specify the format SUM.

XQL Query for TotalItems =

/PurchaseOrder[0]/ListOfOrderDetail[0]/OrderDetail[]/BaseItemDetail[0]/Quantity[0]/Qty[0]

<PurchaseOrder>
. This element of the query indicates to
. select all occurrences of <OrderDetail>
. tags.
<ListOfOrderDetail>
<OrderDetail>
<BaseItemDetail>
<LineItemNum>1</LineItemNum>
.
.
.
<Quantity>
<Qty>10</Qty>
</Quantity>
.
.
.
<BaseItemDetail>
</OrderDetail> The XQL query points to these tags.
<OrderDetail> Trading Networks uses the SUM
<BaseItemDetail> format and stores the value 15 for the
<LineItemNum>2</LineItemNum> TotalItems attribute.
.
.
.
<Quantity>
<Qty>5</Qty>
</Quantity>
.
.
.
<BaseItemDetail>
</OrderDetail>
<ListOfOrderDetail>
.
.
.
</PurchaseOrder>

webMethods Trading Networks Administrator’s Guide Version 7.1 247

 14. Defining and Managing TN XML Document Types

Specifying a Custom Transformation Service

Trading Networks allows you to create your own service to perform transformations on 
extracted attributes. The following table describes the specification you should use to 
create the custom transformation service based on the data type.

Data type Specification you must use…

DATETIME or The service must implement the input and output variables that 
DATETIME LIST are defined in the wm.tn.rec:DateAttributeTransformService specification.
STRING or The service must implement the input and output variables that 
STRING LIST are defined in the wm.tn.rec:StringAttributeTransformService specification.
NUMBER or The service must implement the input and output variables that 
NUMBER LIST are defined in the wm.tn.rec:NumberAttributeTransformService
specification.

For more information about the inputs and outputs, see the section “Setting Input and 
Output Values for Custom Transformation Services” below. 
To view these specifications, use webMethods Developer. The specifications are located in 
the WmTN package. For more information about these specifications, see the webMethods 
Trading Networks Built‐in Services Reference.

Setting Input and Output Values for Custom Transformation Services

For custom transformation services, Trading Networks passes the following input 
variables:

Input Value Meaning

values  One or more values for your service to transform. 

Note: The values may be null or an empty (zero length) string. For 
an array data type (e.g., DATETIME LIST), any element in the values 
array can be null or an empty string. Make sure that your custom 
transformation service can handle null values or empty strings. 

isArray Whether values contains a single value to transform or multiple 
values to transform.
arg Optional arguments that you can define

webMethods Trading Networks Administrator’s Guide Version 7.1 248

 14. Defining and Managing TN XML Document Types

As output, Trading Networks expects that you return the transforms values in the 
following output variable:

Output Value Meaning

newValues 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 the input variable isArray is false, the input variable values will 
contain only a single item to transform. 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. It should store each as an item in the output 
variable newValues. For example, if you are transforming string data, 
newValues is a Date List of the transformed Strings.

For information about creating the service, see the webMethods Developer User’s Guide.

Namespace Mappings in TN XML Document Types

If you receive XML documents that use namespaces, you might want to include 
namespace mappings in your TN XML document types. This section provides 
information about namespaces, how namespaces affect XQL queries against XML 
documents, what namespace mappings are, and how to set up namespace mappings.

XML Documents and Namespaces

Namespaces are used in an XML document to distinguish between elements that come 
from different sources. A set of elements (or tags) from a specific source is assigned to a 
specific namespace. For example, a document might contain elements that are part of a 
standard and also custom elements. 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. 

webMethods Trading Networks Administrator’s Guide Version 7.1 249

 14. Defining and Managing TN XML Document Types

<order xmlns:standard="http://www.standards.org"
xmlns:custom="http://www.unitedsteel.com/orderDocs">
The namespace is associated with a
URI that uniquely identifies the
<standard:buyer>
<standard:DUNS>987654321</standard:DUNS> The namespace is associated with
<standard:company>SMK Products</standard:company> a string that is used as a prefix in
the names of elements
<custom:contact>Mr. Smith</custom:contact>
<custom:customerNum>01031995</custom:customerNum>
</standard:buyer> The xmlns attribute defines a
namespace
<standard:seller>
<standard:DUNS>123456789</standard:DUNS>
<standard:company>United Steel</standard:company>
<custom:contact>Mr. Jones</custom:contact>
</standard:seller> This element is in the standard
namespace
<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>
This element is in the custom
</order> namespace

XML documents that use namespaces contain the xmlns attribute, which defines a 
namespace. Each namespace is associated with a URI. Note that the URI does not have to 
point to anything. It is used to uniquely identify the namespace. 
Elements are considered to be in the same namespace if they are all associated with the 
same URI. The xmlns attribute specifies the URI for a namespace and optionally, a prefix 
associated with that namespace. When a namespace is associated with a string, this string 
is used as a prefix when naming the elements in that namespace, which allows you to 
easily identify the elements that belong to a specific namespace. For example, if a 
document contains a namespace that is associated with the prefix string standard and the 
quantity element is in the standard namespace, the element is represented in the XML 
document as <standard:quantity>. 
The exception for naming elements in a namespace with a prefix is when the elements 
belong to the default namespace. When an XML document uses a default namespace, the 
elements in the default namespace do not use a prefix. The documents with a default 
namespace contain an xmlns attribute that specifies only the URI for a namespace, for 
example:
xmlns=“http://www.standards.org”

webMethods Trading Networks Administrator’s Guide Version 7.1 250

 14. Defining and Managing TN XML Document Types

How Namespaces Affect Identifying and Attribute XQL Queries

If an XML document uses namespaces, the elements in that document might be prefixed 
with a string. When you create XQL queries to identify elements within the document, for 
example, identifying queries or queries that locate document attributes, the XQL queries 
include the prefix. For example, the XQL query to identify the <standard:buyer> 
element in the XML document shown above is:
/Order[0]/standard:buyer

However, not all documents use the same prefix for the same namespace. For example, 
one document might use standard for a prefix and another might use CBL_standard. 
Namespaces are the same if they identify the same URI, not the same prefix. As a result, 
the following xmlns attributes identify the same namespace:
xmlns:standard=“http://www.standard.org/”
xmlns:CBL_standard=“http://www.standard.org/”

As a result, if the above xmlns attributes are used in two different documents, the XQL 
queries for elements within those documents are different: For example, the following 
XQL queries might represent the same elements:
/Order[0]/standard:buyer
/Order[0]/CBL_standard:buyer

However, if you execute the /Order[0]/standard:buyer XQL query against the 
document that uses the prefix CBL_standard, the XQL query will fail.
The solution to this problem is namespace mappings. In a TN XML document type, you 
define namespace mapping to identify all the prefixes that point to the same URI (in other 
words, identify the same namespace).

Namespace Mappings
Namespace mappings map the prefixes used by namespaces to the URIs used by those 
namespaces. With this information, if Trading Networks receives an XML document that 
contains a prefix that you have in the namespace mappings, it can make the appropriate 
substitutions in the XQL queries, if necessary, so that the queries find the elements of the 
XML document as expected.
For example, you create your TN XML document type using a sample document that uses 
the following namespace:
xmlns:standard=“http://www.standard.org/”

You have a trading partner that sends you documents, but the trading partner uses the 
following namespace:
xmlns:CBL_standard=“http://www.standard.org/”

Note that the URIs are identical meaning it is the same namespace; however, the prefixes 
are different. To accommodate the different prefixes, the TN XML document type 
contains the following namespace mappings:

webMethods Trading Networks Administrator’s Guide Version 7.1 251

 14. Defining and Managing TN XML Document Types

Prefix URI
standard http://www.standard.org/
CBL_standard http://www.standard.org/

With this namespace mapping, a TN XML document type definition can use the XQL 
query /Order[0]/standard:buyer, and Trading Networks will make the proper 
substitution for a document that uses the CBL_standard prefix rather than the standard 
prefix.

With the namespace mapping, the following XQL query will locate the "buyer" element in either of the following
documents.
XQL query = /order[0]/standard:buyer

<order xmlns:standard="http://www.standards.org"
xmlns:custom="http://www.unitedsteel.com/orderDocs"> The XQL query points to this element
in this document
<standard:buyer>
<standard:DUNS>987654321</standard:DUNS>
<standard:company>SMK Products</standard:company>
<custom:contact>Mr. Smith</custom:contact>
<custom:customerNum>01031995</custom:customerNum>
</standard:buyer>

</order>

<order xmlns:CBL_standard="http://www.standards.org"
The XQL query points to this element
xmlns:custom="http://www.unitedsteel.com/orderDocs"> in this document

<CBL_standard:buyer>
<CBL_standard:DUNS>987654321</CBL_standard:DUNS>
<CBL_standard:company>SMK Products</CBL_standard:company>
<custom:contact>Mr. Smith</custom:contact>
<custom:customerNum>01031995</custom:customerNum>
</CBL_standard:buyer>

</order>

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 you do not define namespace mappings, the identifying XQL 
queries and the XQL queries that locate document attributes will fail. As a result, if the TN 
XML document types use identifying queries, Trading Networks will not match the 
document to the TN XML document type. If the TN XML document type specifies XQL 
queries to locate and extract attribute information, those queries will fail and Trading 
Networks will not extract the attribute information.

webMethods Trading Networks Administrator’s Guide Version 7.1 252

 14. Defining and Managing TN XML Document Types

To define namespace mappings, you can define them manually, or if you are using a 
sample document, 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.
When defining namespace mappings, keep the following guidelines in mind: 

Guideline Sample
Each prefix in the namespace 
mappings table for a TN XML  Prefix URI
document type must be unique.
aaa http://www.ww.com
bbb http://www.xx.com
ccc http://www.yy.com
ddd http://www.zz.com

The URIs you list in the 
namespace mappings table do not  Prefix URI
have to be unique. You can define 
more than one prefix to the same  aaa http://www.xx.com
URI. bbb http://www.xx.com
ccc http://www.xx.com
ddd http://www.xx.com

To define a mapping for the 
default namespace (which does  Prefix URI
not use a prefix), use the literal 
prefix0 http://www.yy.com
string prefix0 for the prefix.

Note: Because Trading Networks uses the literal prefix0 to identify the default 
namespace, you should not use prefix0 as the prefix in any document.

Additionally, be sure to include a mapping for each prefix/URI combination that you 
expect to receive in XML documents from your trading partners. If Trading Networks 
receives a document that uses a prefix not defined in the namespace mappings table, it 
performs a literal match of the XQL queries against the document.

webMethods Trading Networks Administrator’s Guide Version 7.1 253

 14. Defining and Managing TN XML Document Types

Options in TN XML Document Types

When Trading Networks matches a document to a TN XML document type, it uses the 
options you specify. 

Use this option... To...

IS Document Type Associate an IS document type with documents identified by the 
TN XML document type.
IS schema to Associate an IS schema with documents identified by the TN XML 
validate against document type. Trading Networks uses the IS schema to validate 
documents. 
Processing Rule Whether you want Trading Networks to search for a processing 
Routing rule to use to process the documents identified by the TN XML 
document type. If you disable routing, Trading Networks 
performs the pre‐processing actions defined by the TN document 
type; however, it does not search for a processing rule, nor does it 
perform any processing rule actions. You might disable routing, 
for example, if you extract a conversation ID and the document 
will be processed as part of a business process.
Pre-Processing Specify actions that you want Trading Networks to perform on 
actions documents identified by the TN XML document type before 
Trading Networks uses the processing rule actions to process the 
document. You can select one or more of the following 
preferences:
Verify the digital signature of a document.

Validate the structure of a document using the IS schema that 
you specified for the Schema to validate against option.
Check for duplicate document using built‐in or custom 
services; that is, determine whether Trading Networks has 
already received the document.
Save a copy of the document content, attributes, and/or log 
information to the database.

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 identify the IS document type 
by specifying its fully‐qualified name. The Document Types screen allows you to browse 
IS document types to locate the one you want to use.

webMethods Trading Networks Administrator’s Guide Version 7.1 254

 14. Defining and Managing TN XML Document Types

Specify an IS document type if you plan to execute the wm.tn.doc.xml:bizdocToRecord built‐in 
service against the document. This service transforms an XML document into an IS 
document (IData object) based on the blueprint defined by the specified IS document 
type. For more information about the wm.tn.doc.xml:bizdocToRecord built‐in service, see the 
webMethods Trading Networks Built‐in Services Reference. 

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 identify the IS schema by specifying its fully‐qualified 
name. If you do not know the fully‐qualified name, the Document Types screen allows 
you to browse IS schemas to locate the one you want to use.
Specify an IS schema if you want Trading Networks to be able to validate the structure of 
an XML document. For more information, see below, “Specifying Pre‐Processing Actions 
for TN XML Document Type” on page 256.

Disabling Processing Rule Routing

You specify whether you want Trading Networks to process documents identified by the 
TN XML document type using actions in a processing rule.
When processing rule routing is enabled, Trading Networks searches for a processing rule 
for the document and proceeds to perform the pre‐processing and processing actions 
as defined by that processing rule.
When processing rule routing is disabled, Trading Networks performs the pre‐processing 
actions defined by the TN document type; however, it does not search for a 
processing rule, nor does it perform any processing rule actions.
If you do not want Trading Networks to perform processing rule actions, disabling 
routing improves performance because Trading Networks does not use processing 
time to search for a processing rule. 
You might want to disable processing if the document is to be processed as part of a 
business process. Even when processing rule routing is disabled, if the TN document 
type instructs Trading Networks to extract the ConversationID system attribute, 
Trading Networks will pass the document to the Process Engine, which in turn will 
determine the process model to use to process the document.

webMethods Trading Networks Administrator’s Guide Version 7.1 255

 14. Defining and Managing TN XML Document Types

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. You specify pre‐processing actions in both TN 
document types and processing rules. The pre‐processing actions in a processing rule 
indicate whether Trading Networks is to use the settings from the TN document type or to 
override the TN document type settings. 
You can specify the following pre‐processing actions for TN document types. Trading 
Networks performs the pre‐processing actions in the following order.

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. To 
use this pre‐processing action, the TN document type must instruct Trading Networks to 
extract the SignedBody and Signature system attributes. The signature that Trading 
Networks extracts must be a PKCS#7 detached signature of the signed body. 
To verify that the document arrived unchanged, Trading Networks assures the signed 
body has not changed by verifying the digital signature. To verify that the sender is who it 
claims to be, Trading Networks matches the certificate from the digital signature to the 
certificate that Trading Networks has in the Trading Networks database. This certificate 
on file with Trading Networks is the one identified in that partner’s profile on the Security 
tab, Verify sub‐tab. If the partner’s profile does not contain the certificates to use for 
verification, Trading Networks cannot verify the digital signature.

For more information about how Trading Networks verifies the digital signature, see 

Appendix B, ʺSecurity within Trading Networksʺ in the webMethods Trading Networks 
Concepts Guide.

Regardless of whether Trading Networks determines the digital signature is valid, it 
continues performing the rest of the pre‐processing actions. It also performs the 
processing actions that are defined in the processing rule. If the digital signature is not 
valid, the processing actions can access the error information from the pipeline. For more 
information about the pipeline variables that are available to processing actions, see 
“Action 1—Execute a Service” on page 354.
If Trading Networks is instructed to use the Save Document to Database pre‐processing 
action to save information about the document to the database, Trading Networks also 
logs the error to the activity log.

webMethods Trading Networks Administrator’s Guide Version 7.1 256

 14. Defining and Managing TN XML Document Types

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. To use this pre‐processing action, you must specify an IS schema in 
the TN XML document type.
To validate the structure of the document, Trading Networks assures that the XML 
document matches the structure identified by the IS schema using the pub.schema:validate 
built‐in service. For more information about this service, see the webMethods Integration 
Server Built‐In Services.
Regardless of whether the Trading Networks determines the document structure is valid, 
it continues performing the rest of the pre‐processing actions. It also performs the 
processing actions that are defined in the processing rule. If the document structure is not 
valid, the processing actions can access the error information from the pipeline. For more 
information about the pipeline variables that are available to processing actions, see 
“Action 1—Execute a Service” on page 354.
If Trading Networks is instructed to use the Save Document to Database pre‐processing 
action to save information about the document to the database, Trading Networks also 
logs the error to the activity log. 

Important! If the structure of a document is not valid, the validation service can return 
many error messages. To limit the number of error messages, set the tn.doc.validate.max_errs 
property in the Trading Networks properties file. For example, to limit the number of 
errors to ten, specify the following:
tn.doc.validate.max_errs=10

For more information, see “Trading Networks Configuration Properties” on page 42.

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. Trading Networks checks the 
document being processed against either built‐in services or custom services. 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.
You can have Trading Networks determine whether the document is a duplicate using a 
built‐in or custom duplicate check service.
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. To check for a duplicate 
document using the document ID, you must instruct Trading Networks to extract 
the DocumentID system attribute from the document.

webMethods Trading Networks Administrator’s Guide Version 7.1 257

 14. Defining and Managing TN XML Document Types

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. 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.
Document ID, sender and receiver—Trading Networks assures that it does not 
already have a document with the same document ID, sender, and receiver in its 
database. To check for a duplicate document using the document ID, sender, and 
receiver, you must instruct Trading Networks to extract the DocumentID, SenderID, 
and ReceiverID system attributes from the document.
Document ID, sender and document type—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 
and sender you must instruct Trading Networks to extract the DocumentID and 
SenderID system attributes from the document.
Custom services—Use a service that you create to determine whether a document is a 
duplicate. For more information, see “Creating a Duplicate Document Check Service” 
on page 352.

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. 

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. 
Trading Networks previously received a document and saved it to the database, but 
did not extract the DocumentID, SenderID, and/or ReceiverID system attributes from the 
document.
You selected the Document ID, sender and document type option and Trading Networks 
was unable to match the document to a TN document type.
Trading Networks saves the results of the duplicate document check to the pipeline. As a 
result, it is available for your use in processing actions that you define in the processing 
rule. For more information about the pipeline variables that are available to processing 
actions, see “Action 1—Execute a Service” on page 354.
Additionally, Trading Networks uses the results of the duplicate document check in the 
Save Document to Database pre‐processing action.

webMethods Trading Networks Administrator’s Guide Version 7.1 258

 14. Defining and Managing TN XML Document Types

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, only unique documents, or do not save the document to the 
database. In addition, if you want Trading Networks to use reliable delivery or scheduled 
delivery to deliver XML documents, you must have Trading Networks save the document 
to the database. For more information, see “Using Reliable Delivery with Immediate 
Delivery Method” on page 367 or “Using Reliable Delivery with Scheduled Delivery” on 
page 368. 
If you choose to not save the document, Trading Networks maintains no information 
about this document after it processes the document. Certain delivery options require 
saving the document content to the database, for example, if you want to deliver a 
document via a queue. 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, Trading 
Networks will bypass reliable delivery and invoke the specified delivery service once.
When you specify this pre‐processing action, you select whether Trading Networks is to 
save all documents (i.e., save the document regardless of whether it is unique, even if 
there is a duplicate) or only if the document(s) is unique (i.e., there is no duplicate). If you 
want Trading Networks to save document(s) to the database only if it is unique, you must 
specify the Check for Duplicate Document pre‐processing action.
If you do not have Trading Networks perform the Check for Duplicate Document 
pre‐processing action, it has not determined whether the document has a duplicate. In this 
situation, Trading Networks considers the document as having no duplicate and will save 
the unique document to the database. For more information about the Check for Duplicate
Document pre‐processing action, see the previous section, “Checking for Duplicate of the 
XML Document”.
You can save a copy of the document(s) content, attributes, and/or log information to the 
database. The following table displays the consequences of not saving specific options:

If you do not save

this option... Then the consequences of not saving are...
Content If you use the Deliver Document actions, Trading Networks will 
not use reliable delivery.
You will not be able to view content from My webMethods or 
Trading Networks Console.
You will not be able to resubmit or re‐process the document.

webMethods Trading Networks Administrator’s Guide Version 7.1 259

 14. Defining and Managing TN XML Document Types

If you do not save

this option... Then the consequences of not saving are...
Attribute You will not be able to view custom attributes from My 
webMethods or Trading Networks Console (i.e., attributes will 
contain only information for system attributes). However, you 
can still use the processing rules extended criteria for the 
document.
You cannot search for documents in My webMethods or 
Trading Networks Console based on the values of custom 
attributes.
You might get different or unexpected results when you 
reprocess a document. Because the attributes are not saved 
when you reprocess the document, Trading Networks will not 
match processing rules that use extended criteria. Instead, 
Trading Networks will match to another processing rule, for 
example the default processing rule, and perform the process 
actions identified in that matching rule. Trading Networks does 
not perform document recognition again and therefore does not 
re‐extract the attributes. 
For example, if you use extended criteria to select a processing 
rule when the value of the custom attribute Total Amount is 
greater than 10000, 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.
Note that you can still resubmit a document. When Trading 
Networks resubmits a document, it performs document 
recognition and therefore extracts the attributes again.
Activity Log You will not be able to view activity log entries from My 
webMethods or Trading Networks Console.

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. Trading Networks passes documents on to project management if it extracted a 
conversation ID from the document. For more information about process management, 
see the Getting Started with Business Process Management and the webMethods Designer 
online help.

webMethods Trading Networks Administrator’s Guide Version 7.1 260

 14. Defining and Managing TN XML Document Types

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. 
When you create a TN XML document type, you specify XQL queries that locate specific 
nodes in the document; that is, 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.
Using a sample document—When you use a sample document, creating the XQL queries 
is simplified because you highlight the node in the sample document and Trading 
Networks forms the query for you. You can use a sample document that you have 
stored in your file system. Alternatively, you can use a document that was sent to 
Trading Networks for processing and is in the Trading Networks database. For 
example, Trading Networks might have received a document for which there is no 
matching TN document type, in other words, a document with an unknown TN 
document type. To create a TN document type for that document, you can use the 
document as the sample document when creating the TN document type.
Not using a sample document—When you do not use a sample document, you need to 
know the required XQL queries and type them in yourself.

Note: If new TN document types are created while you have an open My webMethods 
session, those TN document types will not be included in My webMethods displays until 
you log out then back into My webMethods or until you refresh your cache in My 
webMethods. For more information about how to refresh your My webMethods cache, 
see information about My webMethods user preferences in the webMethods Trading 
Networks User’s Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 261

 14. Defining and Managing 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. For a summary of actions you can take against a sample document, see 
“Working with a Sample Document” on page 271.

To define a TN XML document type using a sample document

1 In Trading Networks Console, perform one of the following procedures to start a new 
TN XML document type and load a sample document.

Method to start a TN XML

document type Procedures when you have a sample document loaded

New— The TN XML  1) Select View > Document Types.

document type fields are 
2) Select Types > New > XML.
empty, and you load a 
sample document from the  3) In the Create New DocType dialog box, select 
file system. the XML document type category from the list.
4) In the Document Types Details dialog box, 
click the Identify tab.

5) Click   Select Sample Document.

6) In the Select File dialog box, browse your file 
system to locate the XML document that you 
want to use as a sample, and click Open.
Duplicate— The TN XML  1) Select View > Document Types.
document type fields are 
2) Click the row containing the TN XML 
filled with values from the 
document type that you want to duplicate.
TN XML document type that 
you duplicate, and you load a  3) Select Types > Duplicate.
sample document from the 
file system. 4) Click the Identify tab.

You can update any or all  5) Click   Select Sample Document.

fields from the duplicated TN 
XML document type. 6) In the Select File dialog box, browse your file 
system to locate the XML document that you 
want to use as a sample, and click Open.

webMethods Trading Networks Administrator’s Guide Version 7.1 262

 14. Defining and Managing TN XML Document Types

Method to start a TN XML

document type Procedures when you have a sample document loaded

From Saved Document—The  1) From Trading Networks Console, use the 

TN XML document type  Transaction Analysis screen to display the 
fields are empty and the  sample document that you want to use. If you 
sample document from the  need procedures for viewing documents on 
Trading Networks database  the Transaction Analysis screen, see 
is loaded for you. webMethods Trading Networks User’s Guide.
2) Click the row containing the document for 
which you want to create a TN XML 
document type.
3) Select Transactions > Create/Edit Document Type.

Note: Trading Networks displays a tree view of the XML document in the left side on 
the screen. To view the document source, click Show Source.
2 Type the name you want to give the TN XML document type in the Name field. This 
field is required.
3 Optionally, type a description for the TN XML document type in the Description field.
4 Click the Identify tab. Perform one or more of the following procedures to specify 
information that indicates how Trading Networks is to identify documents. For 
details about specifying any of this information, see “Identification Information in TN 
XML Document Types” on page 234.
Note: If you do not specify any identification information in a TN document type, 
Trading Networks does not use the TN document type.

webMethods Trading Networks Administrator’s Guide Version 7.1 263

 14. Defining and Managing TN XML Document Types

For this Identify tab

parameter… Use this procedure when using a sample document

Identifying Queries 1) In the sample document, select the node that you want the 

identifying query to represent. 
When you select a node, Trading Networks fills in the 
Query field with the XQL query for the selected node and 
displays the value in the Value field.
Note: This “filled in” query is for a specific node in the XML 
document. This node is applicable for DATETIME, STRING, or 
NUMBER data types. But, if you want to use DATETIME LIST, 
STRING LIST, NUMBER (with Average, Minimum, Maximum, and 
Sum), or NUMBERLIST data types, you need to update the 
query so that it identifies an array of values.
For information about XQL queries, see Appendix E, 
“XQL Reference”.
2) Right click and select Add an identifying query.
Trading Networks displays the Add an identifying query 
dialog box. 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.
If you want the TN XML document type to require the 
identifying query to evaluate to a value, specify the 
value in the Value field.
If you do not want the TN XML document type to 
require the identifying query to evaluate to a specific 
value, clear the Value field.
3) Click OK. 
Trading Networks adds the identifying query to the list on 
the right. 

webMethods Trading Networks Administrator’s Guide Version 7.1 264

 14. Defining and Managing TN XML Document Types

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: 
To delete a query from the TN document type, select 

the query row and click  Delete selected identifying

query.
To view (in the sample document) the node that a 
query represents, select the query row and click   
Show node. 
Root Tag Click the Set button next to the Root Tag field. Trading 
Networks determines the root tag of the sample document and 
uses its value to populate the Root Tag field.
DOCTYPE Identifier 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. If both literal strings 
exist, Trading Networks uses the value after the SYSTEM 
literal string. Trading Networks populates the DOCTYPE
Identifier field with the value it obtains from the document type 
declaration in the sample document.
Pipeline Matching
1) Click   Add New Pipeline Match. 
2) Specify the following values in the Add Pipeline Matching 
dialog box.
Name. Name of the pipeline matching variable.
Value. The value of the pipeline matching variable. 
This field is optional. If you specify both the Name and 
the Value of the pipeline matching variable, Trading 
Networks checks to see that both exist in the pipeline. 
If you specify only the Name and no Value, then 
Trading Networks checks to see if the Name exists. 
3) Click OK. Trading Networks adds the pipeline matching 
variable to the list. 
4) Repeat this procedure for each pipeline matching variable 
that you want to add.

webMethods Trading Networks Administrator’s Guide Version 7.1 265

 14. Defining and Managing TN XML Document Types

Important! You must supply at least one criterion that Trading Networks is to use to 
recognize an XML document; that is, you must supply at least one identifying query, 
a value for the Root Tag field, a value for the DOCTYPE Identifier field, or a pipeline 
matching variable.

5 Click the Extract tab. Perform the following procedure for each attribute that you want 
Trading Networks to extract from documents identified by this TN XML document 
type. For details about what to specify for these fields, see “Extraction Information In 
TN XML Document Types” on page 238.
a In the sample document, select the node that represents the attribute that you 
want Trading Networks to extract.
b Right click and select Add an attribute.
Trading Networks displays the Add an attribute dialog box. Trading Networks 
fills the Query field with the XQL query for the node that you selected. 
Note: This “filled in” query is for a specific node in the XML document. This node 
is applicable for DATETIME, STRING, or NUMBER data types. But, if you want to use 
DATETIME LIST, STRING LIST, NUMBER (with Average, Minimum, Maximum, and Sum), or 
NUMBERLIST data types, you need to update the query so that it identifies an array 
of values.
c In the Name field, select the name of the attribute from the list. Trading Networks 
fills in the Description and Type fields based on the document attribute definition. 
d If you want Trading Networks to flag an error if it encounters an error attempting 
to extract this document attribute, select the Required check box. For more 
information, see “Indicating that Attributes are Required in TN XML Document 
Types” on page 241.
e Use the Transformation option to specify how Trading Networks is to handle 
attribute data before storing it in the Trading Networks database. The data type of 
the attribute (shown in the Type field) determines the Built-in or Custom 

webMethods Trading Networks Administrator’s Guide Version 7.1 266

 14. Defining and Managing TN XML Document Types

transformation options available. For more information, see “Transformation 
Information for Extracted Attributes of TN Document Types” on page 242.
1 Built-in. Select an existing built‐in transformation provided by Trading 
Networks. 

If the attribute data

type is… For Transformation…

Is SenderID or You must specify an external ID type. For more 
ReceiverID information, see “Specifying Built‐in Transformation 
Information for SenderID and ReceiverID” on 
page 243.
Has DATETIMEor You must specify a date format. Select one from the 
DATETIME LIST seven different built‐in formats or type in your own. 
data type For more information, see “Specifying Built‐In 
Transformation Information for Attributes with the 
DATETIME and DATETIME LIST Data Type” on 
page 243.
Has STRING or You can specify whether you want Trading Networks 
STRING LIST data to alter the string value before storing it to UPPERCASE 
type (but not or LOWERCASE. For more information, see “Specifying 
SenderID or Built‐in Transformation Information for Attributes 
ReceiverID) with the STRING or STRING LIST Data Type” on 
page 244.
Has NUMBER data You should specify the operation that Trading 
type and the XQL Networks should perform on the numbers in the 
query identifies an array. For more information, see “Specifying Built‐in 
array of numbers Transformation Information for Attributes with the 
NUMBER Data Type” on page 246.

2 Custom. Select or create your own service to perform custom transformations 
on extracted attributes. For more information, see “Specifying a Custom 
Transformation Service” on page 248.

To do this… Perform this…

Create a new custom 
transformation Click  New Service.

Select an existing custom 
transformation service Click  Find Service to browse the IS namespace 
to locate the one you want to use.

webMethods Trading Networks Administrator’s Guide Version 7.1 267

 14. Defining and Managing TN XML Document Types

To do this… Perform this…

Set the inputs of the  Click Set Inputs.

transformation from the 
selected service
Edit an existing service Click on the Edit Service button.

f Click OK to close the Add an attribute dialog box.
 Note: To delete an attribute from the TN document type, select the attribute row 

and click  Delete attribute. To view (in the sample document) the node that a 

query represents, select the attribute row; then click   Show node. 

Important! If you do not extract the system attributes, Trading Networks does not 
have this information available for processing rules or querying documents.

6 To define namespace mappings, click the Namespaces tab and perform one of the 
following:
To populate the namespace mapping table replacing any existing namespace 
information, click Set.
To add the namespace information to the current namespace mappings, click 
Append.
When you click either Set or Append, Trading Networks populates the namespace table 
with the namespace information from all xmlns attributes in the sample document.
For more information about namespaces, see “Namespace Mappings in TN XML 
Document Types” on page 249.
7 Click the Options tab and fill in the fields. For details about these fields, see “Options in 
TN XML Document Types” on page 254. For information specific to pre‐processing 
actions, see “Specifying Pre‐Processing Actions for TN XML Document Type” on 
page 256.

For this Options tab

parameter… Specify…

Format an IS The fully‐qualified name of the IS document type. To search 
document type
for an IS document type, click   Find IS document type to 
browse IS document types. For more information, see 
“Specifying an IS Document Type for TN XML Document 
Types” on page 254

webMethods Trading Networks Administrator’s Guide Version 7.1 268

 14. Defining and Managing TN XML Document Types

For this Options tab

parameter… Specify…

Schema to validate The fully‐qualified name of the IS schema. To search for an IS 

against
schema, click   Find schema to browse IS schemas. For more 
information, see “Specifying an IS Schema for TN XML 
Document Types” on page 255.

Note: When you select a IS schema, Trading Networks 
automatically sets the Validate Structure fields to indicate that 
you want to validate the structure of the document.

Processing Rule Whether you want Trading Networks to search for a 

Routing processing rule and process the document based on the 
processing rule; select either Enable routing or Do not enable
routing. For more information, see “Disabling Processing Rule 
Routing” on page 255.
Verify Digital Whether you want Trading Networks to verify a document’s 
Signature  digital signature; select either Verify digital signature or Do not
pre‐processing  verify digital signature. Trading Networks performs this 
action pre‐processing action before it performs the processing actions 
defined by the processing rule. For more information about 
this pre‐processing action, see “Verifying the Digital Signature 
of an XML Document” on page 256. 
Validate Structure  Whether you want Trading Networks to validate the 
pre‐processing  document’s structure; select either Validate structure or Do not
action validate structure. If you select to validate, Trading Networks 
validates the structure of the XML document against the IS 
schema you specified in the Schema to validate again option. 
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, 
see “Validating the Structure of an XML Document” on 
page 257.

webMethods Trading Networks Administrator’s Guide Version 7.1 269

 14. Defining and Managing TN XML Document Types

For this Options tab

parameter… Specify…

Check for Duplicate Whether you want Trading Networks to determine whether it 

Document  has already received the document. Select one of the following:
pre‐processing 
action Use built-in service to check for duplicate document

Use custom service to check for duplicate document. To create a 

new service, click   New Service. To select an existing 

service, click Find 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.
For more information about how to create a custom 
duplicate checking service, see, “Creating a Duplicate 
Document Check Service” on page 352.
Do not check for duplicate document
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, see 
“Checking for Duplicate of the XML Document” on page 257. 
Save Document to Whether you want Trading Networks to save the document to 
Database  the database; select Save all documents, Save only unique
preprocessing  documents, or Do not save. Trading Networks performs this 
action pre‐processing action before it performs the processing actions 
defined by the processing rule.
If you select to save documents to the database, select from the 
list whether you want Trading Networks the document’s content, 
attributes, and/or activity log information to the database.
For more information about this pre‐processing action, see 
“Saving an XML Document to the Database” on page 259

Important! Keep in mind the pre‐processing actions specified in the processing rules 
can override pre‐processing actions specified in a TN document type. For more 
information, see “Specifying Pre‐Processing Actions for TN XML Document Type” on 
page 256.

8 Click OK to create the TN XML document type.

webMethods Trading Networks Administrator’s Guide Version 7.1 270

 14. Defining and Managing 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. 

Menu or Button Description

Right-click menu— Right click in the sample document to display the right‐click 
Identify Tab menu. 
Add an identifying query—Select a node in the XML document; then, 
select this menu item to add a new identifying query to the TN 
document type. 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, respectively.
Edit selected identifying query—Use to update the XQL query for 
an identifying query. Select the identifying query for which 
you want to update the XQL query. Then, select the node in 
the sample document that represents the new query you want 
to use. Right click and select this menu item. 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 also updates 
the Value field with the value of the selected XQL query.
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.
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. Trading 
Networks uses the value that follows the SYSTEM or PUBLIC 
literal string in the document type declaration. If both literal 
strings exist, Trading Networks uses the value after the 
SYSTEM literal string.

webMethods Trading Networks Administrator’s Guide Version 7.1 271

 14. Defining and Managing TN XML Document Types

Menu or Button Description

Right-click menu— Right click in the sample document to display the right‐click 
Extract Tab menu. 
Add an Attribute—Select a node in the XML document; then, 
select this menu item to add a new attribute that you want 
Trading Networks to extract. 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.
Edit Attribute—Use to update the XQL query that identifies 
where to locate the attribute information. Select the attribute 
for which you want to update the XQL query. Then, select the 
node in the sample document that represents the new query 
you want to use. Right click and select this menu item. 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.
Right-click menu— Right click in the sample document to display the right‐click 
Namespaces Tab menu.
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. When you 
select Set Namespace Mapping, Trading Networks deletes any 
existing namespace mappings from the table and replaces 
them with the namespace information that it obtains from the 
sample document.
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. 
When you select Append Namespace Mappings, Trading 
Networks appends the namespace information that it obtains 
from the sample document to the existing namespace 
mappings in the table.
Append— Use the Append button to populate the namespace mappings table 
Namespaces tab with the namespace information from all xmlns attributes in the 
sample document. Trading Networks appends the namespace 
information that it obtains from the sample document to the 
existing namespace mappings in the table.

webMethods Trading Networks Administrator’s Guide Version 7.1 272

 14. Defining and Managing TN XML Document Types

Menu or Button Description

Set—Identify Tab Use the Set buttons to set the Root Tag and/or DOCTYPE Identifier 
fields with values from the sample document. 
To set the Root Tag field with the value of the root tag in the 
sample document, 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, 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. If both literal strings exist, Trading Networks uses 
the value after the SYSTEM literal string.
Set—Namespaces Use the Set button to populate the namespace mappings table with 
Tab 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.
Test Query—all Use this button to test an XQL query that you have typed in the 
tabs Query field of the Document Type screen. When you click this 
button, 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. 
Example:
The following sample document is loaded:

... Trading Networks displays

If XQL query points to it’s value
this node...

webMethods Trading Networks Administrator’s Guide Version 7.1 273

 14. Defining and Managing TN XML Document Types

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, which is 1. 

Show Source—all Use this button to display the source of the XML document. When 

tabs you click this button, Trading Networks opens a new window that 
contains the document source.

 (Show Node)— Click   to have Trading Networks highlight the node in the 

Identify and Extract sample document that an XQL query for an identifying query or 
tabs attribute represents. 

On the Identify tab, select an identifying query; then, click  . 
Trading Networks highlights (in the sample document) the node 
that the XQL query for the identifying query represents.

When on the Extract tab, select an attribute; then, click  . 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).

webMethods Trading Networks Administrator’s Guide Version 7.1 274

 14. Defining and Managing TN XML Document Types

Defining a TN XML Document Type without a Sample

Document
If you do not have a sample document available, use the following procedure to define a 
TN XML document type.

To define a TN XML document type when you do not have a sample document

1 In Trading Networks Console, perform one of the following procedures to start a new 
TN XML document type.

Method to start a TN XML Procedures when you do not have a sample document
document type loaded

New— The TN XML  1) Select View > Document Types.

document type fields are 
2) Select Types > New.
empty, and you load a 
sample document from the  3) In the Create New DocType dialog box, select 
file system. the XML document type category from the list.
Duplicate— The TN XML  1) Select View > Document Types.
document type fields are 
filled with values from the  2) Click the row containing the TN XML 
document type that you want to duplicate.
TN XML document type that 
you duplicate. 3) Select Types > Duplicate.
You can update any or all 
fields from the duplicated TN 
XML document type.

2 In the Name field, type the name you want to give the TN XML document type. This 
field is required.
3 Optionally, type a description for the TN XML document type in the Description field.

webMethods Trading Networks Administrator’s Guide Version 7.1 275

 14. Defining and Managing TN XML Document Types

4 Click the Identify tab. Perform one or more of the following procedures to specify 
information that indicates how Trading Networks is to identify documents. For 
details about specifying any of this information, see “Identification Information in TN 
XML Document Types” on page 234.

For this Identify tab

parameter… Use this procedure when not using a sample document

Identifying Queries
1) Click   Add an identifying query. Trading Networks 
displays the Add an identifying query dialog box.
2) In the Query field, 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. For information 
about XQL queries, see Appendix E, “XQL Reference”.
3) If you want the TN XML document type to require the 
identifying query to evaluate to a specific value, type that 
value in the Value field.
4) Click OK. 
5) Repeat this procedure for each identifying query that you 
want to add.

Note:  To delete a query from the TN document type, select the 

query row and click  Deleting an identifying query.

Type the value of the root tag from within the XML documents 
that this TN XML document type is to match.
DOCTYPE Identifier 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 276

 14. Defining and Managing TN XML Document Types

For this Identify tab

parameter… Use this procedure when not using a sample document

Pipeline Matching
1) Click  Add New Pipeline Match. 
2) Specify the following values in the Add Pipeline Matching 
dialog box.
Name. Name of the pipeline matching variable.
Value. The value of the pipeline matching variable. 
This field is optional. If you specify both the Name and 
the Value of the pipeline matching variable, Trading 
Networks checks to see that both exist in the pipeline. 
If you specify only the Name and no Value, then 
Trading Networks checks to see if the Name exists. 
3) Click OK. Trading Networks adds the pipeline matching 
variable to the list. 
4) Repeat this procedure for each pipeline matching variable 
that you want to add.

Important! You must supply at least one criterion that Trading Networks is to use to 
recognize an XML document; that is, you must supply at least one identifying query, 
a value for the Root Tag field, a value for the DOCTYPE Identifier field, or a pipeline 
matching variable.

5 Click the Extract tab. Perform the following procedure for each attribute that you want 
Trading Networks to extract from documents identified by this TN XML document 
type. For details about what to specify for these fields, see “Extraction Information In 
TN XML Document Types” on page 238.

a Click   Add an attribute. Trading Networks displays the Add an attribute dialog 

box.
b In the Name field, select the name of the attribute from the list. Trading Networks 
fills in the Type and Description fields based on the document attribute definition.
c If you want Trading Networks to flag an error if it encounters an error attempting 
to extract this document attribute, select the Required check box. For more 
information, see “Indicating that Attributes are Required in TN XML Document 
Types” on page 241.
d In the Query field, type an XQL query that identifies the location of the attribute 
within an XML document. For information about XQL queries, see Appendix E, 
“XQL Reference”.

webMethods Trading Networks Administrator’s Guide Version 7.1 277

 14. Defining and Managing TN XML Document Types

e If necessary, use the Transformation option to specify how Trading Networks is to 
handle attribute data before storing it in the Trading Networks database. The data 
type of the attribute (shown in the Type field) determines the Built-in or Custom 
transformation options available. For more information, see “Transformation 
Information for Extracted Attributes of TN Document Types” on page 242.

Important! If you do not extract the system attributes, Trading Networks does not 
have this information available for processing rules or querying documents.

1 Built-in. Select an existing built‐in transformation provided by Trading 
Networks.

If the attribute data

type is… For Transformation…

Is SenderID or You must specify an external ID type. For more 
ReceiverID information, see “Specifying Built‐in Transformation 
Information for SenderID and ReceiverID” on 
page 243.
Has DATETIMEor You must specify a date format. Select one from the 
DATETIME LIST seven different built‐in formats or type in your own. 
data type For more information, see “Specifying Built‐In 
Transformation Information for Attributes with the 
DATETIME and DATETIME LIST Data Type” on 
page 243.
Has STRING or You can specify whether you want Trading Networks 
STRING LIST data to alter the string value before storing it to UPPERCASE 
type (but not or LOWERCASE. For more information, see “Specifying 
SenderID or Built‐in Transformation Information for Attributes 
ReceiverID) with the STRING or STRING LIST Data Type” on 
page 244.
Has NUMBER data You should specify the operation that Trading 
type and the XQL Networks should perform on the numbers in the 
query identifies an array. For more information, see “Specifying Built‐in 
array of numbers Transformation Information for Attributes with the 
NUMBER Data Type” on page 246.

webMethods Trading Networks Administrator’s Guide Version 7.1 278

 14. Defining and Managing TN XML Document Types

2 Custom. Select or create your own service to perform custom transformations 
on extracted attributes. For more information, see “Specifying a Custom 
Transformation Service” on page 248.

To do this… Perform this…

Create a new custom 
transformation Click   New Service.

Select an existing custom 
transformation service Click  Find Service to browse the IS namespace 
to locate the one you want to use.
Set the inputs of the  Click Set Inputs.
transformation from the 
selected service
Edit an existing service Click on the Edit Service button.

Important! If you do not extract the system attributes, Trading Networks does not 
have this information available for processing rules or querying documents.

Note: To delete an attribute from the TN document type, select the attribute query 

and then click Delete an attribute.

6 To define namespace mappings, click the Namespaces tab. Perform the following for 
each namespace mapping you want to add to the table. For more information about 
namespaces, see “Namespace Mappings in TN XML Document Types” on page 249.

a In the Namespace Mappings section of the screen on the right, click   Add a

namespace mapping. Trading Networks adds a row to the namespace mappings 
table.
b In the Namespace Prefix column, type the prefix for the namespace. If you are 
adding a mapping for the default namespace, specify prefix0.
c In the URI Mapping column, type the URI for the namespace.

Note:
To delete a namespace mapping from the TN document type, select the row 

for the namespace and click  Delete selected namespace mapping.

To edit a namespace mapping, type over the existing information.

webMethods Trading Networks Administrator’s Guide Version 7.1 279

 14. Defining and Managing TN XML Document Types

7 Click the Options tab and fill in the fields. For details about these fields, see “Options in 
TN XML Document Types” on page 254. For information about pre‐processing 
actions, see “Specifying Pre‐Processing Actions for TN XML Document Type” on 
page 256.

For this Options tab

parameter… Specify…

Format an IS The fully‐qualified name of the IS document type. To search 
document type
for an IS document type, click   Find IS document type to 
browse IS document types. For more information, see 
“Specifying an IS Document Type for TN XML Document 
Types” on page 254.
Schema to validate The fully‐qualified name of the IS schema. To search for an IS 
against
schema, click   Find schema to browse IS schemas. For more 
information, see “Specifying an IS Schema for TN XML 
Document Types” on page 255.

Note: When you select a IS schema, Trading Networks 
automatically sets the Validate Structure fields to indicate that 
you want to validate the structure of the document.

Processing Rule Whether you want Trading Networks to search for a 

Routing processing rule and process the document based on the 
processing rule; select either Enable routing or Do not enable
routing. For more information, see “Disabling Processing Rule 
Routing” on page 255.
Verify Digital Whether you want Trading Networks to verify a document’s 
Signature  digital signature; select either Verify digital signature or Do not
pre‐processing  verify digital signature. Trading Networks performs this 
action pre‐processing action before it performs the processing actions 
defined by the processing rule. For more information about 
this pre‐processing action, see “Verifying the Digital Signature 
of an XML Document” on page 256. 

webMethods Trading Networks Administrator’s Guide Version 7.1 280

 14. Defining and Managing TN XML Document Types

For this Options tab

parameter… Specify…

Validate Structure  Whether you want Trading Networks to validate the 

pre‐processing  document’s structure; select either Validate structure or Do not
action validate structure. If you select to validate, Trading Networks 
validates the structure of the XML document against the IS 
schema you specified in the Schema to validate again option. 
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, 
see “Validating the Structure of an XML Document” on 
page 257.
Check for Duplicate Whether you want Trading Networks to determine whether it 
Document  has already received the document. Select one of the 
pre‐processing  following:
action
Use built-in service to check for duplicate document

Use custom service to check for duplicate document. To create a 

new service, click   New Service. To select an existing 

service, click Find 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.
For more information about how to create a custom 
duplicate checking service, see, “Creating a Duplicate 
Document Check Service” on page 352.
Do not check for duplicate document
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, see 
“Checking for Duplicate of the XML Document” on page 257. 

webMethods Trading Networks Administrator’s Guide Version 7.1 281

 14. Defining and Managing TN XML Document Types

For this Options tab

parameter… Specify…

Save Document to Whether you want Trading Networks to save the document to 

Database  the database; select Save all documents, Save only unique
preprocessing  documents, or Do not save. Trading Networks performs this 
action pre‐processing action before it performs the processing actions 
defined by the processing rule.
If you select to save documents to the database, select from the 
list whether you want Trading Networks the document’s 
content, attributes, and/or activity log information to the 
database.
For more information about this pre‐processing action, see 
“Saving an XML Document to the Database” on page 259
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.g., if you want to deliver a document via 
a queue), Trading Networks will bypass reliable delivery and 
invoke the specified delivery service once.

Important! Keep in mind the pre‐processing actions specified in the processing rules 
can override pre‐processing actions specified in a TN document type. For more 
information, see “Pre‐Processing Actions” on page 351.

8 Click OK to create the TN XML document type.

Managing TN XML Document Types

The following table describes the tasks you can perform against TN XML document types:

Task See page...

“Viewing TN XML Document Types” 283
“Updating TN XML Document Types” 283
“Using a Sample Document when Updating a TN XML  283
Document Type”
“Updating a TN XML Document Type without a Sample  289
Document”
“Disabling TN XML Document Types” 293

webMethods Trading Networks Administrator’s Guide Version 7.1 282

 14. Defining and Managing TN XML Document Types

Task See page...

“Enabling TN XML Document Types” 294
“Testing TN XML Document Types” 294

Viewing TN XML Document Types

You can view TN XML document types using the Document Types screen. By default, 
Trading Networks does not display disabled TN document types. However, you can 
update the display of TN document types to include disabled TN document types.

To view TN XML document type

1 In Trading Networks Console: View > Document Types.

Trading Networks displays both the TN XML document types and TN flat file 
document types.
2 To view disabled TN document types, select Types > Show All. Trading Networks 
places a check (D) next to the Show All menu item to indicate that Trading Networks is 
currently displaying disabled TN document types.
3 To hide disabled TN document types, select Types > Show All again. Trading Networks 
removes the check (D) next to the Show All menu item to indicate that Trading 
Networks is currently not displaying disabled TN document types.

Updating TN XML Document Types

As when you define TN XML document types, 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. 

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, 
perform the following procedure.

To update a TN XML document type when a sample document is available

1 In Trading Networks Console: View > Document Types.

Trading Networks displays both the TN XML document types and TN flat file 
document types.

webMethods Trading Networks Administrator’s Guide Version 7.1 283

 14. Defining and Managing TN XML Document Types

2 Click the row containing information about the TN XML document type that you 
want to update. Trading Networks displays the Document Type Details dialog for the 
selected TN XML document type.
3 Select Types > Edit. 
4 To update the description, type a new description in the Description field.
5 Perform the following to load the sample document:
a Click the Identify tab.

b Click   Select Sample Document.

c In the Select File dialog box, browse your file system to locate the XML document 
that you want to use as a sample, and click Open.
For a summary of actions you can take against a sample document, see “Working with 
a Sample Document” on page 271.
6 To update identification information, click the Identify tab. For details about specifying 
any of this information, see “Identification Information in TN XML Document Types” 
on page 234.

Important! The TN XML document type must include at least one criterion that Trading 
Networks can use to recognize a document; that is, at least one identifying query, a 
value for the Root Tag field, a value for the DOCTYPE Identifier field, or a pipeline 
matching variable.

To update this
Identify tab
parameter … Use these procedures when you have a sample document loaded…

Identifying Queries To add an identifying query—In the sample document, select 

the node that you want the identifying query to represent. 
Right click and select Add an identifying query. Trading 
Networks opens the Add an identifying query dialog box 
and populates the Query field with the XQL query for the 
selected node. 

Note: This “filled in” query is for a specific node in the XML 
document. This node is applicable for DATETIME, STRING, or 
NUMBER data types. But, if you want to use DATETIME LIST, 
STRING LIST, NUMBER (with Average, Minimum, Maximum, and 
Sum), or NUMBERLIST data types, you need to update the 
query so that it identifies an array of values.

webMethods Trading Networks Administrator’s Guide Version 7.1 284

 14. Defining and Managing TN XML Document Types

To update this
Identify tab
parameter … Use these procedures when you have a sample document loaded…

If you want the TN document type to require the 
identifying query to evaluate to a specific value, assure 
that value is in the Value field; otherwise, clear the Value 
field. Click OK to close the Add an identifying query 
dialog box.
For information about XQL queries, see Appendix E, 
“XQL Reference”
To update an identifying query—In the sample document, 
select the node that you want the identifying query to 
represent. Right click and select Edit selected identifying
query. 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.
To delete an identifying query from the TN document type—
Select the row for the identifying query and click 
p
Delete selected identifying query
Root Tag To update the Root Tag field with the value from the sample
document, click the Set button next to the Root Tag field.
To remove the value from the Root Tag field, clear the Root Tag 
field.
DOCTYPE Identifier To update the DOCTYPE Identifier field with the value from the
sample document, click the Set button next to the DOCTYPE
Identifier field.
To remove the value from the DOCTYPE Identifier field, clear the 
DOCTYPE Identifier field.
Pipeline Matching
To add a pipeline matching variable—Click  Add New
Pipeline Match. In the Add Pipeline Matching dialog box, 
specify the Name and optionally, the Value for the pipeline 
matching variable. Click OK to save the variable and close 
the dialog box.

webMethods Trading Networks Administrator’s Guide Version 7.1 285

 14. Defining and Managing TN XML Document Types

To update this
Identify tab
parameter … Use these procedures when you have a sample document loaded…

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 

Update Pipeline Matching dialog box, update the Name 
and Value fields for that variable. Click OK to save your 
updates and close the Update Pipeline Matching dialog 
box.
To delete a pipeline matching variable, click the row containing 
the pipeline matching variable you want to delete and 

click  Remove Selected Pipeline Match.

7 To update extraction information, click the Extract tab. For information about how to 
specify information on this tab, see “Extraction Information In TN XML Document 
Types” on page 238.
To add an attribute—In the sample document, select the node that represents the 
attribute that you want Trading Networks to extract. Right click and select Add an
attribute. Trading Networks opens the Add an attribute dialog box and populates 
the Query field with the XQL query for the selected node. 

Note: This “filled in” query is for a specific node in the XML document. This 
node is applicable for DATETIME, STRING, or NUMBER data types. But, if you 
want to use DATETIME LIST, STRING LIST, NUMBER (with Average, Minimum, 
Maximum, and Sum), or NUMBERLIST data types, you need to update the query 
so that it identifies an array of values.

Fill in the rest of the Add an attribute dialog box by performing the following:
a In the Name field, select the name of the attribute from the list.
b If you want Trading Networks to flag an error if it encounters an error 
attempting to extract this document attribute, select the Required check box. 
For more information, see “Indicating that Attributes are Required in TN 
XML Document Types” on page 241.
c If necessary, use the Transformation option to specify how Trading Networks is 
to handle attribute data before storing it in the Trading Networks database.
d The data type of the attribute (shown in the Type field) determines the Built-in 
or Custom transformation options available.

webMethods Trading Networks Administrator’s Guide Version 7.1 286

 14. Defining and Managing TN XML Document Types

Important! If you do not extract the system attributes, Trading Networks does not 
have this information available for processing rules or querying documents.

Built-in transformation. Select an existing built‐in transformation provided 
by Trading Networks:

If the attribute data

type is… For Transformation…

Is SenderID or You must specify an external ID type. For more 
ReceiverID information, see “Specifying Built‐in 
Transformation Information for SenderID and 
ReceiverID” on page 243.
Has DATETIMEor You must specify a date format. Select one from 
DATETIME LIST the seven different built‐in formats or type in your 
data type own. For more information, see “Specifying Built‐
In Transformation Information for Attributes with 
the DATETIME and DATETIME LIST Data Type” 
on page 243.
Has STRING or You can specify whether you want Trading 
STRING LIST data Networks to alter the string value before storing it 
type (but not to UPPERCASE or LOWERCASE. For more 
SenderID or information, see “Specifying Built‐in 
ReceiverID) Transformation Information for Attributes with 
the STRING or STRING LIST Data Type” on 
page 244.
Has NUMBER data You should specify the operation that Trading 
type and the XQL Networks should perform on the numbers in the 
query identifies an array. For more information, see “Specifying Built‐
array of numbers in Transformation Information for Attributes with 
the NUMBER Data Type” on page 246.

Custom transformation. Select or create your own service to perform 
custom transformations on extracted attributes. For more information, 
see “Specifying a Custom Transformation Service” on page 248.

To do this… Perform this…

Create a new custom 
transformation Click   New Service.

Select an existing custom 
transformation service Click  Find Service to browse the IS 
namespace to locate the one you want to use.

webMethods Trading Networks Administrator’s Guide Version 7.1 287

 14. Defining and Managing TN XML Document Types

To do this… Perform this…

Set the inputs of the  Click Set Inputs.

transformation from the 
selected service
Edit an existing service Click on the Edit Service button.

e Click OK to close the Add an attribute dialog box.
To update information for an existing attribute—In the sample document, select the 
node that represents the attribute that you want Trading Networks to extract. 
Right click and select Edit Attribute. Trading Networks opens the Edit Attribute 
dialog box and updates the Query field with the XQL query for the selected node. 
For information about what you can specify, see above for the description for 
adding an attribute. Click OK to close the Edit Attribute dialog box.
To delete an attribute from the TN document type—Select the row for the attribute and 

click   Delete selected attribute.

8 To update namespace mappings, click the Namespaces tab. For information about 
namespaces, see “Namespace Mappings in TN XML Document Types” on page 249.
To replace existing namespace mappings with namespace information from the sample
document—Click Set. 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.
To append namespace information from the sample document to the existing namespace
mappings—Click Append. Trading Networks adds the namespace information 
from all xmlns attributes in the sample document to the namespace mappings 
table.
To update a namespace mapping—Type over the existing information in the 
namespace mappings table.
To delete a namespace mapping—Select the row for the namespace mapping and 

click   Delete selected namespace mapping.

9 To update options, click the Options tab. For information about how to specify 
information on this tab, see step 7 on page 268.
10 After you have made all your changes, click OK. Trading Networks closes the screen.

webMethods Trading Networks Administrator’s Guide Version 7.1 288

 14. Defining and Managing TN XML Document Types

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.

To update a TN XML document type without a sample document

1 In Trading Networks Console: View > Document Types.

Trading Networks displays both the TN XML document types and TN flat file 
document types.
2 Click the row containing information about the TN XML document type that you 
want to update.
3 Select Types > Edit.
4 To update the description, type a new description in the Description field.
5 To update identification information, click the Identify tab. For details about specifying 
any of this information, see “Identification Information in TN XML Document Types” 
on page 234. 

Important! The TN document type must include at least one criterion that Trading 
Networks is to use to recognize an XML document; that is, at least one identifying 
query, a value for the Root Tag field, a value for the DOCTYPE Identifier field, or a 
pipeline matching variable.

webMethods Trading Networks Administrator’s Guide Version 7.1 289

 14. Defining and Managing TN XML Document Types

To update this
Identify tab
parameter … Use these procedures when you do not have a sample document…

Identifying Queries
To add an identifying query—Click  . Trading Networks 
displays the Add an identifying query dialog box. In the 
Query field, 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. 
Note: This “filled in” query is for a specific node in the 
XML document. This node is applicable for DATETIME, 
STRING, or NUMBER data types. But, if you want to use 
DATETIME LIST, STRING LIST, NUMBER (with Average, 
Minimum, Maximum, and Sum), or NUMBERLIST data types, 
you need to update the query so that it identifies an array 
of values.
If you want the TN document type to require that the 
identifying query evaluate to a specific value, type that 
value in the Value field. Click OK to close the Add an 
identifying query dialog box.
For information about XQL queries, see Appendix E, 
“XQL Reference”.
To update information for an existing identifying query—Select 

the row for the identifying query and click   Edit selected

identifying query. Trading Networks displays the Edit 
selected identifying query dialog box. Update the Query 
and/or Value fields. Click OK to close the Edit selected 
identifying query 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, type the value of the root tag 
from within the XML documents that this TN document 
type is to match.
To remove the value from the Root Tag field, clear the Root Tag 
field.

webMethods Trading Networks Administrator’s Guide Version 7.1 290

 14. Defining and Managing TN XML Document Types

To update this
Identify tab
parameter … Use these procedures when you do not have a sample document…

DOCTYPE Identifier To update the DOCTYPE Identifier field, click the Set button 

next to the DOCTYPE identifier field.
To remove the value from the DOCTYPE Identifier field, clear the 
DOCTYPE Identifier field.
Pipeline Matching
To add a pipeline matching variable—Click  Add New
Pipeline Match. In the Add Pipeline Matching dialog box, 
specify the Name and optionally, the Value for the pipeline 
matching variable. Click OK to save the variable and close 
the dialog box.
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 

Update Pipeline Matching dialog box, update the Name 
and optionally, the Value fields for that variable. Click OK 
to save your updates and close the Update Selected 
Pipeline Match dialog box.
To delete a pipeline matching variable—Click the row 
containing the pipeline matching variable you want to 

delete and click  Remove Selected Pipeline Match.

6 To update extraction information, click the Extract tab. For information about how to 
specify information on this tab, see “Extraction Information In TN XML Document 
Types” on page 238.

To add an attribute—Click  . Trading Networks displays the Add an attribute 

dialog box. Fill in the Add an attribute dialog box by performing the following:
1 In the Name field, select the name of the attribute from the list. 
2 To update the description, type a description in the Description field.
3 If you want Trading Networks to flag an error if it encounters an error 
attempting to extract this document attribute, select the Required check box. 
For more information, see “Indicating that Attributes are Required in TN 
XML Document Types” on page 241.
4 In the Query field, type an XQL query that identifies the location of the 
attribute within an XML document. For information about XQL queries, see 
Appendix E, “XQL Reference”.

webMethods Trading Networks Administrator’s Guide Version 7.1 291

 14. Defining and Managing TN XML Document Types

5 If necessary, use the Detail field to specify how Trading Networks is to handle 
attribute data before storing it in the Trading Networks database.
.

If the attribute… For Detail, specify…

Is SenderID or You must specify an external ID type. For more 
ReceiverID information, see “Specifying Built‐in Transformation 
Information for SenderID and ReceiverID” on 
page 243.
Has DATETIME data You must specify a date format. Select one from the 
type seven different built‐in formats or type in your own. 
For more information, see “Specifying Built‐In 
Transformation Information for Attributes with the 
DATETIME and DATETIME LIST Data Type” on 
page 243.
Has STRING data You can specify whether you want Trading Networks 
type (but not to alter the string value before storing it. For more 
SenderID or information, see “Specifying Built‐in Transformation 
ReceiverID) Information for Attributes with the STRING or 
STRING LIST Data Type” on page 244.
Has NUMBER and You should specify the operation that Trading 
the XQL query Networks should perform on the numbers in the 
identifies an array array. For more information, see “Specifying Built‐in 
of numbers Transformation Information for Attributes with the 
NUMBER Data Type” on page 246.

6 Click OK to close the Add an attribute dialog box.
To update information for an existing attribute—Select the row for the attribute and 

click   Edit selected attribute. Trading Networks displays the Edit Attribute 

dialog box. Update the fields to make the changes you want. For information 
about what you can specify, see above for the description for adding an attribute. 
Click OK to close the Edit Attribute dialog box.
To delete an attribute from the TN document type—Select the row for the attribute and 

click   Delete selected attribute.

webMethods Trading Networks Administrator’s Guide Version 7.1 292

 14. Defining and Managing TN XML Document Types

7 To update namespace mappings, click the Namespaces tab. For information about 
namespaces, see “Namespace Mappings in TN XML Document Types” on page 249.

To add a namespace mapping—Click  . Trading Networks adds a row to the 

namespace mappings table. 

In this column... Specify

Namespace Prefix The prefix for the namespace. If you are adding a mapping 

for the default namespace, specify prefix0.
URI Mapping The URI for the namespace.

To update a namespace mapping—Type over the existing information in the 

namespace mappings table.
To delete a namespace mapping—Select the row for the namespace mapping and 

click   Delete selected namespace mapping.

8 To update options, click the Options tab. For information about how to specify 
information on this tab, see step 7 on page 268.
9 After you have made all your changes, click OK. Trading Networks closes the screen.

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, you can disable it. When you disable a TN XML document 
type, the definition for the TN document type is not removed from the database. Later, if 
you decide that you need the TN document type, you can enable it. See “Enabling TN 
XML Document Types” on page 294.

Note: To permanently remove the TN document type from the database, your database 
administrator must remove it. When you remove a TN document type from the database, 
you must also remove all documents that are associated with the TN document type.

To disable a TN XML document type

1 In Trading Networks Console: View > Document Types.

2 Click the row containing information about the TN XML document type that you 
want to update.
3 Select Types > Disable. Trading Networks places No in the Enabled column to indicate 
that the TN XML document type is disabled.

webMethods Trading Networks Administrator’s Guide Version 7.1 293

 14. Defining and Managing TN XML Document Types

Note: To view the Enabled column (if it is not currently displayed), select Document
Types > Show All.

Enabling TN XML Document Types

If you disable a TN XML document type and then later determine that you still need it, 
you can enable it and make it available again.

Important! To enable TN document types, you must first display inactive TN document 
types as described in “Viewing TN XML Document Types” on page 283.

To enable a TN XML document type

1 In Trading Networks Console: View > Document Types.

2 Click the row containing information about the TN XML document type that you 
want to update.
3 Select Types > Enable. Trading Networks places Yes in the Enabled column to indicate 
that the TN XML document type is enabled

Testing TN XML Document Types

You can test your TN XML document types to determine the TN document types that 
match a specified document. If you have samples of all the types of documents that your 
Trading Networks system will process, you can test each to determine whether your 
Trading Networks system will receive:
Documents that match exactly one defined TN XML document type. In this situation, the TN 
XML document types are set up correctly for this type of document.
Documents that do not match any of your defined XML TN XML document types. This type of 
document would be an unknown TN document type if processed by your system. If 
your testing finds a document that does not match any defined TN XML document 
type, you should add a TN XML document type to identify the document or update 
an existing TN document type to identify the document.
Documents that match more than one defined TN XML document type. 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. If your testing 
finds a document that matches multiple TN document types (also called an ambiguous 
document), you should update TN document types so that the document matches 
exactly one TN XML document type.

webMethods Trading Networks Administrator’s Guide Version 7.1 294

 14. Defining and Managing TN XML Document Types

To test the TN XML document types, you must have sample documents available in your 
file system. To perform a test, you select the sample document. Trading Networks uses the 
identification information in all TN XML document types to determine all TN document 
types that match the specified document. Trading Networks highlights all matching TN 
XML document types on the Document Types screen.
Note that Trading Networks does not test the sample document against disabled TN 
document types. This means the Trading Networks does not highlight the disabled TN 
document types that the document would match. 

Important!  During the test, Trading Networks does not actually process the document. 
That is, Trading Networks does not perform any pre‐processing or processing actions on 
the document.

Perform the following procedure to test your TN XML document types for a specified 
document.

To test TN XML document types

1 In Trading Networks Console: View > Document Types.

2 Select Types > Test. Trading Networks displays the Select Input Document dialog box.
3 From the Select Input Document dialog box, select the sample document you want to 
use for the test and click Open.
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, multiple TN document types, or no TN document 
types.

webMethods Trading Networks Administrator’s Guide Version 7.1 295

 14. Defining and Managing TN XML Document Types

webMethods Trading Networks Administrator’s Guide Version 7.1 296

Chapter 15. Defining and Managing TN Flat File Document
Types

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

Defining Document Gateway Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

Defining TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

Managing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

webMethods Trading Networks Administrator’s Guide Version 7.1 297

 15. Defining and Managing TN Flat File Document Types

Overview
Flat file documents present data in a record‐based storage format. Unlike XML files, flat 
files do not have structural information embedded within the data. Trading Networks’ 
definition of a flat file is any file or document with a format that is non‐describing, that is, 
a document that does not contain metadata. In other words, flat file data is externalized as 
a set of records (a list of records containing fields and composites) without any structural 
information. 
Because the records are not structured in a flat file document, the application receiving the 
flat file must have knowledge of the flat file’s structure to read its content. To provide this 
structural knowledge, you create a document gateway service and a corresponding TN flat 
file document type for each type of document you expect to receive.
A document gateway service is the entry point for flat files into Trading Networks. It is a Java 
or flow service that you create to provide information to Trading Networks about a flat file. 
To provide this information, your service defines values in a pipeline variable named 
TN_parms. The service should define values for:
System attributes, for example SenderID and ReceiverID in the TN_parms/SenderID 
and TN_parms/ReceiverID, respectively. 
Optional system variables, for example variables that specify the content type and 
content encoding you want Trading Networks to use for the document.
Custom attributes (the document data).
After supplying the values needed in the TN_parms pipeline variable, the gateway service 
passes control to Trading Networks for processing. Trading Networks will retrieve the 
flat file information from the TN_parms pipeline variable.
In addition to creating a document gateway service, you define a corresponding TN flat file 
document type that Trading Networks will use when it receives the document from the 
gateway service. 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. For example, 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 system and custom attribute values to extract. You can only extract values for the 
attributes that the gateway service has placed in the TN_parms pipeline variable. In 
addition, you can transform certain types of attribute data before Trading Networks 
stores it in the database, using built‐in or custom transformations.

webMethods Trading Networks Administrator’s Guide Version 7.1 298

 15. Defining and Managing TN Flat File Document Types

Whether you want Trading Networks to process the documents that match the TN 
document type using a processing rule or want to prevent Trading Networks from 
performing processing rule actions.
Whether to perform pre‐processing actions (such as validating the data structure and 
checking for duplicate documents) before executing a processing rule.

Run-Time Processing of Flat File Documents

Trading Networks processes a flat file document as follows.
1 Your trading partner’s client application invokes a specific document gateway 
service, sending the flat file document to the service as an input stream.
2 The document gateway service places information about the flat file into the 
TN_parms pipeline variable, and then passes control to Trading Networks for further 
processing.
3 Trading Networks tries to identify the type of the document.
To do this, it examines the contents of the pipeline variable TN_parms, and searches 
the pipeline matching key/value pairs in all your enabled TN flat file document types, 
trying to find a matching document type for the document.
For example, suppose you defined a document type named Acme_XYZ_Invoices to 
receive all documents from Acme’s Billing department with the service code XYZ. 
You would have defined the following pipeline matching criteria:

Key Value

Department Billing
Service_code XYZ

A document would match this TN document type only if the gateway service adds both 
of those pipeline variables (within TN_parms) and the variables have the specified 
values. (You could have omitted the Service_code value if you wanted to receive Billing 
department documents with any service code.)

Tip! Rather than having Trading Networks search all of your TN flat file document 
types to find a match, you can explicitly specify in the gateway service the TN flat file 
document type to use for the document. Doing this eliminates the overhead of that 
search.

webMethods Trading Networks Administrator’s Guide Version 7.1 299

 15. Defining and Managing TN Flat File Document Types

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 TN flat file document type
The data in the TN_parms pipeline variable matches the pipeline matching criteria 
in multiple TN flat file document types
The data in the TN_parms pipeline variable explicitly identifies the TN flat file 
document type to use, but that TN document type does not exist
4 After finding a single matching TN flat file document type, Trading Networks adds 
the extracted attributes to the BizDocEnvelope, which is placed in the pipeline as a 
variable named bizdoc. A BizDocEnvelope represents a routable Trading Networks 
transaction. It contains the flat file document, and Trading Networks adds additional 
information that it uses for routing and processing. 
5 Trading Networks extracts all system and custom attributes that you defined in the 
TN flat file document type. To extract attribute values, Trading Networks looks for 
the values within the TN_parms pipeline variable. Trading Networks places the 
extracted attribute values into the BizDocEnvelope.
In addition, Trading Networks can transform the extracted attribute values before 
storing them into the BizDocEnvelope, using the optional built‐in or custom 
transformations that you specified.
By default if Trading Networks cannot extract a particular attribute value, it will not 
log an error; it completes processing (assuming it finds no errors) and sets the 
processing status to DONE.
If you want Trading Networks to log an error when it cannot extract particular 
attribute values, you can designate those attributes as being required for extraction. In 
this case, Trading Networks completes processing, logs the error to the activity log, 
and sets the processing status to DONE W/ERRORS.
Continuing with the example document type Acme_XYZ_Invoices, suppose your 
trading network expects to receive a document whose TN_parms will contain the 
following attributes:

Attribute Value

TN_parms/SenderID [some value]
TN_parms/ReceiverID [some value]
TN_parms/DocumentID [some value]
TN_parms/Department Billing
TN_parms/Service_code XYZ

webMethods Trading Networks Administrator’s Guide Version 7.1 300

 15. Defining and Managing TN Flat File Document Types

Attribute Value

TN_parms/Invoice_number 123
TN_parms/Amount 1000.00

You can extract any of these attributes. SenderID and ReceiverID are system attributes 
that Trading Networks always requires in TN_parms, and always extracts. Extracting 
all other system attributes, such as DocumentID, is optional. You extract system 
attribute values if you want to use them as criteria for determining the processing rule 
to use for a document, transaction analysis, process management, and more. You can 
extract document data to perform any processing you want, such as calculations.
6 Trading Networks does one of the following based on whether processing rule 
routing is enabled or disabled:
If the TN flat file document type indicates that processing rule routing is disabled, Trading 
Networks performs the pre‐processing actions defined by the TN document type; 
it then ends its processing. Trading Networks does not search for a processing 
rule, nor does it perform any processing rule actions.
If the TN flat file document type indicated that the ConversationID system 
attribute be set for the document and TN_parms contains the value for the 
ConversationID attribute, Trading Networks passes the document to the Process 
Engine, which in turn will determine the process model to use to process the 
document.
If the TN flat file document type indicates that processing rule routing is enabled, Trading 
Networks performs a processing rule lookup to determine the processing rule to 
use for the incoming flat file document. For details, see Chapter 16, “Defining and 
Managing Processing Rules”.

Tip! Trading Networks performs a processing rule lookup for each document to 
determine the processing rule to use for it. Alternatively, you can explicitly 
specify in the gateway service the processing rule to execute for a given TN 
document type, thus bypassing the lookup (and its overhead).

webMethods Trading Networks Administrator’s Guide Version 7.1 301

 15. Defining and Managing TN Flat File Document Types

After selecting a processing rule for the document:
1 Trading Networks executes the optional pre‐processing actions that you might 
have specified when you defined the TN flat file document type. 
Trading Networks executes these pre‐processing actions before it executes the 
processing rule that you associate with the document type. These actions, 
executed in the following order, 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; that is, determine whether Trading 
Networks has already received the document
Save a copy of the document content, attributes, 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. In the processing 
rule, you can specify whether to use the pre‐processing actions specified in 
the processing rule, or to use the ones specified in the document type. For 
details, see “Pre‐Processing Actions” on page 351.
2 Trading Networks executes the processing rule actions. For details, see 
Chapter 16, “Defining and Managing Processing Rules”.

Defining Document Gateway Services

You can create a document gateway service using Java or flow. 
The wm.tn.rec:GatewayService specification defines the input and output variables for a 
document gateway service. There is only one input variable: ffdata. The trading partner’s 
client application invokes a gateway service, passing it the flat file document. The 
gateway service receives the flat file document as an input stream in the ffdata pipeline 
variable. You must provide your trading partners with the names of the document 
gateway services that are appropriate for their particular types of documents.
A document gateway service returns the output variables ffdata (an object) and TN_parms 
(an IS document). TN_parms can include:
The custom attributes that you specify (the document data)

The Trading Networks system attributes and system variables that you specify.

webMethods Trading Networks Administrator’s Guide Version 7.1 302

 15. Defining and Managing TN Flat File Document Types

Note: If new TN document types are created while you have an open My webMethods 
session, those TN document types will not be included in My webMethods displays until 
you log out then back into My webMethods or until you refresh your cache in My 
webMethods. For more information about how to refresh your My webMethods cache, 
see information about My webMethods user preferences in the webMethods Trading 
Networks User’s Guide.

Logic to include in a document gateway service

1 Read the input stream.
For details, see “Reading the Input Stream” on page 304. Optionally, you can parse the 
input stream and convert it to an IS document. For details, see “Converting a Flat File 
Document to an IS Document” on page 305.
2 Use the Trading Networks system attributes and variables (described in “Specifying the 
Document Gateway Services Outputs” on page 306) to:
a Explicitly specify the document type to use for processing the document 
(optional).
This is an alternative to having Trading Networks search for a matching 
document type, thus eliminating the overhead of that search. Use the system 
attribute DoctypeID or DoctypeName for this purpose.
b Specify the external ID values (e.g., D‐U‐N‐S numbers) for the sender and receiver 
of the documents in the TN_parms/SenderID and TN_parms/ReceiverID pipeline 
variables.
c Optionally specify values for the system attributes DocumentID, GroupID, 
ConversationID, and/or UserStatus in the TN_parms/DocumentID, 
TN_parms/GroupID, TN_parms/ConversationID, and/or TN_parms/UserStatus 
pipeline variables, respectively.
d Explicitly specify the processing rule to use for processing the document 
(optional).
This is an alternative to having Trading Networks look up the appropriate 
processing rule to use, thus eliminating the overhead of that lookup. Use the 
system variables TN_parms/processingRuleID and TN_parms/processingRuleName 
for this purpose. 

webMethods Trading Networks Administrator’s Guide Version 7.1 303

 15. Defining and Managing TN Flat File Document Types

e Place the gateway service’s name into the pipeline to enable documents that 
invoke this gateway service to be resubmitted if necessary (optional).
Use the system variable TN_parms/$receiveSvc for this purpose. 
f Specify the content type and content encoding you want Trading Networks to use 
for the document (optional).
This is an alternative to having Trading Networks automatically determine the 
content type and content encoding of the document. Use the system variables 
TN_parms/$contentType and TN_parms/$contentEncoding for this purpose. 
3 Specify all custom attribute values (the document data) that the matching document 
type is to extract. 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.
4 Invoke either wm.tn:receive or wm.tn.doc.ff:routeFlatFile to pass ffdata and TN_parms to 
Trading Networks.

Reading the Input Stream

If your document gateway service is a Java service, use the methods of the 
java.io.InputStream class to read bytes from the input stream contained in ffdata. Consult your 
Java documentation for descriptions of these methods.

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. Otherwise, Trading 
Networks will lose the bytes read by the gateway service when attempting to save the 
document content to the BizDocEnvelope.

If your document gateway service is a flow service, use the services provided in the 
WmFlatFile package’s pub.io folder. The WmFlatFile package must be enabled to use these 
services. For descriptions of the pub.io services, 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.
You can provide the content type and content encoding to ensure that Trading Networks 
uses the accurate values. To do so, explicitly specify the content type and/or content 
encoding in the TN_parms/$contentType and the TN_parms/$contentEncoding variables, 
respectively.
For example, 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, the original content type and content encoding will be lost. The pipeline 

webMethods Trading Networks Administrator’s Guide Version 7.1 304

 15. Defining and Managing TN Flat File Document Types

has a content type of application/x‐wmidatabin and a content encoding of UTF8. In this 
case, either your gateway service or the service that invoked it, should specify 
text/plain for TN_parms/$contentType and SJIS for TN_parms/$contentEncoding.

Converting a Flat File Document to an IS Document

Optionally, you can parse the input stream and convert it to an IS document. Then you 
can map information from the converted document to the TN_parms variable.

Important! Perform this action only if absolutely necessary because parsing can be 
time‐consuming and return very large outputs that consume much memory. 

In your document gateway service, invoke pub.flatfile:convertToValues, which is a service in 
the WmFlatFile package (see the Flat File Schema Developer’s Guide). This service invokes 
the flat file parser to validate the document’s structure and content, based on the flat file 
schema that you name as input to the service. Trading Networks can save or throw away 
the parsed contents. Alternatively, if you decide you do not need to parse the document in 
your gateway service, you can still indicate that you want to parse the document to 
validate its structure using the pre‐processing option Validate Structure. For details, see 
“Validating the Structure of Flat File Documents” on page 320.

Note: Do not convert a document in both the gateway service and the TN document type. If 
you convert a document in the gateway service, it will remain in the pipeline.

webMethods Trading Networks Administrator’s Guide Version 7.1 305

 15. Defining and Managing TN Flat File Document Types

Specifying the Document Gateway Services Outputs

A document gateway service can return the output variables ffdata (an object) and 
TN_parms (an IS document). TN_parms can return:
The custom attributes that you specify (the document data)

The Trading Networks system attributes and system variables that you specify, which 
are described below

TN_parms variables Description

DoctypeID or  String (optional) The Trading Networks‐generated internal 
DoctypeName identifier or name of the TN flat file document type that you 
want Trading Networks to use for the flat file document. This is 
an alternative to having Trading Networks search for an 
appropriate document type, thus eliminating the overhead of 
that search. To determine the document type identifier invoke 
the wm.tn.doctype:list service from Developer to return the name 
and ID of all your TN document types.
If you use DoctypeName, and that name is changed later, the 
gateway service will not function as intended. Since TN 
document type IDs cannot be changed, your gateway service 
will be both more stable and more efficient if you use DoctypeID 
rather than DoctypeName. If you specify both variables, 
DoctypeID is used.
Examples:
/TN_parms/DoctypeID = "5066kt00tttva37r00000009"
/TN_parms/DoctypeName = "xCBL_PO"
SenderID String An external ID value specified in the sender’s profile, for 
example, the sender’s D‐U‐N‐S number. The TN document type 
uses SenderID to verify the sender’s identity. In the TN 
document type you must specify the type of the external ID, for 
example DUNS.
ReceiverID String An external ID value specified in the receiver’s profile, for 
example, the receiver’s D‐U‐N‐S number. The TN document 
type uses ReceiverID to verify the receiver’s identity. In the TN 
document type you must specify the type of the external ID, for 
example DUNS.

webMethods Trading Networks Administrator’s Guide Version 7.1 306

 15. Defining and Managing TN Flat File Document Types

TN_parms variables Description

DocumentID String (optional) The identifier of the flat file document. Be sure 
to specify DocumentID if you want to use the Check for Duplicate
Document pre‐processing action, and Trading Networks is to use 
the DocumentID to determine whether documents are 
duplicates. For details, see “Checking for Duplicates of the Flat 
File Document” on page 321.
GroupID String (optional) The identifier in a flat file document that 
associates this document with other documents in its group. If 
you expect to receive more documents in the same group, be 
sure the value you specify for GroupID is reproducible for future 
documents that will arrive in the same group.
ConversationID String (optional) The identifier in a flat file document that 
associates this document with other documents in the same 
business process (i.e., conversation of documents). Use 
ConversationID if you want Trading Networks to pass the 
document to process management after it executes the 
document type’s processing rule. You define the actions taken 
against a document during process management by creating a 
process model. For more information about creating process 
models, see the Getting Started with Business Process Management 
guide and the webMethods Designer online help. If you do not 
want Trading Networks to pass the document to process 
management, add a variable to the pipeline called 
prtIgnoreDocument with the value of true.
If you expect to receive more documents in the same 
conversation, be sure the value you specify for ConversationID is 
reproducible for future documents that will arrive in the same 
conversation.
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. The user 
status is a criterion that Trading Networks uses to determine the 
processing rule to use for a document. For more information, see 
“Processing Rule Criteria” on page 341. In addition, if you create 
UserStatus, when searching for documents in Trading Networks 
Console, you can refine your search to documents with specific 
user statuses.

webMethods Trading Networks Administrator’s Guide Version 7.1 307

 15. Defining and Managing TN Flat File Document Types

TN_parms variables Description

processingRuleID or  String (optional) The Trading Networks‐generated internal 
processingRuleName identifier or name of the processing rule that you want Trading 
Networks to use for the flat file document. This is an alternative 
to having Trading Networks look up the appropriate rule, thus 
eliminating the overhead of that lookup. To determine the 
identifier, invoke the wm.tn.route:list service from Developer to 
return the name and ID of all your processing rules.
If you use processingRuleID and that name is changed, the 
gateway service will not function as intended. Processing rule 
IDs cannot be changed, so your gateway service will be both 
more stable and more efficient if you use processingRuleID rather 
than processingRuleName.
If you include values for both processingRuleID and 
processingRuleName, Trading Networks only uses the 
processingRuleID value.
For more information, see “Bypassing Lookups for Processing 
Rules” on page 349.
$receiveSvc String (optional) The fully‐qualified name of the document 
gateway service you are creating. By saving the name of the 
gateway service, you will be able to resubmit the flat file 
document if necessary. If $receiveSvc is not set and you resubmit 
the document, Trading Networks resubmits the document to 
wm.tn:receive, which will not be able to properly recognize the flat 
file document. As a result, the sender, receiver, and TN 
document type will all be unknown, and the resubmission will 
fail.
$contentType and  String (optional) The content type and encoding you want 
$contentEncoding Trading Networks to use for the flat file document. You can 
specify $contentType and/or $contentEncoding. This is an 
alternative to having Trading Networks automatically 
determine the content type and content encoding of the 
submitted flat file document. For more information, see 
“Determining the Content Type and Content Encoding” on 
page 304.

webMethods Trading Networks Administrator’s Guide Version 7.1 308

 15. Defining and Managing TN Flat File Document Types

TN Flat File Document Types

After you define a document gateway service, you define a corresponding TN flat file 
document type that Trading Networks will use when it receives the document from the 
gateway service. In a document type you specify: 
“Pipeline Matching Criteria Used to Identify the TN Document Type” on page 309

“Attributes To Extract From Documents” on page 310

“Pre‐Processing Actions in the TN Flat File Document Type” on page 319

Pipeline Matching Criteria Used to Identify the TN Document

Type
In your TN flat file document type, you specify pipeline matching criteria that Trading 
Networks uses to determine whether to use the document type for the incoming flat file 
document. The pipeline matching criteria is one or more key/value pairs that identify a 
document. Specifying values for the variables is optional. If you specify both a key and a 
value, Trading Networks ensures that the variable (key) is in the TN_parms variable and 
that it has the value that you specified. If you specify a key without a value, Trading 
Networks ensures that the variable (key) is in the TN_parms regardless of its value.
At run time Trading Networks examines the contents of the TN_parms variable that the 
gateway service added to the pipeline. Then it searches the key/value pairs specified in the 
pipeline matching criteria of all your enabled TN flat file document types, trying to find a 
matching document type for the document.

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. Doing so eliminates the overhead of the search that Trading Networks 
would have to perform to find the matching TN flat file document type.

For example, suppose you defined a document type named Acme_XYZ_Invoices to 
receive all documents from Acme’s Billing department with the service code XYZ. You 
would have defined the following criteria:

Key Value

Department Billing
Service_code 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. (You could have omitted the 
Service_code value if you wanted to receive Billing department documents with any service 
code.)

webMethods Trading Networks Administrator’s Guide Version 7.1 309

 15. Defining and Managing TN Flat File Document Types

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, but that document type does not exist.
In either of these cases, the document is considered to be an unknown type. Because 
TN document types indicate the system and custom attributes to extract, Trading 
Networks cannot extract any attribute values 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. You can define processing rules that 
act on documents with an unknown TN document type.
The data in the TN_parms pipeline variable matches the pipeline matching criteria in 
multiple document types.
When this happens, the document is considered to be an unknown type because 
Trading Networks does not know which of the matching TN document types to use. 
In this situation, Trading Networks logs a message to the activity log that identifies all 
the TN document types that the document matched. Because the TN document type is 
unknown, Trading Networks does not extract any attribute values. 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.

Attributes To Extract From Documents

You specify the attribute values to extract from the document’s TN_parms variable. You 
can extract system attributes as well as custom attributes (the document data). In addition, 
you can transform extracted attribute values before Trading Networks stores them in the 
BizDocEnvelope, using built‐in or custom transformations. 
Continuing with the example document type Acme_XYZ_Invoices, suppose your trading 
network expects to receive a document whose TN_parms will contain the following 
attributes:

Attribute Value

TN_parms/SenderID [some value]
TN_parms/ReceiverID [some value]

webMethods Trading Networks Administrator’s Guide Version 7.1 310

 15. Defining and Managing TN Flat File Document Types

Attribute Value

TN_parms/DocumentID [some value]
TN_parms/Department Billing
TN_parms/Service_code XYZ
TN_parms/Invoice_number 123
TN_parms/Amount 1000.00

You can extract any of these attributes. Trading Networks always extracts the system 
attributes SenderID and ReceiverID. Extracting all other system attributes, such as 
DocumentID, is optional. You extract system attribute values if you want to use them as 
criteria for determining the processing rule to use for a document, transaction analysis, 
process management, and more. You can extract document data to perform any 
processing you want, such as calculations. For more information, see “System Attributes 
To Extract From Documents” on page 312.

Error Conditions When Extracting Attributes

By default if Trading Networks cannot find a particular attribute for extraction, it will not 
log an error; it completes processing (assuming it finds no errors) and sets the processing 
status to DONE.
If you want Trading Networks to log an error when it cannot extract particular attribute 
values, you can designate those attributes as being required for extraction. In this case, 
Trading Networks:
Completes processing

Logs an error in the BizDocEnvelope, which is in the bizdoc variable 

Puts the error into the activity log

Sets the processing status to DONE W/ERRORS.
In this case, 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. For more information, see “Document Recognition 
Errors Criterion” on page 345.
Use the processing rule’s Execute a service processing action to inspect the bizdoc/Errors 
variable for the errors that Trading Networks encountered. When Trading Networks 
is unable to extract a required attribute, it records the error in the bizdoc/Errors 
variable. This variable is in the pipeline and is available for your use when Trading 
Networks is processing the document. For more information about the Execute a
service processing actions, see “Action 1—Execute a Service” on page 354.

webMethods Trading Networks Administrator’s Guide Version 7.1 311

 15. Defining and Managing TN Flat File Document Types

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. Trading Networks always extracts SenderID and 
ReceiverID from TN_parms. Extracting all other system attributes is optional. 
Reasons for extracting system attributes are discussed below. For descriptions of system 
attributes, see “Specifying the Document Gateway Services Outputs” on page 306.

SenderID and ReceiverID

Trading Networks always extracts both of these attributes; you cannot delete them. 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. On the Extract panel you must 
select from the pull‐down list the type of the external IDs (for example, 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. This is how Trading Networks 
verifies the identities of the sender and receiver. When Trading Networks finds a match, it 
automatically transforms the externals ID in TN_parms/SenderID and TN_parms/ReceiverID 
into its internal IDs before storing them in the BizDocEnvelope.
When Trading Networks has a value for the SenderID and ReceiverID, you can perform 
the following tasks.
Specify the sender and receiver as criteria for determining the processing rule to use 
for the flat file document. For more information, see “Processing Rule Criteria” on 
page 341.
Search for the flat file document in My webMethods or the Trading Networks 
Console by searching for documents with specific senders and receivers.
Use the identify of the sender and receiver of the flat file document in the logic of a 
business process. For example, you can then set conditions on transitions in process 
model, so the business process performs different logic based on the sender and 
receiver of a document. For more information about creating process models, see the 
Getting Started with Business Process Management guide and the webMethods Designer 
online help.
Use the Retrieve SenderID from session option as an alternative way to set the value of 
the SenderID system attribute. If set, rather than look in TN_parms\SenderID for the 
value to use, Trading Networks uses the connected user. That means that when the 
client sent the flat file document to Trading Networks, it had to present credentials—
an Integration Server user name and password. That user name/password pair 
directly correlates to a Trading Networks partner. Recall that when you create a 
profile, there is a required external ID type (for example, DUNS). When you create a 
profile, Trading Networks creates a user account on the Integration Server for that 
partner. The user name is equal to the required external ID. So, if the required external 
ID is DUNS and a profile is added for a partner whose D‐U‐N‐S number is 123456789, 
then that partner will have an Integration Server user account with the user name 
123456789. So, when that partner’s client wants to send a flat file document to Trading 

webMethods Trading Networks Administrator’s Guide Version 7.1 312

 15. Defining and Managing TN Flat File Document Types

Networks, it must present credentials—it supplies user name 123456789 along with its 
password. So, if Retrieve SenderID from session is set to true in a TN flat file document 
type, Trading Networks would determine the sender of the document based on the 
user account 123456789, find the profile (and therefore the internal ID), and put that 
value in the BizDocEnvelope.

Important! When you resubmit a flat file document with the Retrieve SenderID from

session option selected, the resubmit might fail. If you set up Sender criteria in a 
processing rule, the first time the document arrives, the criteria matches a processing 
rule based on the SenderID value 123456789 because that is the value determined via 
the Retrieve SenderID from session option. However, if you resubmit the document, that 
same processing rule will not be selected based on the Retrieve SenderID from session 
option. This is because when you resubmit the document from the Trading Networks 
Console, the user is the IS user account that you used to log in to the Trading 
Networks Console (e.g., Administrator), which will not match sender 123456789 in 
the Sender criteria of the processing rule. It could end up matching another 
processing rule and then go through completely different processing.

DocumentID
When Trading Networks has a value for DocumentID, you can perform the following 
tasks.
Determine whether the incoming flat file document is a duplicate, by checking the 
value of the document ID; that is, determine whether Trading Networks has already 
received the document. For details, see “Checking for Duplicates of the Flat File 
Document” on page 321.
Search for the flat file document in My webMethods or the Trading Networks 
Console by searching for documents with the specific document ID.

ConversationID
You can use ConversationID to have Trading Networks pass the document to process 
management after it performs its own processing (e.g., the actions identified by a 
processing rule). You define the actions taken against a document during process 
management by creating a process model. For more information about creating process 
models, see the Getting Started with Business Process Management guide and the 
webMethods Designer online help. If you do not want Trading Networks to pass the 
document to process management, add a variable to the pipeline called prtIgnoreDocument 
with the value true.

webMethods Trading Networks Administrator’s Guide Version 7.1 313

 15. Defining and Managing TN Flat File Document Types

UserStatus
When Trading Networks has a value for UserStatus, you can perform the following tasks.
Specify the user status as a criterion for determining the processing rule to use for the 
flat file document. For more information, see “Processing Rule Criteria” on page 341.
Search for the flat file document in My webMethods or the Trading Networks 
Console by searching for documents with the specific user status.

GroupID
When Trading Networks has a value for GroupID, you can search for this flat file and all 
other flat files that have the same group ID in My webMethods or the Trading Networks 
Console.

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 314

“Built‐In Transformations for DATETIME and DATETIME LIST Data Type 
Attributes” on page 314
“Built‐in Transformations for STRING or STRING LIST Data Type Attributes” on 
page 315
“Built‐in Transformations for NUMBER Data Type Attributes” on page 316

“Custom Transformation Services” on page 317

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. This is how Trading Networks 
verifies the identities of the sender and receiver. 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.

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 requires you to identify the date format. Trading Networks maintains a list of 
built‐in common date/time formats from which you can select. However, if the date/time 
format you need to use is not in the list, you can type the format you need. 
To specify the date/time format, use a pattern string based on the “Time Format Syntax” 
described for the java.text.SimpleDateFormat class. Trading Networks extracts the value 

webMethods Trading Networks Administrator’s Guide Version 7.1 314

 15. Defining and Managing TN Flat File Document Types

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.

Built-in Transformations for STRING or STRING LIST Data Type Attributes

For attributes with the data type STRING or STRING LIST, you can specify whether you 
want Trading Networks to alter the string value before storing it. You can have Trading 
Networks make a simple alteration to change the case of the extracted string values to all 
upper‐ or all lowercase. Alternatively, you can have Trading Networks use the extracted 
values as substitutions in a string that you supply. If you do not specify transformation 
information for a string attribute, Trading Networks saves the data exactly as it extracted 
it.
Following are descriptions of the built‐in transformation options for string attributes.

Format Description
Uppercase Stores the extracted string attribute value in all uppercase. For 
example, if the extracted attribute value is “Purchase Order”, 
Trading Networks stores “PURCHASE ORDER” for the attribute 
value.
Lowercase Stores the extracted string attribute in all lowercase. For example, 
if the attribute value is “Purchase Order”, Trading Networks 
stores “purchase order” for the attribute value.
String Substitution Substitutes extracted values with a pattern that you specify. 
Trading Networks uses the java.text.MessageFormat class to 
perform this transformation.
For example, 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”, “WidgetB”, “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. To do this, use this field to specify 
the following string substitution pattern for itemName: 
“Item Name: {0}, {1}, {2}”

Trading Networks would store the following for the value of 
itemName:
Item Name: WidgetA, WidgetB, WidgetC

webMethods Trading Networks Administrator’s Guide Version 7.1 315

 15. Defining and Managing TN Flat File Document Types

Format Description
If you place more arguments in the pattern than values that 
Trading Networks extracts, the string that Trading Networks 
stores for the attribute will contain the extra arguments (e.g., {2}). If 
you specify less arguments in the pattern than values that Trading 
Networks extracts, the string that Trading Networks stores for the 
attribute will not contain all the extracted values; it will only 
contain the values for the number of arguments you specify in the 
pattern.

Built-in Transformations for NUMBER Data Type Attributes

You can specify an attribute with the NUMBER data type that contains an array of 
numbers. 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 Description
Average Stores the average value of all the numbers in the array. For example, if 
the array contains the numbers [2, 3, 4, 5], Trading Networks stores the 
value 3.5.
Minimum Stores the smallest number in the array. For example, if the array contains 
the numbers [2, 3, 4, 5], Trading Networks stores the value 2.
Maximum Stores the largest number in the array. For example, if the array contains 
the numbers [2, 3, 4, 5], Trading Networks stores the value 5.
Sum Stores the sum of all the numbers in the array. For example, if the array 
contains the numbers [2, 3, 4, 5], Trading Networks stores the value 14.
No format  Stores the first value of the array as the value of the attribute. For 
specified example, if the array contains the numbers [2, 3, 4, 5], Trading Networks 
stores the value 2.

Note: When Trading Networks extracts a NUMBER or NUMBER LIST from a document, it 
uses the number parsing behavior of java.lang.Number. For example, if the NUMBER or 
NUMBER LIST contains the value “100zzz”, Trading Networks interprets the value as 
“100”, instead of throwing an error as it would if the value were “zzz100”. To redefine this 
parsing behavior, you can write a custom attribute transformation. For more information, 
see “Custom Transformation Services” on page 317.

For example, suppose your document gateway service extracts the quantity of each item 
of a purchase order, and you want to sum the quantities of all items. Suppose you defined 
the following attributes in your TN_parms variable and in your TN document type:

webMethods Trading Networks Administrator’s Guide Version 7.1 316

 15. Defining and Managing TN Flat File Document Types

TN_parms attributes TN document type

/TN_parms/itemNumber itemNumber NUMBER
/TN_parms/quantity quantity NUMBER
/TN_parms/totalQuantity totalQuantity NUMBER
summedValue NUMBER LIST

If you select the Sum built‐in transformation for totalQuantity, it will sum its value (an of 
quantities), and produce a single number. For example, if the value of totalQuantity is the 
following array:
/TN_parms/totalQuantity = {2, 3, 4, 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.

Custom Transformation Services

Trading Networks allows you to create your own service to perform transformations on 
extracted attributes. Base your service on the appropriate specification listed below:

Data type Specification you must use…

DATETIME or The service must implement the input and output variables 
DATETIME LIST defined in the wm.tn.rec:DateAttributeTransformService specification.
STRING or The service must implement the input and output variables 
STRING LIST defined in the wm.tn.rec:StringAttributeTransformService specification.
NUMBER or The service must implement the input and output variables 
NUMBER LIST defined in the wm.tn.rec:NumberAttributeTransformService specification.

To view these specifications, use webMethods Developer and look in the WmTN package. 
For more information, see the webMethods Trading Networks Built‐in Services Reference.
Trading Networks passes the following input variables:

Input Value Meaning

values  One or more values for your service to transform. 

Note: The values might be null or an empty (zero length) string. For an 
array data type (e.g., DATETIME LIST), any element in the values array 
can be null or an empty string. Make sure that your custom 
transformation service can handle null values or empty strings. 

webMethods Trading Networks Administrator’s Guide Version 7.1 317

 15. Defining and Managing TN Flat File Document Types

Input Value Meaning

isArray Whether values contains a single value to transform or multiple values 
to transform. isArray will be false if values contains a single value; 
otherwise it will be true.
arg Optional arguments that you can define.

Trading Networks expects you to return the transformed values in the following output 
variable:

Output Value Meaning

newValues 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 the input variable isArray is false, the input variable values will 
contain only a single item to transform. 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. It should store each as an item in the output variable 
newValues. For example, if you are transforming string data, newValues is 
a Date List of the transformed Strings.

For information about creating a service, see the webMethods Developer User’s Guide.

Disabling Processing Rule Routing

You specify whether you want Trading Networks to process documents identified by the 
TN flat file document type using actions in a processing rule.
When processing rule routing is enabled, Trading Networks locates the processing rule to 
use for the document and proceeds to perform the pre‐processing and processing 
actions as defined by that processing rule.
When processing rule routing is disabled, Trading Networks performs the pre‐processing 
actions defined by the TN document type; however, it does not search for a 
processing rule, nor does it perform any processing rule actions.

webMethods Trading Networks Administrator’s Guide Version 7.1 318

 15. Defining and Managing TN Flat File Document Types

If you do not want Trading Networks to perform processing rule actions, disabling 
routing can improve performance because Trading Networks will not use processing 
time to search for a processing rule. 
You might want to disable processing if the document is to be processed as part of a 
business process. Even when processing rule routing is disabled, if the TN document 
type instructs Trading Networks to set the value of the ConversationID system 
attribute, Trading Networks will pass the document to the Process Engine, which in 
turn will determine the process model to use to process the document.

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. All actions are optional. Trading 
Networks executes them in the following order:
“Verifying the Digital Signature of Flat File Documents” on page 319

“Validating the Structure of Flat File Documents” on page 320

“Checking for Duplicates of the Flat File Document” on page 321

“Saving Flat File Documents to the Database” on page 322
These actions are provided as built‐in options on the Options tab in the TN document 
type’s definition. 

Note: Additionally, you can specify this same set of pre‐processing actions in a processing 
rule. In the processing rule, you can specify whether to use the pre‐processing actions 
specified in the processing rule, or to use the ones specified in the document type. This 
enables you to overwrite the pre‐processing actions. For details, see “Pre‐Processing 
Actions” on page 351.

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. To do this, 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. 
Create this service in any user‐defined package, using the inputs and outputs specified in 
wm.tn.rec:BizDocVerificationService (described in the webMethods Trading Networks Built‐in 
Services Reference).
If the digital signature is invalid, Trading Networks:
1 Performs the remainder of the pre‐processing actions you specified (if any).
2 Adds the error information to the BizDocEnvelope in the pipeline variable 
bizdoc/Errors, which your processing rule can access.

webMethods Trading Networks Administrator’s Guide Version 7.1 319

 15. Defining and Managing TN Flat File Document Types

3 Logs the error to the activity log, if you selected the Save Document to Database 

pre‐processing option and the Activity Log option.
4 Performs the processing actions specified in the processing rule.

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, and converts the flat file document to an IS 
document. Then you can map information from the converted document to the TN_parms 
variable.

Important! Perform this action only if absolutely necessary because parsing can be 
time‐consuming and return very large outputs that consume much memory.

Note: Alternatively, 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 305). Do not convert a document in both locations. If you convert a document in the 
gateway service, it will remain in the pipeline.

To implement this action, use the Options tab in the TN document type’s definition to:
Select the Validate Structure option.

Specify the name of the TN document type’s flat file schema in the Parsing schema 
option. The Input for Flat File Validation dialog prompts you to select the parsing 
settings. Trading Networks will save the parsed contents if you select the keepResults 
option. You only need to specify a flat file schema if you want to validate the structure 
of the document. (You create flat file schemas in webMethods Developer, as described 
in the Flat File Schema Developer’s Guide.)
At run time, the Validate Structure option invokes pub.flatfile:convertToValues, which is a service 
in the WmFlatFile package (see the Flat File Schema Developer’s Guide). This service invokes 
the flat file parser to validate the document’s structure and content, based on the flat file 
schema that you named in the Parsing schema option, and saves the parsed contents if you 
selected the keepResults option.
If the document structure is invalid, Trading Networks:
1 Performs the remainder of the pre‐processing actions you specified (if any).
2 Adds the error information to the BizDocEnvelope in the pipeline variable 
bizdoc/Errors, which your processing rule can access.
3 Logs the error to the activity log, if you selected the Save Document to Database 
pre‐processing option and the Activity Log option.
4 Performs the processing actions specified in the processing rule.

webMethods Trading Networks Administrator’s Guide Version 7.1 320

 15. Defining and Managing TN Flat File Document Types

Important! If the structure of a document is invalid, the validation service can return many 
error messages. To limit the number of error messages, set the Validate Max Errors option on 
the Trading Networks Web Manager.

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. 
Trading Networks provides the following Check for Duplicate Document options on the 
Options tab in the TN document type’s definition. Alternatively, you can create your own 
service to be executed in the document type.
Document ID only—Trading Networks assures that it does not already have a document 
with the same document ID in its database. To check for a duplicate document using 
the document ID, you must instruct Trading Networks to extract the DocumentID 
system attribute from the document.
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. 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.
Document ID, sender and receiver—Trading Networks assures that it does not already 
have a document with the same document ID, sender, and receiver in its database. To 
check for a duplicate document using the document ID, sender, and receiver, you 
must instruct Trading Networks to extract the DocumentID, SenderID, and 
ReceiverID system attributes from the document.
Document ID, sender and document type—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 and sender 
you must instruct Trading Networks to extract the DocumentID and SenderID system 
attributes from the document.
To create a custom duplicate document check service, see “Creating a Duplicate 
Document Check Service” on page 352.

Note: A custom duplicate checking service can affect performance, depending on its logic.

webMethods Trading Networks Administrator’s Guide Version 7.1 321

 15. Defining and Managing 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, and the same document is sent again (see “Saving Flat File Documents to 
the Database” on page 322).
Trading Networks previously received a document and saved it to the database, but 
the document gateway service did not supply values in the pipeline for DocumentID, 
SenderID, and/or ReceiverID system attributes.
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, 
SenderID, and/or ReceiverID system attributes.
Trading Networks was unable to match the document to a TN document type.
Trading Networks saves the results of the duplicate check to the pipeline, so you can use 
it in the processing rule. Additionally, Trading Networks uses the results of the duplicate 
check in the Save Document to Database pre‐processing action.

Saving Flat File Documents to the Database

This action saves a copy of all documents or only unique documents to the database. 
You must save documents to the database if you want to use reliable delivery or 
scheduled delivery to deliver the document. For more information, see “Using Reliable 
Delivery with Immediate Delivery Method” on page 367 and “Using Reliable Delivery 
with Scheduled Delivery” on page 368.
You can choose to save:
All documents, regardless of whether they are unique.

Only unique documents. You must also select the Check for Duplicate Document 

pre‐processing option (see “Checking for Duplicates of the Flat File Document”). If 
you fail to select the Check for Duplicate Document option, Trading Networks considers 
the document as having no duplicate and will save the document to the database. 
No documents.

webMethods Trading Networks Administrator’s Guide Version 7.1 322

 15. Defining and Managing TN Flat File Document Types

You can save a copy of the document content, attributes, and/or activity log information to 
the database. The following table displays the consequences of not saving specific parts of 
documents:

If you do not save

this... Then the consequences of not saving are...
Content If you use the Deliver Document actions, Trading Networks will 
not use reliable delivery or scheduled delivery.
If Trading Networks is to use a delivery option that requires 
document content to be saved, Trading Networks will bypass 
reliable delivery and invoke the specified delivery service once, 
but only if the Trading Networks property 
tn.task.attempt.notPersisted is set to true (the default). For more 
information, see “tn.task.attempt.notPersisted” on page 504.
You will not be able to view content when monitoring 
transactions using My webMethods or Trading Networks 
Console.
You will not be able to resubmit or re‐process the document.
Attribute You will not be able to view custom attributes when monitoring 
transactions using My webMethods or Trading Networks 
Console (i.e., attributes will contain only information for system 
attributes). However, you can still use the processing rules 
extended criteria for the document.
In My webMethods or Trading Networks Console, you will not 
be able to search for documents based on the attribute values 
because their values were not saved to the database.
You might get different or unexpected results when you 
reprocess a document. Because the attributes are not saved 
when you reprocess the document, Trading Networks will not 
match processing rules that use extended criteria. Instead, 
Trading Networks will match to another processing rule, for 
example the default processing rule, and perform the process 
actions identified in that matching rule. Trading Networks does 
not perform document recognition again and therefore does not 
re‐extract the attributes. 

webMethods Trading Networks Administrator’s Guide Version 7.1 323

 15. Defining and Managing TN Flat File Document Types

If you do not save

this... Then the consequences of not saving are...
For example, if you use extended criteria to select a processing 
rule when the value of the custom attribute Total Amount is 
greater than 10000, 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.
Note: You can still resubmit a document. When Trading 
Networks resubmits a document, it performs document 
recognition and therefore extracts the attributes again.
Activity Log You will not be able to view activity log entries when 
monitoring transactions using My webMethods or Trading 
Networks Console.
You will not be able to view the activity log entries when 
managing the activity log using My webMethods or Trading 
Networks Console.

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. Trading Networks passes documents on to process management if it extracted a 
conversation ID from the document. For more information about process management, 
see the Getting Started with Business Process Management guide and the webMethods 
Designer online help.

webMethods Trading Networks Administrator’s Guide Version 7.1 324

 15. Defining and Managing TN Flat File Document Types

Defining TN Flat File Document Types

To define a TN flat file document type

1 In Trading Networks Console, perform one of the following procedures to start a new 
TN flat file document type. 

Method to start a TN document

type Procedure to perform

New— The TN flat file  1) Select View > Document Types.

document type fields are 
2) Select Types > New.
empty.
3) Select Flat file for the TN document type 
category.
4) Click OK.
Duplicate— The TN flat file  1) Select View > Document Types.
document type fields are 
filled with values from the  2) Click the row containing the TN flat file 
TN flat file document type  document type that you want to duplicate.
that you duplicate. 3) Select Types > Duplicate.
You can update any or all 
fields from the duplicated TN 
flat file document type.

2 In the Name field (required), type the name you want to give the TN flat file document 
type.
3 Optionally, type a description for the TN document type in the Description field.
4 Click the Configure tab.

webMethods Trading Networks Administrator’s Guide Version 7.1 325

 15. Defining and Managing TN Flat File Document Types

5 Click the Identify panel to specify the criteria that Trading Networks will use to match 
flat file documents to the TN document type. For details about the information you 
specify on this panel, see “Pipeline Matching Criteria Used to Identify the TN 
Document Type” on page 309.
Note: You must specify at least one attribute; otherwise Trading Networks will not use 
the TN document type.

a In the Pipeline Matching section, click  Add New Pipeline Match. 

b Specify the following values in the Add Pipeline Matching dialog box.

Attribute Specify
Name Name of the TN_parms variable.
Value Optional. The value of the TN_parms variable. If you specify a 
value, Trading Networks finds a match only if the variable has the 
specified value.

c Click OK to save the attribute and close the Add Pipeline Matching dialog box.
6 In the Extract panel, specify the system attributes and document attributes (document 
data) that you want Trading Networks to extract from documents. For details about 
what to specify for these fields, see “Attributes To Extract From Documents” on 
page 310.

Important! If you do not extract the system attributes, Trading Networks will not have 
this information available for processing rules or querying documents.

a Add an attribute to extract by clicking   Add New Attribute. Trading Networks 

displays the Add an attribute dialog box. 
Note: Trading Networks always lists SenderID and ReceiverID as attributes to be 
extracted. You cannot delete them.
b In the Name field, select the name of the attribute from the list. Trading Networks 
fills in the Type field based on the document attribute definition. To view more 

details about all of the document attributes, click   Document Attributes to view 

the Document Attributes screen.
c Select the Required check box if you want Trading Networks to throw an error 
when it cannot extract the attribute.
Note: Trading Networks always designates SenderID and ReceiverID as required.
Note: If you do not mark an attribute as required, Trading Networks does not flag 
an error if it is unable to extract the attribute. If Trading Networks completes 

webMethods Trading Networks Administrator’s Guide Version 7.1 326

 15. Defining and Managing TN Flat File Document Types

processing without encountering any further errors, it sets the processing status 
to DONE.
d Use the Retrieve SenderID from session option as an alternative way to set the value 
of the SenderID system attribute. If set, rather than look in TN_parms\SenderID 
for the value to use, Trading Networks uses the connected user. For more 
information, see “System Attributes To Extract From Documents” on page 312.
e Use the Transformation fields to specify how Trading Networks is to handle 
attribute data before storing it in the Trading Networks database. The data type of 
the attribute (shown in the Type field) determines the Built-in or Custom 
transformation options available. For more information, see “Transformation 
Information for Extracted Attributes of TN Flat File Document Types” on 
page 314.
Built-in. Select a built‐in transformation provided by Trading Networks. 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… For Transformation…

Is SenderID or You must select from the pull‐down list the type of the 
ReceiverID external IDs (for example, DUNS) for both attributes so 
that Trading Networks can match the externals ID in 
SenderID and ReceiverID with the external IDs in the 
profiles. This is how Trading Networks verifies the 
identities of the sender and receiver.
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.
Has DATETIME or You must specify a date format. Select a built‐in format 
DATETIME LIST or type in your own. For more information, see “Built‐
data type In Transformations for DATETIME and 
DATETIME LIST Data Type Attributes” on page 314.

webMethods Trading Networks Administrator’s Guide Version 7.1 327

 15. Defining and Managing TN Flat File Document Types

If the attribute data

type… For Transformation…

Has STRING or You can specify whether you want Trading Networks 

STRING LIST data to alter the string value to all uppercase or all 
type (but not lowercase before storing it. Alternatively, you can 
SenderID or have Trading Networks use the extracted values as 
ReceiverID) substitutions in a string that you supply. For more 
information, see “Built‐in Transformations for STRING 
or STRING LIST Data Type Attributes” on page 315.
Has NUMBER or You should specify the operation that Trading 
NUMBER LIST data Networks should perform on the numbers in the 
type array. For more information, see “Built‐in 
Transformations for NUMBER Data Type Attributes” 
on page 316.

Custom. Select or create your own service to perform custom transformations 
on extracted attributes. For more information, see “Custom Transformation 
Services” on page 317.

To do this… Perform this…

Create a new custom 
transformation Click   New Service.

Select an existing custom 
transformation service Click  Find Service to browse the IS namespace 
to locate the one you want to use.
Set the inputs of the  Click Set Inputs.
transformation from the 
selected service
Edit an existing service Click on the Edit Service button.

f Click OK to save the new attribute and close the Add an attribute dialog box. 
Trading Networks returns to the Extract panel of the Document Type Details 
screen. Trading Networks displays the name of the extracted attributes and their 
built‐in or custom transformation services.
Note: To delete an attribute from the TN document type, select the attribute row 

and click  Delete attribute. 

.

webMethods Trading Networks Administrator’s Guide Version 7.1 328

 15. Defining and Managing TN Flat File Document Types

7 Click the Options tab and specify any of the options.

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, see “Pre‐Processing Actions” on page 351.

Options tab
parameter Description

Parsing schema The fully qualified name of a flat file (parsing) schema to use to 

validate the structure of the documents. You only need to 
specify a flat file schema if you select the Validate Structure pre‐
processing option.

If you do not know the fully qualified name, click   Find
schema to browse flat file schemas to locate the one you want 
to use.
For more information, see “Validating the Structure of Flat File 
Documents” on page 320.
Processing Rule Indicates whether you want Trading Networks to search for a 
Routing processing rule and process the document based on the 
processing rule; select either Enable routing or Do not enable
routing. For more information, see “Disabling Processing Rule 
Routing” on page 318.
Verify Digital Executes a user‐defined verification service to verify the digital 
Signature  signature of the documents. Trading Networks executes this 
pre‐processing  pre‐processing action before executing the processing rule that 
action you associate with the TN document type. 
Create the verification service in any user‐defined package, 
using the inputs and outputs specified in 
wm.tn.rec:BizDocVerificationService (described in the webMethods 
Trading Networks Built‐in Services Reference). For more 
information, see “Verifying the Digital Signature of Flat File 
Documents” on page 319.

webMethods Trading Networks Administrator’s Guide Version 7.1 329

 15. Defining and Managing TN Flat File Document Types

Options tab
parameter Description

Validate Structure  Invokes the flat file parser to validate the document’s structure 

pre‐processing  and content against the flat file schema you specify in the 
action 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. The Input for 
Flat File Validation dialog box prompts you to select the 
parsing settings. 
Trading Networks executes this pre‐processing action before 
executing the processing rule that you associate with the TN 
document type. For more information, see “Validating the 
Structure of Flat File Documents” on page 320.
Check for Duplicate Searches the database to determine whether the database has 
Document  already received the document. Trading Networks executes 
pre‐processing  this pre‐processing action before executing the processing rule 
action that you associate with the TN document type. Select a built‐in 
service or use a custom service. For more information, see 
“Checking for Duplicates of the Flat File Document” on 
page 321. 

To create a new custom service click   New Service. 

To select an existing duplicate service, click  Find Service to 

browse the IS namespace to locate one and then click Edit
Service if you want to modify the service.

Note: A custom duplicate checking service may affect 
performance, depending on its logic. For details, see, “Creating 
a Duplicate Document Check Service” on page 352.

Save Document to Specify whether to save all documents, only unique 

Database  documents, or no documents. Additionally, specify whether to 
preprocessing  save the document’s content, attributes, and/or activity log 
action information. Trading Networks executes this pre‐processing 
action before executing the processing rule that you associate 
with the TN document type. For more information, see 
“Saving Flat File Documents to the Database” on page 322.

8 Click OK to create the TN flat file document type.

webMethods Trading Networks Administrator’s Guide Version 7.1 330

 15. Defining and Managing TN Flat File Document Types

Managing TN Flat File Document Types

The following table lists the tasks you can perform against TN flat file document types:

Task See page...

“Viewing TN Flat File Document Types” 331
“Updating TN Flat File Document Types” 331
“Disabling TN Flat File Document Types” 333
“Enabling TN Flat File Document Types” 334

Viewing TN Flat File Document Types

You can view all enabled and disabled TN document types.

To view TN flat file document types

1 In Trading Networks Console: View > Document Types.

Trading Networks displays the TN flat file document types as well as the TN XML 
document types.
2 To view disabled TN document types, select Types > Show All. Trading Networks 
places a check (D) next to the Show All menu item to indicate that it is currently 
displaying disabled TN document types.
3 To hide disabled TN document types, select Types > Show All again. Trading Networks 
removes the check (D) next to the Show All menu item to indicate that Trading 
Networks is currently not displaying disabled TN document types.

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 
Designer
-- 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 331

 15. Defining and Managing TN Flat File Document Types

To update a TN flat file document type

1 In Trading Networks Console: View > Document Types.

Trading Networks displays all TN flat file document types as well as the TN XML 
document types.
2 Click the row containing the TN flat file document type you want to update.
3 Select Types > Edit.
4 To update the description, type a new description in the Description field.
5 To update identification information, click on the Identify panel. For details about the 
what to specify on this panel, see “Pipeline Matching Criteria Used to Identify the TN 
Document Type” on page 309. 

To add a pipeline matching variable, click  Add New Pipeline Match. Click OK to save 

the variable and close the dialog box.
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 

Update Pipeline Matching dialog box, update the Name and Value fields for that 
variable. Click OK to save your updates and close the Update Pipeline Matching 
dialog box.
To delete a pipeline matching variable, click the row containing the pipeline matching 

variable you want to delete and click  Remove Selected Pipeline Match.

6 To update extraction information, click the Extract panel. For details about what to 
specify on this panel, see “Attributes To Extract From Documents” on page 310.
7 To update the system attributes, click on the System Attributes tab. For details about 
what to specify for these fields, see “System Attributes To Extract From Documents” 
on page 312.
To select a system attribute to extract, select the appropriate check box in front of the 
attribute name.
Note: The SenderID and ReceiverID are always selected.
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 
Networks database. For a summary of actions you can take for adding a new 
system attribute, see step 6 on page 326.
To deselect a system attribute, deselect the appropriate check box in front of the 
attribute name.

webMethods Trading Networks Administrator’s Guide Version 7.1 332

 15. Defining and Managing TN Flat File Document Types

8 To update custom attribute information, click on the Custom Attributes tab. Custom 
attributes are the user‐defined ones on the Document Attributes screen. For more 
information about document attributes, see Chapter 13, “Defining and Managing 
Document Attributes”.

To add a custom attribute, click   Add New Attribute. Then, add a new custom 

attribute. For a summary of actions you can for take for adding a new custom 
attribute, see step 4 on page 225. 

To view more details about all of the document attributes, click   Document

Attributes to view the Document Attributes screen.

To update a custom attribute, click  Edit Selected Attribute. For a summary of actions 

you can take for custom attributes, see step 4 on page 225.
To delete a custom attribute from the TN document type—Select the row for the attribute 

and click   Remove Selected Attribute.

9 To update options, click the Options tab. For details about these fields, see “Pre‐
Processing Actions in the TN Flat File Document Type” on page 319. 
10 After you have made all your changes, click OK. Trading Networks closes the screen.

Disabling TN Flat File Document Types

If you no longer want Trading Networks to use a TN document type, you can disable it. 
When you disable a TN document type, the definition for the TN document type is not 
removed from the database. You can enable it later (see “Enabling TN Flat File Document 
Types” on page 334).

Note: To permanently remove the TN document type from the database, your database 
administrator must remove it. When you remove a TN document type from the database, 
you must also remove all documents that are associated with the TN document type.

To disable a TN flat file document type

1 In Trading Networks Console: View > Document Types.

Trading Networks displays both the TN XML document types and TN flat file 
document types.
2 Click the row containing information about the TN flat file document type that you 
want to disable.
3 Select Types > Disable. Trading Networks places No in the Enabled column to indicate 
that the TN flat file document type is disabled.

webMethods Trading Networks Administrator’s Guide Version 7.1 333

 15. Defining and Managing TN Flat File Document Types

Note: To view the Enabled column (if it is not currently displayed), select Document
Types > Show All.

Enabling TN Flat File Document Types

If you disable a TN document type and then later determine that you still need it, you can 
enable it and make it available again.

Important! To enable TN document types, you must first display inactive TN document 
types as described in “Viewing TN Flat File Document Types” on page 331.

To enable a TN flat file document type

1 In Trading Networks Console: View > Document Types.

Trading Networks displays both the TN XML document types and TN flat file 
document types.
2 Click the row containing information about the TN document type that you want to 
enable.
3 Select Types > Enable. Trading Networks places Yes in the Enabled column to indicate 
that the TN document type is enabled.

webMethods Trading Networks Administrator’s Guide Version 7.1 334

Chapter 16. Defining and Managing Processing Rules

What are Processing Rules? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336

Processing Rules Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

Processing Rule Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

Extended Criteria—Using Custom Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

Pre-Processing Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

Processing Rule Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

Defining Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

About Querying and Viewing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

Managing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

webMethods Trading Networks Administrator’s Guide Version 7.1 335

 16. Defining and Managing Processing Rules

What are Processing Rules?

Processing rules specify how you want webMethods Trading Networks (Trading 
Networks) to process documents. For example, you might want Trading Networks to 
send an alert e‐mail message to a contact, and then deliver the document to the receiver 
that is identified in the document.
For each document that Trading Networks is to process, it performs a processing rule 
lookup to determine which processing rule to use for a specific document. After Trading 
Networks locates the appropriate processing rule, it takes the actions that you specify in a 
processing rule. Alternatively, you can bypass the lookup if you already know which 
processing rule you want to execute, thus avoiding the overhead of the lookup (see 
“Bypassing Lookups for Processing Rules” on page 349).
After Trading Networks finds the appropriate processing rule for a document, it performs 
the pre‐processing and processing actions. The pre‐processing actions identify actions that 
Trading Networks performs before performing the processing actions. You can specify 
pre‐processing actions in both the TN document type and the processing rule. The actions 
you specify in the processing rule can be configured to override the actions that are 
specified in the TN document type.

Note: If you are working in a clustered environment, all Trading Networks servers must be 
set up for cluster synchronization. That is, the servers must set the 
tn.cluster.sync.remoteAliases property correctly. For more information about how to configure 
Trading Networks for a clustered environment, see “Shared Trading Networks Database 
in a Clustered Environment”.

For more information about 

Processing rules, see Chapter 3, ʺSetting up Trading Networks to Process 
Documentsʺ
Delivery methods you can use with Trading Networks, see Chapter 6, ʺDelivering 
Documents to Partnersʺ in the webMethods Trading Networks Concepts Guide.
Large document handling, see Chapter 5, ʺTrading Networks Document 
Processingʺ in the webMethods Trading Networks Concepts Guide and Appendix F, 
“Large Document Handling”.

webMethods Trading Networks Administrator’s Guide Version 7.1 336

 16. Defining and Managing Processing Rules

Processing Rules Order

If a document matches more than one processing rule, Trading Networks uses the first 
processing rule it encounters. As a result, the order in which you list your processing rules 
on the Processing Rules screen is important. Trading Networks maintains the order of the 
processing rules by assigning an ordinal to each processing rule. 

Adding Processing Rules and the Order of Processing Rules

When you add a new processing rule, 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. 

Note: If you are working with a queried list of processing rules, remember that Trading 
Networks adds the new rule to the full, unfiltered list of processing rules (e.g., all of the 
processing rules). 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 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.

If you add a new processing rule using

this option.... The processing rules reorder in this way...
Above— Add a new processing  The new processing rule is assigned the 
rule above the highlighted rule. original ordinal of the highlighted rule. 
The highlighted processing rule is assigned its 
original ordinal + 1.
All existing processing rules below the 
highlighted processing rule keep their 
respective order but are also assigned their 
original ordinal + 1.
Below— Add a new processing rule  The new processing rule is assigned the 
below the highlighted rule.  highlighted rule’s original ordinal + 1.
The highlighted processing rule keeps its 
original ordinal.
All existing processing rules below the 
highlighted processing rule keep their 
respective order, but they are assigned their 
original ordinal + 1.

webMethods Trading Networks Administrator’s Guide Version 7.1 337

 16. Defining and Managing Processing Rules

If you add a new processing rule using

this option.... The processing rules reorder in this way...
Last—Add a new processing rule  The new processing rule is placed in the last 
to the bottom of the processing  position at the bottom of the full, unfiltered 
rules list. If you set up a default  list of processing rules. 
processing rule, place it here (last) 
in the list.  All other processing rules keep their original 
ordinals.

Example: The following diagrams demonstrate what happens if you highlight Processing
Rule B, Ordinal 12 as the rule to add your new processing rule in relation to.

Add Processing Rule ABOVE Processing Rule B, Ordinal 12

Add new rule ABOVE

Processing Rule B,
Ordinal 12

The new rule is ABOVE

Processing Rule B and is
now Ordinal 12

Processing Rule B is
now Ordinal 13

webMethods Trading Networks Administrator’s Guide Version 7.1 338

 16. Defining and Managing Processing Rules

Add Processing Rule BELOW Processing Rule B, 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 Administrator’s Guide Version 7.1 339

 16. Defining and Managing Processing Rules

Add Processing LAST

Add new rule LAST

(below the Default rule,
Ordinal15)

Default rule remains

Ordinal 15

The new rule is LAST,

Ordinal 16, and is now
below the Default rule

Reordering Processing Rules

You can reorder the processing rules by moving them up or down. When you reorder a 
processing rule, Trading Networks reassigns the ordinal number for your selected 
processing rule and all affected processing rules.

Note: If you reorder processing rules, there is no “undo” function that will return the 
processing rules to their original order.

If you are working with a queried list of processing rules, remember that Trading 
Networks adds the new rule to the full, unfiltered list of processing rules (e.g., all of the 
processing rules). 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.
Keep rules with specific criteria before rules with general criteria. 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. Trading Networks ships with a default 
processing rule that you can use. Place the default processing rule in the last position of 
the full, unfiltered processing rules list. For more information about the default 
processing rule, see “Setting Up a Default Processing Rule” on page 386.

webMethods Trading Networks Administrator’s Guide Version 7.1 340

 16. Defining and Managing Processing Rules

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. A document has a sender, receiver, 
TN document type, user status, the possibility of having errors, and the custom attributes 
that the TN document type instructed Trading Networks to extract. You can set up a 
processing rule to match one or more of these criteria. For example, you can specify that a 
processing rule is to apply to documents that have specified senders and receivers, have a 
specified TN document type, and the extracted custom attribute “Total PO Amount” is 
greater than 10000.
All processing rule criteria that you specify must match the document information for 
Trading Networks to use the rule to process the document. As another example, you 
might set up the following criteria:

Criterion Value(s) To match...

Sender “Any” The sender can be any value
Receiver “Industrial Steel Company” The receiver must be “Industrial 
“United Steel” Steel Company” or “United Steel”
Document Type “cXML Order Request” The TN document type must be 
“cXML Order Request”
User Status “Needs approval” The user status must be “Needs 
approval”
Recognition Errors “has no errors” The document cannot have errors

Keep rules with specific criteria before rules with general criteria. 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. Trading Networks ships with a default 
processing rule that you can use. Place the default processing rule in the last position of 
the full, unfiltered processing rules list. For more information about ordering processing 
rules, see “Processing Rules Order” on page 337. For more information about the default 
processing rule, see “Setting Up a Default Processing Rule” on page 386.
The rest of this section describes the types of criteria you can specify in a processing rule.

Sender and Receiver Criteria

You can use the sender and/or receiver of a document as criteria in a processing rule.
After Trading Networks recognizes the TN document type, it extracts the document 
attributes that are specified in the TN document type. To process a document based on 
sender/receiver, you must specify that you want Trading Networks to extract the SenderID 
and ReceiverID system attributes from the document. You can select one or more partners 
and/or one or more partner profile groups to be a sender or receiver. 

webMethods Trading Networks Administrator’s Guide Version 7.1 341

 16. Defining and Managing Processing Rules

If Trading Networks cannot determine the sender/receiver of a document, it considers the 
sender/receiver an unknown partner. Trading Networks uses the unknown partner for a 
document in all the following situations:
The TN document type is unknown. Because it is the TN document type that specifies 
the attributes to extract, when the TN document type is not recognized, Trading 
Networks cannot extract any attributes (including SenderID and ReceiverID).
The TN document type does not instruct Trading Networks to extract the SenderID 
and ReceiverID system attributes. 
The XQL query (in the TN document type) that identifies the location of the SenderID/
ReceiverID system attributes is not valid.
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. 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.
If a document was sent by one of your partners (for example, Industrial Steel Company), 
but Trading Networks cannot determine the sender for one of the above reasons, Trading 
Networks uses Unknown for the sender. If you have a processing rule that processes 
documents that are sent by this partner (for example, Industrial Steel Company), Trading 
Networks will not select the rule because it is using the unknown partner 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, it uses 
the corporation name and unit name specified in the partner profile as the name of the 
sender and/or receiver. Trading Networks compares the name of the partner (or 
unknown) to the partner or partners that you specify in the processing rule. 

If you specify this… The rule matches…

Any Senders Regardless of the partner that is identified as the 
sender/receiver in of the document, even if the partner is 
—or— unknown
Any Receivers
Enterprise Only if the sender/receiver that is identified in the document is 
the local partner.
Unknown Only if the sender/receiver is unknown
Selected Senders Only if the sender/receiver that is identified in the document is 
one of the partners you specify
—or—
Selected Receivers

webMethods Trading Networks Administrator’s Guide Version 7.1 342

 16. Defining and Managing Processing Rules

Document Type Criterion

One of the criteria that you can use in a processing rule is the TN document type of a 
document.
When Trading Networks has a document that it needs to process, it must first attempt to 
recognize the type of document. To do this, Trading Networks determines the TN 
document type that matches the document. Trading Networks sets the TN document type 
of the document to the name of the matching TN document type. If a document does not 
match any TN document type or if it matches multiple TN document types, the document 
is considered an unknown TN document type. 
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. You can specify one of the 
following for the document type criterion in a processing rule: 

If you specify this… The rule matches…

Any Document Types Regardless of the TN document type of the document, even if 
the TN document type is unknown
Unknown Only if the TN document type is unknown
Selected Document Only if the name of the TN document type is one of the TN 
Types document types you specify

User Status Criterion

You can use the user status of a document as a criterion in a processing rule.
The user status is a status that you can associate with a document. If you do not extract the 
User Status system attribute from a 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.wm.app.tn.doc.BizDocEnvelope.setUserStatus(String) 
com.wm.app.tn.db.BizDocStore.changeStatus(BizDocEnvelope,String,String) 
The built‐in service wm.tn.doc:changeStatus

Processing action that changes the user status

webMethods Trading Networks Administrator’s Guide Version 7.1 343

 16. Defining and Managing Processing Rules

The following shows an example of using user status criteria during processing:
User Status and Processing

Integration Server

Processing Rule
TN document type = PO
user status = accepted
Service
6 handles POs
Processing Rule
TN document type = PO
user status = rejected

PO Processing Rule
1
TN document type = PO
user status = any 2

TN document type = PO
user status = null

To:
3 PO
From:
Subject:
Accept Reject
http://tn:5555/PO.dsp

Set user status to “accepted” Set user status to “rejected”

4

PO

Step Description

1 Trading Networks receives a document and recognizes that its TN 
document type is PO. The user status is originally null because Trading 
Networks was not instructed to extract the User Status system attribute.

2 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 processing action in this rule indicates Trading Networks is to 
send an alert e‐mail. The alert e‐mail contains a URL for a web page that 
displays the PO. The processing rule also changes the user status to 
“pending approval”.

3 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 344

 16. Defining and Managing Processing Rules

Step Description

4 The user selects either Accept or Reject. When the user selects either button, 
code executes. If the user selects Accept, the code uses the built‐in service 
wm.tn.doc:changeStatus to set the user status associated with the document to 
“accepted.” If the user selects Reject, the code uses the built‐in service to set 
the user status associated with the document to “rejected”.

5 The code for the web form invokes the wm.tn:submit built‐in service that sends 
the document back to the Integration Server for processing. Trading 
Networks recognizes the TN document type is PO and determines the user 
status, which is either “accepted” or “rejected.” 

6 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.” This processing action 
in these rules indicates Trading Networks is to invoke a service. This service 
processes the purchase order appropriately.

You can set the user status processing rule criterion to one of the following: 

If you specify this… The rule matches…

Any User Status Regardless of the user status of the document, even if the user 
status is null
Specified User Status 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. (This criterion does not allow you to process documents based on 
errors that occur while performing the pre‐processing or processing actions. This is 
because Trading Networks uses criteria before processing to determine the processing 
rule to use for processing.)
Trading Networks flags a general error if an identifying XQL query in the TN document 
type failed. For example, this error occurs when the document is identified as an XML 
document but contains invalid XML. Another example is if the document is identified as 
an XML document but is actually another format, for example plain text or EDI.
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.
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. Similarly, Trading Networks flags 

webMethods Trading Networks Administrator’s Guide Version 7.1 345

 16. Defining and Managing Processing Rules

a 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.
This processing criterion is useful to assure that processing occurs only if no errors were 
encountered during document recognition. Conversely, you can also use this criterion to 
set up processing rules that specifically handle error cases.
You can set the error processing rule Content Criteria to one of the following:

If you specify this… The rule matches…

may have errors Regardless of whether Trading Networks encountered errors
has no errors Only if Trading Networks did not encounter any errors
has 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. For 
example, you might want to process purchase orders for an amount over $10,000 
differently from purchase orders with an amount under $10,000. If you extract a custom 
attribute, for example, Total PO Amount, from a document, 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.
After Trading Networks recognizes the TN document type, it extracts the custom 
attributes that are specified in the TN document type. If the XQL query for the custom 
attribute is not valid or it identifies a node that is not in the document, the value of the 
custom attribute will be null. When you use extended criteria, you can match a document 
based on whether the custom attribute value is null or not null. In addition, if the value is 
not null, you can match based on the value that Trading Networks extracted for the 
custom attribute. For example, if you have Trading Networks extract the custom attribute, 
Shipping Date, you can use the extended criteria to match if Shipping Date is equal to a date 
you specify.
For each custom attribute that you want to use in the extended criteria, you specify the 
attribute name, an operator, and the value the attribute should have.
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. You can 
specify any attribute that is defined to your system.
Operator instructs Trading Networks how to match the value, for example, match 
string values that contain specified characters, match number values that are greater 

webMethods Trading Networks Administrator’s Guide Version 7.1 346

 16. Defining and Managing Processing Rules

than a specified value, or match date values before a specified date. The operator you 
can specify depends on the data type of the custom attribute. 

Data Type Operator Matches when the attribute extracted from a document…
STRING Is null Has no 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.
You do not need to specify a value when you specify 
this operator.
Is not null Has any value. You do not need to specify a value 
when you specify this operator.
Equals Matches exactly the value that you specify.
Contains Contains the character string that you specify for the 
value.
Not equals Has a value that does not match the value that you 
specify.
STRINGLIST Is null 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.
Is not null Has any value. You do not need to specify a value 
when you specify this operator.
Includes Includes the value that you specify.
NUMBER Is null Has no 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.
You do not need to specify a value when you specify 
this operator.
Is not null Has any value. You do not need to specify a value 
when you specify this operator.
Equals Matches exactly the value that you specify.
Less than Has a value that is less than the value that you 
specify.
Greater than Has a value that is greater than the value that you 
specify.

webMethods Trading Networks Administrator’s Guide Version 7.1 347

 16. Defining and Managing Processing Rules

Data Type Operator Matches when the attribute extracted from a document…
NUMBER Less than or  Has a value that is less than or equal to the value 
(continued) equals that you specify.
Greater than  Has a value that is greater than or equal to the value 
or equals that you specify.
Not equals Has a value that does not match the value that you 
specify.
NUMBERLIST Is null Has no 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.
You do not need to specify a value when you specify 
this operator.
Is not null Has any value. You do not need to specify a value 
when you specify this operator.
Includes Includes the value that you specify.
DATETIME Is null Has no 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.
You do not need to specify a value when you specify 
this operator.
Is not null Has any value. You do not need to specify a value 
when you specify this operator.
Equals Matches exactly the value that you specify.
Before Is a date that is before the date that you specify.
After Is a date that is after the date that you specify.
DATETIMELIST Is null Has no 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.
You do not need to specify a value when you specify 
this operator.
Is not null Has any value. You do not need to specify a value 
when you specify this date list.

webMethods Trading Networks Administrator’s Guide Version 7.1 348

 16. Defining and Managing Processing Rules

Value along with the 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, Trading 
Networks might still have a null value for the attribute. 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.
The TN document type of the document is unknown. (Trading Networks does 
not extract attributes for unknown TN document types.)

Note: For custom attributes that are extracted from an XML document, Trading 
Networks returns specific values for different attribute data types. For more 
information about these extraction values, see “Extracting Custom Attributes From 
XML Documents” on page 523.

You can specify multiple custom attributes in the extended criteria. Trading Networks 
only selects the processing rule if all the criteria you specify match.

Note: If the pre‐processing actions do not indicate that Trading Networks is to save the 
attributes, Trading Networks does not save the custom attributes. However, you can still 
use extended criteria for the document. For more information about the pre‐processing 
actions, see “Pre‐Processing Actions” on page 351.

If you reprocess a document, Trading Networks does not recognize the TN document 
type again and therefore does not re‐extract the attributes. If you reprocess a document 
for which Trading Networks did not save the attributes, Trading Networks will not match 
processing rules that use extended criteria. Instead, Trading Networks will match to 
another processing rule, for example the default processing rule, and perform the process 
actions identified in that matching rule. For more information about reprocessing a 
document, see the webMethods Trading Networks User’s Guide.

Bypassing Lookups for Processing Rules

As previously mentioned, for each document that Trading Networks is to process, it 
performs a processing rule lookup to determine which processing rule to use for a specific 
document. You can alter this behavior in the following ways:
You can have Trading Networks skip looking up a processing rule and not process 
the document using actions from a processing rule.
You can explicitly specify which processing rule to execute for a given document 
type, thus bypassing the lookup (and its overhead).

webMethods Trading Networks Administrator’s Guide Version 7.1 349

 16. Defining and Managing Processing Rules

Skip Processing Rule Actions

You can define a TN document type so that it disables processing rule processing. For 
more information, see “Disabling Processing Rule Routing” on page 255 and “Disabling 
Processing Rule Routing” on page 318.

Bypass Lookup by Explicitly Specifying the Processing Rule

To explicitly specify the processing rule that you want Trading Networks to use, 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, invoke the wm.tn.route:list service.
processingRuleName—The name (a String) of the processing rule you want Trading 
Networks to execute for the flat file document.
If you include values for both attributes (which is unnecessary), processingRuleID is used.
For more information about these attributes and TN_parms, see “Specifying the Document 
Gateway Services Outputs” on page 306.
Be careful not to specify a rule that may process your documents inappropriately. For 
example, assume the following rules are defined to process purchase orders:

Rule Action
1: Execute for orders >$10000 Perform special handling
2: Execute for orders <$10 Discard order
3: Execute for all other orders Perform standard handling

If you assign the rule 2 identifier as the value of processingRuleID, and an application 
submits an order greater than $10, rule 2 will discard the order.

webMethods Trading Networks Administrator’s Guide Version 7.1 350

 16. Defining and Managing Processing Rules

Pre-Processing Actions
Trading Networks performs pre‐processing actions before it processes the document using 
the processing rule actions. You can specify pre‐processing actions in both the TN 
document type and the processing rule. You specify the pre‐processing actions in the 
processing rule to override the actions that are specified in the TN document type.
Trading Networks performs the pre‐processing actions in the following order. Use pre‐
processing actions to instruct Trading Networks to:
Verify Digital Signature—Trading Networks verifies the digital signature of a document. 
To verify that the document arrived unchanged, Trading Networks assures the signed 
body has not changed by verifying the digital signature. To verify that the sender is 
who it claims to be, Trading Networks matches the certificate from the digital 
signature to the certificate that Trading Networks has on file for the partner.
Validate Structure—Trading Networks validates the structure of the document against 
an IS schema. Trading Networks assures that the document matches the structure 
identified by the IS schema (using the pub.schema:validate built‐in service). 
Check for Duplicate Document—Trading Networks determines if there is a duplicate of 
the document; that is, if it has already received the document. Trading Networks 
checks the document being processed against documents it has in its database. 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. 
Document ID and sender—Trading Networks assures that it does not already 
have a document with same document ID and sender in its database.
Document ID, sender and receiver—Trading Networks assures that it does not 
already have a document with the same document ID, sender, and receiver in 
its database.
Document ID, sender and document type—Trading Networks assures that it does 
not already have a document with the same document ID, sender, and TN 
document type in its database.
Custom services—Use a service that you create to determine whether a document 
is a duplicate. For more information, see below, “Creating a Duplicate Document 
Check 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 351

 16. Defining and Managing Processing Rules

Trading Networks saves the results of the duplicate check to the pipeline. As a result, 
this information is available for use in the processing actions that you define in the 
processing rule.
Save Document to Database—Trading Networks saves a copy of the document content, 
attributes, and/or activity log information to the database. Trading Networks uses the 
results of the duplicate check in the Save Document to Database pre‐processing action.
Certain delivery options require saving the document content to the database, for 
example, if you want to deliver a document via a queue. 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, Trading Networks will bypass reliable delivery and 
invoke the specified delivery service once.
For more information about pre‐processing actions for XML documents, see “Specifying 
Pre‐Processing Actions for TN XML Document Type” on page 256. For more information 
about pre‐processing actions for flat file documents, see “Pre‐Processing Actions in the 
TN Flat File Document Type” on page 319.
For all pre‐processing actions, 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, see Chapter 3, ʺSetting up Trading 

Networks to Process Documentsʺ and Chapter 6, ʺDelivering Documents to Partnersʺ 
in the webMethods Trading Networks Concepts Guide.

Creating a Duplicate Document Check Service

The service must implement the input and output variables that are defined in the 
wm.tn.rec:DupCheckService specification. Trading Networks passes the following input 
variables:

Input Value Meaning

bizdoc The BizDocEnvelope that represents the document to perform the 
duplicate document check on. The BizDocEnvelope conforms to the 
wm.tn.rec:BizDocEnvelope IS document type.

webMethods Trading Networks Administrator’s Guide Version 7.1 352

 16. Defining and Managing Processing Rules

For duplicate checking services, Trading Networks passes the following output variables:

Output Value Meaning

duplicate String Whether the service determined the document is a duplicate. The 

service should return either true or false for duplicate.

The specification is located in the WmTN package. For more information about this 
specification, see the webMethods Trading Networks Built‐in Services Reference.

Processing Rule Actions

The purpose of the actions in a processing rule is to specify how Trading Networks is to 
process a document. When Trading Networks finds the processing rule to use for a 
document (using the criteria), Trading Networks performs the actions specified in the 
processing rule to process the document.
You can define the processing rule actions to instruct Trading Networks either to ignore 
the document (that is, do nothing) or to perform one or more of the following actions in 
the order listed below:
Execute a service that you specify. You can have Trading Networks invoke the service 
synchronously or asynchronously.
Send an alert e‐mail message to one of the contacts defined for the sender of the 
document, one of the contacts defined for the receiver of the document, the 
webMethods system administrator, or another e‐mail that you specify.
Change the user status for the document.

Deliver the document to the receiver using a defined delivery method, e.g., Primary 
HTTP.
Respond to the caller with a message that you specify.
If you select to have Trading Networks perform more than one of the above actions, 
Trading Networks performs the actions in the order listed above. For example, if you 
select to execute a service, send an alert e‐mail message, and deliver the document to the 
receiver, Trading Networks performs the actions in that order.
If Trading Networks encounters an error performing one of the actions, it will continue to 
attempt the other actions. For example, if the service specified in the rule does not exist, 
Trading Networks will receive an error attempting to invoke the service. In this situation, 
Trading Networks logs the error in the activity log and continues, attempting to send the 
alert e‐mail message and deliver the document to the receiver.

webMethods Trading Networks Administrator’s Guide Version 7.1 353

 16. Defining and Managing Processing Rules

For more information about 

Processing rule actions, see Chapter 5, ʺTrading Networks Document Processingʺ 
in the webMethods Trading Networks Concepts Guide.
Delivery methods you can use, see Chapter 6, ʺDelivering Documents to Partnersʺ 
in the webMethods Trading Networks Concepts Guide.

Action 1—Execute a Service

Use the Execute a service action to have Trading Networks invoke a service that you 
specify. The service can perform any action you want. For example, 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.
The following lists the prerequisite to using the Execute a service action.

Prerequisite
Before you can use the Execute a service action, the service that you want to invoke must 
exist on the Integration Server. If the service does not exist, you can access the 
Developer from the Processing Rules screen to create the service. 

When you use the Execute a service action, you specify the service you want Trading 
Networks to execute and whether you want Trading Networks to invoke the service 
synchronously or asynchronously. In addition, you can optionally set input values to 
hardcode input values for the service.

Note: If you are using large document processing, see “Creating Services that Recognize 
Large Document Handling” on page 530.

Executing the Service Synchronously or Asynchronously

To specify that you want Trading Networks to execute a service synchronously or 
asynchronously, you select one of the following:
Synchronous—Trading Networks attempts to synchronously execute the service a 
single time.
Asynchronous—Trading Networks attempts to asynchronously execute the service a 
single time.
Service execution task—Trading Networks sets up a service execution task for the 
asynchronous execution of the service. Trading Networks uses reliable execution to 
re‐execute the service one or more times if the service fails. For more information 
about service execution tasks, see “Service Execution Tasks and Reliable Execution” 
on page 356.

webMethods Trading Networks Administrator’s Guide Version 7.1 354

 16. Defining and Managing Processing Rules

The following table describes the behavior of Trading Networks based on whether you 
use synchronous, asynchronous, or service execution task:

Trading Networks Behavior for the Execute a service Action

When does Trading synchronous Trading Networks waits for the service to 
Networks process complete before it performs the rest of the 
subsequent processing actions. Trading Networks 
processing actions? merges the results from the service into the 
pipeline. This allows you to use the service 
results in output templates or in other 
processing actions.
If there are no subsequent processing actions, 
Trading Networks waits for the service to 
complete before returning to the caller that 
sent the document for processing.
asynchronous Trading Networks processes the actions 
and immediately. The results of the service are 
service execution not available in the pipeline for the other 
task processing actions.
If there are no subsequent processing actions, 
Trading Networks immediately returns to 
the caller that sent the document for 
processing.

webMethods Trading Networks Administrator’s Guide Version 7.1 355

 16. Defining and Managing Processing Rules

Trading Networks Behavior for the Execute a service Action

What does Trading synchronous If you do not select the Respond With 
Networks return to processing action, the results of the service 
the caller? are returned unmodified to the caller that 
sent the document for processing.
If you do select the Respond With processing 
action, Trading Networks does not return the 
results of the service to the caller. It returns 
only the message that you specify with the 
Respond With 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. 
This includes the results of the service.
asynchronous If you do not select the Respond With 
and processing action, Trading Networks returns 
service execution no additional information to the caller.
task
If you do select the Respond With processing 
action, Trading Networks returns the 
message that you specify with the Respond
With action.
Trading Networks cannot return the results 
of the service because the service might not 
be complete.
What if the service synchronous,  Trading Networks logs the error to its 
throws an exception asynchronous activity log and continues with the other 
or does not exist at and actions in the processing rule, if any.
runtime (i.e., it was service execution
deleted since you task
created the
processing rule)?

Service Execution Tasks and Reliable Execution

When you select service execution task, Trading Networks sets up a service execution task 
to execute your service. A service execution task is a task that Trading Networks performs to 
asynchronously execute a service using reliable execution. Reliable execution is a feature of 
Trading Networks that allows Trading Networks to automatically retry failed services. 
When you configure Trading Networks, you define the system‐wide settings for service 
execution tasks. Use the Trading Networks tn.transport.user property to indicate the user 
account to use when invoking the service. By default, Trading Networks uses the 

webMethods Trading Networks Administrator’s Guide Version 7.1 356

 16. Defining and Managing Processing Rules

Administrator user account to invoke services. For more information about this property, 
see “tn.transport.user” on page 511. 
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.
If Trading Networks attempts to execute a service and the service fails, Trading Networks 
attempts to execute the service subsequent times until the service succeeds or until 
Trading Networks reaches the maximum retry limit. If Trading Networks has reached the 
maximum retry limit and the service has not successfully executed, Trading Networks 
marks the service execution task as failed.
To determine whether a service was successful or failed, Trading Networks evaluates the 
value of the status output variable. 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. For more information about the output variables that your service 
should return, see “Defining a Processing Rule Based on a Saved Document” on page 385.
The following table lists the system‐wide settings for service execution tasks that you can 
configure. When using reliable execution, Trading Networks uses these settings to 
establish the parameters for the service execution task that governs the execution of the 
service. For instructions on how to configure these settings, see “Configuring Tasks 
Settings” on page 52.

Service Execution
Task Setting Description
Maximum Retries The number of times you want Trading Networks to attempt to 
re‐execute a service.
Wait Between The number of milliseconds (ms) you want Trading Networks to 
Retries wait before making its first attempt to re‐execute the service. 
(Trading Networks uses the Retry Factor along with the Wait Between
Retries value to calculate how long to wait for subsequent retry 
attempts.)
Retry Factor 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. Trading Networks calculates the 
time to wait by multiplying the last wait time by the value you 
specify for Retry Factor.

webMethods Trading Networks Administrator’s Guide Version 7.1 357

 16. Defining and Managing Processing Rules

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.

Maximum Retries =     3

Wait Between Retries =     10000 ms
Retry Factor =     2
Retry 1 Retry 2 Retry 3
Wait until next attempt 10000 ms 20000 ms 40000 ms

With the above settings, if the original attempt to execute the service fails, Trading 
Networks waits 10000 milliseconds before it makes its first retry attempt. If the first retry 
attempt fails, Trading Networks determines the next retry wait period by multiplying the 
last wait value (10000 ms) by the Retry Factor (2). This results in 20000 ms; Trading 
Networks waits 20000 ms between the first failed retry attempt an the second retry 
attempt. If the second retry attempt fails, Trading Networks multiplies the last wait value 
(20000 ms) by the Retry Factor (2). This results in 40000 ms; Trading Networks waits 40000 
ms between the second retry attempt and the third retry attempt.
Trading Networks keeps track of the progress and status of each service execution task. If 
the service execution task fails, you can troubleshoot the problem. If you can correct the 
problem, you can restart the service execution task to have Trading Networks attempt to 
execute the service again. You can view information about service execution tasks from 
My webMethods and the Trading Networks Console. For more information about 
managing and tracking service execution tasks, see the webMethods Trading Networks 
User’s Guide.

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. 

webMethods Trading Networks Administrator’s Guide Version 7.1 358

 16. Defining and Managing Processing Rules

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, asynchronous, or service execution task.

Method Specification You Must Use

synchronous The service must implement, at a minimum, the input variables 
and that are defined in the wm.tn.rec:ProcessingService specification. The 
asynchronous input values that are identified in the specification are the IS 
documents (IData objects) that are in the pipeline during 
processing. The specification does not identify any outputs.
To view the wm.tn.rec:ProcessingService specification, use the 
webMethods Developer. The specification is located in the WmTN 
package.
service execution The service must implement, at a minimum, the input and output 
task variables that are defined in the wm.tn.rec:ReliableProcessingService 
specification. The input values that are identified in the 
specification are the IS documents (IData objects) that are in the 
pipeline during processing. Your service must specify output 
values that indicate the outcome of the service. See below for 
additional information about setting the output variables.
To view the wm.tn.rec:ReliableProcessingService specification, use the 
webMethods Developer. The specification is located in the WmTN 
package.

If you use synchronous or asynchronous, Trading Networks does not require the service to 
have specific output values. However, if you use service execution task, your service must 
provide values for the serviceOutput output variable, which is an IS document (IData 
object) that contains the following String variables:

webMethods Trading Networks Administrator’s Guide Version 7.1 359

 16. Defining and Managing Processing Rules

Variable in the
serviceOutput Specify…
status 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 Meaning

success The service executed successfully.
When your service returns this value, Trading 
Networks updates the status of the service execution 
task for this service to DONE. Trading Networks does 
not attempt to execute the service again.
fail The execution of the service failed.
If the maximum retry limit has been met, Trading 
Networks updates the status of the service execution 
task for this service to FAILED. If the maximum retry 
limit has not yet been reached, the status of the service 
execution task remains PENDING and Trading 
Networks will attempt to re‐execute the service after 
the wait period elapses.
statusMessage Optional. A message that contains more information about the 
outcome of the service. It is recommended that you provide 
information for statusMessage if the service fails, for example, an 
error message that explains why the service failed.
transportTime Optional. The number of milliseconds it took for the service to 
execute. Specify this value if you want to maintain analytical 
information about how long it took the service to execute.

You can view the task detail information described above, plus other task‐related 
information, such as, the number of times Trading Networks has attempted to retry the 
service from My webMethods and Trading Networks Console. For instructions on how to 
view tasks, see information about managing tasks in the webMethods Trading Networks 
User’s Guide.

Setting Values for the Input Variables

If you create a service that requires input values, in addition to the input values specified 
in the wm.tn.rec:ProcessingService or wm.tn.rec:ReliableProcessingService specification, you might 
want to hardcode some of the values. You can do this when you set up the processing 
rule.

webMethods Trading Networks Administrator’s Guide Version 7.1 360

 16. Defining and Managing Processing Rules

For example, you might create a service that can add, update, or delete an entry for a 
partner in your back‐end system. Input to the service is a flag that indicates the action the 
service is to take—add, update, or delete. You can create three separate processing rules 
that all execute this service. However, you set the input values for the flag different for 
each processing rule. For the processing rule that is triggered by a document for which 
you want to add an entry, set the input value of the flag to indicate the service should add 
an entry. For the processing rule that is triggered by a document for which you want to 
update an entry, set the input value of the flag to indicate the service should update an 
entry, and so on.

Logic for the Service

This service can perform any logic that you want. You might want to perform different 
processing based on whether Trading Networks encountered errors during previous 
processing, e.g., whether a document is a duplicate. For more information about creating 
the service, see the webMethods Developer User’s Guide.

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.

Prerequisite
Before you can use the Alert e-mail action, your Trading Networks system must be set up 
to allow Trading Networks to send e‐mail messages. 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.
To specify the address of the SMTP server, use the following procedure: 
1 In Server Administrator: Settings > Logging.
2 Click Edit logging settings.
3 In the Email Notification section of the screen, set the SMTP Server field to the domain 
name or IP address of the SMTP server that you want the Integration Server to use.
4 Click Save Changes.

When you use the Alert e-mail action, you specify the recipient that is to receive the e‐mail 
message, the subject line for the e‐mail message, and the body (or content) of the e‐mail 
message.

webMethods Trading Networks Administrator’s Guide Version 7.1 361

 16. Defining and Managing Processing Rules

Recipient of the E-mail Message

You can use one of the following as the recipient of the e‐mail message:

If you select… Specify…

Sender The sender’s contacts that are to receive the e‐mail message. For 
example, if you want Trading Networks to send the e‐mail 
message to the senderʹs administrative contacts, select 
“Administrative”. Trading Networks looks in the sender’s profile 
for the e‐mail addresses of all contacts of the type you selected. 
If the sender is unknown or if the contact type you specify is not 
defined in the sender’s profile, Trading Networks will be unable to 
determine an e‐mail address. As a result, Trading Networks will 
be unable to send the e‐mail message. In this situation, Trading 
Networks logs the error to its activity log and continues with the 
other actions you specified in the processing rule, if any.
Receiver The receiver’s contacts that are to receive the e‐mail message. For 
example, if you want Trading Networks to send the e‐mail 
message to the receiverʹs technical contact, specify “Technical”. 
Trading Networks looks in the receiver’s profile for the e‐mail 
addresses of all contacts of the type you selected.
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 determine an e‐mail address. As a result, Trading Networks will 
be unable to send the e‐mail message. In this situation, Trading 
Networks logs the error to its activity log and continues with the 
other actions you specified in the processing rule, if any.

webMethods Trading Networks Administrator’s Guide Version 7.1 362

 16. Defining and Managing Processing Rules

If you select… Specify…

webMethods No additional information is required. Trading Networks sends 
Administrator the e‐mail message to the webMethods administrator.
Before you select webMethods Administrator, assure the e‐mail 
address for the webMethods administrator is defined. Do this 
using the Server Administrator. Follow the steps specified in the 
“Prerequisites” section above, on page 361. However, in Step 4, in 
addition to specifying the SMTP server, assure an e‐mail address is 
specified for Internal Email field. If an e‐mail address is not 
specified, specify it.
If the webMethods administrator is not defined, Trading 
Networks will be unable to send the e‐mail message. In this 
situation, Trading Networks logs the error to its activity log and 
continues with the other actions you specified in the processing 
rule, if any.
E-mail Address The e‐mail address of the recipient that is to receive the e‐mail 
message.
If the e‐mail address you specify is not valid, Trading Networks 
will be unable to send the e‐mail message. In this situation, 
Trading Networks logs the error to its activity log and continues 
with the other actions you specified in the processing rule, if any.

Subject of the E-mail Message

You can type any subject line for the e‐mail message. There are no restrictions to the 
length or characters that you can use.

Body of the E-mail Message

You can type any message for the body of the e‐mail message. There are no restrictions to 
the length or characters that you can use. 
To make the body dynamic, you can include information from the pipeline in the body. 
To include information from the pipeline, use output template tags. 
For example, you might want the e‐mail message to specify the type of document that was 
received and from whom it was received. You might also want to include a hyperlink that 
allows the recipient of the e‐mail message to view the document. The following shows the 

webMethods Trading Networks Administrator’s Guide Version 7.1 363

 16. Defining and Managing Processing Rules

text you might specify for the body. (For illustrative purposes, bold text is used for the 
output template tags.)

If the TN document type is “Purchase Order”, the senderʹs corporation name is 
“Industrial Steel Company”, and the organizational unit is “Alloys Division”, the 
following shows how the above sample e‐mail message body would be rendered:

Trading Networks received a Purchase Order document from Industrial

Steel Company--Alloys Division.

You can view the document at

http://wMTN:5555/invoke/wm.tn.doc/view?docId=000233AB907ED1234

When Trading Networks executes the Alert E-mail action, the pipeline contains the 
information described in “Action 1—Execute a Service” on page 354. In addition, if the 
processing rule specifies the Execute a service action and the service is executed 
synchronously, the pipeline also contains any information that the service placed in the 
pipeline.
For details about the output template tags that you can use, see the Dynamic Server Pages 
and Output Templates Developer’s Guide manual.

webMethods Trading Networks Administrator’s Guide Version 7.1 364

 16. Defining and Managing Processing Rules

Action 3—Change User Status

Use the User Status action to change the user status that is associated with a document. The 
user status is a status that you can associate with a document. The TN document type can 
be defined to extract a user status from the document, which gives the user status an 
initial value. 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, the initial 
value of user status is null.
When you use this processing rule action, you specify the status that you want Trading 
Networks to associate with the document. You can specify 1‐255 characters for the user 
status. There is no restriction to the characters you can use for user status.
The User Status action is useful to assign a status to a document that you will use when 
performing document queries or generating reports. For example, you might require that 
purchase orders be approved. In this case, 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”. To determine the purchase orders that are waiting for approval, you can query 
documents searching for documents with the user status “pending approval”.

Action 4—Deliver the Document to the Receiver

When a processing rule includes the Deliver Document By processing action, webMethods 
Trading Networks (Trading Networks) attempts to deliver a document to the receiver that 
is identified in the document. In the processing rule, you can specify one of four ways to 
deliver a document—immediate delivery, scheduled delivery, queued for polling, or 
preferred protocol. 
If you select preferred protocol, Trading Networks looks up the receiver’s profile and uses 
the delivery method that is identified as that partner’s preferred delivery method. This 
preferred delivery method can be an immediate delivery or queued for polling.

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, 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. If the service does not update the receiver, Trading Networks delivers the 
document to the receiver identified when it initially received the document for 
processing.

The following lists the prerequisite to using the Deliver Document By action.

webMethods Trading Networks Administrator’s Guide Version 7.1 365

 16. Defining and Managing Processing Rules

Prerequisite
To use the Deliver Document By action, the TN document type must indicate that Trading 
Networks is to extract the ReceiverID system attribute from the document. Trading 
Networks uses the receiver information to determine the partner to which to deliver 
the document.

For more information about 

Delivery methods in Trading Networks, see Chapter 6, ʺDelivering Documents to 
Partnersʺ in the webMethods Trading Networks Concepts Guide.
Delivery information on the partner’s profile, see “Delivery Settings” on page 118.

Immediate Delivery
When the Deliver Document By processing action indicates Immediate Delivery, Trading 
Networks attempts to deliver a document directly to the receiving partner. Trading 
Networks comes with the following immediate delivery methods:

Primary E-mail Secondary E-mail

Primary FTP Secondary FTP

Primary FTPS Secondary FTPS

Primary HTTP Secondary HTTP

Primary HTTPS Secondary HTTPS

Each immediate delivery method (Primary HTTP, Secondary HTTP, etc.) that Trading 
Networks provides is associated with a built‐in immediate delivery service that Trading 
Networks provides. An immediate delivery service is a service that acts on a single 
document to delivery the document to a single partner. Trading Networks invokes the 
delivery service to deliver a document to a trading partner. In addition to the above 
delivery methods, you can create immediate delivery services and register them with 
Trading Networks to define your own custom immediate delivery methods. 

For more information about 

Immediate delivery methods, see Chapter 6, ʺDelivering Documents to Partnersʺ in 
the webMethods Trading Networks Concepts Guide.
Immediate delivery services, see “What is an Immediate Delivery Service?” on 
page 422.

webMethods Trading Networks Administrator’s Guide Version 7.1 366

 16. Defining and Managing Processing Rules

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, 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. To keep track of the attempts to deliver a document, 
Trading Networks establishes a delivery task.

Note: You can also use reliable delivery by invoking the built‐in service, wm.tn.delivery:deliver.

The following table lists the reliable delivery settings that you define in the Delivery Method 
tab of the partner’s profile. When using reliable delivery with an immediate delivery 
method, Trading Networks uses these settings to establish the parameters for the delivery 
task that governs the delivery of the document. 

Reliable Delivery
Setting Description
Delivery Maximum The number of times you want Trading Networks to attempt to 
Retries redeliver a document.
Wait Between The number of milliseconds (ms) you want Trading Networks to 
Retries wait before making its first attempt to redeliver the document. 
(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.)
Retry Factor 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. Trading Networks calculates the time to wait by 
multiplying the last wait time by the value you specify for Retry
Factor. 

For more information about 

Delivery options, see Chapter 6, ʺDelivering Documents to Partnersʺ in the 
webMethods Trading Networks Concepts Guide.
Delivery tasks, see the webMethods Trading Networks User’s Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 367

 16. Defining and Managing Processing Rules

Scheduled Delivery
When the Deliver Document By processing action indicates scheduled delivery, Trading 
Networks batches documents that are then delivered at scheduled times. Trading 
Networks also creates the delivery task for the document and places the delivery task in 
the queue specified by the processing rule. 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. It is a set of rows in the Trading 
Networks database. Each queued delivery task that is associated with a document is a row 
in the same table of the Trading Networks database.

For scheduled delivery, Trading Networks supports two types of queues—public queues 
and private queues. You can select to use a public queue or to use a specific partner’s 
private queue. 

Note: If you select Receiver’s Queue, Trading Networks looks up a queue in the receiver’s 

profile. If the receiver’s profile does not contain a queued delivery method (i.e., does not 
define a queue), then Trading Networks will be unable to deliver the document by this 
method and instead, Trading Networks makes the document pollable (Queue for polling).

Once you select a queue for the scheduled delivery method, 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.

For more information about 

Scheduled delivery, see Chapter 6, ʺDelivering Documents to Partnersʺ in the 
webMethods Trading Networks Concepts Guide.
Public/Private queues and scheduled delivery, see “About Scheduled Delivery 
Queues” on page 404.

Using Reliable Delivery with Scheduled Delivery

Trading Networks automatically uses reliable delivery for a scheduled delivery method. 
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. To 
specify how many times Trading Networks attempts to re‐deliver a document that is 
scheduled for delivery, you define reliable delivery settings in the profile for each of your 
partners. To keep track of the attempts to deliver a document, Trading Networks 
establishes a delivery task.

Note: You can also use reliable delivery by invoking the built‐in service, wm.tn.delivery:deliver.

webMethods Trading Networks Administrator’s Guide Version 7.1 368

 16. Defining and Managing Processing Rules

When using reliable delivery with a scheduled delivery method, Trading Networks only 
uses only the following reliable delivery setting that you define in the Delivery Method tab 
of the partner’s profile.

Reliable Delivery Setting Description

Delivery Maximum Retries The number of times you want Trading Networks to attempt 
to redeliver a document.

Unlike for the immediate delivery method, 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.

For more information about 

Delivery information on the partner’s profile, see “Delivery Settings” on page 118.

“Scheduled Delivery Queue States” on page 408

Scheduled delivery services, see “What is a Scheduled Delivery Service?” on 
page 422.
Customized delivery services, see “Adding and Registering New Delivery 
Services” on page 433.
Delivery tasks, see the webMethods Trading Networks User’s Guide.

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 example, 
Secondary HTTPS is specified but the profile does not contain a Secondary HTTPS 
delivery method. Or, another example is that if the scheduled delivery method is 
Receiver’s Queue, but the receiving partner’s profile does not contain a queued delivery 
method (i.e., does not define a queue), then Trading Networks makes the document 
pollable (Queue for polling).
When Trading Networks queues the document for polling, it places the document in an 
internally‐defined queue. Trading Networks does not deliver the documents that are in 
this queue. Instead, Trading Networks waits for a partner to poll for the documents. 
When a specific partner polls for documents, Trading Networks returns all the documents 
in the queue for which that partner is the receiver.

webMethods Trading Networks Administrator’s Guide Version 7.1 369

 16. Defining and Managing Processing Rules

The receiving partners define the protocol (e.g., HTTP) to use to poll for the document and 
how frequently to poll for documents.

For more information about 

Delivery options, see Chapter 6, ʺDelivering Documents to Partnersʺ in the 
webMethods Trading Networks Concepts Guide.
Queue for polling, see “Defining Queue for Polling” on page 417.

Preferred Protocol
If you select Receiver’s Preferred Protocol, Trading Networks looks up the receiver’s profile 
and uses the delivery method that is identified as that partner’s preferred delivery 
method. This preferred delivery method can be an immediate delivery or queued for 
polling.
In addition to the above delivery methods, you can create customized delivery services 
and register them with Trading Networks to define your own custom delivery methods.

For more information about 

Partner’s preferred delivery method, see “Delivery Settings” on page 118.

Customized delivery services, see “Adding and Registering New Delivery 
Services” on page 433.

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.
When you use the Respond With action, you must specify the message you want Trading 
Networks to return and the content type of the message.

Specifying the Message

You can type any message. There are no restrictions to the length or characters that you 
can use. To make the body dynamic, you can include information from the pipeline in the 
body. To include information from the pipeline, use output template tags. For details 
about the output template tags that you can use, see the Dynamic Server Pages and Output 
Templates Developer’s Guide manual.
The pipeline contains the information described in “Action 1—Execute a Service” on 
page 354 of this user’s guide. In addition, if the processing rule specifies the Execute a
service action and the service is executed synchronously, the pipeline also contains any 
information that the service placed in the pipeline.

webMethods Trading Networks Administrator’s Guide Version 7.1 370

 16. Defining and Managing Processing Rules

An example of using the Respond With action would be to send an acknowledgement for a 
purchase order. 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, for example, interfacing with a 
back‐end system. This action returns the confirmation that the purchase order was 
received and processed.
The Respond With action could return an acknowledgement that just indicates that the 
purchase order was received. The message you specify is the acknowledgement that 
is returned.

Specifying the Content Type

In addition to specifying the message, you must indicate the content type of the message. 
For example, if the message is an XML document, specify the content type, text/xml, or if 
the message is in plain text, specify the content‐type text/plain.

Defining Processing Rules

Use this procedure to define a processing rule on the Processing Rule Details screen.

Note: If you are working in a clustered environment, all Trading Networks servers must be 
set up for cluster synchronization. That is, the servers must set the 
tn.cluster.sync.remoteAliases property correctly. For more information about how to configure 
Trading Networks for a clustered environment, see “Shared Trading Networks Database 
in a Clustered Environment”.

webMethods Trading Networks Administrator’s Guide Version 7.1 371

 16. Defining and Managing Processing Rules

To define a processing rule

1 In Trading Networks Console: View > Processing Rules.

2 Perform one of the following procedures to add a new processing rule. 

Method to start a processing rule Procedures

Add — To add a new  1) Click the row where you want to add the 

processing rule in a specific  new processing rule.
order relative to a selected 
2) Select Rules > Add and then one of the 
processing rule.
following:
For more information about 
a Above— Add a new processing rule 
adding processing rules, see 
above the highlighted processing rule. 
“Adding Processing Rules 
and the Order of Processing  b Below— Add a new processing rule 
Rules” on page 337 below the highlighted processing rule.
c Last—Add a new processing rule to the 
bottom of the full unfiltered processing 
rules list. All other processing rules 
keep their original ordinal numbers.

Note:  Make sure you place the Default processing 
rule in the last position in the filter processing 
rules list. For more information about the 
default processing rule, see “Setting Up a 
Default Processing Rule” on page 386

3) Trading Networks displays a blank 
Processing Rule Details screen for you to 
complete.
Duplicate— Add a new  1) Click the row containing the processing 
processing rule that is a  rule that you want to duplicate.
duplicate of an existing one. 
Trading Networks adds the 
new rule to the bottom of the 
processing rules list.
You can update any or all  2) Select Rules > Duplicate.
fields from the duplicated 
Trading Networks copies the processing 
processing rule.
rule fields with values from the processing 
rule that you duplicate.

webMethods Trading Networks Administrator’s Guide Version 7.1 372

 16. Defining and Managing Processing Rules

3 On the Processing Rule Details screen, specify the name you want to give the 
processing rule in the Name field. Specify 1‐64 characters. There is no restriction to the 
characters that you can use.
4 If you do not want this processing rule to be enabled, deselect the default Enabled 
field.
5 Optionally, specify a description for the processing rule in the Description field. Specify 
1‐255 characters. There is no restriction to the characters that you can use.
6 Click the Criteria tab and fill in the fields to identify documents that should be 
processed using 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. For more information, see “Processing Rule Criteria” on 
page 341.

For this Criteria tab

parameter… Specify…

Sender The sender(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 sender.
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. Trading Networks lists the name 
of the Enterprise profile in parentheses.
Unknown to use this rule for documents for which the 
sending partner is not known.
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. 
To specify a partner profile:

a Click the  Select Profile(s) button. 

b Select a partner profile from the Partner Selection 
Dialog. You can select multiple partners using the 
<Shift> and <Ctrl> keys. For more information about the 
Select Profile(s)... button, see “Selecting a Partner” on 
page 37.
c Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 373

 16. Defining and Managing Processing Rules

For this Criteria tab

parameter… Specify…

To specify a partner profile group:

a Click the  Select Profile Group(s) button. 

b Select a partner profile group from the Partner Groups 
Dialog. You can select multiple partner profile groups 
using the <Shift> and <Ctrl> keys. For more information 
about the Select Profile Group(s)... button, see “Selecting 
a Partner” on page 37.
c Click OK.
For more information about these processing rules fields, see 
“Sender and Receiver Criteria” on page 341.
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.
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. Trading Networks lists the name 
of the Enterprise profile in parentheses.
Unknown to use this rule for documents for which the 
receiving partner is not known.
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. 
To specify a partner profile:

a Click the  Select Profile(s) button. 

b Select a partner profile from the Partner Selection 
Dialog.You can select multiple partners using the 
<Shift> and <Ctrl> keys. For more information about the 
Select Profile(s)... button, see “Selecting a Partner” on 
page 37.
c Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 374

 16. Defining and Managing Processing Rules

For this Criteria tab

parameter… Specify…

To specify a partner profile group:

a Click the  Select Profile Group(s) button. 

b Select a partner profile group from the Partner Groups 
Dialog. You can select multiple partner profile groups 
using the <Shift> and <Ctrl> keys. For more information 
about the Select Profile Group(s)... button, see “Selecting 
a Partner” on page 37.
c Click OK.
For more information about these processing rules fields, see 
“Sender and Receiver Criteria” on page 341.
Document Type The TN document type(s) of 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 TN 
document type.
Unknown to use this rule for documents with unknown TN 
document types.
Selected to use this rule for documents with the specified 
TN document types. To specify TN document types:

a Click the  Select Document Type button. 

b Select the row containing the TN XML document type 
or TN flat file document type that you want from the 
Document Type Selection Dialog. You can select 
multiple partners using the <Shift> and <Ctrl> keys. For 
more information about using this button, see 
“Selecting TN Document Types” on page 38.
c Click OK.
For more information about these fields, see “Document Type 
Criterion” on page 343
User Status The user status of the documents that you want to process 
using this rule. Select one of the following:
Any to use this rule for documents regardless of the user 
status.

webMethods Trading Networks Administrator’s Guide Version 7.1 375

 16. Defining and Managing Processing Rules

For this Criteria tab

parameter… Specify…

Specified to use this rule for documents with the specified 
user statuses. Type each user status you want to allow on a 
separate row in the table. To add a user status to the table, 

click   Add New to add a row; then, type the user status. 

To remove a user status from the table, delete the row 

containing the user status by clicking   Delete Selected.

For more information about these fields, see “User Status 
Criterion” on page 343.
Recognition Errors Whether the documents that you want to process using this 
rule contain errors. Select one of the following from the list:
May have errors to use this rule for documents regardless of 
whether the document contains errors.
Has no errors to use this rule for documents that do not 
contain errors.
Has errors to use this rule for documents that contain 
errors.
For more information about these fields, see “Document 
Recognition Errors Criterion” on page 345

7 Click the Extended Criteria tab to specify custom attributes that you want Trading 
Networks to use as criteria for matching processing rules. 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 each custom attribute that you want to use, specify the following Content Criteria:

For this Extended Criteria tab

parameter… Specify…

Attribute The custom attribute that you want Trading Networks 
to use to select documents. Select an attribute from the 
list.
Operator The operator you want Trading Networks to use with 
the value you specify. For example, select Equal if you 
want Trading Networks to match documents that 
have the exact value you specify for Value.

webMethods Trading Networks Administrator’s Guide Version 7.1 376

 16. Defining and Managing Processing Rules

For this Extended Criteria tab

parameter… Specify…

Value Specify the value you want Trading Networks to use 
when matching documents to the processing rule.
To specify a string, type the characters in the 
string. Be sure to use the exact combination of 
upper‐ and lowercase letters because Trading 
Networks performs a case‐sensitive match. 
To specify a number, type the numeric value.
To specify a date and time, either type in the date 

and time or click   to open a dialog that allows 
you to select the date from a calendar. (Trading 
Networks uses the current time.) If you type a 
date and time, use the format yyyy-mm-dd hh:mm:ss. 
(Use a 24‐hour clock for the hour field, hh.). For 
example, if you want to specify the date/time 
August 29, 2001 at 2:30 pm, specify 2001-08-29
14:30:00. 

You do not need to specify a value if you select is null 
or is not null for Operator

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. By default, Trading Networks checks all pre‐processing 
actions. 
For more information about pre‐processing actions for XML documents, see 
“Specifying Pre‐Processing Actions for TN XML Document Type” on page 256. For 
more information about pre‐processing actions for flat file documents, see “Pre‐
Processing Actions in the TN Flat File Document Type” on page 319.

webMethods Trading Networks Administrator’s Guide Version 7.1 377

 16. Defining and Managing Processing Rules

For this Pre-Processing

tab parameter… Specify…

Verify Digital Signature  Whether you want Trading Networks to verify the digital 

signatures of documents. 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.
Verify digital signature to always verify digital signatures 
or digitally sign documents that Trading Networks 
processes with this processing rule.
Do not verify digital signature to never verify digital 
signatures or digitally sign documents that Trading 
Networks processes with this processing rule.
Validate Structure Whether you want Trading Networks to validate the 
structure of 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.
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.
Check for Duplicate Whether you want Trading Networks to determine 
Document whether it already received the document. 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.
Use built-in services to check for duplicate document of 
XML or flat file documents against a Trading 
Networks built‐in service.
If you select Use built-in services to check for duplicate
document, select whether you Trading Networks 
should use the: Document ID only; both the Document ID
and sender; the Document ID, sender and receiver; or the 
Document ID, sender and document type.

webMethods Trading Networks Administrator’s Guide Version 7.1 378

 16. Defining and Managing Processing Rules

For this Pre-Processing

tab parameter… Specify…

Use custom services to check for duplicate document 

against a custom duplicate checking service.
To create a new custom duplicate service, click 

 New service.

To select an existing duplicate service, click  
Find Service to browse the IS namespace to locate 
the one you want to use. Click the Edit Service 
button if you want to modify the service.
To edit an existing custom duplicate service, click 
on the Edit Service button.
For more information about creating a duplicate 
checking service, “Creating a Duplicate Document 
Check Service” on page 352.
Do not check for duplicate document to never check the 
uniqueness of the documents that Trading Networks 
processes with this 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.

Save Document to Whether you want Trading Networks to save a copy of 

Database document content to the database. 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 379

 16. Defining and Managing Processing Rules

For this Pre-Processing

tab parameter… Specify…

Save to always save a copy of the document contents, 
attributes, and/or activity log information that 
Trading Networks processes with this processing rule. 
If you select Save, select whether you want to save the 
document only if it is unique. Select one of the 
following: 
all documents—to save the selected information for 
all documents regardless of whether they are 
unique.
only unique documents—to save the selected 
information for documents only if they are 
unique.
Select the information you want to save to the 
database by specifying the following:
Content—to save the content of the document.
Attributes—to save the custom attributes of the 
document.
Activity Log—to save activity log criteria relative to 
the document.
When you select the Save option, Trading Networks 
displays the above three items (Content, Attributes, and 
Activity Log) by default.
Do not save to never save the document content and 
attributes of the documents that Trading Networks 
processes with the processing rule.

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.g., if you want to deliver 
a document via a queue), Trading Networks will bypass 
reliable delivery and invoke the specified delivery service 
once.

webMethods Trading Networks Administrator’s Guide Version 7.1 380

 16. Defining and Managing 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. To disable a 
processing rule action, deselect the appropriate check box in the Enable column on the 
left.
When you select a processing rule action, Trading Networks displays the 
corresponding panel for each action on the right side of the screen. Complete your 
selections for each processing rule action as explained below.

Important! If you select more than one action, Trading Networks performs the actions in 
the order they are listed on the Processing Rules screen. For example, if you select to 
execute a service, send an alert e‐mail message, and deliver the document to the 
receiver, Trading Networks performs the actions in that specific order. For more 
information, see “Processing Rule Actions” on page 353.

Execute a service. Specify the service you want Trading Networks to invoke for the 
document and how you want Trading Networks to invoke the service. Optionally, 
you can also hardcode input parameters for the service.
For more information about the Execute a service processing rule action, 
see“Action 1—Execute a Service” on page 354. If you are using large document 
processing, see “Creating Services that Recognize Large Document Handling” on 
page 530.

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, click   Find Service to browse the services 

and select the one you want to use. 

To create a new service, click   New Service (folder with yellow 

highlight) to open the Developer to create the service. For more 
information about creating services, see the webMethods Developer 
User’s Guide.
b Specify how to invoke the service:
To invoke the service synchronously, select synchronous. 
To invoke the service asynchronously, select asynchronous. 
To invoke the service asynchronously and use a service execution task, 
select service execution task.

webMethods Trading Networks Administrator’s Guide Version 7.1 381

 16. Defining and Managing Processing Rules

c To set inputs for the service, click Set Inputs. Trading Networks displays the 
input parameters for the service. Type in values for the parameters you 
want to hardcode an input value. After specifying inputs, click OK.
d If you need to update the service, click Edit Service. Trading Networks 
opens the Developer from which you can update the service.

Alert E-mail—Compose an e‐mail message to send to a specified contact. Specify 
the recipient, subject line, and body of the e‐mail message in the To, Subject, and 
Body fields, respectively. 
For more information about the Alert E-mail processing rule action, see “Action 2—
Send an Alert E‐mail” on page 361.

For this Alert

e-mail field… Specify...

To One of the following addresses:
webMethods Administrator to send the e‐mail to the 
webMethods administrator.
Sender to send the e‐mail to a sender contact. Then, select the 
contact type from the list.
Receiver to send the e‐mail to a receiver contact. Then, select 
the contact type from the list.
E-mail address to specify a specific address. Then, specify the 
e‐mail address.
For more information on these fields, see “Recipient of the 
E‐mail Message” on page 362.
Subject Type a character string for the subject of your e‐mail. There are 
no limits to the length or the characters you can specify.
Body Type a character string for the body of your e‐mail. There are no 
limits to the length or the characters you can specify. You can 
include output template tags to create a dynamic message. 
To use a larger input window to specify the body, click Expand.
For more information on this field, see “Body of the E‐mail 
Message” on page 363.

webMethods Trading Networks Administrator’s Guide Version 7.1 382

 16. Defining and Managing Processing Rules

Change User Status—Specify the user status you want to associate with the 

document. In the Change to field, specify a character string containing 1‐255 
characters. There is no restriction on the characters you can use. 
For more information about the User Status processing rule action, see “Defining a 
Processing Rule Based on a Saved Document” on page 385.
Deliver Document By—Specify the delivery method you want to use to deliver the 
document. 
For more information about the Deliver Document By processing rule action, see 
“Action 4—Deliver the Document to the Receiver” on page 365

Select this Deliver

Document By
field… For...

Queue for polling Trading Networks queues a document for polling. For 

more information, see “Defining Queue for Polling” on 
page 417.
Receiver’s The delivery method that is identified as the receiving 
Preferred Protocol partner’s preferred delivery method. This preferred 
delivery method can be an immediate delivery or queued 
for polling.
Immediate Delivery Specify an immediate delivery method from the list.
For more information, see “Immediate Delivery” on 
page 366.
Scheduled Delivery Specify the scheduled delivery queue to use from the list. 
Scheduled Delivery indicates that documents matching the 
processing rule will not be delivered immediately, but will 
be queued and delivered later by scheduled delivery.
The scheduled delivery queue can be a public or private 
queue (Receiver’s queue). Select the public queue from the 
list of registered public queues. Select Receiver’s queue to 
place documents that match this processing rule in the 
receiving partner’s selected queue. The next time Trading 
Networks runs a scheduled delivery service and reads 
documents from the specified queue, all documents in that 
queue will be delivered.

webMethods Trading Networks Administrator’s Guide Version 7.1 383

 16. Defining and Managing Processing Rules

Select this Deliver

Document By
field… For...

For more information about queues and scheduled 
delivery, see “Scheduled Delivery” on page 368 and 
“About Scheduled Delivery Queues” on page 404. 

Important! If you select the Scheduled Delivery processing 

action, you must use the Save Document to Database pre‐
processing action. If you do not save the document, 
Trading Networks maintains no information about this 
document after it processes the document.

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, see 
“Action 5—Respond With a Message” on page 370.

For this Respond

With field… Type…

Content type The content type of the message in the Content type field. For 

example, if the message is and XML document, type 
“text/xml”.
Message The message in the Message field. Specify a character string. 
There are no limits to the length or the characters you can 
specify. You can include output template tags to create a 
dynamic message. 
To use a larger input window to specify the message, click 
Expand. 

10 Click OK. Trading Networks closes the Processing Rule Details screen, and saves all 
changes you have made to processing rules. This includes saving all new rules you 
added, rules you changed, rules you disabled or enabled, and all changes you made 
to the order of the rules. 

webMethods Trading Networks Administrator’s Guide Version 7.1 384

 16. Defining and Managing 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. When Trading Networks creates the 
processing rule, it sets the criteria, extended criteria, pre‐processing actions, and actions as 
follows:

Processing Rule
Tab How Trading Networks Defines the Information on the Tab
Criteria Trading Networks sets the processing rule criteria as follows:
Sender criterion—Set to the sender that is associated with the 
document; that is, either the sender identified within a 
document or unknown.
Receiver criterion—Set to the receiver that is associated with 
the document; that is, either the receiver identified within a 
document or unknown.
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.
User status criterion—Set to the value of the user status that is 
associated with the document, if any.
Extended Criteria Trading Networks does not set any extended criteria.
Pre-Processing Trading Networks sets the pre‐processing actions as follows:
Verify digital signature—Set to always verify the digital 
signature of the document.
Validate structure—Set to always validate the structure of the 
document.
Check for duplicate document—Set to use the setting in the 
TN document type for the duplicate check pre‐processing 
action.
Save document to database—Set to always save a copy of the 
document content, attribute, and/or activity log information.
Action Trading Networks sets the processing action to ignore the 
document.

You can make any changes to the criteria, extended criteria, pre‐processing actions, or 
processing actions.

webMethods Trading Networks Administrator’s Guide Version 7.1 385

 16. Defining and Managing Processing Rules

To define a processing rule based on a saved document

1 From Trading Networks Console, use the Transaction Analysis screen to display the 
sample document that you want to use. Select View > Transaction Analysis.
2 Click the row containing the document that you want to view.
3 Select Transactions > Create Processing Rule.
4 To change the criteria, select the Criteria tab; then, update the settings as you want. For 
information about how to update the settings, see step 6 on page 373.
5 To change the custom attribute (extended) criteria, select the Extended Criteria tab; then, 
update the settings as you want. For information about how to update the settings, 
see step 7 on page 376.
6 To change the pre‐processing actions, select the Pre-Processing tab; then, update the 
settings as you want. For information about how to update the settings, see step 8 on 
page 377.
7 To change the processing actions, select the Action tab; then, update the settings as you 
want. For information about how to update the settings, see step 9 on page 381.
8 Click OK. Trading Networks saves the processing rule and closes the Processing Rule 
Details screen.

Note: Trading Networks saves the new rule at the top of the list of processing rules. For 
instructions on how to move the processing rule to another position in the list, see 
“Ordering the Processing Rules” on page 387.

Setting Up a Default Processing Rule

Trading Networks is shipped with a default processing rule that has the name Default rule. 
The criteria of this processing rule matches a document that has any sender, any receiver, 
any TN document type, any user status, and may have errors. The default rule specifies 
no extended criteria. In other words, any document that Trading Networks receives will 
meet the criteria of the default processing rule.
The pre‐processing actions in the default processing rule indicate that Trading Networks 
should use the settings in the TN document type. The processing action is to change the 
user status of the document to “IGNORED”.
You can update the default processing rule to change any settings. You should not change 
the criteria. However, you might want to update the pre‐processing and processing 
actions. If you do update the default processing rule, make sure that it remains last in the 
full, unfiltered processing list. For more information about ordering processing rules, see 
“Processing Rules Order” on page 337.

webMethods Trading Networks Administrator’s Guide Version 7.1 386

 16. Defining and Managing Processing Rules

Use the following procedure to update and set up your default processing rule.

To update the default processing rule

1 In Trading Networks Console: View > Processing Rules.

2 Double‐click on the row for the default processing rule that is named Default rule. The 
default processing rule is listed last (on the bottom of the full unfiltered list).
3 To update the pre‐processing actions, click the Pre-Processing tab. Then, update the 
pre‐processing actions. For information about what you can specify, see step 8 on 
page 377.
4 To update the processing actions, click the Action tab. Then, update the processing 
actions. For information about what you can specify, see step 9 on page 381.
Note: If you do update the Default rule, make sure that it remains last in the full, 
unfiltered processing list.
5 Click OK. Trading Networks closes the Processing Rule Details screen and saves the 
changes to the processing rule.

Ordering the Processing Rules

The order in which you list your processing rules on the Processing Rules screen is 
important. For each document, Trading Networks matches document information against 
the criteria that is specified in a processing rule. Trading Networks matches documents 
against processing rules in the order the rules are listed on the Processing Rules screen. It 
uses the first processing rule that matches to process the document.
Because Trading Networks looks for processing rules in this order, you should keep rules 
with specific criteria before rules with general criteria. The default processing rule should 
always be last. For more information about how Trading Networks works with the order 
of processing rules, see “Processing Rules Order” on page 337.

Note: If you reorder processing rules, there is no “undo” function that will return the 
processing rules to their original order.

webMethods Trading Networks Administrator’s Guide Version 7.1 387

 16. Defining and Managing Processing Rules

Use the following procedure to order processing rules.

To order processing rules

1 In Trading Networks Console: View > Processing Rules.

2 To move a processing rule, click the rule you want to move. To move more than one 
contiguous block of rules at a time, you can highlight multiple processing rules using 
the <Shift> key.
Note: You can only move and reorder processing rules if their ordinals are contiguous.
3 Click Rules > Move > Select to select the processing rule (s) you want to move.
Note: f you reorder processing rules, there is no “undo” function that will return the 
processing rules to their original order.
4 Highlight the processing rule you want to move your selected rule in relation to.
5 Once you have highlighted the location, perform the following to move your selected 
processing rule: 

Click this... Inserts the selected processing rule...

Rules > Move > Above Above the highlighted rule

Rules > Move > Below Below the highlighted rule

Trading Networks reassigns the ordinal numbers for all affected processing rules.
Repeat this step until the processing rules are listed in the order you want. You can 
order the processing rules in any direction. The default processing rule should always 
be listed last. For more information, see “Processing Rules Order” on page 337.
If you want, you can test the order of your processing rules to assure you have them 
in the correct order. For more information, see “Testing the Order of Processing 
Rules” below.

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. If you find that Trading Networks is not 
using the correct processing rule, you can re‐order the rules.

webMethods Trading Networks Administrator’s Guide Version 7.1 388

 16. Defining and Managing Processing Rules

To test the processing rules, you must have sample documents available in your file 
system. To perform a test, you select the sample 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. The first highlighted processing rule in the list is the one Trading Networks would 
use to process the document.
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. 
This means Trading Networks does not highlight the disabled processing rules that the 
document would match. For more information about disabling processing rules, see 
“Disabling Processing Rules” on page 397.

Important! During the test, Trading Networks does not actually process the document. That 
is, Trading Networks does not perform any pre‐processing or processing actions on the 
document.

Perform the following procedure to test the order of your processing rules.

To test the order of processing rules

1 If the Processing Rules screen is not currently displayed, in Trading Networks 
Console, select View > Processing Rules.
2 Select Rules > Test. Trading Networks displays the Select Input Document dialog box.
3 From the Select Input Document dialog box, select the sample document you want to 
use for the test and click Open.
Trading Networks informs you of the number of matches for which the sample 
document information meets the processing rule criteria, and highlights the 
corresponding processing rules.

webMethods Trading Networks Administrator’s Guide Version 7.1 389

 16. Defining and Managing 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, including the ones 
available out‐of‐the box and the processing rules you have created.
The Processing Rules screen contains a table that displays the processing rules from your 
query results. You can select to display summary information or detailed information for 
each processing rule that is listed in the table.
To find a specific processing rule, query Trading Networks for the processing rule(s) in 
which you are interested. 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. 
If you plan to use the same query many times, you can save the query settings. When you 
want to use the same query again, you simply select that saved query. For more 
information about different query functions you can perform, see Chapter , “Running 
Queries in Trading Networks”.
To set up a query and display information for viewing processing rules, specify some or 
all of the following:
Basic search criteria

How to display Detail view information about selected processing rules.

Basic Search Criteria for Processing Rules

Use the Basic Criteria tab to search for processing rules. The basic search criteria includes 
most of the basic processing rule criteria, that is, the information found on the Criteria tab 
of the Processing Rules Details screen. 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

webMethods Trading Networks Administrator’s Guide Version 7.1 390

 16. Defining and Managing 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, it displays the filtered results of your processing rule query. Trading 
Networks displays the query results in the processing rules table, which lists the 
requested processing rules information.
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. Each column corresponds to basic information that Trading Networks 
maintains about a processing rule: ordinal number, processing rule name, sender, 
receiver, TN document types, user statuses, and if a processing rule is enabled.

Finding and Viewing Processing Rules

Use the following procedure to find and view processing rule(s).

To find and view a specific processing rule

1 In Trading Networks Console: View > Processing Rules.

Trading Networks displays the last query run on the Trading Networks Console.

2 Select   Run Query on the toolbar. Trading Networks displays the processing rules 

table.
3 Perform one of the following to view processing rule information from the table:
To see summary information for a processing rule:
With your cursor, single click on the selected row. 
Trading Networks displays corresponding summary information about the 
highlighted processing rule in a summary section below the processing rules 
table. The summary information contains: the processing rule name, description, 
and processing rule criteria for the selected processing rule.

webMethods Trading Networks Administrator’s Guide Version 7.1 391

 16. Defining and Managing Processing Rules

To see the detailed information for a specific processing rule:

a With your cursor, 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.
b On the Processing Rule Details screen, you can:
1 View the information. For more information about the tabs and fields 
on this screen, see “Defining Processing Rules” on page 371.
2 Edit the information. For more information on how to change the 
information on the Processing Rule Details screen, see “Updating 
Processing Rules” on page 397.

To change the display format of the processing rules table:

a Select   Show Query on the toolbar. Trading Networks displays the Basic

Criteria and Detail View tabs.
b Go to step 6 to change the table format using the Detail View tab.

4 If you cannot find the processing rule you are looking for, you can perform a more 

detailed query to refine the results on the processing rules table. Select   Show Query 

on the toolbar. Trading Networks displays the Basic Criteria and Detail View tabs.
5 To narrow down the list of processing rules from which to choose, select the Basic
Criteria tab and fill in the fields to specify basic search criteria. To indicate that you 
want to use one or more of the basic search criteria, select the check box next to each 
criterion you want to use. Then fill out the corresponding information as follows. 

webMethods Trading Networks Administrator’s Guide Version 7.1 392

 16. Defining and Managing Processing Rules

For this Basic

Criteria tab
parameter… Select the check box and specify…

Sender The sender of the processing rule you want to view. 
Optionally, select Perform Implicit Matching to implicitly 
expand the query results to reflect group membership of 
your selected sender(s).
For example, if you select a sender group (Group A), 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, where the 
processing rule sender was set to Any in the Criteria tab). 
For more information about the Criteria tab, see step 6 on 
page 373.
If you do not select this option, the query returns only those 
rules where the sender is Group A.
Similarly, 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, the query returns only those 
rules where the sender is Partner 1.

To specify one or more senders, click the  Select Profile(s) 

button or the  Select Profile Group(s) button. Select the 

individual sender(s) and/or sender group(s) from the Partner 
Selection Dialog or the Profile Group(s) Dialog. For more 
information about the Select Profile(s)... or the Select Profile
Group(s) button, see “Selecting a Partner” on page 37.

webMethods Trading Networks Administrator’s Guide Version 7.1 393

 16. Defining and Managing Processing Rules

For this Basic

Criteria tab
parameter… Select the check box and specify…

Receiver The receiver of the processing rule you want to view. 
Optionally, select Perform Implicit Matching to implicitly 
expand the query results to reflect group membership of 
your selected receiver(s). This option works the same way it 
works for sender queries.

To specify one or more receivers, click the  Select Profile(s) 

button or the  Select Profile Group(s) button. Select the 

individual receiver(s) and/or receiver group(s) from the 
Partner Selection Dialog or the Profile Group(s) Dialog. For 
more information about the Select Profile(s) or the Select Profile
Group(s) button, see “Selecting a Partner” on page 37.
Document Type The TN document type of the documents processed with this 
processing rule.
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. That is, where the 
processing rule TN document type was set to Any in the 
Criteria tab. For more information about the Criteria tab, see 
step 6 on page 373

To specify a TN document type, click the  Select Document
Type button. Select the TN document type from the 
Document Type Selection Dialog.
User Status The user status of the documents that processed by this 
processing rule. 

To specify a user status for the query, click   Add New; then, 

type the user status in the newly added row. 
To remove a user status from a query, select the row 
containing the user status you want to delete and then click 

 Delete Selected.

webMethods Trading Networks Administrator’s Guide Version 7.1 394

 16. Defining and Managing Processing Rules

For this Basic

Criteria tab
parameter… Select the check box and specify…

Rule Name The name of the processing rule. Type in a character string 

contained in the processing rule name.
You can use the pattern‐matching characters “%” in the 
processing rule name search. For example
Type this: To find:

%str Any string beginning with ʺstrʺ
str% Any string ending with ʺstrʺ
str%str Any string beginning and ending with ʺstrʺ
Last Modified The time Trading Networks last updated the processing rule 
Time either when the processing rule was created or last updated. 
Select an entry from the list. 
To specify a date range, select Custom from the list. Then specify 
dates in the Beginning and Ending fields. 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. 
The ordinal corresponds to the order placement where Trading 
Networks has assigned the rule you are searching for in the 
processing rules list.
You can specify an ordinal range by using the From and To fields 
to indicate the beginning and end of the range.

webMethods Trading Networks Administrator’s Guide Version 7.1 395

 16. Defining and Managing Processing Rules

6 Select the Detail View tab and fill in the fields to specify how Trading Networks 
displays information in the processing rules table.
a In the Display Column panel, 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 Ordinals and Rule Name columns. 
Trading Networks displays the Senders and Receivers columns by default.
b In the Search Order panel, select the search order that you want Trading Networks 
to follow when performing a query. To change the search order, use the up and 
down buttons. 

Select this... To do this...

Move a search criteria up, select the criteria you want to have 
precedence from the Search Order list and then click  .
Move a search criteria down, select the criteria you want to have 
precedence from the Search Order list and then click  .

For more information about the Detail view, see “Detail View of Processing Rules” on 
page 391.

7 Select  Run Query on the toolbar. Trading Networks displays the processing rules 

table with the results from the refined query.
8 Select the processing rule you want from the Processing Rules table on the bottom 
portion of the screen. 
For more information about the tabs and fields on this screen, see “Defining 
Processing Rules” on page 371.
For more information on how to change the information on the Processing Rule 
Details screen, see “Updating Processing Rules” on page 397.

Managing Processing Rules

The following tables lists the tasks you can perform against processing rules:

Task See page...

“Updating Processing Rules” 397
“Disabling Processing Rules” 397
“Enabling Processing Rules” 398
“Deleting Processing Rules” 398

webMethods Trading Networks Administrator’s Guide Version 7.1 396

 16. Defining and Managing Processing Rules

Updating Processing Rules

To update a processing rule, perform the following procedure.

To update a processing rule

1 In Trading Networks Console: View > Processing Rules.

2 Click the row containing the processing rule you want to update.
3 Select Rules > Edit.
4 To update the name, type a new name in the Name field. You can specify 1‐64 
characters. There is no restriction to the characters that you can use. 
5 To update the description, type a new description in the Description field. You can 
specify 1‐256 characters. There is no restriction to the characters that you can use. 
6 To update the criteria for the processing rule, click the Criteria tab. Then, update the 
fields. For information about what you can specify, see step 6 on page 373.
7 To update the extended criteria for the processing rule, click the Extended Criteria tab. 
Then, update the fields. For information about how to update the settings, see step 7 
on page 376.
8 To update the pre‐processing actions, click the Pre-Processing tab. Then, update the 
pre‐processing actions. For information about how to update the settings, see step 8 
on page 377.
9 To update the processing actions, click the Action tab. Then, update the processing 
actions. For information about how to update the settings, see step 9 on page 381.
10 Click OK. Trading Networks closes the Processing Rule Details screen and saves the 
changes to the processing rule.

Disabling Processing Rules

If you want Trading Networks to temporarily stop using a processing rule, you can 
disable it. When determining the processing rule to use for a document, Trading 
Networks does not match the document against processing rules that are disabled. 
When you want Trading Networks to use the processing rule again, you can enable it; see 
“Enabling Processing Rules” on page 398. If you no longer need the processing rule and 
want to permanently remove it, you can delete it; see “Deleting Processing Rules” on 
page 398.

To disable a processing rule

1 In Trading Networks Console: View > Processing Rules.

webMethods Trading Networks Administrator’s Guide Version 7.1 397

 16. Defining and Managing Processing Rules

2 Click the row containing the processing rule(s) you want to disable. 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.
3 Select Rules > Disable. Trading Networks places No in the Enabled column to indicate 
that the processing rule is disabled.

Enabling Processing Rules

If you disable a processing rule and then later determine that you want Trading Networks 
to use it again, you can enable it.

To enable a processing rule

1 In Trading Networks Console: View > Processing Rules.

2 Click the row containing the processing rule(s) you want to enable. 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.
3 Select Rules > Enable. Trading Networks places Yes in the Enabled column to indicate 
that the processing rule is enabled.

Deleting Processing Rules

If you no longer need a processing rule, you can delete it. This is an actual delete of the 
processing rule. The processing rule is not deactivated; it is removed from the Trading 
Networks system. You will not be able to recover it later.

To delete a processing rule

1 In Trading Networks Console: View > Processing Rules.

2 Select   Run Query on the toolbar. Trading Networks displays the processing rules 

table.
If you want to delete a processing rule that is currently disabled, make sure that 
disabled processing rules are visible on the processing rules table. To do so:

a Select   Show Query on the toolbar. Trading Networks displays the Basic Criteria 

and Detail View tabs.
b Select the Detail View tab.

webMethods Trading Networks Administrator’s Guide Version 7.1 398

 16. Defining and Managing Processing Rules

c In the Display Column panel, check the Enabled field so that Trading Networks 

includes it in the Detail view.

d Select   Run Query on the toolbar. Trading Networks updates the processing 

rules table. Now you can see the disabled processing rules (No in the Enabled 
column).
3 Click the row containing the processing rule(s) you want to delete. 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.

Important!  This is an actual delete of the processing rule. The processing rule is not 
deactivated; it is removed from the Trading Networks system. You will not be able to 
recover it later.

4 Select Rules > Delete. Trading Networks confirms that you want to delete the selected 

processing rule(s). Click Yes to delete.

webMethods Trading Networks Administrator’s Guide Version 7.1 399

 16. Defining and Managing Processing Rules

webMethods Trading Networks Administrator’s Guide Version 7.1 400

 Part IV. Setting Up Document Delivery

Chapter 17, “Defining and Managing Queues in Trading Networks”

Chapter 18, “Creating Delivery Services”

webMethods Trading Networks Administrator’s Guide Version 7.1 401

 IV. Setting Up Document Delivery

webMethods Trading Networks Administrator’s Guide Version 7.1 402

Chapter 17. Defining and Managing Queues in Trading
Networks

What is a Queue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404

About Scheduled Delivery Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404

Defining Private Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

Defining Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

Searching for Public Queues Using My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

Deleting Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

Changing the State of a Private Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

Changing the State of a Public Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

About Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

Defining Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

Viewing Documents that Are Queued for Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

Note: This chapter describes how to define and manage queues using My webMethods. 
The same functionality in the Trading Networks Console is deprecated. If you need 
instructions for using the Console to define and manage queues, see Appendix K, 
“Managing Queues Using the Console”. 

webMethods Trading Networks Administrator’s Guide Version 7.1 403

 17. Defining and Managing Queues in Trading Networks

What is a Queue?
A queue in Trading Networks is a grouping of outbound documents that can be delivered 
in batch. Note that a Trading Networks queue is not a queue in the traditional sense. 
Instead, it is a set of rows in the Trading Networks database. When documents are placed 
in a queue, Trading Networks does not deliver them immediately, rather, Trading 
Networks delivers them based on a schedule defined for the queue.
Trading Networks supports queues for two different purposes— scheduled delivery and 
polling.

For more information about delivery methods and queues, see Chapter 6, ʺDelivering 

Documents to Partnersʺ in the webMethods Trading Networks Concepts Guide.

About Scheduled Delivery Queues

A scheduled delivery queue is a queue for batching documents to be sent to the receiving 
partners at scheduled times. You define one or more queues that Trading Networks uses 
for scheduled delivery. 
A scheduled delivery queue does not contain documents. Instead, it contains delivery 
tasks that are associated with documents. All scheduled deliveries use reliable delivery. 
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 
partner’s profile. To use a scheduled delivery queue for a partner, you add the “Queue for 
delivery” delivery method and define the queue settings in the profile’s delivery settings.
To have Trading Networks deliver a document using scheduled delivery, you select the 
scheduled delivery method in the processing rules with the Deliver Document By processing 
action. 

For more information about 

Scheduled delivery and queues, see Chapter 6, ʺDelivering Documents to Partnersʺ 
in the webMethods Trading Networks Concepts Guide.
Delivery information on the partner’s profile, see “Delivery Settings” on page 118.

Scheduled delivery and the Deliver Document By processing action, see “Scheduled 

Delivery” on page 368.

As a result, when Trading Networks schedules a document for delivery, Trading 
Networks also creates a delivery task that maintains information about the delivery of the 
document. It is this delivery task that Trading Networks places in the queue. 
When you define a queue for scheduled delivery, you associate a delivery schedule and 
scheduled delivery service with the queue. The delivery schedule defines the times that 

webMethods Trading Networks Administrator’s Guide Version 7.1 404

 17. Defining and Managing Queues in Trading Networks

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.

For more information about 

Scheduled delivery services, see “What is a Scheduled Delivery Service?” on 
page 422.
Delivery tasks, see the webMethods Trading Networks User’s Guide.

Types of Scheduled Delivery Queues

Trading Networks supports two types of scheduled delivery queues—private and public.

Private Queues
A private queue is a queue that contains only delivery tasks that correspond to documents 
aimed for a specific receiving partner. You define private queues in the delivery settings of 
a partner’s profile. The queue will only contain delivery tasks that correspond to 
documents that are to be delivered to the partner defined by the profile.
For more information, see “Delivery Settings” on page 118 and refer to “Defining Private 
Queues” on page 410. 

Public Queues
A public queue is a queue that can contain delivery tasks that correspond to documents that 
are aimed for multiple receiving partners.
For more information, see “Defining Public Queues” on page 413.

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. When you define a scheduled delivery 
queue, you also associate a delivery schedule and a scheduled delivery service with 
the.queue. 
The delivery schedule defines the times that Trading Networks invokes the scheduled 
delivery service, which acts on the delivery tasks in the queue to deliver the 
corresponding batched documents. 

webMethods Trading Networks Administrator’s Guide Version 7.1 405

 17. Defining and Managing Queues in Trading Networks

The delivery service acts on the delivery tasks in the queue when and how often you 
specify:
Run Once. Trading Networks executes the delivery service a single time. For more 
information, see “Using the Run Once Option” on page 406.
Fixed Interval. Trading Networks executes the delivery service repeatedly at an 
interval you specify. For more information, see “Using the Fixed Interval Option” 
on page 407. 

Note: In the Console, this option is referred to as Simple Interval.

Custom Interval. 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. 
For more information, see “Using a Custom Interval Option” on page 407.

Important! Do not attempt to use the Server Administrator to change the schedule for a 
delivery service! If you do so, the data passed to the service will be lost and the service 
will be unable to deliver documents. Use the My webMethods to change the delivery 
schedule and other queue settings

 For more information about scheduled delivery services, see “What is a Scheduled 
Delivery Service?” on page 422.

Using the Run Once Option

When you schedule a queue delivery using the Run Once option, Trading Networks 
executes the delivery service one time on the date and at the time that you specify. At that 
time, Trading Networks uses the scheduled delivery service to act on all the delivery tasks 
in the queue. 
When using the Run Once option, delivery tasks can get “stuck” in the queue. If the 
scheduled delivery service fails to deliver documents associated with the delivery tasks in 
the queue, the delivery tasks remain in the queue. Also, once scheduled delivery service is 
invoked, Trading Networks does not act on new tasks added to the queue. These tasks 
will remain in the queue with a QUEUED status. Because the queue is set up to run the 
scheduled delivery service only one time, Trading Networks will not act on the QUEUED 
tasks again unless you update the queue schedule.
Trading Networks includes the Run Once option for use in a development environment.

Note: If the scheduled run‐time occurs when the server is not running, when you initialize 
server, the server throws an exception.

webMethods Trading Networks Administrator’s Guide Version 7.1 406

 17. Defining and Managing Queues in Trading Networks

Using the Fixed Interval Option

When you schedule a queue delivery using the Fixed Interval option, Trading Networks 
executes the delivery service for the first time immediately after you add the delivery task. 
Trading Networks continues to execute the delivery service at the interval you specify. 
For example, you might want Trading Networks to execute the delivery service every 24 
hours.
By default, when you schedule a delivery service to repeat, Trading Networks bases the 
repeat interval on when the task starts. For example, if you specify a repeat interval of 
3600 seconds, Trading Networks starts the task and schedules the next execution for 3600 
seconds after the previous execution began. 
There might 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. 
For example, suppose your delivery service is scheduled to run every minute, but 
sometimes takes longer than that to complete. By default, Trading Networks will start the 
next subsequent execution even though the previous one has not yet completed. To have 
Trading Networks wait for the service to complete before beginning its next scheduled 
execution, check the Do not overlap task box.
With the Fixed Interval option, there is no end date or time associated with a repeating 
delivery task. Trading Networks continues to execute the delivery service until you 
change the queue schedule. If you want to specify an end date or time, use a custom 
interval option, described below.

Note: In the Console this option is referred to as Simple Interval.

Using a Custom Interval Option

Using a custom interval option offers the greatest flexibility for specifying when you want 
Trading Networks to execute the delivery service for the queue. You can specify a date 
range for when you want Trading Networks to execute the delivery service. For example, 
you can define the date range so that the first run of the service is in the future. You can 
also specify that you do not want an end date, which indicates that Trading Networks will 
execute the delivery service indefinitely on the schedule you define.
After specifying a date range, you can specify whether you want the service to run hourly, 
daily, weekly, monthly, or yearly. 

webMethods Trading Networks Administrator’s Guide Version 7.1 407

 17. Defining and Managing Queues in Trading Networks

Scheduled Delivery Queue States

You can manage your scheduled delivery queues by enabling, disabling, draining, and 
suspending them. These actions change the state of the queue, 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. 

State Meaning
Enabled Trading Networks can place delivery tasks into 
IN Enabled OUT
the queue and can invoke the scheduled delivery 
service to deliver the documents that are 
associated with the delivery tasks in the queue.
Disabled Trading Networks cannot place delivery tasks 
X Disabled X into the queue or deliver documents that are 
associated with delivery tasks in the queue.
All delivery tasks that are in the queue when you 
disable it remain in the queue. If you enable or 
drain 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.
There are two reasons you might want to disable 
a queue. 1) If the delivery service is defective and 
you need to debug and fix it, 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.
When the Deliver Document By processing action of 
a processing rule specifies to use a queue that is 
disabled, the delivery fails because Trading 
Networks cannot place the delivery task in the 
queue. Trading Networks sets the delivery task 
status to FAILED and logs a message to the 
activity log.

webMethods Trading Networks Administrator’s Guide Version 7.1 408

 17. Defining and Managing Queues in Trading Networks

State Meaning
Draining Trading Networks cannot place delivery tasks 
X Draining OUT
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.
Drain a queue if you want to empty it, so you can 
delete it. You can also drain a queue to perform 
maintenance changes (e.g., change queue 
settings, update delivery services).
When the Deliver Document By processing action of 
a processing rule specifies to use a queue that is 
draining, the delivery fails because Trading 
Networks cannot place the delivery task in the 
queue. In this situation, Trading Networks sets 
the delivery task status to FAILED and logs a 
message to the activity log. 
Suspended Trading Networks can place delivery tasks into 
IN Suspended X the queue, but Trading Networks cannot deliver 
documents that are associated with delivery tasks 
that are in the queue.
You might suspend a queue if a trading partner 
indicates that it is temporarily unable to accept 
documents.
All delivery tasks that are in the queue when you 
suspend it remain in the queue. If you enable or 
drain 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 409

 17. Defining and Managing Queues in Trading Networks

Defining Private Queues

To define a private queue in a partner profile, perform the following procedure.

To define a private queue

1 Search for the profile for which you want to add a private queue. If you need 
procedures for this step, see “Searching for Partner Profiles” on page 168.

2 Click   Edit in the row for the partner profile for which you want to add a private 
queue.
3 Click the Delivery Settings tab.
4 In the DELIVERY METHODS panel, click Add Delivery Method.
5 From the Delivery Method list, select Queue for delivery.
6 Select Use Private Queue.
7 Click Edit.
8 From the Delivery Service field, select the delivery service to use with the private queue.
9 Click the Inputs tab and fill in the inputs to the delivery service. 
Select Include empty values for string types? if you want the input parameters to include 
fields that you leave blank. If you select this option and you leave a field blank, 
Trading Networks passes an empty string for the value. If you do not select this 
option and you leave a field blank, the field is not included in the inputs.
10 From the State list, select the state of the queue (Enable, Disable, Drain, or Suspend
Delivery). For a description of these states, see “Scheduled Delivery Queue States” on 
page 408.
11 Click the Schedule tab and from the Process Queue list, select how often (Run Once, Fixed
Interval, Hourly, Daily, Weekly, Monthly, or Yearly) that you want Trading Networks to 
invoke the delivery service to deliver documents in the queue.

webMethods Trading Networks Administrator’s Guide Version 7.1 410

 17. Defining and Managing Queues in Trading Networks

12 Based on your selection from the Process Queue list, fill in the associated fields.

If you select .. Specify...

Run Once In the Date and Time fields, specify the one time you want 

Trading Networks to execute the delivery service. For more 
information, see “Using the Run Once Option” on page 406.
Fixed Interval In the Interval fields, specify the interval of time you want 
Trading Networks to wait between executions of the delivery 
service. You can specify the interval in seconds, minutes, 
hours, days, or weeks.
If you want Trading Networks to wait for a delivery service to 
complete execution before it starts the next scheduled 
execution of the service, check Do not overlap task.
When you add or update a fixed interval schedule for a queue 
that is Enabled or Draining, Trading Networks invokes the 
service immediately. Subsequent invokes are governed by the 
interval. For more information, see “Using the Fixed Interval 
Option” on page 407
Hourly Specific times when you want Trading Networks to execute 
Daily the delivery service. 
Weekly
Use the DATE RANGE fields to specify the days when you want 
Monthly
Yearly Trading Networks to start and end executing the service. You 
can select:
A timeframe from the drop‐down list and Trading 
Networks will update the Start Date/Time and End Date/Time 
fields.
Custom from the drop‐down list and then update the Start
Date/Time and End Date/Time fields to specify your custom 
time frame.

webMethods Trading Networks Administrator’s Guide Version 7.1 411

 17. Defining and Managing Queues in Trading Networks

If you select .. Specify...

Select No end date if you want Trading Networks to execute the 

service for an indefinite period of time. If you specify an end 
date, Trading Networks executes the delivery service at the 
scheduled times until the end of the time period. All delivery 
tasks added to the queue after the end date are “stuck” in the 
queue. Trading Networks will not act on the queued tasks 
again unless you update the queue schedule.
In addition to the DATE RANGE fields, specify the following 
based on your selection:
Selection Description

Hourly Use the PROCESS QUEUE EVERY HOUR AT fields to 

select the minutes of the hour that you want 
Trading Networks to execute the service. 
If the execution of the delivery service is long 
running and runs into the next execution, you can 
specify that you want Trading Networks to wait for 
the service to complete before beginning its next 
execution by checking the Do not overlap task check 
box.
Daily Use the PROCESS QUEUE EVERY DAY AT THESE TIMES 
to indicate the hours and times of the day that you 
want Trading Networks to execute the service. 
Select the Do not overlap task check box to prevent 
execution of the service from overlapping.
Weekly Use the PROCESS QUEUE EVERY WEEK fields to 
specify the days of the week that you want Trading 
Networks to execute the service and the times on 
the selected days that you want the service 
executed.
Select the Do not overlap task check box to prevent 
execution of the service from overlapping.

webMethods Trading Networks Administrator’s Guide Version 7.1 412

 17. Defining and Managing Queues in Trading Networks

If you select .. Specify...

Monthly Use the PROCESS QUEUE EVERY MONTH fields to 

specify the days of the month that you want 
Trading Networks to execute the service and the 
times on the selected days that you want the service 
executed.
Select the Do not overlap task check box to prevent 
execution of the service from overlapping.
Yearly Use the Process Queue Every Year fields to specify 
the months, days of the month, and days of the 
week you want Trading Networks to execute the 
service and the times on the selected days that you 
want the service executed.
Select the Do not overlap task check box to prevent 
execution of the service from overlapping.

13 Click OK to close the Private Queue dialog box.
14 Click OK to close the ADD DELIVERY METHOD dialog box.
15 Click Save on the Partner Profile page.

Defining Public Queues

To add a public queue to Trading Networks, perform the following procedure.

To define a public queue

1 In My webMethods: Administration > Integration > B2B > Public Queues.

2 Click Add Queue.
Trading Networks displays the Public Queue Information panel.
3 In the Name field, specify a name for the queue. You can specify a string of up to 225 
alphanumeric characters. Trading Networks displays this name when listing available 
public queues.
4 From the Delivery Service field, select the delivery service to use with the public queue. 
Out‐of‐the‐box, Trading Networks provides a single scheduled delivery service, Batch
FTP (wm.tn.transport:batchFtp service), which uses FTP to deliver documents to a single 
destination. If you created a custom delivery service and registered them with 
Trading Networks, then you can associate your custom scheduled delivery services 
with the queues that you define. For more information about scheduled delivery 

webMethods Trading Networks Administrator’s Guide Version 7.1 413

 17. Defining and Managing Queues in Trading Networks

services, see “What is a Scheduled Delivery Service?” on page 422. For more 
information about custom delivery services, see “Adding and Registering New 
Delivery Services” on page 433.
5 In the State field, select the state of the queue (Enable, Disable, Drain, or Suspend Delivery). 
For a description of these states, see “Scheduled Delivery Queue States” on page 408.
6 Click the Inputs tab and fill in the inputs to the delivery service.
Select Include empty values for string types? if you want the input parameters to include 
fields that you leave blank. If you select this option and you leave a field blank, 
Trading Networks passes an empty string for the value. If you do not select this 
option and you leave a field blank, the field is not included in the inputs.
7 Click the Schedule tab and from the Process Queue list, select how often (Run Once, Fixed
Interval, Hourly, Daily, Weekly, Monthly, or Yearly) that you want Trading Networks to 
invoke the delivery service to deliver documents in the queue.
For additional instructions for how to complete the fields on the Schedule tab, see 
step 12 on page 411.
8 Click Save.

Searching for Public Queues Using My webMethods

The following table listsMy webMethods tasks related to searching for public queues and 
where to find more information about each task.

Task For more information, see...

Search for public with queue names that  “Performing a Keyword Search for 
contain keywords that you specify. Public Queues” on page 415
Set the following display options for how  Getting Started with My webMethods 
Trading Networks displays search results  guide
on the Administration > Integration > B2B > 
Public Queues page:
The number of rows that you want 
Trading Networks to display on each 
page of the search results
How the search results are sorted

The columns displayed and the order of 
the columns

webMethods Trading Networks Administrator’s Guide Version 7.1 414

 17. Defining and Managing Queues in Trading Networks

Task For more information, see...

Save searches for public queues. Getting Started with My webMethods 
guide
Re‐execute saved searches for public  Getting Started with My webMethods 
queues. guide

Performing a Keyword Search for Public Queues

Use a keyword search to find public queues based on the queue names. 

To perform a keyword search for public queues

1 In My webMethods: Administration > Integration > B2B > Public Queues.

2 Click the Keyword tab if it is not already displayed.
3 In the text box, type the keywords that are contained in the queue name.
If you leave the text box blank, Trading Networks searches for all queues that you are 
authorized to view. For more information about how to specify keywords, see the 
Getting Started with My webMethods guide.
4 Click Go to execute the search.

Deleting Public Queues

To delete a public queue to Trading Networks, perform the following procedure.

To delete a public queue

1 In My webMethods: Administration > Integration > B2B > Public Queues.

2 If the queue you want to delete is not listed, search for the queue you want to delete. 
For instructions, see “Searching for Public Queues Using My webMethods” on 
page 414.
3 Select the check boxes beside the names of the queues that you want to delete.
4 Click Delete.

webMethods Trading Networks Administrator’s Guide Version 7.1 415

 17. Defining and Managing Queues in Trading Networks

Changing the State of a Private Queue

To change the status of a private queue, perform the following procedure:

To change the state of a private queue

1 Search for the profile for which you want to add a private queue. If you need 
procedures for this step, see “Searching for Partner Profiles” on page 168.

2 Click   Edit in the row for the partner profile for which you want to add a private 
queue.
3 Click the Delivery Settings tab.

4 Click   Edit in the row for the Queue for delivery delivery method.

If this delivery method is using a private queue, the Use Private Queue check box is 
selected in the EDIT ‐ QUEUE FOR DELIVERY dialog box.
5 Click Edit.
6 For State, select the queue state you want: Enable, Disable, Drain, or Suspend Delivery.
7 Click OK to close the Private Queue dialog box.
8 Click OK to close the EDIT ‐ QUEUE FOR DELIVERY dialog box.
9 Click Save to save the changes to the profile.

Changing the State of a Public Queue

To change the state of a public queue, perform the following procedure:

To change the queue state of a public queue

1 In My webMethods: Administration > Integration > B2B > Public Queues.

2 If the queue you want to update is not listed, search for the queue you want to delete. 
For instructions, see “Searching for Public Queues Using My webMethods” on 
page 414.

3 Click   Edit in the row containing the public queue that you want to update.
4 For State, select the queue state you want: Enable, Disable, Drain, or Suspend Delivery.
5 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 416

 17. Defining and Managing Queues in Trading Networks

About Queue for Polling

The queue for polling is an internally‐defined queue that contains documents. Trading 
Networks does not deliver the documents in this queue. Instead, Trading Networks waits 
for a partner to poll for the documents. When a specific partner polls for documents, 
Trading Networks returns all documents in the queue for which the polling partner is the 
receiver. Trading Networks handles the management of the queue for polling. You cannot 
enable, disable, drain, or suspend this queue. This queue is always enabled.
Your trading partners that poll your system for documents determine the method (e.g., 
HTTP) to use when requesting documents in your queue and how frequently to poll your 
system for documents. 
You can define the polling method (e.g., 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. The polling 
method and polling frequency you use for a specific partner is defined in the delivery 
settings of the partner’s profile. For more information about the polling information in 
your partner’s profile, see “Delivery Settings” on page 118.

Defining Queue for Polling

You define queue for polling settings in delivery settings of partner profiles to indicate 
how your Trading Networks polls for documents in your partners’ systems. For each 
partner that you want to poll, you define the settings in that partner’s profile in the 
delivery settings.
To set up your Trading Networks system so it polls for documents on a partner’s system, 
perform the following

To define a queue for polling settings

1 Search for the profile you want to update; that is, the profile of the partner for which 
you want to define how your system will poll for documents in that partner’s system. 
If you need procedures for this step, see “Searching for Partner Profiles” on page 168.

2 Click   Edit in the row for the partner profile.
3 Click the Delivery Settings tab.

webMethods Trading Networks Administrator’s Guide Version 7.1 417

 17. Defining and Managing Queues in Trading Networks

4 In the SETTINGS panel, fill in the following queue for polling fields:

For this field... Specify...

Polling Method The method you want your Trading Networks system to use 

access the partner’s system to request queued documents.
Polling Frequency How often you want your Trading Networks system to poll 
your partner’s system for documents.

For more information about these settings, see “Delivery Settings” on page 118
5 Click Save to save the profile.

Additional Queue for Polling Setup for webMethods for

Partners
This section describes how to set up queue for polling for a server running webMethods 
for Partners. If you are running webMethods Trading Networks, there is no additional 
setup.

To set up Queue for polling for webMethods for Partners

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, the partner server uses the partner key and the hub server uses 
the hub key).
2 Locate the server configuration file at <ServerDirectory>\config\server.cnf, 
where ServerDirectory is the directory in which you installed the Integration Server 
running webMethods for Partners.
3 In the server configuration file, ensure that the watt.server.partner property exists 
and is set properly. The property should be set to the host name for the hub 
Integration Server. For example, if the host name for the hub Integration Server were 
“HostName,” the property would be 
watt.server.partner=HostName

Note: Note: If the watt.server.partner property is missing or set incorrectly, the 
partner server will be unable to request the documents queued for it on the hub 
server. If the property exists but is set incorrectly, the partner server will throw an 
exception when attempting to request queued documents.

If the watt.server.partner property is missing or incorrect, add or update the 
property. To do so, you need to first shut down the Integration Server running 

webMethods Trading Networks Administrator’s Guide Version 7.1 418

 17. Defining and Managing Queues in Trading Networks

webMethods for Partners. After you add or update the property, restart the 
Integration Server.

Viewing Documents that Are Queued for Delivery

You can search for and view information about documents that are scheduled for delivery 
or are in queued for polling. For instructions, see the webMethods Trading Networks User’s 
Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 419

 17. Defining and Managing Queues in Trading Networks

webMethods Trading Networks Administrator’s Guide Version 7.1 420

Chapter 18. Creating Delivery Services

What is a Delivery Service? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

Creating an Immediate Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

Creating a Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

Adding and Registering New Delivery Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

webMethods Trading Networks Administrator’s Guide Version 7.1 421

 18. Creating 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 supports two types 
of delivery services—immediate and scheduled delivery. 

Note: Use the Trading Networks tn.transport.user property to indicate the user account to use 
when invoking a delivery service. By default, Trading Networks uses the Administrator 
user account to invoke services. For more information about this property, see 
“tn.transport.user” on page 511. 

For more information about immediate and scheduled delivery services, see Chapter 6, 

ʺDelivering Documents to Partnersʺ in the webMethods Trading Networks Concepts Guide.

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. 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.g., Primary HTTP, Secondary HTTP, etc.)
Each immediate delivery method (Primary HTTP, Secondary HTTP, etc.) that Trading 
Networks provides is associated with a default immediate delivery service that Trading 
Networks also provides. You can create immediate delivery services that deliver 
documents in ways not provided with Trading Networks. You can:
Add new delivery services—When you add a new immediate delivery service, you, in 
effect, add new immediate delivery methods. The new delivery methods you add by 
adding new immediate delivery services are available for you to select when you 
define processing rules; 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.
Replace existing delivery services—If one or more of the default immediate delivery 
services that are provided with Trading Networks does not meet your needs, you can 
create new delivery services to replace the default services.

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. Trading Networks uses scheduled delivery services 
during scheduled delivery. Scheduled delivery is a way to batch multiple documents that 
are acted on (delivered) at scheduled times.
You associate scheduled delivery services with delivery queues. You can associate a 
single scheduled delivery service with one or more delivery queues. Delivery queues also 

webMethods Trading Networks Administrator’s Guide Version 7.1 422

 18. Creating Delivery Services

have delivery schedules associated with them. Trading Networks invokes the scheduled 
delivery service at the times dictated by the delivery schedule.
Trading Networks places delivery tasks in the queues. When the Deliver Document By 
processing action indicates to use scheduled delivery (i.e., a queue name or Receiver’s
Queue), Trading Networks creates a delivery task for the document that is to be delivered 
and places the delivery task into the queue. When the schedule associated with the queue 
indicates, Trading Networks invokes the scheduled delivery service. The scheduled 
delivery service retrieves the list of delivery tasks that are in the queue. It is the 
responsibility of the scheduled delivery service to retrieve the document, attempt to 
deliver the document, and update the status of the delivery task to indicate whether the 
delivery was successful or not.

Note: The queue is not a queue in the traditional sense. It is a set of rows in the Trading 
Networks database. Each queued delivery task that is associated with a document is a row 
in the same table of the Trading Networks database.

Trading Networks provides a single scheduled delivery service, the wm.tn.transport:batchFtp 
service, which uses FTP to deliver documents to a single destination. This service opens a 
connection, delivers all the documents, and then closes the connection. If you want to 
deliver batches of documents in a different way, you can create custom scheduled 
delivery services and register them with Trading Networks. 
After you add new scheduled delivery services, you can define your delivery queues to 
use your custom scheduled delivery services; Trading Networks displays the scheduled 
delivery services in the lists of services that you can associate with a queue. For more 
information about queues, see Chapter 17, “Defining and Managing Queues in Trading 
Networks”.

Creating an Immediate Delivery Service

An immediate delivery service must handle a single document that is passed to the 
service as input. 
Your immediate delivery service must implement, at a minimum, the input and output 
variables that are defined in the specification wm.tn.rec:DeliveryServiceSignature. To view this 
specification, use the webMethods Developer. The specification is located in the WmTN 
package.
The input value defined by the specification is the document to be delivered. The output 
values specified by the specification indicate the outcome of the service. Your service must 

webMethods Trading Networks Administrator’s Guide Version 7.1 423

 18. Creating Delivery Services

provide values for the serviceOutput output variable. The serviceOutput variable is an IS 
document (IData object) that contains the following String variables: 

Variable in the
serviceOutput Specify…
status Whether the service executed successfully or unsuccessfully. Your 
service must provide one of the following values:
Value Meaning
success The delivery of the document was successful.
fail The delivery of the document failed.
statusMessage Optional. A delivery‐specific message about the outcome of the 
delivery.
transportTime Optional. The number of milliseconds it took for the service to 
deliver the document.
output Optional. Return information from the delivery service, for 
example, response bytes received from an HTTP post.

For information about creating the service, see the webMethods Developer User’s Guide.

Important!  Do not save your immediate delivery service in the WmTN package or any 
other webMethods package that contains webMethods software. If you do, when you 
upgrade the webMethods software, your service will be lost.

Note: If you are using large document processing, see “Creating Services that Recognize 
Large Document Handling” on page 530.

Retrieving the Content of a Document for Immediate Delivery

To obtain the document content that needs to be delivered, use the 
wm.tn.doc:getDeliveryContent service. You pass this service the BizDocEnvelope that represents 
the document and the service returns the delivery content.
You can use the wm.tn.doc:getDeliveryContent service regardless of whether Trading Networks 
considers the document large or not. This service determines whether to handle the 
document as large. If the document is not considered large, the service returns the 
delivery content as a byte array. If the document is considered large, the service returns 
the delivery content as a Java InputStream object.
For more information about handling of large documents, see Appendix F, “Large 
Document Handling”. For more information about the wm.tn.doc:getDeliveryContent service 

webMethods Trading Networks Administrator’s Guide Version 7.1 424

 18. Creating Delivery Services

and the structure of the BizDocEnvelope (wm.tn.rec:BizDocEnvelope), see the webMethods 
Trading Networks Built‐in Services Reference. 

Creating a Scheduled Delivery Service

A scheduled delivery service must act on a batch of delivery tasks. Your scheduled 
delivery service must retrieve each delivery task and act on it individually. It is the 
responsibility of the scheduled delivery service to retrieve each delivery task, deliver the 
document associated with the delivery task, and update the status of the delivery task.
To perform these functions, your scheduled delivery service might have to take other 
actions as well. For example, 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. Trading Networks provides a single scheduled 
delivery service, the wm.tn.transport:batchFtp service, which you can use as a reference 
implementation to write your own scheduled delivery schedule. (The 
wm.tn.transport:batchFtp service opens a connection, delivers all the documents, and then 
closes the connection.)

Important!  Do not save your scheduled delivery service in the WmTN package or any other 
webMethods package that contains webMethods software. If you do, when you upgrade 
the webMethods software, your service will be lost.

Note: If you are using large document processing, see “Creating Services that Recognize 
Large Document Handling” on page 530.

Inputs and Outputs for a Scheduled Delivery Service

When you create your scheduled delivery service, define the inputs and outputs to use for 
the variables described in this section.

webMethods Trading Networks Administrator’s Guide Version 7.1 425

 18. Creating Delivery Services

Inputs for Scheduled Delivery Service

The following table lists the input variables that your scheduled delivery service should 
expect:

Variable Data Type Description

queue String The name of the queue that contains the delivery tasks 
on which your scheduled delivery service is to act; this 
is the only required input variable.
Your scheduled delivery service will use this value as 
input to the wm.tn.queuing:getQueuedTask service to 
retrieve a delivery task. For more information, see 
“Required Logic to Include in the Scheduled Delivery 
Service” on page 427.
other  n/a Define any other input variables that your scheduled 
variables delivery service requires. Other variables that you 
need to define typically depend on the transport 
protocol your service will use to deliver the 
documents. For example, for a service that uses FTP, 
an additional input variable would be the directory in 
which to place the documents that are being 
delivered.
When you define a public or private queue, Trading 
Networks allows you to set these variables. When 
Trading Networks invokes your delivery service, it 
will supply the inputs you specify when you defined 
the queue. For more information about defining 
public queues, see “Defining Public Queues” on 
page 413. 

Outputs for Scheduled Delivery Service

The following table lists the output variables that your scheduled delivery service must 
return:

Variable Data Type Description

logMsg String Text that describes the result of the scheduled delivery 
service.
This is not the status of acting on a single delivery task 
in the queue; it is the result of the scheduled delivery 
service as a whole.

webMethods Trading Networks Administrator’s Guide Version 7.1 426

 18. Creating Delivery Services

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. For more information, see “Retrieving the Content of a Document for Immediate 
Delivery” on page 424.

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.

Action Built-in service to use

Retrieve a delivery wm.tn.queuing:getQueuedTask
task from a queue
When you invoke this service, 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. When you retrieve a task from the queue, 
the task is not removed from the queue. Instead, the status of the 
delivery task is updated from QUEUED to DELIVERING. 
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… Task represented as...

Flow service IS document (IData object) that has a structure 
defined by the wm.tn.rec:Task IS document type
Java Service com.wm.app.tn.delivery.GuaranteedJob object
The task that is returned includes the document to be delivered. 
For more information about the wm.tn.rec:Task IS document type, 
see the webMethods Trading Networks Built‐in Services Reference. For 
more information about the com.wm.app.tn.delivery.GuaranteedJob 
object, see the webMethods Trading Networks Java API Reference 
documentation.

Note: The wm.tn.queuing:getQueuedTask service places the 
timeDequeued variable in the pipeline. Trading Networks uses this 
variable to calculate the amount of time it takes to transmit the 
document. Do not update or drop this variable from the pipeline.

webMethods Trading Networks Administrator’s Guide Version 7.1 427

 18. Creating Delivery Services

Action Built-in service to use

Typically, your scheduled delivery service should invoke the 
wm.tn.queuing:getQueuedTask service and process delivery tasks until 
the queue is empty; that is, until you have processed each of the 
QUEUED delivery tasks in the queue. When the queue is empty, 
the wm.tn.queuing:getQueuedTask service returns null for the task 
variable.
Deliver the Use one of the built‐in services in the pub.client folder or one of your 
document own custom transport services.
After your scheduled delivery service retrieves a delivery task, it 
should deliver the document that is returned with the task 
information.
Update the delivery wn.tn.queuing:updateQueuedTask
task
After your scheduled delivery service attempts to deliver the 
document that is associated with a delivery task, the service must 
update the task to indicate whether the delivery was successful or 
not. 
To indicate the outcome of the delivery, set the following input 
variables to the wm.tn.queuing:updateQueuedTask service:
Variable Setting

status If the delivery attempt was successful, set the 
status variable to success
If the delivery attempt was unsuccessful, set 
the status variable to fail
statusMsg If the transport protocol that your scheduled 
delivery service uses returns a text string 
message, set statusMsg to the value of the 
returned text string.
  serviceOutput Optional. To save pipeline data from the 
delivery service, place the data in the 
serviceOutput variable.

webMethods Trading Networks Administrator’s Guide Version 7.1 428

 18. Creating Delivery Services

Action Built-in service to use

The wm.tn.queuing:updateQueuedTask service uses the returned status 
to update the delivery task status: 
If status is success, the service updates the task status to the 
DONE.
If status is fail, the service updates the task’s retry count. 
If the maximum retry count has not been reached, the 
service updates the task status to QUEUED, which 
indicates that the next time the queue schedule invokes 
your delivery service, this delivery task will be available to 
retrieve and re‐attempt to deliver the document.
If the maximum retry count has been reached, the service 
updates the task status to FAILED.
The wm.tn.queuing:updateQueuedTask service also takes care of logging 
the results of the delivery to the activity log.

Typical Logic to Include in the Scheduled Delivery Service

A typical scheduled delivery service might deliver all the batched documents to a single 
destination. The wm.tn.transport:batchFtp scheduled delivery service, which Trading 
Networks provides, behaves in this manner and is a good sample to refer to when 
creating your own scheduled delivery service. For more information, see “The 
wm.tn.transport:batchFtp Service” on page 431.
The following shows steps you might want to include in your scheduled delivery service 
to deliver all documents to the same destination.

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.g., 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. For more 
information, see “Required Logic to Include in the Scheduled Delivery Service” on 
page 427.

webMethods Trading Networks Administrator’s Guide Version 7.1 429

 18. Creating Delivery Services

The above shows only a sample of one way to create the service. You might have different 
requirements for your service. For example, 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.
As shown above, the scheduled delivery service might need to make a connection to a 
remote server. The typical approach is to open the connection after you have determined 
that the queue has delivery tasks in it (that is, the queue is not empty). You can determine 
whether the queue is empty by invoking the wm.tn.queuing:getQueuedTask service. If this 
service returns null, the queue is empty. After your scheduled delivery service has acted 
on the delivery tasks in the queue, your service can then close the connection to the 
remote server.
Some transport protocols require additional actions after opening a connection and before 
you begin delivering documents. For example, for the FTP protocol, after performing the 
LOGIN to connect to the remote server, a cd (change directory) is performed to navigate to 
the appropriate directory.

Handling Exceptions
When the queue schedule dictates, the wm.tn.queuing:deliverBatch service is invoked. The 
wm.tn.queuing:deliverBatch service, in turn, invokes your scheduled delivery service and 
passes your service information about the queue.
This wm.tn.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. In response to an exception, the wm.tn.queuing:deliverBatch service increments the 
retry count for the current delivery task and logs the exception to the activity log.
If your scheduled delivery service needs to take action in response to an exception, use the 
pub.flow:getLastError built‐in service to detect whether an exception was thrown.
If you are creating your scheduled delivery service using the flow language, and you 
want to exit your scheduled delivery service due to a failure, use the following flow 
operation:
EXIT $flow and signal FAILURE

The above flow operation causes the wm.tn.queuing:deliverBatch service to increment the 
current delivery task’s retry count and log the exception to the activity log. You provide 
the information that Trading Networks logs to the activity log. To provide this 
information, be sure you specify meaningful information in:
failure‐message property of the EXIT flow operation

logMsg variable in Pipeline out; map meaningful text to this variable

webMethods Trading Networks Administrator’s Guide Version 7.1 430

 18. Creating Delivery Services

The wm.tn.transport:batchFtp Service

Trading Networks provides one scheduled delivery service, wm.tn.transport:batchFtp, which 
is shown below. This service delivers a batch of documents using the FTP protocol to a 
single destination. It is written in the flow language. To view more information about the 
service, use the webMethods Developer to view it. Use this service as a model if you are 
creating your own custom scheduled delivery service.

The wm.tn.transport:batchFtp Service

1

3
4

6
7
8

9
10

11
12

13

webMethods Trading Networks Administrator’s Guide Version 7.1 431

 18. Creating Delivery Services

Flow
Operations Description

1 The INVOKE flow operation invokes the wm.tn.queuing:getQueuedTask service 
to retrieve the first delivery task from the queue. The service returns the 
task information in the task variable.

2 If the variable, task, is null, the queue is empty. In this case, map text to the 
output variable, logMsg, and exit the service. 

3 If the queue contains delivery tasks, attempt to log in to the remote FTP 
server.

4 An input to the wm.tn.transport:batchFtp service is the variable, directory. If this 
variable was specified, cd to the specified directory. 

5 If the cd to the specified directory fails, map a message to the output 
variable, logMsg, and exit the service. 

6 The REPEAT flow operation causes the service to loop over the delivery 
tasks in the queue.

7 The INVOKE flow operation invokes wm.tn.doc:getDeliveryContent to retrieve 
the document content to be delivered. Note that this service is for all files 
regardless of whether Trading Networks considers a document large. For 
more information, see Appendix F, “Large Document Handling”.

8 The operations in the SEQUENCE flow operation form the file name to use 
for the document being delivered. The file name will be internalID.ext, 
where internalID is the Trading Networks generated internal ID for the 
document and ext is the file extension.
The first INVOKE flow operation in the sequence invokes the 
pub.string:concat service to append a period to the internal ID. The BRANCH 
flow operation determines the file extension. An input to the 
wm.tn.transport:batchFtp service is the variable, fileExtension. If this variable 
was not specified, the file extension defaults to “xml”. Otherwise, the file 
extension is the value specified for the fileExtension variable.

9 This INVOKE flow operation invokes the pub.client.ftp:put service that 
transmits the file using FTP.

10 If the return code from the pub.string:concat service is 226, the file was 
transmitted successfully. In this case, the MAP flow operation sets the 
value of the status variable in Pipeline Out to “success”.
For any other return code the other MAP flow operation sets the value of 
the status variable in Pipeline Out to “fail”.

webMethods Trading Networks Administrator’s Guide Version 7.1 432

 18. Creating Delivery Services

Flow
Operations Description

11 The first INVOKE flow operation invokes the wm.tn.queuing:updateQueuedTask 
service to update the status of the delivery task. One of the inputs to the 
service is status that was set to either “success” or “fail”.
The second INVOKE flow operation invokes the wm.tn.queuing:getQueuedTask 
service to retrieve the next delivery task from the delivery queue.

12 If the wm.tn.queuing:getQueuedTask service returned a delivery task, continue 
in the REPEAT loop. If the service returned null, the queue is empty; exit 
the REPEAT loop.

13 After looping through all delivery tasks, log out of the remote FTP server.

Note that the wm.tn.transport:batchFtp service does not do any exception handling. All 
transport‐level exceptions cause the current invocation of the wm.tn.transport:batchFtp service 
to terminate, and the exception will be handled by its caller, wm.tn.queuing:deliverBatch. The 
wm.tn.transport:batchFtp service will be invoked again for the delivery queue, according to the 
queue’s schedule.

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, you can add or register a new delivery service. For example, you might 
want to create an immediate delivery service that delivers a message into a message 
queuing system.
When you register a delivery service, you assign the delivery service a service name. 
Trading Networks uses the name you supply to identify the delivery service in My 
webMethods and Console:
For an immediate delivery service, the name you specify becomes the name of a new 
immediate delivery method. After you register the new delivery service, Trading 
Networks Console lists the corresponding new delivery method on the Processing 
Rule Detail screen with the Deliver document action. 
For a scheduled delivery service, Trading Networks displays the name in My 
webMethods and the Console with the scheduled delivery services that you can 
associate with a queue.

Note: If you are using large document processing, see “Creating Services that Recognize 
Large Document Handling” on page 530.

webMethods Trading Networks Administrator’s Guide Version 7.1 433

 18. Creating Delivery Services

To add a new delivery service, 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. 
For immediate delivery services, see “Creating an Immediate Delivery Service” 
on page 423
For scheduled delivery services, see “Creating a Scheduled Delivery Service” on 
page 425
For large document processing, see “Creating Services that Recognize Large 
Document Handling” on page 530.
For general information about creating services, see the webMethods Developer User’s 
Guide.
When you create the service, you must place it in a package. Do not place it in the 
WmTN packages because it will be overwritten when you upgrade Trading 
Networks.

Note: If you use your own Java development environment, you need to use a jcode 
utility to put the Java code into the Integration Server namespace; that is, place it in a 
package and folder. The jcode utility is provided. For more information, see the 
webMethods Developer User’s Guide.

2 Execute the wm.tn.delivery:registerService built‐in service to register your new delivery 
service. For more information about this service, see the webMethods Trading Networks 
Built‐in Services Reference.
One of the input variables of the wm.tn.delivery:registerService built‐in service is 
serviceName. The value you specify for serviceName becomes the name of the delivery 
method that My webMethods and the Console display in lists that contain all delivery 
methods.

webMethods Trading Networks Administrator’s Guide Version 7.1 434

 18. Creating Delivery Services

You can execute the wm.tn.delivery:registerService built‐in service from the webMethods 
Developer to register your new delivery service. To execute the service from the 
Developer, perform the following steps:
a Select the wm.tn.delivery:registerService service from the Navigation Panel.
b Select Test > Run. The webMethods Developer displays a dialog box for you to 
enter input:

c Fill in the input parameters: 

For this
parameter... Specify...

serviceName The name you want to assign to the delivery service, e.g., 
Message Queue. This is the name that Trading Networks 
displays in lists in My webMethods and the Console.

Note: Do not use the same serviceName as any existing 
immediate or scheduled delivery service.

host The host name of the Integration Server. If you leave host 
blank, Trading Networks uses “localhost”. If the delivery 
service resides on the local machine, specify localhost or 
leave host blank.

webMethods Trading Networks Administrator’s Guide Version 7.1 435

 18. Creating Delivery Services

For this
parameter... Specify...

When you leave host blank or specify localhost, Trading 
Networks assumes that the delivery service is on the local 
server.
When you specify any other value for host, Trading 
Networks assumes the delivery service is on a remote 
server. This is true even if the value you specify is the host 
name for the local machine.

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. If the delivery service is on 
the local machine, this will consume resources unnecessarily.

To invoke a delivery service on a remote server, Trading 
Networks opens an HTTP connection and posts the document 
to be delivered.
port The port number for the Integration Server. If you leave host 
blank, do not specify a value for port.
user A user name of a User account that has the authority to 
execute the wm.tn.delivery:registerService service. Trading 
Networks ignores user if host is localhost or left blank.
password The password for the user account identified in user. Trading 
Networks ignores user if password is localhost or left blank.

Note: The password will be securely managed by the 
Integration Server’s Password Manager. For details, see 
Appendix B, ʺSecurity within Trading Networksʺ in the 
webMethods Trading Networks Concepts Guide.

ifc The fully‐qualified folder name of the new delivery service 
you want to use, e.g., TNCustomize.deliveryServices.
service The service name of the new delivery service you want to use, 
e.g., messageQueue.

webMethods Trading Networks Administrator’s Guide Version 7.1 436

 18. Creating Delivery Services

For this
parameter... Specify...

scheduled Whether you are adding an immediate or scheduled delivery 
service.
For this type… Specify…

Immediate false (default)
Scheduled true

d Click OK.

Note: To make changes to the parameters you specified when adding the delivery service 
(e.g., to specify a different service):
First, remove the service using wm.tn.delivery:removeService 

Then, follow this “To add and register a new delivery service” procedure again on to 
re‐register the service specifying your changes.

webMethods Trading Networks Administrator’s Guide Version 7.1 437

 18. Creating Delivery Services

webMethods Trading Networks Administrator’s Guide Version 7.1 438

 Part V. Appendices

Appendix A, “Queries in Trading Networks Console”

Appendix B, “Archiving and Deleting Documents”

Appendix C, “Exporting and Importing Database Information”

Appendix E, “XQL Reference”

Appendix F, “Large Document Handling”

webMethods Trading Networks Administrator’s Guide Version 7.1 439

 V. Appendices

webMethods Trading Networks Administrator’s Guide Version 7.1 440

Appendix A. Queries in Trading Networks Console

Running Queries in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442

Enabling the Query Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

Creating and Saving a Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

Selecting and Running a Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

Updating the Search Criteria for a Saved Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

Saving a New Query Based on an Existing Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

Reverting to a Saved Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

Deleting Saved Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

webMethods Trading Networks Administrator’s Guide Version 7.1 441

 A. Queries in Trading Networks Console

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

webMethods Trading Networks Administrator’s Guide Version 7.1 442

 A. Queries in Trading Networks Console

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 Administrator’s Guide Version 7.1 443

 A. Queries in Trading Networks Console

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 might 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 left of the toolbar to display the query tabs and panels.

Can you see query panels? Click this button... To perform this action...
No Display the query panels.
 Show Query
Yes Remove/Hide the query panels.
Hide Query

webMethods Trading Networks Administrator’s Guide Version 7.1 444

 A. Queries in Trading Networks Console

So, to view the above Trading Partners screen with the query tabs, click   Show Query on 

the toolbar.

Trading Partners screen displayed with query tabs

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.

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 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 Enable the query panel. For instructions, see “Enabling the Query Functions” on 
page 444.
2 Specify the search criteria you want to save on each of the query tabs.

webMethods Trading Networks Administrator’s Guide Version 7.1 445

 A. Queries in Trading Networks Console

3 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.

4 Save the query, select  Save As on the toolbar.

5 In the Save as dialog box, type the name you want to give the query in the Query Name 
field. 
6 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 saved query, perform the following procedure.

To select and run a query

1 Enable the query panel. For instructions, see “Enabling the Query Functions” on 
page 444. Trading Networks displays the last query that was run in this screen view.
2 Select the query from the list of saved queries, which is located on the toolbar.

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.

webMethods Trading Networks Administrator’s Guide Version 7.1 446

 A. Queries in Trading Networks Console

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 Enable the query panel. For instructions, see “Enabling the Query Functions” on 
page 444.
2 Select the query for which you want to update search criteria from the list of saved 
queries, which is located on the toolbar. 
3 Make your changes to the search criteria for the saved query by updating the fields on 
the query tabs.

4 Re‐run the query by selecting  Run Query on the toolbar. Trading Networks 

updates the results table displayed in the bottom panel

5 Select  Save Query on the toolbar to re‐save the query with your updates.

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 Enable the query panel. For instructions, see “Enabling the Query Functions” on 
page 444.
2 Select the existing query to base the new query on from the list of saved queries, 
which is located on the toolbar. 
3 Make your changes to the search criteria for the new query by updating the fields on 
the query tabs.

4 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.

5 Select  Save Query As to save the new query with your changes.

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.

webMethods Trading Networks Administrator’s Guide Version 7.1 447

 A. Queries in Trading Networks Console

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.

Deleting Saved Queries

If you no longer need a saved query you can delete it. Perform the following procedure to 
delete a saved query.

To delete a query

1 Enable the query panel. For instructions, see “Enabling the Query Functions” on 
page 444.
2 Select the query you want to delete from the list of saved queries, which is located on 
the toolbar.

3 Select  Delete Query. Click Yes to verify that you want to delete the query.

webMethods Trading Networks Administrator’s Guide Version 7.1 448

Appendix B. Archiving and Deleting Documents

About Archiving and Deleting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

Setting Up Basic Archival and Deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451

webMethods Trading Networks Administrator’s Guide Version 7.1 449

 B. Archiving and Deleting Documents

About Archiving and Deleting Documents

You can set up Trading Networks to perform data archival and deletion. Using the 
“basic” archival and deletion feature, you specify how many days after a document is 
received that you want Trading Networks to archive and delete the document. You do not 
have to archive a document before deleting it.
The “configurable” archival and deletion feature provides much greater flexibility than 
the “basic” deletion feature. Trading Networks provides a built‐in service that enables 
you to selectively archive documents based on additional criteria, such as the document 
ID, sender, receiver, system status, and more. Additionally, you can choose to archive 
only selected parts of documents. That is, you can choose to archive documents contained 
in any or all of the non‐archival tables listed below.

Archiving Documents
When Trading Networks archives a document, it moves document information into 
archival tables. The archival tables mirror the tables that Trading Networks uses for its 
normal operation:

Corresponding table that Trading Networks uses for

Archival Table normal operation
ARCHIVE_BizDoc BizDoc
ARCHIVE_BizDocContent BizDocContent
ARCHIVE_BizDocAttribute BizDocAttribute
ARCHIVE_BizDocArrayAttribute BizDocArrayAttribute
ARCHIVE_BizDocRelationship BizDocRelationship
ARCHIVE_DeliveryJob DeliveryJob
ARCHIVE_ActivityLog ActivityLog
ARCHIVE_BizDocUniqueKeys BizDocUniqueKeys
ARCHIVE_EDITracking EDITracking

Data in the archival tables is identical to the data in the normal, non‐archival Trading 
Networks tables except that the archival tables do not contain primary keys, foreign keys 
or unique column constraints.
When Trading Networks archives a document, it removes the document information and 
the references to the document from all non‐archival tables in the database. After a 
document is archived, the archived information is no longer available from My 
webMethods or the Trading Networks Console. For example, after a document is 
archived, you will no longer be able to view information about it on the Transactions, 
Tasks, or Activity Log pages in My webMethods.

webMethods Trading Networks Administrator’s Guide Version 7.1 450

 B. Archiving and Deleting Documents

Deleting Documents
When Trading Networks deletes a document, it removes all document information 
(whether in the archival tables or non‐archival tables) from the database. 

Note: The “configurable” deletion feature will delete all documents from archival tables; 
you cannot alter this behavior.

Setting Up Basic Archival and Deletion

To set up the “basic” document archival and deletion feature, you add Trading Networks 
system properties to the Trading Networks properties file, and schedule when you want 
the archive and deletion service to run.

Setting How Many Days to Retain Documents before Archival

and Deletion
Set the tn.archive.archiveAfterDays system property to specify how many days Trading 
Networks should keep a document from the time it is received before archiving it. Set the 
tn.archive.deleteAfterDays system property to specify how many days Trading Networks 
should keep a document from the time it was received before deleting it. If you want 
Trading Networks to only delete documents and not archive them, specify only the 
tn.archive.deleteAfterDays system property.

To set the archival and deletion system properties

1 In My webMethods: Administration > Integration > B2B Settings > Server Settings.

2 Add or update the following properties: 

For this system property … Specify …

tn.archive.archiveAfterDays How many days after Trading Networks receives the 
document that Trading Networks should archive it. 
Specify a value from 0 through 730365. If you do not 
specify this property or if you specify 0 for this 
property, Trading Networks does not archive 
documents.
Example:
If you want Trading Networks to archive documents 
30 days after they are received, add the following:
tn.archive.archiveAfterDays=30

webMethods Trading Networks Administrator’s Guide Version 7.1 451

 B. Archiving and Deleting Documents

For this system property … Specify …

tn.archive.deleteAfterDays How many days after Trading Networks receives the 
document that Trading Networks should delete it. 
Specify a value from 0 through 730365. If you do not 
specify this property or if you specify 0 for this 
property, Trading Networks does not delete 
documents.
Example:
If you want Trading Networks to delete documents 60 
days after they are received, add the following:
tn.archive.deleteAfterDays=60

3 Click Save Changes.

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. To schedule the execution of the service, 
use the Server Administrator to set up a user task that executes the archive and delete 
service. Trading Networks is shipped with the archive and delete service. Its fully 
qualified service name is: wm.tn.archive:archive.

To schedule when to archive and delete documents

1 Open the Server Administrator. If you need instructions, see the webMethods 
Integration Server Administrator’s Guide.
2 In the Server menu of the navigation area, click Scheduler.
3 Click Create a scheduled task.
4 Set the Service Information parameters as follows:

For this parameter… Specify…

folder:subfolder:service wm.tn.archive:archive
Run As User Administrator

webMethods Trading Networks Administrator’s Guide Version 7.1 452

 B. Archiving and Deleting Documents

For this parameter… Specify…

Persistence That you want the server to maintain this user task in the 
event that the server is restarted by selecting the Persist
after restart check box.
Clustering Whether you want the task to run anywhere in your 
cluster of servers. For more information on clusters, see 
the webMethods Integration Server Clustering Guide.

5 In the Schedule Type and Details section of the screen, specify that you want the service 

to be executed periodically, by selecting either Repeating or Complex. Then, specify the 
additional parameters to indicate when and how often you want the archival and 
deletion service to run.

If you select… Specify…

Repeating The number of seconds that you want the server to wait 
between executions of the service in the Interval field. For 
example, if you want the service to run once every 24 hours, 
specify 86400.
In the Repeating field, select the Repeat from end of invocation 
check box to indicate that if the current occurrence of the task 
is not complete when the interval elapses, that you want the 
server to wait until the current occurrence of the task 
completes before repeating the task. 

Note:  The service executes for the first time immediately after 
you schedule the user task.

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.
Example:
To specify that you want the service to execute daily at 10 p.m. 
starting on March 15, 2001, specify the following parameters:
Start Date 2001/3/15
Start Time 22:00:00
End Date leave blank

webMethods Trading Networks Administrator’s Guide Version 7.1 453

 B. Archiving and Deleting Documents

If you select… Specify…

End Time leave blank

Months no selection
Days no selection
Weekly Days no selection
Hours 22
Minutes 0

Note: Note: Omitting the End Date and End Time indicates that 

the service is to run indefinitely.

Note: For more information about these parameters, see information about scheduling 
services in the webMethods Integration Server Administrator’s Guide.
6 Click Save Tasks.

Setting Up Configurable Archival and Deletion

To set up the “configurable” document archival and deletion feature, you specify values 
for the input parameters of the built‐in archive and deletion service wm.tn.extendedArchive, 
and schedule when you want the service to run.

To set the configurable archival and deletion service

1 Open the Developer if it is not already open.
2 In the WmTN package, open the folders wm > tn > archive and double‐click the built‐in 
service extendedArchive.
3 Specify values for the input parameters of the wm.tn.archive:extendedArchive service, 
which are described in the webMethods Trading Networks Built‐in Services Reference.
4 Save the values.

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. To schedule the execution of the service, 
use the Developer to create a wrapper service that executes the archive and delete service. 
Then use the Server Administrator to set up a user task that executes the archive and 

webMethods Trading Networks Administrator’s Guide Version 7.1 454

 B. Archiving and Deleting Documents

delete service. Trading Networks is shipped with the archive and delete service. Its fully 
qualified service name is: wm.tn.archive:extendedArchive.

To set the archival and deletion system properties

1 Open the Developer if it is not already open. 
2 Create a wrapper service that invokes the service wm.tn.archive:extendedArchive.
3 Open the Server Administrator. If you need instructions, see the webMethods 
Integration Server Administrator’s Guide.
4 In the Server menu of the navigation area, click Scheduler.
5 Click Create a scheduled task.
6 Set the Service Information parameters as follows:

For this parameter… Specify…

folder:subfolder:service Your wrapper service
Run As User Administrator
Persistence That you want the server to maintain this user task in the 
event that the server is restarted by selecting the Persist
after restart check box.
Clustering Whether you want the task to run anywhere in your 
cluster of servers. For more information on clusters, see 
the webMethods Integration Server Clustering Guide.

7 In the Schedule Type and Details section of the screen, specify that you want the service 

to be executed periodically, by selecting either Repeating or Complex. Then, specify the 
additional parameters to indicate when and how often you want the archival and 
deletion service to run.

webMethods Trading Networks Administrator’s Guide Version 7.1 455

 B. Archiving and Deleting Documents

If you select… Specify…

Repeating The number of seconds that you want the server to wait 
between executions of the service in the Interval field. For 
example, if you want the service to run once every 24 hours, 
specify 86400.
In the Repeating field, select the Repeat from end of invocation 
check box to indicate that if the current occurrence of the task 
is not complete when the interval elapses, that you want the 
server to wait until the current occurrence of the task 
completes before repeating the task. 

Note:  The service executes for the first time immediately after 
you schedule the user task.

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.
Example:
To specify that you want the service to execute daily at 10 p.m. 
starting on March 15, 2001, specify the following parameters:
Start Date 2001/3/15
Start Time 22:00:00
End Date leave blank
End Time leave blank
Months no selection
Days no selection
Weekly Days no selection
Hours 22
Minutes 0

Note: Note: Omitting the End Date and End Time indicates that 

the service is to run indefinitely.

Note: For more information about these parameters, see information about scheduling 
services in the webMethods Integration Server Administrator’s Guide.
8 Click Save Tasks.

webMethods Trading Networks Administrator’s Guide Version 7.1 456

Appendix C. Exporting and Importing Database Information

About Exporting and Importing Database Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

Trading Networks Objects that You Can Export and Import . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

How Trading Networks Detects Items in Target System Before Importing Them . . . . . . . . . . . 459

Dependencies For Trading Networks Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

Migrating Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

Migrating Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

Migrating TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

Migrating Custom Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

Migrating Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

Migrating Trading Partner Agreements (TPAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

Migrating Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

Migrating Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472

Migrating Data Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472

Exporting Database Information from the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

Importing Database Information from the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

Using the tnexport and tnimport Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

webMethods Trading Networks Administrator’s Guide Version 7.1 457

 C. 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.g., document attributes, TN document 
types, profiles) from one database to another. Use the export/import feature when:
You want to deploy from a development environment to a production environment.

You are using multiple instances of Trading Networks, and you want each Trading 
Networks instance to have its own database with identical Trading Networks objects. 
You can create the Trading Networks objects on one instance of Trading Networks; 
then use export/import to migrate the Trading Networks objects to the databases of 
the other Trading Networks instances. For more information, see “Separate Trading 
Networks Database for Each Instance of Trading Networks” on page 46. 
You have changed the type of database you are using; for example, you changed from 
an Oracle database to a SQL Server database.

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. It is 
not for:
Migrating database information from one version of Trading Networks to another.

Sharing Trading Networks objects with trading partners.

When you export Trading Networks objects, Trading Networks creates a file that contains 
the data you exported. 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.
Trading Networks objects are available for export regardless of whether they are disabled 
or deleted. There is no indication as to which are disabled, enabled, or deleted. Trading 
Networks maintains the current state (e.g., disabled, enabled, deleted) of the Trading 
Networks objects that you migrate.

Trading Networks Objects that You Can Export and Import

You can export/import the Trading Networks objects listed below.
Profiles, see “Migrating Profiles” on page 461.

Profile fields, see “Migrating Profile Fields” on page 464.

TN document types, see “Migrating TN Document Types” on page 465.

Custom document attributes, see “Migrating Custom Document Attributes” on page 467.

webMethods Trading Networks Administrator’s Guide Version 7.1 458

 C. Exporting and Importing Database Information

Processing rules, see “Migrating Processing Rules” on page 467.

Trading Partner Agreements (TPAs), see “Migrating Trading Partner Agreements (TPAs)” 

on page 470.
Queries that you defined for Console screens, see “Migrating Queries” on page 471.

Public queues, see “Migrating Public Queues” on page 472.

Data permissions, see “Migrating Data Permissions” on page 472.

You cannot export/import information about the documents that are in your system, for 
example, document content, tasks, and activity log entries.
To export data using the Console, you use the Export Data dialog box; to import, use the 
Import Data dialog box. 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, see “Using the tnexport and 
tnimport Utilities” on page 478.

How Trading Networks Detects Items in Target System Before

Importing Them
When importing an item, Trading Networks checks whether the item it is importing 
already exists in the target system by checking the internal ID. If it does not locate an 
existing item based on the internal ID, it then checks based on the name of the item. The 
names against which Trading Networks checks for the items are as follows:

Trading Networks
object Trading Networks checks for...
Profile field Profile field with the same profile field name.
Profile Profile with the same Corporation Name and Unit Name.
Trading Partner  TPA with the same sender name, receiver name and agreement 
Agreement (TPA) ID.
Document  Attribute with the same name.
attribute
TN document  TN document type with the same name.
type
Processing rule Processing rule with the same name.

If Trading Networks finds a matching item using either method, Trading Networks 
prompts as to whether it should overwrite that item in the target system. For more 

webMethods Trading Networks Administrator’s Guide Version 7.1 459

 C. Exporting and Importing Database Information

information about how Trading Networks overwrites the items in the target system, see 
“Using the Overwrite Dialog Box” on page 476.

Dependencies For Trading Networks Objects

In the Export Data dialog boxes, when you select an item in the tree structure, if the 
selected item requires additional items, Trading Networks shows these dependencies in 
the Dependencies area of the dialog. For example, 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, Trading Networks lists the custom attributes and the 
duplicate checking service in the Dependencies area of the dialog.

Export Data dialog with a TN document type that has dependencies selected

Note: The Import Data dialog box shows some, but not all of the dependencies. For 
example, the Import Data dialog box cannot display the IS service dependencies because 
these dependencies are not recorded in the exported file.

webMethods Trading Networks Administrator’s Guide Version 7.1 460

 C. Exporting and Importing Database Information

Migrating Profiles
To migrate profiles, use the following items in the Export Data and Import Data dialog 
boxes:

Items in
Export/Import
Data Dialog box Use to migrate... Dependencies
Partner Data Data for: Profile Groups
Delivery Methods
Standard profile fields
External ID Types
Extended profile fields Contact Types

Certificate information on the Security  For more information, 
tab of the profile.  see “Partner Data 
Dependencies” on 
For more information, see “Partner Data”  page 463.
on page 462.
External ID Types External ID types referenced by the profiles  None
on your system.
Trading Networks lists all external ID types 
defined in the database. These include all 
the standard external ID types (e.g., DUN, 
DUNS+4) that are installed with Trading 
Networks and all custom external ID types 
that you add using the 
wm.tn.dictionary:addIDType service.
Contact Types Contact types referenced by the profiles on  None
your system.
Trading Networks lists all contact types 
defined in the database. These include both 
the standard contact types (i.e., Technical 
and Administrative) that are installed with 
Trading Networks and all custom contact 
types that you add using the 
wm.tn.dictionary:addContactType service.
Profile Groups Profile groups that you have registered on  None
your Trading Networks system.

webMethods Trading Networks Administrator’s Guide Version 7.1 461

 C. Exporting and Importing Database Information

Important! You cannot use export/import to share your profile with a partner. When you 
export your (Enterprise) profile, Trading Networks records that the profile is the Enterprise 
profile. Trading Networks does not allow you to import the Enterprise system from your 
system into a partnerʹs system.

Note: When importing profiles, if any of the dependent data is not defined, Trading 
Networks throws an error and does not import the profile. For example, if the contact 
type is not already defined in the target system before importing a contact of that type, an 
error is thrown and that profile is not imported.

Partner Data
Trading Networks lists each partner by its corporation name under the Partner Data item.

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.

For each partner that is listed under Partner Data, Trading Networks lists the following 
elements:
Profile. Select this item to migrate the data for the standard profile fields for the 
specific partner.
Security Data. Select this item to migrate the certificate information from the Security tab 
of the partnerʹs profile. If the profile has no information on the Security tab, the Security
Data element will not be listed under Partner Data in the tree.
One element for each extended profile field. Select these items to migrate the data for the 
extended profile fields for the specific partner. If you have not defined extended 
fields, no extended field elements will be listed under Partner Data in the tree.

webMethods Trading Networks Administrator’s Guide Version 7.1 462

 C. Exporting and Importing Database Information

Partner Data Dependencies

The following table shows the dependencies for Partner Data. For more information about 
dependencies, see “Dependencies For Trading Networks Objects” on page 460.

Partner Data
Element Dependencies Description
Profile Profile Groups The profile groups that are identified in the 
partner’s profile. 
Use the Profile Groups tree element to migrate the 
profile groups.
Delivery Methods The delivery methods that are defined in the 
profile. 
The profile can only contain standard delivery 
methods that are installed with Trading 
Networks (e.g., Primary HTTP), so no action is 
needed. 
You cannot migrate custom delivery methods. 
You must create these methods in the target 
system.
External ID Types The external ID types that are used by the profile.
If the profile uses custom external ID types that 
you added using the wm.tn.dictionary:addIDType 
service, migrate the those external ID types using 
the External ID Types item.
Trading Networks also lists standard external ID 
types. You do not need to migrate these unless 
they have been deleted from the target system.
Contact Types The contact types that are used by the profile.
If the profile uses custom contact types that you 
added using the wm.tn.dictionary:addContactType 
service, migrate those contact types using the 
Contact Types item.
Trading Networks also lists standard contact 
types. You do not need to migrate these unless 
they have been deleted from the target system.
Queues The public queues used by the profile.
You migrate the queues using the Public Queues 
item.

webMethods Trading Networks Administrator’s Guide Version 7.1 463

 C. Exporting and Importing Database Information

Partner Data
Element Dependencies Description
Security Data Profile The partner’s profile. You migrate the profile 
when you select the Profile element under Partner
Data.
Extended Field Definition The profile field definition for the extended 
Profile Fields profile field.
Use the Field Definitions item to migrate the 
definition for the extended profile field. For more 
information, see “Migrating Profile Fields” on 
page 464.
Profile The partner’s profile. You migrate the profile 
when you select the Profile element under Partner
Data.

In addition to migrating the queue, ensure you move the scheduled delivery services that 
are associated with the queues to the target system.

Migrating Profile Fields

To migrate profile fields, use the following items in the Export Data and Import Data 
dialog boxes:

Items in
Export/Import
Data Dialog box Use to migrate... Dependencies
Field Definitions Definitions for standard and extended profile  Field Group
fields. 
For more 
information, see 
Note: To migrate the data for profile fields, use  “Field Definitions 
the Partner Data item. For more information, see  Dependencies” 
“Partner Data” on page 462. on page 465.

Field Groups Profile field groups that you added to your  None

system on the Extended Field group of a profile or 
by using the wm.tn.dictionary:addFieldGroup service. 
Trading Networks lists all field groups, 
including the standard field groups that are 
installed with Trading Networks (e.g., 
Corporation, Delivery, Contact). You only need 
to migrate custom field groups that you add.

webMethods Trading Networks Administrator’s Guide Version 7.1 464

 C. Exporting and Importing Database Information

Field Definitions Dependencies

When you select a profile field under the Field Definitions item, Trading Networks lists the 
field group to which the profile field belongs in Dependencies.
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.tn.dictionary:addFieldGroup service, migrate the field groups 
using the Field Group item.
If the profile field belongs to a standard field group (e.g., Corporation, Delivery) that was 
installed with Trading Networks, Trading Networks lists the standard field group. You 
do not need to migrate standard field groups.
For more information about dependencies, see “Dependencies For Trading Networks 
Objects” on page 460.

Migrating TN Document Types

To migrate TN document types, use the following items in the Export Data and Import 
Data dialog boxes:

Items in
Export/Import
Data Dialog box Use to migrate... Dependencies
Document Types Definitions for TN document types. IS Services
Attributes
For more 
information, see 
“Document Type 
Dependencies” 
on page 466.
DocType Categories of documents (e.g., XML and Flat  None
Categories  File). All Trading Networks systems will have 
the TN document type categories. You do not 
(which is a 
need to migrate them.
sub‐item 
under Binary
Data)

webMethods Trading Networks Administrator’s Guide Version 7.1 465

 C. Exporting and Importing Database Information

Document Type Dependencies

The following table shows the dependencies for Document Types. For more information 
about dependencies, see “Dependencies For Trading Networks Objects” on page 460.

Dependencies Description
IS Services 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.
If a TN document type that you are migrating uses either or both 
of these types of services, ensure that you move the IS services to 
the target Trading Networks system.
Attributes The custom document attributes that are associated with the TN 
document type.
Use the Attributes item to migrate the custom attributes for the TN 
document type. For more information, see “Migrating Custom 
Document Attributes” on page 467.

Note: When importing TN document types, Trading Networks determines whether the 
attributes used by the TN document type exist in the target system with the same internal 
ID or name. If they do not exist, Trading Networks throws an error and does not import 
the TN document type.

webMethods Trading Networks Administrator’s Guide Version 7.1 466

 C. Exporting and Importing Database Information

Migrating Custom Document Attributes

To migrate custom document attributes, use the following item in the Export Data and 
Import Data dialog boxes. 

Note: You do not need to migrate system attributes because the system attributes are 
defined when you install Trading Networks, and you cannot delete nor alter their 
definitions.

Items in
Export/Import Data
Dialog box Use to migrate... Dependencies
Document Definitions for custom document attributes. None
Attributes

Migrating Processing Rules

To migrate processing rules, use the following item in the Export Data and Import Data 
dialog boxes. 

Items in
Export/Import Data
Dialog box Use to migrate... Dependencies
Processing Rules Processing rules IS Services
Delivery Methods
For more information, see 
“Processing Rules Dependencies” 
on page 468.

When you select to export and import processing rules, be aware of the order of the 
processing rules. Trading Networks maintains processing rules in a specific order. This is 
the order in which Trading Networks selects a processing rule to use for processing an 
incoming document. (Trading Networks uses the first processing rule that matches.)
Trading Networks maintains the list of processing rules that you want to export and 
import in the order it is in the target system. When you import a processing rule, Trading 
Networks replaces the matching processing rules and appends the non‐matching 

webMethods Trading Networks Administrator’s Guide Version 7.1 467

 C. Exporting and Importing Database Information

processing rules without changing the order of the list in the target system, irrespective of 
its order in the source system.

Note: When you import processing rules, you can select to replace all the processing rules 
in the target Trading Networks system with the imported processing rules by selecting 
the Replace Processing Rule List option in the Import Data dialog box.

Processing Rules Dependencies

The following table shows the dependencies for Processing Rules. For more information 
about dependencies, see “Dependencies For Trading Networks Objects” on page 460.

Dependencies Description
IS Services 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, ensure that you move the IS services to 
the target Trading Networks system.
Delivery Methods The immediate delivery method that is used in the Deliver
Document By action of the processing rule. 
If the processing rule uses a custom immediate delivery method 
that you added, ensure that you move the corresponding IS 
services to the target Trading Networks system, and use the 
wm.tn.delivery:registerService service to register the IS service using 
the same delivery method name.
If the processing rule uses a standard immediate delivery method 
that was installed with Trading Networks (e.g., Primary HTTP), 
no action is needed. 

webMethods Trading Networks Administrator’s Guide Version 7.1 468

 C. Exporting and Importing Database Information

Although the Dependencies does not list the following Trading Networks objects, they are 
also required if referenced in a processing rule. Review the processing rules you want to 
export/import and migrate the following if appropriate.
Profiles for senders identified in the Sender criterion on the Criteria tab of the 
processing rule, see “Migrating Profiles” on page 461.
Profiles for the receivers identified in the Receiver criterion on the Criteria tab of the 
processing rule, see “Migrating Profiles” on page 461.
TN document types identified in the Document Type criterion on the Criteria tab of the 
processing rule, see “Migrating TN Document Types” on page 465.
Custom document attributes identified on the Extended Criteria tab of the processing 
rule, see “Migrating Custom Document Attributes” on page 467.
Queues referenced by a Scheduled Delivery used by the Deliver Document By processing 
action. To create the queues on the target system, you can do one of the following:
Use the tnexport and tnimport utilities to export all public and private queues. 
For more information, see “Using the tnexport and tnimport Utilities” on 
page 478.
Manually create the required queue on the target system. 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.
In addition to migrating the queue, ensure you move the scheduled delivery service 
that are associated with the queue to the target system.

Note: When importing processing rules, Trading Networks determines whether the 
associated senders, receivers, and TN document types exist in the target system with the 
same internal ID or name. If they do not exist, Trading Networks throws an error and 
does not import the processing rule.

webMethods Trading Networks Administrator’s Guide Version 7.1 469

 C. Exporting and Importing Database Information

Migrating Trading Partner Agreements (TPAs)

To migrate Trading Partner Agreements (TPAs), use the following item in the Export Data 
and Import Data dialog boxes. 

Items in
Export/Import Data
Dialog box Use to migrate... Dependencies
Agreements TPAs Profiles
IS Services
IS Document Types
For more information, see 
“Agreements Dependencies” on 
page 470.

Agreements Dependencies
The following table shows the dependencies for Agreements. For more information about 
dependencies, see “Dependencies For Trading Networks Objects” on page 460.

Dependencies Description
Profiles The profiles that are associated with the TPA. A TPA is associated 
with two trading partners on your system, one that acts as the 
sender and one that acts as the receiver. Migrate the profiles for 
the sender and receiver. For more information, see “Migrating 
Profiles” on page 461.
IS Services 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, ensure that you move the IS services 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.
Ensure that you migrate this IS document type to the target 
Trading Networks system.

webMethods Trading Networks Administrator’s Guide Version 7.1 470

 C. Exporting and Importing Database Information

Note: When importing TPAs, Trading Networks determines whether the associated 
senders and receivers exist in the target system with the same internal ID or name. If they 
do not exist, Trading Networks throws an error and does not import the TPA.

Migrating Queries
You can migrate all the queries you have defined for the Trading Networks Console 
screens (e.g., queries you defined for the Transaction Analysis screen to search for specific 
documents). To migrate all of your queries, use the following item in the Export Data and 
Import Data dialog boxes.

Items in
Export/Import Data
Dialog box Use to migrate... Dependencies
Query  All queries that you have defined for all screens  None
of the Trading Networks Console:
(a sub‐item 
under Binary Data) Trading Partners

Document Types

Processing Rules

Agreements

Transaction Analysis

Tasks

Activity Log

Note:  This migrates only queries defined in the Console. Searches you save in My 
webMethods are not stored in the Trading Networks database.

webMethods Trading Networks Administrator’s Guide Version 7.1 471

 C. Exporting and Importing Database Information

Migrating Public Queues

To migrate public queues, use the following item in the Export Data and Import Data 
dialog boxes. 

Items in
Export/Import Data
Dialog box Use to migrate... Dependencies
Public Queues Public queues. IS services

Public Queues Dependencies

The following table shows the dependencies for Public Queues. For more information 
about dependencies, see “Dependencies For Trading Networks Objects” on page 460.

Dependencies Description
IS Services The fully‐qualified names of the delivery service associated with 
the queue. Be sure to move the IS services to the target Trading 
Networks system.

Migrating Data Permissions

You can migrate data permissions that provide role‐based access to Trading Networks 
data when accessing the data via My webMethods. You define the data permissions in My 
webMethods. When you define data permissions, you define rules that identify:
A data set that defines the Trading Networks data to which the data permission rule 
applies. The data set can contain profiles, profile groups, and transaction (BizDoc 
type) entries.
The roles that can act on the data in the data set. Additionally, for each role you 
indicate the Trading Networks permissions that the role can take against the data.
For more information about data permissions, see “Data and Actions Governed by Data 
Permissions” on page 72 and “Defining Data Permissions” on page 75.

Note: You cannot migrate the general functional permissions.

How to Migrate Data Permissions

You must use the command line utilities tnexport and tnimport to migrate data 
permissions. You cannot export or import data permissions from the Console. 

webMethods Trading Networks Administrator’s Guide Version 7.1 472

 C. Exporting and Importing Database Information

To export data permissions, use the -dls option of the tnexport utility. The tnexport 
utility exports all data permission rules. You cannot select a subset of the data permission 
rules. 
When you use the tnimport utility to import the data permission rules, the utility imports 
all data in the file that contains the data you are importing. As a result, if the file contains 
data permission rules, they will be imported into the target Trading Networks.
For more information, see “Using the tnexport and tnimport Utilities” on page 478.

Data Permission Dependencies

The following table shows the dependencies when migrating data permissions. 

Dependencies Description
Profiles All profiles that are part of the data set definitions for data 
permission rules. 
Profile Groups All profiles that are part of the data set definitions for data 
permission rules.
TN document types All TN document types that are part of the data set definitions 
for data permission rules. 
My webMethods  The My webMethods roles that the data permission rules 
roles reference. These roles are defined in the My webMethods Server 
database not the Trading Networks database, and as a result, 
you cannot import/export them with the Trading Networks 
tnexport and tnimport command line utilities. You must 
ensure the My webMethods Server setup is the same in the 
target system.

For more information about how profiles, profile groups, and TN document types are 
used to define the data set of a data set permission rule, see “Defining Data Permissions” 
on page 75.
When you export the data permissions, and you do not include the dependent profiles, 
profile groups, and TN document types, then when importing, Trading Networks throws 
a warning indicating that the required dependent does not exist in the target system. It 
then continues to import the other items.

webMethods Trading Networks Administrator’s Guide Version 7.1 473

 C. Exporting and Importing Database Information

Exporting Database Information from the Console

To export database information, perform the following procedure.

To export database information

1 In Trading Networks Console: File > Export. 

Trading Networks displays the Export Data dialog box. The Available Items contains a 
tree structure that lists the database items that are available for you to export.
2 Select the items that you want to export by moving items to the Selected Items list.
When you select one of the following types of items in the Available Items list, check the 
Dependencies to determine whether there are other items you should export as well.

Item For more information about dependencies, see...

Partner Data “Partner Data Dependencies” on page 463

Field Definitions “Field Definitions Dependencies” on page 465
Document Types “Document Type Dependencies” on page 466
Processing Rules “Processing Rules Dependencies” on page 468
Public Queues “Public Queues Dependencies” on page 472

3 Click OK.
4 In the Save File dialog box, specify the file to which you want Trading Networks to 
write the database information. Then, click Save.
Note: The file that contains the exported data is a binary‐encoded file.

Importing Database Information from the Console

When importing data, you need to:
Determine how to handle importing items that exist in the target system. For more 
information, see “Importing Items that Match With Those in the Target System” on 
page 475.
Select the Replace Processing Rules List option when you want to replace all the 
processing rules in the target Trading Networks system with the imported processing 
rules.

webMethods Trading Networks Administrator’s Guide Version 7.1 474

 C. Exporting and Importing Database Information

Importing Items that Match With Those in the Target System

When importing an item, if the item in the target system matches either the internal ID or 
the name, then Trading Networks handles the items based on the type of item that is being 
imported. 

For the following items in the Import

Data dialog box: Trading Networks...
Document Types Displays the Overwrite dialog box.

Document Attributes For more information about how to use this dialog 

box, see “Using the Overwrite Dialog Box” on 
Partner Data: page 476. 
Profiles For information about how to force the overwrite 
of identically named items without displaying the 
Field Groups
Overwrite dialog box, see “Suppressing the 
Contact Types Overwrite Dialog Box and Forcing the Overwrite 
of Items” on page 477.
Public Queues
Field Definitions Does not display the Overwrite dialog box. 
Attempts to add the identically named item to the 
External ID Types target database.
Agreements

Binary Types

Partner Data:
Security Data
Extended Field Data
Processing Rules Displays the Overwrite dialog box, when you do 
not select the Replace Processing Rule List option.
Does not display the Overwrite dialog box when 
you select the Replace Processing Rule List option.

webMethods Trading Networks Administrator’s Guide Version 7.1 475

 C. Exporting and Importing Database 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, 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

Public Queues

Processing Rules
The Overwrite dialog box allows you to select one of the following options:

Overwrite dialog option Description

Yes Selecting Yes grants Trading Networks permission to overwrite 
only the Trading Networks object described in the Overwrite 
dialog box.
Yes to All 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. When you select Yes to All Trading Networks 
no longer displays the Overwrite dialog box for identically 
named items.
No Selecting No denies Trading Networks the permission to 
overwrite the Trading Networks object described in the 
Overwrite dialog box. Trading Networks does not import the 
item described in the Overwrite dialog box.
No to All 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. When you select No to All Trading Networks no 
longer displays the Overwrite dialog box for identically named 
items. No identically named items are imported.

webMethods Trading Networks Administrator’s Guide Version 7.1 476

 C. Exporting and Importing Database Information

Suppressing the Overwrite Dialog Box and Forcing the Overwrite of Items
If you want Trading Networks to automatically overwrite the matching items in the target 
database, select the Force Import check box on the Import Data dialog box. When you select 
the Force Import check box, Trading Networks does not display the Overwrite dialog box. 
It overwrites the matching items without prompting for confirmation.

Procedure for Importing Database Information from the

Console
To import database information, perform the following procedure.

To import database information

1 In Trading Networks Console: File > Import. 

Trading Networks displays the Import Data dialog box. 
2 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. Then, click Open. 
Trading Networks populates the Available Items list with the items contained in the file 
you select.
3 If you want Trading Networks to automatically import the items that match with 
those in the target database without prompting for confirmation, select the Force
Import check box. For more information, see “Importing Items that Match With Those 
in the Target System” on page 475 and “Suppressing the Overwrite Dialog Box and 
Forcing the Overwrite of Items” on page 477.
If you do not select the Force Import check box, see “Using the Overwrite Dialog Box” 
on page 476 for how to use the Overwrite dialog box.
4 If you want to import processing rules, and you want Trading Networks to replace all 
the existing processing rules in the target database with the processing rules that you 
import, select the Replace Processing Rule List check box. For more information, see 
“Procedure for Importing Database Information from the Console” on page 477.
5 Select the items that you want to import by moving items to the Selected Items list.
When you select one of the following types of items in the Available Items list, check the 
Dependencies to determine whether there are other items you should import as well.

Item For more information about dependencies, see...

Partner Data “Partner Data Dependencies” on page 463

Field Definitions “Field Definitions Dependencies” on page 465
Document Types “Document Type Dependencies” on page 466

webMethods Trading Networks Administrator’s Guide Version 7.1 477

 C. Exporting and Importing Database Information

Item For more information about dependencies, see...

Processing Rules “Processing Rules Dependencies” on page 468

Public Queues “Public Queues Dependencies” on page 472

6 Click OK.
Note: If there are any import errors, Trading Networks displays the Import Errors 
dialog. This dialog lists each item that has an error. To see more details of the error, 
select the item in the Name column. 

Using the tnexport and tnimport Utilities

In addition to exporting and importing data using the Trading Networks Console, you can 
export and import data using the command line utilities tnexport and tnimport. Run 
these utilities from the following directory:
webMethods7\IntegrationServer\packages\WmTN\bin

Use these utilities to perform a bulk transfer of data from one Trading Networks system to 
another.

tnexport Utility
Use the tnexport utility to export all objects of the selected types. For example, if you 
specify you want to export processing rules, all processing rules defined in the Trading 
Networks database are exported. 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. binfile is 

the path and file name to which you want to export the data. The 
directory in which you want the output file placed must already 
exist. If you specify a relative path, Trading Networks uses a 
directory relative to the directory from which you are running the 
tnexport utility. If the file already exists, Trading Networks 
overwrites it.
Note: Binary output is much smaller than the XML output, but 
cannot be read by humans.

webMethods Trading Networks Administrator’s Guide Version 7.1 478

 C. Exporting and Importing Database Information

-xml xmlfile Use the ‐xml option to export the data to an XML file. xmlfile is 

the path and file name to which you want to export the data. The 
directory in which you want the output file placed must already 
exist. If you specify a relative path, Trading Networks uses a 
directory relative to the directory from which you are running the 
tnexport utility. If the file already exists, Trading Networks 
overwrites it.

options is one or more of the following:

-attribs Indicates you want to export all the document attributes.
-types Indicates you want to export all the TN document types.
-rules Indicates you want to export all the processing rules.
-profiles Indicates you want to export all the profiles.
-extflds Indicates you want to export the values for the extended fields 
that are in the profiles.
-flddefs Indicates you want to export all the definitions for field groups 
and all the definitions for the profile fields in those groups.
-lkup Indicates you want to export all the definitions for contact 
types, external ID types, and profile groups that you might 
have added.
-queues Indicates you want to export all public and private queues.
-securityData Indicates the you want to export all certificate information from 
the Security tabs of all profile.
-tpas Indicates you want to export all the trading partner agreements 
(TPAs).
-dls Indicates that you want to export all the data permission rules 
that were defined in My webMethods.
-all Indicates that you want to export all objects, that is, all 
attributes, TN document types, processing rules, profiles, 
extended field values, profile field groups, field definitions, 
custom contact types, custom extended fields, public queue, 
and TPAs.

Examples
You want to export all profiles, all extended field values in the profiles, and all the 
extended field definitions to the XML file \TradingNetworks\ExportedData.xml. 
Use the following command line:
tnexport -xml \TradingNetworks\ExportedData.xml -profiles -extflds -flddefs

webMethods Trading Networks Administrator’s Guide Version 7.1 479

 C. Exporting and Importing Database Information

You want to export all data in the Trading Networks database to the binary file 
ExportedData.bin, and you want the utility to create the ExportedData.bin file in 
the same directory as where you are running the utility. Use the following command 
line:
tnexport -bin ExportedData.bin -all

tnimport Utility
Use the tnimport utility to import all data in a specified 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, you must reload the WmTN package to be able to 
use the imported data.

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. 

binfile is the path and file name of the binary file that 
contains the data to import. If you specify a relative path, 
Trading Networks looks for the directory relative to the 
directory from which you are running the tnimport utility.
-xml xmlfile Use the ‐xml option to import the data from an XML file. 
xmlfile is the path and file name of the XML file that 
contains the data to import. If you specify a relative path, 
Trading Networks looks for the directory relative to the 
directory from which you are running the tnimport utility.

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.
If you do not specify this option, the tnimport utility will 
only load and print information about the data in your file. 
This is useful for testing purposes.

webMethods Trading Networks Administrator’s Guide Version 7.1 480

 C. Exporting and Importing Database Information

-force Indicates whether you want the tnimport utility to 
overwrite existing data with the same ID or name that 
already exists in the Trading Networks database. This 
option only applies when importing document attributes, 
TN document types, profiles, profile field groups, profile 
field definitions, and TPAs.
If you do not specify this option and an object with the 
same ID or name already exists in the Trading Networks 
database, the import fails.
-replaceRuleList Indicates whether you want the tnimport utility to replace 
all the processing rules in the input file to the current list of 
processing rules. This applies only to importing processing 
rules.
If you do not specify this option, the tnimport utility 
replaces only the matching processing rules in the target 
system and appends the non‐matching processing rules to 
the existing list on the target system.

Examples
You want to import the data in the XML file \TradingNetworks\ExportedData.xml. 
You want the tnimport utility to overwrite objects that have the same ID or name as 
those in the input file, and you want to completely overwrite the matching processing 
rules and append the non‐matching processing rules to the current list. Use the 
following command line:
tnimport -xml \TradingNetworks\ExportedData.xml -db -force

You want to view information about the data in the input file ExportedData.bin that 
resides in the same directory as the tnimport utility. You do not want to import it into 
your database. Use the following command line:
tnimport -bin ExportedData.bin

You want to import all data in the binary file ExportedData.bin that resides in the 
same directory as the tnimport utility. You want the tnimport utility to replace all 
the existing list of processing rules in the target system with the imported processing 
rules. Use the following command line:
tnimport -bin ExportedData.bin -db -replaceRuleList

webMethods Trading Networks Administrator’s Guide Version 7.1 481

 C. Exporting and Importing Database Information

webMethods Trading Networks Administrator’s Guide Version 7.1 482

Appendix D. Trading Networks Configuration Properties

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

Updating Properties on the Server Settings Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

Alphabetical Listing of the Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484\

Cluster Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487

Database Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489

Database Query Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489

Debugging Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491

Document Archiving Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491

Document Delivery Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492

Document Validation Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493

Flat File Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494

Large Document Handling Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

Localization Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496

Performance Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497

Profile Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502

Task Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

Miscellaneous Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512

webMethods Trading Networks Administrator’s Guide Version 7.1 483

 D. Trading Networks Configuration Properties

Overview
You can update properties from My webMethods using the Administration > Integration > B2B Settings > 
Server Settings page. Updating properties on the Server Settings page changes the properties in the 
Trading Networks properties.cnf file. The properties.cnf file is located in the 
webMethods\IntegrationServer\packages\WmTN\config\ directory, where 
webMethods\IntegrationServer is the directory in which your Integration Server is installed.

Updating Properties on the Server Settings Page

Use the following procedure to update the properties on the Administration > Integration > B2B Settings > 
Server Settings page.
1 In My webMethods: Administration > Integration > B2B Settings > Server Settings.
2 If the property that you want to update is in the list, change its value.
3 If the property that you want to update is not in the list, create a new line by typing the property you 
want to add along with its value. Be sure to use the correct combination of upper‐ and lowercase 
letters.
4 Click Save.

Alphabetical Listing of the Properties

The following table lists all the Trading Networks properties that you can set along with a category for 
each property. Click on a property to view a description of that property. To view all properties within a 
category, click on the category name.

Property Category
tn.archive.archiveAfterDays Document Archiving Properties
tn.archive.deleteAfterDays Document Archiving Properties
tn.bam.monitoring.enable Miscellaneous Properties
tn.BigDocThreshold Large Document Handling Properties
tn.check.ambiguous.docs Miscellaneous Properties
tn.clean.routePipeline Performance Properties
tn.cluster.notifyCacheChange Cluster Properties
tn.cluster.notifyProfileAddUser Cluster Properties
tn.cluster.notifyPropertyChange Cluster Properties
tn.cluster.sync.remoteAliases Cluster Properties

webMethods Trading Networks Administrator’s Guide Version 7.1 484

 D. Trading Networks Configuration Properties

Property Category
tn.default.idType Profile Properties
tn.default.userCreation Profile Properties
tn.delivery.ftpTransferType Document Delivery Properties
tn.doc.saveAsDone Performance Properties
tn.doctype.includeHidden Miscellaneous Properties
tn.doc.validate.max_errs Document Validation Property
tn.export.deleted.profiles Profile Properties
tn.ff.contenttypes Flat File Property
tn.ism.stats.saveFrequency Miscellaneous Properties
tn.locale.country Localization Properties
tn.locale.language Localization Properties
tn.locale.variant Localization Properties
tn.mail.from Document Delivery Properties
tn.mail.onuserfail Miscellaneous Properties
tn.mail.subject Document Delivery Properties
tn.profile.EnableLogProfileChanges Profile Properties
tn.query.maxrows Database Query Properties
tn.query.threshold Database Query Properties
tn.receive.clearKeys Performance Properties
tn.receive.clearTNObjects Performance Properties
tn.recursion.max Miscellaneous Properties
tn.resubmit.return.bizdocs Performance Properties
tn.server.seq Miscellaneous Properties
tn.store.encoding Database Properties
tn.store.logsql Debugging Properties
tn.store.pool.stmt Performance Properties
tn.task.attempt.notPersisted Task Properties
tn.task.dbupdate.enableNotifications Task Properties
tn.task.dbupdate.retryEnabled Task Properties
tn.task.dbupdate.retrySweepTime Task Properties

webMethods Trading Networks Administrator’s Guide Version 7.1 485

 D. Trading Networks Configuration Properties

Property Category
tn.task.init.groupSize Task Properties
tn.task.init.pauseLength Task Properties
tn.task.maxRetries Task Properties
tn.task.notifyFailure Task Properties
tn.task.pauseOnMaxThreads Task Properties
tn.task.retryFactor Task Properties
tn.task.sweepTime Task Properties
tn.task.threadpool.pct Task Properties
tn.task.ttw Task Properties
tn.tmpdir Miscellaneous Properties
tn.tmpfile.time Miscellaneous Properties
tn.tpa.cacheSize Performance Properties
tn.transport.user Task Properties
tn.xml.cacheXQLQueryResults Performance Properties
tn.xml.xqlThreshold Large Document Handling Properties

webMethods Trading Networks Administrator’s Guide Version 7.1 486

 D. Trading Networks Configuration Properties

Cluster Properties
Set these properties to configure Trading Networks to run in a clustered environment. 
Note: If you are using Trading Networks in a cluster, be sure to set the tn.query.threshold property to ‐1.

tn.cluster.notifyCacheChange
Description: Controls whether an Integration Server will notify other servers in the cluster when a 
change occurs in any of the following: 
TN document types

processing rules

attributes

profile summaries

delivery services
Specify either true or false. If you specify true, use the tn.cluster.sync.remoteAliases 
property to specify the servers in the cluster that should be notified.
Default Value: true

Example: To configure Trading Networks so that it will not notify servers in the cluster, use the 
following: 
tn.cluster.notifyCacheChange=false

tn.cluster.notifyProfileAddUser
Description: Controls whether when a user account is created on one Integration Server in a 
cluster, the user account is also created on the other servers in the cluster. Specify 
either true or false. If you specify true, use the tn.cluster.sync.remoteAliases property 
to specify the servers in the cluster that should be notified.
Default Value: true

Example: To configure Trading Networks so that it will not automatically create user accounts 
on other servers in the cluster, use the following:
tn.cluster.notifyProfileAddUser=false

webMethods Trading Networks Administrator’s Guide Version 7.1 487

 D. Trading Networks Configuration Properties

tn.cluster.notifyPropertyChange
Description: Controls whether when you update the Trading Networks properties on one 
Integration Server in a cluster that the Trading Networks properties are updated on 
the other servers in the cluster. Specify either true or false. If you specify true, use 
the tn.cluster.sync.remoteAliases property to specify the servers in the cluster that should 
be notified. 
Default Value: true

Example: To configure Trading Networks so that it will not automatically update properties on 
all servers in the cluster, use the following:
tn.cluster.notifyPropertyChange=false

tn.cluster.sync.remoteAliases
Description: Specifies the remote server aliases for the other servers in the cluster.
Default Value: No default; if you do not provide a value, Trading Networks cannot notify other 
servers when there are changes. 
Example: If you have two servers, Server1 and Server2, running in a cluster, you must create a 
remote server alias for Server1 on Server2, and a remote server alias for Server2 on 
Server1. For example, the tn.cluster.sync.RemoteAliases property for Server1 would 
look like the following: 
tn.cluster.sync.remoteAliases=Server2

If you have more than two Integration Servers (for example, Server1, Server2, and 
Server3) running in a cluster, separate the remote server aliases with a comma. For 
example, the tn.cluster.sync.RemoteAliases property for Server 1 in this instance 
would look like the following: 
tn.cluster.sync.remoteAliases=Server2,Server3 

webMethods Trading Networks Administrator’s Guide Version 7.1 488

 D. Trading Networks Configuration Properties

Database Properties

tn.store.encoding
Description: Identifies the encoding that your database is using. When a string is passed to an 
INSERT or UPDATE statement and that string is too long to fit into a column, 
Trading Networks uses value of this property to determine where to truncate the 
string.
Default Value: No default. If you do not specify a value, Trading Networks uses the default system 
encoding.
Example: To indicate that your database uses the AL32UTF8 encoding, specify the following: 
tn.store.encoding=AL32UTF8

Database Query Properties

tn.query.maxrows
Description: Specifies the default number of rows that the query services return. The query 
services are services in the wm.tn.query folder. An input variable to the query services 
allows you to specify a maximum number of rows that you want returned from a 
query. However, if you do not specify the number of rows to return when you invoke 
a query service, the query service uses the value you specify for this property. If a 
query returns more row than allowed by this property, the query service silently 
drops the rows that exceed the value you specify.
Default Value: 0 (This value means there is no maximum.)
Example: If you want to set the default value for the number of rows a query service returns to 
500, specify the following:
tn.query.maxrows=500

webMethods Trading Networks Administrator’s Guide Version 7.1 489

 D. Trading Networks Configuration Properties

tn.query.threshold
Description: The number of rows of query results that Trading Networks stores in the session 
object.
You can have Trading Networks store query results in the session object to optimize 
query execution. Trading Networks stores the number of rows that you specify in the 
session object on the server and uses the caching component to store the remaining 
rows of query results. This caching component stores these results in files in the 
location identified by the tn.tmpdir property. Trading Networks uses this property for 
all queries that you perform from My webMethods and the Console, for example, 
queries for documents, tasks, and activity logs. In addition, this is the default for 
queries that you perform using the built‐in services in the wm.tn.query folder. For more 
information about the built‐in service in the wm.tn.query folder, see the webMethods 
Trading Networks Built‐in Services Reference.
If you are using Trading Networks in a cluster, Trading Networks should not store 
query results in the session object. To prevent Trading Networks from storing query 
results in the session object, set this property to –1. 
If you are not using Trading Networks in a cluster, for best performance, this setting 
should be the page size you use for query results. Trading Networks uses a page size 
of 50 for queries performed through the Console. 
Default Value: 50

Example: To indicate that you do not want Trading Networks to store query results in a session 
object because you are using Trading Networks in a cluster, specify the following: 
tn.query.threshold=-1

webMethods Trading Networks Administrator’s Guide Version 7.1 490

 D. Trading Networks Configuration Properties

Debugging Properties

tn.store.logsql
Description: Specifies whether you want Trading Networks to write each SQL statement to the log 
as it executes the statement. Writing the SQL statements to the log will cause the 
server to run more slowly. You should only use this feature when in a development 
environment and not in a production environment. Specify true to have Trading 
Networks write the SQL statements to the log or false to prevent Trading Networks 
from writing the SQL statements to the log.
Note: To view the SQL statements in the server log, you must have the detail level for 
your server log set to 9 or higher. You specify the level of detail you want to view in 
the server log using the -debug startup option when you start the Integration Server.
Default Value: false

Example: If you are running in a development environment and want Trading Networks to 
write the SQL statements to the log, specify the following:
tn.store.logsql=true

Document Archiving Properties

tn.archive.archiveAfterDays
Description: The number of days after Trading Networks receives a document that Trading 
Networks should archive the document. Specify a number from 0 through 730365. If 
you omit this property or specify 0 for this property, Trading Networks does not 
archive documents.
Default Value: No default. If you omit this property, Trading Networks does not archive documents.
Example: To archive documents 30 days after they are received, add the following: 
tn.archive.archiveAfterDays=30

webMethods Trading Networks Administrator’s Guide Version 7.1 491

 D. Trading Networks Configuration Properties

tn.archive.deleteAfterDays
Description: The number of days after Trading Networks receives the document that Trading 
Networks should delete the document. Specify a number from 0 through 730365. If 
you omit this property or specify 0 for this property, Trading Networks does not 
delete documents. 
Default Value: No default. If you omit this property, Trading Networks does not delete documents.
Example: To delete documents 60 days after they are received, add the following:
tn.archive.deleteAfterDays=60

Document Delivery Properties

tn.delivery.ftpTransferType
Description: Controls the transfer type for FTP delivery of documents. Specify active if you want 
to use active mode FTP to deliver documents. Specify passive if you want to use 
passive mode FTP.
Default Value: passive

Example: If you want to use active mode FTP to deliver documents, specify the following:
tn.delivery.ftpTransferType=active

tn.mail.from
Description: 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).
Default Value: No default.
Example: If you want the e‐mail messages to use the “from” e‐mail address 
[email protected], specify the following:
[email protected]

webMethods Trading Networks Administrator’s Guide Version 7.1 492

 D. Trading Networks Configuration Properties

tn.mail.subject
Description: The subject line you want Trading Networks to use 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).
Default Value: By default, Trading Networks does not specify a subject line in e‐mail messages.
Example: If you want the e‐mail messages to use the subject line “Document from IFC”, specify 
the following:
tn.mail.subject=Document From IFC

Document Validation Property

tn.doc.validate.max_errs
Description: The maximum number of errors that Trading Networks returns when errors occur 
when validating a document. If the structure of a document is not valid, the 
validation service can return many error messages. Set this property to limit the 
number of returned error messages.
Default Value: 10

Example: To limit the number of errors to 20, specify the following: 
tn.doc.validate.max_errs=20

webMethods Trading Networks Administrator’s Guide Version 7.1 493

 D. Trading Networks Configuration Properties

Flat File Property

tn.ff.contenttypes
Description: The content types you want the Integration Server to associate with flat file 
documents. Use this property to register content types for flat file documents. To set 
this property, specify a comma‐separated list of all the content types you want the 
Integration Server to treat as flat files. 
If you do not include this property in the properties.cnf file, by default the 
Integration Server treats documents with the content type text/plain as flat files. 
You cannot register the following content types as flat files: 
application/x‐www‐form‐urlencoded 

text/xml 

application/x‐wmrpc2 

application/x‐x509v3‐bin 

application/x‐wmrpc 

application/x‐wmrpc‐bin 

application/x‐wmidatabin 

application/wm‐soap 

application/soap 

application/soap+xml
Default Value: text/plain

Example: If you want the Integration Server to treat documents with the content types 
text/plain, text/csv, text/richtext, and multipart/digest as flat files, specify the 
following:
tn.ff.contenttypes=text/plain,text/csv,text/richtext,multipart/digest

webMethods Trading Networks Administrator’s Guide Version 7.1 494

 D. Trading Networks Configuration Properties

Large Document Handling Properties

Set these properties to configure Trading Networks to handle large documents.

tn.BigDocThreshold
Description: The threshold size at which Trading Networks should consider a document to be 
large.
Possible Values: ‐n, any negative whole number indicating that Trading Networks considers no 
documents as large. Trading Networks processes all documents in the traditional 
manner, reading the document content into memory during processing.
0, indicating that Trading Networks considers all documents large. Because all 
documents that Trading Networks receives contain more than 0 bytes, Trading 
Networks uses large document handling for all documents.
n, any positive whole number indicating the number of bytes over which Trading 
Networks considers a document to be large.
Default Value: -1, indicating that Trading Networks considers no documents to be large.
Example: If you want Trading Networks to consider all documents over 1,000,000 bytes to be 
large, set this property to 1000000:
tn.BigDocThreshold=1000000

tn.xml.xqlThreshold
Description: Determines the maximum number of bytes that Trading Networks reads into 
memory from the start of an XML document to perform the XQL queries that are 
defined in a TN XML document type. The XQL queries can be identifying queries or 
queries to extract attributes. In your TN document types, if you have XQL queries 
that point to nodes beyond the number of bytes that Trading Networks reads, the 
queries will fail. For more information about queries in TN document types, see the 
Chapter 14, “Defining and Managing TN XML Document Types”. 
Specify a positive whole number greater than 1000. If you specify a value less than 
1000, Trading Networks reads 1000 bytes.
Default Value: If tn.xml.xqlThreshold is not defined, Trading Networks uses the value of 
tn.BigDocThreshold. 
Example: If you want Trading Networks to read in 50,000 bytes to perform the XQL queries in 
TN XML documents, specify the following: 
tn.xml.xqlThreshold=50000

webMethods Trading Networks Administrator’s Guide Version 7.1 495

 D. Trading Networks Configuration Properties

Localization Properties
Use the localization properties to change the server’s locale. When you change the locale, Trading 
Networks displays error messages and screen labels using the language that is associated with the locale. 
To display the messages and screen labels in the language, Trading Networks must have the appropriate 
resource bundle. These resource bundles reside in the tncore.zip file, which was copied to your system 
during installation. If you change the locale but the resource bundle does not exist for that locale, Trading 
Networks attempts to find the best match. For information about how Trading Networks selects the 
resource bundle that matches best, see Sun® Microsystems’ documentation for the 
java.util.ResourceBundle class. By default, Trading Networks uses the locale of the host machine. 
To change the locale you must set, at a minimum, the tn.locale.language and tn.locale.country properties. If you 
do not specify both of these properties, Trading Networks continues to use the default locale (the locale of 
the host machine).

tn.locale.language
Description: The two‐letter ISO 639 language code for the language you want Trading Networks 
to use for messages and screen labels. 
Example: The two‐letter ISO 639 language code for the French language is “fr”. To set this 
property to identify the French language, specify:
tn.locale.language=fr

tn.locale.country
Description: The two letter ISO 3166 country code for the country that is associated with the 
language.
Example: The two‐letter ISO 3166 country code for Canada is “CA”. If you want to localize for 
the French language in Canada, set tn.locale.language to ʺfrʺ (as shown above) and 
set tn.locale.country to ʺCAʺ:
tn.locale.country=CA

webMethods Trading Networks Administrator’s Guide Version 7.1 496

 D. Trading Networks Configuration Properties

tn.locale.variant
Description: A variant code that further distinguishes the locale, if necessary. Typically you use 
the variant code if there is a difference based on the platform on which the server is 
running. If you need to specify more than one variant code, separate them with an 
underscore, placing the most important codes first. 
For more information about variant codes, see the Sun Microsystems’ documentation 
for the java.util.Locale class.
Example: You might specify a variant code because of font differences between platforms. If 
you are running on UNIX, you might set the variant code to UNIX:
tn.locale.variant=UNIX

Performance Properties

tn.clean.routePipeline
Description: Removes some of the contents of the pipeline when a document is routed. If set to 
true, this property removes all data from the pipeline except bizdoc, rule, TN_parms, 
and $tnReprocess. Setting this property to true can help prevent the pipeline from 
growing very large, which could affect system performance. 
Default Value: false

Example: If you want Trading Networks to remove some of the contents of the pipeline when a 
document is routed, specify the following:
tn.clean.routePipeline=true

webMethods Trading Networks Administrator’s Guide Version 7.1 497

 D. Trading Networks Configuration Properties

tn.doc.saveAsDone
Description: When Trading Networks originally receives a document, it saves information about 
the resulting BizDocEnvelope for that document to the database. When it saves the 
BizDocEnvelope to the database, it sets the status of the BizDocEnvelope. Based on 
this property, Trading Networks can set the status of the BizDocEnvelope to one of 
the following: 
NEW If you set this property to false, Trading Networks sets the status of the 
BizDocEnvelope to NEW. This status means that Trading Networks has received 
the document, but not yet processed it.
DONE If you set this property to true, Trading Networks sets the status of the 
BizDocEnvelope to DONE. Typically, the DONE status means that Trading 
Networks has completed processing the document. However, you can use this 
property to have Trading Networks immediately set the status to DONE. This 
saves a database update per document if Trading Networks completes 
processing of the document normally with no errors.
Important! If the server ends unexpectedly while processing a document, upon server 
restart, because the status is already DONE, processing of the document will appear 
to be complete. There is a risk that the document might not be processed completely.
Default Value: false (This value means that new BizDocEnvelopes are saved with the NEW status.)
Example: If you want Trading Networks to immediately set the status of a BizDocEnvelope to 
DONE, specify the following: 
tn.doc.saveAsDone=true

webMethods Trading Networks Administrator’s Guide Version 7.1 498

 D. Trading Networks Configuration Properties

tn.receive.clearKeys
Description: Specifies the pipeline variables that represent Trading Networks objects that you 
want Trading Networks to drop from the pipeline when the tn.receive.clearTNObjects 
property is set to true. Specify a comma‐separated list naming the pipeline variables 
that you want Trading Networks to drop. Do not use spaces in the list. Your list can 
contain the following Trading Networks objects: 
node

bizdoc

sender

receiver

flags

ffdata

TN_parms
If you specify a pipeline variable other than the ones listed above, Trading Networks 
ignores it, and Trading Networks will not drop the variable.
Default Value: null (which means no variables appear in the pipeline)
Example: If you want Trading Networks to drop the pipeline variables node, flags, and ffdata, 
specify the following: 
tn.receive.clearKeys=node,flags,ffdata

tn.receive.clearTNObjects
Description: Specifies whether you want Trading Networks to drop pipeline variables that 
represent Trading Networks objects. Trading Networks drops the pipeline variables 
after it completes the execution of the wm.tn:receive entry point service.
You specify the pipeline variables to drop using the tn.receive.clearKeys property. 
Dropping these objects reduces the time it takes to process each document and 
improves the overall performance of the server because the content handler does not 
have to format the objects for return to the client.
Specify true if you want Trading Networks to drop the objects; specify false if you 
do not want Trading Networks to drop the objects.

webMethods Trading Networks Administrator’s Guide Version 7.1 499

 D. Trading Networks Configuration Properties

Default Value: true

Example: If you do not want Trading Networks to drop the Trading Networks objects, specify 
the following:
tn.receive.clearTNObjects=false

tn.store.pool.stmt
Description: Specifies whether you want Trading Networks to cache SQL statements in memory 
rather than read them from WmTN/config/dbops.sql. Specify true to have Trading 
Networks cache SQL statements; specify false to have Trading Networks read SQL 
statements from a file.
Default Value: true

Example: If you want Trading Networks to read SQL statements from 
WmTN/config/dbops.sql, specify the following: 
tn.store.pool.stmt=false

tn.resubmit.return.bizdocs
Description: Specifies whether you want the wm.tn.doc:resubmit and wm.tn.doc:resubmits services to 
return BizDocEnvelopes in the pipeline.
You use the wm.tn.doc:resubmit and wm.tn.doc:resubmits services to resubmit documents 
that are in the Trading Networks database for processing. When you resubmit a 
document, Trading Networks has a BizDocEnvelope for the original document that 
was in the database and forms an additional BizDocEnvelope for the new instance of 
the document being resubmitted. This property controls whether the 
wm.tn.doc:resubmit and wm.tn.doc:resubmits services leave these BizDocEnvelopes in the 
pipeline when returning to the caller. Performance is improved if the 
BizDocEnvelopes are not returned in the pipeline. For more information about the 
wm.tn.doc:resubmit and wm.tn.doc:resubmits services, see the webMethods Trading Networks 
Built‐in Services Reference.
Specify false if you do not want the BizDocEnvelopes returned in the pipeline; 
specify true if you do want the BizDocEnvelopes returned in the pipeline.
Default Value: false

Example: If you want the wm.tn.doc:resubmit and wm.tn.doc:resubmits services to return the 
BizDocEnvelopes in the pipeline, specify the following:
tn.resubmit.return.bizdocs=true

webMethods Trading Networks Administrator’s Guide Version 7.1 500

 D. Trading Networks Configuration Properties

tn.tpa.cacheSize
Description: Specifies the maximum number of trading partner agreements (TPAs) that Trading 
Networks caches in memory. Trading Networks only caches TPAs that have an 
Agreed status. Caching TPAs speeds up the run‐time retrieval of TPAs; however, it 
also increases the amount of memory used by the server.
Default Value: 1000

Example: If you want Trading Networks to cache 1500 TPAs, specify the following: 
tn.tpa.cacheSize=1500

tn.xml.cacheXQLQueryResults
Description: Specifies whether Trading Networks should save and reuse the results of XQL 
queries executed against an XML document while attempting to match that XML 
document to an TN XML document type. 
During document recognition, Trading Networks attempts to locate a single TN 
document type that the inbound document matches. For an XML document, the TN 
XML document types can contain XQL queries that Trading Networks performs to 
determine whether the XML document contains a specific node and optionally 
whether that node contains a specific value. Several of your TN XML document 
types might use the same XQL queries. Each time the XQL query is executed, it 
would produce the same result for the inbound XML document. 
Specify true for this property to have Trading Networks perform each unique XQL 
query only a single time and save the results for subsequent TN XML document 
types that might use the same XQL query. Specify false if you want Trading 
Networks to perform all XQL queries in each TN XML document type whether they 
have previously been executed for the document or not.
Default Value: true
Example: If you want Trading Networks to execute all XQL queries in all TN XML document 
types even if some of the XQL queries might have already been performed against 
the document being processed, specify the following: 
tn.xml.cacheXQLQueryResults=false

webMethods Trading Networks Administrator’s Guide Version 7.1 501

 D. Trading Networks Configuration Properties

Profile Properties

tn.default.idType
Description: The external ID type (e.g., D‐U‐N‐S® number) that Trading Networks initially 
displays when creating or editing a profile in My webMethods and the Console. For 
example, when you add a profile in My webMethods and click Add ID on the External
IDs tab, Trading Networks makes the external ID type that you identify using this 
property as the selected item in the ID Type list.
When creating a profile from the Console, this property also works in conjunction 
with the tn.default.userCreation property, which determines whether Trading Networks 
will create an Integration Server user account for a profile created from the Console.
Default Value: DUNS

By default, Trading Networks displays the DUNS ID type.
Example: If you want Trading Networks to use the Mutually Defined external ID for the 
default ID type, specify the following:
tn.default.idType=Mutually Defined

tn.default.userCreation
Description: Whether you want Trading Networks to create an Integration Server user account 
when you define a profile in Trading Networks Console. When this property is true, 
Trading Networks automatically creates an Integration Server user account when a 
new partner profile is created from Console. The user name of the account is set to 
the value of the new partnerʹs external ID identified by the tn.default.idType property. 
For example, if the tn.default.idType is set to DUNS and the D‐U‐N‐S number in the 
profile that you are adding is 987654321, Trading Networks will create an Integration 
Server user account where the user name is ʺ987654321ʺ.
Note: Functionality to create and manage profiles in Trading Networks Console is 
deprecated. 
Note: If you have Trading Networks create anIntegration Server user account, the 
value of the external ID cannot contain blank spaces because blank spaces are invalid 
in an Integration Server user account user name. 
Specify either true if you want Trading Networks to create an Integration Server 
user account when you define a profile in the Console, or false if you do not.

webMethods Trading Networks Administrator’s Guide Version 7.1 502

 D. Trading Networks Configuration Properties

Default Value: false

By default, Trading Networks does not create an Integration Server user account 
when you define a profile from Trading Networks Console.
Example: If you want Trading Networks to create an Integration Server user account when 
defining profiles from Trading Networks Console:
tn.default.userCreation=true

tn.export.deleted.profiles
Description: Displays deleted profiles in the Export Data dialog box. Specify true or false.
Default Value: false 

When the value for this property is false, Trading Networks does not display the 
deleted profiles.
Example: If you want Trading Networks to display the deleted profiles in the Export Data 
dialog box, specify the following:
tn.export.deleted.profiles=true

tn.profile.EnableLogProfileChanges
Description: Whether you want Trading Networks to log profile auditing information to the 
activity log when you manage profiles from My webMethods. This property also 
controls whether you want to log actions related to role‐based access.
If profile logging is enabled, when you manage profiles using My webMethods, 
Trading Networks logs changes that you make to profile components, for example 
addresses, contacts, delivery methods, etc. Trading Networks logs activity log entries 
when you add, update, and/or delete profile components.
Similarly, when you use My webMethods to manage data permissions and general 
functional permissions, Trading Networks logs changes that you make.
Note: This property affects only profile actions you take from My webMethods. It has 
no affect for actions taken from Trading Networks Console.
Default Value: false

When you specify false, Trading Networks does not log profile and role‐based 
access auditing information.
Example: If you want Trading Networks to log profile and role‐based access auditing 
information, specify the following:
tn.profile.EnableLogProfileChanges=true

webMethods Trading Networks Administrator’s Guide Version 7.1 503

 D. Trading Networks Configuration Properties

Task Properties

tn.task.attempt.notPersisted
Description: For Trading Networks to use reliable service execution for a document, the 
document must be saved. If a processing rule is executed that is configured to 
perform reliable service execution, and the document has not been saved, this 
property determines whether to attempt a single asynchronous execution of the 
service.
Default Value: true

When you specify true, the service is executed once, asynchronously; otherwise the 
service will not be executed.
Example: If you want Trading Networks to attempt to execute a service on a document that is 
not persisted, specify the following:
tn.task.attempt.notPersisted=true

tn.task.dbupdate.enableNotifications
Description: Controls whether you want Trading Networks to publish an IS document (i.e., raise 
an Integration Server event) when it attempts to update the database for a task after a 
database failure condition occurs.
You can use webMethods Developer to define a trigger that subscribes to the IS 
document and takes appropriate actions. For more information about creating 
triggers, see the Publish‐Subscribe Developer’s Guide.
Specify either true or false for this property. If you specify true, Trading Networks 
publishes an IS document. Trading Networks publishes an IS document each time it 
retries to update the database, whether the attempt was successful or failed. The IS 
document that Trading Networks publishes is in the format defined by the 
wm.tn.rec:TaskDbUpdate IS document type. For more information about the 
wm.tn.rec:TaskDbUpdate IS document type, see the webMethods Trading Networks Built‐in 
Services Reference.
Default Value: false

Example: If you want Trading Networks to publish an IS document when it attempts to update 
the database for a task after a database failure, specify the following:
tn.task.dbupdate.enableNotifications=true

webMethods Trading Networks Administrator’s Guide Version 7.1 504

 D. Trading Networks Configuration Properties

tn.task.dbupdate.retryEnabled
Description: Controls whether Trading Networks tries to update the database again after it 
encounters a database failure when trying to update the information for a task.
If Trading Networks encounters an error when attempting to update the information 
for a task, for example because it lost connectivity to the database, the information 
that Trading Networks is maintaining in memory for the task will not match the 
information stored in the database. If the server is shut down, the task information 
will be incorrect upon server restart.
If you want Trading Networks to continuously attempt to retry updating the 
database until the update is successful or until the server shuts down, specify true; 
otherwise specify false.
Default Value: true

Example: If you do not want Trading Networks to continuously attempt to retry updating the 
database when it encounters a database failure, specify the following:
tn.task.dbupdate.retryEnabled=false

tn.task.dbupdate.retrySweepTime
Description: The number of seconds between attempts to retry updating the database information 
for a task.
Trading Networks only uses this property when the tn.task.dbupdate.retryEnabled 
property is true.
Default Value: 300

Example: If you want Trading Networks to retry updating the database every 600 seconds (10 
minutes), specify the following:
tn.task.dbupdate.retrySweepTime=600

webMethods Trading Networks Administrator’s Guide Version 7.1 505

 D. Trading Networks Configuration Properties

tn.task.init.groupSize
Description: Specifies the number of tasks that Trading Networks processes at one time during 
server startup. Trading Networks uses a background thread during startup to read 
the task data from the database and create the tasks in groups. The number of tasks 
in a group is the value you specify for this property. After creating a group of tasks, 
Trading Networks pauses for the amount of time specified by the 
tn.task.init.pauseLength property. By pausing between groups, this makes CPU cycles 
available to other Integration Server functions that are initializing during startup. 
This improves performance when starting Trading Networks when there are many 
pending tasks.
Default Value: 100

Example: To have Trading Networks process 75 tasks at a time during startup, specify the 
following:
tn.task.init.groupSize=75

tn.task.init.pauseLength
Description: Specifies the number of seconds that Trading Networks pauses between processing 
groups of tasks during server startup. Trading Networks uses a background thread 
during startup to read the task data from the database and create the tasks in groups. 
The number of tasks in a group is the value you specify for the tn.task.init.groupSize 
property. After creating a group of tasks, Trading Networks pauses for the amount of 
time specified by this property. By pausing between groups, this makes CPU cycles 
available to other Integration Server functions that are initializing during startup. 
This improves startup performance when starting Trading Networks when there are 
many pending tasks.
Default Value: 10 (seconds)
Example: To have Trading Networks pause for 15 seconds between the groups of tasks that it 
processes during startup, specify the following:
tn.task.init.pauseLength=15

webMethods Trading Networks Administrator’s Guide Version 7.1 506

 D. Trading Networks Configuration Properties

tn.task.maxRetries
Description: The number of times you want Trading Networks to attempt to re‐execute a service 
when it is executing the service using reliable execution and the service fails. Specify 
a whole number.
Default Value: 5

Example: If you want Trading Networks to attempt to re‐execute a service three times, specify 
the following:
tn.task.maxRetries=3

tn.task.notifyFailure
Description: Controls whether you want Trading Networks to publish an IS document (i.e., raise 
an Integration Server event) when a task fails.
You can use the webMethods Developer to define a trigger that subscribes to the IS 
document and takes appropriate actions. For more information about creating 
triggers, see the Publish‐Subscribe Developer’s Guide.
The IS document that Trading Networks publishes is in the format defined by the 
wm.tn.rec:TaskFailure IS document type. For more information about the 
wm.tn.rec:TaskFailure IS document type, see the webMethods Trading Networks Built‐in 
Services Reference.
To have Trading Networks publish an IS document when a task fails, specify true; 
otherwise, specify false.
Default Value: false

Example: If you want Trading Networks to publish an IS document to notify you of failed 
tasks, specify the following:
tn.task.notifyFailure=true

webMethods Trading Networks Administrator’s Guide Version 7.1 507

 D. Trading Networks Configuration Properties

tn.task.pauseOnMaxThreads
Description: Specifies the number of milliseconds that Trading Networks pauses when the task 
manager runs out of threads. You control the number of threads that the task 
manager is allocated using the tn.task.threadpool.pct property. If the number of threads 
specified by the tn.task.threadpool.pct property are in use and Trading Networks has 
more tasks to process, Trading Networks pauses the number of milliseconds 
specified by this property to allow some of the working threads to complete and 
become available.
Default Value: 500 (milliseconds)
Example: If you want Trading Networks to pause for 750 milliseconds when the task manager 
runs out of threads, specify the following:
tn.task.pauseOnMaxThreads=750

tn.task.retryFactor
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 a service that Trading 
Networks is executing using reliable execution.
Trading Networks calculates the time to wait by multiplying the last wait time by 
tn.task.retryFactor. Specify a whole number greater than zero for tn.task.retryFactor.
Example: The following shows sample values for the reliable execution properties and how they 
affect the wait times between attempts to re‐execute a failed service.
tn.task.maxRetries=3
tn.task.ttw=10000
tn.task.tn.task.retryFactor=2
Retry 1 Retry 2 Retry 3

Wait until next attempt: 10000 ms 20000 ms 40000 ms

webMethods Trading Networks Administrator’s Guide Version 7.1 508

 D. Trading Networks Configuration Properties

tn.task.sweepTime
Description: The number of seconds the reliable task manager thread remains idle before checking for 
tasks it needs to perform (for example, a task to deliver a document or execute a service).
The task manager thread becomes idle when all tasks are completed, failed, or in the 
wait period between attempts. 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. 
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.
The minimum allowable value for this property is 1 second. If you attempt to set this 
property to a value less than 1 second, the new value will be ignored. In other words, if 
you set tn.task.sweepTime to any value below 1 second, the task manager remains idle 
for 1 second before checking for tasks it needs to perform.
Note: The task manager wakes up immediately when a new task arrives.
The value of tn.task.sweepTime can affect how long Trading Networks waits between 
attempts to retry a task. Typically, the wait between retries value is governed by one of 
the following:
Type of task Wait between retries is governed by …

Delivery The Wait between retries value specified in the delivery settings of 

the receiving partner’s profile. 
Service of execution The tn.task.ttw property.
However, Trading Networks could wait as long as the tn.task.sweepTime. If the task 
manager thread is idle when the wait between retries value expires, the task manager 
thread will not wake up to process the task until the tn.task.sweepTime expires.
Default Value: 300

Example: To set the sweep time to 500 seconds, specify the following:
tn.task.sweepTime=500

webMethods Trading Networks Administrator’s Guide Version 7.1 509

 D. Trading Networks Configuration Properties

tn.task.threadpool.pct
Description: Controls the percentage of the Integration Server’s pool of threads that the task 
manager can use to process tasks simultaneously. This is to prevent the task manager 
from consuming all Integration Serverr threads when the task manager has a large 
number of tasks to process.
Possible property values can range from .2 to .8. If you set the property value less 
than the range, the task manager ignores the value and takes the lowest value of the 
range, or .2. If you set the property value greater than the range, the task manager 
ignores the value and takes the greatest value of the range, or .8. No matter how 
small you set the property value, the task manager is guaranteed to always have at 
least one thread with which to execute tasks.
Default Value: .5

tn.task.ttw
Description: The number of milliseconds you want Trading Networks to wait before making its 
first attempt to re‐execute a failed service when Trading Networks is executing the 
service using reliable execution. (Trading Networks uses this setting along with 
tn.task.retryFactor to calculate how long to wait for subsequent retry attempts.)
Default Value: 300

Example: If you want Trading Networks to wait 500 milliseconds after a service fails before 
making the first attempt to re‐execute the service, specify the following:
tn.task.ttw=500

webMethods Trading Networks Administrator’s Guide Version 7.1 510

 D. Trading Networks Configuration Properties

tn.transport.user
Description: The user account to use to invoke a service that Trading Networks is executing 
reliably due to a processing action in a processing rule. This affects the user account 
used to invoke the built‐in delivery services (which are in the wm.tn.transport folder), 
custom delivery services that you create, and services invoked by service execution 
tasks.
To have Trading Networks use the currently connected user to invoke services, do 
not supply a value for the tn.transport.user property. By default, Trading Networks 
will use the currently connected user to invoke services. This is the user that 
submitted the document to Trading Networks, unless you are resubmitting or 
reprocessing a document. When you resubmit or reprocess a document, the current 
user is the user issuing the resubmit or reprocess.
If you want Trading Networks to use a user account other than the currently 
connected userʹs account, use this property to specify the user name. If you want an 
Administrator account to execute services from processing rules, specify 
Administrator. Some Integration Server administrators might delete the built‐in 
Administrator account and create a new one with a different name. If 
tn.transport.user is Administrator, Trading Networks will use an account from the 
Administrators group, though it might not be the built‐in Administrator account.
Important! Ensure that the ACL you use to protect the service grants Execute access to 
the user you specify.
Default Value: No default. Trading Networks will use the currently‐connected user to invoke 
services fro processing rules.

webMethods Trading Networks Administrator’s Guide Version 7.1 511

 D. Trading Networks Configuration Properties

Miscellaneous Properties

tn.bam.monitoring.enable
Description: Whether you want Trading Networks documents to be monitored by webMethods 
Optimize.
Rather than updating the properties.cnf file, you can set this property to true or 
false using the Administration > Integration > B2B > Business Monitoring page in 
My webMethods. The settings on that page determine which documents and 
document attributes the system monitors.
Important! To enable analysis of Trading Networks documents, in addition to setting 
this property to true, you must also set the Integration Server 
watt.server.optimize.monitoring property to true.
Note: You can only configure TN document types for monitoring when this property 
is set to true. For more information about how to configure TN document types, see 
the Chapter 5, “Setting up Analysis of Trading Networks Transaction Data”. For 
more information about viewing monitoring data for Trading Networks documents, 
see the webMethods Trading Networks User’s Guide.
Default Value: false

When you specify false, analysis information is not collected for TN document 
types.
Example: If you want to enable analysis of TN documents, specify the following:
tn.bam.monitoring.enable=true

webMethods Trading Networks Administrator’s Guide Version 7.1 512

 D. Trading Networks Configuration Properties

tn.check.ambiguous.docs
Description: Determines whether Trading Networks searches through all TN document types to 
find a matching TN document type or uses the first match. 
By default, Trading Networks searches through all TN document types to find a 
single TN document type to use for the incoming document. If it finds multiple TN 
document types that match it considers the document to be an unknown document 
because it does not know which TN document type to use. 
However, you can use this property to configure Trading Networks to stop looking 
for TN document types after it finds the first match and uses the first matching TN 
document type for the incoming document.
Default Value: true

Example: If you want Trading Networks to use the first TN document type it finds that 
matches an incoming document and not check through all TN document types, 
specify the following: 
tn.check.ambiguous.docs=false

tn.doctype.includeHidden
Description: Determines whether the wm.tn.doctype:list service returns the built‐in TN document 
types. You can override this property when you invoke the wm.tn.doctype:list service by 
using the includeHidden input variable.
Because the Trading Networks Console uses the wm.tn.doctype:list to retrieve the list of 
TN document types, this property also controls whether to show or hide the built‐in 
TN document types in the Trading Networks Console.
Specify true if you want the wm.tn.doctype:list service to return the built‐in TN 
document types and therefore also show them in the Trading Networks Console. 
Specify false if you do not want the wm.tn.doctype:list service to return the built‐in TN 
document types and therefore hide them in the Trading Networks Console.
Default Value: true

Example: If you do not want the wm.tn.doctype:list service to return the built‐in TN document 
types and want to hide the built‐in TN document types in the Trading Networks 
Console, specify the following:
tn.doctype.includeHidden=false

webMethods Trading Networks Administrator’s Guide Version 7.1 513

 D. Trading Networks Configuration Properties

tn.ism.stats.saveFrequency
Description: Specifies how frequently (in seconds) you want Trading Networks to save document 
processing statistics to the database. You can view these statistics using My 
webMethods.
Default Value: 30 (seconds)
Example: If you want Trading Networks to save document processing statistics to the database 
every 45 seconds, specify the following:
tn.ism.stats.saveFrequency=45

tn.mail.onuserfail
Description: Whether you want Trading Networks to send an e‐mail message to the Server 
Administrator to alert the administrator of the following errors:
Sender of the document is not the same as the current user

Trading Networks has no profile for current user

Trading Networks was unable to retrieve the profile summary for the sender

Senderʹs profile is Inactive, which does not allow for sending documents

Senderʹs profile has been deleted

Internal exception prevented processing from completing
Specify true if you want Trading Networks to send the alert e‐mail messages. 
Otherwise, specify false. 
Default Value: false

Example: If you want Trading Networks to send alert e‐mail messages for the above error 
conditions, specify the following: 
tn.mail.onuserfail=true

webMethods Trading Networks Administrator’s Guide Version 7.1 514

 D. Trading Networks Configuration Properties

tn.recursion.max
Description: The maximum number of successive times that Trading Networks can use a 
processing rule for a specific document. If Trading Networks attempts to recursively 
use a processing rule more times than the number you specify for this property, 
Trading Networks aborts processing of the document.
Trading Networks recursively uses a processing rule if the processing rule uses the 
Execute a Service processing action to synchronously invoke a service that calls the 
wm.tn:submit service to submit the same BizDocEnvelope to Trading Networks, and 
Trading Networks selects the same processing rule again.
Default Value: 0

When you specify 0, recursive use of processing rules is not allowed.
Example: If you have a processing rule that executes a service and resubmits the document to 
Trading Networks, and Trading Networks will select the same processing rule on the 
resubmit, you can set this value to a higher number to allow recursion of the 
processing rule. The number you set is the maximum number of subsequent times 
that Trading Networks will allow the same document to use the same processing 
rule. For example, to allow 5 recursive calls, specify the following: 
tn.recursion.max=5

webMethods Trading Networks Administrator’s Guide Version 7.1 515

 D. Trading Networks Configuration Properties

tn.server.seq
Description: Trading Networks uses this property when generating internal IDs. To guarantee 
that Trading Networks internal IDs are unique across all servers, they consist of: 
hash code of the hostname

server sequence number

timestamp ‐AND‐

counter
The second element, “server sequence number”, is the value of the tn.server.seq 
property. Use this property only if you are running more than one instance of 
Trading Networks on the same machine. In this situation, each instance of Trading 
Networks should be given a unique value for tn.server.seq.
If you run multiple instances of Trading Networks on one machine and do not 
supply a value for this property, you run the risk of Trading Networks generating 
duplicate internal IDs. If you supply an invalid value (less than 0 or greater than 31), 
Trading Networks ignores the setting and uses 0 for the server sequence number 
portion of generated internal IDs, which again runs the risk of generating duplicate 
internal IDs.
Default Value: Specify a value from 0 to 31, inclusive.
Example: If you have two instances of Trading Networks running on the same machine, you 
should specify the tn.server.seq property for each instance of Trading Networks. For 
example, for the first instance, specify the following:
tn.server.seq=1

For the second instance of Trading Networks, specify the following:
tn.server.seq=2

webMethods Trading Networks Administrator’s Guide Version 7.1 516

 D. Trading Networks Configuration Properties

tn.tmpdir
Description: Identifies the location on the server where you want to store temporary files. Trading 
Networks creates and stores the temporary files:
To store query results. Trading Networks uses a caching component to store query 
results. The caching component stores temporary files in this location. 
When users save document content to their disks. Before saving the file to the userʹs 
disk, Trading Networks saves the document to a temporary location on the 
machine running Trading Networks Server. Trading Networks keeps the file in 
the temporary location for the length of time specified by the tn.tmpfile.timee 
property
Default Value: The JVMʹs temporary directory, which is the value of the JVM system property, 
java.io.tempdir.
Example: If you want Trading Networks to save temporary files to the 
webMethods\IntegrationServer\tempdir directory, specify the following:
tn.tmpdir=tempdir

You only have to set the value to tempdir because the JVM has a working directory 
equal to the Integration Server install directory. As a result, relative paths are from 
that directory.

tn.tmpfile.time
Description: Specifies how many minutes you want Trading Networks to keep temporary files it 
has stored in the location specified by the tn.tmpdir property. These are temporary files 
that Trading Networks creates when a user saves document content to disk. Before 
saving the file to the userʹs disk, Trading Networks temporarily saves the document 
to a temporary location on the machine running Trading Networks Server.
Default Value: 120

By default, Trading Networks maintains the temporary files for 120 minutes (2 
hours).
Example: If you want Trading Networks to maintain the temporary files for 60 minutes (1 
hour), specify the following:
tn.tmpfile.time=60

webMethods Trading Networks Administrator’s Guide Version 7.1 517

 D. Trading Networks Configuration Properties

webMethods Trading Networks Administrator’s Guide Version 7.1 518

Appendix E. XQL Reference

XQL Reference Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

Sample XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

Example XQL Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521

Extracting Custom Attributes From XML Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

webMethods Trading Networks Administrator’s Guide Version 7.1 519

 E. XQL Reference

XQL Reference Information

Use the following link for more information about the W3C, World Wide Web Consortium 
reference information for XQL: http://www.w3.org/TandS/QL/QL98/pp/xql.html.

Sample XML File

The example XQL queries in the next section reference the following XML file.
<?xml version='1.0'?>
<!-- This file represents a fragment of a book store database. -->
<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.50</price>
<subscription price='24' per='year'/>
</magazine>
<book style='novel' id='myfave'>
<title>Trenton Today, Trenton Tomorrow</title>
<author>
<first-name>Toni</first-name>
<last-name>Bob</last-name>
<degree from='Trenton U'>B.A.</degree>
<degree from='Harvard'>Ph.D.</degree>
<award>Pulitzer</award>
<publication>Still in Trenton</publication>
<publication>Trenton Forever</publication>
</author>

webMethods Trading Networks Administrator’s Guide Version 7.1 520

 E. XQL Reference

<price intl='canada' exchange='0.7'>6.50</price>

<excerpt>
<p>It was a dark and stormy night.</p>
<p>But then all nights in Trenton seem dark and
stormy to someone who has gone through what
<emph>I</emph> have.</p>
<definition-list>
<term>Trenton</term>
<definition>misery</definition>
</definition-list>
</excerpt>
</book>
<my:book style='leather' price='29.50'
xmlns:my='http://www.placeholder-name-here.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.

XQL Query Description

/bookstore To find the root element (bookstore) of 
the document
//author Find all author elements anywhere 
within the current document.
//author/first-name Find all first-name elements within an 
author element anywhere in the current 
document.
bookstore/*/title Find all title elements that are 
grandchildren of bookstore elements.
//@style Find all style attributes anywhere 
within the current document.
bookstore/book/price/@exchange Find the exchange attributes of price 
elements that are contained inside book 
elements that are contained in a 
bookstore element.
//book[excerpt] Anywhere within the current 
document, find all book elements 
containing at least one child excerpt 
element.

webMethods Trading Networks Administrator’s Guide Version 7.1 521

 E. XQL Reference

XQL Query Description

//book[excerpt]/author[degree] 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.
//book[excerpt][title] Anywhere within the current 
document, find all book elements 
containing at least one excerpt element 
and at least one title element.
//author[(degree $or$ award) $and$ Anywhere within the current 
publication] document, find all author elements that 
contain at least one degree element or 
award element and at least one 
publication element.
//degree[@from $ne$ 'Harvard'] Anywhere within the current 
document, find all degree elements 
where the from attribute is not equal to 
“Harvard”.
//(book/author)[end()] Anywhere within the current 
document, find the last author element 
from the entire set of author elements 
that are contained within book 
elements.
//my:book Anywhere within the current 
document, find all book elements with 
the namespace my.
/*/my:book/my:title 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[index() $le$ 1] Find the first two books anywhere 
within the current document.
//author[publication!count() $gt$ 1] Anywhere within the current 
document, find all author elements that 
contain more than one publication 
element.
//author[$any$ last-name = 'Bob'] Find all author elements where at least 
one of the last-name elements is ʺBobʺ 
anywhere within the current document.

webMethods Trading Networks Administrator’s Guide Version 7.1 522

 E. XQL Reference

XQL Query Description

//book $union$ //book/author Anywhere within the current 
document, find all book elements and 
all author elements that are children of 
book elements.
/bookstore/book/author[last- Find all the author elements that have 
name/regex('Bo.')] last-name elements that contain the 
string ʺBo.ʺ and another single 
character. 
//book[@style/regex("no.*")] Find all the book elements that have a 
style attribute that contains the regular 
expression pattern ʺno.*ʺ 
/comment()[0] Find the first comment element starting 
from the root of the current document.

Extracting Custom Attributes From XML Documents

For custom attributes that are extracted from an XML document, 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. In some cases, the query returns a null value.

webMethods Trading Networks Administrator’s Guide Version 7.1 523

 E. XQL Reference

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 How Trading Networks stores the

returns results as a:
(result always returned
XML Data as a String List) STRINGLIST STRING
<node></node> null null null
<node> {““} {null} null
<item></item>
</node> (String List with one  (String List with one 
element, an empty  element, a null 
String) String)
<node> {“value”} {“value”} “value”
<item>value</item>
</node> (String List with one  (String List with one 
element) element)
<node> {“value”, ““} {“value”, null} “value”
<item>value</item>
<item></item> (String List with two  (String List with two 
</node> elements) elements)
<node> {““, “value”} {null,“value”} null
<item></item>
<item>value</item> (String List with two  (String List with two 
</node> elements) elements)
<node> {““, “”} {null, null} null
<item></item>
<item></item> (String List with two  (String List with two 
</node> elements) elements)
<node> {“valuea”,““,””, {“valuea”, null, “valuea”
<item>valuea</item> ”valueb”} null, ”valueb”}
<item> </item>
<item></item> (String List with four  (String List with four 
<item>valuez</item> elements) elements)
</node>

webMethods Trading Networks Administrator’s Guide Version 7.1 524

 E. XQL Reference

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 How Trading Networks stores the

returns results as a:
(result always returned
XML Data as a String List) NUMBERLIST NUMBER
<node></node> null null null
<node> {““} {null} null
<item></item>
</node> (String List with one  (Number List with 
element, an empty  one element, a null 
String) element)
<node> {“123”} {“123”} “123”
<item>123</item>
</node> (String List with one  (Number List with 
element) one element)
<node> {“123”, ““} {“123”, null} “123”
<item>123</item>
<item></item> (String List with two  (Number List with 
</node> elements) two elements)
<node> {““, “123”} {null,“123”} null
<item></item>
<item>123</item> (String List with two  (Number List with 
</node> elements) two elements)
<node> {““, “”} {null, null} null
<item></item>
<item></item> (String List with two  (Number List with 
</node> elements) two elements)
<node> {“123”, {“123”, “123”
<item>123</item> ““,””,”456”} null,null,”456”
<item> </item> }
<item></item> (String List with four 
<item>456</item> elements) (Number List with 
</node> four elements)

webMethods Trading Networks Administrator’s Guide Version 7.1 525

 E. XQL Reference

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 How Trading Networks stores the

returns results as a:
(result always returned
XML Data as a String List) DATETIMELIST DATETIME
<node></node> null null null
<node> {““} {null} null
<item></item>
</node> (String List with one  (Datetime List 
element, an empty  with one 
String) element, a null 
element)
<node> {“2004/12/31”} {“2004/12/31”} “2004/12/31”

<item>2004/12/31</item> (String List with one  (Datetime List 

</node> element) with one 
element)
<node> {“2004/12/31”, ““} {“2004/12/31”, “2004/12/31”
null}
<item>2004/12/31</item> (String List with two 
<item></item> elements) (Datetime List 
</node> with two 
elements)
<node> {““, “123”} {null, null
<item></item> “2004/12/31”}
(String List with two 
<item>2004/12/31</item> elements) (Datetime List 
</node> with two 
elements)
<node> {““, “”} {null, null} null
<item></item>
<item></item> (String List with two  (Datetime List 
</node> elements) with two 
elements)
<node> {“2004/12/31”, {“2004/12/31”, “2004/12/31”
<item>2004/12/31</item> ““,””,”2006/01/31”} null,null,”200
<item> </item> 5/01/31”}
<item></item> (String List with four 
<item>2005/01/31</item> elements) (Datetime List 
</node> with four 
elements)

webMethods Trading Networks Administrator’s Guide Version 7.1 526

Appendix F. Large Document Handling

Overview of Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528

What You Need to Do to Use Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528

Features Not Available for Large Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529

Defining TN Document Type XQL Queries for Large Documents . . . . . . . . . . . . . . . . . . . . . . . 530

Creating Services that Recognize Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . 530

Sending Large XML Documents for Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

Viewing Large Documents that Trading Networks Has Processed . . . . . . . . . . . . . . . . . . . . . . 535

webMethods Trading Networks Administrator’s Guide Version 7.1 527

 F. Large Document Handling

Overview of Large Document Handling

As installed, when webMethods Trading Networks (Trading Networks) receives a 
document, it keeps the document’s content in memory during processing. If a document 
is large, Trading Networks can encounter memory constraint problems, 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; that is, 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.

To learn more about Trading Networks large document processing, see Chapter 5, 

ʺTrading Networks Document Processingʺ in the webMethods Trading Networks Concepts 
Guide.

What You Need to Do to Use Large Document Handling

You must set up Trading Networks to use large document handling. As installed, Trading 
Networks does not use this feature for any documents.
To use large document handling you must:
Ensure your system meets the minimum hardware requirements. For more 
information, see “Minimum Hardware Requirements for Large Document Handling” 
on page 55”. 
Set configuration properties that determine when and how Trading Networks uses 
large document handling. For more information see, “Configuring Trading Networks 
for Large Document Handling” on page 55.
Redefine the XQL queries in your TN document types, so they do not require Trading 
Networks to read the entire document content into memory. For more information 
see, “Defining TN Document Type XQL Queries for Large Documents” on page 530.

webMethods Trading Networks Administrator’s Guide Version 7.1 528

 F. Large Document Handling

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. 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, “Creating Services that Recognize Large Document 
Handling” on page 530.
Ensure IS clients (trading partners) do not use the $xmldata variable to send large 
XML documents to Trading Networks.
Increase the largest size of a document that Trading Networks can save to the 
database. You only need to do this if you are using DB2 for the database and if you 
need to save documents that are greater than 2M. For more information, see 
“Increasing the Size of the Largest Document that Can Be Saved When Using DB2” on 
page 57. 

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. If a processing rule indicates that Trading Networks is to use queue for 
polling as the delivery method for a large document, Trading Networks logs a 
message to the activity log and continues processing. The document is not available 
for your partner to poll. If the pre‐processing actions indicated that the document be 
saved, 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. 
When Trading Networks processes a large document and is instructed to validate the 
document structure, Trading Networks does not validate the document, logs a 
message to the activity log, and continues document processing.
Verify pre-processing action–The service that Trading Networks uses to verify the digital 
signature of a document does not support large document handling. When Trading 
Networks processes a large document and is instructed to verify the document’s 
digital signature, Trading Networks does not verify the digital signature, logs a 
message to the activity log, and continues document processing. 

webMethods Trading Networks Administrator’s Guide Version 7.1 529

 F. Large Document Handling

Defining TN Document Type XQL Queries for Large Documents

When defining TN XML document types, you can include two types of XQL queries: 
identifying queries and queries to extract document attributes. When a document is 
considered large, Trading Networks does not necessarily read the entire document 
content into memory to perform the XQL queries. Instead, Trading Networks reads a set 
number of bytes of the document into memory. You set a configuration property 
(tn.xml.xqlThreshold) to define the number of bytes that Trading Networks reads. For more 
information, see “Configuring Trading Networks for Large Document Handling” on 
page 55.
Because Trading Networks only reads in a set number of bytes, 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. If the XQL query identifies a node 
that is in the portion of the document that is not in memory, the query will fail. A failed 
identifying query causes Trading Networks not to select the TN document type for the 
document. A failed attribute query causes Trading Networks to be unable to extract the 
attribute information from the document.
For more information about specifying identifying queries and queries for extracting 
document attributes in TN XML document types, see Chapter 14, “Defining and 
Managing TN XML Document Types”.

Important! Large XML files that are sent to Trading Networks for processing must contain 
the XML declaration (e.g., <?xml...) as the first line. If a large XML document contains any 
blank space before the XML declaration, Trading Networks throws an exception when 
attempting to process the document.

Creating Services that Recognize Large Document Handling

You can create services that act on documents that Trading Networks receives. These 
services are: 
Services specified with the Execute a service processing action in a processing rule. For 
more information, see “Action 1—Execute a Service” on page 354. 
Immediate and scheduled delivery services. For more information, see “Creating an 
Immediate Delivery Service” on page 423 and “Creating a Scheduled Delivery 
Service” on page 425.
When you create these services, you should code them to handle documents that are 
considered large and documents that are not considered large; that is, 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. For example, 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. If the processing rule invokes a 

webMethods Trading Networks Administrator’s Guide Version 7.1 530

 F. 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.

Determining Where the Document Content is Stored

Regardless of whether a document is considered large or not, Trading Networks keeps 
information about the document in the pipeline in the bizdoc variable. Fields within the 
bizdoc indicate whether Trading Networks considers the document large, and therefore, 
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).

Note: The structure of bizdoc is defined by the wm.tn.rec:BizDocEnvelope IS document type.

webMethods Trading Networks Administrator’s Guide Version 7.1 531

 F. Large Document Handling

Using Fields in bizdoc to Determine Where the Document Content is Stored

If StorageType is “tspace”, the document

is in the hard disk drive space.

If StorageType is null, the document is

If the part is large, LargePart?, is true. in the Content object.

If the document contains at least one

large part, LargeDocument? is true.

webMethods Trading Networks Administrator’s Guide Version 7.1 532

 F. 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, indicates whether the 
content part is considered large. Its value is true if Trading Networks considers the 
content part large; otherwise it is false.
LargeDocument?–This field indicates whether any of the content parts of the document 
are large. If at least one of the content parts is considered large, its value is true. If all 
content parts are not considered large, its value is false.
If a content part is considered large, Trading Networks sets StorageType to tspace and 
leaves the Content variable null. If the document is not considered large, Trading 
Networks stores the document content in the Content variable and leaves StorageType null.

Retrieving Document Content from Hard Disk Drive Space

Use the wm.tn.doc:getContentPartData service to retrieve the document content from 
the hard disk drive space. When you invoke this service, specify the following as input:

Input Variable Description

BizDocEnvelope The BizDocEnvelope that Trading Networks created for the 
document.
partName The part name of the content that you want to retrieve.
getAs How you want Trading Networks to retrieve the document 
content. 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, specify the index into the 
document where you want Trading Networks to start retrieving 
content. For example, to retrieve document content from the 
beginning, specify 0.
byteCount If you specified bytes for getAs, specify the number of bytes of 
content that you want Trading Networks to retrieve.

If you indicate that you want the wm.tn.doc:getContentPartData service to retrieve a 
specified number of bytes, the service returns a byte array that contains the retrieved 
bytes of the document content. If you indicate that you want the 

webMethods Trading Networks Administrator’s Guide Version 7.1 533

 F. Large Document Handling

wm.tn.doc:getContentPartData service to retrieve using a stream, the service returns a 
Java InputStream object.
Note that you can invoke this service for all documents, that is whether a document is 
considered large or not.

Retrieving the Content for Document Delivery

To deliver a document, you need the original document content (i.e., the content Trading 
Networks received before processing). Use the wm.tn.doc:getDeliveryContent service 
to retrieve the document content. When you invoke this service, specify the following as 
input:

Input Variable Description

BizDocEnvelope The BizDocEnvelope that Trading Networks created for the 
document.

You can invoke this service for all documents. The service determines whether the 
document is considered large or not. If the document is not considered large, the service 
returns a byte array that contains the retrieved delivery content. If the document is 
considered large, the service retrieves the delivery content using a Java InputStream 
object.

Sending Large XML Documents for Processing

To have Trading Networks process XML documents, send them to the Integration Server. 
To send the XML documents, create an IS service or IS client (Java client, C/C++ client, 
Visual Basic client, Excel client, or browser‐based client). When sending a document that 
Trading Networks considers large, do not submit the document using the $xmldata variable.
For more information about other methods you can use to submit XML documents 
(besides the $xmldata variable), see the chapter about passing XML data to services in the 
webMethods Developer User’s Guide. For more information about creating clients, see the 
chapter about creating client code in the webMethods Developer User’s Guide. For more 
information about sending XML documents to Trading Networks, see the Chapter 4, 
ʺSending Documents to Trading Networks for Processingʺ in the webMethods Trading 
Networks Concepts Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 534

 F. Large Document Handling

Viewing Large Documents that Trading Networks Has Processed

When you use My webMethods, viewing large documents is the same as viewing any 
other document. 
However, if you use Trading Networks Console to view large documents, the behavior 
for large documents is different from how Trading Networks displays other documents in 
the Console. Trading Networks still lists the large documents on the Transaction Analysis 
screen. From the Transaction Analysis screen, you can view the Document Details screen 
(Transactions > View Document). However, the Content tab of the Document Details screen 
displays only 1,000 bytes of the document. 

Content tab of Document Details screen

Click   to display the next 1,000 bytes. Click   to display the previous 1,000 bytes.

webMethods Trading Networks Administrator’s Guide Version 7.1 535

 F. Large Document Handling

webMethods Trading Networks Administrator’s Guide Version 7.1 536

 Part VI. Deprecated Console Functionality

Appendix G, “Managing Profile Fields Using the Console”

Appendix H, “Managing Your Profile Using the Console”

Appendix I, “Managing Partner Profiles Using the Console”

Appendix J, “Managing Profile Groups Using the Console”

Appendix K, “Managing Queues Using the Console”

webMethods Trading Networks Administrator’s Guide Version 7.1 537

 VI. Deprecated Console Functionality

webMethods Trading Networks Administrator’s Guide Version 7.1 538

Appendix G. Managing Profile Fields Using the Console

What are Profile Fields? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540

Viewing Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548

Updating Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549

Adding Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550

Viewing Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552

Updating Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553

Disabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554

Enabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554

Note: This appendix describes how to define and manage profile fields using the Trading 
Networks Console. This functionality in the Console is deprecated. You can now perform 
these functions using My webMethods. For instructions, see Chapter 8, “Defining and 
Managing Profile Fields”. 
For instructions on how to enable the deprecated functions in the Console, see 
information about setting Console preferences in the webMethods Trading Networks User’s 
Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 539

 G. Managing Profile Fields Using the Console

What are Profile 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 fields that are provided out‐of‐the‐box and 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.
For more information, see “Standard Profile Fields” on page 540.
Extended fields are fields that you define to extend the standard profile. 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.
For more information, see “Extended Profile Fields” on page 547.

For more information about profile fields, see Chapter 2, ʺTrading Partnersʺ in the 

webMethods Trading Networks Concepts Guide

Required Fields
A required field is one that you want supplied for all profiles. Several of the standard 
fields, as defined out‐of‐the‐box, are required. Those that are not, you can mark as 
required if you want. When you add extended fields, you can mark them as required. All 
profiles on your system must have a value for required profile fields.
When you create your own profile or add a profile for a partner, you must supply 
information for all required fields before Trading Networks will allow you to enable the 
profile. When you are filling in a profile, Trading Networks displays each required field in 
blue and places an asterisk (*) next to the required fields, so you can easily determine the 
fields that are required.

Standard Profile Fields

The standard profile fields are fields that are provided out‐of‐the‐box. Although Trading 
Networks has many standard fields, you can view and update only a subset of the 
standard fields.

webMethods Trading Networks Administrator’s Guide Version 7.1 540

 G. Managing Profile Fields Using the Console

The following table lists the standard profile fields that you can update. For each field, the 
table lists a description of what each field is, how Trading Networks uses the field, and 
any consequences if a field is not included in a partner profile.

Standard Field Description

Corporation Name What it is: This field identifies the name of the corporation, for 
example, “Industrial Steel Company”. The following shows where 
it is located within the profile:
Console Tab Field Name

Corporate Corporation Name

How it is used: Trading Networks uses this field (along with the Unit
Name, if specified) to identify your enterprise or a partner within 
the network. 
If not specified: Trading Networks will not have a name to use to 
identify for the partner.
Unit Name What it is: This field identifies a unit name or division name within 
the corporation, for example, “Sales and Marketing”. The 
following shows where it is located within the profile:
Console Tab Field Name

Corporate Unit Name

How it is used: Trading Networks uses this field (along with the 
Corporation Name) to identify your enterprise or a partner within the 
network.
If not specified: Trading Networks will use only the Corporation Name 
for identification.
Preferred Language What it is: This field is used by other webMethods components (e.g., 
webMethods RosettaNet Module) for localization purposes. The 
following shows where it is located within the profile: 
Console Tab Field Name

Corporate Preferred Language

How it is used: Trading Networks does not use this information. It is 
maintained for other webMethods components.
If not specified: The information will not be available.

webMethods Trading Networks Administrator’s Guide Version 7.1 541

 G. Managing Profile Fields Using the Console

Standard Field Description

Preferred Delivery What it is: This field identifies which delivery method the partner 
Method prefers to receive documents with. The following shows where it is 
located within the profile:
Console Tab Field Name

Delivery Method  Use as preferred protocol

How it is used: If a processing rule is configured to deliver a 
document using the preferred protocol, the partner’s delivery 
method that is selected as the preferred protocol will be used.
If not specified: The preferred protocol defaults to Queue for polling.
E-mail What it is: This field identifies an e‐mail address for a contact, for 
example, “[email protected]”. The following shows 
where it is located within the profile:
Console Tab Field Name

Contact  E-mail
How it is used: Trading Networks allows you to select a contact type 
in a processing rule for the Alert e-mail action. The Alert e-mail action 
instructs Trading Networks to send an e‐mail message to the 
contacts associated with the selected contact type. If the e‐mail 
address is not specified for a contact of the selected contact type, 
Trading Networks cannot send the e‐mail message to that contact. 
For more information on the Alert e-mail action in a processing rule, 
see “Action 2—Send an Alert E‐mail” on page 361.
If not specified: If the contact is referenced in the Alert e-mail action of 
a processing rule, Trading Networks will not be able to send an e‐
mail message. 
Fax What it is: This field identifies the fax number for a contact, for 
example, “1‐888‐555‐4897”. The following shows where it is 
located within the profile:
Console Tab Field Name

Contact  Fax
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

webMethods Trading Networks Administrator’s Guide Version 7.1 542

 G. Managing Profile Fields Using the Console

Standard Field Description

First Name What it is: This field identifies the contactʹs first name. The following 
shows where it is located within the profile:
Console Tab Field Name

Contact  First Name

How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile.
Pager What it is: This field identifies the pager number for a contact, for 
example, “1‐330‐555‐7890”. The following shows where it is 
located within the profile:
Console Tab Field Name

Contact  Pager
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 
Role What it is: This field identifies the contactʹs job title, for example, 
“Trading Network Administrator”. The following shows where it 
is located within the profile:
Console Tab Field Name

Contact  Role
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile.
Last Name What it is: This field identifies the contactʹs last name. The following 
shows where it is located within the profile:
Console Tab Field Name

Contact Last Name

How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 543

 G. Managing Profile Fields Using the Console

Standard Field Description

Extension 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, use the Extension field to identify the contactʹs 
extension. The following shows where it is located within the 
profile:
Console Tab Field Name

Contact Extension
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 
Telephone What it is: This field identifies the telephone number for a contact, 
for example, “1‐800‐555‐1234”. The following shows where it is 
located within the profile:
Console Tab Field Name

Contact Telephone
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 
Address What it is: This field identifies the first line of the street address, for 
example, “595 Main Street”. The following shows where it is 
located within the profile:
Console Tab Field Name

Corporate Address
Contact
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the Address as a required field, Trading Networks 

will require the Address field in all locations.

webMethods Trading Networks Administrator’s Guide Version 7.1 544

 G. Managing Profile Fields Using the Console

Standard Field Description

AddressLine2 What it is: This field identifies the second line of the street address, 
for example, “Suite 556”. The following shows where it is located 
within the profile:
Console Tab Field Name

Corporate AddressLine2
Contact
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the AddressLine2 as a required field, Trading 
Networks will require the AddressLine2 field in all locations.

AddressLine3 What it is: This field identifies the third line of the street address, for 

example, “ATTN Billing Department”. The following shows where 
it is located within the profile:
Console Tab Field Name

Corporate AddressLine3
Contact
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the AddressLine3 as a required field, Trading 
Networks will require the AddressLine3 field in all locations.

webMethods Trading Networks Administrator’s Guide Version 7.1 545

 G. Managing Profile Fields Using the Console

Standard Field Description

City What it is: This field identifies the city in an address, for example, 
“Los Angeles”. The following shows where it is located within the 
profile:
Console Tab Field Name

Corporate AddressLine3
Contact
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the City as a required field, Trading Networks 
will require the City field in all locations.

Country What it is: This field identifies the country in an address, for 

example, “USA”. The following shows where it is located within 
the profile:
Console Tab Field Name

Corporate Country
Contact
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the Country as a required field, Trading Networks 
will require the Country field in all locations.

webMethods Trading Networks Administrator’s Guide Version 7.1 546

 G. Managing Profile Fields Using the Console

Standard Field Description

State/Province What it is: This field identifies the state or province in an address, 
for example, “California”. The following shows where it is located 
within the profile:
Console Tab Field Name

Corporate State/Province
Contact
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the State/Province as a required field, Trading 
Networks will require the State/Province field in all locations.

Postal Code What it is: This field identifies the postal code (for example, ZIP 

code) for the state or province in an address, for example, “90001”. 
The following shows where it is located within the profile:
Console Tab Field Name

Corporate Postal Code

Contact
How it is used: Trading Networks does not use this information. It is 
for you to access via the profile.
If not specified: The information will not be available in the profile. 

Note: If you mark the Postal Code as a required field, Trading 

Networks will require the Postal Code field in all locations.

Extended Profile Fields

If after reviewing the standard profile you determine that you want to maintain 
additional information about partners, you can define extended profile fields.
When you define an extended profile field, you specify the following:
The name you want the extended profile field to have. 

The name of the profile field group that you want Trading Networks to assign to the 
profile field. Trading Networks provides the groups—Address, Corporation, Custom, 
Contact, Delivery, and External ID. You can add additional groups. 

webMethods Trading Networks Administrator’s Guide Version 7.1 547

 G. Managing Profile Fields Using the Console

A description you want Trading Networks to display for the extended profile field. 

The data type of the extended profile field—string or binary.

The default value of the extended profile field. You can supply this information only 
if the data type is string.
The maximum length of the value that can be supplied for the profile field. You can 
supply this information only if the data type is string.
The valid values that can be supplied for the profile field. You can supply this 
information only if the data type is string.
You can change all information for an extended field, including its name. 

Important!  Use caution when changing fields from required to not required. If you have 
services that use the field or if you might create or update services that use the field, the 
information might not be available if the partner is not required to supply it.
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 updated 
extended profile fields. This is true even when the updated extended profile fields has a 
default value

Viewing Standard Profile Fields

To view the standard profile fields that Trading Networks allows you to update, perform 
the following procedure.

To view standard profile fields using the Console

1 In Trading Networks Console: View > Enterprise.

2 Select Enterprise > Profile Fields.
3 Click the Standard tab.
Note: To sort the columns in the Standard table, select the column to sort and then click 
on the column heading for forward () and reverse () alpha‐numeric order.
4 Click the row containing the profile field that you want to view.
5 Right click and select Edit. For more information about the fields on this tab, see 
“Standard Profile Fields” on page 540.

webMethods Trading Networks Administrator’s Guide Version 7.1 548

 G. Managing Profile Fields Using the Console

Updating Standard Profile Fields

Perform the following procedure to update information for standard profile fields:

To update a standard profile field using the Console

1 In Trading Networks Console: View > Enterprise.

2 Select Enterprise > Profile Fields.
3 Click the Standard tab.
Note: To sort the columns in the Standard table, select the column to sort and then click 
on the column heading for forward () and reverse () alpha‐numeric order.
4 Click the row containing the profile field that you want to update.
5 Right click and select Edit. 
6 Update the field(s) you want to change: 

For this Standard

tab parameter... Specify...

Description The description you want the profile field to have. You can 
replace the current description or add more detail to it. 
You can specify 1‐1024 characters. You can specify any 
characters; there are no restrictions.
Required Whether the profile field is required or not. Click the check 
box to indicate your choice. To indicate the profile field is 
required, assure the check box has a check. To indicate that the 
profile field is not required, remove the check from the check 
box.

Important! Use caution when changing fields from required to 
not required. Trading Networks uses some standard fields for 
its processing, so if you change a field so that it is not required 
and a partner opts to not supply that information, Trading 
Networks might be prevented from performing a function that 
you will require. 

To determine how Trading Networks uses each standard field 
and the effect of not specifying a field, see “Standard Profile 
Fields” on page 540.

7 Click OK.

webMethods Trading Networks Administrator’s Guide Version 7.1 549

 G. Managing Profile Fields Using the Console

Adding Extended Profile Fields

To add an extended profile field to the profiles you maintain on your system, perform the 
following procedure.

Note: If you already have profiles in your system and then add extended profile fields that 
are required, you must manually edit the existing profiles for the newly added extended 
profile fields. This is true even when you define default values for the added extended 
profile fields.

To add a new extended profile field using the Console

1 In Trading Networks Console: View > Enterprise.

2 Select Enterprise > Profile Fields.
3 Click the Extended tab to view the list of extended profile fields.
4 Perform one of the following to start defining a new extended profile field:

To create a new extended field

based on... Perform this procedure...

A blank New Extended 
Profile Field screen Click   New. 

Trading Networks displays a blank New 
Extended Profile Field screen.
An existing extended  Click the row containing the profile field that 
profile field you want to duplicate.

Click   Duplicate. 

Trading Networks displays the New Extended 
Profile Field screen with the information copied 
from the selected profile field.
You can update any or all fields for the extended 
profile field.

webMethods Trading Networks Administrator’s Guide Version 7.1 550

 G. Managing Profile Fields Using the Console

5 Fill in the fields on the New Extended Profile Field screen:

For this Extended

tab parameter... Specify...

Name The name you want to assign the new extended profile field. 
For example, if you send catalogs to clients and you want to 
maintain the type of catalog the partner is to receive, you 
might define an extended profile field named “Catalog Type”.
Specify 1‐32 characters. You can specify any characters; there 
are no restrictions.
Group The group you want Trading Networks to assign the extended 
profile field to. To assign the field to an existing group, select a 
group from the list. To assign the field to a new group, type the 
name of the group.
Description Optional. A description of the profile field. 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.
Specify 1‐1024 characters. You can specify any characters; 
there are no restrictions.
Data Type The data type of the profile field. Select either String or Binary 
from the list. If you specify String, you can specify a default 
value, maximum length, and valid values for the profile field. 
Default Optional. The default value for a profile field. You can specify 
Default only when Data Type is String. 
Specify 1‐128 characters. You can specify any characters; there 
are no restrictions.
Maximum Length Optional. The maximum number of characters that you want 
to allow someone to specify for the profile field. If you do not 
specify a maximum length, there is no limit placed on the 
profile field. You can specify Maximum Length only when Data
Type is String.

webMethods Trading Networks Administrator’s Guide Version 7.1 551

 G. Managing Profile Fields Using the Console

For this Extended

tab parameter... Specify...

Valid Values Optional. These are values that you want Trading Networks to 

accept for this profile field. Specify the valid values in the table 
in the Valid Values field. Place one valid value per row.

To add row to the table, click   Add New.

To remove a row from the table, select the row and then 

click   Delete Selected.

If you specify valid values, Trading Networks displays a list of 
the values that can be selected when filling out a profile. You 
can specify Valid Values only when Data Type is String.
Enabled Whether the profile field is enabled or disabled. To define the 
field and assure it is enabled, make sure the Enabled check box 
is selected. 
Required Whether the profile field is required or not. Select the check 
box to indicate your choice. To indicate the profile field is 
required, assure the check box has a check. To indicate that the 
profile field is not required, remove the check from the check 
box.

6 Click OK.

Viewing Extended Profile Fields

To view the extended profile fields that are defined on your system, perform the following 
procedure:

To view extended profile fields using the Console

1 In Trading Networks Console: View > Enterprise.

2 Select Enterprise > Profile Fields.
3 Click the Extended tab to view the list of extended profile fields.

webMethods Trading Networks Administrator’s Guide Version 7.1 552

 G. Managing Profile Fields Using the Console

4 Select one of the following options to view extended profile fields.

For the following... Perform this procedure...

To see details about a  Double click the row for that field.
specific extended 
profile field
To display disabled  To display disabled extended profile fields, click 
extended profile 
fields Show All to show both enabled (yellow light bulbs) and 
disabled (darkened light bulbs) items.
To hide disabled  To hide disabled extended profile fields, click 
extended profile 
fields Show Enabled to only show enabled (yellow light bulbs) 
items. Trading Networks does not display any disabled 
(darkened light bulbs) items.

Updating Extended Profile Fields

You can change all information for an extended profile field, including its name.

Note: Use caution when changing fields from required to not required. If you have services 
that use the field or if you might create or update services that use the field, the 
information might not be available if the partner is not required to supply it.
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 updated 
extended profile fields. This is true even when the updated extended profile fields has a 
default value

To update extended profile fields, perform the following procedure:

To update an extended profile field using the Console

1 In Trading Networks Console: View > Enterprise.

2 Select Enterprise > Profile Fields.
3 Click the Extended tab.
Note: To sort the columns in the Extended table, select the column to sort and then click 
on the column heading for forward () and reverse () alpha‐numeric order.
4 Click the row containing the profile field you want to update.

webMethods Trading Networks Administrator’s Guide Version 7.1 553

 G. Managing Profile Fields Using the Console

5 Select   Edit. Update the fields you want to change. For information on what you 
can specify, see step 5 on page 551.
6 Click OK.

Disabling Extended Profile Fields

If you no longer want to use an extended profile field, you can disable it. When you 
disable an extended profile field, Trading Networks no longer displays it in profiles. 
Trading Networks does not delete the field definition from the database or any 
information stored for the field in partner profiles.
Because the field is no longer displayed in profiles, if you create new profiles after 
disabling a field, the new profile will not contain information for the disabled field. Use 
caution when disabling fields. 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.
To disable the extended profile fields, perform the following procedure:

Note: To permanently remove the extended profile field from the database, your database 
administrator must remove it. Before you can remove the field, you must first remove all 
rows from the PartnerProfileField table that reference the profile field you want to delete. 

To disable an extended profile field using the Console

1 In Trading Networks Console: View > Enterprise.

2 Select Enterprise > Profile Fields.
3 Click the Extended tab.
4 Click the row containing the profile field that you want to disable.
5 Right click and select Disable. Trading Networks places No in the Enabled column to 
indicate that the extended profile field is disabled.

Enabling Extended Profile Fields

If you disable an extended profile field and then later determine that you still need it, you 
can enable it. 
If the profile field you are enabling is a required field, you might need to take further 
action. If you added partner profiles while the profile field was disabled, the profiles that 
were added in the interim do not contain information for the required field. You will need 

webMethods Trading Networks Administrator’s Guide Version 7.1 554

 G. Managing Profile Fields Using the Console

to manually update the profiles to supply the missing information. For instructions on 
how to update a partner profile, see “Updating Partner Profiles” on page 581.
To enable an extended profile field, perform the following procedure.

Important! To perform this procedure, you must first perform the procedure described in 
“Disabling Extended Profile Fields” on page 554.

To enable the extended profile fields, perform the following procedure:

To enable an extended profile field using the Console

1 In Trading Networks Console: View > Enterprise.

2 Select Enterprise > Profile Fields.
3 Click the Extended tab.
Note: To sort the columns in the Extended table, select the column to sort and then click 
on the column heading for forward () and reverse () alpha‐numeric order.
4 Click the row containing the profile field that you want to enable.
5 Right click and select Enable. Trading Networks places Yes in the Enabled column to 
indicate that the extended profile field is enabled.

webMethods Trading Networks Administrator’s Guide Version 7.1 555

 G. Managing Profile Fields Using the Console

webMethods Trading Networks Administrator’s Guide Version 7.1 556

Appendix H. Managing Your Profile Using the Console

Creating Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558

Viewing Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559

Updating Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559

Enabling Your Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569

Disabling Your Profile—Changing the Status to Inactive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569

Note: This appendix describes how to define and manage your profile using the Trading 
Networks Console. This functionality in the Console is deprecated. You can now perform 
these functions using My webMethods. For instructions, see Chapter 9, “Defining and 
Managing Your Profile (Your Enterprise)”. 
For instructions on how to enable the deprecated functions in the Console, see 
information about setting Console preferences in the webMethods Trading Networks User’s 
Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 557

 H. Managing Your Profile Using the Console

Creating Your Own Profile

To create your own profile, you use the Profile Assistant, which is a wizard that takes you 
step‐by‐step through the process of creating your own profile.
In addition, you can use the Profile Assistant to create partner profiles. For more details, 
see Chapter 10, “Defining and Managing Partner Profiles”.

To create your profile using the Console

1 In Trading Networks Console: Tools > Profile Assistant.

2 Select Create my profile.
3 Click Next. The Profile Assistant takes you to the appropriate panel based on the 
action that you are to perform.
4 Follow the directions specified by the Profile Assistant. On the Profile Assistant 
panels, use the following buttons to supply information to the profile fields:

Use this button To...

Add an entry.

Edit an existing entry.
   or 
Delete an entry.
 

The information you need to supply in the Profile Assistant is the same as the 
information you supply on the Profile screen. For descriptions of the fields on the 
Profile screen, see “Information Trading Networks Maintains in a Profile” on 
page 113.
Note: Trading Networks validates the information you enter in each panel and will 
alert you with an error message for incorrect or incomplete entries. If you receive an 
error message, you must go back to that panel and complete the required information 
to proceed with Profile Assistant. Click Back to return to the previous panel in Profile 
Assistant.
5 When you have completed all the steps, Trading Networks saves the new profile and 
displays the “Profile Created” message.
Note: If the profile fields were not completed correctly, 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. You must edit the profile to 
correct the errors. For instructions, see “Updating Your Profile” on page 559. 

webMethods Trading Networks Administrator’s Guide Version 7.1 558

 H. Managing Your Profile Using the Console

After you create your profile and Trading Networks validates the fields, Trading 
Networks saves your profile and sets the status of your profile on your system to 
“Inactive”. Note that your profile is saved, even if there are errors.

Important! Before you can exchange documents with partners, you must enable your profile 
to update the status to “Active”. For instruction on how to enable a profile, see “Enabling 
Your Profile—Changing the Status to Active” on page 569.

Viewing Your Profile

To view your profile, perform the following procedure.

To view your profile using the Console

In Trading Networks Console: View > Enterprise. The Enterprise tabular and tabs appear on 

the screen.

Updating Your Profile

To update your profile, perform the following procedure. Fields that you must specify are 
in blue and are marked with an asterisk (*) on the screen.
See the following sections based on the changes you want to make to your profile:
“Updating Your Corporation Information” on page 560

“Managing Addresses for Your Corporation” on page 560

“Managing Your External IDs” on page 561

“Managing Your Profile Group Memberships” on page 562

“Managing the Contacts in Your Profile” on page 563

“Managing Delivery Methods in Your Profile” on page 565

“Managing Your Profiles Extended Fields” on page 566

“Managing Security Information in Your Profile” on page 567

webMethods Trading Networks Administrator’s Guide Version 7.1 559

 H. Managing Your Profile Using the Console

Updating Your Corporation Information

You can add or change your corporation information.

To update the corporation information in your profile

1 In Trading Networks Console: View > Enterprise.

2 Click the Corporate tab and make the necessary changes. For more information about 
these fields, see “Information Trading Networks Maintains in a Profile” on page 113.

3 Click   Edit Corporation Name next to the Corporation Name field.

4 In the Corporation Name field, type the name of your corporation, for example, 
“Industrial Steel Company”.
5 In the Unit Name field, type the name of the organizational unit or division within your 
corporation, for example, “Sales and Marketing”.
6 In the Partner Type field, specify the type of software your corporation uses to interact 
with the trading network: webMethods Trading Networks or webMethods for Partners.
7 In the Preferred Language field, optionally specify the language preference your 
corporation uses if needed for another webMethods component (e.g., webMethods 
RosettaNet Module).
8 Click Save.

Managing Addresses for Your Corporation

You can add, edit, and delete addresses for your corporation.

To update the corporation information in your profile

1 In Trading Networks Console: View > Enterprise.

2 Click the Corporate tab and make the necessary changes. For more information about 
these fields, see “Information Trading Networks Maintains in a Profile” on page 113.

webMethods Trading Networks Administrator’s Guide Version 7.1 560

 H. Managing Your Profile Using the Console

3 To add or edit address:

a To add, click   Add New Address. 

To edit, select the tab containing the address you want to edit; then click   Edit
Address.
b Specify the following fields:

For this corporate

parameter… Specify…

Country The country where your corporation is located, for example, 
“USA”.
Address The street address for your corporation, for example, “123 
Main Street, Suite 456”.
City The city where your corporation is located, for example, 
“Los Angeles”.
State/Province The state or province where your corporation is located, for 
example, “California”.
Postal Code The postal code (for example, a zip code) for the state or 
province where your corporation is located, for example, 
“90001”.

c Click Save.
4 To delete an address:
a Select the tab containing the address you want to delete.

b Click   Delete Address.

Managing Your External IDs

You can add, edit, and delete external IDs.

To update the external IDs in your profile

1 In Trading Networks Console: View > Enterprise.

2 Click the Corporate tab and make the necessary changes. For more information about 
these fields, see “Information Trading Networks Maintains in a Profile” on page 113.

webMethods Trading Networks Administrator’s Guide Version 7.1 561

 H. Managing Your Profile Using the Console

3 To add or edit an external ID:

a To add and external ID, click   Add New External ID. 

To edit, select the row you want to edit, then click   Edit External ID.

b In the External ID Type field, select the external ID type. Be sure to include an 
external ID type for each type of identification that you use in documents. You 
can specify an unlimited number of external ID types.
c In the Value field, specify the value of the external ID type. For example, if you 
selected DUNS and your D‐U‐N‐S number is 987654321, specify 987654321 for 
Value. The maximum length you can specify for an external ID is 128 characters.
d Click Save.
4 To delete an external ID:
a Select the row containing the external ID you want to delete.

b Click   Delete External ID.

Managing Your Profile Group Memberships

You can add or remove your profile from profile groups.

Note: You can only associate profiles with a profile group if there are profile groups 
defined in the database. To add a new profile group, see “Defining Profile a Group” on 
page 598.

To update the profile group membership for your profile

1 In Trading Networks Console: View > Enterprise.

2 Click the Corporate tab and make the necessary changes. For more information about 
these fields, see “Information Trading Networks Maintains in a Profile” on page 113.
3 To add your profile to a profile group:

a Click   Add New Profile Group next to Profile Group Membership. 

b Select the profile group name from the list of available groups.
c Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 562

 H. Managing Your Profile Using the Console

4 To remove your profile from a profile group:
a Select the row containing the profile group from which you want to remove your 
profile.

b Click   Delete From Profile Group Membership.

Managing the Contacts in Your Profile

You can add contacts, edit contact information, or remove contacts from your profile.

To update the corporation information in your profile

1 In Trading Networks Console: View > Enterprise.

2 Click the.Contact tab and fill in the fields. For more information about the fields on this 
tab, see “Contacts” on page 116.
3 To add or edit a contact:

a To add a contact, click   Add New Contact.

To edit a contact, select the contact name from the Name column, then click   
Edit Contact.
b Specify the following fields for the contact:

For this contact

parameter… Specify…

Contact Type The type of contact, for example, “Administrative”. Select a 

contact type from the list.
Role The role the contact has in the partner’s corporation. This 
might be a job title, for example, “Trading Network 
Administrator”.
Last Name The contactʹs last (surname) name.

Note: To sort the contacts’ last names alphabetically, click on 
the Name column heading for forward () and reverse () 
alphabetization.

First Name The contactʹs first (given) name.

E-mail The contactʹs e‐mail address, for example, 
“[email protected]”.

webMethods Trading Networks Administrator’s Guide Version 7.1 563

 H. Managing Your Profile Using the Console

For this contact

parameter… Specify…

Telephone The contactʹs telephone number, for example, 
“1‐800‐555‐1234”.
Extension The contactʹs extension number. If the telephone number in 
the Telephone field identifies the main line for the 
corporation, use the Extension field to identify the contactʹs 
extension. 
Pager The contactʹs pager number, for example, “1‐330‐555‐7890”.
Fax The contactʹs fax number, for example, “1‐888‐555‐4897”.
Country The country where the contact is located, for example, 
“USA”.
Address The street address for the contact, for example, “123 Main 
Street, Suite 456”.
City The city where the contact is located, for example, “Los 
Angeles”.
State/Province The state or province where the contact is located, for 
example, “California”.
Postal Code The postal code (for example, a zip code) for the state or 
province where the contact is located, for example, “90001”.

c Click Save. If you added a contact, the new contact’s name now appears in the 
Name column.
4 To delete a contact:
a Select the contact that you want to delete in the Name column.

b Click   Delete Contact.

webMethods Trading Networks Administrator’s Guide Version 7.1 564

 H. Managing Your Profile Using the Console

Managing Delivery Methods in Your Profile

You can add, edit, or delete delivery methods. Delivery methods specify how partners are 
to deliver documents to your Trading Networks system. The Deliver document processing 
action uses the settings on the Delivery Method tab. 

To update the corporation information in your profile

1 In Trading Networks Console: View > Enterprise.

2 Click the Delivery Method tab. For more information about the fields on this tab, see 
“Delivery Settings” on page 118. 
3 To add or edit a delivery method:

a To add a delivery method, click   Add New Destination.

To edit a delivery method, select the tab for the delivery method; then, click   
Edit Destination. 
b In the Protocol field, select a delivery method from the list. Trading Networks 
updates the information on the tab to display the fields required for the protocol 
you selected. 
c For an HTTP, HTTPS, FTP, or FTPS delivery method, specify the host name or IP 
address of your system in the Host field, for example, “IndustrialSteel.com”.
d For an HTTP, HTTPS, FTP, or FTPS delivery method, specify the port number on 
which your system listens for incoming requests in the Port field, for example, 
“5555”.
Note: If you do not supply a port number, Trading Networks uses the following 
defaults: HTTP—80; HTTPS—443; FTP or FTPS—21.
e For an HTTP, HTTPS, FTP or FTPS delivery method, specify one of the following 
in the Location field:
For HTTP or HTTPS, Location is the URL partners should use to send 
documents to your system via HTTP or HTTPS. By default, Trading 
Networks displays the default URL: “/invoke/wm.tn/receive” for HTTP and 
HTTPS. 
For FTP or FTPS, 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. 
f For an E‐mail delivery method, specify the e‐mail address to which you want a 
partner to deliver documents in the E-mail field, for example, “[email protected]”
g If you prefer that partners use this delivery method to deliver documents to your 
Trading Networks system, select the Use as preferred protocol check box. 

webMethods Trading Networks Administrator’s Guide Version 7.1 565

 H. Managing Your Profile Using the Console

Trading Networks displays the preferred protocol at the top of the Delivery Method 
tab.
Note: If the Use as preferred protocol is not selected for any delivery method, Trading 
Networks uses Queue for polling. 
h Click Save. 
4 To delete a delivery method from your profile:
a Select the tab for the delivery method you want to delete.

b Click   Delete Destination.

Note: You cannot delete a delivery method that is selected as the preferred protocol.

Managing Your Profiles Extended Fields

You can edit the values for the extended fields.

To update the corporation information in your profile

1 In Trading Networks Console: View > Enterprise.

2 Click the Extended Fields tab. For more information about the fields on this tab, see 
“Extended Fields” on page 124. 
3 Select the name of the group that contains the extended profile field you want to edit. 
Trading Networks displays the corresponding extended fields on the right.
Note: If there are no extended profile fields in a specific group, Trading Networks does 
not list that group. For example, if you have not defined any extended profile fields 
for the “Corporate” group, “Corporate” will not appear in the Group column. See 
“Extended Profile Fields” on page 137 on how to add and define extended fields.

4 Click   Edit Field to make the extended fields in selected group editable. 

5 Update the values for the extended fields that you want to alter.
Note: If you do not know what to specify for an extended field and the description 
does not indicate what to specify, contact your Trading Networks administrator to 
determine what to specify. 
6 Click Save.
Note: You must save the changes you make to one group’s extended fields before you 
can edit another group’s extended fields. Repeat this procedure for each extended 
field you want to update.

webMethods Trading Networks Administrator’s Guide Version 7.1 566

 H. Managing Your Profile Using the Console

Managing Security Information in Your Profile

You can view, add, and delete certificates and private keys.

Note: Trading Networks Console will not display private key information. If a key is 
defined, Defined appears in the text field. If a key is not defined, <Empty> appears in the text 
field.

To update the corporation information in your profile

1 In Trading Networks Console: View > Enterprise.

2 Click the Security tab. For more information about the fields on this tab, see 
“Certificates” on page 125. Perform the following procedure for each sub‐tab.

Use this sub-tab… To add/update certificates to use to…

Sign/Verify Digitally sign documents that your Enterprise sends to 
partners.
Decrypt/Encrypt Decrypt documents that your Enterprise receives from partners.
SSL Client Enable Trading Networks to act as an SSL client to connect to a 
remote secure server.

3 To view information about a certificate:
a Select the partner from the Partner list on the left.
b Select the appropriate certificate sub tab: Sign/Verify, Decrypt/Encrypt, or SSL Client. 
Trading Networks displays the certificate information.
c Click the appropriate row of the Certificate Chain table. The Console displays the 
certificate information on the right.
4 To add a certificate chain:

a Click   Edit Selected.

b Click   Add Certificate(s).

c In the Add Certificate dialog box, add one or more certificates as follows:
To add one certificate, browse to and select the file that contains the 
certificate.
Note: When you add a certificate, be sure also to add the CA certificate(s) and 
private key that are associated with the certificate. The certificates, CA 
certificates, and private keys must reside in your file system. Trading 

webMethods Trading Networks Administrator’s Guide Version 7.1 567

 H. Managing Your Profile Using the Console

Networks can import files that have a .der, .cer, or .p7b extension. If you import 
a .der file, Trading Networks appends it to the existing certificate chain list. 
However, if you import a .cer or .p7b file, Trading Networks replaces the 
certificate chain list with the .cer or .p7b file.
To add multiple certificates within a directory, browse to and select the files 
that contain the certificates, using the SHIFT + CONTROL keys. If you select 
an entire directory, Trading Networks imports all files except duplicate files 
and private key files.
Note: The order that Trading Networks displays the certificate chain does not 
reflect how the chain is linked.
5 To delete certificates from your profile:

a Click   Edit Selected.

b Select the certificate(s) that you want to delete. To select multiple certificates, 
press CTRL and click on the second and subsequent certificates.

c Click   Delete Certificate(s).

Note: If you delete the certificate, be sure also to delete the CA certificate(s) and private 
key that are associated with the certificate.
6 To add a private key:

a Click   Edit Selected.

b Click   Import Private Key in the Private Key field. 

c In the Import Private Key dialog box, browse to and select the file that contains 
the private key that you want to add. You can only import a .der file that contains 
a valid private key format. Once you select the file, then click Open.
Note: If you add a private key, be sure also to add the certificate and CA certificate(s) 
that are associated with the private key.
7 To delete a private key:

a Click   Edit Selected.

b Click   Delete 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 568

 H. Managing Your Profile Using the Console

Enabling Your Profile—Changing the Status to Active

After you add a profile and Trading Networks validates the fields, Trading Networks 
saves the profile and sets the status of the profile to “Inactive”. Before you can exchange 
documents with partners, you must enable your profile by updating your status to 
“Active”. Enabling your profile allows you to exchange documents with partners. When 
you enable your profile, Trading Networks changes the status of the profile to “Active”. 
For more information about statuses, see “Profile Statuses” on page 127.

To enable your profile using the Console

1 In Trading Networks Console: View > Enterprise.

2 Select Enterprise > Enable.

Disabling Your Profile—Changing the Status to Inactive

When you disable your profile, Trading Networks changes the status of your profile to 
“Inactive”. As a result, you will not be able to exchange documents with your partners. 
For more information about statuses, see “Profile Statuses” on page 127.

To disable your profile using the Console

1 In Trading Networks Console: View > Enterprise.

2 Select Enterprise > Disable.

webMethods Trading Networks Administrator’s Guide Version 7.1 569

 H. Managing Your Profile Using the Console

webMethods Trading Networks Administrator’s Guide Version 7.1 570

Appendix I. Managing Partner Profiles Using the Console

Adding Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572

Searching for Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576

Updating Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581

Deleting a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594

Disabling a Partner’s Profile—Changing the Status to Inactive . . . . . . . . . . . . . . . . . . . . . . . . 595

Enabling a Partner’s Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . 596

Note: This appendix describes how to define and manage partner profiles using the 
Trading Networks Console. This functionality in the Console is deprecated. You can now 
perform these functions using My webMethods. For instructions, see Chapter 10, 
“Defining and Managing Partner Profiles”.
For instructions on how to enable the deprecated functions in the Console, see 
information about setting Console preferences in the webMethods Trading Networks User’s 
Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 571

 I. Managing Partner Profiles Using the Console

Adding Partner Profiles

If you are using Trading Networks, you can add as many partners as you want. If you are 
using webMethods for Partners and do not already have a partner, you can add a single 
partner; webMethods for Partners allows you to maintain only a single partner. 
Before you can create partner profiles, fulfill the following prerequisites:

Prerequisite
Create and enable your Enterprise profile.
Review the fields you need to fill out for the partner profile.
Obtain the partner information that you require in the profiles on your system and 
have this information available when you create the profile.

Perform the following procedure to add a partner profile and fill in the minimum fields to 
create the profile. For instructions for how to add additional information to the profile, see 
“Updating Partner Profiles” on page 581.

To add or duplicate a base profile using the Profile screen

1 In Trading Networks Console: View > Trading Partners.

2 You can add a profile by starting with a blank profile or by duplicating an existing 
profile.
To start with a blank profile, select Trading Partners > New Trading Partner.
To duplicate an existing profile, click the row containing the profile that you want 
to duplicate and select Trading Partners > Duplicate Trading Partner.
3 On the Corporate tab, fill in information about the corporation. If you are duplicating a 

profile and the information is already provided, click   Edit Corporation Name next to 

the Corporation Name field. For more information about these fields, see “Information 
Trading Networks Maintains in a Profile” on page 113.
a In the Corporation Name field, type the name of the partner’s corporation, for 
example, “Industrial Steel Company”.
b In the Unit Name field, type the name of the organizational unit or division within 
the partner’s corporation, for example, “Sales and Marketing”.

webMethods Trading Networks Administrator’s Guide Version 7.1 572

 I. Managing Partner Profiles Using the Console

c In the Partner Type field, specify the type of software that the partner uses to 
interact with your trading network: webMethods Trading Networks, webMethods for
Partners, Web Browser, or Other/Unknown.
d In the Preferred Language field, optionally specify the language preference the 
partner uses if needed for another webMethods component (e.g., webMethods 
RosettaNet Module).
4 On the Corporate tab, specify at least on external ID.

a Click   Add New External ID located next to the External ID Type table in the Profile

Identifiers section.
b In the External ID Type field, specify the type of identification that the partner’s 
corporation uses within documents. For example, specify DUNS if the partner uses 
a D‐U‐N‐S number. Be sure to include an external ID type for each type of 
identification that you use in documents. You can specify an unlimited number of 
external ID types. 
Note: If Trading Networks is configured to create an Integration Server user 
account when you create a new profile, Trading Networks uses the value of one 
of the external IDs for the user name and randomly generates a password. You 
configure whether Trading Networks is to create a user account by using the 
tn.default.userCreation property. You define the external ID type that Trading 
Networks uses for the user name of the user account by using the tn.default.idType 
property. For more information about these properties, see Appendix D, “Trading 
Networks Configuration Properties”.
After you create the profile and Trading Networks saves it, the Console displays 
the User Account Information dialog box. This dialog box will only appear when 
the profile saved is valid and created successfully. Be sure to record the 
information and send the user name and password to your partner.
c In the Value field, specify the value of the external ID type. For example, if you 
selected DUNS and the partner D‐U‐N‐S number is 987654321, specify 987654321 
for Value. The maximum length you can specify for an external ID is 128 
characters.
d Click Save.
5 Click Create Profile.
Note: If the profile fields were not completed correctly, Trading Networks saves the 
profile; however, it displays a dialog box listing the error messages that identify the 
fields that are in error. You must edit the profile to correct the errors.

webMethods Trading Networks Administrator’s Guide Version 7.1 573

 I. Managing Partner Profiles Using the Console

Important! After creating the base profile, you should:
Fill in additional fields to complete the profile to meet your sites needs. For 
instructions for filling in the rest of the fields, see “Updating Partner Profiles” on 
page 581.
Enable the profile. By default, the profile will be inactive. After you have filled in all 
the fields you need, make it active. For instructions, see “Enabling a Partner’s 
Profile—Changing the Status to Active” on page 596.
If you have Trading Networks generate an Integration Server user account for the 
profile, provide your partner with the user name and password of the user account. 
For more information, see “Informing the Partner of the User Name and Password” 
on page 574.

Informing the Partner of the User Name and Password

If Trading Networks is configured to create an Integration Server user account when you 
create a new profile, Trading Networks uses the value of one of the external IDs for the 
user name and randomly generates a password. You configure whether Trading 
Networks is to create a user account by using the tn.default.userCreation property. You define 
the external ID type that Trading Networks uses for the user name of the user account by 
using the tn.default.idType property. For more information about these properties, see 
Appendix D, “Trading Networks Configuration Properties”.
After you create the user account, let your partner know the user name and password for 
the account that Trading Networks created. Trading Networks displays the user name 
and password after you successfully create and enable the profile. Be sure to record it. Your 
partner can use this user account when delivering documents via FTP, FTPS, HTTP, or 
HTTPS and to access the Web Manager. 
For the partner to be able to use this user account to deliver documents to your Trading 
Networks system documents or to access Web Manager, the partner must enter the user 
name and password into your profile on their Trading Networks system. The partner 
should update the Delivery Method tab of the Profile screen. On this screen, the partner 
should:
Enter the user name you supply for the User Name fields for Primary FTP, Secondary FTP, 
Primary FTPS Secondary FTPS, Primary HTTP, Secondary HTTP, Primary HTTPS, and 
Secondary HTTPS
Enter the password you supply for the Password fields for Primary FTP, Secondary FTP, 
Primary FTPS Secondary FTPS, Primary HTTP, Secondary HTTP, Primary HTTPS, and 
Secondary HTTPS.

webMethods Trading Networks Administrator’s Guide Version 7.1 574

 I. Managing Partner Profiles Using the Console

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.

To retrieve your partner’s user name and password

1 Select your partner’s profile. If you need procedures for this step, see “Finding and 
Viewing Profiles” on page 578.
2 Select Trading Partners > Show Password.
3 Trading Networks displays the user name and password for this partner profile. 
Record the user name and password.

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.

For your partner to update your profile with user name and password on the partner’s system

1 Your partner should view your profile. For your partner’s procedures to this step, see 
“Finding and Viewing Profiles” on page 578.
2 Click the Delivery Method tab.
3 Specify the following fields for Primary HTTP, Secondary HTTP, Primary HTTPS, Secondary
HTTPS, Primary FTP, Secondary FTP, Primary FTPS, and Secondary FTPS.

For this Delivery

Method tab
parameter... Perform this procedure...

User Name 1 Click the tab for the delivery method.

Password
2 Click   Edit Destination.
3 In the User Name field, your partner should specify user 
name that you supplied. In the Password field, your 
partner should specify the password that you supplied. 
4 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 575

 I. Managing Partner Profiles Using the Console

Searching for Partner 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, including your own Enterprise 
profile.
To find a specific profile, query Trading Networks for the profiles in which you are 
interested. Trading Networks returns information about the profiles that meet the search 
criteria that you specify and displays the query results in the Profiles table. 
If you plan to use the same query many times, you can save the query settings. When you 
want to use the same query again, you simply select that saved query. For more 
information about different query functions you can perform, see Appendix A, “Queries 
in Trading Networks Console”.
To set up a query and display information for viewing profiles, specify some or all of the 
following:
Basic search criteria

Custom search criteria

How to display detail view information about selected profiles.

Basic Search Criteria for Profiles

Use the Basic Criteria tab to search for profiles. The basic search criteria includes most of 
the basic corporate information found on the Corporate tab of the Trading Partners screen. 
Trading Networks searches for profiles that meet all search criteria that you specify.
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, city, state/province, and/or postal 
code.

Custom Search Criteria for Profiles

Use the Custom Criteria tab to search for profiles based on the extended profile fields. For 
example, if you set up Trading Networks with the extended profile field “Encryption 
Algorithm”, you can search for all profiles with the “Encryption Algorithm” equal to a 
specified value.

webMethods Trading Networks Administrator’s Guide Version 7.1 576

 I. Managing Partner Profiles Using the Console

For each extended profile field that you want to use to select profiles, you specify the 
attribute name, an operator, and the value the attribute should have.
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. You can 
specify attributes with the STRING data type.
Operator instructs Trading Networks how to match the value, for example, match 
string values that contain specified characters. The operator you can specify depends 
on the data type of the attribute. 

Data Type Operator Matches when the attribute extracted from a document…
STRING Is null 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.
The TN document type does not instruct 
Trading Networks to extract the attribute.
You do not need to specify a value when you specify 
this operator.
Is not null Has any value. You do not need to specify a value 
when you specify this operator.
Equals Matches exactly the value that you specify.
Not equals Has a value that does not match the value that you 
specify.
Contains Contains the character string that you specify for the 
value.

Detail View of Profiles

After Trading Networks selects the profile that matches the basic search criteria that you 
specify, it displays the results of your query in the Profiles table. You can customize this 
Profiles table to indicate the columns you want Trading Networks to display using the 
options on the Detail View tab. Each column corresponds to information that Trading 
Networks maintains about a partner profile, such as the corporation and unit names, 
external ID information, group membership, partner status, and basic corporation 
address information.

webMethods Trading Networks Administrator’s Guide Version 7.1 577

 I. Managing Partner Profiles Using the Console

Finding and Viewing Profiles

To view profiles or perform any operations on the profile, you need to first have the 
profile visible. Perform the following procedure to select the profile.

To find and view a profile

1 In Trading Networks Console: View > Trading Partners.

2 Select   Show Query on the toolbar.Trading Networks displays the Basic Criteria and 

Detail View tabs.
Note: Trading Networks displays the last query run on the Trading Networks Console.
3 Select the Basic Criteria tab and fill in the fields to specify basic search criteria. To 
indicate that you want to use one or more of the basic search criteria, select the check 
box next to each criterion you want to use. Then fill out the corresponding 
information as follows

For this Basic

Criteria tab
parameter… Specify…

Corporation The name of the partner’s corporation, for example, “Industrial 
Name Steel Company”. Type a character string contained in the 
Corporation Name of the partner you want to work with.
You can use the pattern‐matching characters “%” in the 
corporation name search.
Unit Name The name of the organizational unit or division within the 
partner’s corporation, for example, “Sales and Marketing”. type 
a character string contained in the Unit Name of the partner you 
want to work with.
External ID Type The External ID Type is the type of identification that the partner 
Value (partner’s corporation) uses within documents. The Value is the 
alpha‐numerical value of the partner’s external ID type. 
You must provide both values for the query to work. For 
example, if the partner uses a D‐U‐N‐S number as an external 
identification type, select DUNS from the External ID Type list and 
specify the partner’s D‐U‐N‐S number in the Value column.

webMethods Trading Networks Administrator’s Guide Version 7.1 578

 I. Managing Partner Profiles Using the Console

For this Basic

Criteria tab
parameter… Specify…

Group The name of the profile group that Trading Networks associates 
Membership the partner’s profile to. This column contains the complete list of 
profile groups that have been created in the database. You can 
only select one profile group from the list for each query. For 
more information about how to create profile groups, see 
“Defining Profile a Group” on page 598.
Partner Status The status of the partner’s profile. Select Active to search for an 
enabled profile or Inactive for a disabled profile.
Corporation The country where the partner’s corporation is located, for 
Country example “USA”.
Corporation City The city where the partner’s corporation is located, for example, 
“Los Angeles”.
Corporation The state or province where the partner’s corporation is located, 
State/Province for example, “California”.
Corporation The postal code (for example, a zip code) for the state or province 
Postal Code where the partner’s corporation is located, for example, “90001”.

For more information about these profile query fields, see “Information Trading 
Networks Maintains in a Profile” on page 113. 
4 Select the Custom Criteria tab and fill in the fields to specify custom search criteria for 
the extended profile field(s). For the profile query, specify a STRING extended field to 
query documents as follows.

For this Custom

Criteria tab
parameter… Specify…

Extended Field The name of the extended profile fields that you want Trading 

Networks to use to select documents. Select a STRING data type 
from the list.
Operator The operator you want Trading Networks to use with the Value 
you specify. For example, select Equal if you want Trading 
Networks to match extended fields that have the exact value you 
specify for Value.
Data Type Operator values

STRING Is null; Is not null; Equals; Not equals; Contains

webMethods Trading Networks Administrator’s Guide Version 7.1 579

 I. Managing Partner Profiles Using the Console

For this Custom

Criteria tab
parameter… Specify…

Value The value you want Trading Networks to use when querying for 
documents. 
To specify a string, type the characters in the string. Be sure to 
use the exact combination of upper‐ and lowercase letters 
because Trading Networks performs a case‐sensitive match. 
You do not need to specify a value if you select Is null or Is not null
for Operator.

For more information about extended profile fields, see “Extended Fields” on 
page 124. For more information about how to use custom criteria, see “Custom Search 
Criteria for Profiles” on page 576.

5 Select  Run Query on the toolbar. Trading Networks displays the Profiles table with 

the results from the refined query.
6 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 panel, check 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.
b In the Extended Fields section, to select the extended fields that you want Trading 
Networks to include in the Detail view, move the fields to the Selected Extended
Fields list. 

c To see the new display format, click   Run Query.

7 To view a partner profile, double click to select the partner you want from query 
results in the Profiles table on the bottom portion of the screen.

webMethods Trading Networks Administrator’s Guide Version 7.1 580

 I. Managing Partner Profiles Using the Console

Updating Partner Profiles

You can update the partner profiles that you maintain for your partners. 

To update the profile of one of your partners using the Console

1 Select the partner whose profile you want to update. If you need procedures for this 
step, see “Finding and Viewing Profiles” on page 578.
2 To update an existing partner profile, see the following sections based on the changes 
you want to make to your profile. When updating the profile, note that fields that you 
must specify are in blue and are marked with an asterisk (*) on the screen.
“Updating the Corporation Information in a Partner Profile” on page 581
“Managing Addresses for the Corporation in a Partner Profile” on page 582
“Managing External IDs in a Partner Profile” on page 583
“Managing the Partner Profile Group Memberships” on page 584
“Managing Contacts in a Partner Profile” on page 584
“Managing Delivery Methods in a Partner Profile” on page 586
“Managing Reliable Delivery and Polling Settings in a Partner Profile” on 
page 590
“Updating Extended Fields in a Partner Profile” on page 591
“Managing Security Information in a Partner Profile” on page 592
3 After updating all of the partner profile fields, make sure to click Save to save all your 
changes to the profile.

Updating the Corporation Information in a Partner Profile

You can add or change the corporation information.

To update the corporation information in a profile

1 After selecting the profile you want to update (using the procedure in “Finding and 
Viewing Profiles” on page 578), select the Corporate tab, if it is not already selected. For 
information about the fields on this tab, see “Information Trading Networks 
Maintains in a Profile” on page 113.

2 Click   Edit Corporation Name next to the Corporation Name field.

webMethods Trading Networks Administrator’s Guide Version 7.1 581

 I. Managing Partner Profiles Using the Console

3 In the Corporation Name field, type the corporation name, for example, “Industrial Steel 
Company”.
4 In the Unit Name field, type the name of the organizational unit or division for the 
corporation, for example, “Sales and Marketing”.
5 In the Partner Type field, specify the type of software the corporation uses to interact 
with your trading network: webMethods Trading Networks or webMethods for Partners.
6 In the Preferred Language field, optionally specify the language preference the 
corporation uses if needed for another webMethods component (e.g., webMethods 
RosettaNet Module).
7 Click Save.

Managing Addresses for the Corporation in a Partner Profile

You can add, edit, and delete addresses for the corporation.

To update the addresses for a corporation in a profile

1 After selecting the profile you want to update (using the procedure in “Finding and 
Viewing Profiles” on page 578), select the Corporate tab, if it is not already selected. For 
information about the fields on this tab, see “Information Trading Networks 
Maintains in a Profile” on page 113.
2 To add or edit address:

a To add, click   Add New Address. 

To edit, select the tab containing the address you want to edit; then click   Edit
Address.
b Specify the following fields:

For this corporate

parameter… Specify…

Country The country where the corporation is located, for example, 
“USA”.
Address The street address for the corporation, for example, “123 
Main Street, Suite 456”.
City The city where the corporation is located, for example, “Los 
Angeles”.

webMethods Trading Networks Administrator’s Guide Version 7.1 582

 I. Managing Partner Profiles Using the Console

For this corporate

parameter… Specify…

State/Province The state or province where the corporation is located, for 
example, “California”.
Postal Code The postal code (for example, a zip code) for the state or 
province where the corporation is located, for example, 
“90001”.

c Click Save.
3 To delete an address:
a Select the tab containing the address you want to delete.

b Click   Delete Address.

Managing External IDs in a Partner Profile

You can add, edit, or delete external IDs. Be sure to include an external ID type for each 
type of identification that the partner uses in documents. You can specify an unlimited 
number of external ID types.

To update external IDs for a partner profile

1 After selecting the profile you want to update (using the procedure in “Finding and 
Viewing Profiles” on page 578), select the Corporate tab, if it is not already selected. For 
information about the fields on this tab, see “Information Trading Networks 
Maintains in a Profile” on page 113.
2 To add or edit an external ID:

a To add and external ID, click   Add New External ID. 

To edit, select the row you want to edit, then click   Edit External ID.

b In the External ID Type field, select the external ID type.
c In the Value field, specify the value of the external ID type. For example, if you 
selected DUNS and your D‐U‐N‐S number is 987654321, specify 987654321 for 
Value. The maximum length you can specify for an external ID is 128 characters.
d Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 583

 I. Managing Partner Profiles Using the Console

3 To delete an external ID:
a Select the row containing the external ID you want to delete.

b Click   Delete External ID.

Managing the Partner Profile Group Memberships

You can add or remove the profile from profile groups.

Note: You can only associate profiles with a profile group if there are profile groups 
defined in the database. To add a new profile group, see “Defining Profile a Group” on 
page 598.

To update the profile group membership for the profile

1 After selecting the profile you want to update (using the procedure in “Finding and 
Viewing Profiles” on page 578), select the Corporate tab, if it is not already selected. For 
information about the fields on this tab, see “Information Trading Networks 
Maintains in a Profile” on page 113.
2 To add the profile to a profile group:

a Click   Add New Profile Group next to Profile Group Membership. 

b Select the profile group name from the list of available groups.
c Click Save.
3 To remove your profile from a profile group:
a Select the row containing the profile group from which you want to remove your 
profile.

b Click   Delete From Profile Group Membership.

Managing Contacts in a Partner Profile

You can add, edit, or delete contacts. You can specify an unlimited number of contacts. 

To update contacts for a partner profile

1 After selecting the profile you want to update (using the procedure in “Finding and 
Viewing Profiles” on page 578), select the Contacts tab. For information about the 
fields on this tab, see “Contacts” on page 116.

webMethods Trading Networks Administrator’s Guide Version 7.1 584

 I. Managing Partner Profiles Using the Console

2 To add or edit a contact:

a To add a contact, click   Add New Contact on the right side of the screen.

To edit a contact, Select the row containing the name of the contact you want to 

edit; then, click   Edit Contact.

b Specify the following fields for the contact:

For this contact

parameter… Specify…

Contact Type The type of contact, for example, “Administrative”. Select a 

contact type from the list.
Role The role the contact has in the partner’s corporation. This 
might be a job title, for example, “Trading Network 
Administrator”.
Last Name The contactʹs last (surname) name.

Note: To sort the contacts’ last names alphabetically, click on 
the Name column heading for forward () and reverse () 
alphabetization.

First Name The contactʹs first (given) name.

E-mail The contactʹs e‐mail address, for example, 
“[email protected]”.
Telephone The contactʹs telephone number, for example, 
“1‐800‐555‐1234”.
Extension The contactʹs extension number. If the telephone number in 
the Telephone field identifies the main line for the corporation, 
use the Extension field to identify the contactʹs extension. 
Pager The contactʹs pager number, for example, “1‐330‐555‐7890”.
Fax The contactʹs fax number, for example, “1‐888‐555‐4897”.
Address The street address for the contact, for example, “123 Main 
Street, Suite 456”.
City The city where the contact is located, for example, “Los 
Angeles”.
State/Province The state or province where the contact is located, for 
example, “California”.
Postal Code The postal code (for example, a zip code) for the state or 
province where the contact is located, for example, “90001”.

webMethods Trading Networks Administrator’s Guide Version 7.1 585

 I. Managing Partner Profiles Using the Console

c Click Save.
3 To delete a contact:
a Select the contact you want to delete from the Name list.

b Click   Delete Contact.

Managing Delivery Methods in a Partner Profile

You can add, edit, or delete delivery methods. Delivery methods specify how your 
Trading Networks system delivers documents to the partner associated with a profile. 
The Deliver document processing action uses the settings on the Delivery Method tab. For 
more information about the Deliver Document By processing action, see “Action 4—Deliver 
the Document to the Receiver” on page 365.

To update delivery methods for a partner profile

1 After selecting the profile you want to update (using the procedure in “Finding and 
Viewing Profiles” on page 578), select the Delivery Methods tab. For information about 
the fields on this tab, see “Delivery Settings” on page 118.
2 To add or edit a delivery method:

a To add a delivery method, click   Add New Destination.

To edit a delivery method, select the tab for the delivery method you want to edit; 

then, click   Edit Destination. 

b In the Protocol field, select a delivery method from the list. Trading Networks 
updates the information on the tab screen to display the fields required for the 
protocol you selected.
Note: If you selected Queue for delivery as your delivery method, see step 4 on 
page 587 for instructions on how to specify information for this delivery method. 
c For an HTTP, HTTPS, FTP, or FTPS delivery method, in the Host field, specify the 
host name of the partner’s system, for example, “IndustrialSteel.com”. 
d For an HTTP, HTTPS, FTP, or FTPS delivery method, in the Port field, specify the 
port number on which the partner’s system listens for incoming requests, for 
example, “5555”.
Note: If you do not supply a port number, Trading Networks uses the following 
defaults: HTTP—80; HTTPS—443; FTP or FTPS—21.

webMethods Trading Networks Administrator’s Guide Version 7.1 586

 I. Managing Partner Profiles Using the Console

e For an HTTP, HTTPS, FTP, or FTPS delivery method, specify one of the following 
in the Location field:
For HTTP and HTTPS delivery methods, specify the URL Trading Networks 
is to use when sending a document to the partner’s system, for example, 
“cgi‐bin/acceptOrder”. If the partner is using Trading Networks, the URL is 
typically, “/invoke/wm.tn/receive”. 
For FTP and FTPS delivery methods, specify the directory path on the 
partner’s system identified by Host and Port. Trading Networks delivers the 
document to this directory.
f For an HTTP, HTTPS, FTP, or FTPS delivery method, in the User Name field, 
specify the user name that your Trading Networks system is to supply when 
connecting to the partner’s system to deliver documents.
If you are creating a profile for a partner that uses webMethods Trading 
Networks or webMethods for Partners, you must specify the user name for your 
user account on the partner’s system. The user account can be either an Integration 
Server user account or My webMethods user account; however, it must be a user 
account that has partner authority; that is, a member of the TNPartners IS group.
Note: If you do not know what to specify for User Name, contact the partner.
g For an HTTP, HTTPS, FTP, or FTPS delivery method, in the Password field, specify 
the password that your Trading Networks system is to supply (along with User
Name) when connecting to the partner’s system.
h When defining the delivery method that the partner prefers that you use to 
deliver documents to its system, select the Use as preferred protocol check box.
Note: You cannot select the Queue for delivery as the preferred protocol.
Trading Networks displays the preferred protocol at the top of the Delivery Method 
tab.
i Click Save.
3 To delete a delivery method from the profile:
a Select the tab for the delivery method you want to delete.

b Click   Delete Contact.

4 If you added Queue for delivery as the delivery method (in the Protocol field), select 
which type of queue: Use Public Queue or Use Private Queue.
Note: You cannot use either the public or private queue as your preferred protocol.
Then set the following parameters on the New Protocol tab of the Delivery Method tab. 

webMethods Trading Networks Administrator’s Guide Version 7.1 587

 I. Managing Partner Profiles Using the Console

5 To use a public queue:
a Select Use Public Queue.
b Specify which public queue to use to deliver documents from the Public Queues 
list. The public queues were defined on the Tools menu of the Console. For more 
information about the public queue fields, see “Defining Public Queues” on 
page 413.
If you want to review the setting for the public queue, click the View button.
c Click Save.
6 To use a private queue:
a Select Use Private Queue.
b Click Edit and fill in the fields on the Settings and Schedule tabs.
c Set the following Settings tab parameters to specify private queue settings. 

For this
parameter… Specify…

Delivery Service Which delivery service to use with the private queue. 

Set Inputs The inputs for the delivery service.
Queue State The state of the queue (Enable Queue, Disable Queue, Drain
Queue, or Suspend Delivery). 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 states for private queues are the same states as for public 
queues. For a description of each queue state, “Scheduled 
Delivery Queue States” on page 408

d Set the following Schedule tab parameters for the private queue delivery settings. 
The scheduling fields for a private queue are the same as for a public queue. See 

webMethods Trading Networks Administrator’s Guide Version 7.1 588

 I. Managing Partner Profiles Using the Console

“Delivery Schedule for Queues” on page 405 for more information about the 
schedule settings.

For this
parameter… Specify…

Run Once In the Date field the date on which you want Trading 

Networks to execute the delivery service. 
In the Time field the time at which you want Trading 
Networks to execute the delivery service. “Using the Run 
Once Option” on page 406
Simple Interval The number of seconds that you want Trading Networks to 
wait between executions of the delivery service in the Interval 
field. 
If you want Trading Networks to wait for a delivery service 
to complete execution before it starts the next scheduled 
execution of the service, check Do not overlap task.
When you add or update a simple interval schedule for a 
queue that is Enabled or Draining, Trading Networks invokes 
the service immediately. Subsequent invokes are governed 
by the interval. For more information, see “Using the Fixed 
Interval Option” on page 407
Complex Interval Settings that indicate when and how often you want the 
delivery service to execute. For descriptions of these fields 
and examples of setting them, see “Using a Custom Interval 
Option” on page 407.

e Click OK.
f Click Save. 

webMethods Trading Networks Administrator’s Guide Version 7.1 589

 I. Managing Partner Profiles Using the Console

Managing Reliable Delivery and Polling Settings in a Partner

Profile
Trading Networks uses reliable delivery settings when delivering documents to a partner 
and reliable delivery is being used. For more information about reliable delivery, see 
“Using Reliable Delivery with Immediate Delivery Method” on page 367 and “Using 
Reliable Delivery with Scheduled Delivery” on page 368. 
Trading Networks uses the polling settings to polling for documents that are waiting in 
the partner’s system.

To update reliable delivery and polling settings in a partner profile

1 After selecting the profile you want to update (using the procedure in “Finding and 
Viewing Profiles” on page 578), select the Delivery Methods tab. For information about 
the fields on this tab, see “Delivery Settings” on page 118.

2 Click on   Edit Access Information. The settings are located on the bottom portion of 

the tab.
3 In the Delivery Maximum Retries field, specify the number of times you want Trading 
Networks to attempt to re‐deliver a document to the partner when Trading Networks 
is using reliable delivery. Specify a whole number.
Note: The Delivery Maximum Retries, Wait Between Retries, and Retry Factor options are only 
used when Trading Networks is using reliable delivery (delivery tasks). The Delivery
Maximum Retries option is used for both immediate and scheduled delivery methods.
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. Trading Networks uses the Retry Factor 
along with the Wait Between Retries value to calculate how long to wait for subsequent 
retry attempts.
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). 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.
5 In the Retry Factor field, 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. Trading 
Networks calculates the time to wait by multiplying the last wait time by Retry Factor. 
Specify a whole number greater than zero for Retry Factor.

webMethods Trading Networks Administrator’s Guide Version 7.1 590

 I. Managing Partner Profiles Using the Console

6 In the Polling Method field, specify the method (e.g., Primary HTTP) that your Trading 
Networks system uses to contact the partner’s system to request queued documents. 
Select the method from the list.
Note: If you do not want your Trading Networks system to poll for documents, select 
the blank entry.
7 Click Save.

Updating Extended Fields in a Partner Profile

You can edit the values for the extended fields.

To update extended fields in a partner profile

1 After selecting the profile you want to update (using the procedure in “Finding and 
Viewing Profiles” on page 578), select the Extended Fields tab. For information about 
the fields on this tab, see “Extended Fields” on page 124.
2 Select the name of the group that contains the extended profile field you want to edit. 
Trading Networks displays the corresponding extended fields on the right.
Note: If there are no extended profile fields in a specific group, Trading Networks does 
not list that group. For example, if you have not defined any extended profile fields 
for the “Corporate” group, “Corporate” will not appear in the Group column. See 
“Extended Profile Fields” on page 137 on how to add and define extended fields.

3 Click   Edit Field to fill in the fields for the appropriate group.

Note: If you do not know what to specify for an extended field and the description 
does not indicate what to specify, contact your Trading Networks administrator to 
determine what to specify.
4 Click Save.
Note: You must save the changes you make to one group’s extended fields before you 
can add another group’s extended fields. Repeat this step for each extended field you 
want to update.

webMethods Trading Networks Administrator’s Guide Version 7.1 591

 I. Managing Partner Profiles Using the Console

Managing Security Information in a Partner Profile

You can view, add, and delete certificates and private keys.

Note: Trading Networks Console will not display private key information. If a key is 
defined, Defined appears in the text field. If a key is not defined, <Empty> appears in the text 
field.

To update security setting in a partner profile

1 After selecting the profile you want to update (using the procedure in “Finding and 
Viewing Profiles” on page 578), select the Security tab. For information about the fields 
on this tab, see “Certificates” on page 125.

Use this sub-tab… To …

Sign/Verify Specify certificate information that Trading Networks uses to 
verify the digital signature of documents that were digitally 
signed by this partner.
Decrypt/Encrypt  Specify certificate information that can be used to encrypt 
information that is being sent to a partner.
SSL Client Enable Trading Networks to act as an SSL client to connect to a 
remote secure server.

2 To view information about a certificate:
a Select the partner from the Partner list on the left.
b Select the appropriate certificate sub tab: Sign/Verify, Decrypt/Encrypt, or SSL Client. 
Trading Networks displays the certificate information.
c Click the appropriate row of the Certificate Chain table. The Console displays the 
certificate information on the right.
3 To add a certificate chair:

a Click   Edit Selected.

b Click   Add Certificate(s).

webMethods Trading Networks Administrator’s Guide Version 7.1 592

 I. Managing Partner Profiles Using the Console

c In the Add Certificate dialog box, add one or more certificates as follows:
To add one certificate, browse to and select the file that contains the 
certificate.
Note: When you add a certificate, be sure also to add the CA certificate(s) and 
private key that are associated with the certificate. The certificates, CA 
certificates, and private keys must reside in your file system. Trading 
Networks can import files that have a .der, .cer, or .p7b extension. If you import 
a .der file, Trading Networks appends it to the existing certificate chain list. 
However, if you import a .cer or .p7b file, Trading Networks replaces the 
certificate chain list with the .cer or .p7b file.
To add multiple certificates within a directory, browse to and select the files 
that contain the certificates, using the SHIFT + CONTROL keys. If you select 
an entire directory, Trading Networks imports all files except duplicate files 
and private key files.
Note: The order that Trading Networks displays the certificate chain does not 
reflect how the chain is linked.
4 To delete certificates:

a Click   Edit Selected.

b Select the certificate(s) that you want to delete. To select multiple certificates, 
press CTRL and click on the second and subsequent certificates.

c Click   Delete Certificate(s). When Trading Networks prompts you to verify that 

you want to delete the certificate(s), click Yes.
Note: If you delete the certificate, be sure also to delete the CA certificate(s) and private 
key that are associated with the certificate.
5 To add a private key:

a Click   Edit Selected.

b Click   Import Private Key in the Private Key field. 

c In the Import Private Key dialog box, browse to and select the file that contains 
the private key that you want to add. You can only import a .der file that contains 
a valid private key format. Once you select the file, then click Open. 
Note: If you add a private key, be sure also to add the certificate and CA 
certificate(s) that are associated with the private key.

webMethods Trading Networks Administrator’s Guide Version 7.1 593

 I. Managing Partner Profiles Using the Console

6 To delete a private key:

a Click   Edit Selected.

b Click   Delete Private Key. When Trading Networks prompts you to verify that 

you want to delete the private key, click Yes.
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.
7 Click Save.

Deleting a Profile
When you delete a profile from the Trading Networks Console, Trading Networks 
removes most of the profile data from its database, but keeps all documents, entries, and 
TPAs that are associated with the partner. You are no longer able to view the profile or any 
related TPAs.
If you decide to delete a profile, you must also delete all related TPAs before deleting the 
profile.

Note: You cannot delete your own Enterprise profile.

Trading Networks does not provide a way to “undelete” a profile. If a partner sends you a 
document after you delete its profile, Trading Networks treats the document as if it came 
from an unknown partner.

Important! If Trading Networks created a Integration Server or My webMethods user account 
for a partner and you delete the associated partner profile, Trading Networks does not 
delete the user account. 
To delete an Integration Server user account, use the Server Administrator. For 
instructions, see the webMethods Integration Server Administrator’s Guide.
To delete a My webMethods user account, use the Administration > System‐Wide > 
User Management > Users page. For instructions, see the My webMethods Server 
Administrator’s Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 594

 I. Managing Partner Profiles Using the Console

To delete a partner’s profile using the Console

1 Select the partner whose profile you want to delete. If you need procedures for this 
step, see “Finding and Viewing Profiles” on page 578.

Important! Before you delete any profile, you must delete any related TPAs. For more 
information, see “Deleting a TPA” on page 218.

2 Select Trading Partners > Delete Trading Partner to delete the profile. 

3 When Trading Networks prompts you to verify that you want to delete the profile, 
click Yes.

Disabling a Partner ’s Profile—Changing the Status to Inactive

When you disable a profile, Trading Networks changes the status of the profile to 
“Inactive”. When you disable a partner’s profile, you will not be able to exchange 
documents with that partner. As a result, disabling a profile can be thought of as 
temporarily removing a partner from your network. If the partner attempts to send you 
documents while its profile is disabled, 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 administrator

Responds to the sender with an HTTP 403 message if the document was sent using 
HTTP.
For more information about profile statuses, see “Profile Statuses” on page 127.

To disable a partner’s profile using the Console

1 Select the partner whose profile you want to update. If you need procedures for this 
step, see “Finding and Viewing Profiles” on page 578.
2 Select Trading Partners > Enable Trading Partner. 

Important! When you disable a partner’s profile, Trading Networks does not disable or 
delete the Integration Server or My webMethods user account for the partner. To 
delete the user account, use the Server Administrator or My webMethods. For more 
instructions, see the webMethods Integration Server Administrator’s Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 595

 I. Managing Partner Profiles Using the Console

Enabling a Partner ’s Profile—Changing the Status to Active

When you enable a profile, Trading Networks changes the status of the profile to “Active”. 
If you enable your own profile, you will be able to exchange documents with partners. If 
you enable a partner’s profile, you will be able to exchange documents with that partner. 
As a result, enabling a profile can be thought of as reestablishing a partner into your 
network. For more information about profile statuses, see “Profile Statuses” on page 127.

To enable a partner’s profile using the Console

1 Select the partner whose profile you want to update. If you need procedures for this 
step, see “Finding and Viewing Profiles” on page 578.
2 Select Trading Partners > Enable Trading Partner.

webMethods Trading Networks Administrator’s Guide Version 7.1 596

Appendix J. Managing Profile Groups Using the Console

What are Profile Groups? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598

Defining Profile a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598

Viewing the List of Profile Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598

Updating a Profile Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598

Associating Profiles with Profile Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599

Deleting a Profile Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599

Note: This appendix describes how to define and manage profile groups using the Trading 
Networks Console. This functionality in the Console is deprecated. You can now perform 
these functions using My webMethods. For instructions, see Chapter 11, “Defining and 
Managing Profile Groups”.
For instructions on how to enable the deprecated functions in the Console, see 
information about setting Console preferences in the webMethods Trading Networks User’s 
Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 597

 J. Managing Profile Groups Using the Console

What are Profile Groups?

A profile group is a logical user‐defined group that you associate a profile with. For 
example, you can create a group profile named “Buyers” to associate all of your partner 
profiles who are buyers in your trading network.

Defining Profile a Group

To define profile groups, perform the following procedure.

To define a profile group using the Console

1 In Trading Networks Console: Tools > Registry > Profile Groups.

2 Click  Add Profile Group. 

Trading Networks adds a row for the new profile group.
3 Type the name of the group you want to add.
4 Click Close.

Viewing the List of Profile Groups

To view the list of profile groups that are defined, perform the following procedure.

To view the list of profile groups using the Console

1 In Trading Networks Console: Tools > Registry > Profile Groups.

Trading Networks displays the Profile Groups dialog box that lists the profile groups.
2 Click Close.

Updating a Profile Group

To update a profile group, perform the following procedure.

To update a profile group using the Console

1 In Trading Networks Console: Tools > Registry > Profile Groups.

2 Select the row containing the profile group that you want to update.

webMethods Trading Networks Administrator’s Guide Version 7.1 598

 J. Managing Profile Groups Using the Console

3 Click  Edit Selected Profile Group. 

4 Update the name of the group.
5 Click Close.

Associating Profiles with Profile Groups

After you create a profile group, you can associate a partner profile (including your 
Enterprise profile) with any profile group and to more than one group.

To associate a profile to one or more profile groups using the Console

1 Select the profile you want to work with. If you need procedures for this step, see 
“Searching for Partner Profiles” on page 576.

2 Click   Add to Profile Group Membership located next to the Profile Group Membership 

table.
Trading Networks adds a row to the table with a list from which you can select a 
profile group.
3 Select the group to which you want to associate the profile.
4 To associate the profile with additional profile groups, repeat step 2 and step 3.
5 Click Save.
6 Click OK.

Deleting a Profile Group

To delete a profile group, perform the following procedure.

To delete a profile group using the Console

1 In Trading Networks Console: Tools > Registry > Profile Groups.

2 Select the row containing the profile group that you want to delete.

3 Click  Delete Selected Profile Group. 

4 Click Close.

webMethods Trading Networks Administrator’s Guide Version 7.1 599

 J. Managing Profile Groups Using the Console

webMethods Trading Networks Administrator’s Guide Version 7.1 600

Appendix K. Managing Queues Using the Console

About Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602

About Scheduled Delivery Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602

Defining Private Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608

Defining Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611

Deleting Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613

Deleting Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613

Changing the State of a Private Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613

Changing the State of a Public Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614

About Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614

Defining Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615

Viewing Documents that Are Queued for Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616

Note: This appendix describes how to define and manage queues using the Trading 
Networks Console. This functionality in the Console is deprecated. You can now perform 
these functions using My webMethods. For instructions, see Chapter 17, “Defining and 
Managing Queues in Trading Networks”.
For instructions on how to enable the deprecated functions in the Console, see 
information about setting Console preferences in the webMethods Trading Networks User’s 
Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 601

 K. Managing Queues Using the Console

About Queues
A queue in Trading Networks is a grouping of outbound documents that can be delivered 
in batch. Note that a Trading Networks queue is not a queue in the traditional sense. 
Instead, it is a set of rows in the Trading Networks database. When documents are placed 
in a queue, Trading Networks does not deliver them immediately, rather, Trading 
Networks delivers them based on a schedule defined for the queue.
Trading Networks supports queues for two different purposes— scheduled delivery and 
polling.

For more information about delivery methods and queues, see Chapter 6, ʺDelivering 

Documents to Partnersʺ in the webMethods Trading Networks Concepts Guide.

About Scheduled Delivery Queues

A scheduled delivery queue is a queue for batching documents to be sent to the receiving 
partners at scheduled times. You define one or more queues that Trading Networks uses 
for scheduled delivery. 
A scheduled delivery queue does not contain documents. Instead, it contains delivery 
tasks that are associated with documents. All scheduled deliveries use reliable delivery. 
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 
partner’s profile. To use a scheduled delivery queue for a partner, you add the “Queue for 
delivery” delivery method and define the queue settings in the profile’s delivery settings.
To have Trading Networks deliver a document using scheduled delivery, you select the 
scheduled delivery method in the processing rules with the Deliver Document By processing 
action. 

For more information about 

Scheduled delivery and queues, see Chapter 6, ʺDelivering Documents to Partnersʺ 
in the webMethods Trading Networks Concepts Guide.
Delivery information on the partner’s profile, see “Delivery Settings” on page 118.

Scheduled delivery and the Deliver Document By processing action, see “Scheduled 

Delivery” on page 368.

As a result, when Trading Networks schedules a document for delivery, Trading 
Networks also creates a delivery task that maintains information about the delivery of the 
document. It is this delivery task that Trading Networks places in the queue. 
When you define a queue for scheduled delivery, you associate a delivery schedule and 
scheduled delivery service with the queue. The delivery schedule defines the times that 

webMethods Trading Networks Administrator’s Guide Version 7.1 602

 K. Managing Queues Using the Console

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.

For more information about 

Scheduled delivery services, see “What is a Scheduled Delivery Service?” on 
page 422.
Delivery tasks, see the webMethods Trading Networks User’s Guide.

Types of Scheduled Delivery Queues

Trading Networks supports two types of scheduled delivery queues—private and public.

Private Queues
A private queue is a queue that contains only delivery tasks that correspond to documents 
aimed for a specific receiving partner. You define private queues in the delivery settings 
of a partner’s profile. The queue will only contain delivery tasks that correspond to 
documents that are to be delivered to the partner defined by the profile.
For more information, see “Delivery Settings” on page 118 and refer to “Defining Private 
Queues” on page 608. 

Public Queues
A public queue is a queue that can contain delivery tasks that correspond to documents that 
are aimed for multiple receiving partners.
For more information, see “Defining Public Queues” on page 611.

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. When you define a scheduled delivery 
queue, you also associate a delivery schedule and a scheduled delivery service with the 
queue. 
The delivery schedule defines the times that Trading Networks invokes the scheduled 
delivery service, which acts on the delivery tasks in the queue to deliver the 
corresponding batched documents. 

webMethods Trading Networks Administrator’s Guide Version 7.1 603

 K. Managing Queues Using the Console

The delivery service acts on the delivery tasks in the queue when and how often you 
specify:
Run Once. Trading Networks executes the delivery service a single time. For more 
information, see “Using the Run Once Option” on page 604.
Fixed Interval. Trading Networks executes the delivery service repeatedly at an 
interval you specify. For more information, see “Using the Fixed Interval Option” 
on page 605. 

Note: In the Console, this option is referred to as Simple Interval.

Complex Interval. 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. 
For more information, see “Using a Complex Interval Option” on page 605.

Important! Do not attempt to use the Server Administrator to change the schedule for a 
delivery service! If you do so, the data passed to the service will be lost and the service 
will be unable to deliver documents. Always use the Trading Networks Console to change 
the delivery schedule and other queue settings

 For more information about scheduled delivery services, see “What is a Scheduled 
Delivery Service?” on page 422.

Using the Run Once Option

When you schedule a queue delivery using the Run Once option, Trading Networks 
executes the delivery service one time on the date and at the time that you specify. At that 
time, Trading Networks uses the scheduled delivery service to act on all the delivery tasks 
in the queue. 
When using the Run Once option, delivery tasks can get “stuck” in the queue. If the 
scheduled delivery service fails to deliver documents associated with the delivery tasks in 
the queue, the delivery tasks remain in the queue. Also, once scheduled delivery service is 
invoked, Trading Networks does not act on new tasks added to the queue. These tasks 
will remain in the queue with a QUEUED status. Because the queue is set up to run the 
scheduled delivery service only one time, Trading Networks will not act on the QUEUED 
tasks again unless you update the queue schedule.
Trading Networks includes the Run Once option for use in a development environment.

Note: If the scheduled run‐time occurs when the server is not running, when you initialize 
server, the server throws an exception.

webMethods Trading Networks Administrator’s Guide Version 7.1 604

 K. Managing Queues Using the Console

Using the Fixed Interval Option

When you schedule a queue delivery using the Fixed Interval option, Trading Networks 
executes the delivery service for the first time immediately after you add the delivery task. 
Trading Networks continues to execute the delivery service at the interval you specify. 
For example, you might want Trading Networks to execute the delivery service every 24 
hours.
By default, when you schedule a delivery service to repeat, Trading Networks bases the 
repeat interval on when the task starts. For example, if you specify a repeat interval of 
3600 seconds, Trading Networks starts the task and schedules the next execution for 3600 
seconds after the previous execution began. 
There might 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. 
For example, suppose your delivery service is scheduled to run every minute, but 
sometimes takes longer than that to complete. By default, Trading Networks will start the 
next subsequent execution even though the previous one has not yet completed. To have 
Trading Networks wait for the service to complete before beginning its next scheduled 
execution, check the Do not overlap task box.
With the Fixed Interval option, there is no end date or time associated with a repeating 
delivery task. Trading Networks continues to execute the delivery service until you 
change the queue schedule. If you want to specify an end date or time, use a complex 
interval option, described below.

Note: In the Console this option is referred to as Simple Interval.

Using a Complex Interval Option

Using a complex interval option offers the greatest flexibility for specifying when you 
want Trading Networks to execute the delivery service for the queue. You can specify a 
date range for when you want Trading Networks to execute the delivery service. For 
example, you can define the date range so that the first run of the service is in the future. 
You can also specify that you do not want an end date, which indicates that Trading 
Networks will execute the delivery service indefinitely on the schedule you define.
After specifying a date range, you can specify whether you want the service to run hourly, 
daily, weekly, monthly, or yearly. 

Scheduled Delivery Queue States

You can manage your scheduled delivery queues by enabling, disabling, draining, and 
suspending them. These actions change the state of the queue, which defines whether 

webMethods Trading Networks Administrator’s Guide Version 7.1 605

 K. Managing Queues Using the Console

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. 

State Meaning
Enabled Trading Networks can place delivery tasks into 
IN Enabled OUT
the queue and can invoke the scheduled delivery 
service to deliver the documents that are 
associated with the delivery tasks in the queue.
Disabled Trading Networks cannot place delivery tasks 
X Disabled X into the queue or deliver documents that are 
associated with delivery tasks in the queue.
All delivery tasks that are in the queue when you 
disable it remain in the queue. If you enable or 
drain 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.
There are two reasons you might want to disable 
a queue. 1) If the delivery service is defective and 
you need to debug and fix it, 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.
When the Deliver Document By processing action of 
a processing rule specifies to use a queue that is 
disabled, the delivery fails because Trading 
Networks cannot place the delivery task in the 
queue. Trading Networks sets the delivery task 
status to FAILED and logs a message to the 
activity log.

webMethods Trading Networks Administrator’s Guide Version 7.1 606

 K. Managing Queues Using the Console

State Meaning
Draining Trading Networks cannot place delivery tasks 
X Draining OUT
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.
Drain a queue if you want to empty it, so you can 
delete it. You can also drain a queue to perform 
maintenance changes (e.g., change queue 
settings, update delivery services).
When the Deliver Document By processing action of 
a processing rule specifies to use a queue that is 
draining, the delivery fails because Trading 
Networks cannot place the delivery task in the 
queue. In this situation, Trading Networks sets 
the delivery task status to FAILED and logs a 
message to the activity log. 
Suspended Trading Networks can place delivery tasks into 
IN Suspended X the queue, but Trading Networks cannot deliver 
documents that are associated with delivery tasks 
that are in the queue.
You might suspend a queue if a trading partner 
indicates that it is temporarily unable to accept 
documents.
All delivery tasks that are in the queue when you 
suspend it remain in the queue. If you enable or 
drain 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.

webMethods Trading Networks Administrator’s Guide Version 7.1 607

 K. Managing Queues Using the Console

Defining Private Queues

To define a private queue in a partner profile, perform the following procedure.

To define a private queue using the Console

1 Select the profile of the partner for whom you want to define a private queue. If you 
need procedures for this step, see “Searching for Partner Profiles” on page 576.
2 Select the Delivery Method tab.

3 Click   Add New Protocol.

4 In the Protocol field, select Queue for delivery.
5 Select Use Private Queue.
6 Click Edit. Trading Networks displays the Private Queue dialog box.
7 Select the Setting tab and fill in the following fields:
a From the Delivery Service field, select the delivery service to use with the private 
queue.
b Click Set Inputs and fill in the inputs to the delivery service.
c In the Queue State field, select the state of the queue (Enable Queue, Disable Queue, 
Drain Queue, or Suspend Delivery). For a description of these states, see “Scheduled 
Delivery Queue States” on page 605.

webMethods Trading Networks Administrator’s Guide Version 7.1 608

 K. Managing Queues Using the Console

8 Select the Schedule tab and fill in the schedule for how often Trading Networks should 
attempt to deliver the documents in the queue:

If you select .. Specify...

Run Once In the Date and Time fields, specify the one time you want 

Trading Networks to execute the delivery service. For more 
information, see “Using the Run Once Option” on page 604.
Simple Interval In the Interval field, the number of seconds that you want 
Trading Networks to wait between executions of the delivery 
service. 
If you want Trading Networks to wait for a delivery service to 
complete execution before it starts the next scheduled 
execution of the service, check Do not overlap task.
When you add or update a simple interval schedule for a 
queue that is Enabled or Draining, Trading Networks invokes the 
service immediately. Subsequent invokes are governed by the 
interval. For more information, see “Using the Fixed Interval 
Option” on page 605
Complex Interval Specific times when you want Trading Networks to execute 
the delivery service. 
Field Description

Start Date The date on which you want Trading Networks 

to execute the delivery service for the first time. 
If you leave this field blank, Trading Networks 
executes the task at the first date specified by 
the remaining settings.
Start Time The time at which you want Trading Networks 
to begin executing the delivery service. Specify 
the time using a 24‐hour clock. If you leave this 
field blank, Trading Networks uses 00:00:00 
(midnight).
End Date The date on which you want Trading 
Networks to execute the delivery service for 
the last time. If you leave this field blank, 
Trading Networks executes the service for an 
indefinite period of time.

webMethods Trading Networks Administrator’s Guide Version 7.1 609

 K. Managing Queues Using the Console

If you select .. Specify...

End Time The time on the last date at which you want 

Trading Networks to execute the delivery 
service. Specify the time using a 24‐hour clock. 
If you leave this field blank, Trading Networks 
uses 00:00:00 (midnight).
Months The months (January through December) that 
you want Trading Networks to execute the 
delivery service. 
Days The days of the months (1 through 31) that you 
want Trading Networks to execute the delivery 
service. 
Weekdays The days of the week (Sunday through 
Saturday) that you want Trading Networks to 
execute the delivery service. 
Hours The hours of the days that you want Trading 
Networks to execute the delivery service.
Minutes The minute of the hour that you want Trading 
Networks to execute the delivery service.

If you do not select an item for Months, Days, Weekdays, Hours, or Minutes, Trading 
Networks assumes all items for the selection. For example, if you do not specify a 
month, Trading Networks assumes you want the service to execute every month. If 
you do not select any items for any of these settings, Trading Networks assumes you 
want the service to execute every month, every day, all week days, every hour, and 
every minute; in other words, Trading Networks executes the scheduled delivery 
service every minute from the time you add the task.
If you use the Start Date and End Date to specify a date range, Trading Networks 
executes the delivery service at the scheduled times until the end of the time period. 
All delivery tasks added to the queue after the End Date are “stuck” in the queue. 
Trading Networks will not act on the queued tasks again unless you update the queue 
schedule.
9 Click OK to close the Private Queue dialog box.
10 Click Save to save your changes to the profile.
11 Click OK to close the profile.

webMethods Trading Networks Administrator’s Guide Version 7.1 610

 K. Managing Queues Using the Console

Defining Public Queues

To add a public queue to Trading Networks, perform the following procedure.

To define a public queue using the Console

1 In Trading Networks Console: Tools > Registry > Public Queues. 

2 Perform one of the following procedures to add a new public queue or to edit or 
duplicate an existing one.

Method to select queue Procedures

New— The public queue fields 
are empty. Click   Add New to add a new public queue.

Edit— Edit an existing public  1 Select the public query for which you want to 
queue’s fields. update and click to select. 

2 Click   Edit to edit the selected public 
queue.
Copy— Use this function to  1 Select the public query for which you want to 
rapidly create queues and  update and click to select.
schedules with roughly the 
same values.  2 Click   Copy Selected to copy the selected 
The public queue fields are  public queue fields.
filled with values from the 
public queue that you 
duplicate, and you can 
update any or all fields from 
the duplicated public queue.

3 Select the Setting tab and fill in the following fields:
a In the Queue Name field, a name for the queue. You can specify a string of up to 225 
alphanumeric characters. Trading Networks displays this name when listing 
available public queues.
b From the Delivery Service field, select the delivery service to use with the public 
queue. 
Out‐of‐the‐box, Trading Networks provides a single scheduled delivery service, 
Batch FTP (wm.tn.transport:batchFtp service), which uses FTP to deliver documents to a 
single destination. If you created a custom delivery service and registered them 
with Trading Networks, then you can associate your custom scheduled delivery 
services with the queues that you define. For more information about scheduled 
delivery services, see “What is a Scheduled Delivery Service?” on page 422. For 

webMethods Trading Networks Administrator’s Guide Version 7.1 611

 K. Managing Queues Using the Console

more information about custom delivery services, see “Adding and Registering 
New Delivery Services” on page 433.
c Click Set Inputs and fill in the inputs to the delivery service.
d In the Queue State field, select the state of the queue (Enable Queue, Disable Queue, 
Drain Queue, or Suspend Delivery). For a description of these states, see “Scheduled 
Delivery Queue States” on page 605.
4 Select the Schedule tab and fill in the schedule for how often Trading Networks should 
attempt to deliver the documents in the queue:

If you select .. Specify...

Run Once In the Date and Time fields, specify the one time you want 

Trading Networks to execute the delivery service. For more 
information, see “Using the Run Once Option” on page 604.
Simple Interval In the Interval field, the number of seconds that you want 
Trading Networks to wait between executions of the delivery 
service. 
If you want Trading Networks to wait for a delivery service to 
complete execution before it starts the next scheduled 
execution of the service, check Do not overlap task.
When you add or update a simple interval schedule for a 
queue that is Enabled or Draining, Trading Networks invokes 
the service immediately. Subsequent invokes are governed by 
the interval. For more information, see “Using the Fixed 
Interval Option” on page 605
Complex Interval Settings that indicate when and how often you want the 
delivery service to execute. For descriptions of these fields, see 
step 8 on page page 609.

If you use the Server Administrator to view scheduled user tasks, you will see a 
scheduled invocation of the wm.tn.queuing:deliverBatch service for each delivery queue 
you have saved. The wm.tn.queuing:deliverBatch service handles exceptions and logging, 
and invokes the scheduled delivery service you specified for the delivery queue.

Important! Do not attempt to use the Server Administrator to change the schedule for a 
delivery service! If you do so, the data passed to the service will be lost and the service 
will be unable to deliver documents. Always use the Trading Networks Console to 
change the delivery schedule and other queue settings.

5 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 612

 K. Managing Queues Using the Console

Deleting Public Queues

To use the Console to delete public queues, perform the following procedure.

To delete public queues using the Console

1 In Trading Networks Console: Tools > Registry > Public Queues.

2 Select the public query for which you want to update and click to select. 

3 Click   Delete to delete the selected public queue.

Changing the State of a Private Queue

To change the state of a private queue, perform the following procedure:

To change the state of a private queue using the Console

1 Select the profile of the partner for whom you want to define a private queue. If you 
need procedures for this step, see “Searching for Partner Profiles” on page 576.
2 Select the Delivery Method tab of the partner profile.

3 Click   Edit Destination to update the New Protocol sub‐tab.

4 Next to the Use Private Queue option, click the Edit button.
5 Select the Settings tab.
6 For Queue State, select the queue state you want: Enable Queue, Disable Queue, Drain
Queue, or Suspend Delivery.
7 Click OK.
8 Click Save.

webMethods Trading Networks Administrator’s Guide Version 7.1 613

 K. Managing Queues Using the Console

Changing the State of a Public Queue

To change the state of a public queue, perform the following procedure:

To change the queue state of a public queue using the Console

1 In Trading Networks Console: Tools > Registry > Public Queues.

2 In the Public Queues screen, select the queue that you want to change from the Queue
Name list on the left side of the screen.

3 Click   Edit Selected.

4 Select the Settings tab.
5 For Queue State, select the queue state you want: Enable Queue, Disable Queue, Drain
Queue, or Suspend Delivery.
6 Click Save.

About Queue for Polling

The queue for polling is an internally‐defined queue that contains documents. Trading 
Networks does not deliver the documents in this queue. Instead, Trading Networks waits 
for a partner to poll for the documents. When a specific partner polls for documents, 
Trading Networks returns all documents in the queue for which the polling partner is the 
receiver. Trading Networks handles the management of the queue for polling. You cannot 
enable, disable, drain, or suspend this queue. This queue is always enabled.
Your trading partners that poll your system for documents determine the method (e.g., 
HTTP) to use when requesting documents in your queue and how frequently to poll your 
system for documents. 
You can define the polling method (e.g., 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. The polling 
method and polling frequency you use for a specific partner is defined in the delivery 
settings of the partner’s profile. For more information about the polling information in 
your partner’s profile, see “Delivery Settings” on page 118.

webMethods Trading Networks Administrator’s Guide Version 7.1 614

 K. Managing Queues Using the Console

Defining Queue for Polling

You define queue for polling settings in delivery settings of partner profiles to indicate 
how your Trading Networks polls for documents in your partners’ systems. For each 
partner that you want to poll, you define the settings in that partner’s profile in the 
delivery settings.
To set up your Trading Networks system so it polls for documents on a partner’s system, 
perform the following:
:

To set up Queue for polling using the Console

1 Define the polling method and polling frequency. 
The polling method specifies how your Trading Networks system accesses a 
partner’s system to request queued documents. 
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. You specify them in the delivery 
settings of the partner’s profile. For more information, see “Delivery Settings” on 
page 118.
2 Optionally, 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. For more 
information, see “Delivery Settings” on page 118.

Additional Queue for Polling Setup for webMethods for

Partners
This section describes how to set up queue for polling for a server running webMethods 
for Partners. If you are running webMethods Trading Networks, there is no additional 
setup.

To set up Queue for polling for webMethods for Partners

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, the partner server uses the partner key and the hub server uses 
the hub key).
2 Locate the server configuration file at <ServerDirectory>\config\server.cnf, 
where ServerDirectory is the directory in which you installed the Integration Server 
running webMethods for Partners.

webMethods Trading Networks Administrator’s Guide Version 7.1 615

 K. Managing Queues Using the Console

3 In the server configuration file, ensure that the watt.server.partner property exists 
and is set properly. The property should be set to the host name for the hub 
Integration Server. For example, if the host name for the hub Integration Server were 
“HostName,” the property would be 
watt.server.partner=HostName

Note: Note: If the watt.server.partner property is missing or set incorrectly, the 
partner server will be unable to request the documents queued for it on the hub 
server. If the property exists but is set incorrectly, the partner server will throw an 
exception when attempting to request queued documents.

If the watt.server.partner property is missing or incorrect, add or update the 
property. To do so, you need to first shut down the Integration Server running 
webMethods for Partners. After you add or update the property, restart the 
Integration Server.

Viewing Documents that Are Queued for Delivery

You can search for and view information about documents that are scheduled for delivery 
or are in queued for polling. For instructions, see the webMethods Trading Networks User’s 
Guide.

webMethods Trading Networks Administrator’s Guide Version 7.1 616