You are on page 1of 520

Title Page

Building B2B Integrations

webMethods Trading Networks Administrator’s Guide

Version 8.0

May 2010

Copyright
& Docu-
ment ID

This document applies to webMethods Trading Networks Version 8.0 and to all subsequent releases.
Specifications contained herein are subject to change and these changes will be reported in subsequent release notes or new editions.
Copyright © 2000–2010 Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, United States of America, and/or
their licensors.
The name Software AG, webMethods, and all Software AG product names are either trademarks or registered trademarks of Software AG
and/or Software AG USA, Inc. and/or their licensors. Other company and product names mentioned herein may be trademarks of their
respective owners.
Use of this software is subject to adherence to Software AG’s licensing conditions and terms. These terms are part of the product
documentation, located at http://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).
This software may include portions of third-party products. For third-party copyright notices and license terms, please refer to "License
Texts, Copyright Notices and Disclaimers of Third Party Products." This document is part of the product documentation, located at
http://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).

Document ID: TN-AG-80SP1-20100521

Table of Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Documentation Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Online Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Part I. Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

1. Integration Server and Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Starting the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Starting the Integration Server from the Command Line . . . . . . . . . . . . . . . . . . . . . . . 23
Shutting Down the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Configuring Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

2. Trading Networks User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Starting the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Opening and Closing Sessions on Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Familiarizing Yourself with the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . 31
The Selector Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Selecting Trading Networks Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Selecting TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Coordinating Your Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Closing the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

3. Configuring webMethods Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Trading Networks Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Configuring the Trading Networks Database Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Trading Networks in a High Availability Environment . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Shared Trading Networks Database in a Clustered Environment . . . . . . . . . . . . . 37
Shared Trading Networks Database in a Non-Clustered Environment . . . . . . . . . 38
Separate Trading Networks Database for Each Instance of Trading Networks . . 40
Configuring Trading Networks for a Clustered Environment . . . . . . . . . . . . . . . . . . . . . . . . 41
Configuring Partner Profile Settings for the Trading Networks Console . . . . . . . . . . . . . . . 43
Configuring E-mail Settings for Document Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Configuring Tasks Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Enabling Task Failure Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 3

Table of Contents

Configuring Trading Networks for Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . 47
Minimum Hardware Requirements for Large Document Handling . . . . . . . . . . . . . . . . 48
Steps for Configuring Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Setting Properties in the Trading Networks Properties File . . . . . . . . . . . . . . . . . . 48
Increasing the Size of the Largest Document that Can Be Saved When Using DB2 50
Configuring the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Improving Trading Networks Performance During Searches . . . . . . . . . . . . . . . . . . . . . . . . 53
Set a Limit for Search Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Configuring the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Setting Properties in the Trading Networks Properties File . . . . . . . . . . . . . . . . . . 54
Delete Search Results Periodically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Configuring Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Other Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

4. Configuring My webMethods to Work with Trading Networks . . . . . . . . . . . . . . . . . . . 57
Central User Management—How Integration Server Authorizes My webMethods Users . . 58
How Trading Networks Uses Central User Management . . . . . . . . . . . . . . . . . . . . . . . 58
Setting Up Central User Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Configuring Central User Management in Integration Server . . . . . . . . . . . . . . . . 59
Identifying Trading Networks Server to My webMethods Server . . . . . . . . . . . . . . 59
Deleting Trading Networks Server to My webMethods Server . . . . . . . . . . . . . . . 60
Using One My webMethods Instance for Multiple Trading Networks Instances . . . . . . 60
How the Integration Server Authenticates a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
How the Integration Server Authorizes a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
How Trading Networks Adds My webMethods Roles to ACLs . . . . . . . . . . . . . . . . . . . 63
Defining Trading Networks Administrators for My webMethods . . . . . . . . . . . . . . . . . . . . . 64
Granting My webMethods Users the Authority to Execute Trading Networks Services . . . . 65
Defining Role-Based Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Role-Based Access is Cumulative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Data and Actions Governed by Role-Based Access . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Data and Actions Governed by General Functional Permissions . . . . . . . . . . . . . 66
Data and Actions Governed by Data Permissions . . . . . . . . . . . . . . . . . . . . . . . . . 68
Create Profile Data Permission Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Setting Up Role-Based Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Granting General Functional Permissions to a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Removing General Functional Permissions from a Role . . . . . . . . . . . . . . . . . . . . 71
Defining Data Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
About Defining Data Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Defining Data Sets and Granting Roles Permissions to Act on the Data Set . . . . 72
Removing Data Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
How Trading Networks Uses My webMethods Roles Privileges . . . . . . . . . . . . . . . . . 75
Configuring How Long My webMethods Waits for a Response . . . . . . . . . . . . . . . . . . . . . . 76
Configuring Resubmission and Reprocessing Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

4 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

Table of Contents

5. Planning Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Task 1: Identify the Types of Transactions to Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Task 2: Determine the Important Document Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Task 3: Define the Types of Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Task 4: Define Information to Maintain about Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Task 5: Create Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Task 6: Define Actions to Perform Against Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Task 7: Add Partners to Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Part II. Managing Trading Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

6. About Trading Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
How to Manage Partners in Your Trading Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Defining the Information You Want to Collect about Partners . . . . . . . . . . . . . . . . . . . 98
Creating Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Adding Profiles for Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Information Trading Networks Maintains in a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Partner Identification Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
External IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Partner Group Membership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Delivery Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Delivery Method Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
General Partner Delivery Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Extended Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Steps to Setting up Partner Profiles in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Profile Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

7. Defining and Managing Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
What are Profile Fields? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Required Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Viewing Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Updating Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Adding Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Viewing Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Duplicating an Existing Profile Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Updating Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Disabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Enabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 5

Table of Contents

8. Defining and Managing Your Profile (Your Enterprise) . . . . . . . . . . . . . . . . . . . . . . . . . 131
Creating Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Viewing Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Updating Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Updating Your Corporation Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Managing Your External IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Managing Addresses for Your Corporation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Managing the Contacts in Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Managing Your Partner Group Memberships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Managing Your Document Delivery Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Updating Extended Fields of Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Managing the My webMethods Users Associated with Your Profile . . . . . . . . . . . . . . . 145
Managing Your Security Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Adding Certificate Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Managing Certificate Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Enabling Your Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Disabling Your Profile—Changing the Status to Inactive . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

9. Defining and Managing Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Adding Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Searching for Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Performing a Keyword Search for Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Performing an Advanced Search for Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Viewing Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Updating Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Updating Your Partner’s Corporation Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Managing Your Partner’s External IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Managing Your Partner’s Addresses for the Corporation . . . . . . . . . . . . . . . . . . . . . . . 162
Managing Your Partner’s Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Managing Your Partner’s Group Memberships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Managing Reliable Delivery and Polling Settings in a Partner Profile . . . . . . . . . . . . . . 165
Managing Document Delivery Methods in a Partner Profile . . . . . . . . . . . . . . . . . . . . . 167
Updating Extended Fields in a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Managing the My webMethods Users Associated with the Partner’s Profile . . . . . . . . 174
Managing Your Partner’s Security Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Adding Certificate Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Managing Certificate Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Copying a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Suspending Delivery for a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Resuming Delivery for a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Deleting a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Disabling a Partner’s Profile—Changing the Status to Inactive . . . . . . . . . . . . . . . . . . . . . . 183
Enabling a Partner’s Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . 184

6 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

Table of Contents

Searching for Certificates that Are Expired or Expiring Soon . . . . . . . . . . . . . . . . . . . . . . . 184
Searching for Expired Partner Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Searching for Partner Certificates that Will Expire Soon . . . . . . . . . . . . . . . . . . . . . . . 185

10. Defining and Managing Partner Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
What are Partner Groups? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Defining a Partner Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Searching for Partner Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Performing a Keyword Search for Partner Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Updating a Partner Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Deleting a Partner Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

11. Defining and Managing Trading Partner Agreements (TPAs) . . . . . . . . . . . . . . . . . . . . 193
What is a Trading Partner Agreement (TPA)? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Information You Supply to Define a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Defining a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Managing TPAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Finding and Viewing TPAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Updating TPAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Changing a TPA Agreement Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Changing the TPA Data Inputs in the IS Document Type . . . . . . . . . . . . . . . . . . . 204
Deleting a TPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

Part III. Defining Transaction Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

12. Defining and Managing Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
What are Document Attributes? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Defining Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Managing Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Viewing Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Displaying Disabled Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Hiding Disabled Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Updating Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Disabling Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Enabling Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Determining the TN Document Types that Use an Attribute . . . . . . . . . . . . . . . . . . . . 216

13. Defining and Managing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
What Are TN XML Document Types? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Identification Information in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Determining the TN Document Type to Use for an XML Document . . . . . . . . . . . . . . . 225
When an XML Document Does Not Match Any TN Document Types . . . . . . . . . 225
When an XML Document Matches More Than One TN Document Type . . . . . . . 225

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 7

Table of Contents

Extraction Information In TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Important Attributes that You Should Extract from an XML Document . . . . . . . . . . . . . 226
Indicating that Attributes are Required in TN XML Document Types . . . . . . . . . . . . . . 228
Transformation Information for Extracted Attributes of TN Document Types . . . . . . . . 229
Specifying Built-In Transformation Information for SenderID and ReceiverID . . . . 230
Specifying Built-In Transformation Information for Attributes with the DATETIME and
DATETIME LIST Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Specifying Built-In Transformation Information for Attributes with the STRING or
STRING LIST Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Specifying Built-In Transformation Information for Attributes with the NUMBER Data
Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Specifying a Custom Transformation Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Setting Input and Output Values for Custom Transformation Services . . . . . 235
Namespace Mappings in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
XML Documents and Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
How Namespaces Affect Identifying and Attribute XQL Queries . . . . . . . . . . . . . . 238
Namespace Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Options in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Specifying an IS Document Type for TN XML Document Types . . . . . . . . . . . . . . . . . 241
Specifying an IS Schema for TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . 241
Disabling Processing Rule Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Specifying Pre-Processing Actions for TN XML Document Type . . . . . . . . . . . . . . . . . 242
Verifying the Digital Signature of an XML Document . . . . . . . . . . . . . . . . . . . . . . . 242
Validating the Structure of an XML Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Checking for Duplicate of the XML Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Saving an XML Document to the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Defining TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Using a Sample Document to Define a TN XML Document Type . . . . . . . . . . . . . . . . 248
Working with a Sample Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Defining a TN XML Document Type without a Sample Document . . . . . . . . . . . . . . . . 260
Managing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Viewing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Updating TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Using a Sample Document when Updating a TN XML Document Type . . . . . . . . 268
Updating a TN XML Document Type without a Sample Document . . . . . . . . . . . . 273
Disabling TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Enabling TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Testing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Submitting XML Documents to Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

14. Defining and Managing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Run-Time Processing of Flat File Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

8 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

Table of Contents

Defining Document Gateway Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Reading the Input Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Determining the Content Type and Content Encoding . . . . . . . . . . . . . . . . . . . . . 287
Converting a Flat File Document to an IS Document . . . . . . . . . . . . . . . . . . . . . . 288
Specifying the Document Gateway Services Outputs . . . . . . . . . . . . . . . . . . . . . . . . . 288
TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Pipeline Matching Criteria Used to Identify the TN Document Type . . . . . . . . . . . . . . 292
Error Conditions When Matching Documents to TN Document Types . . . . . . . . . 293
Attributes To Extract From Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Error Conditions When Extracting Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
System Attributes To Extract From Documents . . . . . . . . . . . . . . . . . . . . . . . . . . 295
SenderID and ReceiverID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
DocumentID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
ConversationID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
UserStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
GroupID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Transformation Information for Extracted Attributes of TN Flat File Document Types
297
Built-In Transformations for SenderID and ReceiverID . . . . . . . . . . . . . . . . . 297
Built-In Transformations for DATETIME and DATETIME LIST Data Type Attributes
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Built-In Transformations for STRING or STRING LIST Data Type Attributes 297
Built-In Transformations for NUMBER Data Type Attributes . . . . . . . . . . . . . 298
Custom Transformation Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Disabling Processing Rule Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Pre-Processing Actions in the TN Flat File Document Type . . . . . . . . . . . . . . . . . . . . 302
Verifying the Digital Signature of Flat File Documents . . . . . . . . . . . . . . . . . . . . . 302
Validating the Structure of Flat File Documents . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Checking for Duplicates of the Flat File Document . . . . . . . . . . . . . . . . . . . . . . . . 303
Saving Flat File Documents to the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Defining TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Managing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Viewing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Updating TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Disabling TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Enabling TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

15. Defining and Managing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
What are Processing Rules? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Processing Rules Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Adding Processing Rules and the Order of Processing Rules . . . . . . . . . . . . . . . . . . . 318
Reordering Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 9

Table of Contents

Processing Rule Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Sender and Receiver Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Document Type Criterion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
User Status Criterion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Document Recognition Errors Criterion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Extended Criteria—Using Custom Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Bypassing Lookups for Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Skip Processing Rule Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Bypass Lookup by Explicitly Specifying the Processing Rule . . . . . . . . . . . . . . . . 331
Pre-Processing Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Creating a Duplicate Document Check Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Processing Rule Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Action 1—Execute a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Executing the Service Synchronously or Asynchronously . . . . . . . . . . . . . . . . . . . 335
Service Execution Tasks and Reliable Execution . . . . . . . . . . . . . . . . . . . . . . . . . 337
Creating the Service for the Execute a Service Processing Action . . . . . . . . . . . . 339
Input and Output Variables for the Service . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Setting Values for the Input Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Logic for the Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Action 2—Send an Alert E-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Recipient of the E-mail Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Subject of the E-mail Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Body of the E-mail Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Action 3—Change User Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Action 4—Deliver the Document to the Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Immediate Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Using Reliable Delivery with Immediate Delivery Method . . . . . . . . . . . . . . . 346
Scheduled Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Using Reliable Delivery with Scheduled Delivery . . . . . . . . . . . . . . . . . . . . . . 347
Queued for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Preferred Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Action 5—Respond With a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Specifying the Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Specifying the Content Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Defining Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Defining a Processing Rule Based on a Saved Document . . . . . . . . . . . . . . . . . . . . . . 362
Setting Up a Default Processing Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Ordering the Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Testing the Order of Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
About Querying and Viewing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Basic Search Criteria for Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Detail View of Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Finding and Viewing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

10 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

379 Private Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396 Creating a Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . 388 Changing the State of a Public Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380 Using a Custom Interval Option . . . . . . . . . . 395 Retrieving the Content of a Document for Immediate Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381 Defining Private Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378 About Scheduled Delivery Queues . . . . . . . . . . . . . 373 Part IV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .tn. . . . . . . . Setting Up Document Delivery . . . 381 Scheduled Delivery Queue States . . . . . . . . . . 398 Typical Logic to Include in the Scheduled Delivery Service . . . . 379 Using the Run Once Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378 Types of Scheduled Delivery Queues . . . . . . . . . . . . . 389 About Queue for Polling . . . . Creating Delivery Services . . 379 Delivery Schedule for Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .transport:batchFtp Service . . . . . . . . . . . . . . . . . . . . . . . . 383 Defining Public Queues . 388 Deleting Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373 Deleting Processing Rules . . . . . . . . . 390 Viewing Documents that Are Queued for Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387 Performing a Keyword Search for Public Queues . Defining and Managing Queues in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398 Required Logic to Include in the Scheduled Delivery Service . . . . . 380 Using the Fixed Interval Option . . . . . . . . . . . . . . . . . . . 397 Inputs for Scheduled Delivery Service . . . . . . . . . . 393 What is a Delivery Service? . . . . . . . . . . . . . . . . . . 389 Defining Queue for Polling . . . . . . . . . . . . . . . 397 Inputs and Outputs for a Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . .0 11 . . . . . . . . . . . . . . . . . . . . . . . . . . . 377 What is a Queue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379 Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402 The wm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391 17. . . . . . . . . . . . . . . 375 16. . . . . . . 394 What is an Immediate Delivery Service? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372 Updating Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394 Creating an Immediate Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372 Disabling Processing Rules . . . . . . . 401 Handling Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . 394 What is a Scheduled Delivery Service? . . 398 Retrieving the Content of a Document for Scheduled Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386 Searching for Public Queues Using My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388 Changing the State of a Private Queue . . . . . . 397 Outputs for Scheduled Delivery Service . . . . . . . . . . . . . . . . . . . . . . . . . 373 Enabling Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . 390 Additional Queue for Polling Setup for webMethods for Partners . . . . . . . . . . . . . . . . . . . . . . . Table of Contents Managing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . 444 Migrating Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448 Migrating TN Document Types . . . . . . . . 425 Scheduling the Archival and Deletion of Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424 Setting Up Extended Archival and Deletion Using Integration Server . . . . . . . . 418 B. 415 Selecting and Running a Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414 Creating and Saving a Query . . . . . . . . . . . . 446 Partner Data Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439 Editing Archive and Delete Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420 Archiving Documents . . . . . . . . . . . . . . . . Appendices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412 Enabling the Query Functions . . . 442 How Trading Networks Detects Items in Target System Before Importing Them . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441 About Exporting and Importing Database Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442 Trading Networks Objects that You Can Export and Import . . . . . . . . . . . . . . . . . . . . . . . 445 Partner Data . . . 425 Setting the Archival and Deletion Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Queries in Trading Networks Console . . . . . . . . . . . . . . . . . . . . 421 Setting Up Basic Archival and Deletion . . . . . . . . . .0 . . . . 416 Updating the Search Criteria for a Saved Query . . . . . . . . . Exporting and Importing Database Information . . . . . 449 Document Type Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440 Copying Archive and Delete Schedules . . . . . . . . . . . 405 Part V. . . 439 Deleting Archive and Delete Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421 Setting How Many Days to Retain Documents Before Archival and Deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418 Deleting Saved Queries . . . . . . . . . . 427 Setting the Archival and Deletion Criteria . . . . . . . . . . . . . . . . . . . . . . . . . Archiving and Deleting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Table of Contents Adding and Registering New Delivery Services . . . . . . . . . . . . . . . 417 Reverting to a Saved Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443 Dependencies For Trading Networks Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446 Migrating Profile Fields . . . . . . 432 Searching for Archive and Delete Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419 About Archiving and Deleting Documents . 417 Saving a New Query Based on an Existing Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449 12 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . 421 Scheduling the Archival and Deletion of Documents . 427 Scheduling the Archival and Deletion of Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422 Setting Up Extended Archival and Deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448 Field Definitions Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411 Running Queries in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440 C. . . . . . . . . . . . . . . . . . 416 Navigating Through the Results Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420 Deleting Documents . . . . . . . . . . . . . . . . . . . . . . . 409 A. . . . . . . . . . . . . . . . . . . . . 425 Setting Up Extended Archival and Deletion Using My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . XQL Reference . . . . . . . . . . . . . . . . . . . . . . . . 502 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . 477 Large Document Handling Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453 Migrating Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458 Suppressing the Overwrite Dialog Box and Forcing the Overwrite of Items . . . . . . . . . . . . . . 474 Document Delivery Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462 Examples . . . . . . . . . 497 E. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486 Task Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479 Performance Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Trading Networks Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480 Profile Properties . 468 Database Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455 How to Migrate Data Permissions . . . . . . . . . . . . . . . . . . . . . . . . 489 Miscellaneous Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461 tnimport Utility . 455 Exporting Database Information from the Console . . . . . . . . .0 13 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473 Debugging Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450 Processing Rules Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . 454 Public Queues Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460 tnexport Utility . . . . . . . . . . . . . 501 XQL Reference Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457 Using the Overwrite Dialog Box . . . . . . . . . 475 Document Validation Property . . . . . . . . . . . . . . . . . . . . . . 465 Overview . . . . Table of Contents Migrating Custom Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456 Importing Database Information from the Console . . . . . . . . . 453 Migrating Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459 Using the tnexport and tnimport Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450 Migrating Processing Rules . . . . . . . . . . . . . . . . . . . 473 Document Archiving Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 Alphabetical Listing of the Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463 D. . 457 Importing Items that Match With Those in the Target System . . . . . . . . . . . . . . . . . . 451 Migrating Trading Partner Agreements (TPAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471 Data Level Security Properties . . . . . . . . . . 459 Procedure for Importing Database Information from the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 Updating Properties on the Configure Properties Page . . . . . . . . . . . . . 460 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454 Migrating Data Permissions . . . . . . . . . . . . . . . . . . 471 Database Query Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 Cluster Properties . . . . . . . . . . . . . . . . . 455 Data Permission Dependencies . . . . . . . . . . . . . . . . . . . . . . . 478 Localization Properties . . . . . . . . . . . . . . . . . . 452 Agreements Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476 Flat File Property . . . . . . . .

. . . . . . . . . . . . . 518 Enabling the Delivery of Documents Using a Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512 Determining Where the Document Content is Stored . . . . 510 What You Need to Do to Use Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518 Step 3: Define a Web Services Delivery Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512 Retrieving Document Content from Hard Disk Drive Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506 Extracting DATETIMELIST or DATETIME ATTRIBUTES . . . . . . . . . . . . . . . . . 511 Creating Services that Recognize Large Document Handling . . . 507 F. . 514 Retrieving the Content for Document Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510 Features Not Available for Large Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514 Sending Large XML Documents for Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling a Document Delivery Using a Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509 Overview of Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503 Extracting Custom Attributes From XML Documents . . . . . . . . . . . . . . . . . . . . . . . . . . 515 Viewing Large Documents that Trading Networks Has Processed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Table of Contents Sample XML File . . . . . . . . . . . . . . . . . . . . . 511 Defining TN Document Type XQL Queries for Large Documents . . . . . . . . . . . . . . 519 14 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505 Extracting STRINGLIST or STRING ATTRIBUTES . . . . . . . 515 G. . . 519 Step 5: Perform Additional Steps if the Web Service Response must be a New Document . . . . . . . . . . . . . . . . . . . . .0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517 Overview . . 518 Step 1: Create a Web service connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518 Step 2: Create a Mapping Service . . . . . 502 Example XQL Queries . 505 Extracting NUMBERLIST or NUMBER ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519 Step 4: Define a Processing Rule . . . . . . . . . . . . . . . . . . . .

Narrow font Identifies storage locations for services on webMethods Integration Server. [] Indicates one or more options. Monospace Identifies text you must type or messages displayed by the system. Document Conventions Convention Description Bold Identifies elements on a user interface. Do not type the [ ] symbols.About This Guide This manual describes how to configure Trading Networks and how to plan for your trading network.subfolder:service. Identifies new terms the first time they occur in the text. Italic Identifies variables for which you must supply values specific to your own situation or environment. Type only the information inside the square brackets. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. using the convention folder. Do not type the | symbol.). Type only the information inside the curly braces... Keys you must press simultaneously are joined with a plus sign (+).. 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).0 15 . font {} Indicates a set of choices from which you must choose one. Type only the information. | Separates two mutually exclusive choices in a syntax line. It also describes how to define how you want Trading Networks to process business documents that are sent to your trading network. UPPERCASE Identifies keyboard keys. Do not type the ellipsis (. . Type one of these choices.. It provides procedures for setting up Trading Networks to build your trading network and how to manage an existing trading network. Do not type the { } symbols. Note: The webMethods Trading Networks and webMethods for Partners components perform the same functionality. 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. Indicates that you can type multiple options of the same type.

x A central directory named _documentation in the main installation directory (Software AG by default). https://empower.. For webMethods. See the Products area to:  Download products.  Get information about product availability.  Submit feature/enhancement requests. If you want to.  Download fixes and service packs.com See the Knowledge Center to:  Read technical articles and papers. 7.softwareag.. 16 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.  Learn about critical alerts.. Depending on the release of the webMethods product suite.. http://documentation...About This Guide Documentation Installation You can download the product documentation using the Software AG Installer.x The installation directory of each product.softwareag. Go to. Online Information You can find additional information about Software AG products at the locations listed below. Access the latest version of product Software AG Documentation Web site documentation.0 . Note: The Empower Product Support Web site and the Software AG Documentation Web site replace Software AG ServLine24 and webMethods Advantage.. the location of the downloaded documentation will be as shown in the table below.  Access older versions of product documentation.com Find information about product releases and Empower Product Support Web site tools that you can use to resolve problems. 8.x A central directory named _documentation in the main installation directory (webMethods by default).. 6. The documentation is downloaded to.

..  Link to external Web sites that discuss open standards and many Web technology topics.  Expand your knowledge about product documentation. demos.  Access additional articles. About This Guide If you want to. webmethods moderated by Software AG professionals. and online discussion forums.. for webMethods  Obtain technical information. online seminars.  See how other customers are streamlining their operations with technology from Software AG..com/ resources. to help you do more with Software AG technology. useful http://communities. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.  Use the online discussion forums to exchange best practices and chat with other experts. and Software AG Developer Community tutorials. code samples.0 17 . articles. and tutorials. Go to.softwareag.

0 .About This Guide 18 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25  Configuring webMethods Trading Networks . . . . . . . . . . 21  Trading Networks User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57  Planning Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .0 19 . . . . . . . . . . . . . . . . . . . . . 35  Configuring My webMethods to Work with Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .I Getting Started  Integration Server and Trading Networks . . . . . . . 79 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . .

0 .I Getting Started 20 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23  Configuring Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . .0 21 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22  Shutting Down the Integration Server . . . . . .1 Integration Server and Trading Networks  Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 22  Starting the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . 24 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . .

specifically.  To allow your partners to submit documents to Trading Networks. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. 22 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. To start the Integration Server on UNIX 1 Locate the server. Because Trading Networks is seamlessly integrated into the webMethods platform. 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.sh script file that you modified for your environment when you installed the server. Running the script as root might reduce the security of your system. how to start and shut down the server. Starting the Integration Server You must have the Integration Server running:  To set up and manage Trading Networks. select Programs > webMethods > Servers > webMethods Integration Server.0 . you installed additional packages into the webMethods Integration Server. Installing the Trading Networks added functionality to the webMethods Integration Server.1 Integration Server and Trading Networks Overview To use webMethods Trading Networks (Trading Networks). you must start the Integration Server. This chapter describes basic tasks that you will need to perform when using the server. see Administering webMethods Integration Server.  To use the Trading Networks Console. all configuration. administration. To start the Integration Server on Microsoft Windows On the Start menu. the WmPublic package must be enabled. Important! Run this script when logged in as a non-root user. Note: For Trading Networks to function properly.  To use the Trading Networks functions in My webMethods. 2 Execute this script. For more information on the WmPublic package and how to assure a package is enabled. Note: When you installed the Trading Networks.

To open the Integration Server Administrator. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. so you can record or display the activity occurring in the Integration Server. Starting the Integration Server this way allows you to override certain configuration settings. For instructions on how to start the Integration Server from the command line and a description of the parameters you can specify. It also lets you start the Integration Server in “debug” mode. Trading Networks automatically closes its session on the server.  Delay number minutes or until all client sessions are complete. click the Shutdown and Restart link. 3 Select whether you want the server to wait before shutting down or to shut down immediately. see Administering webMethods Integration Server. when you start the server again. 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). 4 Click Shutdown. 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 Integration Server Administrator screen. You can restore the session. Specify the number of minutes you want the Integration Server to wait before shutting down. After you do so. start your browser and point it to the host and port where the Integration Server is running.  Immediate. see Administering webMethods Integration Server. Shutting Down the Integration Server Shut down Integration Server to stop all the active sessions. The server and all active sessions terminate immediately. To shut down the server 1 Open the Integration Server Administrator if it is not already open.0 23 . 1 Integration Server and Trading Networks Starting the Integration Server from the Command Line There are times when it is useful to start the Integration Server from the command line. For instructions on how to view the active sessions.

you can specify the database you want to use and the parameters that control how Trading Networks delivers documents. 24 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see Chapter 3. For example.0 .1 Integration Server and Trading Networks Configuring Trading Networks You can configure the Trading Networks to suit your site. “Configuring webMethods Trading Networks”. For complete information.

. . . 29 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . 26  Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26  My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 Trading Networks User Interfaces  Overview . . . . . . . . . . . . . . . . . .0 25 . . . . . . . . . . . . . .

you can use it to define partner profiles. For Trading Networks functions. delivery tasks. If you do not have all permissions. the Integration Server must be running to use any of the user interfaces to perform Trading Networks tasks. to use Trading Networks the Integration Server must be started. Networks You can use it to define trading partner agreements (TPAs). and monitor Trading Networks transactions. My webMethods My webMethods is a web-based. If a procedure instructs you to use an item that is not available.0 . and public queues. TN document types. Trading The Trading Networks Console (Console) is a standalone Java GUI. buttons. custom Console attributes. and the activity log. My webMethods might not display pages. and/or other user interface controls required to perform the actions describe in this guide. and processing rules. see Managing B2B Integrations: webMethods Trading Networks User’s Guide. see your system administrator about acquiring the proper permissions to allow you to perform the action.2 Trading Networks User Interfaces Overview webMethods Trading Networks (Trading Networks) has the user interfaces described in the table below: User Interface Description My My webMethods is a web-based. partner groups. Also all tasks you perform to configure. and activity logs. service execution tasks. 26 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. and manage the Integration Server also affect Trading Networks. The following table lists the My webMethods pages that you use to perform Trading Networks actions. administer. For information about monitoring transactions. tasks. perform some configuration tasks. administration and monitoring webMethods user interface for managing your webMethods components. Because Trading Networks server runs within the Integration Server. administration and monitoring user interface for managing your webMethods components. The administrative tasks are described in this guide. Important! Functionality available via the My webMethods user interface is based on the permissions assigned to your My webMethods roles. In addition.

“Defining and Managing Your Profile (Your Enterprise)” and Chapter 9. see “Defining Role-Based Access” on page 65. see Chapter 8. Specifically. edit. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see “Defining Role-Based Access” on page 65. “Defining and Managing Partner Profiles”. For more information.  Add. Administration > System-Wide > Set data permissions for a My webMethods role that B2B Permissions > Data indicate the actions users in that role can take against Permissions Trading Networks data. and/or delete partner profiles. and/or delete extended profile fields.. For more information. For more information. edit.0 27 . you can identify the My webMethods roles that can:  Manage public queues  Manage partner groups  Delete a partner profile  Manage extended profile fields  Add external ID types  Show the SQL query for a search  View user preferences  Edit user preferences  View B2B configuration properties  Edit B2B configuration properties  Query expiring partner certificates  Manage the archival and deletion schedules of Trading Networks data  Manage the immediate delivery methods that you create using Trading Networks  Submit documents to Trading Networks For more information. Administration > System-Wide > Set the general functional permissions for a My B2B Permissions > General webMethods role that indicate the Trading Networks Functional Permissions actions that users in that role can perform. “Defining and Managing Profile Fields”. see Chapter 7. Administration > Integration > Manage profiles and profile fields.. 2 Trading Networks User Interfaces Navigation Selections Use to. You can: B2B > Partner Profiles  Add.

restart. and/or delete partner groups. For more information. Administration > Integration > Submit XML documents to Trading Networks using My B2B Settings > Submit webMethods. For a description of the properties. For more information. edit. see Preferences “Configuring My webMethods to Work with Trading Networks” on page 57. Administration > Integration > Set Trading Networks Server properties. 28 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see Managing B2B Integrations: webMethods Trading Networks User’s Guide. You can also stop. Administration > Integration > Set administrative settings. Monitoring > Integration > B2B Track and manage documents that Trading Networks > Transactions has processed by querying the Trading Networks database. see “Trading Networks Configuration Properties” on page 36. and/or delete public queues. or delete tasks.. “Trading Networks Configuration Properties”. For more information. reassign. Monitoring > Integration > B2B View the status and detail of delivery and service > Tasks execution tasks. see “Searching for Certificates that Are Expired or Expiring Soon” on page 184. Administration > Integration > Query for partner certificates that are expired or B2B > Partner Certificates expiring soon. For B2B Settings > Configure instructions for setting Trading Networks properties Properties from My webMethods. For more B2B > Public Queues information.2 Trading Networks User Interfaces Navigation Selections Use to. Administration > Integration > Add. For information about B2B Settings > Administrative Trading Networks administrative preferences. “Defining and Managing Queues in Trading Networks”. For more information.0 . see Managing B2B Integrations: webMethods Trading Networks User’s Guide. For more B2B > Partner Groups information. Administration > Integration > Add. see Chapter 16.. edit. see Chapter 10. “Defining and Managing Partner Groups”. see “Submitting Documents XML Documents to Trading Networks” on page 278. see Appendix D.

This includes activity while managing your partners. Monitoring > Integration > B2B Set user preferences for using My webMethods to > User Preferences perform Trading Networks functions. Trading Networks Console Use the Trading Networks Console to perform functions such as configuring how documents are exchanged through your network. In addition. 2 Trading Networks User Interfaces Navigation Selections Use to. For more information. Important! Make sure that the Integration Server with which you want to use the Console is running. This section provides procedures for how to start and exit from the Console. For more information about My webMethods. as well as administrative actions performed for your Trading Networks system. see Managing B2B Integrations: webMethods Trading Networks User’s Guide. 2 In the Open Session dialog box. Starting the Trading Networks Console Use the following procedure to start the Trading Networks Console on your workstation. complete the following: Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.. it contains information to help you become familiar with how to use the Console. see Managing B2B Integrations: webMethods Trading Networks User’s Guide. while documents are being received. For information about user preferences for Trading Networks pages in My webMethods.. processed.0 29 . Monitoring > Integration > B2B Access the activity log that records the activity > Activity Log occurring within the Trading Networks system. see the Working with My webMethods guide. To start the Trading Networks Console 1 On the Start menu. and delivered. select Programs > webMethods > Trading Networks Console.

browsing for an IS document type for a TPA. Use secure Whether the connection will be made through HTTP or connection HTTPS. (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. You can select a server from this list or type a different server name and port number. To open a session on the selected server using your proxy server. User Name The name of a valid user account on this server..2 Trading Networks User Interfaces In this field. Server The host name and port of the Integration Server in ServerName:PortNum format. To open a session on the selected server using the Secure Socket Layer (SSL). IS user names are case-sensitive.. Example localhost:5555 Note: Servers to which you have successfully logged on in the past are listed in the Server list. such as: specifying a service for a processing rule or a delivery queue. For the user name. The Trading Networks Console maintains an open session on that server until you exit the Console or switch to another server. Specify. select this check box. Password The password for the user account in User Name. Opening and Closing Sessions on Servers When you start Trading Networks.and lower-case characters. and setting inputs for a TPA.. Use proxy server Whether the Trading Networks opens a session on the server through the default proxy server.) 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. select this check box. 30 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Use the exact combination of upper.. specify the exact combination of upper- and lower-case characters. IS passwords are case-sensitive. 3 Click OK.0 . For information about defining default proxy servers. specifying a custom duplicate checking service or custom attribute transformation service for a TN document type. see Managing B2B Integrations: webMethods Trading Networks User’s Guide. you are prompted to log on to the Integration Server that you want to work with.

You change the screen view of the Trading Networks Console by selecting one of these selector panel buttons. If you have unsaved work. Familiarizing Yourself with the Trading Networks Console The Trading Networks Console screen contains several different parts. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 3 Click OK. To open a session on a different server 1 Select File > Open Session. The following table lists the selector panel buttons. that is. 2 Select File > Close Session. select View > Buttons. 2 Trading Networks User Interfaces You can open a session on only one webMethods Integration Server at a time. Before you switch to another server. and the display area. 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. you are prompted to save it. along with a description of each button. the toolbar. Trading Networks automatically closes the session you have on that server. you might want to choose to remove the selector panels from the display. To turn the buttons on/off. 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. you must first close the session on the current server. 2 Complete the Opening Session to Integration Server dialog box. When you are not actively using Trading Networks. see Managing B2B Integrations: webMethods Trading Networks User’s Guide. To close a session on the current server 1 Save any work that you want to keep. the selector panel with selector panel buttons. Important! While the Trading Networks Console has an open session on a Integration Server.0 31 . you are using a licensed seat for that server. the screen name. Note: If you already have a session opened on a Integration Server. For information of the fields. For a description of these items. Because you can also access the screens using the View menu. the menu bar. see step 2 on “Starting the Trading Networks Console” on page 29.

Processing Rules. you can access the Document Attribute screen from the Document Types screen... and Transaction Analysis screens so you can select the partner profile. specify attributes for Trading Networks to extract from the document. see Chapter 13. For more information about TPAs. partner profiles and document types)..0 . “Defining and Managing Processing Rules”. “Defining and Managing Trading Partner Agreements (TPAs)”. 32 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. “Defining and Managing TN Flat File Document Types”. In addition. For more information about processing rules. see Chapter 15. “Defining and Managing TN XML Document Types” and Chapter 14. Define and manage processing rules. Define and manage TN document types.2 Trading Networks User Interfaces Selecting Trading Networks Objects This Selector Panel icon. the Select button appears on the Agreements. Define and manage Trading Partner Agreement (TPA) parameters that will specify how to govern transactions between two trading Agreements partners. and specify Document Types options for pre-processing. which Trading Networks uses to determine how to process the documents sent to your Processing Rules Trading Networks system. see Chapter 11.g... You can also view and query TPAs. Many of the screens and query panels on the Trading Networks Console use the same buttons for selecting various Trading Networks objects (e. For example. For more information about TN document types. Performs this function.

profile field. etc. 4 Click OK. which accesses the Document Type Selection Dialog. “Defining and Managing TN XML Document Types” and Chapter 14. For example. document type. Coordinating Your Work If you will have more than one Trading Networks administrator. If more than one Trading Networks administrator accesses the Trading Networks Console and edits the same item (e. you can select a TN document type by clicking Select Document Type. Trading Networks displays the Document Type Selection Dialog. see Chapter 13. “Defining and Managing TN Flat File Document Types”. Closing the Trading Networks Console To close the Trading Networks Console. For more information about using the Console to work with TN document types. the administrators should coordinate their work.) simultaneously. To select a TN document type 1 Click Select Document Type. use Select Document Type. select File > Exit. Trading Networks places a check () next to the Show All menu item to indicate that Trading Networks is currently displaying disabled TN document types. 2 Trading Networks User Interfaces Selecting TN Document Types If you need to select a TN document type. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.g. which lists all of the TN document types (both the TN XML document types and TN flat file document types). Trading Networks displays the Document Type Details dialog for the selected TN document type. the administrators might inadvertently overwrite one another’s work. when you create processing rule criteria. select Types > Show All. 3 Select the row containing information about the TN XML document type or TN flat file document type that you want. profile.. 2 To view disabled TN document types.0 33 .

0 .2 Trading Networks User Interfaces 34 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

. . . . . . . . . . . . . . . .3 Configuring webMethods Trading Networks  Trading Networks Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53  Other Configuration Settings . . . . . . . . . . . . . 47  Improving Trading Networks Performance During Searches . . . . . . . . . . . . . . . . . . . . . . . . 43  Configuring E-mail Settings for Document Delivery . . . . . 36  Configuring the Trading Networks Database Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . 45  Configuring Trading Networks for Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36  Configuring Trading Networks for a Clustered Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41  Configuring Partner Profile Settings for the Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .0 35 . . . . . . . . . . . . . . . . . 44  Configuring Tasks Settings . . . . . . . . . . . . . .

0 .  The location of the database. If the Trading Networks database requires a user name and password to connect to it.  Database properties. 36 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. and maintain the properties for each server individually. If you want to change these parameters (for example.cluster. To update the Trading Networks configuration properties In My webMethods: Administration > Integration > B2B Settings > Configure Properties.  A user name and password.cnf You can update the configuration properties using the Administration > Integration > B2B Settings > Configure Properties page in My webMethods.3 Configuring webMethods Trading Networks Trading Networks Configuration Properties You perform most Trading Networks configuration tasks by updating the Trading Networks properties. This is important if you are using Trading Networks in a clustered environment and have the tn. which appear in: IntegrationServer_directory\packages\WmTN\config\properties. you identified the user name and password that Trading Networks must supply. The procedures in this chapter describe how to access the Configure Properties page. you identified the database properties. If you want the servers in the cluster to maintain different values for some of the properties. Configuring the Trading Networks Database Settings When you installed Trading Networks. to adjust the minimum and maximum connections). To see a list of the Trading Networks configuration properties and a description of each. see the Software AG Installation Guide for general instructions.cluster. “Trading Networks Configuration Properties”. set the tn.notifyPropertyChange property to false. A URL to specify the location of the Trading Networks database. you specified the following database connection parameters:  The JDBC driver.notifyPropertyChange property set to true. If you want Trading Networks to supply any additional database properties when connecting to the Trading Networks database. Using the Configure Properties page to update properties when you are in a clustered environment will cause Trading Networks to synchronize all properties each time you use the Configure Properties page. Trading Networks updates all the properties with their values including those that you might not have altered. The name of the JDBC driver for Trading Networks database. see Appendix D. Important! When you use the Configure Properties page and save your updated properties.

you must decide whether to share a single Trading Networks database among the Trading Networks instances.0 37 .  Be sure that all Integration Server system properties are identical for all servers in the clusters..  You can also use multiple Trading Networks instances that each use their own database. For more information.. Then.  See “Configuring Trading Networks for a Clustered Environment” on page 41 for more information about running Trading Networks in a cluster. “Exporting and Importing Database Information”.remoteAliases server property for each instance servers of Trading Networks. Trading Networks in a High Availability Environment To meet your high availability requirements. when one of your adapters does not work in a clustered environment).g. Shared Database in a Clustered Environment Setting up the  Set the tn. and you configure all Trading Networks systems to use the same database. Trading Networks does not copy the data in the current database to the new database. Trading Networks is running on two or more Integration Servers that are in a clustered environment.sync. see Appendix C. The following lists possible scenarios:  If you cluster your Integration Servers. you might need to use multiple instances of Trading Networks. you can import the exported information into the new database. after you change the database. etc. services invoked from processing rules. For more information about this property. The Integration Server system properties are in the IntegrationServer_directory\config\server.cnf file  Be sure that the application code you need Trading Networks to execute (e. delivery services. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 3 Configuring webMethods Trading Networks Important! If you change the database after using Trading Networks.) is available on all servers in the cluster.cluster. see “Cluster Properties” on page 468. When you use multiple instances of Trading Networks. you should share a single Trading Networks database among the Trading Networks instances. Shared Trading Networks Database in a Clustered Environment For this option. you can still share a single Trading Networks database among the Trading Networks instances.  If you do not cluster your Integration Servers (e. you can use the Trading Networks export and import facility to export data from your existing database.g. However.

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

. be sure to connect it to one of the Trading Networks instances. Behavior of  Changes you make to Trading Networks objects (e.tn.g.g. see the webMethods Trading Networks Built-In Services Reference. you must manually make your changes to the properties. when you start My webMethods or the Console.) is shared among all instances of Trading Networks that share the database. processing rules. and do not specify the virtual IP address defined by the load balancer.0 39 . long-running conversations). etc. Trading attributes.tn. First Page.. are Networks automatically shared by all servers that share the database. Note: If you change the server properties by directly editing the IntegrationServer_directory\packages\WmTN\config\properties.  Changes you make to Trading Networks server properties using the Administration > Integration > B2B Settings > Configure Properties page or by invoking the wm.. Last Page).  To use My webMethods or the Console query paging feature (e. TN document types. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. activity log.  All run-time data (e.cn f file. documents received from partners. Previous Page. That is. specify the host name and port name of one of the Trading Networks instances that share the database.). etc..g. profiles.g. 3 Configuring webMethods Trading Networks Shared Database in a Non-Clustered Environment  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.cnf file for each server. Next Page.admin:setProperties service are automatically replicated to all servers that share the database.admin:setProperties service. For more information about the wm.

).cnf file. TN document types.3 Configuring webMethods Trading Networks Separate Trading Networks Database for Each Instance of Trading Networks For this option.. The Integration Server system properties are in the IntegrationServer_directory\config\server. For more information.  If you want all servers to have identical configurations. Trading attributes. processing rules.  If you want all instances of Trading Networks to be able to handle all incoming documents.  You cannot cluster the Integration Servers because the Trading Networks database is not shared. Behavior of  Changes you make to Trading Networks objects (e. Each instance of Trading Networks is unaware of other the other instances of Trading Networks.cnf file. You can view and set these properties from the Administration > Integration > B2B Settings > Configure Properties page of the My webMethods. etc. delivery services.g.g. attributes. “Exporting and Importing Database Information”.). you have multiple instance of Trading Networks running. profiles. 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. you must use the Trading Networks’ import/export feature to copy the data from one server to the other. You need to make the changes to each instance of Trading Networks if you want to keep them in sync.  All Trading Networks server properties are identical for all servers. etc. The Trading Networks server properties are in the IntegrationServer_directory\packages\WmTN\config\proper ties. services invoked from processing rules. are not Networks shared by all servers. 40 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. but you configure each to use its own database. etc.0 . processing rules. profiles..) is available on all servers. you must ensure that:  All Integration Server system properties are identical for all servers. be sure that the application code you need Trading Networks to execute (e. TN document types. see Appendix C..

notifyCacheChange. b Add or update the following properties: Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. if you have two servers (Server1 and Server2) in the cluster. 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. 2 To update the Trading Networks properties.cnf file for each Integration Server in the cluster.cnf file. see Administering webMethods Integration Server. Configuring Trading Networks for a Clustered Environment If Trading Networks is running on an Integration Server in a cluster of servers. For example.cluster. user accounts. you can configure Trading Networks so that the data cached in memory. and tn. For information on how to create a remote server alias. tn. For example.. To configure Trading Networks for a clustered environment T 1 On each Integration Server in the cluster. see “Cluster Properties” on page 468. activity log. For information on these properties. you need to create an additional remote server alias for the server specifically for the Trading Networks cluster.g. create a remote server alias for the other servers in the cluster.) with the other instances of Trading Networks.notifyPropertyChange properties in the properties.cluster. etc. perform the following: a In My webMethods: Administration > Integration > B2B Settings > Configure Properties. 3 Configuring webMethods Trading Networks Separate Database for Each Instance of Trading Networks  Changes you make to Trading Networks server properties are not replicated to all servers.  You cannot relate documents sent to and processed by one server to documents sent by and processed by another server.0 41 . and Trading Networks properties are synchronized on all servers in the cluster. These synchronizations are controlled by the tn.notifyProfileAddUser. documents received from partners. Important! If you have already created a remote server alias so the server is part of an Integration Server cluster (without Trading Networks). and a remote server alias for Server1 on Server2.  An instance of Trading Networks does not share its run-time data (e. You need to make the changes to each instance of Trading Networks if you want to keep them in sync. you would create a remote server alias for Server2 on Server1.cluster.

This is important if you are using Trading Networks in a clustered environment and have the tn. Trading Networks updates all the properties with their values including those that you might not have altered.. 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. If you are using Trading Networks in a cluster.. tn.3 Configuring webMethods Trading Networks For this property. and maintain the properties for each server individually.cluster. If you want the servers in the cluster to maintain different values for some of the properties.. tn.notifyPropertyChange property to false.. set the tn.threshold The number of rows of query results that Trading Networks stores in the session object.. 42 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.remoteAliases The remote server aliases you created in step 1.cluster.cluster.0 . Using the Configure Properties page to update properties when you are in a clustered environment will cause Trading Networks to synchronize all properties each time you use this page..query.cluster.notifyCacheChange A change to data cached in memory tn.cluster. see ““Cluster Properties” on page 468.. Trading Networks should not store query results in the session object.query.threshold=-1 c Ensure the following properties are set to true: Set this property to true.sync. Specify. specify the following: tn. To prevent Trading Networks from storing query results in the session object. d Click Save. To notify all servers in the cluster about.. set this property to “-1”.notifyProfileAddUser New user accounts tn.cluster.notifyPropertyChange A change to Trading Networks properties Important! When you use the Administration > Integration > B2B Settings > Configure Properties page and save your updated properties.notifyPropertyChange property set to true. For a description of the properties used in this procedure. tn.

userCreation to true. and you cannot configure it to do so. Note: When you create a profile for a partner using My webMethods.default.g. D-U-N-S number) that you specify in the profile for the user name. you can always associate one or more My webMethods user accounts with a profile. you can configure Trading Networks so that it never creates an Integration Server user account. Trading Networks does not automatically create a user account. 3 Configuring webMethods Trading Networks After completing the above procedure. add or update the tn. and Trading Networks properties are automatically synchronized on all Integration Servers in the cluster. perform the following procedure: To configure profile settings when you create a profile from the Console 1 In My webMethods: Administration > Integration > B2B Settings > Configure Properties. you would disable automatic user account creation by turning off the tn.cluster. if you do not want Trading Networks to define an Integration Server user account for a profile.cnf file.  To indicate that Trading Networks should create an IS user account: 1 Add or update the tn. When you create a profile from Console. To turn one of these synchronizations off for a server. 2 Set whether Trading Networks should create a user account when a profile is added.0 43 . user accounts. Trading Networks can create an Integration Server user account for the partner. the data cached in memory. Trading Networks uses the value of one of the external IDs (e. if you wanted to manually control user account creation. modify the respective property in the Trading Networks properties. Configuring Partner Profile Settings for the Trading Networks Console When you use the Console to add a profile for a partner. However.. For more information. see “Central User Management—How Integration Server Authorizes My webMethods Users” on page 58.  To indicate that Trading Networks should not create an IS user account. The external ID that Trading Networks uses is the value of the default external ID type. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.default. see “Managing the My webMethods Users Associated with the Partner’s Profile” on page 174. You configure the default external ID type that Trading Networks uses for the IS user account. To configure profile settings.userCreation to false. For example. For information about a My webMethods user account is used.notifyProfileAddUser property.

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.default. 3 Click Save..from=TNAdmin@ifc. specify the following: tn. DUNS) that Trading Networks uses for the user name of an IS user account that it creates for the partner.. Example: If you want the e-mail messages to use the subject line “Document from IFC”. Example: If you want the e-mail messages to use the “from” e- mail address TNAdmin@ifc.0 .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. To configure e-mail settings for document delivery 1 In My webMethods: Administration > Integration > B2B Settings > Configure Properties.idType property. the “from” e-mail address and subject line that you want Trading Networks to use in the e-mail messages. tn.3 Configuring webMethods Trading Networks 2 To identify the external ID to use for the IS user account created for a profile that is added from the Console.subject=Document from IFC 3 Click Save. specify the following: tn. specifically.mail. add or update the tn... Specify the external ID type (e.com tn..com. 2 Add or update the following properties to configure how Trading Networks performs document delivery: For this property.mail. Specify.mail.mail. 44 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.g. Configuring E-mail Settings for Document Delivery You can configure settings Trading Networks uses when delivering documents via an e-mail message.

.sweepTime can affect how long Trading Networks waits between attempts to retry a task. 2 Add or update the following property to configure settings that affect both delivery and service execution tasks: For this property.sweepTime The number of seconds the reliable task manager thread remains idle before checking for tasks it needs to perform (for example. The value you specify for tn. Specify. For more information. or in the wait period between attempts.task. you need to create an Integration Server trigger that subscribes to the wm..rec:TaskFailure IS document type. tn. see “Using Reliable Delivery with Immediate Delivery Method” on page 346 and “Service Execution Tasks and Reliable Execution” on page 337. the wait between retries value is governed by one of the following: Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. To configure tasks settings 1 In My webMethods: Administration > Integration > B2B Settings > Configure Properties. Typically.. a task to deliver a document or execute a service). 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.0 45 . failed.tn. For more information about these tasks. see the Publish-Subscribe Developer’s Guide.task. 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. Note: If you want to be notified when tasks fail. You can configure settings that Trading Networks uses when processing these tasks. The task manager thread becomes idle when all tasks are completed. 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..

retryFactor.. tn. Trading Networks calculates the time to wait by multiplying the last wait time by the tn.maxRetries The number of times you want Trading Networks to attempt to re-execute a service.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. If the task manager thread is idle when the wait between retries value expires. Service The tn. the task manager thread will not wake up to process the task until the tn.task.retryFactor value along with the tn..3 Configuring webMethods Trading Networks 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.retryFactor = 3 Retry 1 Retry 2 Retry 3 Wait until next attempt 10000 ms 30000 ms 90000 ms 4 Click Save. Specify.sweepTime value expires.task. execution However.task. tn.task.task.retryFactor value.task.task.ttw = 10000ms tn. (Trading Networks uses the tn.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. Specify a whole number. 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.task. 3 Add or update the following properties to configure settings that affect only service execution tasks.sweepTime value.ttw property value.task.task. For this property. 46 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks could wait as long as the tn.task. 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...ttw value to calculate how long to wait for subsequent retry attempts.task.) tn.task. tn.0 . Specify a whole number greater than zero for tn.maxRetries = 3 tn.

3 Configuring webMethods Trading Networks Enabling Task Failure Notification If you want to be notified when a task fails. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For more information about the areas in Trading Networks that are affected by large document handling.notifyFailure Either true or false. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. You also configure the document size that Trading Networks should treat as large. You can configure Trading Networks to handle large documents differently.  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. see Appendix F.. When this property is true.task.rec:TaskFailure IS document type.0 47 . Configuring Trading Networks for Large Document Handling As installed. You can create an Integration Server trigger that subscribes to IS documents of this IS document type.. tn. Trading Networks publishes an IS document with the format defined by the wm..notifyFailure property is set to “true”.tn. “Large Document Handling”. For information on creating an Integration Server trigger.task. Trading Networks acts on all documents in the same manner regardless of their size. see the 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 > Configure Properties. 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. make sure the tn. For more information about large document handling.

you need to set configuration properties in the Trading Networks properties file and perform configuration tasks on the Integration Server. To configure Trading Networks for large document handling T 1 In My webMethods: Administration > Integration > B2B Settings > Configure Properties. To use large document handling. 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. perform the following procedure. 2 Add or update the following properties: 48 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.3 Configuring webMethods Trading Networks 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. you need to define hard disk drive space where Trading Networks can temporarily save documents (rather than store them in memory). Important! The hard disk drive space listed above identifies only the amount of hard disk drive space that Trading Networks requires for normal processing. you would need a hard disk drive space that is 10 to 15 times the combined size of the documents being processed concurrently. Steps for Configuring Large Document Handling To use large document handling. See the Important! note below for more information about additional hard disk drive space required for large document handling.0 . For example. It does not account for the hard disk drive space that is necessary for temporarily saving the large documents during processing. The size of the hard disk drive space for temporarily saving documents will vary based on the number of documents that you process concurrently and the size of the documents that you process. if your typical concurrent document load is 10. Setting Properties in the Trading Networks Properties File To configure Trading Networks to use large document handling.

BigDocThreshold=1000000 tn.xml. Trading Networks uses large document handling for all documents. 3 Click Save. The default is -1. if you have XQL queries that point to nodes beyond the number of bytes that Trading Networks reads. For more information.BigDocThreshold. n: Specify a positive whole number to indicate the number of bytes over which Trading Networks considers a document large.xml. In your TN XML document types.. Specify. reading the document content into memory during processing. For example. 0: Specify zero to have Trading Networks consider all documents as large. tn.xqlThreshold=50000 If you do not specify a value for tn. Specify a positive whole number. For example. Trading Networks processes all documents in the traditional manner.BigDocThreshold.000 bytes.000 bytes of the document.. Because all documents that Trading Networks receives contains more than 0 bytes.000 bytes to perform document recognition.. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks considers all documents greater than 1. If you do not specify a value for tn. Trading Networks defaults to 1.xqlThreshold The number of bytes that Trading Networks reads into memory to perform the XQL queries in a TN XML document type.0 49 . the queries will fail. or if the value that you specify is negative.xml. if the XQL queries that you specify reference nodes in the first 50.xqlThreshold. if you specify the following. Trading Networks uses the number of bytes that you specify for tn. specify the following: tn.000 bytes as large: 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. 3 Configuring webMethods Trading Networks For this property.000. Trading Networks needs to read at least 1. see “Defining TN XML Document Types” on page 247.

Content field in the BIZDOCCONTENT table to have a 2M size limit. if you use the Trading Networks Archive tables. For this property.location=D:\LargeDocTemp  For UNIX: watt. the DB2 SQL script defines the size of the BizDocContent.tspace.3 Configuring webMethods Trading Networks Increasing the Size of the Largest Document that Can Be Saved When Using DB2 When defining columns for a DB2 database.Content field to accommodate the largest document you expect to process. Configuring the Integration Server In addition to setting configuration properties for Trading Networks. Each file that the Integration Server stores in this directory is given the name DocResxxxxx.. you also need to configure settings for the webMethods Integration Server.dat. When defining the Trading Networks database. shut down the Integration Server.location The absolute directory path of the hard disk drive space where Trading Networks is to temporarily store large documents rather than keep them in memory.tmpDir. To configure the Integration Server. Specify. For example:  For Windows: watt. where xxxxx is a value that can vary in length and character..cnf Before you edit the configuration file.location=/opt/webmethods/ tspace If you do not specify a value for watt. you must update the size limit for the BizDocContent.server. Similarly.Content field. If you are using a DB2 database for the Trading Networks database and want to save documents that are larger than 2M..io.0 .location. After you make the changes.server.. update the following properties in the Integration Server configuration file: IntegrationServer_directory\config\server. watt.tspace.server. which defaults to the value of the environment variable Temp on most platforms.server. As a result.tspace.tspace. restart the server. 50 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. you must also update the size of the ARCHIVE_BizDocContent. The directory you specify is on the same machine as the Integration Server. DB2 requires that you specify a size limit. the largest document that Trading Networks can save to the DB2 database is 2M. Trading Networks uses the value defined by the Java system property java.

Note: If you are setting up large document handling for multiple webMethods components (e. if your typical concurrent document load is 10.server..428. webMethods EDI Module. Specify. all components use this property. you would need a hard disk drive space that is 10 to 15 times the combined size of the documents being processed concurrently. 3 Configuring webMethods Trading Networks For this property. For example. All components use the same location and the Integration Server manages allotting space to each component.g...tspace. Specify any positive whole number of bytes. The default is 52.. For example: watt.tspace.server. use this property to define a single hard disk drive location.. watt.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. an error message is displayed on the server console and the document is not stored.800 bytes (50 MB). The Integration Server ensures that the hard disk drive space use for all components does not exceed the value you specify. Note: If you are setting up large document handling for multiple webMethods components.0 51 . Trading Networks. and webMethods RosettaNet Module).tspace. If Trading Networks (or another webMethods component) attempts to write a large document to the hard disk drive space that will cause the number of bytes you specify to be exceeded.location property.server.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. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

keepAliveTime property for a response.keepAliveTime=180000 The default value is 15000 (15 seconds). When you submit a document using a Java InputStream over a network to the Integration Server.0 .. The Integration Server waits the amount of time you specify with the watt.3 Configuring webMethods Trading Networks For this property.server.server.keepAliveTimeout The maximum number of milliseconds that you want the Integration Server to wait for a response after making a request to read from a network InputStream. the Integration Server makes a request to read from the InputStream. If the Integration Server does not receive a response in the specified amount of time. It is recommended that you set this property to 180000 (3 minutes). watt. for example: watt.. it times out with the error “Connection reset by peer”.. Specify a whole number greater than zero.server. 52 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Specify..

watt.timeToLive The number of milliseconds that you want Integration Server to temporarily store documents in TSpace rather than keep them in the memory. Setting this property prevents the deletion of a document as soon as it is created. you can set a limit for the search results. For example.server. thus preventing any resulting exceptions that occur while you try to read back from the document.tspace. Improving Trading Networks Performance During Searches To improve performance of Trading Networks while performing searches. For example.server. Hybrid eviction policy determines which result rows to delete based on the combination of how often and how recently the rows were accessed. Specify. Integration Server deletes the documents from TSpace three minutes after they are created. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. The rows that were least frequently accessed and were not accessed for the longest period are deleted... Integration Server deletes all the 10 documents from TSpace. 3 Configuring webMethods Trading Networks For this property.. you can set to periodically delete the search results stored in the cache. Rather it is just to accommodate the length of time it takes to receive a response to a read request. Trading Networks uses the Hybrid eviction policy to delete the search results from the cache.0 53 . consider that TSpace contains 10 documents and the value of this property is set to 0 (zero).server.. if you set this property to 180000 milliseconds as below.keepAliveTime does not need to be long enough to accommodate reading the entire document. watt.tspace. Only after Integration Server creates a new document. Note: The value you specify with watt. In addition.timeToLive=180000 The default value is 0 (zero). A value of 0 (zero) indicates that Integration Server deletes the documents from TSpace only after it creates a new document in TSpace.

Use the format: <highUnits>value</highUnits>. Specify.xml file and edit the following XML tags within the XML tag <localScheme>: For this XML tag. Setting Properties in the Trading Networks Properties File To configure Trading Networks to improve performance during searches. then you might want to set the <highUnits> value to 2500000. For example. do the following: 54 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. deleting the search results from the cache.0 . 3 Restart Integration Server. that is. Example: <lowUnits>37500<lowUnits> The recommended value is 75 percent of the value you provide in the <highUnits> tag.. where value is the number of rows. where value is the total number of rows. <highUnits> The maximum number of rows that Trading Networks can cache for searches of all users. Configuring the Integration Server To limit the search results 1 Shut down Integration Server.. Example: <highUnits>50000</highUnits> When specifying the <highUnits> values.. Use the format: <lowUnits>value</lowUnits>. consider the number of users and the average number of rows in the production database.3 Configuring webMethods Trading Networks Set a Limit for Search Results To set a limit for the search results. and the average number of result rows for each user is 5000. you must perform configuration tasks on the Integration Server and set the configuration properties in the Trading Networks properties file. 2 Open the IntegrationServer_directory\config\Cache\webm-cache-config.. if there are 10 users. <lowUnits> The number of rows of the search when once reached triggers Trading Networks to start the eviction.

xml file and edit the following XML tags within the XML tag <localScheme>: For this XML tag. Delete Search Results Periodically To delete search results periodically. Use the format: <expiryDelay>value</expiryDelay>. Configuring Integration Server To configure Integration Server for searches T 1 Shut down Integration Server. where 15m indicates 15 minutes of time. tn. 3 Click Save. This is the default.. A cached row can be deleted only after it has expired.. where value is the time in minutes after which the cached row is considered expired. tn..0 55 . you must perform configurations tasks in Integration Server.db.  Set to false. Example: <expiryDelay>15m</expiryDelay>... Specify. 3 Configuring webMethods Trading Networks To configure Trading Networks for searches T 1 In My webMethods: Administration > Integration > B2B Settings > Configure Properties.  Set to true.. <expiryDelay> The time in minutes after which a cached row is considered expired. 2 Add or update the following properties: For this property.db. Specify. 2 Open the IntegrationServer_directory\config\Cache\webm-cache-config. if you want Trading Networks to sort the result rows.fetchMaxRows The maximum number of result rows that Trading Networks must retrieve from the database for each query.sortDocTimestamp Whether Trading Networks must sort the result rows based on their timestamps in the descending order. if you do not want Trading Networks to sort the result rows. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8... The default is 10000 rows.

Trading Networks flushes the expired rows every 20 minutes.. where 20m indicates 20 minutes of time. Other Configuration Settings For instructions on how to perform the following configuration tasks.. Use the format: <flushDelay>value</flushDelay>.3 Configuring webMethods Trading Networks For this XML tag.. Specify. 3 Restart Integration Server.. where value is the time interval in minutes. That is.0 . see Administering webMethods Integration Server:  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 56 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. <flushDelay> The time interval in minutes between periodic cache flushes of the expired rows. The first flush starts when the number of rows mentioned in the <lowUnits> tag have been cached. Example: <flushDelay>20m</flushDelay>.

. . 64  Granting My webMethods Users the Authority to Execute Trading Networks Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65  Defining Role-Based Access . . .4 Configuring My webMethods to Work with Trading Networks  Central User Management—How Integration Server Authorizes My webMethods Users . . . . . . . . . . . . . . . . . . . . . . . . . . . 58  Defining Trading Networks Administrators for My webMethods . . . . . . . . . . . 65  Configuring How Long My webMethods Waits for a Response . . . . . 76  Configuring Resubmission and Reprocessing Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .0 57 . . .

For instructions. wm. 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. Note: After Central User Management is set up.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. “Defining and Managing Partner Profiles”. 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. for example.tn:receive. you need to perform additional actions to authorize users to perform various Trading Networks actions from My webMethods. When issuing the requests.  When a Trading Networks partner sends a document to Trading Networks. see “Defining Trading Networks Administrators for My webMethods” on page 64. 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 must configure Central User Management in Integration Server. For more information. see “Granting My webMethods Users the Authority to Execute Trading Networks Services” on page 65.0 . The Trading Networks partner can invoke the service using the credentials of a My webMethods user account. My webMethods Server invokes Trading Networks services on the Integration Server to satisfy the request. it invokes a Trading Networks service. 58 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For more information. see “Defining Role-Based Access” on page 65. you still need to take action to grant a My webMethods user Trading Networks administrator authority. see “Managing the My webMethods Users Associated with the Partner’s Profile” on page 174 in the Chapter 9.  When a My webMethods user wants to view Trading Networks data and/or perform Trading Networks actions. For information about assigning partners a My webMethods user account. My webMethods Server presents the credentials of the logged in My webMethods user to authenticate the user and authorize the request.

Configuring Central User Management in Integration Server For instructions on how to configure Integration Server to use Central User Management. For information about how multiple Trading Networks Server instances work with one My webMethods Server instance. You can connect to multiple Trading Networks Server instances using only one My webMethods Server instance. To identify the Trading Networks Server to My webMethods Server 1 In My webMethods: Administration > Integration > B2B Settings > Administrative Preferences. 2 Identify the Integration Server that My webMethods should interact with for Trading Networks requests. After Central User Management is set up. 4 Configuring My webMethods to Work with Trading Networks Setting Up Central User Management You can set up Central User Management so that My webMethods can be used as a Trading Networks user interface. that is. To set up Central User Management to enable the usage of My webMethods with Trading Networks 1 Configure the Integration Server to use Central User Management. My webMethods users can be authorized to perform Trading Networks functions by making them members of My webMethods roles. Integration Server on which Trading Networks is running. Identifying Trading Networks Server to My webMethods Server For My webMethods Server to identify which host and port to use to connect with Trading Networks. For more information. To do so.0 59 . do the following: Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. to My webMethods Server. see “How the Integration Server Authorizes a User” on page 62. For more information. All users can update the Trading Networks Server settings. you must identify Trading Networks Server. see Administering webMethods Integration Server. 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. see “Configuring Central User Management in Integration Server” on page 59. see “Using One My webMethods Instance for Multiple Trading Networks Instances” on page 60. For more information. 2 In the TRADING NETWORKS SERVER panel. you must identify the Trading Networks Server instances to the My webMethods Server instance. see “Identifying Trading Networks Server to My webMethods Server” on page 59.

Note: The fields in the General panel can be edited only by the administrator. type the host name or IP address of the server that hosts the Trading Networks Server. 60 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. those changes do not affect the other user until the session expires. Deleting Trading Networks Server to My webMethods Server To delete the Trading Networks Servers to My webMethods Server 1 In My webMethods: Administration > Integration > B2B Settings > Administrative Preferences. do the following: a In the IS Config Name field. each user that has logged on to a My webMethods Server can connect to different Trading Networks Server instances. The default is 5555. click Other. and makes changes to the Trading Networks Server settings. type the port number for the Trading Networks Server. select the Trading Networks Server that you want to delete. all the fields in the General panel are grayed out. b Click Delete. The default is localhost. If the user deletes a Trading Networks Server that the other user is connecting to. The default is LocalHost (http://localhost:5555). 4 To continue adding Trading Networks Server instances. b In the Server Hostname field. then the other user is not affected by the changes until the user visits the Administration > Integration > B2B Settings > Administrative Preferences page. If you are not the administrator. every user is independent of each other. Type the Trading Networks Server name that you want to connect to.4 Configuring My webMethods to Work with Trading Networks a In the IS Config Name field. My webMethods Server creates a session that expires only after the user logs off. d Select Use Secure Connection if you want to secure the communication between My webMethods and the Trading Networks Server instance. 2 In the Trading Networks Server panel. 3 Click Save. If a user logs on with the user credentials of another user who has already logged on. c In the Server Port field. repeat steps step 2 and step 3. This per user session aspect ensures that when multiple My webMethods users from one My webMethods instance connect to multiple Trading Networks instances. For every user that logs on to My webMethods Server. Using One My webMethods Instance for Multiple Trading Networks Instances When you use one My webMethods Server instance for multiple Trading Networks Server instances.0 .

and set the watt. To specify the SAML resolver location 1 Shut down Integration Server. and user A updates the Trading Networks Server settings. My webMethods passes an authentication token to Integration Server. When you use other authentication methods such as client-side certificate authentication and third party tools. when the Integration Server receives a user name and password to authenticate.server.samlResolver on every Integration Server instance that My webMethods Server will communicate with. How the Integration Server Authenticates a User When using Central User Management. Integration Server then uses Central User Management.auth. you must set the watt property watt. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 2 Open the IntegrationServer_directory\config\server. you will not be affected by the changes until you visit the Administrative Preferences page.0 61 . and if so.server. When you want to access a Trading Networks Server instance from different My webMethods Server instances. However. then ensure either of the following:  The My webMethods Server instances are in a clustered environment. 3 Restart Integration Server. Integration Server uses http://localhost:8585/services/SAML as the default SAML resolver. For Integration Server to accept this token.auth. To indicate the SAML resolver location.auth. It determines whether the user account is defined in My webMethods. The setting changes for user A take effect immediately. If the user is not defined among IS user accounts.server.  The roles and the user preferences configured in the My webMethods Servers are the same. you must indicate the location of the SAML resolver in My webMethods Server. you will not be affected by the changes until you log off and log on again. If user A deletes the Trading Networks Server you are connecting to. it first attempts to authenticate the user using its own user account definitions. 4 Configuring My webMethods to Work with Trading Networks For example. If you do not set this parameter. consider that you and user A log on with the same credentials at the same time.cnf file. SAML resolver enables the exchange of the authentication information between My webMethods Server and the Integration Server instance you are connecting to. ensures the user supplied valid My webMethods credentials.samlResolver property as follows: watt.samlResolver=http://host name:port/services/SAML where host name is the host name or IP address and port is the port number of My webMethods Server.

For to ACLs” on more information page 63. 62 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see permissions. on page 64 TNMWSUsers TN MWS Users The TN MWS Users When a My role is added to the webMethods role is Allowed list of the given general TNMWSUSers ACL functional at startup.0 . you can add My webMethods groups and roles to the Allowed list of ACLs. about general functional permissions and data permissions. The following table lists the ACLs used for Trading Networks functionality. the Integration Server determines whether the user can access the requested IS service. 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. When using Central User Management. see see “How Trading “Defining Trading Networks Adds My Networks webMethods Roles Administrators for to ACLs” on My webMethods” page 63. For Role. that “How Trading role is added as a Networks Adds My member of the TN webMethods Roles MWS Users role. For more permissions or data information. how the roles are added to the ACL. see “Defining Role- Based Access” on page 65. 4 Configuring My webMethods to Work with Trading Networks How the Integration Server Authorizes a User To authorize a request. For more information. r How My webMethods Corresponding My How the role is added users are added to the IS ACL webMethods role to the ACL My webMethods role TNAdministrators TN The TN You must manually Administrators Administrators role add My is added to the webMethods users Allowed list of the to the TN TNAdministrators Administrators ACL at startup. the corresponding My webMethods roles. instructions. access to IS services is protected by Access Control Lists (ACLs). and how users are added to the My webMethods role.

Trading Networks adds the My webMethods roles to their corresponding ACLs. you can startup. 4 Configuring My webMethods to Work with Trading Networks How My webMethods Corresponding My How the role is added users are added to the IS ACL webMethods role to the ACL My webMethods role TNPartners TN Partners The TN Partners When you use My role is added to the webMethods to Allowed list of the define a partner TNPartners ACL at profile. Trading Networks determines:  Whether Central User Management is configured. and  Whether the My webMethods TN Administrators.0 63 . see “Managing the My webMethods Users Associated with the Partner’s Profile” on page 174 in Chapter 9. and TN Partners roles exist If both Central User Management is configured and the My webMethods roles exist. 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 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. “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. TN MWS Users. webMethods Roles Trading Networks to ACLs” on automatically adds page 63. see more My “How Trading webMethods users Networks Adds My with the partner. For instructions about associating My webMethods users with a partner. For more associate one or information. users associated with a partner to the TN Partners role.

create a user account for the user. including making groups or roles members of a role. In addition.WmTN. Defining Trading Networks Administrators for My webMethods Trading Networks administrator authority allows the users to:  Perform Trading Networks administrative task in My webMethods. You create a user using the Administration > System-Wide > User Management > Users page.mwsMap property to the Trading Networks version number.4 Configuring My webMethods to Work with Trading Networks After Trading Networks maps the My webMethods roles to their corresponding ACLs.mwsMap property. To grant Trading Networks administrator authority to a My webMethods user. 2 On the Roles page. see Administering My webMethods Server. To grant a user Trading Networks administrator authority 1 In My webMethods: Administration > System-Wide > User Management > Roles. After this property is updated.mwsMap property.  View all Trading Networks data and perform all Trading Networks actions within My webMethods. click EDIT in the row for the TN Administrators role. you can edit the Integration Server server. For instructions. it updates the watt.0 . which is in the Integration Server server. Trading Networks will no longer attempt to map the My webMethods roles to their corresponding ACLs at startup. it will go through its processing to create the mappings. when Trading Networks starts up again. Trading Networks sets the watt. Note: If the user to which you want to grant Trading Networks administrator authority does not already have a My webMethods user account.WmTN.cnf file and remove the watt. 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. the Trading Networks administrator authority extends to all Trading Networks functions accessed via the Integration Server. see Administering My webMethods Server. which are described in this chapter. If you want to force Trading Networks to create these mappings again.cnf file. 64 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. To learn more role membership. As a result.WmTN.

5 Use the SELECT PRINCIPAL(S) dialog to add the My webMethods user to the role. For help with this step. My webMethods Server. information about a delivery task) and to perform actions against that data (for example. 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. After the TN MWS Users role is made a member of the TNMWSUsers ACL. 7 Click Save to save the changes to the TN Administrators role. You still need to grant the user’s role the appropriate data permissions and/or general functional permissions. 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. 6 Click Apply to close the SELECT PRINCIPAL(S) dialog. the My webMethods user must have the correct privileges in the Integration Server to execute the service. My webMethods Server uses the credentials of the logged in My webMethods user. you must be a member of role to which that permission has been granted. the Trading Networks services are protected by the TNMWSUsers ACL. The TN MWS Users role is added to the Allowed list of the TNMWSUSers ACL at installation. see “Defining Role-Based Access” on page 65. to view Trading Networks data (for example. For more information. 4 Configuring My webMethods to Work with Trading Networks 3 Click the Members tab. further action is still required to allow a user to perform a Trading Networks actions. the My webMethods “TN MWS Users” role must be added to the Allowed list of the TNMWSUsers ACL. That is. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. To allow My webMethods users to execute the service. In the Integration Server.0 65 . restart a task). To execute the service. and then displays the results in My webMethods. in turn. To add the TN MWS Users role to the TNMWS ACL You do not need to take any action. see information about editing the membership of a static role in Administering My webMethods Server. attempts to execute a Trading Networks service on the Integration Server to perform the requested action. As a result. 4 Click Edit Members.

Delete Partner Delete any partner profile. For more information about:  General functional permissions. There is no role-based access in Trading Networks Console.4 Configuring My webMethods to Work with Trading Networks The two types of permissions are general functional permissions and data permissions. see “Granting General Functional Permissions to a Role” on page 71. edit.  Data permissions. the user can perform the actions granted to all of the roles that the user is a member of. The data and actions that you control using each are distinct. Role-Based Access is Cumulative If a user belongs to multiple My webMethods roles. Manage Partner Use the Administration > Integration > B2B > Partner Groups page to Groups manage (add. Functional permission Actions a role can perform when assigned this functional permission Manage Public Use the Administration > Integration > B2B > Public Queues page to Queues manage (add. delete) all public queues. A Console user continues to have administrative privileges to perform all functions available in the Console. 66 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. delete) all partner groups. see “Data and Actions Governed by General Functional Permissions” on page 66. edit. Note: Trading Networks role-based access is only applicable to access via My webMethods. The table lists the data governed by each general functional permission and the actions a role can perform when assigned the permission. Trading Networks displays the Delete button on the Administration > Integration > B2B > Partner Profiles page.0 . For more information about granting permissions. If a user’s role is granted this Profile functional permission. Data and Actions Governed by Role-Based Access This section describes the data and actions governed by:  General functional permissions  Data permissions 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. see “Data and Actions Governed by Data Permissions” on page 68.

0 67 . 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. Trading Networks displays the Show SQL button on the search panel where this feature is supported. Add External ID Add new external ID types that can be used in profiles. edit. delete) the criteria and schedules for archiving and deleting documents. Edit B2B properties Use the Administration > Integration > B2B Settings > Configure Properties page to edit Trading Networks Server properties. edit. Query Expiring Use the Administration > Integration > B2B Settings > Partner Certificates Certificates page to query partner certificates that have expired or that will expire soon. delete) all extended profile fields. Edit User Use the Monitoring > Integration > B2B > User Preferences page to Preferences update user preferences. View B2B properties Use the Administration > Integration > B2B Settings > Configure Properties page to view (but not update) the settings for the Trading Networks Server properties. Trading Networks displays the Manage Extended Fields button on the Extended Fields tab of a profile. If a Types user’s role is granted this functional permission. If a user’s Profile Fields role is granted this functional permission. Trading Networks displays the Add ID Type button on the External IDs tab of a profile. Manage TN Use the Administration > Integration > B2B > Archive Schedules page Archiving to manage (add. If a user’s role is granted this functional permission. View User Use the Monitoring > Integration > B2B > User Preferences page to Preferences view (but not update) user preferences. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 4 Configuring My webMethods to Work with Trading Networks Functional permission Actions a role can perform when assigned this functional permission Manage Extended Manage (add.

A data set is composed of partners. After defining a data set. If this permission is not assigned. the user can only use the built-in immediate delivery methods and the immediate delivery methods that have been added by other users for whom this functional permission is set. tasks. edit. see “About Defining Data Sets” on page 72. you must first define data sets. you can also submit EDI documents. you define permissions that indicate the actions the role can take against the data. and activity log entries. For more information about granting data permissions. Submit Documents Use the Administration > Integration > B2B Settings > Submit to TN Documents page to submit XML documents to your Trading Networks for processing. If you have webMethods EDI Module installed.4 Configuring My webMethods to Work with Trading Networks Functional permission Actions a role can perform when assigned this functional permission Manage Delivery Manage (add.0 . you then specify the roles that can act on the data in the data set. For more information. FTP. FTPS). The following table describes the Trading Networks data permissions that you can assign to a role. delete) the immediate delivery methods that Methods a user creates using the delivery methods that Trading Networks provides (for example. see “Defining Data Permissions” on page 72. transactions. Data and Actions Governed by Data Permissions To set data permissions. Items Actions you can assign to the role Partners in the data set  View profile information  Create profile  Edit Profile Summary  Edit External IDs  Edit Addresses  Edit Profile Group Membership Contacts in the data set  View contact information  Edit contact information Delivery Settings in the data  View delivery settings information set  Edit delivery settings information Extended fields in the data  View extended fields information set  Edit extended fields information 68 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. HTTP. For each role.

0 69 . a newly created profile gets added to all the data sets where the user has the create profile permission. 4 Configuring My webMethods to Work with Trading Networks Items Actions you can assign to the role Users in the data set  View user information  Edit user information Certificates in the data set  View certificates information  Edit certificates information Transactions (Trading  View transactions Networks documents) in the  Reprocess transactions data set  Resubmit transactions  Edit user status attribute of transactions  Edit EDI FA status attributes of EDI transactions  Edit comments associated with transactions  View content of transactions  Edit content of transactions Delivery tasks and/or Service  View tasks 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 Create Profile Data Permission Capabilities The create profile data permission allows the My webMethods user to create a profile of the partner that belongs to the data set. see “Defining Data Sets and Granting Roles Permissions to Act on the Data Set” on page 72. Note: When you select the Create Profile permission. For more information about All Partners option. then the profile of the partner will always belong to that dataset. and the My webMethods user does not require to explicitly add it to the dataset. By default. the Edit Profile Summary and Edit External IDs check boxes are selected automatically only after you save and re-open the data set. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. If the data set has the All Partners option selected. The user with a create profile permission is automatically granted the permission to edit the profile summary and the external IDs.

see “Adding Partner Profiles” on page 154.4 Configuring My webMethods to Work with Trading Networks If a user is granted the create profile data permission. 70 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see “Data and Actions Governed by Data Permissions” on page 68. 4 Assign Trading Networks data permissions to roles. and/or roles members of a My webMethods role. Consider how you want to provide access when defining your data sets. You define roles using the Administration > System-Wide > User Management > Roles page. For more information about defining roles. In this case. For more information about defining roles. For example. 2 Add members to the roles you want to use for Trading Networks role-based access. groups. Each step describes where you can find more-detailed instructions for completing the step. 3 Assign Trading Networks general functional permissions to roles. The general steps are: a Define the data sets for which you want to assign data permissions. To grant access. For more information about adding partner profiles. each identifying the data on which a role can act. you would define multiple data sets. The following describes the general tasks for setting up Trading Networks role-based access in My webMethods. but only to a limited set of data. only then does Trading Networks display the Add Profile button on the Administration > Integration > B2B > Partner Profiles page to add partner profiles.0 . For instructions for defining general functional privileges. Another example is that you might want to allow all access rights to a role. Setting Up Role-Based Access By default. 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. you grant access to the roles that users are members of. For instructions for defining data permissions. see “Data and Actions Governed by General Functional Permissions” on page 66. see “Granting General Functional Permissions to a Role” on page 71. see Administering My webMethods Server. see Administering My webMethods Server. see “Defining Data Permissions” on page 72. You can make My webMethods users. To set up Trading Networks role-based access in My webMethods 1 Define the roles to which you want to grant access. 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. For a description of the general functional permissions. My webMethods users have no access to Trading Networks data. For a description of data permissions.

c Click Apply. To grant a general functional permission to one or more roles 1 In My webMethods: Administration > System-Wide > B2B Permissions > General Functional Permissions. 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. see “Data and Actions Governed by General Functional Permissions” on page 66. you can remove the permission. b Identify the roles that can act on the data set. For more information about defining roles. To define roles. see. you must define the roles to which you want to assign general functional permissions. Before performing the procedure in this section. 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. move the roles to the Selected list. use the Administration > System-Wide > User Management > Roles page. 2 Click EDIT in the row containing the general functional permission that you grant to one or more roles. “About Defining Data Sets” on page 72. 3 In the SELECT ROLE(S) dialog: Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 4 Configuring My webMethods to Work with Trading Networks For information about defining data sets. see Administering My webMethods Server. c For each role. edit the permissions to identify the actions that the role can perform against the data set. b To select the roles to which you want to grant permission.0 71 . Granting General Functional Permissions to a Role For a description of the general functional permissions. Removing General Functional Permissions from a Role If you no longer want a role to have a general functional permission.

For more information about defining roles.0 . tasks.. and activity log entries to which you want to control access. use the Administration > System-Wide > User Management > Roles page. Defining Data Permissions Define data permissions to control access to partner profiles. you must define the roles to which you want to assign data permissions.4 Configuring My webMethods to Work with Trading Networks a Move the role from which you want to remove permission from the Selected list to the Available list. profiles Partners defined in The partners identified in the data set the data set definition definition. transactions. This data is included in the data set. you define a data set.. see “Data and Actions Governed by Data Permissions” on page 68. transactions. The table below describes how Trading Networks includes partner profiles. transactions Partners and TN Transactions where: document types in  The sender or receiver of the the data set definition transactions is associated with a partner identified in the data set. b Click Apply. For a description of the data permissions. service execution) the data set definition activity log entries Partners and TN Activity log entries associated with the document types in partners and transactions in the data set.. tasks. and activity log entries in the data set based on the partners and TN document types you specify. see Administering My webMethods Server. To define roles. To indicate the partner profiles. Based on. and activity log entries. 72 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. the data set definition Defining Data Sets and Granting Roles Permissions to Act on the Data Set Before granting data permissions. Limited to.. transactions. tasks.. you can then grant permissions to act on the data set.. -AND-  The transactions use a TN document type identified in the data set. tasks Partners and TN Task associated with the transactions in (delivery and/or document types in the data set. After you define a data set. About Defining Data Sets You define data sets by specifying partner profiles and TN document types.

if it is not already selected. Trading Networks includes partners that are associated with the logged in My webMethods user. 2 Click Add Data Set. 3 In the Data Set Name field. select Custom selection and continue with step 5b below. see “Managing the My webMethods Users Associated with the Partner’s Profile” on page 174 in the Chapter 9. “Defining and Managing Partner Profiles”. select All Partners and continue with step 6. you can do one or more of the following to identify the partners in the data set:  Make the partner list relative to the logged in My webMethods user. 1 Select Self Partners.  To include a few partners. 4 Configuring My webMethods to Work with Trading Networks 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. b If you selected Custom selection.  To include all partners. type a name for the data set. 5 Define the partners to include in the data set using the Partners panel: a Select whether you want to include all or only a few partners in the data set. 4 Select the Dataset tab. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 73 . For more information about associating a My webMethods user with a partner. Note: When checking permissions.

3 Click Apply.0 . move the TN document types to the SELECTED list. 3 To select the TN document types to add to the data set.4 Configuring My webMethods to Work with Trading Networks  Identify partners to include in the partner list. c Repeat step 8 for each role you want to add. move the partners to the SELECTED PARTNERS list. move the roles to the Selected list. 2 In the SELECT MEMBERS TO ADD dialog box. 8 Add one or more roles to which you want to grant data permissions to act on the data in the data set. 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. select Selected document types and continue with step 6b below. 7 Click Permissions tab. 4 Click OK. 74 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. b If you selected Selected document types: 1 Click Edit. You must add at least one role. The system populates the AVAILABLE PARTNERS list with the search results. search for the partners you might want to add to the data set. 3 To select the partners to add to the data set. 2 Search for the document types to populate the Available list by typing a string contained in the name(s) of the document types you want and clicking Search.  To include a subset of the document types. 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. To add a role: a Click Add Role. 1 Click Edit above the Partners box. select All Document Types and continue with step step 7.  To include all TN document types. 2 To select the roles to which you want to grant permission. 4 Click OK.

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. For each role: a Click Edit in the row containing the role to which you want to grant data permissions. 5 Click Delete.0 75 . 2 Click Data Set Name from which you want to remove a role’s permission. you can typically assign the My webMethods role data-level security for some webMethods products. How Trading Networks Uses My webMethods Roles Privileges When you add or update a role in My webMethods. 2 Select the data permission rules that you want to remove. 10 Click Save. 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. 3 Click the Permissions tab. Data-level security defines the data on which a role can act. b In the EDIT PERMISSIONS dialog box. To remove a data permission completely. you do not assign Trading Networks data-level security using the Data Level Security tab of a My Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. c Repeat step 9 for each role you added in step 8. 4 Select the roles that you want to remove. both data set and permissions 1 In My webMethods: Administration > System-Wide > B2B Permissions > Data Permissions. but remove a role from the rule so that the role no longer has data permissions for the data set. 4 Configuring My webMethods to Work with Trading Networks 9 Grant data permissions to the roles you added in step 8. 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. 6 Click Save. Removing Data Permissions To remove data permissions. In case of Trading Networks.

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. . To configure resubmission and reprocessing settings 1 In My webMethods: Administration > Integration > B2B Settings > Administrative Preferences. Instead. You configure how long My webMethods Server waits for a response from the service before timing out the requested action. 2 In the Web Service Timeout field. 2 In the GENERAL PANEL. 3 Click Save. you grant roles Trading Networks data permissions. the Edit for Resubmit button will be available. 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. see “Defining Role-Based Access” on page 65. Configuring How Long My webMethods Waits for a Response When a My webMethods user issues a request that requires access to Trading Networks data.0 . The default is 60 seconds. The service that My webMethods Server executes is a web service.  The maximum number of documents that a My webMethods user can resubmit or reprocess at one time. My webMethods Server. 4 Configuring My webMethods to Work with Trading Networks webMethods role. which is in the GENERAL panel. . For more information about data permissions and general functional privileges. fill in the following fields: 76 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. if the document is the size you specify for Edit for Resubmit Maximum Size or smaller. If a document is greater than the value you specify the Edit for Resubmit button will not be available. in turn. specify the number of seconds that My webMethods Server should wait for a response from a Trading Networks Web service. attempts to execute a Trading Networks service on the Integration Server to perform the requested action. To configure how long My webMethods waits for a response 1 In My webMethods: Administration > Integration > B2B Settings > Administrative Preferences.

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Reprocessing/Resubmission Limit The maximum number of documents that a My webMethods user can resubmit or reprocess at one time. 3 Click Save.0 77 . 4 Configuring My webMethods to Work with Trading Networks 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.

0 .4 Configuring My webMethods to Work with Trading Networks 78 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

. . . . . . . . . . . . . . . . . . .0 79 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81  Task 2: Determine the Important Document Information . . . . . . 84  Task 4: Define Information to Maintain about Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . 93  Task 6: Define Actions to Perform Against Documents . . . . . . . . . . . . . . . . . .5 Planning Your Network  Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93  Task 7: Add Partners to Your Network . . . . . . . . . 82  Task 3: Define the Types of Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . 92  Task 5: Create Your Own Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80  Task 1: Identify the Types of Transactions to Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

For more information. use this information to define the profiles of your partners. and your profile into your production system using the export and import facility that Trading Networks provides. 3. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. processing rules.0 . Add partners to your network. that is. 80 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. profile fields. TN document types. see Appendix C. migrate your information to a production environment. You might want to perform these tasks in a development environment. The general order of tasks is: Task Description See page. based on your unique situations. For more information. The tasks are presented in the proposed order in which you should complete them. Determine the information that you want to maintain about your 92 partners. and processing rules that determine how Trading Networks processes documents that it receives. you can use your development system to test your trading network to ensure that documents are processed as intended. you can perform Task 7.. “Exporting and Importing Database Information”. Determine the pieces of information within documents that are 82 of interest to you and define this information to Trading Networks. 94 Tasks 1 through 6 define the behavior of your trading network. you have defined the document attributes. Define the types of documents you want Trading Networks to 84 recognize. 93 6. 1. 5. profile fields. add partners to your network. 2. After you have migrated information to your production system. TN document types. Define the actions that you want Trading Networks to take 93 against the documents it receives. you might want to perform the tasks in an alternative order.. You can migrate your document attributes. 4. however. Identify the types of transactions that Trading Networks must 81 handle. After Tasks 1 through 6 are completed. After you perform these tasks. This chapter describes the tasks to plan for and to set up your trading network.5 Planning Your Network Introduction Before you begin planning your network. After you ensure your trading network is defined properly. 7. it is helpful if you have a basic understanding of Trading Networks. Create the profile for your own corporation.

available to promise. see Optimizing B2B with BAM: webMethods Optimize for B2B User’s Guide. Place the samples in a directory that you will have available when using the Trading Networks Console. 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. purchase orders. and CBL. you must complete all the tasks from 1 to 7. You should know the types of transactions you will be exchanging with your trading partners (your suppliers. Although it is not necessary.). Obtain sample files. For each type of transactions. you might receive EDI. To do so. you need to define the types of documents that your Trading Networks system will receive. For example. for example. it is helpful if you can obtain a representative sample document for each variation of a transaction type. that is. etc. For information about configuring and enabling Trading Networks for BAM. etc. 5 Planning Your Network You can also BAM enable Trading Networks using webMethods Optimize for B2B. you might send documents that represent purchase orders. etc. OAG. you might receive purchase orders in cXML. This is applicable for XML documents only. and CBL purchase orders. you need to determine the variations of each transaction. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. In addition. For example. Task 1: Identify the Types of Transactions to Process To exchange documents with trading partners. confirmations. Task 1: Identify the Types of Transactions to Process Step Action  1.0 81 . For example. This is applicable for XML documents only. you can analyze and monitor Trading Networks transaction data for business purposes. Determine types of transactions. acknowledgements. cXML. 2. business partners. Determine variations of transaction types. This first task is to identify the transaction types that your Trading Networks system will receive. determine the variations of that transaction that you receive. 3.

0 . you can create a flat file schema that contains a particular TN document type’s structural information. see “Defining Document Gateway Services” on page 286. The information that Trading Networks extracts is available to determine how to process the document and for 82 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. This is applicable for XML documents only. Create a document gateway service. Task 2: Determine the Important Document Information To process and analyze the types of information that pass through your network. A document gateway service is the entry point for flat file documents into Trading Networks. This enables inbound flat file documents to be parsed and validated for use by back-end systems.  For XML documents: For XML documents. For more information about the flat file schema and parsing. If you want Trading Networks to be able to programmatically validate the structure of the documents it receives. and outbound documents to be converted to a flat file for delivery to another’s back-end system. For information about creating IS schemas. you must create schemas. For more information about transforming XML documents to IS documents (IData objects). For more information about the document gateway service. Create IS document types. To transform the XML documents to an IS document (IData object) to allow you to manipulate the document within a service.tn. Create IS schemas. This is applicable for flat file documents only. you must create IS schemas for each variation of a transaction type. set up IS document types for each variation of an XML document. including how to identify records and separate those records into fields. you can have Trading Networks extract information from documents.doc.xml:bizdocToRecord built-in service that is described in the webMethods Trading Networks Built-In Services Reference.You build/create your own flat file schema in webMethods Developer.5 Planning Your Network Task 1: Identify the Types of Transactions to Process Step Action  4. see the wm. For information about creating IS document types. see the webMethods Integration Server Schema Reference.  For flat file documents: For flat file documents. 6. Your trading partners send their flat files to the document gateway service so that Trading Networks can process the documents. see Developing Integration Solutions: webMethods Developer User’s Guide. You need to write a document gateway service to provide information hints for the Trading Networks recognition process. see the Flat File Schema Developer’s Guide 5.

A status that you or a partner has associated with the document  GroupID. you have to define the pieces of information within documents that are important to you. For Trading Networks to extract information. you might be interested in the total amount of purchase orders you receive. Trading Networks provides a different way to do this for TN flat file document types)  DoctypeID or DoctypeName. and you cannot delete them. 5 Planning Your Network you to use for reporting. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Identification of the partner that is to receive the document  DocumentID. Identification within a document that associates this document with other documents in the same “conversation” of documents  SignedBody and Signature. You do not need to define them. The following system attributes are provided for you:  SenderID. Identification within a document that associates this document with other documents in its group  ConversationID. For example. in this case. 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. define a custom attribute for total purchase order. a cXML purchase order. Identification of the document  UserStatus. and CBL purchase order all have some piece of information that represents the total purchase amount. Typically.0 83 . Identification of the partner that sent the document  ReceiverID. For example. You can use it to search for specific documents that have been sent through your system or to gather information about the documents that have been sent through your system. The 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. To identify other pieces of information within a document that are of interest. OAG purchase order. 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. you can define custom document attributes. Portions of the document that contain the data that was digitally signed and the digital signature (available only for TN XML document types. the documents for all variations of a transaction type have the same pieces of information. Trading Networks refers to these pieces of information as document attributes.

determine whether the document has been received before. complete the following tasks: Task 2: Determine the Important Document Information Step Action  1. Trading Networks uses the TN document types to recognize the type of document and perform actions based on the TN document type. 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. For instructions. or DATETIME) for the value of the attribute.5 Planning Your Network For each piece of information (attribute) that is of interest to you. NUMBER. When documents are first received. and/or save the document to the Trading Networks database. you might want to give the attribute a description. Identify the attribute. 84 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. The pre-processing actions indicate whether Trading Networks is to verify the document’s digital signature. you can define the TN document types for each of the variations of documents that Trading Networks will receive for a transaction. Optionally. Define the custom document attribute. 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. Select a name for the attribute and the data type (STRING. validate the structure of the document. 2. Use the Trading Networks Console and the information from Step 1 to define the attribute.0 . see “Defining Document Attributes” on page 212.

read “Pipeline Matching Criteria Used to Identify the TN Document Type” on page 292. if you are defining a cXML purchase order. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. you can have Trading Networks load the sample for your use in creating the XQL queries. you must provide an XQL query that identifies the location of the attribute within the document.  For flat file documents: you can specify arbitrary pipeline variables to identify a TN flat file document type. 5 Planning Your Network For each variation of a transaction. identify the parts of the document that uniquely identify a document as a cXML purchase order—it might be that the root tag of the document is cXML and there is “PurchaseOrder” node within the document. If you have a sample document available. Determine how to recognize documents of this type. If you have a sample document available. For details about what you can use to identify a TN XML document type. you can have Trading Networks load the sample for your use in creating the XQL queries. For details.  For XML documents: For example. Determine the attributes that you want to create from documents of this 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 XML documents: For each attribute that you want to extract from an XML document. read “Extraction Information In TN XML Document Types” on page 226. when you use the Trading Networks Console to define the TN XML document type. When a sample document is loaded. Identify the contents of the document that uniquely indicate that a document is this variation of a transaction. 2. you can select the node that contains the attribute information and Trading Networks creates the query for you. you can select the node in the sample document and Trading Networks creates the query for you.0 85 . To identify specific nodes within an XML document. You can have Trading Networks create any or all of the system and custom attributes from XML and flat file documents. For details about specifying XML document attributes. when you use the Trading Networks Console to define the TN document type. read “Identification Information in TN XML Document Types” on page 222. When a sample document is loaded. complete the following tasks: Task 3: Define the Types of Documents Step Action  1. you specify an XQL query.

you must extract the SenderID. specify the system and custom (user- defined) attributes that you want Trading Networks to extract from TN_parms and place in the bizdoc. read “Attributes To Extract From Documents” on page 293.)  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. (For more information. For Trading Networks to perform some pre-processing and processing actions. see “Checking for Duplicate of the XML Document” on page 244 and “Checking for Duplicates of the Flat File Document” on page 303. For example. you must extract certain system attributes. you need to extract the SenderID.5 Planning Your Network Task 3: Define the Types of Documents Step Action  2. (For more information.) Note: Typically.)  Alert E-mail processing actions—To send an e- mail message to a contact at the sender’s corporation. you might want all documents from a specific sender to be handled in a special way. For details about specifying flat file document attributes. see “Processing Rule Criteria” on page 322. 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.  For flat file documents: For each attribute that you want to create cont. You set up contacts when you define profiles for a partner.0 . see “Action 2—Send an Alert E-mail” on page 341.. These are attributes that Trading Networks can save to the database to use later. you need to extract the Sender ID. which is handled in a later task. you should always extract the SenderID system attribute. from a flat file document. (For more information.. 86 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

. (For more information.)  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.) Note: Typically. which is handled in a later task. ReceiverID  Processing rule search criteria—To process a document based on receiver of the document. You set up contacts when you define profiles for a partner. 5 Planning Your Network Task 3: Define the Types of Documents Step Action  2.0 87 . For example. you should always extract the ReceiverID system attribute Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see “Checking for Duplicate of the XML Document” on page 244 and “Checking for Duplicates of the Flat File Document” on page 303. you need to extract the ReceiverID. (For more information. see “Processing Rule Criteria” on page 322. you need to extract the ReceiverID..)  The Deliver Document By processing action—If you want Trading Networks to deliver the document to the receiver. System Attribute Function it affects… cont. see “Action 2—Send an Alert E-mail” on page 341. you need to extract the ReceiverID. see “Action 4—Deliver the Document to the Receiver” on page 344. (For more information. you must extract the ReceiverID.)  Alert e-mail processing action—To send an e- mail message to a contact at the receiver’s corporation. you might want all documents that are sent to a specific receiver to be handled in a special way. (For more information.

0 . you need to extract the SignedBody and Signature.) 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. (For more information. use this attribute to explicitly specify the processing rule. 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. see “Verifying the Digital Signature of Flat File Documents” on page 302. thus eliminating the overhead of that lookup. you need to extract the conversation ID. see “Checking for Duplicate of the XML Document” on page 244 and “Checking for Duplicates of the Flat File Document” on page 303.. (For more information.) Note: Typically.) 88 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.) processingRule Rather than have Trading Networks look up the ID appropriate rule for a flat file document. you should always extract the DocumentID system attribute. see “Important Attributes that You Should Extract from an XML Document” on page 226 or “Specifying the Document Gateway Services Outputs” on page 288. see “Verifying the Digital Signature of an XML Document” on page 242. To verify the digital signature of flat file documents. (For more information. (For more information. you need to extract the DocumentID.5 Planning Your Network Task 3: Define the Types of Documents Step Action  2.. System Attribute Function it affects… cont. see “Specifying the Document Gateway Services Outputs” on page 288. 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.

appropriate TN flat file document type for a flat file document.tn. 5 Planning Your Network Task 3: Define the Types of Documents Step Action  2. you must identify an IS document type with the document. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. DoctypeID Rather than have Trading Networks search for an cont. (For more information. use this attribute to explicitly specify the document type. For more information about associating an IS document type with a TN XML document type.tn. Determine whether you want to associate an IS document type with the TN XML document type. thus eliminating the overhead of that search..doc. see “Specifying the Document Gateway Services Outputs” on page 288. see “Specifying the Document Gateway Services Outputs” on page 288.) GroupID Use this attribute to easily locate all the flat file documents within the same group.xml:bizdocToRecord service uses the IS document type that you specify as the blueprint to form the IS document (IData object).) 3.0 89 . For more information about this service. see “Specifying an IS Document Type for TN XML Document Types” on page 241. see “Specifying the Document Gateway Services Outputs” on page 288. see the webMethods Trading Networks Built-In Services Reference.) UserStatus Use this attribute if you want to process a flat file document based on the user status. the wm. Also. If you will want to use the wm.. the user status is a criterion that Trading Networks uses to determine the processing rule to use for a document.doc. (For more information.xml:bizdocToRecord built-in service to transform the XML document to an IS document (IData object). This is applicable for XML documents only. (For more information.

5 Planning Your Network Task 3: Define the Types of Documents Step Action  4.tn. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 242 and “Pre- Processing Actions in the TN Flat File Document Type” on page 302. For more information. For more information about specifying the pre-processing actions in a TN document types. see “Verifying the Digital Signature of an XML Document” on page 242. you must have a certificate on file for each partner whose digital signature you want to verify. see “Validating the Structure of Flat File Documents” on page 302. For more information.rec:BizDocVerification service. you must specify a parsing schema that maps the structure of the TN flat file document type. you must specify an IS schema that maps the structure of the TN XML document type. For more information. 5. Determine the pre-processing actions you want Trading Networks to perform. this will be addressed in a later step. your verification service should implement the wm. see “Specifying an IS Schema for TN XML Document Types” on page 241.  For XML documents: To use this action. you must have Trading Networks extract the system attributes SignedBody and Signature. In addition. you must code the verification service for your flat file document.  For flat file documents: To use this action. see “Verifying the Digital Signature of Flat File Documents” on page 302.  Verify the digital signature of a document.  For XML documents: If you want Trading Networks to perform the Validate Structure pre-processing action to validate the structure of an XML document. For the inputs and outputs of the service. For more information.0 . Determine whether you want to associate a schema with the TN document type.  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. 90 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. You can specify whether you want Trading Networks to perform any or all of the following pre-processing actions against documents of this type.

see “Using Reliable Delivery with Immediate Delivery Method” on page 346.  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. attributes. sender and receiver  the same document ID. In this case. For more information. 5 Planning Your Network Task 3: Define the Types of Documents Step Action  5. cont. Trading Networks has a reliable delivery feature that it uses only if the document content is saved to the database. and/or log information to the database—You can have Trading Networks maintain information about the document in the database. For more information. For more information.  Check the for duplicate document of a document. Keep in mind that if processing rule processing is enabled. SenderID and/or ReceiverID. This will be addressed in a later task. the pre-processing actions can be overridden by selections you make in the processing rules that process a document. see “Validating the Structure of Flat File Documents” on page 302. see “Validating the Structure of an XML Document” on page 243.  For XML documents: To use this action. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 91 .. that is. you must specify an IS schema with the TN XML document type. sender and TN document type To use this action.. has Trading Networks already received the document—you can have Trading Networks determine whether it has already received a document with either:  the same document ID  the same document ID and sender  the same document ID.  Save a copy of the document content. You might want to disable processing rule processing if the document is to be processed as part of a business process. you must have Trading Networks extract the system attributes DocumentID. —Trading Networks will not perform any processing rule actions against the document. For flat file documents: To use this action.  Validate the structure of a document. The reliable delivery feature allows Trading Networks to attempt to deliver a document to a partner more than one time. you must specify a flat file schema with the TN flat file document type.

Review the standard profile fields that are provided. 92 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.5 Planning Your Network Task 3: Define the Types of Documents Step Action  6.0 . To see a description of the type of information in profiles. 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. “Standard Profile Fields” on page 116. For instructions. see “Information Trading Networks Maintains in a Profile” on page 99. Use the Trading Networks Console and the information from Steps 1-5 to define the TN document type. Task 4: Define Information to Maintain about Partners To determine the type of information you want to collect about your partner. 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  1. Determine whether the standard fields meet your needs. You can create TN XML document types and TN flat file document types. see “Defining TN XML Document Types” on page 247 and “Defining TN Flat File Document Types” on page 307. for example. For a list of the standard fields that you can change. Create the TN document type. you are ready to start to define information you need to store in the profiles for your partners. information you need access in services that process documents After you understand the type of information you need about your partners.

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. Task 5: Create Your Own Profile After you have defined the format of the profiles on your Trading Networks system. Examples of uses for process rules are:  Actions that you want to perform against all or several documents that Trading Networks receives. cost centers. For instructions on how to update whether fields are required or not.  If there are standard fields that are not currently required but that you want to require. (Note that if you want to use queued documents for delivery to partners and have the documents delivered at scheduled intervals. Trading Networks allows you to update a subset of the standard fields. or customer codes. you need to define the queues. To maintain information about partners that is not covered by the standard fields. 5 Planning Your Network Task 4: Define Information to Maintain about Partners Step Action  2. you can define extended profile fields. Define extended profile fields. For information about the standard fields that you can update. see “Updating Standard Profile Fields” on page 124. See Chapter 16. see “Extended Profile Fields” on page 123 and “Adding Extended Profile Fields” on page 125.  If there are standard fields that are required that you do not require. 3.0 93 . For example. Use processing rules to perform actions that are stateless. “Defining and Managing Queues in Trading Networks” for more information. you can update the fields.) Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Task 6: Define Actions to Perform Against Documents You can define how Trading Networks handles the documents it processes by setting up processing rules. you might be able to mark them not required. you might want to define extended fields for preferred shipping method. you can fill in your own profile. For instructions. Update standard fields as necessary. For instructions on how to define extended profile fields. meaning that each application of a processing rule has no knowledge of the actions that happen before it. see “Creating Your Own Profile” on page 132. see “Standard Profile Fields” on page 116.

see “Defining and Managing Processing Rules” on page 317. For instructions. To add partner.0 . Note: If you want to process documents as part of a complete business interaction (that is. You define the business process by using webMethods Designer to create a process model. 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 start exchanging business documents with the partner. If you have Trading Networks extract a conversation ID from a document. use process management. Then create the profile using the gathered information. you can now start adding partners to your network. Processing rules and conversation scripts are extremely flexible. see Getting Started with BPM and webMethods Designer Online Help. see “Adding Partner Profiles” on page 154. as a series of connected steps). To understand all of the capabilities of processing rules and how to set them up. After a partner is added to your network. 94 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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.5 Planning Your Network  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. gather the information required for the partner’s profile.

. . 97  Defining and Managing Profile Fields . . . . . . . . . . .0 95 . . . . . . . . . . . . . . . . . . . . 193 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . . . . 131  Defining and Managing Partner Profiles . . . . . . . . . . . . . . 187  Defining and Managing Trading Partner Agreements (TPAs) . . . . . . . . . . .II Managing Trading Partners  About Trading Partners . . . 153  Defining and Managing Partner Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115  Defining and Managing Your Profile (Your Enterprise) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

II Managing Trading Partners 96 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 .

. .6 About Trading Partners  How to Manage Partners in Your Trading Network . . . . . . . . . . . . . . . . . . . . 113  Profile Statuses . . . . . . . . . . . . . . . . . . . .0 97 . . . . . . . . . . . 98  Information Trading Networks Maintains in a Profile . . . . . . . . . . . . . . . . . 99  Steps to Setting up Partner Profiles in Trading Networks . . . . . . 113 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. For information about working with profile fields. You add profiles for those partners with which you want to exchange documents. After you create your own profile. Your profile contains the standard fields and the extended fields that you define. Defining the Information You Want to Collect about Partners A profile is made up of fields. Creating Your Own Profile Trading Networks maintains a profile for your corporation.  Extended fields are fields that you define to extend the standard profile. For information about what information Trading Networks includes in a profile and how you view the information.6 About Trading Partners How to Manage Partners in Your Trading Network Every corporation in your network. Adding Profiles for Partners To identify a partner with which you want to exchange business documents. 98 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.  A partner’s profile is information about a partner in your trading network. including your own corporation. you add a profile for the partner. For more information about trading partners information. You define and manage profile fields using My webMethods. “Defining and Managing Profile Fields”. Trading Networks is only aware of partners for which it has a profile. To add a partner to your network. see Chapter 7. Your profile must be filled out before you can exchange business documents with partners. 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. 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 can create profiles for your partners. To define the information that you want to collect about your partners. you add a profile for the partner.0 . requires a profile in the Trading Networks system. see “Information Trading Networks Maintains in a Profile” on page 99.

Preferred Language The Preferred Language option is for use only by other webMethods components (e. “XYZ Steel Company”. “Sales and Marketing”. In the Console. the field name is Unit Name. for example. 6 About Trading Partners Information Trading Networks Maintains in a Profile The following sections describe the information that Trading Networks maintains in a profile. For more information.. The status is shown only in the list of profiles. Status The status of the profile.g.  In Trading Networks Console on the Corporate tab of the Profile screen. Trading Networks does not use this option for its own processing. Partner Identification Information The following table lists the fields that Trading Networks uses to describe a corporation. specify the preferred language of the partner. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Optionally. These fields are located:  In My webMethods in the Partner Details panel of the Partner Profile page. the Status field is not listed in the profile details. In the Console. see “Profile Statuses” on page 113.0 99 . webMethods RosettaNet Module) for localization purposes. for example. Field Description Corporation Name The name of the partner’s corporation. Organization Unit The name of the organizational unit or division within the partner’s corporation.

webMethods for A partner in the network that is using Partners webMethods for Partners. Value Meaning webMethods Trading The corporation uses webMethods Networks Trading Networks. For example. Value The alpha-numerical value for the external ID type. Other/Unknown A partner in the network that is not using one of the other types of software. For example. Field Description ID Type The type of identification that a corporation uses within documents. 100 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. In the Console. within a document. Value is the partner’s D-U-N-S number. the field name is External ID Type. These fields are located:  In My webMethods on the External IDs tab of the Partner Profile page. this might be a partner that is using a webMethods Integration Server (without Trading Networks) or a marketplace. it determines the sender of the document is the partner with the matching profile. For example.6 About Trading Partners Field Description Partner Type The type of software the corporation uses to interact with the trading network. 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. Web Browser A partner in the network that is using a Web browser. the sending partner might be identified by its D-U-N-S number.0 . 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. The following table lists the fields that Trading Networks uses for external IDs. if ID type is “DUNS”. Note: This feature is deprecated and not available in My webMethods. When it finds a profile with an external ID of type DUNS that matches the value from the document.  In Trading Networks Console on the Corporate tab of the Profile screen.

State/Province The state or province where the partner’s corporation is located. you can optionally associate the profile with My webMethods user accounts. City The city where the partner’s corporation is located.  When you define a profile using the Trading Networks Console.default. “California”. “123 Main Street”.  In Trading Networks Console on the Corporate tab of the Profile screen.userCreation configuration property. For example. for example. Addresses You can identify one or more addresses for a corporation. the user can supply the user name and password of the user account associated with their profile. a zip code) for the state or province where the partner’s corporation is located. Field Description Country The country where the partner’s corporation is located. it uses the value of the default external ID as the user name of the user account. These fields are located:  In My webMethods on the Addresses tab of the Partner Profile page. “Los Angeles”. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. when the partner sends a document to your Trading Networks system.0 101 . This allows the partner that the profile defines to use the user account to access your Trading Networks system. When Trading Networks creates the user account. 6 About Trading Partners The external IDs can be used when creating a user account that is associated with the profile. Trading Networks can automatically create an Integration Server user account. the user account receives Trading Networks partner authority.default. for example. for example. You configure whether you want Trading Networks to create the user account using the tn. for example.  When you define or edit a profile in My webMethods. You can associate the profile with one or more My webMethods user accounts and/or an Integration Server user account. 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. The following table lists the fields that Trading Networks uses for address. “90001”. Postal Code The postal code (for example. for example “USA”. You configure the default external ID using the tn. Address The street address of the partner’s corporation. When you associate a user account with the profile.idType.

the field name is Role.tn. The following table lists the fields that Trading Networks uses for contacts. Note: Out-of-the-box. for example. 102 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. for example. Trading Networks allows you to select a contact type for the Alert e-mail processing action. You can add additional contact types by using the built-in service wm. Pager The contact's pager number. Telephone The contact's telephone number. Trading Networks provides pre-defined contact types. Note: In the Console on the Processing Rules screen. see “Action 2—Send an Alert E-mail” on page 341. “Trading Network Administrator”. E-Mail The contact's e-mail address. “1-800-555-1234”. In My webMethods.6 About Trading Partners Contacts You can define information about the people you interact with in a corporation.  In Trading Networks Console on the Contact tab of the Profile screen. for example. Trading Networks cannot send the e-mail message. If an e-mail address is not specified for a contact of the selected contact type. “1-330-555-7890”. for example. 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. Extension The contact's extension number. Field Description Name This column contains the list of contacts defined for a partner’s corporation. for example.dictionary:addContactType.0 . First Name The contact's first (given) name. Fax The contact's fax number. This column is listed only in Trading Networks Console on the Contact tab of the Profile screen. Last Name The contact's last name (surname). Contact Type The type of contact. “1-888-555-4897”. It is a combination of the Last Name and First Name fields. a Name list is not necessary because Trading Networks displays one row for each contact you have defined for a partner on the Partner Profile Contacts tab. the names and phone numbers of your contacts. for example. Title The contact’s job title. In the Console. For more information. The Alert e-mail processing action instructs Trading Networks to send an e-mail message to the contacts of the selected contact type. “Administrative”. see the webMethods Trading Networks Built-In Services Reference. For more information.

a zip code) for the state or province where the contact is located. “California”. for example. 6 About Trading Partners Field Description Country The country where the contact is located. When you define this delivery method. You can access the delivery settings in My webMethods on the Delivery Settings tab of the Partner Profile page. for example. you must define partner groups. For more information about how to create partner groups using My webMethods. for Trading Networks to deliver a document using HTTP. for example. for example. “Defining and Managing Partner Groups”. Suite 456”. see Chapter 10. For example. you define a delivery method that uses HTTP. “Los Angeles” State/Province The state or province where the contact is located. You can view the partner groups on the Partner Group Membership tab of the Partner Profile page. you must provide the partners host name and port that it uses to listen for HTTP requests. A partner can belong to more than one partner group. Postal Code The postal code (for example. Partner Group Membership You can associate partners with partner groups. “123 Main Street. Before you can associate partners with a partner group. Delivery Settings Trading Networks maintains the delivery methods in which it can deliver a document to a partner. “USA”. Address The street address of the contact. for example. “90001”. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 103 . You define partner groups using My webMethods. City The city where the contact is located. You must define the delivery methods you want Trading Networks to use to deliver documents and provide information that is specific to the partner.

and FTPS protocols.XYZSteel. and FTPS. and FTPS protocols. HTTP. Note: Trading Networks allows you to create immediate delivery methods using E-mail (SMTP). When you select a delivery method. FTP. and Web Service. for example. After you create the delivery method. 104 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. “XYZSteel. Trading Networks provides built-in immediate delivery methods for delivering documents via e-mail (SMTP). HTTPS. see Chapter 17. Trading Networks uses the fields in the following table for delivery methods. Trading Networks does not list all the fields for all delivery methods. In addition. This field appears Method only when you are creating a new delivery method. FTP. This option is only valid for HTTP. Delivery The name of the delivery method that you are creating. delivering into a message queuing system). Trading Networks automatically creates the delivery service with the same name as that of the delivery method. for example. Port The port number on which the partner listens for incoming requests. Field Description Delivery The delivery method that Trading Networks can use when delivering Method documents to the partner. HTTP. HTTPS.. Trading Networks lists the fields for the selected delivery method.g. for example.6 About Trading Partners Delivery Method Settings You can define multiple delivery methods for a partner. Name The value that you provide is prefixed with the delivery method that you want to use.0 . FTPS. FTP. HTTPS. If you require another method (e. The chapter describes how to add your own delivery methods.com”. FTP. HTTP . This option is only valid for HTTP. “Creating Delivery Services”. “5555”. HTTPS. Host The partner’s host name or IP address.

HTTPS. FTP or FTPS The directory path that Trading Networks is to use when sending documents. FTP. If you do not know what to specify for User Name. 0a010154f70ddbf900000203. the file extension is xml. Trading Networks does not display it for your (Enterprise) profile.xml.g. For more information.. Note: This field is for a partner profile only.0 105 . Note: This field is for a partner profile only. or FTPS). because trading partners are allowed to create custom scheduled delivery services.  For flat file documents. Trading Networks cannot anticipate which user-defined input variable might be a password. or FTPS).  For XML documents. HTTPS. Trading Networks automatically fills in the Location with /invoke/wm. 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).tn/receive. the file extension is dat 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. 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. It is not possible for Trading Networks to encrypt passwords used in scheduled delivery queues. The file name of the file is the internal ID that Trading Networks generates for the document when Trading Networks receives it. FTP. 6 About Trading Partners Field Description 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 does not display it for your (Enterprise) profile. contact the partner. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. e. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. the standard URL for document exchange.

Mapping The name of the mapping service that provides input to the Web service Service connector.6 About Trading Partners Field Description E-mail The e-mail address to use when delivering documents to the partner. you select the name of the public queue you want Trading Networks to use. 106 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 . see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. for example. Web Service The name of the Web service connector that you created in Integration Connector Server. 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. Output The output parameter of the Web service connector that contains the Parameter required response. A public queue is a queue that can contain documents for multiple receiving partners. Field Description Response Whether Trading Networks must create a new document out of the web Handling service response or add the web service response to the existing bizdoc. “bizdoc@isteel. Trading Networks uses Queue for Polling.com”. the following additional fields appear. When use this delivery method. If the Use as preferred protocol is not protocol selected for any delivery method. For information about web service delivery methods in Trading Networks. If you select the “Web Service” Delivery Method. If you select the “Queue for delivery” Delivery Method. Depending on the value specified in the Response Handling field. the following additional fields appear: Note: You cannot select either the public or private queue as the preferred protocol. the response is in a new document or as an additional part of the bizdoc. Use as The delivery method that the partner prefers be used to deliver preferred documents to the partner’s system. For more information about public queues. Key/Value Any constant input values to the Web service connector. see “Defining Public Queues” on page 386.

see “Adding and Registering New Delivery Services” on page 405. see “Using the Run Once Option” on page 380  Simple Interval. In the Console. The available options are:  Run Once. For more information. In the Console. see “Using a Custom Interval Option” on page 381. For more information about queue states. Inputs tab The inputs for the delivery service you selected. or Disable Queue). Trading Networks executes the delivery service repeatedly at an interval you specify. see “Using the Fixed Interval Option” on page 380. Trading Networks executes the delivery service a single time.0 107 . 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. Drain Queue. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For more information. see “Delivery Schedule for Queues” on page 379. In the Console. Suspend Delivery. these fields are on the Schedule tab. In the Console. For more information. When you use this delivery method.  Custom Interval. see “Scheduled Delivery Queue States” on page 381. 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. the field name is Delivery Service. Process The schedule of when Trading Networks is to invoke Queue the delivery service that will deliver documents from this queue. the field name is Queue State. 6 About Trading Partners Queue for delivery Field Description Use Private Indicates you are defining a delivery method to deliver documents Queue to a private scheduled delivery queue. For more information. the corresponding field is the Set Inputs button. A private queue contains only documents for the partner defined by the profile. State The state of the queue (Enable Queue. For more information.

Trading Networks uses also uses the Delivery Maximum Retries for scheduled delivery methods. Trading Networks uses 20000 milliseconds (20 seconds) for Wait Between Retries. 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. If you specify 0. Trading Networks uses the Retry Factor along with the Wait Between Retries value to calculate how long to wait for subsequent retry attempts.6 About Trading Partners 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.0 . 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. This is the default. these fields are not in your (Enterprise) profile. If you specify 0. Trading Networks attempts to redeliver a document five times. This is the default. Wait Between Retries. and Retry Factor for reliable delivery with immediate delivery methods. Delivery Method Tab Field Description Delivery The number of times you want Trading Networks to attempt to Maximum Retries redeliver a document to the partner’s system. 108 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Note: Trading Networks uses the Delivery Maximum Retries.

Trading Networks calculates the time to wait by multiplying the last wait time by Retry Factor. Polling Method The delivery method (e. 6 About Trading Partners Delivery Method Tab Field Description 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. see “Using Reliable Delivery with Immediate Delivery Method” on page 346 and “Using Reliable Delivery with Scheduled Delivery” on page 347. 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. If you do not want your Trading Networks system to poll for documents. Select the method from the list. Example: The following shows sample values for the reliable delivery settings and how they affect the wait times between attempts to redeliver a document.g. select the blank entry. Specify a whole number greater than zero for Retry Factor. 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. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. If you specify zero.. Polling Frequency How often Trading Networks is to poll the partner’s system to retrieve documents that the partner has queued for your system. Trading Networks will not poll. Note: Setting the polling frequency too low can have an adverse effect on Trading Networks performance.0 109 . Specify a number of minutes that is zero or greater.

Trading Networks holds the delivery tasks until delivery is resumed for this partner. Extended Fields Trading Networks lists the extended fields that you define for partner profiles in the following locations:  In My webMethods on the Extended Fields tab of the Partner Profile page. For example. Users You can optionally associate one or more My webMethods users with a profile. the user can supply the user name and password of the user account associated with their profile. when the partner sends a document to your Trading Networks system. Trading Networks does not deliver documents to the partner. When you associate a user account with the profile. The My webMethods user accounts associated with a profile are listed on the Users tab of a profile in My webMethods.  In My webMethods on the Certificates tab of the Partner Profile page. the user account receives Trading Networks partner authority.0 . When delivery is suspended. The following table lists the types of certificate information that you define: 110 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For documents where the partner is the receiving partner:  For immediate deliveries.  For deliveries that use reliable delivery or scheduled deliveries where the partner is the receiving partner. This field is not available in the Console. the deliveries fail.  In Trading Networks Console on the Security tab of the Profile screen. This allows the partner that the profile defines to use the user account to access your Trading Networks system.  In Trading Networks Console on the Extended Fields tab of the Profile screen. Certificates Trading Networks maintains partner certificates in the profile in the following locations.6 About Trading Partners Delivery Method Tab Field Description Suspend delivery Whether you want Trading Networks to suspend delivery for this partner.

You might have the private key if the profile describes an internal group. see the webMethods Trading Networks Built-In Services Reference. If you include the private key in this certificate information. Trading Networks digitally signs a document when the built-in service wm. 6 About Trading Partners 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 can also use this certificate information to digitally sign documents on behalf of the partner. see “Verifying the Digital Signature of an XML Document” on page 242 and “Verifying the Digital Signature of Flat File Documents” on page 302. for example a department within your corporation Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.doc:sign is invoked. For more information about this service. Trading Networks verifies a digital signature when instructed to do so by the Verify Digital Signature pre- processing action.tn. Trading Networks uses the certificate information to verify the digital signature of documents that were digitally signed by the partner. For more information.  In a partner profile.0 111 .

You might have the private key if the profile describes an internal group.0 . the partner does not belong to the data set. Trading Networks maintains this information for other webMethods components (e. You can also add your own functionality that takes advantage of this certificate information. this is referred to as SSL Client. and that partner does not belong to any data set that has the All Partners option selected. see security information in Administering webMethods Integration Server. SSL A certificate that enables Trading Networks to act as an SSL client to connect to a remote secure server. Trading Networks uses the certificate information to encrypt information that is being sent to a partner. this is referred to as Decrypt/Encrypt. this certificate information can also be used to decrypt documents that were encrypted with the partner’s public key.  In the your (Enterprise) profile.6 About Trading Partners Type Description Encrypt/ Certificate information that Trading Networks uses to decrypt or Decrypt encrypt information. The partner must be in at least one data set where the My webMethods user has the Create Profile permission. In the Console. If the check box against the data set name is not selected. you can supply a certificate information that Trading Networks uses to decrypt documents that your enterprise receives from partners.  In a partner profile. If you include the private key in this certificate information. In the Console. for example a department within your corporation. then an error message is displayed and the changes are not saved. 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. select the check box against the Rule Name check box.g. You can add a partner to a data set by selecting the check box against the data set name. Permissions Trading Networks lists all the data sets for which the My webMethods user has the Create Profile permission.. If the user attempts to remove the partner from all the data sets. 112 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. webMethods RosettaNet Module) that take advantage of this feature. To add the partners to all the data sets. You can obtain the certification information by using built-in services. For more information.

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 1 Set up the profile fields for Chapter 7. see.. “Defining and Managing Your Profile (Your Enterprise)” 3 Add partners by adding Chapter 9. For more information about the All Partners and Custom Selection options and about editing data sets. Steps to Setting up Partner Profiles in Trading Networks To set up the information you want Trading Networks to maintain in profiles and add partners to your network. Administrators can edit the data sets using the Dataset tab. Additionally.0 113 .. “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 will be able to exchange documents with that partner. but not yet enabled it. if you enable a partner’s profile. It does not list the data sets if the role has the All Partners option selected even if the role has the Create Profile permission. Either you have just added the profile. 6 About Trading Partners Trading Networks lists only those data sets that has the role in the data set that has the Create Profile permission and has the Custom Selection option selected. You have enabled the profile to set the status to “Active”. see “Defining Data Sets and Granting Roles Permissions to Act on the Data Set” on page 72. Inactive You have disabled the profile. perform the tasks in the following checklist:  Task For more information. “Defining and Managing Profile profiles Fields” 2 Create your own profile Chapter 8. or you have disabled the profile. Your (Enterprise) profile must be enabled before you can exchange documents with partners.

6 About Trading Partners 114 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124  Adding Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123  Updating Standard Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .0 115 . . . . 129 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . 127  Duplicating an Existing Profile Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Defining and Managing Profile Fields  What are Profile Fields? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127  Updating Extended Profile Fields . . . . . 116  Viewing Standard Profile Fields . . . . . 128  Enabling Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128  Disabling Extended Profile Fields . . . . . . . . . 125  Viewing Extended Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Trading Networks requires some of the standard fields to operate normally. Those that are not. see “Standard Profile Fields” on page 116. are required. When you are filling in a profile. Trading Networks places an asterisk (*) next to the required fields. Several of the standard fields. If you want to collect additional information about your partners that is not covered by the standard fields. Although Trading Networks has many standard fields. for example. 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 can view and update only a subset of the standard fields. The profiles that reside on your system contain all the extended fields that you define. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. For more information about profile fields. Required Fields A required field is one that you want supplied for all profiles. The following table lists the standard profile fields that you can update. you must supply information for all required fields before Trading Networks will allow you to enable the profile. 116 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 . the Trading Networks host and port number that a partner uses for HTTP to deliver a document to the partner via HTTP. you can define extended fields. you can mark them as required. All profiles on your system must have a value for required profile fields. you set up profile fields. However. You cannot add additional standard fields or disable the standard fields that are provided. For more information. Standard Profile Fields The standard profile fields are fields that are provided out-of-the-box. for example. For each field. you can modify the definitions for standard fields to change the description. you can mark as required if you want. However. For more information. how Trading Networks uses the field.  Extended fields are fields that you define to extend the standard profile. as defined out-of-the-box. see “Extended Profile Fields” on page 123. the name of the corporation and its address. and any consequences if a field is not included in a partner profile. the table lists a description of what each field is. When you create your own profile or add a profile for a partner. so you can easily determine the fields that are required. When you add extended fields.7 Defining and Managing Profile Fields What are Profile Fields? To define the information that you want to collect about your partners. Most of the standard fields are for your own use.

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. Preferred What it is: This field is used by other webMethods components (e..g. If not specified: The information will not be available. Unit Name What it is: This field identifies a unit name or division name within the corporation. for example. 7 Defining and Managing Profile Fields Standard Field Description Corporation Name What it is: This field identifies the name of the corporation. If not specified: Trading Networks will use only the Corporation Name for identification.0 117 . “Sales and Marketing”. Language webMethods RosettaNet Module) for localization purposes. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. if specified) to identify your enterprise or a partner within the network. “XYZ Steel Company”. for example. 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 not have a name to use to identify for the partner. 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.

7 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, “jsmith@XYZSteel.com”. 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 341.
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.

118 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

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

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 119

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

120 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

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

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.

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 121

7 Defining and Managing Profile Fields

Standard Field Description
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.

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.

122 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

7 Defining and Managing Profile Fields

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

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 123

7 Defining and Managing Profile Fields

4 Click Manage Extended Fields.
You will be prompted to save any changes you might have made to the profile you
were viewing. To discard the changes you might have made, click Discard and Proceed.
To work with the extended fields, click Save and Proceed.
5 Click the Standard tab, if it not already selected.

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

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

124 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

7 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 127. 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 discard the changes you might have made, click Discard and Proceed.
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.

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 125

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

126 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

7 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 discard the changes you might have made, click Discard and Proceed.
To work with the extended fields, click Save and Proceed.
5 Click the Extended tab, if it is 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 125, 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 127.

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 125.
5 Click OK.

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 127

4 Click OK. Note: To permanently remove the extended profile field from the database.7 Defining and Managing Profile Fields Updating Extended Profile Fields You can change all information for an extended profile field. For a description. 3 Update the field(s) you want to change.0 . This is true even when the updated extended profile fields has a default value. 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. Because the field is no longer displayed in profiles. Trading Networks no longer displays it in profiles. If you need procedures for this step. Disabling Extended Profile Fields If you no longer want to use an extended profile field. including its name. the information might not be available if the partner is not required to supply it. 2 Click in the ACTIONS column in the row containing the profile field you want to edit. When you disable an extended profile field. if you create new profiles after disabling a field. you can disable it. 128 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see step 6 on page 125. To update an extended profile field 1 View the extended fields. of what you can specify. Use caution when disabling fields. you must manually edit the existing profiles for the updated extended profile fields. the new profile will not contain information for the disabled field. Note: Use caution when changing fields from required to not required. 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. Trading Networks does not delete the field definition from the database or any information stored for the field in partner profiles. your database administrator must remove it. When you already have profiles in your system and then change an extended field from not required to required. If you have services that use the field or if you might create or update services that use the field. see “Viewing Extended Profile Fields” on page 127.

see “Viewing Extended Profile Fields” on page 127. If you need procedures for this step. You will need to manually update the profiles to supply the missing information. see “Viewing Extended Profile Fields” on page 127. perform the following procedure. 2 Click in the ACTIONS column in the row containing the profile field you want to disable. If you need procedures for this step. 3 Clear the check box in the Enabled field. To enable an extended profile field. you must first perform the procedure described in “Disabling Extended Profile Fields” on page 128. see “Updating Your Profile” on page 134. 3 Select the check box in the Enabled field. the profiles that were added in the interim do not contain information for the required field. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Enabling Extended Profile Fields If you disable an extended profile field and then later determine that you still need it. 4 Click OK. you can enable it.0 129 . 4 Click OK. If the profile field you are enabling is a required field. you might need to take further action. Important! To perform this procedure. For instructions on how to update a partner profile. 2 Click in the ACTIONS column in the row containing the profile field you want to disable. 7 Defining and Managing Profile Fields To disable an extended profile field 1 View the extended fields. To disable an extended profile field 1 View the extended fields. If you added partner profiles while the profile field was disabled.

0 .7 Defining and Managing Profile Fields 130 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

. . . . . . 134  Enabling Your Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .0 131 . . . . . . . . . . . . . . . . . . . . . . . . . . .8 Defining and Managing Your Profile (Your Enterprise)  Creating Your Own Profile . . . . . 132  Viewing Your Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150  Disabling Your Profile—Changing the Status to Inactive . . . . . . . . 133  Updating Your Profile . . . 151 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

the language preference you use if needed for another Language webMethods component (e. select Inactive. Status Whether you want your profile enabled or disabled.  To disable the profile.0 . 2 Click Create My Enterprise. see “Updating Your Profile” on page 134. To create your base profile 1 In My webMethods: Administration > Integration > B2B > Partner Profiles.  To enable the profile. Preferred Optionally. Trading Networks displays a page that you use to fill in the fields for your profile. For descriptions for how to specify information on the all tabs of the profile. the name of the organizational unit or division within Unit your corporation. “XYZ Steel Company”. then edit the profile to add additional information. you can add all information when creating the profile. 3 In the Partner Details panel.g. You can then add additional information to your profile.8 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. Corporation The name of your corporation. Although this section describes how to create the base profile.. fill in the following fields: Field Specify. Note: You should always keep your profile disabled until you complete filling in all the information you require in a profile. for example. for example.. select Active. You can make your changes to multiple tabs and save one time. “Sales and Marketing”.. webMethods RosettaNet Module). 132 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Name Organization Optionally.

perform the following procedure. a Click the External IDs tab. 2 Click My Enterprise. e Click OK. d Fill in the following fields: Field Specify. ID Value The value of the external ID type.  Click Save and Close to save the changes and close the profile. 2 In the Type Name file.. 5 You can do one of the following:  Continue editing the profile without saving. click Add ID. To add each external ID. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Be sure to include an external ID type for each type of identification that you use in documents. Note: You can add multiple external IDs that use the same type. To view your profile 1 In My webMethods: Administration > Integration > B2B > Partner Profiles. 8 Defining and Managing Your Profile (Your Enterprise) 4 Add at least one external ID to your profile. Viewing Your Profile To view your profile.. The maximum length you can specify for an external ID is 128 characters.0 133 . For example. ID Type The external ID type you want to use. 3 Click OK. b If the external ID type you want to use is not yet available. specify 987654321 for ID Value. perform the following to add it: 1 Click Add ID Type. You can specify an unlimited number of external ID types.  Click Save to save the changes you have made and continue working on the profile. c To add the external ID. specify the name of the new external ID type. if you selected DUNS and your D-U-N-S number is 987654321. perform the procedure below.

 Addition of extended profile fields that you need to fill in for your profile. Fields that you must specify are marked with an asterisk (*):  “Updating Your Corporation Information” on page 134  “Managing Your External IDs” on page 135  “Managing Addresses for Your Corporation” on page 136  “Managing the Contacts in Your Profile” on page 138  “Managing Your Partner Group Memberships” on page 139  “Managing Your Document Delivery Methods” on page 140  “Updating Extended Fields of Your Profile” on page 145  “Managing the My webMethods Users Associated with Your Profile” on page 145  “Managing Your Security Information” on page 147 Note: Although the last step of each profile indicates that you should save the profile. 2 Click My Enterprise. To update the corporation information in your profile 1 In My webMethods: Administration > Integration > B2B > Partner Profiles.  Change in your contact details. After you have completed your profile. perform the following procedure. 134 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 . you can edit several tabs of the profile before saving.  Change in the default certificate that Trading Networks uses to digitally sign documents.  Change in the port number on which Trading Networks listens for incoming requests.8 Defining and Managing Your Profile (Your Enterprise) Updating Your Profile To update your profile. The following are some reasons for updating your own partner profile:  Change in your corporation information. you might need to update it from time to time. Updating Your Corporation Information You can add or change your corporation information.

Name Organization The name of the organizational unit or division within your Unit corporation. Corporation The name of your corporation. webMethods RosettaNet Module). 2 Click My Enterprise. specify the name of the new external ID type.  To enable the profile. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. update any of the following fields: Field Specify. 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.. click Add ID. 2 In the Type Name file. 8 Defining and Managing Your Profile (Your Enterprise) 3 In the Partner Details panel. 3 Click OK. Status Whether you want your profile enabled or disabled.g. and delete external IDs. perform the following to add it: 1 Click Add ID Type. select Inactive. for example. select Active. for example. Preferred The language preference you use if needed for another webMethods Language component (e. 4 To add an external ID: a If the external ID type you want to use is not yet available. edit. To update the external IDs in your profile 1 In My webMethods: Administration > Integration > B2B > Partner Profiles.  Click Save and Close to save the changes and close the profile. 4 You can do one of the following:  Continue editing the profile without saving.0 135 .  Click Save to save the changes you have made and continue working on the profile. b To add the external ID. 3 Click the External IDs tab. “Sales and Marketing”. “XYZ Steel Company”. Managing Your External IDs You can add.  To disable the profile..

The maximum length you can specify for an external ID is 128 characters.0 . change the information in the row containing the external ID that you want to update. edit.  Click Save and Close to save the changes and close the profile. ID Value The value of the external ID type. if you selected DUNS and your D-U-N-S number is 987654321. 7 You can do one of the following:  Click a different profile tab to continue editing the profile without saving... 136 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. b Click Delete. 6 To delete an external ID: a Select the check boxes beside the external IDs that you want to delete. Note: Your profile must contain at least one external ID. Managing Addresses for Your Corporation You can add. d Click OK.  Click Save to save the changes you have made and continue working on the profile. and delete addresses for your corporation. 3 Click the Addresses tab. 5 To edit an external ID.  Type a new value in the VALUE field. For example. You can:  Select a new external ID type from the ID TYPE list. 2 Click My Enterprise. specify 987654321 for ID Value. To update the addresses for your corporation 1 In My webMethods: Administration > Integration > B2B > Partner Profiles. Note: You can add multiple external IDs that use the same type. ID Type The external ID type you want to use.8 Defining and Managing Your Profile (Your Enterprise) c Fill in the following fields: Field Specify.

a zip code) for the state or province where your corporation is located. 7 You can do one of the following:  Click a different profile tab to continue editing the profile without saving. “123 Address Line 2 Main Street. State/Province The state or province where your corporation is located. “90001”.  Click Save to save the changes you have made and continue working on the profile. “California”. For a description. for example. for example. Address Line 3 City The city where your corporation is located. click OK. for example. Suite 456”. Address The street address for your corporation. 6 To delete an address: a Select the check boxes beside the addresses that you want to delete. b Fill in the following fields: Field Specify. b Update the fields.. Country The country where your corporation is located. 8 Defining and Managing Your Profile (Your Enterprise) 4 To add an address: a Click Add Address. see step 4b above.  Click Save and Close to save the changes and close the profile.. b Click Delete. “USA”. Postal Code The postal code (for example. “Los Angeles”. c Click OK.0 137 . 5 To edit an existing address: a Click in the EDIT column for the address you want to edit. for example. for example. c After updating the fields. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

4 To add a contact: a Click Add Contact. “1-330-555-7890”. Select a contact type from the list. “1-888-555-4897”. Contact Type The type of contact. for example. 138 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. use the Extension field to identify the contact's extension. or remove contacts from your profile. Extension The contact's extension number. for example. “1-800-555-1234”. for example. b Fill in the following fields: Field Specify. Fax The contact's fax number.8 Defining and Managing Your Profile (Your Enterprise) Managing the Contacts in Your Profile You can add contacts. “USA”. Title The contact’s job title. Suite 456”. for example. Address The street address for the contact. for example. 3 Click the Contacts tab. To update the contacts in your profile 1 In My webMethods: Administration > Integration > B2B > Partner Profiles. “jsmith@XYZSteel. 2 Click My Enterprise.. Last Name The contact's last (surname) name. for example. Pager The contact's pager number. “Administrative”.0 . Address Line 3 City The city where the contact is located.. First Name The contact's first (given) name. “Trading Network Administrator”. edit contact information.com”. for example. If the telephone number in the Telephone field identifies the main line for the corporation. “123 Main Address Line 2 Street. Telephone The contact's telephone number. E-Mail The contact's e-mail address. for example. Country The country where your corporation is located. for example. “Los Angeles”.

7 You can do one of the following:  Click a different profile tab to continue editing the profile without saving.. b Update the fields.  Click Save and Close to save the changes and close the profile. a zip code) for the state or province where the contact is located. To manage your partner group membership 1 In My webMethods: Administration > Integration > B2B > Partner Profiles. c After updating the fields. see step 4b above.  Click Save to save the changes you have made and continue working on the profile. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. c Click OK. 4 Add your profile to partner groups. 6 To delete a contact: a Select the check boxes beside the contacts that you want to delete. “California”. 2 Click My Enterprise. 8 Defining and Managing Your Profile (Your Enterprise) Field Specify. For a description. b Click Delete.0 139 . identify the partner groups you want to be a member of by moving the groups from the AVAILABLE GROUPS list to the GROUPS THIS PARTNER BELONGS TO list.. 5 To edit a contact: a Click in the EDIT column for the address you want to edit. for example. 3 Click the Partner Group Membership tab. see “Defining a Partner Group” on page 188. Postal Code The postal code (for example. To add a new partner group. for example. Managing Your Partner Group Memberships You can be associated with partner groups. State/Province The state or province where the contact is located. “90001”. You can create your association with a partner group only if there are partner groups defined in the database. click OK.

Managing Your Document Delivery Methods You can add. b Select the delivery method from the Delivery Method list. Trading Networks redisplays the dialog listing the field required for the selected method. 4 To add a delivery method to your profile: a Click Add Delivery Method. Your Trading Networks system can deliver documents to your partners using the HTTP. SMTP. HTTPS. for example. E-mail. type a name for the delivery method.  Click Save and Close to save the changes and close the profile.8 Defining and Managing Your Profile (Your Enterprise) 5 Remove your profile from partner 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.XYZSteel. To update delivery methods in your profile 1 In My webMethods: Administration > Integration > B2B > Partner Profiles. The Deliver document processing action uses the settings on the Delivery Settings tab. Delivery methods specify how partners are to deliver documents to your Trading Networks system. c In the Delivery Method Name field. 3 Click the Delivery Settings tab. HTTPS. that is. and web service methods.  Click Save to save the changes you have made and continue working on the profile. or delete delivery methods. After you create the delivery method.0 . when you select HTTP. FTPS. This field appears only when you are creating a new immediate delivery method. FTPS. HTTP . or WebService in the Delivery Method field. 2 Click My Enterprise. FTP. where HTTP is the delivery method and “XYZSteel” is the value that you provide in this field. Trading Networks automatically creates the underlying delivery service with the same name. FTP. The value that you type in this field is prefixed with the delivery method to form the complete name. edit. 140 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

HTTPS—443. select Additional Content Part. Primary E-mail E-mail The e-mail address to which you want a partner Secondary E-mail to deliver documents. Primary HTTP Port The port number on which your system listens Primary HTTPS for incoming requests.com”.  To convert the response to a new document. 8 Defining and Managing Your Profile (Your Enterprise) d Fill in the following fields: Delivery Methods Field Specify. FTP or FTPS—21. Primary FTP Host The host name or IP address of your system. select New Document. for Primary FTPS example. Secondary FTP Secondary FTPS Note: If you do not supply a port number. specify a directory path on the machine identified by Host and Port to which your partners should deliver documents. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.  To add the response to the bizdoc. for example.  For HTTP or HTTPS.. for example. Trading Networks processes the new document like any other document it receives. FTP FTPS HTTP Location Where to deliver documents when using this HTTPS delivery method.com” WebService Response Whether the response received after the web Handling service execution must be added as an additional content to the bizdoc or must be converted to a new document. specify the URL partners should use to send documents to your system via HTTP or HTTPS.. SMTP “bizdoc@isteel. This is typically the following: /invoke/wm.0 141 . Secondary HTTP Trading Networks uses the following defaults: Secondary HTTPS HTTP—80. “XYZSteel. “5555”.tn/receive  For FTP or FTPS.

2 In the Namespace Name field. You can either provide a string or the entire namespace name. You deliver the document to the Connector partner using this Web service connector.. click Select. select or type the following fields: 1 In the Package Name field. type the namespace name of the Web service connector. 3 Click Search. 2 In the Namespace Name field. Select the required Web service connector from the list in the Name field. select or type the following fields: 1 In the Package Name field. To search for the fully-qualified name of the Web service connector. You can also use wildcard characters for the search. type the Integration Server package name in which the Web service connector exists.0 . Web The fully-qualified name of the Web service Service connector.. 3 Click Search.8 Defining and Managing Your Profile (Your Enterprise) Delivery Methods Field Specify. Mapping The fully-qualified name of the mapping service Service that provides the input to the Web service connector. click Select. 142 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. You can either provide a string or the entire namespace name. You can also use wildcard characters for the search. Select the required mapping service from the list in the Name field. To search for the fully-qualified name of the mapping service. type the Integration Server package name in which the mapping service exists. In the Select Web Service Connector dialog box. In the Select Mapping IS Service dialog box. type the namespace name of the mapping service.

Output The output parameter of the Web service Parameter connector that contains the required response.  Encrypt: Trading Networks encrypts the document being delivered to the partner. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8..  Secure: Trading Networks uses Secure Sockets Layer (SSL) while exchanging the documents.. click Select and select the required parameter in the Key field.  Sign: Trading Networks uses the specific private key required to sign the documents exchanged. Security The certificates that must be used to secure the Options communication between your Trading Networks and the partner web service. Key/Value The input parameter values that you can provide for the Web service connector while defining the delivery method.  Decrypt: Trading Networks decrypts the documents received from the partner. or converted to a new document. Select one or more security options listed below to specify the certificate information that Trading Networks must use.0 143 .  Verify: Trading Networks verifies the digital signatures of the documents exchanged. Based on the option you select in the Response Handling field. To search for output parameters. 8 Defining and Managing Your Profile (Your Enterprise) Delivery Methods Field Specify. the response is either added to the bizdoc of the transaction.

That is. Trading Networks uses the Queue for polling delivery method.. b Click Delete. 6 You can do one of the following:  Click a different profile tab to continue editing the profile without saving. For a description. b Update the fields. 4 To edit a delivery method: a Click in the EDIT column for the delivery method you want to edit. d After updating the fields. Input Whether the blank fields in Key/Value are inputs empty to the Web service connector. e If you prefer that partners use this delivery method to deliver documents to your Trading Networks system. If the Use as preferred protocol is not selected for any delivery method. when a values for field in Key/Value is blank: string  Select this option when Trading Networks types? must pass an empty string as the values for the corresponding input parameters of the Web service connector.. If the Use as preferred protocol is not selected for any delivery method.8 Defining and Managing Your Profile (Your Enterprise) Delivery Methods Field Specify. f Click OK. 5 To delete a delivery method: a Select the check boxes beside the delivery methods that you want to delete.  Click Save and Close to save the changes and close the profile.  Do not select this option when Trading Networks must ignore the empty strings and only consider the values from the corresponding input parameters of the Web service connector. click OK.0 . select the Use as preferred protocol check box.  Click Save to save the changes you have made and continue working on the profile. select the Use as preferred protocol check box. Trading Networks uses the Queue for polling delivery method. 144 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see step 4d above. c If you prefer that partners use this delivery method to deliver documents to your Trading Networks system.

2 Click My Enterprise. 8 Defining and Managing Your Profile (Your Enterprise) Updating Extended Fields of Your Profile You can edit the values for the extended fields. 4 Update the values for any of the extended fields. Managing the My webMethods Users Associated with Your Profile You can associate one or more My webMethods user accounts with your profile.  Associate an existing My webMethods user account with your profile. To associate a My webMethods user account. contact your Trading Networks administrator to determine what to specify.  Click Save to save the changes you have made and continue working on the profile. 2 Click My Enterprise.  Click Save and Close to save the changes and close the profile. 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. see “Central User Management—How Integration Server Authorizes My webMethods Users” on page 58. 5 You can do one of the following:  Click a different profile tab to continue editing the profile without saving.  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. 3 Click the Extended Fields tab. To update extended field values in your profile 1 In My webMethods: Administration > Integration > B2B > Partner Profiles. 3 Click the Users tab. To manage the My webMethods user accounts associated with your profile 1 In My webMethods: Administration > Integration > B2B > Partner Profiles.0 145 . Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For more information about how Trading Networks works with My webMethods user accounts. Note: If you do not know what to specify for an extended field and the description does not indicate what to specify.

d Click OK. Password The password for the new user. e Click OK. specify a single keyword that is contained in the first name. b In the Search for Available Users. My webMethods Server typically regards user IDs as case-insensitive. HTTP authentication. Confirm Password The same password you specified in the Password field. e-mail address.0 . b Select Add new user. b Select the external ID you want to use from the External ID list. c In the User Information section of the dialog. d To associate users with your profile.. User name The user name that you want to assign to the user you are adding. last name. however. fill in the following fields: 146 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. The user ID is not case sensitive.. or user name of the user account that you want to associate with the profile. move the users from the AVAILABLE USERS to the SELECTED USERS list. The user ID can be 1 through 255 characters and can contain only alphanumeric ASCII characters with no spaces. c In the User Information section of the dialog.8 Defining and Managing Your Profile (Your Enterprise) 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. 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. My webMethods Server uses the case you specify for actions that are case-sensitive. c Click Go. Note: My webMethods Server adds the user ID to the internal system directory service using the case you specify. for example. 5 To associate an existing My webMethods user account with your profile: a Select Add existing user. fill in the following fields: Field Specify.

if you import a . If you import a . Note: The value for the external ID must be 1 through 255 characters and can contain only alphanumeric ASCII characters with no spaces. When you add a certificate.cer or .p7b file. CA certificates. . Confirm Password The same password you specified in the Password field. Trading Networks can import files that have a . However. manage certificates and private keys in existing certificate sets. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks appends it to the existing certificate chain list. a Select the check boxes beside the user accounts that you want to delete. My webMethods Server adds the user ID to the internal system directory service using the case used for the external ID value. b Click Remove.  Click Save to save the changes you have made and continue working on the profile.p7b file. External ID The external ID you want to use.p7b extension. HTTP authentication.0 147 . Managing Your Security Information You can add certificate sets. 8 Defining and Managing Your Profile (Your Enterprise) Field Specify. Trading Networks replaces the certificate chain list with the . The certificates.  Click Save and Close to save the changes and close the profile.cer or . Note: Trading Networks does not delete the user accounts. Note: The user ID is not case sensitive.der. Password The password for the new user.der file. and delete certificate sets. My webMethods Server uses this case for actions that are case-sensitive. however. or . 8 You can do one of the following:  Click a different profile tab to continue editing the profile without saving. be sure also to add the CA certificate(s) and private key that are associated with the certificate.. and private keys must reside in your file system. d Click OK.. 7 To remove My webMethods user accounts that are associated with your profile.cer. for example.

5 To add certificate sets that you want Trading Networks to use when with specific partners: a Click Add Certificate Set. if you add a private key. be sure also to add the certificate and CA certificate(s) that are associated with the private key. Trading Networks first looks for a certificate set associated with a specific partner. When looking for a certificate set to use. click Add Certificate. To… SSL Client Enable Trading Networks to act as an SSL client to connect to a remote secure server. 2 Click My Enterprise. click in the EDIT column for the certificates a you want to add (SSL. Sign/Verify Digitally sign documents that your Enterprise sends to partners.0 . For example.. Add this type of certificate set. c To add a certificate. To add certificate sets to your profile 1 In My webMethods: Administration > Integration > B2B > Partner Profiles.8 Defining and Managing Your Profile (Your Enterprise) Likewise. Decrypt/Encrypt Decrypt documents that your Enterprise receives from partners. then click Browse and use the Choose File dialog box to select the certificate file. or Sign/Verify). Adding Certificate Sets You can add certificate sets that Trading Networks uses during processing. b Use the search panel to search for the profiles of the partners you want to add certificate sets for. if Trading Networks needs to digitally sign a document to send to partner A. 3 Click the Certificates tab. d Click OK. it first looks in your profile to determine whether you have a certificate set for partner A. If it does not have a set of certificates for the specific partner. Encrypt/Decrypt. For instructions for how to search for the partner profiles: 148 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. If you do. b To add the private key. click Browse and use the Choose File dialog box to select the private key file.. 4 To add the default certificate set: a Under the Default branch of the tree on the Certificates tab. Trading Networks uses the Default certificate set. Trading Networks uses those Sign/Verify certificates.

8 Defining and Managing Your Profile (Your Enterprise)  Keyword searches. Note: If you add a private key.  Click Save and Close to save the changes and close the profile. d Click OK. 4 To add a certificate. 6 You can do one of the following:  Click a different profile tab to continue editing the profile without saving. then click Browse and use the Choose File dialog box to select the certificate file. perform the following to add a certificate set for that partner: 1 Expand the tree for the partner. see the Working with My webMethods guide Trading Networks populates the AVAILABLE PARTNERS list with the results of your search. or Sign/Verify). see “Performing an Advanced Search for Partner Profiles” on page 158  Saved search. Trading Networks adds a branch to the tree for each partner you selected.  Click Save to save the changes you have made and continue working on the profile. 3 To add the private key. 5 Click OK. be sure also to add the certificate and CA certificate(s) that are associated with the private key. click Browse and use the Choose File dialog box to select the private key file. 2 Click in the EDIT column for the certificates you want to add (SSL. e For each partner. see “Performing a Keyword Search for Partner Profiles” on page 157  Advanced search.0 149 . Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Encrypt/Decrypt. c Select the partners that you want to add certificate sets for by moving the partner profiles from the AVAILABLE PARTNERS list to the SELECTED PARTNERS list. click Add Certificate.

6 To remove the private key.  Click Save and Close to save the changes and close the profile. you must enable your profile by updating your status to “Active”. When you enable your profile. Additionally. Trading Networks changes the status of the profile to “Active”. Enabling Your Profile—Changing the Status to Active Before you can exchange documents with partners. b Click OK. then click Browse and use the Choose File dialog box to select the certificate file. 11 You can do one of the following:  Click a different profile tab to continue editing the profile without saving. 4 Expand the branch for the certificate set that you want to work with. click Add Certificate. click Browse and use the Choose File dialog box to select the private key file. Encrypt/Decrypt.8 Defining and Managing Your Profile (Your Enterprise) Managing Certificate Sets You can add new certificates to or remove certificates from existing certificate sets. 9 To remove a certificate. 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. select the Clear Private Key check box.  Click Save to save the changes you have made and continue working on the profile. in the Certificates section of the screen. 10 Click OK. or Sign/Verify). 7 To add or update the private key. 8 To add a new certificate: a To add a certificate. For more information about statuses. click in the REMOVE column for the certificate you want to remove. 5 Click in the EDIT column for the certificates you want to update (SSL. Enabling your profile allows you to exchange documents with partners. 3 Click the Certificates tab. see “Profile Statuses” on page 113. 2 Click My Enterprise. 150 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 .

 Click Save and Close to save the changes and close the profile. see “Profile Statuses” on page 113. Trading Networks changes the status of your profile to “Inactive”. 4 You can do one of the following:  Continue editing the profile without saving. 3 In the Partner Details panel. select Inactive from the Status list.  Click Save to save the changes you have made and continue working on the profile. 3 In the Partner Details panel. As a result. For more information about statuses. 2 Click My Enterprise.  Click Save and Close to save the changes and close the profile. 8 Defining and Managing Your Profile (Your Enterprise) To enable your profile 1 In My webMethods: Administration > Integration > B2B > Partner Profiles.0 151 .  Click Save to save the changes you have made and continue working on the profile. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 2 Click My Enterprise. you will not be able to exchange documents with your partners. To disable your profile 1 In My webMethods: Administration > Integration > B2B > Partner Profiles. Disabling Your Profile—Changing the Status to Inactive When you disable your profile. 4 You can do one of the following:  Continue editing the profile without saving. select Active from the Status list.

8 Defining and Managing Your Profile (Your Enterprise) 152 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 .

. . . . . 183  Enabling a Partner’s Profile—Changing the Status to Active . . . . . . . . . . . . . . . . . . . . . . . . . . . 180  Suspending Delivery for a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159  Copying a Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154  Searching for Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181  Deleting a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184  Searching for Certificates that Are Expired or Expiring Soon . . . . . 156  Viewing Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . 159  Updating Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 Defining and Managing Partner Profiles  Adding Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .0 153 . . . . . 182  Disabling a Partner’s Profile—Changing the Status to Inactive .

9 Defining and Managing Partner Profiles Adding Partner Profiles If you are using Trading Networks. the name of the organizational unit or division within Unit the corporation. “XYZ Steel Name Company”. you are adding a partner to your network. If you want to add a partner profile that is similar to an existing profile. For instructions for how to add additional information to the profile. Trading Networks displays a page that you use to fill in the fields for the profile. 154 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For instructions. When you copy an existing profile. for example.. for example. Before you can create partner profiles. then edit the profile to add additional information. see “Updating Partner Profiles” on page 159. fulfill the following prerequisites: Prerequisite 1 Create and enable your Enterprise profile. you can add as many partners as you want.. 2 Review the fields you need to fill out for partner profiles. You can make your changes to multiple tabs and save one time. fill in the following fields: Field Specify. “Sales and Marketing”. Organization Optionally. 2 Click Add Profile. Although this section describes how to create the base profile. see “Creating Your Own Profile” on page 132 and “Enabling Your Profile—Changing the Status to Active” on page 150. webMethods for Partners allows you to maintain only a single partner. 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. you can add all information when creating the profile. If you are using webMethods for Partners and do not already have a partner. the form for the new profile is pre-filled with information from the profile that you select to copy.0 . To create a base partner profile 1 In My webMethods: Administration > Integration > B2B > Partner Profiles. you can add a single partner. Perform the procedure in this section to add a partner profile and fill in the minimum fields to create the profile. 3 In the Partner Details panel. Corporation The name of the partner’s corporation. use the procedure in “Copying a Partner Profile” on page 180. When you add a profile.

select Active. ID Value The value of the external ID type. perform the following to add it: 1 Click Add ID Type. 4 Add at least one external ID to the profile. specify 987654321 for ID Value. Note: You should keep the profile Inactive until you have completed filling in all the information you require in a profile. webMethods RosettaNet Module). users.. 3 Click OK. Status Whether you want the profile enabled or disabled. To add each external ID. e Click OK. c To add the external ID. For example.  To disable the profile.. for example. ID Type The external ID type you want to use. b If the external ID type you want to use is not yet available. Preferred Optionally the language preference the partner uses if needed for Language another webMethods component (e.  To enable the profile. if you selected DUNS and your D-U-N-S number is 987654321.0 155 . click Add ID. delivery methods. perform the procedure below.g.. select Inactive.. Be sure to include an external ID type for each type of identification that the partner uses in documents. a Click the External IDs tab.. Note: You can add multiple external IDs that use the same type. d Fill in the following fields: Field Specify. specify the name of the new external ID type. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 2 In the Type Name file. You can specify an unlimited number of external ID types. etc. The maximum length you can specify for an external ID is 128 characters. 9 Defining and Managing Partner Profiles Field Specify.

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 Working with My webMethods guide Trading Networks displays search results 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 156 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.. see.0 . if any. Partner Profiles” on page 158 Set the following search options for the Working with My webMethods guide Administration > Integration > B2B > 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. Search for partner profiles with corporation “Performing a Keyword Search for names and external IDs that contain Partner Profiles” on page 157 keywords that you specify. Searching for Partner Profiles The following table lists tasks related to searching for partner profiles and where to find more information about each task.9 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. Task For more information. Perform a detailed search for partner “Performing an Advanced Search for profiles.  Click Save and Close to save the changes and close the profile.

if you specify “abc corp”. If you leave the text box blank. Working with My webMethods guide Re-execute saved searches for partner Working with My webMethods guide profiles. Trading Networks searches for all partner profiles that you are authorized to view.. 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. see. both keywords must be present for Trading Networks to find a match. see the Working with My webMethods guide. however. Trading Networks searches for profiles where the keywords are in either the external IDs or the corporation name. Trading Networks would return a profile with an external ID value that is abc and the corporation name is corp. if neither the external IDs nor the corporation name contain abc. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. even if the corp name is corp. For example. type a keyword. 4 Click Go to execute the search. For more information about how to specify keywords. 3 In the text box. Trading Networks returns profiles where the external IDs contain abc corp and/or where the corporation name contains abc corp. Trading Networks searches for profiles where all keywords are in either the external ids and/or corporation name. If you put the keywords in quotes. When typing a keyword. 9 Defining and Managing Partner Profiles Task For more information. if you specify abc corp.0 157 . Save searches for partner profiles.. Trading Networks would not return the profile because the keyword abc is not present. The search will find all profiles that contain the keyword in an external ID value or the corporation name. Performing a Keyword Search for Partner Profiles Use a keyword search to find partner profiles based on their corporation names and external IDs. The search is case insensitive. 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. For example. However.

0 . select OR from the Search Condition list. c Specify the value you want to use in the comparison in the VALUE field. 158 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.  To specify that Trading Networks is to match any of the criteria. For each filter: a Select a search field from the FIELD NAME list. 3 In the text box. continue with step 5. d If you want to add another filter. optionally type a keyword that is contained in the corporation names and external IDs of the profiles you want to find. click Add and repeat step 4. regardless of what you specify for the Search Condition field.9 Defining and Managing Partner Profiles 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. see step 3 in “Performing a Keyword Search for Partner Profiles” on page 157. Note: If you specify multiple criteria for a single field. For more information about how to specify keywords. see the Working with My webMethods guide. when forming the query to search for profiles. 6 Click Go to execute the search. 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. b Select the operator you want to use to compare the field from the OPERATOR list. 2 Click the Advanced tab if it is not already displayed. If you do not want to add another filter. 4 Specify one or more filters. Trading Networks always uses an OR condition between each criteria.  To specify that Trading Networks is to match all criteria. select AND from the Search Condition list. For more information about how to specify the keyword.

0 159 . perform the following procedure. you can edit several tabs of the profile before saving. 9 Defining and Managing Partner Profiles Viewing Partner Profiles To view a partner profile. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. perform the following procedure. If you need procedures for this step. click in the ACTION column. Fields that you must specify are marked with an asterisk (*):  “Updating Your Partner’s Corporation Information” on page 160  “Managing Your Partner’s External IDs” on page 161  “Managing Your Partner’s Addresses for the Corporation” on page 162  “Managing Your Partner’s Contact Information” on page 163  “Managing Your Partner’s Group Memberships” on page 165  “Managing Reliable Delivery and Polling Settings in a Partner Profile” on page 165  “Managing Document Delivery Methods in a Partner Profile” on page 167  “Updating Extended Fields in a Partner Profile” on page 174  “Managing the My webMethods Users Associated with the Partner’s Profile” on page 174  “Managing Your Partner’s Security Information” on page 177 Note: Although the last step of each profile indicates that you should save the profile. Updating Partner Profiles To update a partner profile. To view a partner profile 1 Search for the profile you want to view. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. 2 To view the profile.

click in the ACTION column.  Click Save to save the changes you have made and continue working on the profile. If you need procedures for this step. To update the corporation information in a profile 1 Search for the profile you want to update.g. Status Whether you want the profile enabled or disabled.9 Defining and Managing Partner Profiles Updating Your Partner’s Corporation Information You can add or change the corporation information. update any of the following fields: Field Specify.. Organization The name of the organizational unit or division within the partner’s Unit corporation. select Active. “XYZ Steel Name Company”. for example. 160 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 4 You can do one of the following:  Continue editing the profile without saving. select Inactive.. for example. 2 To edit the profile.0 .  To disable the profile. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. “Sales and Marketing”. Preferred The language preference the partner uses if needed for another Language webMethods component (e. 3 In the Partner Details panel.  To enable the profile. Corporation The name of the partner’s corporation.  Click Save and Close to save the changes and close the profile.. webMethods RosettaNet Module).

Note: You can add multiple external IDs that use the same type. 3 Click the External IDs tab. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8..0 161 . specify 987654321 for ID Value. 2 To edit the profile. edit. click Add ID. The maximum length you can specify for an external ID is 128 characters. If you need procedures for this step. To update external IDs for a partner profile 1 Search for the profile you want to update. d Click OK. if you selected DUNS and your D-U-N-S number is 987654321. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. perform the following to add it: 1 Click Add ID Type. change the information in the row containing the external ID that you want to update. 5 To edit an external ID. and delete external IDs. 2 In the Type Name file. 4 To add an external ID: a If the external ID type you want to use is not yet available.  Type a new value in the VALUE field. specify the name of the new external ID type. b To add the external ID. 9 Defining and Managing Partner Profiles Managing Your Partner’s External IDs You can add. You can:  Select a new external ID type from the ID TYPE list. c Fill in the following fields: Field Specify. click in the ACTION column. ID Value The value of the external ID type. 3 Click OK. ID Type The external ID type you want to use. For example. 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..

edit. If you need procedures for this step. for example. Note: The profile must contain at least one external ID. Address Line 3 City The city where the partner’s corporation is located. and delete addresses for the corporation. 162 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 2 To edit the profile.. for example. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. b Fill in the following fields: Field Specify. 3 Click the Addresses tab. “California”. Address Line 2 “123 Main Street. 7 You can do one of the following:  Click a different profile tab to continue editing the profile without saving.  Click Save and Close to save the changes and close the profile. State/Province The state or province where the partner’s corporation is located. “Los Angeles”. Address The street address for the partner’s corporation.0 . Suite 456”. for example. Managing Your Partner’s Addresses for the Corporation You can add.  Click Save to save the changes you have made and continue working on the profile.9 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. To update the addresses for a corporation in a profile 1 Search for the profile you want to update. b Click Delete. 4 To add an address: a Click Add Address. click in the ACTION column..

“USA”.  Click Save to save the changes you have made and continue working on the profile. a zip code) for the state or province where the partner’s corporation is located. You can specify an unlimited number of contacts. or delete contacts. 2 To edit the profile. Managing Your Partner’s Contact Information You can add. For a description. 9 Defining and Managing Partner Profiles Field Specify. 4 To add a contact: a Click Add Contact. c Click OK. If you need procedures for this step. 6 To delete an address: a Select the check boxes beside the addresses that you want to delete. To update contacts for a partner profile 1 Search for the profile you want to update. edit. b Fill in the following fields: Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. for example. c After updating the fields. for example. “90001”.. b Click Delete. 5 To edit an existing address: a Click in the EDIT column for the address you want to edit. 3 Click the Contacts tab. Postal Code The postal code (for example. 7 You can do one of the following:  Click a different profile tab to continue editing the profile without saving.0 163 . b Update the fields. Country The country where the partner’s corporation is located.  Click Save and Close to save the changes and close the profile. see step 4b above. click OK. click in the ACTION column.. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158.

Suite 456”. for example. for example. “1-330-555-7890”. Select a contact type from the list. c After updating the fields. 164 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. State/Province The state or province where the contact is located. Telephone The contact's telephone number. for example.. “Administrative”. “jsmith@XYZSteel. Postal Code The postal code (for example. “Trading Network Administrator”. Contact Type The type of contact. Last Name The contact's last (surname) name. Extension The contact's extension number. “Los Angeles”. Address The street address for the contact.9 Defining and Managing Partner Profiles Field Specify. “90001”. 6 To delete a contact: a Select the check boxes beside the contacts that you want to delete. If the telephone number in the Telephone field identifies the main line for the corporation. c Click OK. for example. b Click Delete. click OK. “USA”. a zip code) for the state or province where the contact is located. Fax The contact's fax number. for example.com”. b Update the fields. 5 To edit a contact: a Click in the EDIT column for the address you want to edit. For a description. “California”. First Name The contact's first (given) name. Pager The contact's pager number. for example. “123 Main Address Line 2 Street. for example. “1-888-555-4897”. Country The country where your corporation is located.0 . “1-800-555-1234”. for example. for example.. E-Mail The contact's e-mail address. Address Line 3 City The city where the contact is located. Title The contact’s job title. use the Extension field to identify the contact's extension. see step 4b above. for example. for example.

see “Defining a Partner Group” on page 188. 9 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 in the ACTION column. 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. To add a new partner group. To update your partner’s group membership 1 Search for the profile of the partner you want to update.  Click Save to save the changes you have made and continue working on the profile. 5 Remove the partner profile from partner 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.  Click Save and Close to save the changes and close the profile.0 165 .  Click Save to save the changes you have made and continue working on the profile. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. see “Using Reliable Delivery with Immediate Delivery Method” on page 346 and “Using Reliable Delivery with Scheduled Delivery” on page 347. 4 Add the partner profile to partner groups.  Click Save and Close to save the changes and close the profile. 3 Click the Partner Group Membership tab. If you need procedures for this step. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For more information about reliable delivery. identify the partner groups by moving the groups from the AVAILABLE GROUPS list to the GROUPS THIS PARTNER BELONGS TO list. 2 To edit the profile. Managing Your Partner’s Group Memberships You can add or remove your partner from partner groups. 6 You can do one of the following:  Click a different profile tab to continue editing the profile without saving. You can associate partners with a partner group only if there are partner groups defined in the database. Trading Networks uses the polling settings to polling for documents that are waiting in the partner’s system.

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). see “Managing Document Delivery Methods in a Partner Profile” on page 167. 4 Update the following reliable delivery settings using the following fields: Field Description Delivery Maximum The number of times you want Trading Networks to attempt Retries to re-deliver a document to the partner when Trading Networks is using reliable delivery. Note: The Delivery Maximum Retries. Note: You can also use the Delivery Settings tab to manage delivery methods. Wait Between The number of milliseconds you want Trading Networks to Retries wait before making its first attempt to redeliver the document when Trading Networks is using reliable delivery. The Delivery Maximum Retries option is used for both immediate and scheduled delivery methods. Trading Networks uses the Retry Factor along with the Wait Between Retries value to calculate how long to wait for subsequent retry attempts. click in the ACTION column.9 Defining and Managing Partner Profiles To update reliable delivery and polling settings in a partner profile 1 Search for the profile you want to update. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. 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. Specify a whole number. If you need procedures for this step. 166 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 . Wait Between Retries. and Retry Factor options are only used when Trading Networks is using reliable delivery (delivery tasks). 3 Click the Delivery Settings tab. 2 To edit the profile.

edit.  Click Save to save the changes you have made and continue working on the profile. 9 Defining and Managing Partner Profiles Field Description 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.  Click Save and Close to save the changes and close the profile. Polling Frequency How often in minutes you want your Trading Networks to poll the partner’s system for documents. For more information about the Deliver Document By processing action. Trading Networks calculates the time to wait by multiplying the last wait time by Retry Factor.0 167 . and Web Service methods. see “Suspending Delivery for a Partner” on page 181. HTTPS. see “Action 4—Deliver the Document to the Receiver” on page 344. Your Trading Networks can deliver documents to your partners using the HTTP. Managing Document Delivery Methods in a Partner Profile You can add. Delivery methods specify how your Trading Networks system delivers documents to the partner associated with a profile. 6 You can do one of the following:  Click a different profile tab to continue editing the profile without saving. The Deliver document processing action uses the settings on the Delivery Method tab. E-mail. 5 Update the following polling settings: Field Description Polling Method The method that your Trading Networks system uses to contact the partner’s system to request queued documents. Select the method from the list. Note: For more information about the Suspend Delivery check box. Specify a whole number greater than zero for Retry Factor. FTP. Note: If you do not want your Trading Networks system to poll for documents. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. or delete delivery methods. select the blank entry. FTPS.

FTP.0 . Primary HTTP Port The port number on which the partner’s system Primary HTTPS listens for incoming requests. for example. After you create the delivery method. 2 To edit the profile. This field appears only when you are creating a new immediate delivery method. HTTPS—443.. The value that you type in this field is prefixed with the delivery method to form the complete name.. where HTTP is the delivery method and “XYZSteel” is the value that you provide in this field. for Primary FTPS example. FTPS. “XYZSteel. SMTP. 3 Click the Delivery Settings tab. b Select the delivery method you want to add to from the Delivery Method list. or WebService in the Delivery Method field. type a name for the delivery method. for example.XYZSteel. Trading Networks redisplays the dialog listing the field required for the selected method. Note: You can also use the Delivery Settings tab to manage reliable delivery and polling settings. If you need procedures for this step. Secondary FTP “5555”. d Fill in the following fields: Delivery Methods Field Specify. Primary FTP Host The host name of the partner’s system. when you select HTTP. HTTPS. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. see “Managing Reliable Delivery and Polling Settings in a Partner Profile” on page 165. c In the Delivery Method Name field. Trading Networks automatically creates the underlying delivery service with the same name. HTTP . 4 To add a delivery method to your profile: a Click Add Delivery Method.9 Defining and Managing Partner Profiles To update delivery methods for a partner profile 1 Search for the profile you want to update. For more information. Secondary HTTPS Trading Networks uses the following defaults: FTP HTTP—80. FTPS HTTP HTTPS 168 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Secondary FTP Secondary HTTP Note: If you do not supply a port number.com”. FTP or FTPS—21. click in the ACTION column. that is.

Note: If you do not know what to specify for User Name. this is typically the following: /invoke/wm.com” Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.  For HTTP or HTTPS. The user account can be either an Integration Server user account or My webMethods user account. 9 Defining and Managing Partner Profiles Delivery Methods Field Specify. Trading Networks delivers the document to this directory. however. for example. it must be a user account that has partner authority. Password The password that your Trading Networks system is to supply (along with User Name) when connecting to the partner’s system. If the partner is using Trading Networks. “cgi-bin/acceptOrder”. specify the URL Trading Networks is to use when sending a document to the partner’s system.. contact the partner. Primary E-mail E-mail The e-mail address of the partner to which you Secondary E-mail must deliver documents. Location Where to deliver documents when using this delivery method.. for example. specify the directory path on the partner’s system identified by Host and Port. a member of the TNPartners IS group. that is. SMTP “bizdoc@isteel. User Name The user name that your Trading Networks system is to supply when connecting to the partner’s system to deliver documents.0 169 .tn/receive  For FTP or FTPS.

Web The fully-qualified name of the Web service Service connector that you created in Integration Connector Server. You can also use wildcard characters for the search. select or type the following fields: 1 In the Package Name field.. select New Document. Select the required Web service connector from the list in the Name field. 170 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. select Additional Content Part. WebService Response Whether the response received after the web Handling service execution must be added as an additional content to the bizdoc or must be converted to a new document.0 . 2 In the Namespace Name field. type the Integration Server package name in which the Web service connector exists.. Trading Networks processes the new document like any other document it receives.9 Defining and Managing Partner Profiles Delivery Methods Field Specify. To search for the fully-qualified name of the Web service connector.  To add the response as an additional content in the bizdoc. type the namespace name of the Web service connector. In the Select Web Service Connector dialog box.  To convert the response to a new document. click Select. You can either provide a string or the entire namespace name. 3 Click Search.

Mapping The fully-qualified name of the mapping Service service that provides the input to the Web service connector. You can also use wildcard characters for the search. select or type the following fields: 1 In the Package Name field. 2 In the Namespace Name field. click Select. Based on the option you select in the Response Handling field. To search for the fully-qualified name of the mapping service. 9 Defining and Managing Partner Profiles Delivery Methods Field Specify. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. type the namespace name of the mapping service. To search for the output parameters.. You can either provide a string or the entire namespace name.. Output The output parameter of the Web service Parameter connector that contains the required response. type the Integration Server package name in which the mapping service exists. or converted to a new document.0 171 . In the Select Mapping IS Service dialog box. 3 Click Search. the response is either added to the bizdoc of the transaction. click Select and select the required parameter in the Key field. Select the required mapping service from the list in the Name field.

Key/Value The input parameter values that you can provide for the Web service connector while defining the delivery method.9 Defining and Managing Partner Profiles Delivery Methods Field Specify.  Encrypt: Trading Networks encrypts the document being delivered to the partner.. That is. Select one or more security options listed below to specify the certificate information that Trading Networks must use.  Verify: Trading Networks verifies the digital signatures of the documents exchanged.  Do not select this option when Trading Networks must ignore the empty strings and only consider the values from the corresponding input parameters of the Web service connector.  Sign: Trading Networks uses the specific private key required to sign the documents exchanged. when a string field in Key/Value is blank.  Secure: Trading Networks uses Secure Sockets Layer (SSL) while exchanging the documents. types?  Select this option when Trading Networks must pass an empty string as the values for the corresponding input parameters of the Web service connector.  Decrypt: Trading Networks decrypts the documents received from the partner.0 . Security The certificates that must be used to secure the Options communication between the partner and your Trading Networks.. 172 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Input empty Whether the blank fields in Key/Value are inputs values for to the Web service connector.

c If the partner prefers that your system uses this delivery method to deliver documents to the partner’s system.  Click Save to save the changes you have made and continue working on the profile. 4 To edit a delivery method: a Click in the EDIT column for the delivery method you want to edit. If the Use as preferred protocol is not selected for any delivery method. 6 You can do one of the following:  Click a different profile tab to continue editing the profile without saving.  Click Save and Close to save the changes and close the profile. Trading Networks uses the Queue for polling delivery method. Use Private The definition of the private queue. f Click OK. e If the partner prefers that your system uses this delivery method to deliver documents to the partner’s system. b Update the fields.. Note: You cannot select the Queue for delivery as the preferred protocol. Queue For instructions for how to define a private queue. see “Defining Private Queues” on page 383. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. click OK. delivery Queue Select the Use Public Queue and then select the name of a public queue from the list. If the Use as preferred protocol is not selected for any delivery method. You cannot select the Queue for delivery as the preferred protocol. see step 4d above. Trading Networks uses the Queue for polling delivery method. select the Use as preferred protocol check box. 9 Defining and Managing Partner Profiles Delivery Methods Field Specify. 5 To delete a delivery method: a Select the check boxes beside the delivery methods that you want to delete. b Click Delete..0 173 . Queue for Use Public The public queue you want to use. For a description. select the Use as preferred protocol check box. d After updating the fields.

9 Defining and Managing Partner Profiles Updating Extended Fields in a Partner Profile You can edit the values for the extended fields.  Define a new My webMethods user account where Trading Networks uses the values of one of the external IDs defined in the partner profile as the user name for the account and then associates that user account with the partner profile. To update extended fields in a partner profile 1 Search for the profile you want to update. 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 the partner profile.  Associate an existing My webMethods user account with the partner profile. Managing the My webMethods Users Associated with the Partner’s Profile You can associate one or more My webMethods user accounts with the partner’s profile. see “Central User Management—How Integration Server Authorizes My webMethods Users” on page 58.  Click Save and Close to save the changes and close the profile. 174 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. click in the ACTION column.  Click Save to save the changes you have made and continue working on the profile.0 . 5 You can do one of the following:  Click a different profile tab to continue editing the profile without saving. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. To associate a My webMethods user account. contact your Trading Networks administrator to determine what to specify. 2 To edit the profile. If you need procedures for this step. Note: If you do not know what to specify for an extended field and the description does not indicate what to specify. 4 Update the values for any of the extended fields. For more information about how Trading Networks works with My webMethods user accounts. 3 Click the Extended Fields tab.

click in the ACTION column. b In the Search for Available Users. 9 Defining and Managing Partner Profiles To manage the My webMethods user accounts associated with the partner profile 1 Search for the profile of the partner you want to update. My webMethods Server typically regards user IDs as case-insensitive. 2 To edit the profile.0 175 . 3 Click the Users tab.. Password d Click OK. Note: My webMethods Server adds the user ID to the internal system directory service using the case you specify. HTTP authentication. fill in the following fields: Field Specify. specify a single keyword that is contained in the first name. User name The user name that you want to assign to the user you are adding. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. e-mail address. or user name of the user account that you want to associate with the partner. The user ID can be 1 through 255 characters and can contain only alphanumeric ASCII characters with no spaces. If you need procedures for this step. 5 To associate an existing My webMethods user account with the partner profile: a Select Add existing user. Confirm The same password you specified in the Password field. Password The password for the new user. however. b Select Add new user.. d To associate users with the partner profile. move the users from the AVAILABLE USERS to the SELECTED USERS list. c Click Go. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. c In the User Information section of the dialog. 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. My webMethods Server uses the case you specify for actions that are case-sensitive. last name. The user ID is not case sensitive. for example.

7 To remove My webMethods user accounts that are associated with the partner profile. Note: The value for the external ID must be 1 through 255 characters and can contain only alphanumeric ASCII characters with no spaces. 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.9 Defining and Managing Partner Profiles e Click OK. External ID The external ID you want to use. 176 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. HTTP authentication. a Select the check boxes beside the user accounts that you want to delete. Confirm The same password you specified in the Password field.0 . fill in the following fields: Field Specify. Password d Click OK. b Select the external ID you want to use from the External ID list. Note: Trading Networks does not delete the user accounts. My webMethods Server adds the user ID to the internal system directory service using the case used for the external ID value. Note: The user ID is not case sensitive. Password The password for the new user. 8 You can do one of the following:  Click a different profile tab to continue editing the profile without saving. however. c In the User Information section of the dialog.  Click Save to save the changes you have made and continue working on the profile. for example... b Click Remove. My webMethods Server uses this case for actions that are case-sensitive.  Click Save and Close to save the changes and close the profile.

CA certificates. Trading Networks first looks for a certificate set associated with a specific partner. Trading Networks uses the Default certificate set.p7b file.. If you need procedures for this step.der file. manage certificates and private keys in existing certificate sets. Trading Networks uses those Sign/Verify certificates. Trading Networks replaces the certificate chain list with the .p7b file. Likewise.. if you import a . If found. Adding Certificate Sets You can add certificate sets that Trading Networks uses during processing. .cer or . Decrypt/Encrypt Encrypt information that is being sent to a partner. However. Sign/Verify Verify the digital signature of documents that were digitally signed by this partner. When you add a certificate. if you add a private key. be sure also to add the certificate and CA certificate(s) that are associated with the private key.p7b extension. Add this type of certificate set. For example. it first looks for a partner A certificate set. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. or . If it does not have a set of certificates for the specific partner. be sure also to add the CA certificate(s) and private key that are associated with the certificate.0 177 . The certificates. and private keys must reside in your file system. and delete certificate sets.cer or . 4 To add the default certificate set: Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 2 To edit the profile. If you import a . if Trading Networks needs to verify the digital signature of partner A. click in the ACTION column. Trading Networks appends it to the existing certificate chain list. To… SSL Client Enable Trading Networks to act as an SSL client to connect to a remote secure server. When looking for a certificate set to use.cer. To add certificate sets to the profile 1 Search for the profile you want to update. Trading Networks can import files that have a . 3 Click the Certificates tab. 9 Defining and Managing Partner Profiles Managing Your Partner’s Security Information You can add certificate sets.der.

c To add a certificate.9 Defining and Managing Partner Profiles a Under the Default branch of the tree on the Certificates tab. c Select the partners that you want to add certificate sets for by moving the partner profiles from the AVAILABLE PARTNERS list to the SELECTED PARTNERS list. see “Performing an Advanced Search for Partner Profiles” on page 158  Saved search. Encrypt/Decrypt. then click Browse and use the Choose File dialog box to select the certificate file.0 . 2 Click in the EDIT column for the certificates you want to add (SSL. 3 To add the private key. or Sign/Verify). click in the EDIT column for the certificates a you want to add (SSL. see “Performing a Keyword Search for Partner Profiles” on page 157  Advanced search. 5 To add certificate sets that you want Trading Networks to use when with specific partners: a Click Add Certificate Set. 5 Click OK. click Add Certificate. Encrypt/Decrypt. Trading Networks adds a branch to the tree for each partner you selected. then click Browse and use the Choose File dialog box to select the certificate file. b To add the private key. 4 To add a certificate. d Click OK. d Click OK. b Use the search panel to search for the profiles of the partners you want to add certificate sets for. be sure also to add the certificate and CA certificate(s) that are associated with the private key. 178 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. perform the following to add a certificate set for that partner: 1 Expand the tree for the partner. or Sign/Verify). For instructions for how to search for the partner profiles:  Keyword searches. click Browse and use the Choose File dialog box to select the private key file. Note: If you add a private key. e For each partner. click Add Certificate. click Browse and use the Choose File dialog box to select the private key file. see the Working with My webMethods guide Trading Networks populates the AVAILABLE PARTNERS list with the results of your search.

To manage certificate sets 1 Search for the profile you want to update.  Click Save and Close to save the changes and close the profile. you can add private keys to or remove private keys from existing certificate sets. 6 To remove the private key. 2 To edit the profile. Additionally. in the Certificates section of the screen.  Click Save and Close to save the changes and close the profile. click Browse and use the Choose File dialog box to select the private key file.0 179 . 9 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. or Sign/Verify). then click Browse and use the Choose File dialog box to select the certificate file. 10 Click OK. b Click OK. click Add Certificate. 11 You can do one of the following:  Click a different profile tab to continue editing the profile without saving. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. Encrypt/Decrypt. 3 Click the Certificates tab. If you need procedures for this step. 5 Click in the EDIT column for the certificates you want to update (SSL. 7 To add or update the private key. 9 To remove a certificate. click in the ACTION column. Managing Certificate Sets You can add new certificates to or remove certificates from existing certificate sets. 4 Expand the branch for the certificate set that you want to work with.  Click Save to save the changes you have made and continue working on the profile. click in the REMOVE column for the certificate you want to remove. select the Clear Private Key check box. 8 To add a new certificate: a To add a certificate.

. “XYZ Steel Name Company”. Preferred Optionally the language preference the partner uses if needed for Language another webMethods component (e. as described in “Adding Partner Profiles” on page 154. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158.. for example. the name of the organizational unit or division within Unit the corporation. “Sales and Marketing”. When you copy an existing profile. see the sections in “Updating Partner Profiles” on page 159. For instructions. webMethods RosettaNet Module).9 Defining and Managing Partner Profiles Copying a Partner Profile In addition to adding a new partner profile by filling in a blank form. you can also add a new partner profile that is similar to an existing profile. Note: You should keep the profile Inactive until you have completed filling in all the information you require in a profile. Status Whether you want the profile enabled or disabled. To add a new partner profile by copying an existing profile 1 Search for the profile you want to copy. 5 Make any other changes you need to make to the profile.g. For instructions.  To disable the profile. fill in the following fields: Field Specify. delivery methods. Corporation The name of the partner’s corporation. Organization Optionally. 3 In the Partner Details panel. 4 Click the External IDs tab and add external IDs for the partner. select Inactive.. for example. etc. 2 Click in the ACTION column in the row containing the partner profile you want to copy. see “Managing Your Partner’s External IDs” on page 161. 180 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. select Active. users. for example.  To enable the profile. If you need procedures for this step. the form for the new profile is pre-filled with information from the partner that you select to copy.0 .

As a result.0 181 . Reliable service execution tasks are also affected when deliveries are suspended. Trading Networks assigns the service execution tasks a HELD status. If you need procedures for this step. Because Trading not use reliable delivery Networks does not save the document to the database. Trading Networks updates the task statuses to PENDING and as a result. Immediate delivery that does Delivering documents will fail. select the Suspend Delivery check box. it cannot hold the delivery. As a result. As a result. Trading Networks will begin attempting to deliver the document. Trading Networks changes the status to PENDING. in general. As a result. Trading Networks will begin attempting to deliver the document. Trading Networks holds documents rather than attempting to deliver them. for example. As a result. Trading Networks will not attempt to deliver the documents. 9 Defining and Managing Partner Profiles Suspending Delivery for a Partner At times you might want to suspend delivery for a partner. To suspend delivery for a partner 1 Search for the profile of the partner for whom you want to suspend delivery. Trading Networks changes the status to QUEUED. 4 To suspend delivery. click in the ACTION column. When delivery is suspended for a partner. When delivery is resumed. which is in the SETTINGS panel. Trading Networks attempts to execute the services. When delivery is suspended. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. 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. When delivery is resumed for the partner. Schedule delivery Delivery tasks for the partner are assigned the HELD status. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks will not attempt to deliver the documents. 3 Click the Delivery Settings tab. Trading Networks does not attempt to execute the services. if a partner’s server is unavailable. 2 To edit the profile. When delivery is resumed for the partner.

entries. 182 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks does not delete the associated user accounts. To delete an My webMethods user account. Note: You cannot delete your own Enterprise profile. but keeps all documents. Trading Networks treats the document as an unknown document. which is in the SETTINGS panel. you must also delete all related TPAs before deleting the profile. see Administering My webMethods Server. 2 Select the check boxes beside the partner profiles that you want to delete. To resume delivery for a partner 1 Search for the profile of the partner for whom you want to resume delivery. If a partner sends you a document after you delete its profile.0 . Important! When you delete a partner’s profile. Trading Networks does not provide a way to “undelete” a profile. 3 Click the Delivery Settings tab. use this procedure to resume delivery. 3 Click Delete. click in the ACTION column.9 Defining and Managing Partner Profiles Resuming Delivery for a Partner If you previously suspended delivery for a partner. If you decide to delete a profile. Trading Networks removes most of the profile data from its database. To delete a partner profile 1 Search for the profile(s) you want to delete. clear the Suspend Delivery check box. If you need procedures for this step. 2 To edit the profile. and TPAs associated with the partner. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. 4 To resume delivery. see “Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158. To delete an Integration Server user account. You can no longer view the profile or any related TPAs. Deleting a Profile When you delete a profile from the Trading Networks Console. see Administering webMethods Integration Server. If you need procedures for this step.

9 Defining and Managing Partner Profiles

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

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 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.

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 Administering My webMethods Server. Use
the Integration Server Administrator to delete an Integration Server user account;
for more information, see Administering webMethods Integration Server.

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 183

9 Defining and Managing Partner Profiles

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

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 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.

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.

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.

184 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

9 Defining and Managing Partner Profiles

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.

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 185

9 Defining and Managing Partner Profiles

186 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

10 Defining and Managing Partner Groups

 What are Partner Groups? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
 Defining a Partner Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
 Searching for Partner Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
 Updating a Partner Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
 Deleting a Partner Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 187

10 Defining and Managing Partner Groups

What are Partner Groups?
A partner group is a logical user-defined group that you associate a partner with. For
example, you can create a group profile named “Buyers” to associate all of your partners
who are buyers in your trading network.

Defining a Partner Group
To define partner groups, perform the following procedure.

To define a partner group

1 In My webMethods: Administration > Integration > B2B > Partner Groups.
2 Click Add Partner 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 of the partners 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 157
 Advanced search, see “Performing an Advanced Search for Partner Profiles”
on page 158
 Saved search, see the Working with My webMethods guide
Trading Networks populates the AVAILABLE PARTNERS list with the results of your
search.
c Select the profiles of the partners that you want to be member of the partner
group by moving the profiles from the AVAILABLE PARTNERS list to the SELECTED
PARTNERS list.

d Click OK.
6 Click Save.

188 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

10 Defining and Managing Partner Groups

Searching for Partner Groups
The following table lists tasks related to searching for partner groups and where to find
more information about each task.

Task For more information, see...
Search for partner groups with group names “Performing a Keyword Search for
that contain keywords that you specify. Partner Groups” on page 190
Set the following search options for the Working with My webMethods guide
Administration > Integration > B2B > Partner
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 Working with My webMethods guide
Trading Networks displays search results 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. Working with My webMethods guide
Re-execute saved searches for partner profiles. Working with My webMethods guide

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 189

10 Defining and Managing Partner Groups

Performing a Keyword Search for Partner Groups
Use a keyword search to find partner groups based on their group names.

To perform a keyword search for partner groups

1 In My webMethods: Administration > Integration > B2B > Partner 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 partner
groups you want to find.
If you leave the text box blank, Trading Networks searches for all partner groups that
you are authorized to view. For more information about how to specify keywords, see
the Working with My webMethods guide.
4 Click Go to execute the search.

Updating a Partner Group
To update a partner group, perform the following procedure.

To update a partner group

1 Search for the partner group you want to update. If you need procedures for this step,
see “Searching for Partner Groups” on page 189.

2 To edit the profile of a partner, click in the EDIT column.
3 To update the partner 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 Partner
Group” on page 188.
6 To remove members from the group:
a Select the check boxes beside the members that you want to remove.
b Click Delete. Trading Networks does not delete the profile of the partner; it only
removes it from the partner group.
7 Click Save.

190 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

10 Defining and Managing Partner Groups

Deleting a Partner Group
To delete a partner group, perform the following procedure.

To delete partner groups

1 Search for the partner groups you want to delete. If you need procedures for this step,
see “Searching for Partner Groups” on page 189.
2 Select the check boxes beside the partner groups that you want to delete.
3 Click Delete.

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 191

10 Defining and Managing Partner Groups

192 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 Defining and Managing Trading Partner Agreements (TPAs)  What is a Trading Partner Agreement (TPA)? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .0 193 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196  Managing TPAs . . . . . . . . . . . . 194  Information You Supply to Define a TPA . . . . . . . . . 194  Defining a TPA .

TPA Information Description Sender Name of the trading partner that has the sender role in the TPA. Information You Supply to Define a TPA When you define a TPA. 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. a description. IS document type. Note: A TPA is an agreement between two partners in your network. and the other that fulfills the receiver role. receiver. You select the receiver from the profiles defined on your Trading Networks system. You select the sender from the profiles defined on your Trading Networks system. Receiver. Agreement ID. Trading Networks returns information about the TPAs that meet the search criteria that you specified in your query. Timestamp. first specify a query to identify the TPAs in which you are interested. data status. Receiver Name of the trading partner that has the receiver role in the TPA. services (export and initialization). Both the sender and receiver in a TPA must be a partner in your Trading Networks system that has an existing profile. For more information about TPAs. agreement ID. including your own profile (Enterprise). see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide.11 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.0 . Agreement ID An application-specific field that uniquely identifies the type of agreement between two partners. You can query TPAs by the following fields: Sender. and IS Document Type. including your own profile (Enterprise). Agreement Status. one that fulfills the sender role during document exchange. you supply the following information: sender. 194 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. To view TPAs and their data in Trading Networks. and optionally.

rec:tpaDataSchema IS document type. When using the TPA feature for your own custom application.b2b. these are the parameters that your custom applications need access to during document exchange.the TPA data can be changed  Non-modifiable . see “Changing the TPA Data Inputs in the IS Document Type” on page 204. Use the webMethods Developer to create the IS document type that contains the parameters you need for your custom application.TPA:EDITPA IS document type and the webMethods ebXML Module supplies the wm.ip. the webMethods EDI Module uses the control number to ensure documents are processed in order and that no documents have been lost or unprocessed. the webMethods EDI Module supplies the wm.ebxml. The data status can be one of the following:  Modifiable .0 195 . For example. For more information about changing the data. see Developing Integration Solutions: webMethods Developer User’s Guide. For example. For more information on how to create an IS document type. see “Changing the TPA Data Inputs in the IS Document Type” on page 204. webMethods components that use the TPA feature come with the IS document type you need to use for the TPA data. For more information about EDI TPAs. Trading Networks does not update the Control Number field. 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). Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see “Changing a TPA Agreement Status” on page 202.the TPA data cannot be changed Note: Trading Networks uses the data status only after the TPA has an Agreed status. 11 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. When using the TPA feature for your own custom application. see the webMethods EDI Module Installation and User’s Guide. Control Number A field that is available for application-specific use.cpa. For more information about TPA statuses.editn. For more information about changing the TPA data defined in the IS document type. Some webMethods’ components that take advantage of the TPA feature use the Control Number field. you can use the Control Number field in any way you want.

Specify 1-1024 characters. Defining an initialization service is optional. 196 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see the webMethods EDI Module Installation and User’s Guide. Initialization A service that sets default values for the IS document type data of Service the TPA. For more information about ebXML CPAs. After creating a TPA.cpa:initTPA initialization service. You can set this field to point to an IS service that can provide the initial values for that data. There is no restriction to the characters that you can use. When using the TPA feature for your own custom application. The webMethods ebXML Module supplies the wm. you can execute your export service. After you set the attributes of your TPA on the top portion of this screen and select the IS document type. Note: The format of the industry-standard agreement will not be the same as the format of a Trading Networks TPA. if you need to obtain the industry-standard format of a TPA.11 Defining and Managing Trading Partner Agreements (TPAs) TPA Information Description Export Service A service that exports a Trading Networks TPA and converts it to an industry-standard format. For more information about EDI TPAs. Trading Networks displays the corresponding IS document type data tree on the bottom panel of the screen. the webMethods EDI Module supplies the service wm.editn. Description This is an optional field that you can use to specify a description for the TPA.b2b.0 . you can create an initialization service that populates the parameters in the IS document type with default values. you can create an export service that converts the Trading Networks TPA to the industry-standard format that you require.ip.ebxml. For example. Defining a TPA You define TPAs on the Agreement Details screen of the Trading Networks Console. When using the TPA feature for your own custom application.TPA:initService that populates the EDITPA with the default values for an EDI TPA. Defining an export service is optional. The right side of this panel displays the input values (TPA data inputs) to variables of the IS document type. Some webMethods’ components that take advantage of the TPA feature supply an initialization service. see the webMethods ebXML Installation and User’s Guide.

2 Perform one of the following procedures to create a new TPA. For more information about how to select a sender. 11 Defining and Managing Trading Partner Agreements (TPAs) Use the following procedure to define a TPA. 3 Fill in the following fields on the Agreement Details screen for the TPA you want to create: Note: The Sender. Method to create a TPA Procedures New—The TPA fields are empty. This list includes your own profile (Enterprise). For this TPA field.. To define a TPA 1 In Trading Networks Console: View > Agreements. and then agreements that you duplicate. Trading Networks You can update any or all fields displays the Agreement Details screen. For EDI. Select Agreements > New. You can use this function to create a template TPA. Receiver. Trading Networks displays the Agreement Details screen to allow you to fill in the information for the TPA.. Trading Networks displays the Agreements screen. Type in the name of the sender or click the Select button to select the sender from the Partner Selection Dialog. select Agreements > Duplicate. see “Selecting TN Document Types” on page 33. Specify Sender Name of the trading partner that has the sender role in the transaction the TPA will govern. After you create a TPA. you can use the default value of Unknown.0 197 . Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. and Agreement ID fields must be unique for each TPA. from the duplicated TPA agreement. to create a template that you will duplicate to create other TPAs. you cannot change or update these fields of the TPA. Duplicate—The TPA fields are Click the row containing the name of the TPA filled with values from the TPA agreement that you want to duplicate.

If you want to change the data input for the IS document type. For more information about the agreement ID. see “Changing the TPA Data Inputs in the IS Document Type” on page 204.11 Defining and Managing Trading Partner Agreements (TPAs) For this TPA field. The value for this field must be an integer.0 . You can use up to 254 characters of any type for this field. including spaces. to create a template that you will duplicate to create other TPAs. you can: create the TPA or continue to supply data for the remaining fields. see “Information You Supply to Define a TPA” on page 194. After you supply the Agreement ID. Receiver. 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.. The TPA data is used to govern the exchange of documents between the two partners. Agreement ID An identifier that indicates the type of agreement between the two partners. This list includes your own profile (Enterprise). see “Selecting TN Document Types” on page 33. For more information about the IS document type. The value you specify depends on the application that is going to use the TPA. 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. For EDI. Specify Receiver Name of the trading partner that has the receiver role in the transaction the TPA will govern. IS Document Type The IS document type that defines the application-specific TPA data. Control Number A value that the application using the TPA expects. The Sender. 198 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. you can use the default value of Unknown. Trading Networks displays the data tree input values of the selected IS document type in the bottom panel of the Agreement Details screen. see “Information You Supply to Define a TPA” on page 194. 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 how to select a receiver.. This value is only needed if the application using the TPA uses the Control Number field. The default value is zero (0).

Initialization A service to populate the inputs to the variables in the IS Service document type for the TPA with default values.tn..editn. For more information about exporting Trading Networks data to another Trading Networks system. see “Changing a TPA Agreement Status” on page 202. see “Information You Supply to Define a TPA” on page 194. For more information about statuses. you should manually complete each parameter field in the Input for ‘wm.. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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. Specify Data Status Whether you want to be able to modify the values of the TPA data of the IS document type. Instead. Note: The Export Service is different from the Trading Networks File > Export function that exports Trading Networks data (such as profiles. Note: If you create a partner-defined EDITPA from scratch. For more information about the initialization service. you should not use the wm. This is optional. see the webMethods EDI Module Installation and User’s Guide.edi. so data can be exported/imported within the same Trading Networks release from development to production environment. For more information about EDI TPAs. 11 Defining and Managing Trading Partner Agreements (TPAs) For this TPA field. see “Information You Supply to Define a TPA” on page 194. which is already tailored to a user’s particular requirements.0 199 . “Exporting and Importing Database Information”. The data status is only applicable when the agreement status is Agreed.TPA:initService initialization service because it populates the partner-defined EDITPA with hard- coded values other than those in the default EDITPA. TN document types) out of the Trading Networks database.b2b. 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.b2b.TPA:EDITPA’ screen in the Trading Networks Console. For more information about the export service. Export Service A service to convert the data in the Trading Networks TPA to an industry-format trading partner agreement. see Appendix C.

. as well as the other TPA fields. There is no restriction to the characters that you can use. Receiver. double click on the row containing the TPA you want more detailed information about. Managing TPAs The following table describes the tasks you can perform against TPAs: Task See Page. you can use the search criteria on the Agreements screen to query for specific TPAs. Specify Description Optionally. Receiver.11 Defining and Managing Trading Partner Agreements (TPAs) For this TPA field. “Finding and Viewing TPAs” 200 “Updating TPAs” 202 “Changing a TPA Agreement Status” 202 “Changing the TPA Data Inputs in the IS Document Type” 204 “Deleting a TPA” 206 Finding and Viewing TPAs You can use the Agreements screen to find and view TPAs that you have defined. Receiver. Note: Trading Networks disables the OK button until you supply the Sender.. You will not be able to save the TPA unless you supply the Sender. Trading Networks displays the Agreements Details screen. 2 To see detailed information about a specific TPA. Specify 1-1024 characters. and Agreement ID fields.. 4 Click OK to create the TPA.0 . 200 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. If you clear any of the Sender. and Agreement ID fields during the creation of the TPA. specify a description for the TPA in the Description field. a Select Show Query on the toolbar to have Trading Networks display the search criteria. Trading Networks will disable the OK button. 3 If you cannot find the TPA you are looking for. To view TPAs 1 In Trading Networks Console: View > Agreements. and Agreement ID fields..

“%”. Type 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. Do not use pattern-matching characters (such as “*”. Type in the name of the sender or click the Select button to select the sender from the Partner Selection Dialog. Timestamp The time Trading Networks last updated the TPA either when the TPA was created or last updated. IS Document The IS document type for the TPA data you want to use. select Custom from the list. Then fill out the corresponding information as follows. For more information about statuses. see “Selecting TN Document Types” on page 33. and Agreement ID fields must be unique for each TPA. Note: The Sender. Agreement ID The Agreement ID of the TPA that you want to view. or click Select Date to open a dialog that allows you to select the date from a calendar. Receiver The name of the trading partner that has the receiver role for the TPA. select the check box next to each criterion you want to use. Agreement The status of the agreement that you want to view: Proposed.0 201 . be sure to use the exact combination of upper. see “Selecting TN Document Types” on page 33. Receiver. or Agreed. For more information about the Select button. see “Information You Supply to Define a TPA” on page 194.and lowercase letters. 11 Defining and Managing Trading Partner Agreements (TPAs) b To indicate that you want to use one or more of the search criteria. To specify a date range. Type in the name of the receiver or click the Select button to select the receiver from the Partner Selection Dialog. Important! The search-criteria fields are space and character-sensitive. For this TPA Attribute… Specify… Sender The name of the trading partner that has the sender role for the TPA. Status Disabled. For more information about the Select button. You can type in a date value. or “_”) in the TPA search. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Select an entry from the list. For more information about the TPA attribute fields. Then specify dates in the Beginning and Ending fields. see “Changing a TPA Agreement Status” on page 202.

3 Update the TPA fields you want to change:  For information on what you can specify for the fields in the Agreement Details screen.11 Defining and Managing Trading Partner Agreements (TPAs) c Select Run Query on the toolbar.0 . see step 3 on page 197. 2 Select Agreements > Edit. as well as to speed up processing.  For more information about the tabs and fields on this screen. 4 For instructions on how to update the inputs for the IS document type. or whether the TPA is inactive (Disabled status). final (Agreed status). Trading Networks displays the Agreement Details screen. Trading Networks updates the Agreements table on the bottom portion of the screen with the query results. the agreement status. data values in the IS document type. If you need procedures for this step. Receiver. d Double click to select the partner you want from query results in the Profiles table on the bottom portion of the screen. Initially. see “Updating TPAs” on page 202. Important! You cannot modify or update the Sender. You can change the agreement status of the TPA to any other agreement status. For a production setting. “Changing a TPA Agreement Status”. when you are creating the TPA. see “Finding and Viewing TPAs” on page 200. and to delete the agreement.  For instructions on how to change the Agreement Status. To update a TPA 1 Select the TPA you want to update. Updating TPAs Use the following procedure to update a TPA. see “Changing the TPA Data Inputs in the IS Document Type” on page 204. see “Defining a TPA” on page 196. 202 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see the next section. or Agreement ID field of a TPA. Changing a TPA Agreement Status The agreement status determines whether the TPA is a draft (Proposed status).  For procedures on how to change the information in your partner’s profile. assign the TPA the Proposed status so that you can make modifications to the TPA fields. select the Agreed status to prevent the accidental deletion of the TPA.

If the Data Status is:  Modifiable.  Non-modifiable. For more information. in a transaction between two partners (e. the agreement status of the TPA might change depending upon business conditions. see “Deleting a TPA” on page 206. you must change the agreement status to Proposed or Disabled. The following table explains what each status is and the changes you can make to the Agreement Status. you must change the agreement status from Agreed to Proposed. If Partner A is delinquent on payments to Partner B. When the TPA is in the Agreed status. Partner B would change the agreement status to Agreed. Proposed you can delete it. Receiver. The TPA is in final status. with the exception of the Sender. or Agreement ID fields. What you can change:  The TPA fields. For more information. see “Changing the TPA Data Inputs in the IS Document Type” on page 204. you can change:  The Control Number Note: To modify the data of the TPA. After Partner A pays his payments. see “Changing the TPA Data Inputs in the IS Document Type” on page 204. For more information. For example. To delete a TPA. Partner A and Partner B) who sell products to one another. however.g. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 11 Defining and Managing Trading Partner Agreements (TPAs) Select the Disabled status when you no longer want Trading Networks to use a specific TPA.0 203 . then Partner B might change Partner A’s agreement status to Disabled .. you Agreed cannot delete it.  The agreement status to Disabled or Agreed.so that no further transactions could occur. For more information.  All inputs to TPA data variables in the IS document type. see “Deleting a TPA” on page 206. you can change:  The Control Number  All inputs to TPA data variables in the IS document type. see “Changing the TPA Data Inputs in the IS Document Type” on page 204. For more information. When the TPA is in the Proposed status. Agreement Status Meaning The TPA is in draft status.

 Set Inputs for IS Document Type. For more information.  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. Trading Networks displays the new status in the Agreement Status column. see “Deleting a TPA” on page 206. Changing the TPA Data Inputs in the IS Document Type The TPA data inputs are the inputs to variables of the IS document type. 204 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. You can delete a disabled TPA. or Agreed. Disabled. Use this method to supply the values you want the TPA data inputs to have. What you can change:  The Control Number Note: To modify the data of a TPA. Disabled. 2 Click the row containing the TPA you want to change the agreement status for.0 . 3 To change the agreement status:  Press the appropriate status change button: Proposed.11 Defining and Managing Trading Partner Agreements (TPAs) Agreement Status Meaning The TPA should not be used. or Agreed -OR-  Right-click and select from the menu items: Proposed. you must change agreement status from Disabled to Proposed. To change a TPA agreement status 1 In Trading Networks Console: View > Agreements. 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. see “Changing the TPA Data Inputs in the IS Document Type” on page 204 Use the following procedure to change a TPA agreement status. For Disabled more information. Trading Networks displays the Agreements screen.

If this field is emptied. see “Finding and Viewing TPAs” on page 200.. 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. see “Changing a TPA Agreement Status” on page 202. For more information about changing IS Document Types. you will lose any changes that you have made to the IS document type.. If you need procedures for this step. To change the data input in the following manner. see Developing Integration Solutions: webMethods Developer User’s Guide. For more information.. 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. 11 Defining and Managing Trading Partner Agreements (TPAs) Use the following procedure to change the inputs for the IS document type. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.. If you choose to reset these values. 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. 3 Click OK to save your changes. Note: The Reset to Initialization Service button is only enabled when an initialization service is supplied.0 205 . Change the values in the IS document type through the Set Inputs Input for <IS Document Type> dialog. When you click this icon. Trading Networks disables the Reset to Initialization Service button. You can modify the data values and then save them by selecting OK. the dialog displays the parameters of the IS document type with the corresponding TPA data values automatically filled in. Click this IS document type data input button. To change the data inputs in the IS document type 1 Select the TPA you want to update.

You cannot delete TPAs with an Agreed status. If you need procedures for this step. To delete a TPA. Before you delete a profile that is referenced by a TPA.11 Defining and Managing Trading Partner Agreements (TPAs) Deleting a TPA When you delete a TPA. Important! Trading Networks does not provide a way to “undelete” the TPA. see “Deleting a Profile” on page 182. you will need to first change the agreement status to either Proposed or Disabled. click Yes. you will need to use the wm.tpa:deleteTPA service.0 . For more information. 206 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. you must first delete any related TPAs. For more information. You can only delete TPAs with the Proposed or Disabled agreement status. see the webMethods Trading Networks Built-In Services Reference guide. If you want to delete a TPA with an Agreed status. and then Trading Networks allows you to delete the TPA. you can delete the invalid TPA. When Trading Networks prompts you to verify that you want to delete the TPA. Note: If you are deleting a non-modifiable agreement. Trading Networks deletes all of the TPA data from its database.tn. perform the following procedure: To delete a TPA 1 Select the TPA you want to delete. If you accidentally deleted the profile and not the TPA. 2 Select Agreements > Delete to delete the TPA. see “Finding and Viewing TPAs” on page 200.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .III Defining Transaction Processing  Defining and Managing Document Attributes . . 281  Defining and Managing Processing Rules . . . . . . . . . . . 317 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . 209  Defining and Managing TN XML Document Types . . . . .0 207 . 219  Defining and Managing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

0 .III Defining Transaction Processing 208 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

. . 212  Managing Document Attributes . . . . . .0 209 . . . . . . . .12 Defining and Managing Document Attributes  What are Document Attributes? . . . . . . . . . . . . . . . . . . . . . . . . . 210  Defining Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

when you define your TN document types. that identify characteristics of the documents. and you cannot delete them. if you want to extract the purchase order number from documents. you can specify whether Trading Networks should save the attribute to the database (the default behavior). To define a document attribute you specify the attribute’s name. For example. see “Important Attributes that You Should Extract from an XML Document” on page 226 or “Attributes To Extract From Documents” on page 293. NUMBER. or STRINGLIST). You should define custom document attributes for all types of documents that you expect to receive. 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. 210 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. and data type (DATETIME. You do not need to define them. DATETIME LIST. which identify specific pieces of information that you want to extract from the documents that your trading network will receive. known as system attributes. “Defining and Managing TN XML Document Types” and Chapter 14. In addition. “Defining and Managing TN Flat File Document Types”. a document attribute is not associated with a specific document type. STRING. you will specify which document attributes to include in each document type. Instructions for creating document types appear in Chapter 13.0 .  Predefined attributes. description.12 Defining and Managing Document Attributes What are Document Attributes? There are two kinds of document attributes:  Custom attributes. Later. you might define a document attribute named PO_Number. System attributes are available out of the box. NUMBER LIST.

Description = Purchase Order Number TN Document Type Name = cXML PO Document #2 Document #3 TN Document . you identify the attributes that you want Trading Networks to extract from the type of document. Trading Networks saves a custom attribute only if the TN document type or processing rule indicates to save that attribute. Name = PO_Number . you can indicate whether you require the attribute to be extracted. . Attributes PO_Number Document Attribute . Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 12 Defining and Managing Document Attributes Document Attributes and How They Relate to TN document types The definition of a Document #1 TN Document document attribute <!-. In addition.OAG --> Type The definition of a TN specifies the name. you specify the name of the attribute and how Trading Networks is to locate the attribute in the specific type of document. you can specify that you want Trading Networks to save the document to the database. Name = OAG PO document type specifies and description for a . Different kinds of documents have different formats. Trading Networks always saves all system attributes except Signature and SignedBody. . . you can query documents where the total order amount is over $10. If you do this. When you define a TN document type. how to locate the document attribute. . Trading Networks records the error. Attributes <Reference> . . </Reference> . .cXML --> <!-. if you use an attribute that retrieves the total order amount of a purchase order. attributes in the specific type of document.CBL --> Type . Trading Networks saves the custom attributes it extracts. 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. To identify the attributes. Note: Regardless of whether you save custom attributes or not. so the location of attributes within a document is based on the specific kind of document. PO_Number <RefNum> . For example. orderID = P01234> <BuyerRefNum> . In the TN document type (or in a processing rule).  Generate reports about documents in your Trading Network. <POID>A230</POID> . Type = Number .000. <!-. </BuyerRefNum> . </RefNum> PO_Number . If you mark an attribute as required and Trading Networks is unable to extract the attribute from the document. type.0 211 . <OrderRequestHeader Name = CBL PO . 100 Attributes .

Click Duplicate. 4 Fill in the following fields for the custom attribute you want to add: 212 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.12 Defining and Managing Document Attributes For more information about document attributes. Defining Document Attributes Use the following procedure to define document attributes. The New Document Attribute screen appears. 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. To define a document attribute 1 In Trading Networks Console: View > Document Types. A copy of the document You can update any or all 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. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. see information about My webMethods user preferences in Managing B2B Integrations: webMethods Trading Networks User’s Guide. 3 Perform one of the following procedures to begin a document attribute definition. Click New (yellow highlight). Note: If new attributes are created while you have an open My webMethods session. 2 Select Types > Document Attributes. Method to begin a definition Procedure New—The document attribute fields are empty. fields from the duplicated document attribute.0 . For more information about how to refresh your My webMethods cache.

Specify Name The name you want to give to the attribute. or STRINGLIST) from the list. Deselect this check box if the attribute value is needed during document processing. STRING. 5 Click OK to add the document attribute. Example: If you are defining an attribute for the price of an item in a purchase order. You can use any character except a single quote ('). select this check box to enable it. If the document attribute is disabled. Description Optional. NUMBER. Select the data type (DATETIME. You can specify 1 to 256 characters. A description of the attribute. Type The data type of the attribute.0 213 .. see “Enabling Document Attributes” on page 216 or “Disabling Document Attributes” on page 215. Trading Networks saves this attribute to the database. Trading Networks does not save this attribute. you might use the name “LineItemPrice”.  If you do not select this check box and the pre-processing actions indicate to save attributes to the database. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Enabled Whether this attribute is enabled or not.  If you select this check box and the pre-processing actions indicate to save attributes to the database. 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. NUMBER LIST. Save Whether this attribute is eligible to be saved to the Trading Networks database. DATETIME LIST. but does not need to be kept in the database. 12 Defining and Managing Document Attributes For this parameter. you might specify the description “The price of an item in a purchase order”.. You can specify 1 to 64 characters. For more information.

“Viewing Document Attributes” 214 “Updating Document Attributes” 215 “Disabling Document Attributes” 215 “Enabling Document Attributes” 216 “Determining the TN Document Types that Use an Attribute” 216 Viewing Document Attributes You can view document attributes using the Document Attributes screen. 3 To see the details about a specific document attribute. 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. Trading Networks does not display disabled document attributes.12 Defining and Managing Document Attributes Managing Document Attributes The following table describes the tasks you can perform against document attributes: Task See Page. you can update the display of attributes to include disabled document attributes. 214 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.. then perform the following additional step. 2 Select Types > Document Attributes. double click the row for that attribute. Displaying Disabled Document Attributes To display disabled document attributes. However. To view document attributes 1 In Trading Networks Console: View > Document Types. perform Steps 1 through 4 in the procedure “Viewing Document Attributes” that is described above.0 . By default..

You can use the attribute as search criteria when displaying documents in My webMethods or in the Trading Networks Console. if you decide that you need the document attribute. it does not allow you to select a disabled attribute as an item to be extracted. See “Enabling Document Attributes” on page 216. Trading Networks prevents you from specifying the document attribute when creating new or updating existing TN document types. that is. Later. see step 4 on page 212. 12 Defining and Managing Document Attributes Hiding Disabled Document Attributes If disabled document attributes are currently being displayed on the Document Attributes screen. Trading Networks no longer displays the value of the attribute in the details for a transaction. you can enable it. the definition for the document attribute is not removed from the database. Updating Document Attributes To update a document attribute 1 In Trading Networks Console: View > Document Types. 4 Right click and select Edit. 3 Click the row containing the document attribute that you want to update. 5 Update the fields you want to change. Trading Networks will continue to extract the document attribute information for existing TN document types that reference this attribute. When you disable a document attribute. however. When you disable a document attribute. perform the following step to hide them.0 215 . Disabling Document Attributes If you no longer want to use a document attribute. 6 Click OK to save your changes. you can disable it. For information on what you can specify. 2 Select Types > Document Attributes. Trading Networks does not display any disabled (darkened light bulbs) items. click Show Enabled to only show enabled (yellow light bulbs) items. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. To hide disabled document attributes To hide disabled document attributes.

2 Select Types > Document Attributes. 3 Click the row containing the document attribute you want to enable. To disable a document attribute 1 In Trading Networks Console: View > Document Types. if you want to disable a document attribute but first want to determine the TN document types that this action will affect. 4 Right click and select Enable. 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 214. 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. 4 Right click and select Disable. for example. Trading Networks places Yes in the Enabled column to indicate that the document attribute is enabled. That is. Trading Networks places No in the Enabled column to indicate that the document attribute is disabled.0 . To enable document attributes 1 In Trading Networks Console: View > Document Types. Enabling Document Attributes If you disable a document attribute and then later determine that you still need it. your database administrator must remove it. 2 Select Types > Document Attributes. you must also remove all TN document types that reference this attribute and all documents that had this attribute extracted from them. When you remove a document attribute from the database. Determining the TN Document Types that Use an Attribute You can determine the TN document types that are dependent on a custom attribute. 3 Click the row containing the document attribute you want to disable.12 Defining and Managing Document Attributes Note: To permanently remove the document attribute from the database. This is helpful. 216 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

12 Defining and Managing Document Attributes 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.0 217 . 4 Click Show document type dependencies. 3 Click the row containing the document attribute for which you want to view TN document type dependencies. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

12 Defining and Managing Document Attributes 218 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222  Extraction Information In TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247  Managing TN XML Document Types . . . . . . . .13 Defining and Managing TN XML Document Types  What Are TN XML Document Types? . . . . . .0 219 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267  Submitting XML Documents to Trading Networks . . . . . . . . . . . . . . . . . . 240  Defining TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . 236  Options in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220  Identification Information in TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . . . . . . 226  Namespace Mappings in TN XML Document Types .

The nodes must be present for Trading Networks to consider the TN XML document type a match. Namespaces are used in an XML document to distinguish between elements that come from different sources. When you define the identification information for a TN XML document type.  Extraction information.  Identifying queries.org/. When you define namespace mappings in a TN XML document type. For more information. You define XQL queries that Trading Networks uses to locate the attributes within the XML documents. For Trading Networks to extract a value. Trading Networks uses the namespace mappings you specify when applying XQL queries against the XML document. For more information.w3. If the XML documents use namespaces. see “Identification Information in TN XML Document Types” on page 222. Trading Networks uses the namespace mappings 220 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 . Specifies the attributes (system attributes and custom attributes) that you want Trading Networks to extract from XML documents. you specify the following types of information:  Identification information. you can specify the value the node must have. Namespace mappings map the prefixes used by namespaces to the URIs used by those namespaces.13 Defining and Managing TN XML Document Types What Are TN XML Document Types? TN XML document types define how Trading Networks recognizes XML documents. Optionally. Optionally. you can specify the value the pipeline variables must have. Trading Networks checks XML documents against the identification information to determine whether the document matches a defined TN XML document type. Each namespace is associated with a URI. where to locate attributes within an XML document. which is used to uniquely identify the namespace. A set of elements (or tags) from a specific source is assigned to a specific namespace. The pipeline variables that you specify must exist for Trading Networks to consider the TN XML document type a match. For example. see “Extraction Information In TN XML Document Types” on page 226. you can specify one or more of the following:  Root tag that the XML document must have to match the TN XML document type. That is. For more information about XML namespaces. in the extraction information. and how to pre-process the XML documents. you should specify namespace mappings to describe the namespaces that XML documents might use. you might want Trading Networks to transform a STRING value into all uppercase characters.  Namespace mappings. see the XML Namespace specification at http://www. which are XQL queries that Trading Networks performs against the XML document to locate specific nodes in the XML document. Optionally. the node that the XQL query identifies must exist in the XML document. 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.  Pipeline variables that must be present when Trading Networks is determining the TN XML document type to use. To define TN XML document types.

nor does it perform any processing rule actions. For more information.tn.  Whether you want Trading Networks to process a document using a processing rule or want to prevent Trading Networks from performing processing rule actions.doc. Note: You specify pre-processing actions in both TN document types and processing rules. When you disable processing rule routing. 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 rule actions. For more information. for example. For more information.  An IS schema that defines the structure of the XML document. it does not search for a processing rule. For more information about processing large document types. If processing rule routing is enabled. For more information. see “Specifying an IS Schema for TN XML Document Types” on page 241. Pre-Processing actions are actions that Trading Networks performs before using the processing rule actions to process the 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.  Whether you want Trading Networks to perform any or all of the pre-processing actions.0 221 . Trading Networks has access to the pre-processing actions specified in a processing rule. however. “Large Document Handling”. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see “Disabling Processing Rule Routing” on page 242. You can use the options to define items for later processing. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 242. Trading Networks performs the pre-processing actions defined by the TN document type. For more information. see “Specifying an IS Document Type for TN XML Document Types” on page 241. 13 Defining and Managing TN XML Document Types for both the identifying XQL queries and the XQL queries to extract attributes. You might want to disable use of a processing rule.  Options. Trading Networks uses the IS document type if you invoke the wm. see “Namespace Mappings in TN XML Document Types” on page 236. 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.xml:bizdocToRecord service to convert the document content in the BizDocEnvelope to an IData object. The pre-processing actions in a processing rule indicate whether Trading Networks is to use the settings from the TN document type or to override the TN document type settings. see Appendix F. When specifying the options for an XML document.

see “Namespace Mappings in TN XML Document Types” on page 236. You can define TN XML document types to be very general or very specific.0 . specify one or more of the following items described in the table below: 222 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For more information. you can set up the TN XML document type to recognize OAG PROCESS_PO_004 documents. you can set up a TN XML document type that simply recognizes OAG documents. Trading Networks cannot determine which of the matching TN document types it should use.13 Defining and Managing TN XML Document Types 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.  The value of the root tag within a document  The system identifier or public identifier from the document type (DOCTYPE) declaration within an XML document. You 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 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. you must also define namespace mappings for Trading Networks to correctly locate the nodes identified by the XQL queries. 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 511. To be more specific. To set up the identification information in a TN XML document type.  Pipeline matching variables (name and value). Trading Networks uses the extraction information and the options (which are specified in the TN XML document type) only if the document meets the criteria specified by the identification information. Trading Networks matches documents against all enabled TN document types. For example. If a document matches more than one. To be even more specific. Each document that passes through your system should match exactly one TN document type.

13 Defining and Managing TN XML Document Types

Item Description
Identifying You can specify one or more XQL queries that locate a specific node in
queries 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, XYZ 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>XYZ Steel Company</Identity>
.
.
.

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 “XYZ Steel Company” and the actual value
in the document is “XyZ Steel COmpany”, the values will not
match and the TN XML document type will not be used.

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 223

13 Defining and Managing TN XML Document Types

Item Description
 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 236.

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

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">

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.

224 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

13 Defining and Managing TN XML Document Types

Determining the TN Document Type to Use for an XML Document
To determine the TN document type to use for an XML document, 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
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”.

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 225

13 Defining and Managing TN XML Document Types

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

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 322.
 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
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 BPM 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

226 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

13 Defining and Managing TN XML Document Types

processing rule to use for a document. For more information, see “Processing Rule
Criteria” on page 322. 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 242.
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.

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

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 227

13 Defining and Managing TN XML Document Types

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 236.
 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 505.

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

228 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

13 Defining and Managing TN XML Document Types

 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 334. For more information
about the Execute an Integration Server processing actions, see “Action 1—Execute a
Service” on page 334.

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 230
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 231
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 231

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 229

13 Defining and Managing TN XML Document Types

Attribute Transformation For more information, see...
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 233
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 to “Specifying a Custom
transform attributes. Transformation Service”
on page 234

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

230 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

13 Defining and Managing TN XML Document Types

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.

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.

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 231

13 Defining and Managing TN XML Document Types

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

232 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0

For example. specified if the array contains the numbers [2. you can write a custom attribute transformation. Trading Networks stores the value 2. 5]. if the NUMBER or NUMBER LIST contains the value “100zzz”.lang. 3. Trading Networks stores the value 14. 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. 4.Number. 5]. For example. 4. When the XQL query for an attribute identifies an array of numbers. 3. 5]. and specify the format SUM. Trading Networks stores the value 3. Trading Networks stores the value 2. Sum The sum of all the numbers in the array. 5]. For more information about custom transformations. To store the total number of items ordered in the attribute TotalItems. For example. The following sample CBL document shows two line items and the quantity to purchase of each. 3. For example. Maximum The largest number in the array. 3. if the array contains the numbers [2. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 233 . 3. 13 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.5. if the array contains the numbers [2. it uses the number parsing behavior of java. For example. if the array contains the numbers [2. Note: When Trading Networks extracts a NUMBER or NUMBER LIST from a document. if the array contains the numbers [2. Trading Networks interprets the value as “100”. instead of throwing an error as it would if the value were “zzz100”. No format The first value of the array as the value of the attribute. “Specifying a Custom Transformation Service”. If you want to redefine this parsing behavior. specify an XQL query that specifies an array of numbers that contains the quantity of each line item. see below. 5]. For example. 4. Minimum The smallest number in the array. 4. 4. Trading Networks stores the value 5.

. This element of the query indicates to . . <Quantity> <Qty>5</Qty> </Quantity> . <OrderDetail> tags. . . Trading Networks uses the <BaseItemDetail> SUM format and stores the value <LineItemNum>2</LineItemNum> 15 for the TotalItems attribute. <Quantity> <Qty>10</Qty> </Quantity> .0 . <BaseItemDetail> </OrderDetail> <ListOfOrderDetail> . . </PurchaseOrder> Specifying a Custom Transformation Service Trading Networks allows you to create your own service to perform transformations on extracted attributes. . 234 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . select all occurrences of . . <ListOfOrderDetail> <OrderDetail> <BaseItemDetail> <LineItemNum>1</LineItemNum> . The following table describes the specification you should use to create the custom transformation service based on the data type. <BaseItemDetail> </OrderDetail> The XQL query points to these <OrderDetail> tags.13 Defining and Managing TN XML Document Types XQL Query for TotalItems = /PurchaseOrder[0]/ListOfOrderDetail[0]/OrderDetail[]/BaseItemDetail[0]/Quantity[0]/Qty[0] <PurchaseOrder> . . .

Trading Networks passes the following input variables: Input Value Meaning values One or more values for your service to transform. The specifications are located in the WmTN package.rec:DateAttributeTransformService specification. see the section “Setting Input and Output Values for Custom Transformation Services” below.. To view these specifications.rec:NumberAttributeTransformService specification. For more information about these specifications. isArray Whether values contains a single value to transform or multiple values to transform. NUMBER or The service must implement the input and output variables that are NUMBER LIST defined in the wm.g.rec:StringAttributeTransformService specification. see the webMethods Trading Networks Built-In Services Reference. Make sure that your custom transformation service can handle null values or empty strings. use webMethods Developer.tn. Setting Input and Output Values for Custom Transformation Services For custom transformation services. 13 Defining and Managing TN XML Document Types Data type Specification you must use… DATETIME or The service must implement the input and output variables that are DATETIME LIST defined in the wm. Note: The values may be null or an empty (zero length) string. For an array data type (e.tn.tn. any element in the values array can be null or an empty string. DATETIME LIST). arg Optional arguments that you can define Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. STRING or The service must implement the input and output variables that are STRING LIST defined in the wm. For more information about the inputs and outputs.0 235 .

a document might contain elements that are part of a standard and also custom elements. For example. your service should loop through the items in the values variable and transform each one. A set of elements (or tags) from a specific source is assigned to a specific namespace.0 . Namespace Mappings in TN XML Document Types If you receive XML documents that use namespaces. For information about creating the service. To distinguish between the standard elements and the custom elements. It should store each as an item in the output variable newValues.13 Defining and Managing TN XML Document Types As output. how namespaces affect XQL queries against XML documents. what namespace mappings are. 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. the XML document might contain a namespace for the standard elements and another for the custom elements. you might want to include namespace mappings in your TN XML document types. If the input variable isArray is true. This section provides information about namespaces. Your service should transform the single item and save just a single item in the output variable newValues. the input variable values will contain only a single item to transform. XML Documents and Namespaces Namespaces are used in an XML document to distinguish between elements that come from different sources. For example. and how to set up namespace mappings. If the input variable isArray is false. newValues is a Date List of the transformed Strings. meaning multiple values. if you are transforming string data. seeDeveloping Integration Solutions: webMethods Developer User’s Guide. 236 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

this string is used as a prefix when naming the elements in that namespace. which defines a namespace. Elements are considered to be in the same namespace if they are all associated with the same URI.0 237 . the element is represented in the XML document as <standard:quantity>. 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. The xmlns attribute specifies the URI for a namespace and optionally. The exception for naming elements in a namespace with a prefix is when the elements belong to the default namespace.standards.org" xmlns:custom="http://www. For example. Note that the URI does not have to point to anything. When an XML document uses a default namespace. It is used to uniquely identify the namespace. which allows you to easily identify the elements that belong to a specific namespace.standards. The documents with a default namespace contain an xmlns attribute that specifies only the URI for a namespace. When a namespace is associated with a string. Smith</custom:contact> elements <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.unitedsteel. Each namespace is associated with a URI.org” Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. a prefix associated with that namespace. 13 Defining and Managing TN XML Document Types <order xmlns:standard="http://www.com/orderDocs"> The namespace is associated with a URI that uniquely identifies the namespace <standard:buyer> <standard:DUNS>987654321</standard:DUNS> The namespace is associated with a string that is used as a prefix in the names of <standard:company>SMK Products</standard:company> <custom:contact>Mr. for example: xmlns=“http://www. the elements in the default namespace do not use a prefix. if a document contains a namespace that is associated with the prefix string standard and the quantity element is in the standard namespace.

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

0 239 .standards. the following XQL query will locate the "buyer" element in either of the following documents. With the namespace mapping.standards. 13 Defining and Managing TN XML Document Types Prefix URI standard http://www.standard.standard. you can define them manually. a TN XML document type definition can use the XQL query /Order[0]/standard:buyer.org/ CBL_standard http://www. 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. Smith</custom:contact> <custom:customerNum>01031995</custom:customerNum> </standard:buyer> </order> <order xmlns:CBL_standard="http://www.org" xmlns:custom="http://www.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.unitedsteel. the identifying XQL queries and the XQL queries that locate document attributes will fail. To define namespace mappings.unitedsteel. XQL query = /order[0]/standard:buyer <order xmlns:standard="http://www. if the TN XML document types use identifying queries. Trading Networks will not match the document to the TN XML document type.org" The XQL query points to this xmlns:custom="http://www. If the TN XML document type specifies XQL queries to locate and extract attribute information. If you do not define namespace mappings. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. those queries will fail and Trading Networks will not extract the attribute information. 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.com/orderDocs"> element in this document <CBL_standard:buyer> <CBL_standard:DUNS>987654321</CBL_standard:DUNS> <CBL_standard:company>SMK Products</CBL_standard:company> <custom:contact>Mr. or if you are using a sample document. As a result. and Trading Networks will make the proper substitution for a document that uses the CBL_standard prefix rather than the standard prefix.org/ With this namespace mapping.

com for the prefix.xx.. it uses the options you specify ..xx.yy.xx. it performs a literal match of the XQL queries against the document.com ddd http://www.zz. To. 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. Use this option. 240 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 . use the literal string prefix0 prefix0 http://www.. Note: Because Trading Networks uses the literal prefix0 to identify the default namespace. aaa http://www.com ccc http://www.yy. 13 Defining and Managing TN XML Document Types When defining namespace mappings. You can define more than one aaa http://www.com ccc http://www. 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. If Trading Networks receives a document that uses a prefix not defined in the namespace mappings table.com prefix to the same URI. you should not use prefix0 as the prefix in any document.ww. Trading Networks uses the IS schema to validate documents. Additionally.com bbb http://www. bbb http://www.xx. Options in TN XML Document Types When Trading Networks matches a document to a TN XML document type.com ddd http://www.com The URIs you list in the namespace mappings table do not have to be Prefix URI unique.. be sure to include a mapping for each prefix/URI combination that you expect to receive in XML documents from your trading partners.xx.com To define a mapping for the default namespace (which does not use a Prefix URI prefix).

If you do not know the fully-qualified name. You identify the IS document type by specifying its fully-qualified name. Specify an IS document type if you plan to execute the wm. To. Trading Networks performs the pre-processing actions defined by the TN document type. the Document Types screen allows you to browse IS schemas to locate the one you want to use.xml:bizdocToRecord built-in service. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. You identify the IS schema by specifying its fully-qualified name. attributes.. 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. determine whether Trading Networks has already received the document.  Save a copy of the document content.  Check for duplicate document using built-in or custom services. and/or log information to the database. 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..doc. This service transforms an XML document into an IS document (IData object) based on the blueprint defined by the specified IS document type.0 241 . for example. You can select one or more of the following preferences:  Verify the digital signature of a document. You might disable routing. 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. 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. For more information about the wm. see the webMethods Trading Networks Built-In Services Reference. however. that is.. 13 Defining and Managing TN XML Document Types Use this option.tn. it does not search for a processing rule. nor does it perform any processing rule actions.doc.xml:bizdocToRecord built-in service against the document. The Document Types screen allows you to browse IS document types to locate the one you want to use. if you extract a conversation ID and the document will be processed as part of a business process.tn..  Validate the structure of a document using the IS schema that you specified for the Schema to validate against option. If you disable routing.

 When processing rule routing is disabled. however. nor does it perform any processing rule actions. it does not search for a processing rule. which in turn will determine the process model to use to process the document. You specify pre-processing actions in both TN document types and processing rules. 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. Trading Networks matches the certificate from the digital signature to the certificate that Trading Networks has in the Trading Networks database. Trading Networks performs the pre-processing actions in the following order.  When processing rule routing is enabled. If you do not want Trading Networks to perform processing rule actions. Trading Networks will pass the document to the Process Engine. To verify that the sender is who it claims to be. You might want to disable processing if the document is to be processed as part of a business process. disabling routing improves performance because Trading Networks does not use processing time to search for a processing rule. 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.13 Defining and Managing TN XML Document Types Specify an IS schema if you want Trading Networks to be able to validate the structure of an XML document. To use this pre-processing action. Even when processing rule routing is disabled. “Specifying Pre-Processing Actions for TN XML Document Type” on page 242. The signature that Trading Networks extracts must be a PKCS#7 detached signature of the signed body. 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. if the TN document type instructs Trading Networks to extract the ConversationID system attribute. 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. 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. To verify that the document arrived unchanged. For more information. You can specify the following pre-processing actions for TN document types. the TN document type must instruct Trading Networks to extract the SignedBody and Signature system attributes. see below. Trading Networks performs the pre-processing actions defined by the TN document type. This certificate 242 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks assures the signed body has not changed by verifying the digital signature.0 .

to limit the number of errors to ten. the processing actions can access the error information from the pipeline. see “Action 1—Execute a Service” on page 334. see “Action 1—Execute a Service” on page 334. specify the following: tn. For more information about this service. If the document structure is not valid. it continues performing the rest of the pre-processing actions. 13 Defining and Managing TN XML Document Types on file with Trading Networks is the one identified in that partner’s profile on the Security tab. Verify sub-tab.doc.max_errs property in the Trading Networks properties file. To use this pre-processing action. see the webMethods Integration Server Built-In Services.validate. Trading Networks also logs the error to the activity log. it continues performing the rest of the pre-processing actions. For more information about the pipeline variables that are available to processing actions.0 243 . To validate the structure of the document. Trading Networks cannot verify the digital signature. see “Trading Networks Configuration Properties” on page 36.doc. Regardless of whether the Trading Networks determines the document structure is valid. If the digital signature is not valid. "Security within Trading Networks" in Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. set the tn. Important! If the structure of a document is not valid. you must specify an IS schema in the TN XML document type. Trading Networks also logs the error to the activity log. If the partner’s profile does not contain the certificates to use for verification. It also performs the processing actions that are defined in the processing rule.validate. If Trading Networks is instructed to use the Save Document to Database pre-processing action to save information about the document to the database. For example. the processing actions can access the error information from the pipeline. It also performs the processing actions that are defined in the processing rule. 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. see Appendix B. To limit the number of error messages. Regardless of whether Trading Networks determines the digital signature is valid. If Trading Networks is instructed to use the Save Document to Database pre-processing action to save information about the document to the database. For more information about the pipeline variables that are available to processing actions. For more information about how Trading Networks verifies the digital signature.max_errs=10 For more information.schema:validate built-in service. Trading Networks assures that the XML document matches the structure identified by the IS schema using the pub. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. the validation service can return many error messages.

 Document ID and sender. and TN document type in its database. Trading Networks assures that it does not already have a document with the same document ID. and/or ReceiverID system attributes from the document. sender. and receiver.0 .  Built-in services—Use one of the following built-in duplicate checks:  Document ID only. sender. To check for a duplicate document using the document ID and sender. sender.  Document ID. You can have Trading Networks determine whether the document is a duplicate using a built-in or custom duplicate check service.13 Defining and Managing TN XML Document Types 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. SenderID. see “Creating a Duplicate Document Check Service” on page 333. 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. 244 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. you must instruct Trading Networks to extract the DocumentID system attribute from the document. To check for a duplicate document using the document ID. Trading Networks assures that it does not already have a document with the same document ID and sender in its database. you must instruct Trading Networks to extract the DocumentID.  Document ID. 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. To check for a duplicate document using the document ID. Note: There could be performance issues if you choose to use custom services for duplicate checking based on the logic in the service you select. 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. sender and receiver. sender and document type.  Custom services—Use a service that you create to determine whether a document is a duplicate. but did not extract the DocumentID. and ReceiverID system attributes from the document. and receiver in its database. you must instruct Trading Networks to extract the DocumentID and SenderID system attributes from the document. Trading Networks assures that it does not already have a document with the same document ID. SenderID. Trading Networks assures that it does not already have a document with the same document ID in its database. For more information.  Trading Networks previously received a document and saved it to the database. Trading Networks checks the document being processed against either built-in services or custom services.

If you choose to not save the document. there is no duplicate). it has not determined whether the document has a duplicate.e. if you want Trading Networks to use reliable delivery or scheduled delivery to deliver XML documents. and/or log information to the database. In this situation. Additionally. For more information about the Check for Duplicate Document pre-processing action. for example. 13 Defining and Managing TN XML Document Types  You selected the Document ID. if you want to deliver a document via a queue. 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. Trading Networks considers the document as having no duplicate and will save the unique document to the database. Certain delivery options require saving the document content to the database. only unique documents. “Checking for Duplicate of the XML Document”. sender and document type option and Trading Networks was unable to match the document to a TN document type. even if there is a duplicate) or only if the document(s) is unique (i. When you specify this pre-processing action. For more information. You can save a copy of the document(s) content. In addition. If you want Trading Networks to save document(s) to the database only if it is unique. If you do not have Trading Networks perform the Check for Duplicate Document pre-processing action. save the document regardless of whether it is unique. see the previous section. attributes. Trading Networks maintains no information about this document after it processes the document. you must specify the Check for Duplicate Document pre-processing action.. you select whether Trading Networks is to save all documents (i. The following table displays the consequences of not saving specific options: Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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 uses the results of the duplicate document check in the Save Document to Database pre-processing action.. or do not save the document to the database. 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. see “Using Reliable Delivery with Immediate Delivery Method” on page 346 or “Using Reliable Delivery with Scheduled Delivery” on page 347. Trading Networks will bypass reliable delivery and invoke the specified delivery service once.e. you must have Trading Networks save the document to the database. As a result.0 245 . see “Action 1—Execute a Service” on page 334. Trading Networks saves the results of the duplicate document check to the pipeline.

. Because the attributes are not saved when you reprocess the document.13 Defining and Managing TN XML Document Types If you do not save this option.0 .  You might get different or unexpected results when you reprocess a document. for example the default processing rule. Attribute  You will not be able to view custom attributes from My webMethods or Trading Networks Console (i. you can still use the processing rules extended criteria for the document. Trading Networks will not use reliable delivery.. Trading Networks does not perform document recognition again and therefore does not re-extract the attributes. Trading Networks will match to another processing rule. attributes will contain only information for system attributes). if you use extended criteria to select a processing rule when the value of the custom attribute Total Amount is greater than 10000..  You will not be able to resubmit or re-process the document.  You cannot search for documents in My webMethods or Trading Networks Console based on the values of custom attributes. When Trading Networks resubmits a document. see Getting Started with BPM and the webMethods Designer Online Help. Content  If you use the Deliver Document actions.  Note that you can still resubmit a document. Trading Networks would not select that processing rule when reprocessing a document because the value of the Total Amount attribute would not be available and therefore would not match the extended criteria. it performs document recognition and therefore extracts the attributes again. Trading Networks will not match processing rules that use extended criteria.. 246 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For more information about process management. 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. and perform the process actions identified in that matching rule.e. Then the consequences of not saving are. Activity Log  You will not be able to view activity log entries from My webMethods or Trading Networks Console..  You will not be able to view content from My webMethods or Trading Networks Console. For example. Trading Networks passes documents on to process management if it extracted a conversation ID from the document. However. Instead.

For more information about how to refresh your My webMethods cache. 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 the document as the sample document when creating the TN document type. 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. in other words.  Using a sample document—When you use a sample document. Trading Networks might have received a document for which there is no matching TN document type. you specify XQL queries that locate specific nodes in the document. Alternatively. 13 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. that is. To create a TN document type for that document. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For example. a document with an unknown TN document type. Note: If new TN document types are created while you have an open My webMethods session.  Not using a sample document—When you do not use a sample document. When you create a TN XML document type. you can use a document that was sent to Trading Networks for processing and is in the Trading Networks database.0 247 . You can use a sample document that you have stored in your file system. you need to know the required XQL queries and type them in yourself. 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. see information about My webMethods user preferences in Managing B2B Integrations: webMethods Trading Networks User’s Guide.

6 In the Select File dialog box.0 . browse your file system to locate the XML document that you want to use as a sample. 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. and click Open. select system. sample document from the file system. 4 Click the Identify tab. For a summary of actions you can take against a sample document. You can update any or all 5 Click Select Sample Document. 4 In the Document Types Details dialog box. 248 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. browse your file system to locate the XML document that you want to use as a sample. empty. document type fields are 2 Click the row containing the TN XML filled with values from the document type that you want to duplicate. document type fields are 2 Select Types > New > XML. Duplicate— The TN XML 1 Select View > Document Types. and you load a 3 Select Types > Duplicate. see “Working with a Sample Document” on page 256. and you load a sample document from the file 3 In the Create New DocType dialog box.13 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. and click Open. 5 Click Select Sample Document. To define a TN XML document type using a sample document 1 In Trading Networks Console. 6 In the Select File dialog box. the XML document type category from the list. perform one of the following procedures to start a new TN XML document type and load a sample document. click the Identify tab. TN XML document type that you duplicate. fields from the duplicated TN XML document type.

5 Optionally. 13 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 TN 1 From Trading Networks Console. Note: Trading Networks displays a tree view of the XML document in the left side on the screen. This field is required. 6 Click the Identify tab. use the XML document type fields Transaction Analysis screen to display the are empty and the sample sample document that you want to use. see Managing for you. click Show Source. type a description for the TN XML document type in the Description field. For details about specifying any of this information. 4 Type the name you want to give the TN XML document type in the Name field. 2 Click the row containing the document for which you want to create a TN XML document type. Perform one or more of the following procedures to specify information that indicates how Trading Networks is to identify documents. Note: If you do not specify any identification information in a TN document type. B2B Integrations: webMethods Trading Networks User’s Guide. Trading Networks does not use the TN document type. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. To view the document source.0 249 . If you document from the Trading need procedures for viewing documents on Networks database is loaded the Transaction Analysis screen. 3 Select Transactions > Create/Edit Document Type. see “Identification Information in TN XML Document Types” on page 222.

4 Repeat this procedure for each identifying query that you want to add. STRING LIST. 3 Click OK.  To view (in the sample document) the node that a query represents. Note:  To delete a query from the TN document type. 250 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. This node is applicable for DATETIME. select the query row and click Delete selected identifying query. see Appendix E. 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. Maximum.  If you do not want the TN XML document type to require the identifying query to evaluate to a specific value. specify the value in the Value field. NUMBER (with Average. STRING. Minimum. “XQL Reference”.  If you want the TN XML document type to require the identifying query to evaluate to a value. or NUMBER data types. For information about XQL queries. you need to update the query so that it identifies an array of values. clear the Value field. But. Note: This “filled in” query is for a specific node in the XML document. Trading Networks displays the Add an identifying query dialog box. if you want to use DATETIME LIST. select the query row and click Show node. select the node that you want the identifying query to represent. 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. or NUMBERLIST data types.13 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.0 . Trading Networks adds the identifying query to the list on the right. and Sum). 2 Right click and select Add an identifying query.

Name of the pipeline matching variable. or a pipeline matching variable.0 251 . For details about what to specify for these fields. Perform the following procedure for each attribute that you want Trading Networks to extract from documents identified by this TN XML document type. a value for the DOCTYPE Identifier field. DOCTYPE Identifier Click the Set button next to the DOCTYPE Identifier field. Trading Networks determines the root tag of the sample document and uses its value to populate the Root Tag field.  Name. Trading Networks uses the value after the SYSTEM literal string. 5 Click the Extract tab. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. This field is optional. Trading Networks adds the pipeline matching variable to the list. Trading Networks populates the DOCTYPE Identifier field with the value it obtains from the document type declaration in the sample document. that is. If both literal strings exist.  Value. a In the sample document. Trading Networks obtains the value that follows the SYSTEM or PUBLIC literal string in the document type declaration (DOCTYPE) in the sample document. see “Extraction Information In TN XML Document Types” on page 226. 13 Defining and Managing TN XML Document Types For this Identify tab parameter… Use this procedure when using a sample document Root Tag Click the Set button next to the Root Tag field. 4 Repeat this procedure for each pipeline matching variable that you want to add. 2 Specify the following values in the Add Pipeline Matching dialog box. Pipeline Matching 1 Click Add New Pipeline Match. If you specify only the Name and no Value. Trading Networks checks to see that both exist in the pipeline. The value of the pipeline matching variable. 3 Click OK. then Trading Networks checks to see if the Name exists. a value for the Root Tag field. If you specify both the Name and the Value of the pipeline matching variable. select the node that represents the attribute that you want Trading Networks to extract. you must supply at least one identifying query. Important! You must supply at least one criterion that Trading Networks is to use to recognize an XML document.

Maximum. see “Transformation Information for Extracted Attributes of TN Document Types” on page 229. select the name of the attribute from the list. This node is applicable for DATETIME. data type For more information. see “Specifying Built-In Transformation Information for Attributes with the DATETIME and DATETIME LIST Data Type” on page 231. For more information. see “Specifying Built-In Transformation Information for SenderID and ReceiverID” on page 230. select the Required check box. Note: This “filled in” query is for a specific node in the XML document. d If you want Trading Networks to flag an error if it encounters an error attempting to extract this document attribute. STRING LIST. or NUMBERLIST data types. c In the Name field. STRING. Select an existing built-in transformation provided by Trading Networks. For more information. if you want to use DATETIME LIST. see “Indicating that Attributes are Required in TN XML Document Types” on page 228. Select one from the DATETIME LIST seven different built-in formats or type in your own. But. e Use the Transformation option to specify how Trading Networks is to handle attribute data before storing it in the Trading Networks database. Has DATETIMEor You must specify a date format. and Sum). 1 Built-in. Minimum. you need to update the query so that it identifies an array of values. Trading Networks fills in the Description and Type fields based on the document attribute definition.13 Defining and Managing TN XML Document Types b Right click and select Add an attribute. If the attribute data type is… For Transformation… Is SenderID or You must specify an external ID type. For more ReceiverID information. Trading Networks fills the Query field with the XQL query for the node that you selected. NUMBER (with Average. The data type of the attribute (shown in the Type field) determines the Built-in or Custom transformation options available. Trading Networks displays the Add an attribute dialog box.0 . 252 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. or NUMBER data types.

query identifies an For more information. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 253 . transformation from the selected service Edit an existing service Click on the Edit Service button. Has NUMBER data You should specify the operation that Trading type and the XQL Networks should perform on the numbers in the array. Important! If you do not extract the system attributes. Select or create your own service to perform custom transformations on extracted attributes. see “Specifying a Custom Transformation Service” on page 234. Select an existing custom transformation service Click Find Service to browse the IS namespace to locate the one you want to use. To view (in the sample document) the node that a query represents. select the attribute row. Note: To delete an attribute from the TN document type. see “Specifying Built-In array of numbers Transformation Information for Attributes with the NUMBER Data Type” on page 233. To do this… Perform this… Create a new custom transformation Click New Service. Trading Networks does not have this information available for processing rules or querying documents. Set the inputs of the Click Set Inputs. 2 Custom. select the attribute row and click Delete attribute. f Click OK to close the Add an attribute dialog box. see “Specifying SenderID or Built-In Transformation Information for Attributes ReceiverID) with the STRING or STRING LIST Data Type” on page 231. For more information. For more information. then click Show node. 13 Defining and Managing TN XML Document Types If the attribute data type is… For Transformation… 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.

7 Click the Options tab and fill in the fields. Processing Rule Whether you want Trading Networks to search for a Routing processing rule and process the document based on the processing rule. Trading Networks automatically sets the Validate Structure fields to indicate that you want to validate the structure of the document. click Find schema to browse IS schemas. To type search for an IS document type. see “Specifying an IS Document Type for TN XML Document Types” on page 241 Schema to validate The fully-qualified name of the IS schema. 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 this Options tab parameter… Specify… Format an IS document The fully-qualified name of the IS document type. click Set. For more information. click Append.0 . For information specific to pre-processing actions. To search for an against IS schema. see “Namespace Mappings in TN XML Document Types” on page 236. 254 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For more information. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 242.  To add the namespace information to the current namespace mappings. Note: When you select a IS schema. For more information about namespaces. For details about these fields. click Find IS document type to browse IS document types. For more information. see “Disabling Processing Rule Routing” on page 242.13 Defining and Managing TN XML Document Types 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. see “Specifying an IS Schema for TN XML Document Types” on page 241. select either Enable routing or Do not enable routing. see “Options in TN XML Document Types” on page 240.

To select an existing service. For more information about this pre-processing action. see “Validating the Structure of an XML Document” on page 243. click Find Service. see. Check for Duplicate Whether you want Trading Networks to determine Document whether it has already received the document. see “Checking for Duplicate of the XML Document” on page 244. For more information about this pre-processing action. Select one pre-processing action of the following:  Use built-in service to check for duplicate document  Use custom service to check for duplicate document. Validate Structure Whether you want Trading Networks to validate the pre-processing action document’s structure. If you select to validate. To create a new service. “Creating a Duplicate Document Check Service” on page 333.  Do not check for duplicate document Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule. select either Verify digital signature or Do not verify digital signature. Note: There could be performance issues if you choose to use custom services for duplicate checking based on the logic in the service you select. click New Service. Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule. see “Verifying the Digital Signature of an XML Document” on page 242. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For more information about how to create a custom duplicate checking service. select either Validate structure or Do not validate structure. 13 Defining and Managing TN XML Document Types For this Options tab parameter… Specify… Verify Digital Signature Whether you want Trading Networks to verify a pre-processing action document’s digital signature. For more information about this pre-processing action. Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule. Trading Networks validates the structure of the XML document against the IS schema you specified in the Schema to validate again option.0 255 .

256 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. and/or activity log information to the database. Working with a Sample Document The following table provides a summary of the actions you can take against a sample document. For more information. attributes. Save preprocessing action only unique documents. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 242. If you select to save documents to the database. Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule. select Save all documents. For more information about this pre-processing action.13 Defining and Managing TN XML Document Types For this Options tab parameter… Specify… Save Document to Whether you want Trading Networks to save the Database document to the database. see “Saving an XML Document to the Database” on page 245 Important! Keep in mind the pre-processing actions specified in the processing rules can override pre-processing actions specified in a TN document type. or Do not save.0 . 8 Click OK to create the TN XML document type. select from the list whether you want Trading Networks the document’s content.

 Add an identifying query—Select a node in the XML document. 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 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. Right click and select this menu item.0 257 . then. Select the attribute for which you want to update the XQL query. select the node in the sample document that represents the new query you want to use. Right-click menu— Right click in the sample document to display the right-click Extract Tab menu. Select the identifying query for which you want to update the XQL query. If both literal strings exist. select this menu item to add a new attribute that you want Trading Networks to extract. then. Trading Networks uses the value after the SYSTEM literal string. Right click and select this menu item. Trading Networks uses the value that follows the SYSTEM or PUBLIC literal string in the document type declaration. select the node in the sample document that represents the new query you want to use. Then. select this menu item to add a new identifying query to the TN document type. Then.  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.  Edit selected identifying query—Use to update the XQL query for an identifying query.  Add an Attribute—Select a node in the XML document. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. respectively. 13 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 Identify Tab menu. Trading Networks opens the Edit Attribute dialog box and replaces the XQL query in the Query field with the XQL query for the selected node. Trading Networks 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. 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.

Trading Networks deletes any existing namespace mappings from the table and replaces them with the namespace information that it obtains from the sample document. click the Set button next to the DOCTYPE Identifier field. 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— Use the Append button to populate the namespace mappings table Namespaces tab with the namespace information from all xmlns attributes in the sample document. 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 uses the value after the SYSTEM literal string. Trading Networks uses the value that follows the SYSTEM or PUBLIC literal string in the document type declaration. 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. click the Set button next to the Root Tag field  To set the DOCTYPE Identifier field with the value from the document type declaration (DOCTYPE) in the sample document. Trading Networks appends the namespace information that it obtains from the sample document to the existing namespace mappings in the table.13 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 Namespaces Tab menu. 258 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. If both literal strings exist.  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 Set Namespace Mapping.  To set the Root Tag field with the value of the root tag in the sample document. Set—Identify Tab Use the Set buttons to set the Root Tag and/or DOCTYPE Identifier fields with values from the sample document.0 .  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.

(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. 13 Defining and Managing TN XML Document Types Menu or Button Description 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. Type the following query in the Query field and click Test Query: Trading Networks updates the Value field to contain the value for TotalLineNum..0 259 . which is 1. Trading Networks If XQL query points displays it’s value to this node. Example: The following sample document is loaded: . select an identifying query. Trading Networks highlights (in the sample document) the node that the XQL query for the identifying query represents. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. When you click this button. When on the Extract tab. 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. When tabs you click this button. then.. click . Show Source—all Use this button to display the source of the XML document.. select an attribute. click . then. Trading Networks opens a new window that contains the document source. 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). On the Identify tab..

and you load a 2 Select Types > New. use the following procedure to define a TN XML document type. perform one of the following procedures to start a new TN XML document type. This field is required. type the name you want to give the TN XML document type. For details about specifying any of this information. select the XML document type category from the list. duplicate.13 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. 5 Optionally.0 . 260 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. You can update any or all fields from 3 Select Types > Duplicate. type fields are filled with values from 2 Click the row containing the TN XML the TN XML document type that you document type that you want to duplicate. the duplicated TN XML document type. Perform one or more of the following procedures to specify information that indicates how Trading Networks is to identify documents. sample document from the file system. type a description for the TN XML document type in the Description field. To define a TN XML document type when you do not have a sample document 1 In Trading Networks Console. Procedures when you do not have a sample Method to start a TN XML document type document loaded New— The TN XML document type 1 Select View > Document Types. 6 Click the Identify tab. Duplicate— The TN XML document 1 Select View > Document Types. 3 In the Create New DocType dialog box. see “Identification Information in TN XML Document Types” on page 222. fields are empty. 4 In the Name field.

2 In the Query field. type that value in the Value field. 4 Repeat this procedure for each pipeline matching variable that you want to add. select the query row and click Deleting an identifying query. 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. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 5 Repeat this procedure for each identifying query that you want to add. Pipeline Matching 1 Click Add New Pipeline Match. Trading Networks displays the Add an identifying query dialog box. 3 If you want the TN XML document type to require the identifying query to evaluate to a specific value.  Name. For information about XQL queries.  Value. then Trading Networks checks to see if the Name exists. This field is optional. 4 Click OK. Name of the pipeline matching variable. 13 Defining and Managing TN XML Document Types For this Identify tab parameter… Use this procedure when not using a sample document Identifying Queries 1 Click Add an identifying query. 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. 3 Click OK. If you specify only the Name and no Value. The value of the pipeline matching variable. Note: To delete a query from the TN document type. Trading Networks checks to see that both exist in the pipeline.0 261 . see Appendix E. 2 Specify the following values in the Add Pipeline Matching dialog box. “XQL Reference”. If you specify both the Name and the Value of the pipeline matching variable. Trading Networks adds the pipeline matching variable to the list. Type the value of the root tag from within the XML documents that this TN XML document type is to match.

For more information. use the Transformation option to specify how Trading Networks is to handle attribute data before storing it in the Trading Networks database. a Click Add an attribute. Trading Networks fills in the Type and Description fields based on the document attribute definition. select the name of the attribute from the list. select the Required check box. see Appendix E. For information about XQL queries. that is. or a pipeline matching variable. b In the Name field. you must supply at least one identifying query. 5 Click the Extract tab. Trading Networks does not have this information available for processing rules or querying documents. see “Indicating that Attributes are Required in TN XML Document Types” on page 228. a value for the DOCTYPE Identifier field. e If necessary. Important! If you do not extract the system attributes. For details about what to specify for these fields.0 . d In the Query field. Trading Networks displays the Add an attribute dialog box. “XQL Reference”. 262 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.13 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. Perform the following procedure for each attribute that you want Trading Networks to extract from documents identified by this TN XML document type. see “Extraction Information In TN XML Document Types” on page 226. a value for the Root Tag field. type an XQL query that identifies the location of the attribute within an XML document. see “Transformation Information for Extracted Attributes of TN Document Types” on page 229. For more information. c If you want Trading Networks to flag an error if it encounters an error attempting to extract this document attribute. The data type of the attribute (shown in the Type field) determines the Built-in or Custom transformation options available.

For more ReceiverID information. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Has NUMBER data You should specify the operation that Trading type and the XQL Networks should perform on the numbers in the array. see “Specifying Built-In Transformation Information for Attributes with the DATETIME and DATETIME LIST Data Type” on page 231. Select an existing custom transformation service Click Find Service to browse the IS namespace to locate the one you want to use. Has DATETIMEor You must specify a date format. see “Specifying SenderID or Built-In Transformation Information for Attributes ReceiverID) with the STRING or STRING LIST Data Type” on page 231. For more information. data type For more information. 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. Set the inputs of the Click Set Inputs. see “Specifying Built-In Transformation Information for SenderID and ReceiverID” on page 230. Select an existing built-in transformation provided by Trading Networks. see “Specifying a Custom Transformation Service” on page 234.0 263 . Select one from the DATETIME LIST seven different built-in formats or type in your own. see “Specifying Built-In array of numbers Transformation Information for Attributes with the NUMBER Data Type” on page 233. 2 Custom. If the attribute data type is… For Transformation… Is SenderID or You must specify an external ID type. 13 Defining and Managing TN XML Document Types 1 Built-in. To do this… Perform this… Create a new custom transformation Click New Service. transformation from the selected service Edit an existing service Click on the Edit Service button. Select or create your own service to perform custom transformations on extracted attributes. For more information. query identifies an For more information.

click the Namespaces tab. For information about pre-processing actions. If you are adding a mapping for the default namespace. 264 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Important! If you do not extract the system attributes. type the URI for the namespace. type the prefix for the namespace. see “Options in TN XML Document Types” on page 240. Trading Networks does not have this information available for processing rules or querying documents. select the row for the namespace and click Delete selected namespace mapping.  To edit a namespace mapping. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 242. see “Namespace Mappings in TN XML Document Types” on page 236. Note:  To delete a namespace mapping from the TN document type. 13 Defining and Managing TN XML Document Types . click Add a namespace mapping. c In the URI Mapping column. specify prefix0. For details about these fields. For more information about namespaces. 6 To define namespace mappings. 7 Click the Options tab and fill in the fields. select the attribute query and then click Delete an attribute. Trading Networks adds a row to the namespace mappings table. b In the Namespace Prefix column. a In the Namespace Mappings section of the screen on the right. Perform the following for each namespace mapping you want to add to the table.0 . Note: To delete an attribute from the TN document type. type over the existing information.

0 265 . Trading Networks automatically sets the Validate Structure fields to indicate that you want to validate the structure of the document. Validate Structure Whether you want Trading Networks to validate the pre-processing document’s structure. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see “Validating the Structure of an XML Document” on page 243. For more information. select either Validate structure or Do not action validate structure. select either Verify digital signature or Do not pre-processing verify digital signature. To search for an IS against schema. see “Verifying the Digital Signature of an XML Document” on page 242. Schema to validate The fully-qualified name of the IS schema. For more information. select either Enable routing or Do not enable routing. see “Disabling Processing Rule Routing” on page 242. Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule. click Find IS document type to browse IS document types. Processing Rule Whether you want Trading Networks to search for a Routing processing rule and process the document based on the processing rule. To search document type for an IS document type. For more information about this pre-processing action. 13 Defining and Managing TN XML Document Types For this Options tab parameter… Specify… Format an IS The fully-qualified name of the IS document type. click Find schema to browse IS schemas. Trading Networks performs this action pre-processing action before it performs the processing actions defined by the processing rule. Trading Networks validates the structure of the XML document against the IS schema you specified in the Schema to validate again option. If you select to validate. Note: When you select a IS schema. For more information. Verify Digital Whether you want Trading Networks to verify a document’s Signature digital signature. see “Specifying an IS Schema for TN XML Document Types” on page 241. see “Specifying an IS Document Type for TN XML Document Types” on page 241. For more information about this pre-processing action.

if you want to deliver a document via a queue).0 . For more information about how to create a custom duplicate checking service. Save only unique preprocessing documents. see “Checking for Duplicate of the XML Document” on page 244. Trading Networks performs this action pre-processing action before it performs the processing actions defined by the processing rule. and/or activity log information to the database. Note: There could be performance issues if you choose to use custom services for duplicate checking based on the logic in the service you select. click New Service. or Do not save. 266 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For more information about this pre-processing action. To create a new service.  Do not check for duplicate document Trading Networks performs this pre-processing action before it performs the processing actions defined by the processing rule.. select Save all documents. For more information about this pre-processing action. attributes. To select an existing service. Save Document to Whether you want Trading Networks to save the document to Database the database. click Find Service.13 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. If you select to save documents to the database. Trading Networks will bypass reliable delivery and invoke the specified delivery service once. select from the list whether you want Trading Networks the document’s content. see. see “Saving an XML Document to the Database” on page 245 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. 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. “Creating a Duplicate Document Check Service” on page 333.

3 To hide disabled TN document types. 13 Defining and Managing TN XML Document Types Important! Keep in mind the pre-processing actions specified in the processing rules can override pre-processing actions specified in a TN document type. select Types > Show All. Trading Networks places a check () next to the Show All menu item to indicate that Trading Networks is currently displaying disabled TN document types. Trading Networks displays both the TN XML document types and TN flat file document types.. Trading Networks does not display disabled TN document types. By default. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see “Pre-Processing Actions” on page 331. However. Managing TN XML Document Types The following table describes the tasks you can perform against TN XML document types: Task See page. Trading Networks removes the check () next to the Show All menu item to indicate that Trading Networks is currently not displaying disabled TN document types. To view TN XML document type 1 In Trading Networks Console: View > Document Types. you can update the display of TN document types to include disabled TN document types.0 267 . 2 To view disabled TN document types. select Types > Show All again. 8 Click OK to create the TN XML document type. “Viewing TN XML Document Types” 267 “Updating TN XML Document Types” 268 “Using a Sample Document when Updating a TN XML Document 268 Type” “Updating a TN XML Document Type without a Sample Document” 273 “Disabling TN XML Document Types” 276 “Enabling TN XML Document Types” 277 “Testing TN XML Document Types” 277 Viewing TN XML Document Types You can view TN XML document types using the Document Types screen. For more information..

To update a TN XML document type when a sample document is available 1 In Trading Networks Console: View > Document Types. 3 Select Types > Edit. perform the following procedure. c In the Select File dialog box.0 . Important! The TN XML document type must include at least one criterion that Trading Networks can use to recognize a document. see “Working with a Sample Document” on page 256. at least one identifying query. b Click Select Sample Document. 4 To update the description. 2 Click the row containing information about the TN XML document type that you want to update. Trading Networks displays both the TN XML document types and TN flat file document types. browse your file system to locate the XML document that you want to use as a sample.13 Defining and Managing TN XML Document Types Updating TN XML Document Types As when you define TN XML document types. 6 To update identification information. 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. For details about specifying any of this information. For a summary of actions you can take against a sample document. 5 Perform the following to load the sample document: a Click the Identify tab. a value for the Root Tag field. Trading Networks displays the Document Type Details dialog for the selected TN XML document type. or a pipeline matching variable. and click Open. 268 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. a value for the DOCTYPE Identifier field. that is. 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. see “Identification Information in TN XML Document Types” on page 222. click the Identify tab. type a new description in the Description field.

Click OK to close the Edit selected identifying query dialog box. and Sum). But. Minimum. STRING. you need to update the query so that it identifies an array of values. “XQL Reference”  To update an identifying query—In the sample document. Right click and select Add an identifying query. This node is applicable for DATETIME. see Appendix E. Right click and select Edit selected identifying query. Click OK to close the Add an identifying query dialog box. STRING LIST. For information about XQL queries. NUMBER (with Average. clear the Root Tag field. otherwise. clear the Value field. if you want to use DATETIME LIST.  To delete an identifying query from the TN document type—Select p the row for the identifying query and click Delete selected identifying query Root Tag  To update the Root Tag field with the value from the sample document. or NUMBERLIST data types. 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. or NUMBER data types. Note: This “filled in” query is for a specific node in the XML document.  To remove the value from the Root Tag field. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. select the node that you want the identifying query to represent. Maximum. assure that value is in the Value field.0 269 . If you want the TN document type to require the identifying query to evaluate to a specific value. Trading Networks opens the Add an identifying query dialog box and populates the Query field with the XQL query for the selected node. select the node that you want the identifying query to represent. click the Set button next to the Root Tag field. 13 Defining and Managing TN XML Document Types 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.

Click OK to save your updates and close the Update Pipeline Matching dialog box.  To delete a pipeline matching variable.  To add an attribute—In the sample document. 7 To update extraction information. Right click and select Add an attribute. Note: This “filled in” query is for a specific node in the XML document. if you want to use DATETIME LIST.  To update a pipeline matching variable. or NUMBER data types. This node is applicable for DATETIME. click the Set button next to the DOCTYPE Identifier field. you need to update the query so that it identifies an array of values. Trading Networks opens the Add an attribute dialog box and populates the Query field with the XQL query for the selected node. For information about how to specify information on this tab. the Value for the pipeline matching variable. In the Update Pipeline Matching dialog box.13 Defining and Managing TN XML Document Types To update this Identify tab parameter … Use these procedures when you have a sample document loaded… DOCTYPE Identifier  To update the DOCTYPE Identifier field with the value from the sample document. Pipeline Matching  To add a pipeline matching variable—Click Add New Pipeline Match. click the Extract tab. update the Name and Value fields for that variable. STRING LIST. Minimum. clear the DOCTYPE Identifier field.0 . In the Add Pipeline Matching dialog box. But. STRING. Maximum. NUMBER (with Average. click the row containing the pipeline matching variable you want to update and click Edit Selected Pipeline Match. and Sum). or NUMBERLIST data types.  To remove the value from the DOCTYPE Identifier field. see “Extraction Information In TN XML Document Types” on page 226. Click OK to save the variable and close the dialog box. specify the Name and optionally. 270 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. click the row containing the pipeline matching variable you want to delete and click Remove Selected Pipeline Match. select the node that represents the attribute that you want Trading Networks to extract.

13 Defining and Managing TN XML Document Types Fill in the rest of the Add an attribute dialog box by performing the following: a In the Name field. For more information. select the Required check box. 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 array of numbers Transformation Information for Attributes with the NUMBER Data Type” on page 233. type For more information. Important! If you do not extract the system attributes. For more information. 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. c If necessary. 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. use the Transformation option to specify how Trading Networks is to handle attribute data before storing it in the Trading Networks database. see “Indicating that Attributes are Required in TN XML Document Types” on page 228.0 271 . Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. d The data type of the attribute (shown in the Type field) determines the Built- in or Custom transformation options available. For more information. b If you want Trading Networks to flag an error if it encounters an error attempting to extract this document attribute. Trading Networks does not have this information available for processing rules or querying documents. see “Specifying Built-In Transformation Information for Attributes with the DATETIME and DATETIME LIST Data Type” on page 231. Has DATETIMEor You must specify a date format. see “Specifying Built-In Transformation Information for SenderID and ReceiverID” on page 230. select the name of the attribute from the list. Select one from the DATETIME LIST data seven different built-in formats or type in your own. see “Specifying SenderID or Built-In Transformation Information for Attributes ReceiverID) with the STRING or STRING LIST Data Type” on page 231.  Built-in transformation.

 To replace existing namespace mappings with namespace information from the sample document—Click Set.  To append namespace information from the sample document to the existing namespace mappings—Click Append. For information about namespaces.  To update a namespace mapping—Type over the existing information in the namespace mappings table. For information about what you can specify.0 . Trading Networks opens the Edit Attribute dialog box and updates the Query field with the XQL query for the selected node. Trading Networks closes the screen. Click OK to close the Edit Attribute dialog box. see “Specifying a Custom Transformation Service” on page 234. Select an existing custom transformation service Click Find Service to browse the IS namespace to locate the one you want to use. 272 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. transformation from the selected service Edit an existing service Click on the Edit Service button.  To delete a namespace mapping—Select the row for the namespace mapping and click Delete selected namespace mapping. click the Options tab. e Click OK to close the Add an attribute dialog box. To do this… Perform this… Create a new custom transformation Click New Service. Set the inputs of the Click Set Inputs. see step 7 on page 254. click the Namespaces tab. Select or create your own service to perform custom transformations on extracted attributes. For information about how to specify information on this tab. click OK. 8 To update namespace mappings. 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 update information for an existing attribute—In the sample document. 9 To update options. 10 After you have made all your changes. Right click and select Edit Attribute. select the node that represents the attribute that you want Trading Networks to extract. see above for the description for adding an attribute. see “Namespace Mappings in TN XML Document Types” on page 236.13 Defining and Managing TN XML Document Types  Custom transformation. For more information.  To delete an attribute from the TN document type—Select the row for the attribute and click Delete selected attribute. Trading Networks adds the namespace information from all xmlns attributes in the sample document to the namespace mappings table.

Trading Networks displays both the TN XML document types and TN flat file document types. 13 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. type that value in the Value field. But. Trading Networks displays the Add an identifying query dialog box. 3 Select Types > Edit. Important! The TN document type must include at least one criterion that Trading Networks is to use to recognize an XML document. at least one identifying query. type a new description in the Description field. 5 To update identification information. To update a TN XML document type without a sample document 1 In Trading Networks Console: View > Document Types. that is.0 273 . 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. you need to update the query so that it identifies an array of values. 4 To update the description. 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 . or NUMBERLIST data types. NUMBER (with Average. Click OK to close the Add an identifying query dialog box. Minimum. a value for the DOCTYPE Identifier field. Maximum. This node is applicable for DATETIME. see “Identification Information in TN XML Document Types” on page 222. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. or NUMBER data types. or a pipeline matching variable. click the Identify tab. If you want the TN document type to require that the identifying query evaluate to a specific value. if you want to use DATETIME LIST. Note: This “filled in” query is for a specific node in the XML document. For details about specifying any of this information. STRING LIST. STRING. a value for the Root Tag field. 2 Click the row containing information about the TN XML document type that you want to update. and Sum). perform the following procedure. In the Query field.

 To remove the value from the Root Tag field. In the Add Pipeline Matching dialog box. Update the Query and/or Value fields. Click OK to close the Edit selected identifying query dialog box.  To update information for an existing identifying query— Select the row for the identifying query and click Edit selected identifying query. Pipeline Matching  To add a pipeline matching variable—Click Add New Pipeline Match. update the Name and optionally. see Appendix E. 274 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. “XQL Reference”.0 . Trading Networks displays the Edit selected identifying query dialog box. Click OK to save the variable and close the dialog box.  To delete an identifying query from the TN document type— Select the row for the identifying query and click Delete selected identifying query. specify the Name and optionally.  To delete a pipeline matching variable—Click the row containing the pipeline matching variable you want to delete and click Remove Selected Pipeline Match. clear the DOCTYPE Identifier field. Click OK to save your updates and close the Update Selected Pipeline Match dialog box. clear the Root Tag field.  To update a pipeline matching variable—Click the row containing the pipeline matching variable you want to update and click Edit Selected Pipeline Match. 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. In the Update Pipeline Matching dialog box. click the Set button next to the DOCTYPE identifier field.13 Defining and Managing TN XML Document Types To update this Identify tab parameter … Use these procedures when you do not have a sample document… For information about XQL queries.  To remove the value from the DOCTYPE Identifier field. DOCTYPE Identifier  To update the DOCTYPE Identifier field. the Value for the pipeline matching variable. the Value fields for that variable.

 To add an attribute—Click . 13 Defining and Managing TN XML Document Types 6 To update extraction information. see “Specifying Built-In Transformation ReceiverID) Information for Attributes with the STRING or STRING LIST Data Type” on page 231. specify… Is SenderID or You must specify an external ID type. For more SenderID or information. 2 To update the description. use the Detail field to specify how Trading Networks is to handle attribute data before storing it in the Trading Networks database. For more ReceiverID information. Trading Networks displays the Add an attribute dialog box. . see “Indicating that Attributes are Required in TN XML Document Types” on page 228. 3 If you want Trading Networks to flag an error if it encounters an error attempting to extract this document attribute. Has DATETIME data You must specify a date format.0 275 . For information about XQL queries. see “Extraction Information In TN XML Document Types” on page 226. type a description in the Description field. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. “XQL Reference”. Fill in the Add an attribute dialog box by performing the following: 1 In the Name field. click the Extract tab. Has NUMBER and You should specify the operation that Trading the XQL query Networks should perform on the numbers in the array. select the Required check box. For information about how to specify information on this tab. For more information. For more information. select the name of the attribute from the list. If the attribute… For Detail. see “Specifying Built-In Transformation Information for Attributes with the DATETIME and DATETIME LIST Data Type” on page 231. see “Specifying Built-In numbers Transformation Information for Attributes with the NUMBER Data Type” on page 233. identifies an array of For more information. 4 In the Query field. see “Specifying Built-In Transformation Information for SenderID and ReceiverID” on page 230. type an XQL query that identifies the location of the attribute within an XML document. Select one from the type seven different built-in formats or type in your own. Has STRING data You can specify whether you want Trading Networks type (but not to alter the string value before storing it. see Appendix E. 5 If necessary.

click the Options tab. See “Enabling TN XML Document Types” on page 277.. you can disable it. Trading Networks displays the Edit Attribute dialog box. Later. Specify Namespace Prefix The prefix for the namespace. For information about what you can specify. specify prefix0. see above for the description for adding an attribute.0 .  To delete an attribute from the TN document type—Select the row for the attribute and click Delete selected attribute. For information about how to specify information on this tab. Click OK to close the Edit Attribute dialog box.. Trading Networks closes the screen. Note: To permanently remove the TN document type from the database. click the Namespaces tab. see step 7 on page 254. URI Mapping The URI for the namespace.  To delete a namespace mapping—Select the row for the namespace mapping and click Delete selected namespace mapping. In this column. 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. If you are adding a mapping for the default namespace. click OK. 276 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Update the fields to make the changes you want. 7 To update namespace mappings. When you disable a TN XML document type.  To update a namespace mapping—Type over the existing information in the namespace mappings table. the definition for the TN document type is not removed from the database. see “Namespace Mappings in TN XML Document Types” on page 236. if you decide that you need the TN document type. you must also remove all documents that are associated with the TN document type. When you remove a TN document type from the database.13 Defining and Managing TN XML Document Types 6 Click OK to close the Add an attribute dialog box. your database administrator must remove it. For information about namespaces. Trading Networks adds a row to the namespace mappings table. 9 After you have made all your changes.  To update information for an existing attribute—Select the row for the attribute and click Edit selected attribute. 8 To update options. you can enable it.  To add a namespace mapping—Click .

This type of document would be an unknown TN document type if processed by your system. 2 Click the row containing information about the TN XML document type that you want to update. you can enable it and make it available again. To enable a TN XML document type 1 In Trading Networks Console: View > Document Types. In this situation. 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.  Documents that do not match any of your defined XML TN XML document types. select Document Types > Show All. the TN XML document types are set up correctly for this type of document. Enabling TN XML Document Types If you disable a TN XML document type and then later determine that you still need it. Note: To view the Enabled column (if it is not currently displayed). you should add a TN XML document type to identify the document or update an existing TN document type to identify the document. 3 Select Types > Disable. 13 Defining and Managing TN XML Document Types To disable a TN XML document type 1 In Trading Networks Console: View > Document Types. Important! To enable TN document types. you must first display inactive TN document types as described in “Viewing TN XML Document Types” on page 267.0 277 . 2 Click the row containing information about the TN XML document type that you want to update. 3 Select Types > Enable. you can test each to determine whether your Trading Networks system will receive:  Documents that match exactly one defined TN XML document type. Trading Networks places No in the Enabled column to indicate that the TN XML document type is disabled. If you have samples of all the types of documents that your Trading Networks system will process. If your testing finds a document that does not match any defined TN XML document type. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.

Trading Networks uses the identification information in all TN XML document types to determine all TN document types that match the specified document. Note that Trading Networks does not test the sample document against disabled TN document types. 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. Trading Networks does not actually process the document. 2 Select Types > Test. 3 From the Select Input Document dialog box.13 Defining and Managing TN XML Document Types  Documents that match more than one defined TN XML document type. multiple TN document types. For information about this permission. This means the Trading Networks does not highlight the disabled TN document types that the document would match. or no TN document types. 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. you must have sample documents available in your file system. you can either copy the file contents or upload the file to Trading Networks. see “Data and Actions Governed by General Functional Permissions” on page 66. To perform a test. 278 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. you select the sample document. Submitting XML Documents to Trading Networks You can submit XML documents to Trading Networks using My webMethods. Trading Networks highlights all matching TN XML document types on the Document Types screen. select the sample document you want to use for the test and click Open. Important! During the test. Perform the following procedure to test your TN XML document types for a specified document.0 . You must be granted the general functional permission to be able to submit documents to Trading Networks. To test the TN XML document types. If your testing finds a document that matches multiple TN document types (also called an ambiguous document). Trading Networks does not perform any pre-processing or processing actions on the document. Trading Networks displays the Select Input Document dialog box. To test TN XML document types 1 In Trading Networks Console: View > Document Types. To submit the document. That is. you should update TN document types so that the document matches exactly one TN XML document type.

Trading Networks does not route the submitted document to webMethods Process Engine. Select this option if the WmPRT package is not installed. 5 Click Submit to submit the XML file to Trading Networks.  If you selected Upload file. 13 Defining and Managing TN XML Document Types To submit XML documents to Trading Networks 1 In My webMethods: Administration > Integration > B2B Settings > Submit Documents.0 279 .  False. copy the XML file contents. Note: When you select the Upload file option.  Select Copy text to copy the file contents. select one of the following:  True. Trading Networks automatically refreshes the page to display a corresponding field FileName. Select this option if the WmPRT package is installed. then in the FileName field. then in the Document Content field. 3 In the PRT Ignore Document list. 4 Based on the method you chose to submit the document in the Submit Method field. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. type the path of the file or click Browse and select the file. Trading Networks routes the submitted document to webMethods Process Engine. See step 4.  Select Upload file to upload the file. do the following:  If you selected Copy text. 2 In the Submit Method field. select one of the following options based on how you want to submit the document.

13 Defining and Managing TN XML Document Types 280 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . 292  Defining TN Flat File Document Types . . . . . . . . 282  Defining Document Gateway Services . . . .0 281 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307  Managing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286  TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . .14 Defining and Managing TN Flat File Document Types  Overview . . . . .

After supplying the values needed in the TN_parms pipeline variable. you can transform certain types of attribute data before Trading Networks stores it in the database. respectively.14 Defining and Managing TN Flat File Document Types Overview Flat file documents present data in a record-based storage format. Because the records are not structured in a flat file document. flat file data is externalized as a set of records (a list of records containing fields and composites) without any structural information. for example SenderID and ReceiverID in the TN_parms/SenderID and TN_parms/ReceiverID.  Optional system variables. your service defines values in a pipeline variable named TN_parms. It is a Java or flow service that you create to provide information to Trading Networks about a flat file.  Whether to perform pre-processing actions (such as validating the data structure and checking for duplicate documents) before executing a processing rule. the gateway service passes control to Trading Networks for processing. a document that does not contain metadata. that is.0 . using built-in or custom transformations. For example. you create a document gateway service and a corresponding TN flat file document type for each type of document you expect to receive. the application receiving the flat file must have knowledge of the flat file’s structure to read its content.  Custom attributes (the document data).  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. for example variables that specify the content type and content encoding you want Trading Networks to use for the document. Trading Networks’ definition of a flat file is any file or document with a format that is non-describing. A document gateway service is the entry point for flat files into Trading Networks. In addition to creating a document gateway service. To provide this information. 282 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks will retrieve the flat file information from the TN_parms pipeline variable. flat files do not have structural information embedded within the data. The service should define values for:  System attributes. In other words. 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. you define a corresponding TN flat file document type that Trading Networks will use when it receives the document from the gateway service. You can only extract values for the attributes that the gateway service has placed in the TN_parms pipeline variable. To provide this structural knowledge. Unlike XML files.  The system and custom attribute values to extract. In addition. 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.

sending the flat file document to the service as an input stream. 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. and Trading Networks adds additional information that it uses for routing and processing. Trading Networks adds the extracted attributes to the BizDocEnvelope. A BizDocEnvelope represents a routable Trading Networks transaction. and searches the pipeline matching key/value pairs in all your enabled TN flat file document types. It contains the flat file document. trying to find a matching document type for the document. 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. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. (You could have omitted the Service_code value if you wanted to receive Billing department documents with any service code.0 283 . you can explicitly specify in the gateway service the TN flat file document type to use for the document. Specifying the document type eliminates the overhead of that search. but that TN document type does not exist 4 After finding a single matching TN flat file document type. For example. 14 Defining and Managing TN Flat File Document Types Run-Time Processing of Flat File Documents Trading Networks processes a flat file document as follows.) Tip! Rather than having Trading Networks search all of your TN flat file document types to find a match. 3 Trading Networks tries to identify the type of the document. To do this. which is placed in the pipeline as a variable named bizdoc. it examines the contents of the pipeline variable TN_parms. suppose you defined a document type named Acme_XYZ_Invoices to receive all documents from Acme’s Billing department with the service code XYZ. 2 The document gateway service places information about the flat file into the TN_parms pipeline variable. 1 Your trading partner’s client application invokes a specific document gateway service. and then passes control to Trading Networks for further processing.

Trading Networks can transform the extracted attribute values before storing them into the BizDocEnvelope. In addition. and more. By default if Trading Networks cannot extract a particular attribute value. You extract system attribute values if you want to use them as criteria for determining the processing rule to use for a document. Extracting all other system attributes. You can extract document data to perform any processing you want. Trading Networks completes processing. 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 TN_parms/Invoice_number 123 TN_parms/Amount 1000. If you want Trading Networks to log an error when it cannot extract particular attribute values. such as DocumentID. logs the error to the activity log.0 . it completes processing (assuming it finds no errors) and sets the processing status to DONE. it then ends its processing. such as calculations. and sets the processing status to DONE W/ERRORS.14 Defining and Managing TN Flat File Document Types 5 Trading Networks extracts all system and custom attributes that you defined in the TN flat file document type. and always extracts. Trading Networks performs the pre-processing actions defined by the TN document type. is optional. Continuing with the example document type Acme_XYZ_Invoices. transaction analysis. you can designate those attributes as being required for extraction. Trading Networks does not search for a processing rule. Trading Networks looks for the values within the TN_parms pipeline variable.00 You can extract any of these attributes. process management. it will not log an error. nor does it perform any processing rule actions. 284 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. To extract attribute values. using the optional built-in or custom transformations that you specified. In this case. Trading Networks places the extracted attribute values into the BizDocEnvelope. SenderID and ReceiverID are system attributes that Trading Networks always requires in TN_parms. 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.

thus bypassing the lookup (and its overhead). Tip! Trading Networks performs a processing rule lookup for each document to determine the processing rule to use for it. you can explicitly specify in the gateway service the processing rule to execute for a given TN document type. which in turn will determine the process model to use to process the document. In the processing rule. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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. Trading Networks passes the document to the Process Engine. For details.0 285 . that is. see Chapter 15. 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 performs a processing rule lookup to determine the processing rule to use for the incoming flat file document. 14 Defining and Managing TN Flat File Document Types 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.  If the TN flat file document type indicates that processing rule routing is enabled. or to use the ones specified in the document type. Trading Networks executes these pre-processing actions before it executes the processing rule that you associate with the document type. determine whether Trading Networks has already received the document  Save a copy of the document content. “Defining and Managing Processing Rules”. Alternatively. “Defining and Managing Processing Rules”. attributes. see “Pre-Processing Actions” on page 331. 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. For details. 2 Trading Networks executes the processing rule actions. see Chapter 15. These actions. you can specify whether to use the pre-processing actions specified in the processing rule. executed in the following order. For details.

tn. c Optionally specify values for the system attributes DocumentID. TN_parms can include:  The custom attributes that you specify (the document data)  The Trading Networks system attributes and system variables that you specify. There is only one input variable: ffdata.14 Defining and Managing TN Flat File Document Types Defining Document Gateway Services You can create a document gateway service using Java or flow.rec:GatewayService specification defines the input and output variables for a document gateway service. see “Converting a Flat File Document to an IS Document” on page 288. passing it the flat file document.. For details. TN_parms/ConversationID. The gateway service receives the flat file document as an input stream in the ffdata pipeline variable. Note: If new TN document types are created while you have an open My webMethods session. 286 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. b Specify the external ID values (e. see information about My webMethods user preferences in Managing B2B Integrations: webMethods Trading Networks User’s Guide. TN_parms/GroupID. For more information about how to refresh your My webMethods cache. and/or TN_parms/UserStatus pipeline variables. For details. you can parse the input stream and convert it to an IS document. and/or UserStatus in the TN_parms/DocumentID. The wm. Logic to include in a document gateway service 1 Read the input stream. A document gateway service returns the output variables ffdata (an object) and TN_parms (an IS document). ConversationID. You must provide your trading partners with the names of the document gateway services that are appropriate for their particular types of documents.g. 2 Use the Trading Networks system attributes and variables (described in “Specifying the Document Gateway Services Outputs” on page 288) to: a Explicitly specify the document type to use for processing the document (optional).0 . thus eliminating the overhead of that search. GroupID. 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. Optionally. This is an alternative to having Trading Networks search for a matching document type. Use the system attribute DoctypeID or DoctypeName for this purpose. The trading partner’s client application invokes a gateway service. see “Reading the Input Stream” on page 287. respectively. D-U-N-S numbers) for the sender and receiver of the documents in the TN_parms/SenderID and TN_parms/ReceiverID pipeline variables.

use the services provided in the pub. Reading the Input Stream If your document gateway service is a Java service. 4 Invoke either wm.InputStream class to read bytes from the input stream contained in ffdata. Trading Networks will lose the bytes read by the gateway service when attempting to save the document content to the BizDocEnvelope. f Specify the content type and content encoding you want Trading Networks to use for the document (optional). Otherwise. 3 Specify all custom attribute values (the document data) that the matching document type is to extract. ensure that you transform InputStream to support marking. For descriptions of the pub. If InputStream does not support marking.tn:receive or wm.doc.tn.ff:routeFlatFile to pass ffdata and TN_parms to Trading Networks. 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. thus eliminating the overhead of that lookup. use the methods of the java. 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.0 287 . Use the system variables TN_parms/$contentType and TN_parms/$contentEncoding for this purpose. The WmPublic package must be enabled to use these services. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see webMethods Integration Server Built-In Services. Consult your Java documentation for descriptions of these methods. Use the system variables TN_parms/processingRuleID and TN_parms/processingRuleName for this purpose. e Place the gateway service’s name into the pipeline to enable documents that invoke this gateway service to be resubmitted if necessary (optional). 14 Defining and Managing TN Flat File Document Types d Explicitly specify the processing rule to use for processing the document (optional).io folder in the WmPublic package. 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. This is an alternative to having Trading Networks look up the appropriate processing rule to use.io. Use the system variable TN_parms/$receiveSvc for this purpose. If your document gateway service is a flow service.io services. This is an alternative to having Trading Networks automatically determine the content type and content encoding of the document.

the original content type and content encoding will be lost.flatfile:convertToValues.0 . Then you can map information from the converted document to the TN_parms variable. invoke pub. To do so. Specifying the Document Gateway Services Outputs A document gateway service can return the output variables ffdata (an object) and TN_parms (an IS document). if you decide you do not need to parse the document in your gateway service. respectively. should specify text/plain for TN_parms/$contentType and SJIS for TN_parms/$contentEncoding. which are described below 288 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Converting a Flat File Document to an IS Document Optionally. Alternatively. either your gateway service or the service that invoked it. TN_parms can return:  The custom attributes that you specify (the document data)  The Trading Networks system attributes and system variables that you specify. Important! Perform this action only if absolutely necessary because parsing can be time-consuming and return very large outputs that consume much memory. which is a service in the WmFlatFile package (see the Flat File Schema Developer’s Guide). it will remain in the pipeline. you can parse the input stream and convert it to an IS document. Trading Networks can save or throw away the parsed contents.14 Defining and Managing TN Flat File Document Types You can provide the content type and content encoding to ensure that Trading Networks uses the accurate values. For details. This service invokes the flat file parser to validate the document’s structure and content. Note: Do not convert a document in both the gateway service and the TN document type. based on the flat file schema that you name as input to the service. 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. If you convert a document in the gateway service. explicitly specify the content type and/or content encoding in the TN_parms/$contentType and the TN_parms/$contentEncoding variables. For example. you can still indicate that you want to parse the document to validate its structure using the pre-processing option Validate Structure. see “Validating the Structure of Flat File Documents” on page 302. In your document gateway service. In this case. The pipeline has a content type of application/x-wmidatabin and a content encoding of UTF8.

see “Checking for Duplicates of the Flat File Document” on page 303. GroupID String (optional) The identifier in a flat file document that associates this document with other documents in its group.tn. To determine the document type identifier invoke the wm. For details. your gateway service will be both more stable and more efficient if you use DoctypeID rather than DoctypeName. the sender’s D-U-N-S number. the receiver’s D-U-N-S number. The TN document type uses ReceiverID to verify the receiver’s identity. for example DUNS. Examples: /TN_parms/DoctypeID = "5066kt00tttva37r00000009" /TN_parms/DoctypeName = "xCBL_PO" SenderID String An external ID value specified in the sender’s profile. for example.0 289 . Be sure to specify DocumentID if you want to use the Check for Duplicate Document pre-processing action. be sure the value you specify for GroupID is reproducible for future documents that will arrive in the same group. In the TN document type you must specify the type of the external ID. Since TN document type IDs cannot be changed. This is an alternative to having Trading Networks search for an appropriate document type. If you expect to receive more documents in the same group. If you use DoctypeName. thus eliminating the overhead of that search. In the TN document type you must specify the type of the external ID.doctype:list service from Developer to return the name and ID of all your TN document types. DoctypeID is used. for example. and Trading Networks is to use the DocumentID to determine whether documents are duplicates. the gateway service will not function as intended. 14 Defining and Managing TN Flat File Document Types 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. and that name is changed later. for example DUNS. DocumentID String (optional) The identifier of the flat file document. ReceiverID String An external ID value specified in the receiver’s profile. The TN document type uses SenderID to verify the sender’s identity. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. If you specify both variables.

For more information. Use ConversationID if you want Trading Networks to pass the document to process management after it executes the document type’s processing rule. see “Processing Rule Criteria” on page 322. conversation of documents). you can refine your search to documents with specific user statuses.14 Defining and Managing TN Flat File Document Types TN_parms variables Description ConversationID String (optional) The identifier in a flat file document that associates this document with other documents in the same business process (i. see the Getting Started with BPM guide and the webMethods Designer Online Help. In addition. be sure the value you specify for ConversationID is reproducible for future documents that will arrive in the same conversation. If you expect to receive more documents in the same conversation.0 . add a variable to the pipeline called prtIgnoreDocument with the value of true.e. If you do not want Trading Networks to pass the document to process management. 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. 290 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. The user status is a criterion that Trading Networks uses to determine the processing rule to use for a document. when searching for documents in Trading Networks Console. if you create UserStatus.. You define the actions taken against a document during process management by creating a process model. For more information about creating process models.

so your gateway service will be both more stable and more efficient if you use processingRuleID rather than processingRuleName. You can specify $contentType and/or $contentEncoding. As a result. the sender. For more information. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. invoke the wm. Trading Networks resubmits the document to wm. you will be able to resubmit the flat file document if necessary. and TN document type will all be unknown. and the resubmission will fail. the gateway service will not function as intended. For more information. If you include values for both processingRuleID and processingRuleName. By saving the name of the gateway service. If $receiveSvc is not set and you resubmit the document. If you use processingRuleID and that name is changed. thus eliminating the overhead of that lookup. This is an alternative to having Trading Networks automatically determine the content type and content encoding of the submitted flat file document.0 291 . $contentType and String (optional) The content type and encoding you want $contentEncoding Trading Networks to use for the flat file document.tn:receive. Trading Networks only uses the processingRuleID value. This is an alternative to having Trading Networks look up the appropriate rule. $receiveSvc String (optional) The fully-qualified name of the document gateway service you are creating. To determine the identifier. which will not be able to properly recognize the flat file document. Processing rule IDs cannot be changed. see “Bypassing Lookups for Processing Rules” on page 330.route:list service from Developer to return the name and ID of all your processing rules. 14 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. receiver. see “Determining the Content Type and Content Encoding” on page 287.tn.

Doing so eliminates the overhead of the search that Trading Networks would have to perform to find the matching TN flat file document type. Trading Networks ensures that the variable (key) is in the TN_parms regardless of its value. 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. Trading Networks ensures that the variable (key) is in the TN_parms variable and that it has the value that you specified. trying to find a matching document type for the document. At run time Trading Networks examines the contents of the TN_parms variable that the gateway service added to the pipeline.0 . In a document type you specify:  “Pipeline Matching Criteria Used to Identify the TN Document Type” on page 292  “Attributes To Extract From Documents” on page 293  “Pre-Processing Actions in the TN Flat File Document Type” on page 302 Pipeline Matching Criteria Used to Identify the TN Document Type In your TN flat file document type. If you specify both a key and a value.) 292 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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. For example. If you specify a key without a value. Specifying values for the variables is optional. (You could have omitted the Service_code value if you wanted to receive Billing department documents with any service code. you define a corresponding TN flat file document type that Trading Networks will use when it receives the document from the gateway service.14 Defining and Managing TN Flat File Document Types TN Flat File Document Types After you define a document gateway service. Then it searches the key/value pairs specified in the pipeline matching criteria of all your enabled TN flat file document types. 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 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.

you can transform extracted attribute values before Trading Networks stores them in the BizDocEnvelope. the document is considered to be an unknown type. Trading Networks does not extract any attribute values. In either of these cases. 14 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. 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. Continuing with the example document type Acme_XYZ_Invoices. You can extract system attributes as well as custom attributes (the document data). In addition. Trading Networks logs a message to the activity log that identifies all the TN document types that the document matched. Because TN document types indicate the system and custom attributes to extract.0 293 . When this happens. 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. using built-in or custom transformations. You can define processing rules that act on documents with an unknown TN document type. the document is considered to be an unknown type because Trading Networks does not know which of the matching TN document types to use. Trading Networks cannot extract any attribute values from the document because the TN document type is unknown. Because the TN document type is unknown. 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. 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] Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.  The data in the TN_parms pipeline variable matches the pipeline matching criteria in multiple document types. but that document type does not exist. In this situation.

For more information about the Execute a service processing actions. it records the error in the bizdoc/Errors variable. In this case. it completes processing (assuming it finds no errors) and sets the processing status to DONE.00 You can extract any of these attributes. process management. it will not log an error. Error Conditions When Extracting Attributes By default if Trading Networks cannot find a particular attribute for extraction. which is in the bizdoc variable  Puts the error into the activity log  Sets the processing status to DONE W/ERRORS.0 . For more information.14 Defining and Managing TN Flat File Document Types Attribute Value TN_parms/Department Billing TN_parms/Service_code XYZ TN_parms/Invoice_number 123 TN_parms/Amount 1000. This variable is in the pipeline and is available for your use when Trading Networks is processing the document. transaction analysis. Trading Networks always extracts the system attributes SenderID and ReceiverID. You extract system attribute values if you want to use them as criteria for determining the processing rule to use for a document. 294 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. In this case. such as DocumentID. 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. When Trading Networks is unable to extract a required attribute. see “Action 1—Execute a Service” on page 334. You can extract document data to perform any processing you want. Trading Networks:  Completes processing  Logs an error in the BizDocEnvelope. and more. If you want Trading Networks to log an error when it cannot extract particular attribute values. see “Document Recognition Errors Criterion” on page 326. is optional. you can designate those attributes as being required for extraction. see “System Attributes To Extract From Documents” on page 295. Extracting all other system attributes.  Use the processing rule’s Execute a service processing action to inspect the bizdoc/Errors variable for the errors that Trading Networks encountered. For more information. such as calculations.

there is a required external ID type (for example. when that partner’s client wants to send a flat file document to Trading Networks. if Retrieve SenderID from session is set to Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. If set. So. For example. it automatically transforms the externals ID in TN_parms/SenderID and TN_parms/ReceiverID into its internal IDs before storing them in the BizDocEnvelope. DUNS).  Use the identify of the sender and receiver of the flat file document in the logic of a business process. Trading Networks uses the connected user. On the Extract panel you must select from the pull-down list the type of the external IDs (for example. it must present credentials—it supplies user name 123456789 along with its password. For more information. DUNS) for both attributes so that Trading Networks can match the externals ID in TN_parms/SenderID and TN_parms/ReceiverID with the external IDs in the profiles. When Trading Networks finds a match. Reasons for extracting system attributes are discussed below. So. SenderID and ReceiverID Trading Networks always extracts both of these attributes. Trading Networks creates a user account on the Integration Server for that partner. see the Getting Started with BPM guide and the webMethods Designer Online Help. it had to present credentials—an Integration Server user name and password. Trading Networks always extracts SenderID and ReceiverID from TN_parms. see “Specifying the Document Gateway Services Outputs” on page 288.  Specify the sender and receiver as criteria for determining the processing rule to use for the flat file document. you can then set conditions on transitions in process model. For descriptions of system attributes.  Use the Retrieve SenderID from session option as an alternative way to set the value of the SenderID system attribute. That means that when the client sent the flat file document to Trading Networks. For more information about creating process models. Recall that when you create a profile. This is how Trading Networks verifies the identities of the sender and receiver.  Search for the flat file document in My webMethods or the Trading Networks Console by searching for documents with specific senders and receivers. you cannot delete them.0 295 . The user name is equal to the required external ID. see “Processing Rule Criteria” on page 322. That user name/password pair directly correlates to a Trading Networks partner. Extracting all other system attributes is optional. So. you can perform the following tasks. 14 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. if the required external ID is DUNS and a profile is added for a partner whose D- U-N-S number is 123456789. so the business process performs different logic based on the sender and receiver of a document. When Trading Networks has a value for the SenderID and ReceiverID. then that partner will have an Integration Server user account with the user name 123456789. When you create a profile. 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. rather than look in TN_parms\SenderID for the value to use.

If you do not want Trading Networks to pass the document to process management. that same processing rule will not be selected based on the Retrieve SenderID from session option. see “Checking for Duplicates of the Flat File Document” on page 303. the resubmit might fail. you can perform the following tasks. This is because when you resubmit the document from the Trading Networks Console. ConversationID You can use ConversationID to have Trading Networks pass the document to process management after it performs its own processing (e. 296 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.14 Defining and Managing TN Flat File Document Types true in a TN flat file document type.  Search for the flat file document in My webMethods or the Trading Networks Console by searching for documents with the specific document ID. the first time the document arrives. However. you can perform the following tasks. see “Processing Rule Criteria” on page 322. Important! When you resubmit a flat file document with the Retrieve SenderID from session option selected. For more information. that is. add a variable to the pipeline called prtIgnoreDocument with the value true. the actions identified by a processing rule)..  Determine whether the incoming flat file document is a duplicate. 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. and put that value in the BizDocEnvelope.  Specify the user status as a criterion for determining the processing rule to use for the flat file document. find the profile (and therefore the internal ID). UserStatus When Trading Networks has a value for UserStatus. For details. by checking the value of the document ID. You define the actions taken against a document during process management by creating a process model.0 . see the Getting Started with BPM guide and the webMethods Designer Online Help. For more information about creating process models.  Search for the flat file document in My webMethods or the Trading Networks Console by searching for documents with the specific user status. It could end up matching another processing rule and then go through completely different processing. If you set up Sender criteria in a processing rule. if you resubmit the document.g. DocumentID When Trading Networks has a value for DocumentID. the user is the IS user account that you used to log in to the Trading Networks Console (e.g. Administrator). determine whether Trading Networks has already received the document. Trading Networks would determine the sender of the document based on the user account 123456789.. which will not match sender 123456789 in the Sender criteria of the processing rule.

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. However. This is how Trading Networks verifies the identities of the sender and receiver. Built-In Transformations for STRING or STRING LIST Data Type Attributes For attributes with the data type STRING or STRING LIST. Alternatively. you can type the format you need. Trading Networks maintains a list of built-in common date/time formats from which you can select. use a pattern string based on the “Time Format Syntax” described for the java. You can have Trading Networks make a simple alteration to change the case of the extracted string values to all upper. if the date/time format you need to use is not in the list. When Trading Networks finds a match.text. you can specify whether you want Trading Networks to alter the string value before storing it. you can have Trading Networks use the extracted Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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.0 297 . To specify the date/time format. Trading Networks requires you to identify the date format.or all lowercase. Trading Networks extracts the value of the date and uses it and the pattern that you specify to decode the value and convert it to the format that Trading Networks requires to store the date in the BizDocEnvelope. 14 Defining and Managing TN Flat File Document Types GroupID When Trading Networks has a value for GroupID. 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. 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 297  “Built-In Transformations for DATETIME and DATETIME LIST Data Type Attributes” on page 297  “Built-In Transformations for STRING or STRING LIST Data Type Attributes” on page 297  “Built-In Transformations for NUMBER Data Type Attributes” on page 298  “Custom Transformation Services” on page 300 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. it automatically transforms the external IDs in TN_parms/SenderID and TN_parms/ReceiverID into its internal IDs before storing them in the BizDocEnvelope.SimpleDateFormat class.

text. {2}). Format Description Uppercase Stores the extracted string attribute value in all uppercase. use this field to specify the following string substitution pattern for itemName: “Item Name: {0}.g. the string that Trading Networks stores for the attribute will contain the extra arguments (e. {1}. String Substitutes extracted values with a pattern that you specify.. If you do not specify transformation information for a string attribute. WidgetC If you place more arguments in the pattern than values that Trading Networks extracts. if the attribute value is “Purchase Order”. Trading Networks stores “PURCHASE ORDER” for the attribute value. 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: 298 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. “WidgetB”. {2}” Trading Networks would store the following for the value of itemName: Item Name: WidgetA. For example. the string that Trading Networks stores for the attribute will not contain all the extracted values. To do this. it will only contain the values for the number of arguments you specify in the pattern. Trading Networks saves the data exactly as it extracted it.0 . For example.MessageFormat class to perform this transformation.14 Defining and Managing TN Flat File Document Types values as substitutions in a string that you supply. Built-In Transformations for NUMBER Data Type Attributes You can specify an attribute with the NUMBER data type that contains an array of numbers. WidgetB. if the extracted attribute value is “Purchase Order”. Following are descriptions of the built-in transformation options for string attributes. “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. For example. If you specify less arguments in the pattern than values that Trading Networks extracts. 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”. Trading Substitution Networks uses the java. Trading Networks stores “purchase order” for the attribute value. Lowercase Stores the extracted string attribute in all lowercase.

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

otherwise it will be true. arg Optional arguments that you can define. isArray will be false if values contains a single value. For more information.tn. any element in the values array can be null or an empty string.tn. Note: The values might be null or an empty (zero length) string. NUMBER or The service must implement the input and output variables NUMBER LIST defined in the wm. isArray Whether values contains a single value to transform or multiple values to transform. Trading Networks passes the following input variables: Input Value Meaning values One or more values for your service to transform.14 Defining and Managing TN Flat File Document Types and Trading Networks will store the value 14 for totalQuantity.g. 300 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8..tn. DATETIME LIST). Make sure that your custom transformation service can handle null values or empty strings. use webMethods Developer and look in the WmTN package. For an array data type (e.rec:NumberAttributeTransformService specification. To view these specifications.rec:DateAttributeTransformService specification.0 . 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. see the webMethods Trading Networks Built-In Services Reference.rec:StringAttributeTransformService specification. STRING or The service must implement the input and output variables STRING LIST defined in the wm. Custom Transformation Services Trading Networks allows you to create your own service to perform transformations on extracted attributes.

14 Defining and Managing TN Flat File Document Types 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. For information about creating a service. You might want to disable processing if the document is to be processed as part of a business process.  When processing rule routing is enabled. however. which in turn will determine the process model to use to process the document. if you are transforming string data. For example. if the TN document type instructs Trading Networks to set the value of the ConversationID system attribute. Your service should transform the single item and save just a single item in the output variable newValues. disabling routing can improve performance because Trading Networks will not use processing time to search for a processing rule. If the input variable isArray is false. It should store each as an item in the output variable newValues. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.  When processing rule routing is disabled. newValues is a Date List of the transformed Strings. nor does it perform any processing rule actions. it does not search for a processing rule. 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.0 301 . Even when processing rule routing is disabled. If the input variable isArray is true (meaning multiple values). 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. see Developing Integration Solutions: webMethods Developer User’s Guide. Trading Networks performs the pre-processing actions defined by the TN document type. Trading Networks will pass the document to the Process Engine. If you do not want Trading Networks to perform processing rule actions. the input variable values will contain only a single item to transform. your service should loop through the items in the values variable and transform each one.

2 Adds the error information to the BizDocEnvelope in the pipeline variable bizdoc/Errors. 302 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Create this service in any user-defined package. you can specify whether to use the pre- processing actions specified in the processing rule. Note: Additionally. you can specify this same set of pre-processing actions in a processing rule. In the processing rule. Trading Networks: 1 Performs the remainder of the pre-processing actions you specified (if any). if you selected the Save Document to Database pre-processing option and the Activity Log option.0 .rec:BizDocVerificationService (described in the webMethods Trading Networks Built-In Services Reference). Trading Networks executes them in the following order:  “Verifying the Digital Signature of Flat File Documents” on page 302  “Validating the Structure of Flat File Documents” on page 302  “Checking for Duplicates of the Flat File Document” on page 303  “Saving Flat File Documents to the Database” on page 304 These actions are provided as built-in options on the Options tab in the TN document type’s definition. If the digital signature is invalid.tn. 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. see “Pre-Processing Actions” on page 331. For details. 4 Performs the processing actions specified in the processing rule.14 Defining and Managing TN Flat File Document Types 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. 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. Then you can map information from the converted document to the TN_parms variable. To do this. or to use the ones specified in the document type. and converts the flat file document to an IS document. 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. All actions are optional. using the inputs and outputs specified in wm. This enables you to overwrite the pre-processing actions. 3 Logs the error to the activity log. which your processing rule can access.

If you convert a document in the gateway service. You only need to specify a flat file schema if you want to validate the structure of the document. Trading Networks provides the following Check for Duplicate Document options on the Options tab in the TN document type’s definition. if you selected the Save Document to Database pre-processing option and the Activity Log option. and saves the parsed contents if you selected the keepResults option. If the document structure is invalid. 2 Adds the error information to the BizDocEnvelope in the pipeline variable bizdoc/Errors.flatfile:convertToValues. Trading Networks: 1 Performs the remainder of the pre-processing actions you specified (if any). Note: Alternatively. The Input for Flat File Validation dialog prompts you to select the parsing settings.  Specify the name of the TN document type’s flat file schema in the Parsing schema option. use the Options tab in the TN document type’s definition to:  Select the Validate Structure option. 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 288). 14 Defining and Managing TN Flat File Document Types Important! Perform this action only if absolutely necessary because parsing can be time-consuming and return very large outputs that consume much memory. This service invokes the flat file parser to validate the document’s structure and content. Trading Networks will save the parsed contents if you select the keepResults option. 3 Logs the error to the activity log. it will remain in the pipeline. as described in the Flat File Schema Developer’s Guide. you can create your own service to be executed in the document type.0 303 . Do not convert a document in both locations. To check for a duplicate document using the document ID. Alternatively.) At run time. which is a service in the WmFlatFile package (see the Flat File Schema Developer’s Guide). based on the flat file schema that you named in the Parsing schema option. (You create flat file schemas in webMethods Developer. 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. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. you must instruct Trading Networks to extract the DocumentID system attribute from the document. which your processing rule can access. To implement this action. the Validate Structure option invokes pub. 4 Performs the processing actions specified in the processing rule.  Document ID only—Trading Networks assures that it does not already have a document with the same document ID in its database.

but the document type Extract panel information did not indicate to save the DocumentID. you must instruct Trading Networks to extract the DocumentID and SenderID system attributes from the document.  Document ID. sender.14 Defining and Managing TN Flat File 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. and receiver. Saving Flat File Documents to the Database This action saves a copy of all documents or only unique documents to the database.  Trading Networks previously received a document and saved it to the database. You must save documents to the database if you want to use reliable delivery or scheduled delivery to deliver the document. Additionally. 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. 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 304). so you can use it in the processing rule.  Trading Networks was unable to match the document to a TN document type. and receiver in its database. depending on its logic. see “Creating a Duplicate Document Check Service” on page 333. and/or ReceiverID system attributes. SenderID. To create a custom duplicate document check service.0 . and TN document type in its database. To check for a duplicate document using the document ID. Trading Networks saves the results of the duplicate check to the pipeline. sender. SenderID.  Document ID. see “Using Reliable Delivery with Immediate Delivery Method” on page 346 and “Using Reliable Delivery with Scheduled Delivery” on page 347. you must instruct Trading Networks to extract the DocumentID. SenderID.  Trading Networks previously received a document and saved it to the database. To check for a duplicate document using the document ID and sender. sender. 304 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. and/or ReceiverID system attributes. Trading Networks uses the results of the duplicate check in the Save Document to Database pre-processing action. sender and receiver—Trading Networks assures that it does not already have a document with the same document ID. sender and document type—Trading Networks assures that it does not already have a document with the same document ID. but the document gateway service did not supply values in the pipeline for DocumentID. and ReceiverID system attributes from the document. Note: A custom duplicate checking service can affect performance. For more information.

and perform the process actions identified in that matching rule. Trading Networks considers the document as having no duplicate and will save the document to the database. However.e. Instead. Trading Networks will bypass reliable delivery and invoke the specified delivery service once.attempt. you will not be able to search for documents based on the attribute values because their values were not saved to the database. Content  If you use the Deliver Document actions.  You will not be able to resubmit or re-process the document.  In My webMethods or Trading Networks Console. You can save a copy of the document content.task. and/or activity log information to the database. Trading Networks will not use reliable delivery or scheduled delivery. The following table displays the consequences of not saving specific parts of documents: If you do not save this.  Only unique documents..attempt. Attribute  You will not be able to view custom attributes when monitoring transactions using My webMethods or Trading Networks Console (i.. Trading Networks will not match processing rules that use extended criteria. attributes will contain only information for system attributes). For more information. You must also select the Check for Duplicate Document pre-processing option (see “Checking for Duplicates of the Flat File Document”).  No documents. Then the consequences of not saving are.  You might get different or unexpected results when you reprocess a document. Trading Networks will match to another processing rule. Trading Networks does not perform document recognition again and therefore does not re-extract the attributes. Because the attributes are not saved when you reprocess the document.0 305 .notPersisted” on page 489.. 14 Defining and Managing TN Flat File Document Types You can choose to save:  All documents. If you fail to select the Check for Duplicate Document option. for example the default processing rule. attributes. see “tn.. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.  If Trading Networks is to use a delivery option that requires document content to be saved. but only if the Trading Networks property tn. regardless of whether they are unique.task. you can still use the processing rules extended criteria for the document..notPersisted is set to true (the default).  You will not be able to view content when monitoring transactions using My webMethods or Trading Networks Console.

When Trading Networks resubmits a document. 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.  You will not be able to view the activity log entries when managing the activity log using My webMethods or Trading Networks Console.14 Defining and Managing TN Flat File Document Types If you do not save this. 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.. Then the consequences of not saving are. see the Getting Started with BPM guide and the webMethods Designer Online Help. Note: You can still resubmit a document. 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.. Activity Log  You will not be able to view activity log entries when monitoring transactions using My webMethods or Trading Networks Console. For more information about process management. Trading Networks passes documents on to process management if it extracted a conversation ID from the document.0 . 306 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. it performs document recognition and therefore extracts the attributes again.

7 Click the Identify panel to specify the criteria that Trading Networks will use to match flat file documents to the TN document type. 5 Optionally. You can update any or all fields 3 Select Types > Duplicate. 4 In the Name field (required). 4 Click OK. see “Pipeline Matching Criteria Used to Identify the TN Document Type” on page 292. duplicate. 2 Select Types > New. Note: You must specify at least one attribute.0 307 . type the name you want to give the TN flat file document type. perform one of the following procedures to start a new TN flat file document type. For details about the information you specify on this panel. a In the Pipeline Matching section. click Add New Pipeline Match. Method to start a TN document type Procedure to perform New— The TN flat file document 1 Select View > Document Types. type fields are empty. Duplicate— The TN flat file 1 Select View > Document Types. 6 Click the Configure tab. 3 Select Flat file for the TN document type category. otherwise Trading Networks will not use the TN document type. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. document type fields are filled with 2 Click the row containing the TN flat file values from the TN flat file document type that you want to document type that you duplicate. 14 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. from the duplicated TN flat file document type. type a description for the TN document type in the Description field. b Specify the following values in the Add Pipeline Matching dialog box.

For more information. see “Attributes To Extract From Documents” on page 293. To view more details about all of the document attributes. The data type of the attribute (shown in the Type field) determines the Built-in or Custom 308 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. The value of the TN_parms variable. Trading Networks displays the Add an attribute dialog box. a Add an attribute to extract by clicking Add New Attribute. Trading Networks finds a match only if the variable has the specified value. b In the Name field. d Use the Retrieve SenderID from session option as an alternative way to set the value of the SenderID system attribute. see “System Attributes To Extract From Documents” on page 295.14 Defining and Managing TN Flat File Document Types Attribute Specify Name Name of the TN_parms variable. rather than look in TN_parms\SenderID for the value to use. Note: If you do not mark an attribute as required. Note: Trading Networks always designates SenderID and ReceiverID as required. You cannot delete them. Note: Trading Networks always lists SenderID and ReceiverID as attributes to be extracted. Trading Networks uses the connected user. click Document Attributes to view the Document Attributes screen. If Trading Networks completes processing without encountering any further errors. Trading Networks will not have this information available for processing rules or querying documents. Trading Networks fills in the Type field based on the document attribute definition. Value Optional. e Use the Transformation fields to specify how Trading Networks is to handle attribute data before storing it in the Trading Networks database. If set. Trading Networks does not flag an error if it is unable to extract the attribute. select the name of the attribute from the list.0 . specify the system attributes and document attributes (document data) that you want Trading Networks to extract from documents. c Click OK to save the attribute and close the Add Pipeline Matching dialog box. c Select the Required check box if you want Trading Networks to throw an error when it cannot extract the attribute. If you specify a value. Important! If you do not extract the system attributes. For details about what to specify for these fields. it sets the processing status to DONE. 8 In the Extract panel.

DUNS) for both attributes so that Trading Networks can match the externals ID in SenderID and ReceiverID with the external IDs in the profiles. see “Transformation Information for Extracted Attributes of TN Flat File Document Types” on page 297. Has NUMBER or NUMBER You should specify the operation that Trading LIST data type Networks should perform on the numbers in the array. Has STRING or STRING You can specify whether you want Trading LIST data type (but not Networks to alter the string value to all SenderID or ReceiverID) uppercase or all lowercase before storing it. For more information.  Built-in. Alternatively. This is how Trading Networks verifies the identities of the sender and receiver. Has DATETIME or You must specify a date format. you can have Trading Networks use the extracted values as substitutions in a string that you supply. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. When Trading Networks finds a match.0 309 . For more information. For more information. it automatically transforms the external IDs in TN_parms/SenderID and TN_parms/ReceiverID into its internal IDs before storing them in the BizDocEnvelope. see “Built-In Transformations for NUMBER Data Type Attributes” on page 298. Select a built-in DATETIME LIST data type format or type in your own. see “Built-In Transformations for DATETIME and DATETIME LIST Data Type Attributes” on page 297. 14 Defining and Managing TN Flat File Document Types transformation options available. Use the Transform and Argument fields to specify how you want to handle attribute data before storing it in the Trading Networks database. For more information. see “Built-In Transformations for STRING or STRING LIST Data Type Attributes” on page 297. Select a built-in transformation provided by Trading Networks. If the attribute data type… For Transformation… Is SenderID or ReceiverID You must select from the pull-down list the type of the external IDs (for example.

select the attribute row and click Delete attribute. For details. For more information. 310 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 . . Trading Networks displays the name of the extracted attributes and their built-in or custom transformation services. see “Pre-Processing Actions” on page 331. To do this… Perform this… Create a new custom transformation Click New Service. Note: To delete an attribute from the TN document type. Trading Networks returns to the Extract panel of the Document Type Details screen. Select or create your own service to perform custom transformations on extracted attributes. Select an existing custom transformation service Click Find Service to browse the IS namespace to locate the one you want to use. 9 Click the Options tab and specify any of the options. see “Custom Transformation Services” on page 300. from the selected service Edit an existing service Click on the Edit Service button. 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. Set the inputs of the transformation Click Set Inputs. f Click OK to save the new attribute and close the Add an attribute dialog box. 14 Defining and Managing TN Flat File Document Types  Custom.

see “Disabling Processing Rule Routing” on page 301.0 311 .rec:BizDocVerificationService (described in the webMethods Trading Networks Built-In Services Reference). For more information. The Input for Flat File Validation dialog box prompts you to select the parsing settings. Then you can map information from the converted document to the TN_parms variable. 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. see “Validating the Structure of Flat File Documents” on page 302. For more information. see “Validating the Structure of Flat File Documents” on page 302. click Find schema to browse flat file schemas to locate the one you want to use. For more information. select either Enable routing or Do not enable routing. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks executes pre-processing this pre-processing action before executing the processing rule action that you associate with the TN document type. see “Verifying the Digital Signature of Flat File Documents” on page 302. Trading Networks executes this pre-processing action before executing the processing rule that you associate with the TN document type. For more information. Processing Rule Indicates whether you want Trading Networks to search for a Routing processing rule and process the document based on the processing rule. Create the verification service in any user-defined package. 14 Defining and Managing TN Flat File Document Types 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. using the inputs and outputs specified in wm. and converts the flat file document to an IS document. You only need to specify a flat file schema if you select the Validate Structure pre- processing option.tn. If you do not know the fully qualified name. Verify Digital Executes a user-defined verification service to verify the Signature digital signature of the documents.

attributes.0 . Trading Networks executes pre-processing this pre-processing action before executing the processing rule action that you associate with the TN document type. see “Checking for Duplicates of the Flat File Document” on page 303. 10 Click OK to create the TN flat file document type. see.. For more information. specify whether to preprocessing save the document’s content. To select an existing duplicate service. Note: A custom duplicate checking service may affect performance. “Viewing TN Flat File Document Types” 313 “Updating TN Flat File Document Types” 313 “Disabling TN Flat File Document Types” 315 “Enabling TN Flat File Document Types” 315 312 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For more information. only unique Database documents. Save Document to Specify whether to save all documents. To create a new custom service click New Service. see “Saving Flat File Documents to the Database” on page 304. and/or activity log action information. Select a built-in service or use a custom service. Managing TN Flat File Document Types The following table lists the tasks you can perform against TN flat file document types: Task See page. depending on its logic. click Find Service to browse the IS namespace to locate one and then click Edit Service if you want to modify the service. Trading Networks executes this pre-processing action before executing the processing rule that you associate with the TN document type.14 Defining and Managing TN Flat File Document Types Options tab parameter Description Check for Duplicate Searches the database to determine whether the database has Document already received the document. Additionally.. or no documents. For details. “Creating a Duplicate Document Check Service” on page 333.

3 Select Types > Edit. 2 To view disabled TN document types. To view TN flat file document types 1 In Trading Networks Console: View > Document Types.0 313 . click on the Identify panel. For details about the what to specify on this panel. type a new description in the Description field. 2 Click the row containing the TN flat file document type you want to update. 3 To hide disabled TN document types. Trading Networks displays all TN flat file document types as well as the TN XML document types. select Types > Show All. To update a TN flat file document type 1 In Trading Networks Console: View > Document Types. Trading Networks removes the check () next to the Show All menu item to indicate that Trading Networks is currently not displaying disabled TN document types. see “Pipeline Matching Criteria Used to Identify the TN Document Type” on page 292.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. 14 Defining and Managing TN Flat File Document Types Viewing TN Flat File Document Types You can view all enabled and disabled TN document types. Trading Networks places a check () next to the Show All menu item to indicate that it is currently displaying disabled TN document types. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 5 To update identification information. Trading Networks displays the TN flat file document types as well as the TN XML 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 -. 4 To update the description. select Types > Show All again.

 To select a system attribute to extract. see step 4 on page 212.14 Defining and Managing TN Flat File Document Types  To add a pipeline matching variable.  To delete a pipeline matching variable. 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.  To view more details about all of the document attributes. click the row containing the pipeline matching variable you want to delete and click Remove Selected Pipeline Match. 8 To update custom attribute information. Note: The SenderID and ReceiverID are always selected. see Chapter 12.  To update a custom attribute. For a summary of actions you can take for custom attributes. click Add New Pipeline Match. For more information about document attributes. Click OK to save the variable and close the dialog box. For a summary of actions you can for take for adding a new custom attribute.  To deselect a system attribute. see “Attributes To Extract From Documents” on page 293. click Add New Attribute. see step 4 on page 212. see step 8 on page 308.  To delete a custom attribute from the TN document type—Select the row for the attribute and click Remove Selected Attribute. click on the System Attributes tab. In the Update Pipeline Matching dialog box.0 . deselect the appropriate check box in front of the attribute name. Custom attributes are the user-defined ones on the Document Attributes screen. For details about what to specify for these fields. 7 To update the system attributes. click Edit Selected Attribute.  To update a pipeline matching variable.  To add a custom attribute. select the appropriate check box in front of the attribute name. click Document Attributes to view the Document Attributes screen. click the Extract panel. Click OK to save your updates and close the Update Pipeline Matching dialog box. see “System Attributes To Extract From Documents” on page 295. click the row containing the pipeline matching variable you want to update and click Edit Selected Pipeline Match. 6 To update extraction information. 314 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For details about what to specify on this panel. click on the Custom Attributes tab. “Defining and Managing Document Attributes”. update the Name and Value fields for that variable. Then. add a new custom attribute.

you can enable it and make it available again. the definition for the TN document type is not removed from the database. 10 After you have made all your changes. click the Options tab. Enabling TN Flat File Document Types If you disable a TN document type and then later determine that you still need it. Important! To enable TN document types. Trading Networks closes the screen. For details about these fields. see “Pre- Processing Actions in the TN Flat File Document Type” on page 302. 14 Defining and Managing TN Flat File Document Types 9 To update options. You can enable it later (see “Enabling TN Flat File Document Types” on page 315). select Document Types > Show All.0 315 . 2 Click the row containing information about the TN flat file document type that you want to disable. Note: To view the Enabled column (if it is not currently displayed). 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. Disabling TN Flat File Document Types If you no longer want Trading Networks to use a TN document type. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. you can disable it. 3 Select Types > Disable. Trading Networks places No in the Enabled column to indicate that the TN flat file document type is disabled. you must first display inactive TN document types as described in “Viewing TN Flat File Document Types” on page 313. Note: To permanently remove the TN document type from the database. To disable a TN flat file document type 1 In Trading Networks Console: View > Document Types. click OK. When you disable a TN document type. Trading Networks displays both the TN XML document types and TN flat file document types.

Trading Networks places Yes in the Enabled column to indicate that the TN document type is enabled. 3 Select Types > Enable. Trading Networks displays both the TN XML document types and TN flat file document types.14 Defining and Managing TN Flat File Document Types To enable a TN flat file document type 1 In Trading Networks Console: View > Document Types. 316 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 . 2 Click the row containing information about the TN document type that you want to enable.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15 Defining and Managing Processing Rules  What are Processing Rules? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327  Pre-Processing Actions . . . 372 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . . . . 350  About Querying and Viewing Processing Rules . . .0 317 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331  Processing Rule Actions . . . . . . . 333  Defining Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366  Managing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318  Processing Rule Criteria . . . . . . . . . . . 322  Extended Criteria—Using Custom Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318  Processing Rules Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

For more information about how to configure Trading Networksfor a clustered environment. see “Shared Trading Networks Database in a Clustered Environment”. Trading Networks maintains the order of the processing rules by assigning an ordinal to each processing rule. For example. After Trading Networks finds the appropriate processing rule for a document.15 Defining and Managing Processing Rules What are Processing Rules? Processing rules specify how you want webMethods Trading Networks (Trading Networks) to process documents. it takes the actions that you specify in a processing rule. After Trading Networks locates the appropriate processing rule. the order in which you list your processing rules on the Processing Rules screen is important.remoteAliases property correctly.cluster.  Large document handling. the servers must set the tn. and then deliver the document to the receiver that is identified in the document. Processing Rules Order If a document matches more than one processing rule. As a result. Note: If you are working in a clustered environment. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. thus avoiding the overhead of the lookup (see “Bypassing Lookups for Processing Rules” on page 330). For more information about:  Processing rules. 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. Alternatively. For each document that Trading Networks is to process. “Large Document Handling”. you can bypass the lookup if you already know which processing rule you want to execute. it performs a processing rule lookup to determine which processing rule to use for a specific document. You can specify pre-processing actions in both the TN document type and the processing rule. That is. all Trading Networks servers must be set up for cluster synchronization. you might want Trading Networksto send an alert e-mail message to a contact. and delivery methods you can use with Trading Networks. The actions you specify in the processing rule can be configured to override the actions that are specified in the TN document type. Trading Networks uses the first processing rule it encounters. The pre-processing actions identify actions that Trading Networks performs before performing the processing actions.0 . 318 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide and Appendix F. Adding Processing Rules and the Order of Processing Rules When you add a new processing rule. it performs the pre-processing and processing actions.sync.

unfiltered rules list. Below— Add a new processing  The new processing rule is assigned the rule below the highlighted rule. Example: The following diagrams demonstrate what happens if you highlight Processing Rule B. 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. all of the processing rules). 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. 15 Defining and Managing Processing Rules Note: If you are working with a queried list of processing rules.  All existing processing rules below the highlighted processing rule keep their respective order. but they are assigned their original ordinal + 1. Ordinal 12 as the rule to add your new processing rule in relation to. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. If you add a new processing rule using this option. original ordinal of the highlighted rule.. highlighted rule’s original ordinal + 1.g. ordinals. place it here (last)  All other processing rules keep their original in the list. 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.. processing rule. Above— Add a new processing  The new processing rule is assigned the rule above the highlighted rule.  The highlighted processing rule keeps its original ordinal. unfiltered list of processing rules (e... remember that Trading Networks adds the new rule to the full..  The highlighted processing rule is assigned its original ordinal + 1..0 319 .  All existing processing rules below the highlighted processing rule keep their respective order but are also assigned their original ordinal + 1. If you set up a default list of processing rules. The processing rules reorder in this way.

15 Defining and Managing Processing Rules Add Processing Rule ABOVE Processing Rule B. Ordinal 12 Add new rule BELOW Processing Rule B.0 . Ordinal 12 The new rule is ABOVE Processing Rule B and is now Ordinal 12 Processing Rule B is now Ordinal 13 Add Processing 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 320 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Ordinal 12 Add new rule ABOVE Processing Rule B.

Keep rules with specific criteria before rules with general criteria. unfiltered list of processing rules (e.. Ordinal15) Default rule remains The new rule is LAST. Ordinal 15 and is now below the Default rule Reordering Processing Rules You can reorder the processing rules by moving them up or down. Note: If you reorder processing rules. unfiltered processing rules list. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. there is no “undo” function that will return the processing rules to their original order. 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. When you reorder a processing rule. Ordinal 16. For more information about the default processing rule. see “Setting Up a Default Processing Rule” on page 363. Place the default processing rule in the last position of the full.0 321 .g. Trading Networks ships with a default processing rule that you can use. all of the processing rules). remember that Trading Networks adds the new rule to the full. Trading Networks reassigns the ordinal number for your selected processing rule and all affected processing rules. If you are working with a queried list of processing rules. 15 Defining and Managing Processing Rules Add Processing LAST Add new rule LAST (below the Default rule. Adding a new processing rule and causing the processing rule order to change may also affect the ordinals of the rules that are not displayed on your query results table.

15 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. To process a document based on sender/receiver. have a specified TN document type. you might set up the following criteria: Criterion Value(s) To match. All processing rule criteria that you specify must match the document information for Trading Networks to use the rule to process the document. A document has a sender. 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. unfiltered processing rules list. and the extracted custom attribute “Total PO Amount” is greater than 10000.0 . 322 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. TN document type. For more information about ordering processing rules. As another example. You can select one or more partners and/or one or more partner groups to be a sender or receiver. You can set up a processing rule to match one or more of these criteria. Trading Networks ships with a default processing rule that you can use. user status. the possibility of having errors. you must specify that you want Trading Networks to extract the SenderID and ReceiverID system attributes from the document. Sender “Any” The sender can be any value Receiver “XYZ Steel Company” The receiver must be “XYZ Steel “United 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. see “Processing Rules Order” on page 318. After Trading Networks recognizes the TN document type. Place the default processing rule in the last position of the full. and the custom attributes that the TN document type instructed Trading Networks to extract.. you can specify that a processing rule is to apply to documents that have specified senders and receivers. For example.. For more information about the default processing rule. The rest of this section describes the types of criteria you can specify in a processing rule. receiver. it extracts the document attributes that are specified in the TN document type. see “Setting Up a Default Processing Rule” on page 363. Sender and Receiver Criteria You can use the sender and/or receiver of a document as criteria in a processing rule.

Because it is the TN document type that specifies the attributes to extract. when the TN document type is not recognized.  The XQL query (in the TN document type) that identifies the location of the SenderID/ ReceiverID system attributes is not valid. 15 Defining and Managing Processing Rules If Trading Networks cannot determine the sender/receiver of a document. XYZ Steel Company). Trading Networks uses the unknown partner for a document in all the following situations:  The TN document type is unknown. it considers the sender/receiver an unknown partner. XYZ Steel Company). Trading Networks uses Unknown for the sender. If a document was sent by one of your partners (for example. but Trading Networks cannot determine the sender for one of the above reasons. If you have a processing rule that processes documents that are sent by this partner (for example. 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 Trading Networks successfully extracts the SenderID/ ReceiverID system attributes from a document and can match it to a partner profile on your Trading Networks system.  The TN document type does not instruct Trading Networks to extract the SenderID and ReceiverID system attributes. 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. If you specify this… The rule matches… Any Senders Regardless of the partner that is identified as the sender/receiver in of the document. 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 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks compares the name of the partner (or unknown) to the partner or partners that you specify in the processing rule.0 323 . Trading Networks cannot extract any attributes (including SenderID and ReceiverID). it uses the corporation name and unit name specified in the partner profile as the name of the sender and/or receiver.  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 will not select the rule because it is using the unknown partner for the sender.

wm.db. the document is considered an unknown TN document type.String)  The built-in service wm.tn. If a document does not match any TN document type or if it matches multiple TN document types.app.BizDocEnvelope. Trading Networks determines the TN document type that matches the document.changeStatus(BizDocEnvelope.setUserStatus(String)  com. The user status is a status that you can associate with a document. Trading Networks sets the TN document type of the document to the name of the matching TN document type. it must first attempt to recognize the type of document. You can set and change the user status using the following:  The following Java methods that are in the Trading Networks Java API:  com.String.wm. If you do not extract the User Status system attribute from a document. 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.tn.BizDocStore. 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.0 . To do this.app. its initial value will be null.15 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.doc. When Trading Networks has a document that it needs to process.doc:changeStatus  Processing action that changes the user status The following shows an example of using user status criteria during processing: 324 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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.tn.

If the user selects Accept. the code uses the built-in service to set the user status associated with the document to “rejected”. The alert e-mail contains a URL for a web page that displays the PO. When the user selects either button. The processing rule also changes the user status to “pending approval”.0 325 . 15 Defining and Managing Processing Rules User Status and Processing Integration Server Processing Rule TN document type = PO user status = accepted Service 6 Processing Rule handles POs TN document type = PO user status = rejected PO 1 Processing Rule TN document type = PO 2 user status = any TN document type = PO user status = null To: 3 P From: Subject: Accept Reject http://tn:5555/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. 3 The user clicks the URL to open the web page to view the PO. 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.” If the user selects Reject.doc:changeStatus to set the user status associated with the document to “accepted.dsp Set user status to “accepted” Set user status to “rejected” 4 PO 5 Step Description 1 Trading Networks receives a document and recognizes that its TN document type is PO. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.tn. code executes. The processing action in this rule indicates Trading Networks is to send an alert e-mail. The user status is originally null because Trading Networks was not instructed to extract the User Status system attribute. 4 The user selects either Accept or Reject. the code uses the built-in service wm.

326 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Conversely. which is either “accepted” or “rejected. Similarly. Another example is if the document is identified as an XML document but is actually another format.” This processing action in these rules indicates Trading Networks is to invoke a service. Trading Networks recognizes the TN document type is PO and determines the user status. Trading Networks flags 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 error occurs when the document is identified as an XML document but contains invalid XML. For example.0 . for example plain text or EDI. (This criterion does not allow you to process documents based on errors that occur while performing the pre-processing or processing actions.) Trading Networks flags a general error if an identifying XQL query in the TN document type failed. 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.tn:submit built-in service that sends the document back to the Integration Server for processing. 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.” 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. 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. 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. you can also use this criterion to set up processing rules that specifically handle error cases.15 Defining and Managing Processing Rules Step Description 5 The code for the web form invokes the wm. This service processes the purchase order appropriately. This is because Trading Networks uses criteria before processing to determine the processing rule to use for processing. This processing criterion is useful to assure that processing occurs only if no errors were encountered during document recognition.

you can match a document based on whether the custom attribute value is null or not null. The operator you can specify depends on the data type of the custom attribute. For example. Total PO Amount. When you use extended criteria.  Operator instructs Trading Networks how to match the value. 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. Shipping Date. the value of the custom attribute will be null. you might want to process purchase orders for an amount over $10. For each custom attribute that you want to use in the extended criteria. You can specify any attribute that is defined to your system. from a document. or match date values before a specified date. 15 Defining and Managing Processing Rules 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. If the XQL query for the custom attribute is not valid or it identifies a node that is not in the document. you can use the extended criteria to match if Shipping Date is equal to a date you specify. For example. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. for example. match number values that are greater than a specified value. it extracts the custom attributes that are specified in the TN document type. you specify the attribute name. If you extract a custom attribute. if the value is not null. if you have Trading Networks extract the custom attribute.000 differently from purchase orders with an amount under $10. an operator. you can match based on the value that Trading Networks extracted for the custom attribute.  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. and the value the attribute should have. In addition. match string values that contain specified characters.0 327 .000.

Equals Matches exactly the value that you specify. You do not need to specify a value when you specify this operator. NUMBER Is null Has no value. You do not need to specify a value when you specify this operator. Equals Matches exactly the value that you specify. Less than or Has a value that is less than or equal to the value equals that you specify. 328 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. You do not need to specify a value when you specify this operator. Less than Has a value that is less than the value that you specify. You do not need to specify a value when you specify this operator. You do not need to specify a value when you specify this operator. Greater than Has a value that is greater than the value that you specify. Is not null Has any value. The attribute has no value if the XQL query for the custom attribute (in the TN document type) did not identify a node in the document. Is not null Has any value. Not equals Has a value that does not match the value that you specify. Is not null Has any value.0 . STRINGLIST Is null Has no value. Includes Includes the value that you specify. The attribute has no value if the XQL query for the custom attribute (in the TN document type) did not identify a node in the document.15 Defining and Managing Processing Rules 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 (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. Contains Contains the character string that you specify for the value.

DATETIME Is null Has no value. Is not null Has any value. Even when a document contains the attribute information that you specify. After Is a date that is after the date that you specify. DATETIMELIST Is null Has no value. Includes Includes the value that you specify.0 329 . 15 Defining and Managing Processing Rules Data Type Operator Matches when the attribute extracted from a document… NUMBER Greater than Has a value that is greater than or equal to the (continued) or equals value that you specify. Is not null Has any value. The following lists reasons this might occur: Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks might still have a null value for the attribute. instructs Trading Networks how to match documents based on the value of the attribute extracted from the documents. 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. Not equals Has a value that does not match the value that you specify. The attribute has no value if the XQL query for the custom attribute (in the TN document type) did not identify a node in the document. You do not need to specify a value when you specify this operator. You do not need to specify a value when you specify this operator. Before Is a date that is before the date that you specify. You do not need to specify a value when you specify this operator. The attribute has no value if the XQL query for the custom attribute (in the TN document type) did not identify a node in the document. You do not need to specify a value when you specify this operator. You do not need to specify a value when you specify this date list. Is not null Has any value.  Value along with the operator. You do not need to specify a value when you specify this operator. Equals Matches exactly the value that you specify. NUMBERLIST Is null Has no value.

for example the default processing rule. Trading Networks returns specific values for different attribute data types. thus bypassing the lookup (and its overhead). Trading Networks only selects the processing rule if all the criteria you specify match. For more information about these extraction values. If you reprocess a document.0 .) Note: For custom attributes that are extracted from an XML 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. Bypassing Lookups for Processing Rules As previously mentioned. see Managing B2B Integrations: webMethods Trading Networks User’s Guide. (Trading Networks does not extract attributes for unknown TN document types.15 Defining and Managing Processing Rules  The XQL query for the custom attribute (in the TN document type) did not identify a node in the document. Instead. Trading Networks does not save the custom attributes. Note: If the pre-processing actions do not indicate that Trading Networks is to save the attributes. see “Disabling Processing Rule Routing” on page 242 and “Disabling Processing Rule Routing” on page 301. For more information about reprocessing a document. Trading Networks will not match processing rules that use extended criteria. Skip Processing Rule Actions You can define a TN document type so that it disables processing rule processing.  You can explicitly specify which processing rule to execute for a given document type. it performs a processing rule lookup to determine which processing rule to use for a specific document. see “Pre-Processing Actions” on page 331. and perform the process actions identified in that matching rule. for each document that Trading Networks is to process. For more information. Trading Networks does not recognize the TN document type again and therefore does not re-extract the attributes. For more information about the pre- processing actions.  The TN document type of the document is unknown. Trading Networks will match to another processing rule. You can specify multiple custom attributes in the extended criteria. However. 330 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. you can still use extended criteria for the document. If you reprocess a document for which Trading Networks did not save the attributes. see “Extracting Custom Attributes From XML Documents” on page 505.

Trading Networks matches the certificate from the digital signature to the certificate that Trading Networks has on file for the partner. Pre-Processing Actions Trading Networks performs pre-processing actions before it processes the document using the processing rule actions. see “Specifying the Document Gateway Services Outputs” on page 288. To find this identifier. rule 2 will discard the order. processingRuleID is used.route:list service. Trading Networks assures the signed body has not changed by verifying the digital signature. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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. You specify the pre-processing actions in the processing rule to override the actions that are specified in the TN document type.  Validate Structure—Trading Networks validates the structure of the document against an IS schema. For example. 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 verify that the document arrived unchanged.  processingRuleName—The name (a String) of the processing rule you want Trading Networks to execute for the flat file document. invoke the wm.schema:validate built-in service).0 331 . Trading Networks performs the pre-processing actions in the following order. For more information about these attributes and TN_parms. If you include values for both attributes (which is unnecessary). 15 Defining and Managing Processing Rules Bypass Lookup by Explicitly Specifying the Processing Rule To explicitly specify the processing rule that you want Trading Networks to use.tn. and an application submits an order greater than $10. Use pre- processing actions to instruct Trading Networks to:  Verify Digital Signature—Trading Networks verifies the digital signature of a document. You can specify pre-processing actions in both the TN document type and the processing rule. Trading Networks assures that the document matches the structure identified by the IS schema (using the pub. To verify that the sender is who it claims to be. Be careful not to specify a rule that may process your documents inappropriately.

Trading Networks saves the results of the duplicate check to the pipeline. if you want to deliver a document via a queue. Trading Networks checks the document being processed against documents it has in its database. see “Pre-Processing Actions in the TN Flat File Document Type” on page 302. sender and document type—Trading Networks assures that it does not already have a document with the same document ID.15 Defining and Managing Processing Rules  Check for Duplicate Document—Trading Networks determines if there is a duplicate of the document. For more information.  Save Document to Database—Trading Networks saves a copy of the document content. and receiver in its database.0 . for example. and TN document type in its database. 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. For more information about pre-processing actions for XML documents. For more information about pre-processing actions for flat file documents. attributes.  Document ID and sender—Trading Networks assures that it does not already have a document with same document ID and sender in its database.  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. 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.  Custom services—Use a service that you create to determine whether a document is a duplicate. sender and receiver—Trading Networks assures that it does not already have a document with the same document ID. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 242. Trading Networks uses the results of the duplicate check in the Save Document to Database pre-processing action. sender.  Document ID. Certain delivery options require saving the document content to the database. As a result. if it has already received the document. see below. Trading Networks will bypass reliable delivery and invoke the specified delivery service once. 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. sender. 332 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. this information is available for use in the processing actions that you define in the processing rule. and/or activity log information to the database. “Creating a Duplicate Document Check Service”. that is.  Document ID.

Trading Networks passes the following output variables: Output Value Meaning duplicate String Whether the service determined the document is a duplicate. Trading Networks performs the actions specified in the processing rule to process the document. 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. When Trading Networks finds the processing rule to use for a document (using the criteria). 15 Defining and Managing Processing Rules For all pre-processing actions. do nothing) or to perform one or more of the following actions in the order listed below:  Execute a service that you specify. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see the webMethods Trading Networks Built-In Services Reference. For duplicate checking services. The specification is located in the WmTN package. You can have Trading Networks invoke the service synchronously or asynchronously.tn.rec:BizDocEnvelope IS document type.rec:DupCheckService specification. You can define the processing rule actions to instruct Trading Networks either to ignore the document (that is. The BizDocEnvelope conforms to the wm. For more information about this specification. Creating a Duplicate Document Check Service The service must implement the input and output variables that are defined in the wm. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide.0 333 . The service should return either true or false for duplicate. Trading Networks passes the following input variables: Input Value Meaning bizdoc The BizDocEnvelope that represents the document to perform the duplicate document check on. Processing Rule Actions The purpose of the actions in a processing rule is to specify how Trading Networks is to process a document.tn.

Trading Networks performs the actions in that order.15 Defining and Managing Processing Rules  Send an alert e-mail message to one of the contacts defined for the sender of the document. If the service does not exist. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. For example.0 . Action 1—Execute a Service Use the Execute a service action to have Trading Networks invoke a service that you specify. Trading Networks will receive an error attempting to invoke the service. When you use the Execute a service action. 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. Trading Networks performs the actions in the order listed above.  Change the user status for the document. Trading Networks logs the error in the activity log and continues.  Respond to the caller with a message that you specify. In this situation. you can optionally set input values to hardcode input values for the service. Note: If you are using large document processing. Prerequisite Before you can use the Execute a service action. see “Creating Services that Recognize Large Document Handling” on page 512. For more information about processing rule actions and delivery methods. The following lists the prerequisite to using 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. if the service specified in the rule does not exist. or another e-mail that you specify. you can access the Developer from the Processing Rules screen to create the service. In addition. The service can perform any action you want. the service that you want to invoke must exist on the Integration Server. If Trading Networks encounters an error performing one of the actions. attempting to send the alert e-mail message and deliver the document to the receiver. send an alert e-mail message. and deliver the document to the receiver. if you select to execute a service. one of the contacts defined for the receiver of the document. it will continue to attempt the other actions. If you select to have Trading Networks perform more than one of the above actions. For example. For example. 334 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. the webMethods system administrator.  Deliver the document to the receiver using a defined delivery method.

you select one of the following:  Synchronous—Trading Networks attempts to synchronously execute the service a single time. see “Service Execution Tasks and Reliable Execution” on page 337. asynchronous Trading Networks processes the actions and immediately. 15 Defining and Managing Processing Rules Executing the Service Synchronously or Asynchronously To specify that you want Trading Networks to execute a service synchronously or asynchronously. Trading Networks waits for the service to complete before returning to the caller that sent the document for processing. Trading Networks immediately returns to the caller that sent the document for processing. The results of the service are service execution not available in the pipeline for the other task processing actions.0 335 . Trading Networks uses reliable execution to re-execute the service one or more times if the service fails.  Asynchronous—Trading Networks attempts to asynchronously execute the service a single time. Trading Networks processing actions? merges the results from the service into the pipeline. asynchronous. This allows you to use the service results in output templates or in other processing actions. If there are no subsequent processing actions. If there are no subsequent processing actions. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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.  Service execution task—Trading Networks sets up a service execution task for the asynchronous execution of the service. For more information about service execution tasks. The following table describes the behavior of Trading Networks based on whether you use synchronous.

runtime (i. It returns only the message that you specify with the Respond With action. asynchronous If you do not select the Respond With and processing action. if any. Trading Networks service execution returns no additional information to the task caller.e. it was service execution deleted since you task created the processing rule)? 336 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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. 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. If you do select the Respond With processing action.15 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 the processing action. the results of the service 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.0 . Trading Networks cannot return the results of the service because the service might not be complete. This includes the results of the service. What if the service synchronous. However. Trading Networks returns the message that you specify with the Respond With action.

see “Defining a Processing Rule Based on a Saved Document” on page 362. see “Configuring Tasks Settings” on page 45. Trading Networks evaluates the value of the status output variable. see “tn.user property to indicate the user account to use when invoking the service. For more information about this property.user” on page 496. 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. A service execution task is a task that Trading Networks performs to asynchronously execute a service using reliable execution. 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.) Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks marks the service execution task as failed. When using reliable execution. To determine whether a service was successful or failed. If Trading Networks has reached the maximum retry limit and the service has not successfully executed. The following table lists the system-wide settings for service execution tasks that you can configure. Service Execution Task Setting Description Maximum Retries The number of times you want Trading Networks to attempt to re-execute a service. For instructions on how to configure these settings. 15 Defining and Managing Processing Rules Service Execution Tasks and Reliable Execution When you select service execution task.transport. Trading Networks attempts to execute the service subsequent times until the service succeeds or until Trading Networks reaches the maximum retry limit. When you configure Trading Networks. you define the system-wide settings for service execution tasks. Trading Networks uses these settings to establish the parameters for the service execution task that governs the execution of the service. Trading Networks uses the Administrator user account to invoke services.0 337 . There are also other settings that indicate the maximum number of times that Trading Networks attempts to re-execute a failed service and how long Trading Networks is to wait between the attempts to retry a service after a failed attempt. Trading Networks sets up a service execution task to execute your service. For more information about the output variables that your service should return. By default. Use the Trading Networks tn.transport. Reliable execution is a feature of Trading Networks that allows Trading Networks to automatically retry failed services. If Trading Networks attempts to execute a service and the service fails.

Trading Networks determines the next retry wait period by multiplying the last wait value (10000 ms) by the Retry Factor (2). If the service execution task fails. if the original attempt to execute the service fails. Trading Networks waits 10000 milliseconds before it makes its first retry attempt. You can view information about service execution tasks from My webMethods and the Trading Networks Console. This results in 40000 ms. 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. If you can correct the problem. you can troubleshoot the problem. If the second retry attempt fails. 338 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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. see Managing B2B Integrations: webMethods Trading Networks User’s Guide. If the first retry attempt fails.15 Defining and Managing Processing Rules Service Execution Task Setting Description 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. This results in 20000 ms.0 . Trading Networks keeps track of the progress and status of each service execution task. Trading Networks waits 40000 ms between the second retry attempt and the third retry attempt. 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 managing and tracking service execution tasks. Trading Networks multiplies the last wait value (20000 ms) by the Retry Factor (2). Trading Networks waits 20000 ms between the first failed retry attempt an the second retry attempt. you can restart the service execution task to have Trading Networks attempt to execute the service again.

Your service must specify output values that indicate the outcome of the service. use the webMethods Developer.tn. Trading Networks does not require the service to have specific output values.rec:ReliableProcessingService specification.rec:ProcessingService specification. The specification does not identify any outputs. Input and Output Variables for the Service The following table describes the specification you should use for the service based on whether you select synchronous. The asynchronous input values that are identified in the specification are the IS documents (IData objects) that are in the pipeline during processing. at a minimum.rec:ProcessingService specification. service execution The service must implement. if you use service execution task. at a minimum. To view the wm. asynchronous. 15 Defining and Managing Processing Rules 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. The specification is located in the WmTN package. Method Specification You Must Use synchronous The service must implement. or service execution task.0 339 . use the webMethods Developer. the input and output task variables that are defined in the wm. See below for additional information about setting the output variables.rec:ReliableProcessingService specification.tn. The specification is located in the WmTN package. The input values that are identified in the specification are the IS documents (IData objects) that are in the pipeline during processing. To view the wm. If you use synchronous or asynchronous. which is an IS document (IData object) that contains the following String variables: Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.tn. the input variables and that are defined in the wm. your service must provide values for the serviceOutput output variable.tn. However.

rec:ReliableProcessingService specification. the status of the service execution task remains PENDING and Trading Networks will attempt to re-execute the service after the wait period elapses. It is recommended that you provide information for statusMessage if the service fails. 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. For example. an error message that explains why the service failed. fail The execution of the service failed. for example. the number of times Trading Networks has attempted to retry the service from My webMethods and Trading Networks Console. Input to the service is a flag that indicates the action the service is to take—add. or delete. you set the input values for the flag different for 340 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. A message that contains more information about the outcome of the service.rec:ProcessingService or wm. Specify this value if you want to maintain analytical information about how long it took the service to execute.15 Defining and Managing Processing Rules Variable in the serviceOutput Specify… status Whether the service executed successfully or unsuccessfully. you might create a service that can add. see information about managing tasks in Managing B2B Integrations: webMethods Trading Networks User’s Guide. However. If the maximum retry limit has not yet been reached. For instructions on how to view tasks. statusMessage Optional. transportTime Optional. Setting Values for the Input Variables If you create a service that requires input values. Trading Networks updates the status of the service execution task for this service to DONE. plus other task-related information. When your service returns this value.tn.0 . You can do this when you set up the processing rule. If the maximum retry limit has been met. you might want to hardcode some of the values. update. or delete an entry for a partner in your back-end system. Trading Networks does not attempt to execute the service again. You can view the task detail information described above. Trading Networks updates the status of the service execution task for this service to FAILED.tn. update. You can create three separate processing rules that all execute this service. The number of milliseconds it took for the service to execute. in addition to the input values specified in the wm. such as.

set the input value of the flag to indicate the service should add an entry. and so on. You might want to perform different processing based on whether Trading Networks encountered errors during previous processing. When you use the Alert e-mail action. select “Administrative”. Prerequisite Before you can use the Alert e-mail action. you specify the recipient that is to receive the e-mail message. 3 In the Email Notification section of the screen.g. For example. your Trading Networks system must be set up to allow Trading Networks to send e-mail messages. the subject line for the e-mail message. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. To specify the address of the SMTP server. 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. if you want Trading Networks to send the e-mail message to the sender's administrative contacts. For the processing rule that is triggered by a document for which you want to update an entry. see Developing Integration Solutions: webMethods Developer User’s Guide. 2 Click Edit logging settings. 15 Defining and Managing Processing Rules each processing rule. Trading Networks looks in the sender’s profile for the e-mail addresses of all contacts of the type you selected. whether a document is a duplicate. use the following procedure: 1 In Server Administrator: Settings > Logging. 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. Action 2—Send an Alert E-mail Use the Alert e-mail action to send an e-mail message to a specified contact.. set the SMTP Server field to the domain name or IP address of the SMTP server that you want the Integration Server to use. For the processing rule that is triggered by a document for which you want to add an entry.0 341 . The following lists the prerequisite to using the Alert e-mail action. Logic for the Service This service can perform any logic that you want. and the body (or content) of the e-mail message. e. set the input value of the flag to indicate the service should update an entry. 4 Click Save Changes. For more information about creating the service.

Trading Networks will be unable to determine an e-mail address.0 . specify it. 342 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. However. Trading Networks will be unable to send the e-mail message. As a result. Trading Networks will be unable to send the e-mail message. In this situation. As a result. If the receiver is unknown or if the contact type you specify is not defined in the receiver’s profile. webMethods No additional information is required. Subject of the E-mail Message You can type any subject line for the e-mail message. in Step 4. Trading Networks will be unable to send the e-mail message. Before you select webMethods Administrator. Receiver The receiver’s contacts that are to receive the e-mail message. Follow the steps specified in the “Prerequisites” section above. E-mail Address The e-mail address of the recipient that is to receive the e-mail message. If the webMethods administrator is not defined. Trading Networks logs the error to its activity log and continues with the other actions you specified in the processing rule. Trading Networks sends the Administrator e-mail message to the webMethods administrator. Trading Networks looks in the receiver’s profile for the e-mail addresses of all contacts of the type you selected. specify “Technical”. Trading Networks will be unable to send the e-mail message. If the e-mail address you specify is not valid. There are no restrictions to the length or characters that you can use. assure an e-mail address is specified for Internal Email field. assure the e-mail address for the webMethods administrator is defined. on page 341. if any. Do this using the Server Administrator. In this situation. if any. If an e-mail address is not specified. In this situation. if you want Trading Networks to send the e-mail message to the receiver's technical contact. 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. Trading Networks will be unable to determine an e-mail address. if any. Trading Networks logs the error to its activity log and continues with the other actions you specified in the processing rule. in addition to specifying the SMTP server.15 Defining and Managing Processing Rules If you select… Specify… If the sender is unknown or if the contact type you specify is not defined in the sender’s profile. For example. Trading Networks logs the error to its activity log and continues with the other actions you specified in the processing rule.

you can include information from the pipeline in the body. and the organizational unit is “Alloys Division”.doc/view?docId=000233AB907ED1234 When Trading Networks executes the Alert E-mail action. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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. To include information from the pipeline. You can view the document at http://wMTN:5555/invoke/wm.0 343 . (For illustrative purposes. To make the body dynamic. see the Dynamic Server Pages and Output Templates Developer’s Guide. bold text is used for the output template tags.) If the TN document type is “Purchase Order”. In addition. the pipeline also contains any information that the service placed in the pipeline. The following shows the text you might specify for the body. the pipeline contains the information described in “Action 1—Execute a Service” on page 334. the sender's corporation name is “XYZ Steel Company”. if the processing rule specifies the Execute a service action and the service is executed synchronously. For example. use output template tags. the following shows how the above sample e-mail message body would be rendered: Trading Networks received a Purchase Order document from XYZ Steel Company-- Alloys Division.tn. 15 Defining and Managing Processing Rules Body of the E-mail Message You can type any message for the body of the e-mail message. For details about the output template tags that you can use. There are no restrictions to the length or characters that you can use.

you might require that purchase orders be approved. If the service does not update the receiver. You can specify 1-255 characters for the user status. the TN document type must indicate that Trading Networks is to extract the ReceiverID system attribute from the document. you can specify one of four ways to deliver a document—immediate delivery. Trading Networks uses the receiver information to determine the partner to which to deliver the document. When you use this processing rule action. Prerequisite To use the Deliver Document By action. To determine the purchase orders that are waiting for approval. 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. Trading Networks delivers the document to the receiver identified when it initially received the document for processing. The TN document type can be defined to extract a user status from the document. The user status is a status that you can associate with a document. The User Status action is useful to assign a status to a document that you will use when performing document queries or generating reports.15 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.0 . There is no restriction to the characters you can use for user status. Action 4—Deliver the Document to the Receiver When a processing rule includes the Deliver Document By processing action. This preferred delivery method can be an immediate delivery or queued for polling. If you select preferred protocol. you can query documents searching for documents with the user status “pending approval”. 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”. 344 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For example. you specify the status that you want Trading Networks to associate with the document. webMethods Trading Networks attempts to deliver a document to the receiver that is identified in the document. scheduled delivery. The following lists the prerequisite to using the Deliver Document By action. 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. In the processing rule. the initial value of user status is null. Important! Trading Networks uses the receiver that is extracted from the document. In this case. Trading Networks looks up the receiver’s profile and uses the delivery method that is identified as that partner’s preferred delivery method. If you use the Execute a service action and the executed service updates the receiver identified in the original document. or preferred protocol. which gives the user status an initial value. queued for polling.

Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 15 Defining and Managing Processing Rules For more information about:  Delivery methods in Trading Networks. In addition to creating immediate delivery methods using the delivery methods that Trading Networks provides. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. Trading Networks invokes the delivery service to deliver a document to a trading partner. Trading Networks automatically creates a delivery service after you create the immediate delivery method. The delivery methods from which you can create the immediate delivery methods are as follows:  E-mail  FTP  FTPS  HTTP  HTTPS  Web Service The built-in immediate delivery methods that Trading Networks provides are as follows:  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 is associated with 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. In addition. Immediate Delivery When the Deliver Document By processing action indicates Immediate Delivery.0 345 . For each built-in immediate delivery method. Trading Networks provides built-in immediate delivery methods. Trading Networks provides a built-in immediate delivery service. you can create immediate delivery services and register them with Trading Networks to define your own custom immediate delivery methods. You can create immediate delivery methods using the delivery methods that Trading Networks provides. see “Delivery Settings” on page 103. Trading Networks attempts to deliver a document directly to the receiving partner.  Delivery information on the partner’s profile. For immediate delivery methods that you create.

When using reliable delivery with an immediate delivery method. The following table lists the reliable delivery settings that you define in the Delivery Method tab of the partner’s profile. Trading Networks uses these settings to establish the parameters for the delivery task that governs the delivery of the document. Trading Networks calculates the time to wait by multiplying the last wait time by the value you specify for Retry Factor. Reliable Delivery Setting Description Delivery The number of times you want Trading Networks to attempt to Maximum Retries redeliver a 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. To keep track of the attempts to deliver a document. 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. Note: You can also use reliable delivery by invoking the built-in service. 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. see “What is an Immediate Delivery Service?” on page 394. 346 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. wm.) 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.  Immediate delivery services.0 . Wait Between The number of milliseconds (ms) you want Trading Networks to Retries wait before making its first attempt to redeliver the document.delivery:deliver. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide.15 Defining and Managing Processing Rules For more information about:  Immediate delivery methods. Trading Networks establishes a delivery task.tn.

then Trading Networks will be unable to deliver the document by this method and instead.. 15 Defining and Managing Processing Rules For more information about:  Delivery options. Trading Networks supports two types of queues—public queues and private queues. Trading Networks makes the document pollable (Queue for polling).  Delivery tasks. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. Note: If you select Receiver’s Queue. Trading Networks looks up a queue in the receiver’s profile. You can select to use a public queue or to use a specific partner’s private queue. It is a set of rows in the Trading Networks database. Once you select a queue for the scheduled delivery method. all documents in that queue will be delivered. Trading Networks also creates the delivery task for the document and places the delivery task in the queue specified by the processing rule. Scheduled Delivery When the Deliver Document By processing action indicates scheduled delivery. Note: The queue is not a queue in the traditional sense. Each queued delivery task that is associated with a document is a row in the same table of the Trading Networks database. see Managing B2B Integrations: webMethods Trading Networks User’s Guide. The queue specified in the processing rule is a scheduled delivery queue that you have previously defined. Using Reliable Delivery with Scheduled Delivery Trading Networks automatically uses reliable delivery for a scheduled delivery method. the next time Trading Networks runs a scheduled delivery service and reads documents from that specified queue. For scheduled delivery. To specify how many times Trading Networks attempts to re-deliver a document that is Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see “About Scheduled Delivery Queues” on page 378. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide.e.0 347 . Trading Networks batches documents that are then delivered at scheduled times.  Public/Private queues and scheduled delivery. If the receiver’s profile does not contain a queued delivery method (i. 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. does not define a queue). For more information about:  Scheduled delivery.

Note: You can also use reliable delivery by invoking the built-in service. you define reliable delivery settings in the profile for each of your partners. does not define a queue). see “What is a Scheduled Delivery Service?” on page 394.tn. see “Delivery Settings” on page 103. see “Adding and Registering New Delivery Services” on page 405. Trading Networks establishes a delivery task.. Unlike for the immediate delivery method. 348 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Secondary HTTPS is specified but the profile does not contain a Secondary HTTPS delivery method. For more information about:  Delivery information on the partner’s profile. but the receiving partner’s profile does not contain a queued delivery method (i.  Customized delivery services.  “Scheduled Delivery Queue States” on page 381  Scheduled delivery services. To keep track of the attempts to deliver a document. then Trading Networks makes the document pollable (Queue for polling).delivery:deliver. Reliable Delivery Setting Description Delivery Maximum The number of times you want Trading Networks to attempt Retries to redeliver a document. Trading Networks only uses only the following reliable delivery setting that you define in the Delivery Method tab of the partner’s profile. Or.15 Defining and Managing Processing Rules scheduled for delivery.e. 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. see Managing B2B Integrations: webMethods Trading Networks User’s Guide.0 . For example.  Delivery tasks. 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. another example is that if the scheduled delivery method is Receiver’s Queue. wm. When using reliable delivery with a scheduled delivery method.

There are no restrictions to the length or characters that you can use. When a specific partner polls for documents. see “Delivery Settings” on page 103. Trading Networks waits for a partner to poll for the documents. For more information about:  Partner’s preferred delivery method.g. This preferred delivery method can be an immediate delivery or queued for polling. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. see the Dynamic Server Pages and Output Templates Developer’s Guide.  Queue for polling. Trading Networks returns all the documents in the queue for which that partner is the receiver. When you use the Respond With action. use output template tags. you can include information from the pipeline in the body. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.  Customized delivery services. In addition to the above delivery methods. Instead. For details about the output template tags that you can use. Specifying the Message You can type any message. To include information from the pipeline. For more information about:  Delivery options. it places the document in an internally-defined queue. see “Defining Queue for Polling” on page 390. The receiving partners define the protocol (e.0 349 . see “Adding and Registering New Delivery Services” on page 405. Preferred Protocol If you select Receiver’s Preferred Protocol.. To make the body dynamic. Trading Networks does not deliver the documents that are in this queue. 15 Defining and Managing Processing Rules When Trading Networks queues the document for polling. you can create customized delivery services and register them with Trading Networks to define your own custom delivery methods. Trading Networks looks up the receiver’s profile and uses the delivery method that is identified as that partner’s preferred delivery method. 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. you must specify the message you want Trading Networks to return and the content type of the message. HTTP) to use to poll for the document and how frequently to poll for documents.

15 Defining and Managing Processing Rules The pipeline contains the information described in “Action 1—Execute a Service” on page 334 of this user’s guide. you must indicate the content type of the message. For example.sync. For more information about how to configure Trading Networks for a clustered environment. the servers must set the tn. Specifying the Content Type In addition to specifying the message.  The Respond With action could return an acknowledgement that just indicates that the purchase order was received.0 . To define a processing rule 1 In Trading Networks Console: View > Processing Rules. or if the message is in plain text. 2 Perform one of the following procedures to add a new processing rule. specify the content-type text/plain.remoteAliases property correctly. specify the content type. see “Shared Trading Networks Database in a Clustered Environment”. Defining Processing Rules Use this procedure to define a processing rule on the Processing Rule Details screen. In addition. Note: If you are working in a clustered environment. You can set up a processing rule that uses the Execute a service action and the Respond With action:  The Execute a service action could asynchronously invoke a service that performs the appropriate processing for the purchase order.cluster. for example. That is. all Trading Networks servers must be set up for cluster synchronization. interfacing with a back-end system. 350 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. text/xml. if the processing rule specifies the Execute a service action and the service is executed synchronously. An example of using the Respond With action would be to send an acknowledgement for a purchase order. The message you specify is the acknowledgement that is returned. This action returns the confirmation that the purchase order was received and processed. the pipeline also contains any information that the service placed in the pipeline. if the message is an XML document.

following: For more information about a Above— Add a new processing rule adding processing rules.0 351 . 15 Defining and Managing Processing Rules 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. rule fields with values from the processing rule that you duplicate. see “Setting Up a Default Processing Rule” on page 363 3 Trading Networks displays a blank Processing Rule Details screen for you to complete. deselect the default Enabled field. 4 If you do not want this processing rule to be enabled. c Last—Add a new processing rule to the bottom of the full unfiltered processing rules list.  Duplicate— Add a new 1 Click the row containing the processing processing rule that is a rule that you want to duplicate. Specify 1-255 characters. Trading Networks adds the new rule to the bottom of the processing rules list. All other processing rules keep their original ordinal numbers. For more information about the default processing rule. see above the highlighted processing rule. There is no restriction to the characters that you can use. specify a description for the processing rule in the Description field. Note: Make sure you place the Default processing rule in the last position in the filter processing rules list. order relative to a selected 2 Select Rules > Add and then one of the processing rule. 5 Optionally. Specify 1-64 characters. fields from the duplicated Trading Networks copies the processing processing rule. duplicate of an existing one. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. You can update any or all 2 Select Rules > Duplicate. specify the name you want to give the processing rule in the Name field. 3 On the Processing Rule Details screen. “Adding Processing Rules and the Order of Processing b Below— Add a new processing rule Rules” on page 318 below the highlighted processing rule. There is no restriction to the characters that you can use.

Trading Networks lists the name of the Enterprise profile in parentheses.0 .. For more information about the Select Profile Group(s). You can select multiple partner groups using the <Shift> and <Ctrl> keys. Select one of the following:  Any to use this rule for documents regardless of the sender. c Click OK. button. b Select a partner profile from the Partner Selection Dialog... see “Processing Rule Criteria” on page 322. button. To specify a partner profile: a Click the Select Profile(s) button. c Click OK. 352 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. A document must meet all the criteria that you specify on both the Criteria and Extended Criteria tabs for Trading Networks to use the processing rule to process the document.  Unknown to use this rule for documents for which the sending partner is not known. see “Selecting TN Document Types” on page 33. For more information about these processing rules fields. see “Selecting TN Document Types” on page 33.  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. For more information. For more information about the Select Profile(s). see “Sender and Receiver Criteria” on page 322.15 Defining and Managing Processing Rules 6 Click the Criteria tab and fill in the fields to identify documents that should be processed using this rule. For this Criteria tab parameter… Specify… Sender The sender(s) identified in the documents that you want to process with this rule. You can select multiple partners using the <Shift> and <Ctrl> keys.  Selected to use this rule for documents that identify one or more of the specified partner profiles and/or partner groups as the sender. b Select a partner group from the Partner Groups Dialog.. To specify a partner group: a Click the Select Profile Group(s) button.

 Unknown to use this rule for documents for which the receiving partner is not known. c Click OK. Select one of the following:  Any to use this rule for documents regardless of the TN document type.  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. For more information about these processing rules fields.. To specify a partner group: a Click the Select Profile Group(s) button. b Select a partner group from the Partner Groups Dialog. button. 15 Defining and Managing Processing Rules For this Criteria tab parameter… Specify… Receiver The receiver(s) identified in the documents that you want to process with this rule. button. see “Selecting TN Document Types” on page 33.  Selected to use this rule for documents that identify one or more of the specified partner profiles and/or partner groups as the receiver. c Click OK.0 353 . For more information about the Select Profile Group(s). Document Type The TN document type(s) of the documents that you want to process with this rule.. Trading Networks lists the name of the Enterprise profile in parentheses. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. To specify a partner profile: a Click the Select Profile(s) button. b Select a partner profile from the Partner Selection Dialog.. Select one of the following:  Any to use this rule for documents regardless of the receiver. You can select multiple partner groups using the <Shift> and <Ctrl> keys..You can select multiple partners using the <Shift> and <Ctrl> keys. see “Sender and Receiver Criteria” on page 322. see “Selecting TN Document Types” on page 33. For more information about the Select Profile(s).

 Specified to use this rule for documents with the specified user statuses. Select one of the following:  Any to use this rule for documents regardless of the user status. For more information about these fields.  Has errors to use this rule for documents that contain errors. 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.15 Defining and Managing Processing Rules For this Criteria tab parameter… Specify…  Unknown to use this rule for documents with unknown TN document types. To specify TN document types: a Click the Select Document Type button. Select one of the following from the list:  May have errors to use this rule for documents regardless of whether the document contains errors. Type each user status you want to allow on a separate row in the table. then. see “User Status Criterion” on page 324. For more information about these fields. type the user status. Recognition Whether the documents that you want to process using this rule Errors contain errors. You can select multiple partners using the <Shift> and <Ctrl> keys. For more information about using this button. To add a user status to the table.0 .  Has no errors to use this rule for documents that do not contain errors.  Selected to use this rule for documents with the specified TN document types. c Click OK. see “Document Type Criterion” on page 324 User Status The user status of the documents that you want to process using this rule. delete the row containing the user status by clicking Delete Selected. For more information about these fields. see “Document Recognition Errors Criterion” on page 326 354 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. To remove a user status from the table. see “Selecting TN Document Types” on page 33. click Add New to add a row.

use the format yyyy-mm-dd hh:mm:ss. type the characters in the string.  To specify a number. type the numeric value. specify 2001-08-29 14:30:00.0 355 . (Use a 24-hour clock for the hour field. For example. For example.) If you type a date and time. Trading Networks checks all pre-processing actions. 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. 2001 at 2:30 pm. 15 Defining and Managing Processing Rules 7 Click the Extended Criteria tab to specify custom attributes that you want Trading Networks to use as criteria for matching processing rules. For more information about pre-processing actions for XML documents. Select an attribute from the list. Be sure to use the exact combination of upper. Value Specify the value you want Trading Networks to use when matching documents to the processing rule. either type in the date and time or click to open a dialog that allows you to select the date from a calendar. For each custom attribute that you want to use.  To specify a string. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.  To specify a date and time. hh. (Trading Networks uses the current time. if you want to specify the date/time August 29. By default. select Equal if you want Trading Networks to match documents that have the exact value you specify for Value. 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 about pre-processing actions for flat file documents.and lowercase letters because Trading Networks performs a case-sensitive match.). 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. see “Pre- Processing Actions in the TN Flat File Document Type” on page 302. Operator The operator you want Trading Networks to use with the value you specify. see “Specifying Pre-Processing Actions for TN XML Document Type” on page 242.

 Verify digital signature to always verify digital signatures or digitally sign documents that Trading Networks processes with this processing rule. sender and receiver.  Do not verify digital signature to never verify digital signatures or digitally sign documents that Trading Networks processes with this processing rule. 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. 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. sender and document type. 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 Whether you want Trading Networks to validate the structure of documents. If you select Use built-in services to check for duplicate document. the Document ID.  Validate structure to always validate the structure of the documents that Trading Networks processes with this processing rule.15 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.  Do not validate structure to never validate the structure of the documents that Trading Networks processes with this processing rule.  Use built-in services to check for duplicate document of XML or flat file documents against a Trading Networks built-in service. or the Document ID. 356 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Check for Duplicate Whether you want Trading Networks to determine Document whether it already received the document. select whether you Trading Networks should use the: Document ID only. both the Document ID and sender.0 .

attributes. 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. click Find Service to browse the IS namespace to locate the one you want to use. 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. For more information about creating a duplicate checking service. 15 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. click New service. “Creating a Duplicate Document Check Service” on page 333.  To select an existing duplicate service.  To create a new custom duplicate service. click on the Edit Service button.  Do not check for duplicate document to never check the uniqueness of the documents that Trading Networks processes with this processing rule.0 357 . Click the Edit Service button if you want to modify the service. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.  To edit an existing custom duplicate service.  Save to always save a copy of the document contents.  only unique documents—to save the selected information for documents only if they are unique. and/or activity log information that Trading Networks processes with this processing rule.

 Activity Log—to save activity log criteria relative to the document. 358 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks performs the actions in the order they are listed on the Processing Rules screen.g. and deliver the document to the receiver. Complete your selections for each processing rule action as explained below. Attributes. When you select a processing rule action. Trading Networks performs the actions in that specific order. if you want to deliver a document via a queue).15 Defining and Managing Processing Rules For this Pre-Processing tab parameter… Specify… Select the information you want to save to the database by specifying the following:  Content—to save the content of the document. Trading Networks will bypass reliable delivery and invoke the specified delivery service once. if you select to execute a service. For example. send an alert e-mail message. The default for a new processing rule is to have all five actions enabled. Important! If you select more than one action. 9 Click the Action tab and select one or more of the following processing rule actions. 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.  Execute a service. For more information.0 . and Activity Log) by default. you can also hardcode input parameters for the service. When you select the Save option. deselect the appropriate check box in the Enable column on the left. Trading Networks displays the corresponding panel for each action on the right side of the screen.  Attributes—to save the custom attributes of the document. To disable a processing rule action..  Do not save to never save the document content and attributes of the documents that Trading Networks processes with the processing rule. see “Processing Rule Actions” on page 333. Specify the service you want Trading Networks to invoke for the document and how you want Trading Networks to invoke the service. Optionally. Trading Networks displays the above three items (Content.

b Specify how to invoke the service:  To invoke the service synchronously. Trading Networks opens the Developer from which you can update the service. Then.  To create a new service. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. If you are using large document processing.  Alert E-mail—Compose an e-mail message to send to a specified contact.. click Edit Service. For this Alert e-mail field… Specify. select the contact type from the list.0 359 . Then. and Body fields. select service execution task.. click Find Service to browse the services and select the one you want to use. For more information about creating services. respectively. and body of the e-mail message in the To. click Set Inputs. Subject. d If you need to update the service. Trading Networks displays the input parameters for the service. see “Creating Services that Recognize Large Document Handling” on page 512. see “Action 2— Send an Alert E-mail” on page 341. Specify the recipient.  Sender to send the e-mail to a sender contact. For more information about the Alert E-mail processing rule action. see Developing Integration Solutions: webMethods Developer User’s Guide. select asynchronous. 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. 15 Defining and Managing Processing Rules For more information about the Execute a service processing rule action. select synchronous. click OK. click New Service (folder with yellow highlight) to open the Developer to create the service. To One of the following addresses:  webMethods Administrator to send the e-mail to the webMethods administrator. c To set inputs for the service. After specifying inputs.  To invoke the service asynchronously and use a service execution task. see“Action 1—Execute a Service” on page 334.  Receiver to send the e-mail to a receiver contact.  To invoke the service asynchronously. Type in values for the parameters you want to hardcode an input value. subject line. select the contact type from the list.

Then. see “Body of the E-mail Message” on page 343. For more information.15 Defining and Managing Processing Rules For this Alert e-mail field… Specify. For more information about the Deliver Document By processing rule action. To use a larger input window to specify the body.. see “Defining Queue for Polling” on page 390. 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. click Expand. For more information on these fields.  E-mail address to specify a specific address. Receiver’s The delivery method that is identified as the receiving Preferred Protocol partner’s preferred delivery method. Immediate Delivery Specify an immediate delivery method from the list. For more information on this field. 360 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 .  Change User Status—Specify the user status you want to associate with the document. see “Action 4—Deliver the Document to the Receiver” on page 344 Select this Deliver Document By field… For. Queue for polling Trading Networks queues a document for polling. see “Immediate Delivery” on page 345. see “Defining a Processing Rule Based on a Saved Document” on page 362.. see “Recipient of the E-mail Message” on page 341. specify the e-mail address. You can include output template tags to create a dynamic message.. For more information.  Deliver Document By—Specify the delivery method you want to use to deliver the document. In the Change to field. This preferred delivery method can be an immediate delivery or queued for polling. For more information about the User Status processing rule action. Subject Type a character string for the subject of your e-mail. specify a character string containing 1-255 characters. There is no restriction on the characters you can use.

Select the public queue from the list of registered public queues. To use a larger input window to specify the message. For example. see “Scheduled Delivery” on page 347 and “About Scheduled Delivery Queues” on page 378. see “Action 5—Respond With a Message” on page 349. The next time Trading Networks runs a scheduled delivery service and reads documents from the specified queue. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Select Receiver’s queue to place documents that match this processing rule in the receiving partner’s selected queue... Message The message in the Message field. For more information about queues and scheduled delivery.0 361 . There are no limits to the length or the characters you can specify. type “text/xml”. You can include output template tags to create a dynamic message. Scheduled Delivery indicates that documents matching the processing rule will not be delivered immediately. 15 Defining and Managing Processing Rules Select this Deliver Document By field… For. If you do not save the document. For more information about the Respond With processing rule action. For this Respond With field… Type… Content type The content type of the message in the Content type field. but will be queued and delivered later by scheduled delivery. Important! If you select the Scheduled Delivery processing action. Scheduled Delivery Specify the scheduled delivery queue to use from the list. if the message is and XML document. The scheduled delivery queue can be a public or private queue (Receiver’s queue). Specify a character string. click Expand. all documents in that queue will be delivered. Trading Networks maintains no information about this document after it processes the document. you must use the Save Document to Database pre- processing action.  Respond With —Specify the message you want to return to the caller that sent the document and the content type of the message.

either the sender identified within a document or unknown.  Receiver criterion—Set to the receiver that is associated with the document.0 .15 Defining and Managing Processing Rules 10 Click OK. Trading Networks closes the Processing Rule Details screen. 362 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. that is. Extended Criteria Trading Networks does not set any extended criteria. rules you disabled or enabled. it sets the criteria.  Save document to database—Set to always save a copy of the document content.  Validate structure—Set to always validate the structure of the document. extended criteria. Action Trading Networks sets the processing action to ignore the document. rules you changed. and saves all changes you have made to processing rules. When Trading Networks creates the processing rule. 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. if any. Pre-Processing Trading Networks sets the pre-processing actions as follows:  Verify digital signature—Set to always verify the digital signature of the document.  Check for duplicate document—Set to use the setting in the TN document type for the duplicate check pre-processing action. either the receiver identified within a document or unknown. and/or activity log information. attribute. 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.  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. that is. This includes saving all new rules you added. and all changes you made to the order of the rules.

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

4 To update the processing actions. there is no “undo” function that will return the processing rules to their original order. Trading Networks matches documents against processing rules in the order the rules are listed on the Processing Rules screen. you can highlight multiple processing rules using the <Shift> key. see step 8 on page 355.15 Defining and Managing Processing Rules To update the default processing rule 1 In Trading Networks Console: View > Processing Rules. The default processing rule is listed last (on the bottom of the full unfiltered list). Use the following procedure to order processing rules. 2 Double-click on the row for the default processing rule that is named Default rule. Trading Networks matches document information against the criteria that is specified in a processing rule. Ordering the Processing Rules The order in which you list your processing rules on the Processing Rules screen is important. Note: If you do update the Default rule. 364 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 . click the Pre-Processing tab. update the processing actions. Note: If you reorder processing rules. Then. 5 Click OK. click the rule you want to move. click the Action tab. see “Processing Rules Order” on page 318. make sure that it remains last in the full. For information about what you can specify. Because Trading Networks looks for processing rules in this order. unfiltered processing list. you should keep rules with specific criteria before rules with general criteria. For more information about how Trading Networks works with the order of processing rules. Trading Networks closes the Processing Rule Details screen and saves the changes to the processing rule. 2 To move a processing rule. Note: You can only move and reorder processing rules if their ordinals are contiguous. Then. update the pre-processing actions. To move more than one contiguous block of rules at a time. To order processing rules 1 In Trading Networks Console: View > Processing Rules. It uses the first processing rule that matches to process the document. 3 To update the pre-processing actions. For information about what you can specify. For each document. see step 9 on page 358. The default processing rule should always be last.

To perform a test.. see “Disabling Processing Rules” on page 373. 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. perform the following to move your selected processing rule: Click this. see “Processing Rules Order” on page 318. Inserts the selected processing rule. If you want. you can test the order of your processing rules to assure you have them in the correct order.. Note: If you reorder processing rules.0 365 . there is no “undo” function that will return the processing rules to their original order. 15 Defining and Managing Processing Rules 3 Click Rules > Move > Select to select the processing rule (s) you want to move. you must have sample documents available in your file system. Repeat this step until the processing rules are listed in the order you want. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. The first highlighted processing rule in the list is the one Trading Networks would use to process the document. 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. To test the processing rules.. you select the sample document. The default processing rule should always be listed last. 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. 4 Highlight the processing rule you want to move your selected rule in relation to. see “Testing the Order of Processing Rules” below. For more information about disabling processing rules. This means Trading Networks does not highlight the disabled processing rules that the document would match. 5 Once you have highlighted the location. If you find that Trading Networks is not using the correct processing rule. 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. You can order the processing rules in any direction. For more information. you can re-order the rules.. For more information.

select the sample document you want to use for the test and click Open. Trading Networks does not perform any pre-processing or processing actions on the document. specify some or all of the following:  Basic search criteria  How to display Detail view information about selected processing rules. Trading Networks displays the Select Input Document dialog box. including the ones available out-of-the box and the processing rules you have created. you can save the query settings. Perform the following procedure to test the order of your processing rules. you simply select that saved query. The Processing Rules screen contains a table that displays the processing rules from your query results. and highlights the corresponding processing rules.15 Defining and Managing Processing Rules Important! During the test. To find a specific processing rule. see Appendix A.0 . To test the order of processing rules 1 If the Processing Rules screen is not currently displayed.  Specific information about a selected processing rule in a summary section below the table. 366 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 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. “Queries in Trading Networks Console”. For more information about different query functions you can perform. query Trading Networks for the processing rule(s) in which you are interested. 3 From the Select Input Document dialog box. If you plan to use the same query many times. You can select to display summary information or detailed information for each processing rule that is listed in the table. 2 Select Rules > Test. select View > Processing Rules. To set up a query and display information for viewing processing rules. Trading Networks returns the following information in the processing rules table:  Processing rules that meet your search criteria in a filtered table format. in Trading Networks Console. Trading Networks informs you of the number of matches for which the sample document information meets the processing rule criteria. That is. Trading Networks does not actually process the document. When you want to use the same query again.

user statuses. Trading Networks displays the last query run on the Trading Networks Console. 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  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. processing rule name. 3 Perform one of the following to view processing rule information from the table: Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. To find and view a specific processing rule 1 In Trading Networks Console: View > Processing Rules. that is. Trading Networks displays the query results in the processing rules table. it displays the filtered results of your processing rule query.0 367 . Trading Networks displays the processing rules table. 2 Select Run Query on the toolbar. and if a processing rule is enabled. which lists the requested processing rules information. sender. Each column corresponds to basic information that Trading Networks maintains about a processing rule: ordinal number. receiver. the information found on the Criteria tab of the Processing Rules Details screen. 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. TN document types. Finding and Viewing Processing Rules Use the following procedure to find and view processing rule(s). 15 Defining and Managing 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.

For more information about the tabs and fields on this screen.  To change the display format of the processing rules table: a Select Show Query on the toolbar. select the Basic Criteria tab and fill in the fields to specify basic search criteria. select the check box next to each criterion you want to use.15 Defining and Managing Processing Rules  To see summary information for a processing rule: With your cursor. The summary information contains: the processing rule name. single click on the selected row. Select Show Query on the toolbar. Trading Networks displays corresponding summary information about the highlighted processing rule in a summary section below the processing rules table. description.  To see the detailed information for a specific processing rule: a With your cursor.0 . 5 To narrow down the list of processing rules from which to choose. see “Updating Processing Rules” on page 372. Trading Networks displays the Basic Criteria and Detail View tabs. To indicate that you want to use one or more of the basic search criteria. you can: 1 View the information. and processing rule criteria for the selected processing rule. Then fill out the corresponding information as follows. double click on the row containing the processing row you want more detailed information about. you can perform a more detailed query to refine the results on the processing rules table. Trading Networks displays the Basic Criteria and Detail View tabs. 368 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. Trading Networks displays the Processing Rule Details screen for the selected processing rule. b On the Processing Rule Details screen. see “Defining Processing Rules” on page 350. For more information on how to change the information on the Processing Rule Details screen. 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. 2 Edit the information.

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. 15 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. 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. Receiver The receiver of the processing rule you want to view. if you select an individual sender (Partner 1). Similarly. For example. the query returns only those rules where the sender is Partner 1. where the processing rule sender was set to Any in the Criteria tab).. If you do not select this option. if you select a sender group (Group A). For more information about the Select Profile(s).  Optionally. select Perform Implicit Matching to implicitly expand the query results to reflect group membership of your selected sender(s). Select the individual sender(s) and/or sender group(s) from the Partner Selection Dialog or the Profile Group(s) Dialog. This option works the same way it works for sender queries.  To specify one or more senders. see “Selecting TN Document Types” on page 33. click the Select Profile(s) button or the Select Profile Group(s) button. select Perform Implicit Matching to implicitly expand the query results to reflect group membership of your selected receiver(s). see step 6 on page 352.  Optionally. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. For more information about the Criteria tab.0 369 . the query returns only those rules where the sender is Group A. or the Select Profile Group(s) button..

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" 370 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. see step 6 on page 352  To specify a TN document type. where the processing rule TN document type was set to Any in the Criteria tab.15 Defining and Managing Processing Rules For this Basic Criteria tab parameter… Select the check box and specify…  To specify one or more receivers.  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. then. Type in a character string contained in the processing rule name.  To specify a user status for the query. click the Select Profile(s) button or the Select Profile Group(s) button. click the Select Document Type button. type the user status in the newly added row. You can use the pattern-matching characters “%” in the processing rule name search. Select the individual receiver(s) and/or receiver group(s) from the Partner Selection Dialog or the Profile Group(s) Dialog. Document Type The TN document type of the documents processed with this processing rule. User Status The user status of the documents that processed by this processing rule.0 .  To remove a user status from a query. select the row containing the user status you want to delete and then click Delete Selected. That is. click Add New. For more information about the Criteria tab. For more information about the Select Profile(s) or the Select Profile Group(s) button. Name The name of the processing rule. Select the TN document type from the Document Type Selection Dialog. see “Selecting TN Document Types” on page 33.

check each field that you want Trading Networks to include in the Detail view. Trading Networks displays a column for each checked field. Select this. select the criteria you want to have precedence from the Search Order list and then click . 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. Trading Networks always displays the Ordinals and Name columns. see “Detail View of Processing Rules” on page 367. To specify a date range. select the criteria you want to have precedence from the Search Order list and then click . Select an entry from the list. 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. Move a search criteria down. For more information about the Detail view. use the up and down buttons. You can type in a date value. select Custom from the list. 15 Defining and Managing Processing Rules For this Basic Criteria tab parameter… Select the check box and specify… Last Modified The time Trading Networks last updated the processing rule Time either when the processing rule was created or last updated. 7 Select Run Query on the toolbar. Trading Networks displays the Senders and Receivers columns by default...0 371 . Then specify dates in the Beginning and Ending fields.. b In the Search Order panel. To change the search order. 6 Select the Detail View tab and fill in the fields to specify how Trading Networks displays information in the processing rules table.. Trading Networks displays the processing rules table with the results from the refined query. Move a search criteria up. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. a In the Display Column panel. To do this. select the search order that you want Trading Networks to follow when performing a query.

Managing Processing Rules The following tables lists the tasks you can perform against processing rules: Task See page. 3 Select Rules > Edit. see “Updating Processing Rules” on page 372. see “Defining Processing Rules” on page 350. For information about what you can specify. 6 To update the criteria for the processing rule. update the fields. To update a processing rule 1 In Trading Networks Console: View > Processing Rules. 8 To update the pre-processing actions. There is no restriction to the characters that you can use. click the Criteria tab. perform the following procedure. see step 6 on page 352. type a new name in the Name field. Then.  For more information about the tabs and fields on this screen. There is no restriction to the characters that you can use. Then. see step 7 on page 355. 372 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.. “Updating Processing Rules” 372 “Disabling Processing Rules” 373 “Enabling Processing Rules” 373 “Deleting Processing Rules” 373 Updating Processing Rules To update a processing rule. You can specify 1-256 characters. update the pre-processing actions. For information about how to update the settings. You can specify 1-64 characters.. 5 To update the description. see step 8 on page 355. Then. 2 Click the row containing the processing rule you want to update.15 Defining and Managing Processing Rules 8 Select the processing rule you want from the Processing Rules table on the bottom portion of the screen. click the Pre-Processing tab. type a new description in the Description field. click the Extended Criteria tab.0 . 7 To update the extended criteria for the processing rule. update the fields.  For more information on how to change the information on the Processing Rule Details screen. 4 To update the name. For information about how to update the settings.

When determining the processing rule to use for a document. When you want Trading Networks to use the processing rule again. Trading Networks places Yes in the Enabled column to indicate that the processing rule is enabled. you can delete it. Trading Networks places No in the Enabled column to indicate that the processing rule is disabled. Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 2 Click the row containing the processing rule(s) you want to enable. 3 Select Rules > Disable. You will not be able to recover it later. Trading Networks closes the Processing Rule Details screen and saves the changes to the processing rule. If you no longer need the processing rule and want to permanently remove it. Disabling Processing Rules If you want Trading Networks to temporarily stop using a processing rule. To enable a processing rule 1 In Trading Networks Console: View > Processing Rules. click the Action tab. The processing rule is not deactivated.0 373 . 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 disable a processing rule 1 In Trading Networks Console: View > Processing Rules. it is removed from the Trading Networks system. Then. For information about how to update the settings. 15 Defining and Managing Processing Rules 9 To update the processing actions. You can select multiple processing rules using the <Shift> (for a contiguous block of rules) and <Ctrl> (for more than one non-contiguous processing rule) keys. you can delete it. see “Deleting Processing Rules” on page 373. 10 Click OK. This is an actual delete of the processing rule. 2 Click the row containing the processing rule(s) you want to disable. see “Enabling Processing Rules” on page 373. you can disable it. see step 9 on page 358. Trading Networks does not match the document against processing rules that are disabled. 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. update the processing actions. 3 Select Rules > Enable. you can enable it. Deleting Processing Rules If you no longer need a processing rule.

Click Yes to delete.15 Defining and Managing Processing Rules To delete a processing rule 1 In Trading Networks Console: View > Processing Rules. make sure that disabled processing rules are visible on the processing rules table. b Select the Detail View tab. Important! This is an actual delete of the processing rule. 2 Select Run Query on the toolbar. To do so: a Select Show Query on the toolbar. If you want to delete a processing rule that is currently disabled. 374 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. 4 Select Rules > Delete. Trading Networks displays the Basic Criteria and Detail View tabs.0 . check the Enabled field so that Trading Networks includes it in the Detail view. 3 Click the row containing the processing rule(s) you want to delete. Trading Networks displays the processing rules table. Trading Networks updates the processing rules table. d Select Run Query on the toolbar. The processing rule is not deactivated. You will not be able to recover it later. 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. c In the Display Column panel. Trading Networks confirms that you want to delete the selected processing rule(s). Now you can see the disabled processing rules (No in the Enabled column). it is removed from the Trading Networks system.

. . . . . . . . . . . 393 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . . . . . . . . . . . . . . 377  Creating Delivery Services . . . . . . . . . . . . . . . .IV Setting Up Document Delivery  Defining and Managing Queues in Trading Networks . . . . . . . . . . . . . . . . . . . . . .0 375 . . . . . . . . . . . . . .

IV Setting Up Document Delivery 376 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 .

. . . . . . . . . . . .16 Defining and Managing Queues in Trading Networks  What is a Queue? . . . . . . . . . . . . . . . . . . . . . . . . 388  Changing the State of a Public Queue . . . . . . . . . . . . . 386  Searching for Public Queues Using My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383  Defining Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378  About Scheduled Delivery Queues . . . . . . . . . . . . 387  Deleting Public Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378  Defining Private Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. . . . . . . . . . . . . .0 377 . . . . . . . . . . . . . . . . . . . 389  Defining Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389  About Queue for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388  Changing the State of a Private Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390  Viewing Documents that Are Queued for Delivery . . . . . . . . . . .

The delivery schedule defines the times that Trading Networks is to invoke the scheduled delivery service to deliver the batched documents that correspond to the delivery tasks that are in the queue. Note that a Trading Networks queue is not a queue in the traditional sense.  Scheduled delivery and the Deliver Document By processing action. When documents are placed in a queue. see Understanding webMethods B2B: webMethods Trading Networks Concepts Guide. Trading Networks supports queues for two different purposes— scheduled delivery and polling. see “Delivery Settings” on page 103. Trading Networks delivers them based on a schedule defined for the queue. you select the scheduled delivery method in the processing rules with the Deliver Document By processing action. It is this delivery task that Trading Networks places in the queue. Instead. it contains delivery tasks that are associated with documents. when Trading Networks schedules a document for delivery. 378 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8. When you define a queue for scheduled delivery.0 . You define one or more queues that Trading Networks uses for scheduled delivery.