Professional Documents
Culture Documents
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).
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 3
Table of Contents
4 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
Table of Contents
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 5
Table of Contents
6 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
Table of Contents
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 7
Table of Contents
8 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
Table of Contents
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 9
Table of Contents
10 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
Table of Contents
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 11
Table of Contents
12 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
Table of Contents
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 13
Table of Contents
14 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
About This Guide
This manual describes how to configure Trading Networks and how to plan for your
trading network. It provides procedures for setting up Trading Networks to build your
trading network and how to manage an existing trading network, including how to
define and update the information you want to collect about trading partners and how to
add and maintain partners to your trading network. It also describes how to define how
you want Trading Networks to process business documents that are sent to your trading
network.
Note: The webMethods Trading Networks and webMethods for Partners components
perform the same functionality. The difference between the components is that
webMethods Trading Networks allows you to have as many partners in your network
as you want, and webMethods for Partners allows you to have only a single partner.
This guide provides documentation for both components although it refers only to
webMethods Trading Networks (referred to as Trading Networks).
Document Conventions
Convention Description
Bold Identifies elements on a user interface.
Narrow font Identifies storage locations for services on webMethods Integration
Server, using the convention folder.subfolder:service.
UPPERCASE Identifies keyboard keys. Keys you must press simultaneously are
joined with a plus sign (+).
Italic Identifies variables for which you must supply values specific to your
own situation or environment. Identifies new terms the first time they
occur in the text.
Monospace Identifies text you must type or messages displayed by the system.
font
{} Indicates a set of choices from which you must choose one. Type only
the information inside the curly braces. Do not type the { } symbols.
| Separates two mutually exclusive choices in a syntax line. Type one of
these choices. Do not type the | symbol.
[] Indicates one or more options. Type only the information inside the
square brackets. Do not type the [ ] symbols.
... Indicates that you can type multiple options of the same type. Type
only the information. Do not type the ellipsis (...).
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 15
About This Guide
Documentation Installation
You can download the product documentation using the Software AG Installer.
Depending on the release of the webMethods product suite, the location of the
downloaded documentation will be as shown in the table below.
Online Information
You can find additional information about Software AG products at the locations listed
below.
Note: The Empower Product Support Web site and the Software AG Documentation
Web site replace Software AG ServLine24 and webMethods Advantage.
16 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
About This Guide
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 17
About This Guide
18 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
I Getting Started
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 19
I Getting Started
20 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
1 Integration Server and Trading Networks
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Starting the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Shutting Down the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Configuring Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 21
1 Integration Server and Trading Networks
Overview
To use webMethods Trading Networks (Trading Networks), you must start the
Integration Server. Because Trading Networks is seamlessly integrated into the
webMethods platform, all configuration, administration, and management tasks that you
can perform for the webMethods Integration Server also apply to the Trading Networks
For more information about the architecture and components of webMethods Trading
Networks, see Understanding webMethods B2B: webMethods Trading Networks Concepts
Guide.
This chapter describes basic tasks that you will need to perform when using the server,
specifically, how to start and shut down the server.
Note: For Trading Networks to function properly, the WmPublic package must be
enabled. For more information on the WmPublic package and how to assure a
package is enabled, see Administering webMethods Integration Server.
On the Start menu, select Programs > webMethods > Servers > webMethods Integration Server.
Note: When you installed the Trading Networks, you installed additional packages
into the webMethods Integration Server. Installing the Trading Networks added
functionality to the webMethods Integration Server.
1 Locate the server.sh script file that you modified for your environment when you
installed the server.
2 Execute this script.
Important! Run this script when logged in as a non-root user. Running the script as
root might reduce the security of your system.
22 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
1 Integration Server and Trading Networks
2 In the upper right corner of any Integration Server Administrator screen, click the
Shutdown and Restart link.
3 Select whether you want the server to wait before shutting down or to shut down
immediately.
Delay number minutes or until all client sessions are complete. Specify the number of
minutes you want the Integration Server to wait before shutting down. Trading
Networks begins monitoring user activity and automatically shuts down when all
non-administrator sessions complete or when the maximum wait time you
specify elapses (whichever comes first).
Immediate. The server and all active sessions terminate immediately.
For instructions on how to view the active sessions, see Administering webMethods
Integration Server.
4 Click Shutdown.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 23
1 Integration Server and Trading Networks
24 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
2 Trading Networks User Interfaces
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Trading Networks Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 25
2 Trading Networks User Interfaces
Overview
webMethods Trading Networks (Trading Networks) has the user interfaces described in
the table below:
Because Trading Networks server runs within the Integration Server, to use Trading
Networks the Integration Server must be started. Also all tasks you perform to configure,
administer, and manage the Integration Server also affect Trading Networks.
In addition, the Integration Server must be running to use any of the user interfaces to
perform Trading Networks tasks.
My webMethods
My webMethods is a web-based, administration and monitoring user interface for
managing your webMethods components. The following table lists the My webMethods
pages that you use to perform Trading Networks actions.
26 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
2 Trading Networks User Interfaces
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 27
2 Trading Networks User Interfaces
28 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
2 Trading Networks User Interfaces
For more information about My webMethods, see the Working with My webMethods guide.
Important! Make sure that the Integration Server with which you want to use the
Console is running.
1 On the Start menu, select Programs > webMethods > Trading Networks Console.
2 In the Open Session dialog box, complete the following:
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 29
2 Trading Networks User Interfaces
3 Click OK.
30 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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, you must first close the session on the current server.
Important! While the Trading Networks Console has an open session on a Integration
Server, you are using a licensed seat for that server. When you are not actively using
Trading Networks, you might want to close the session on the server or close the
Console to free a seat on the server for others to use.
2 Complete the Opening Session to Integration Server dialog box. For information of
the fields, see step 2 on “Starting the Trading Networks Console” on page 29.
3 Click OK.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 31
2 Trading Networks User Interfaces
Many of the screens and query panels on the Trading Networks Console use the same
buttons for selecting various Trading Networks objects (e.g., partner profiles and
document types). For example, the Select button appears on the Agreements,
Processing Rules, and Transaction Analysis screens so you can select the partner profile.
32 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
2 Trading Networks User Interfaces
If you need to select a TN document type, use Select Document Type, which accesses the
Document Type Selection Dialog. For example, when you create processing rule criteria,
you can select a TN document type by clicking Select Document Type.
1 Click Select Document Type. Trading Networks displays the Document Type
Selection Dialog, which lists all of the TN document types (both the TN XML
document types and TN flat file document types).
2 To view disabled TN document types, select Types > Show All. Trading Networks
places a check () next to the Show All menu item to indicate that Trading Networks is
currently displaying disabled TN document types.
3 Select the row containing information about the TN XML document type or TN flat
file document type that you want.
Trading Networks displays the Document Type Details dialog for the selected TN
document type.
4 Click OK.
For more information about using the Console to work with TN document types, see
Chapter 13, “Defining and Managing TN XML Document Types” and Chapter 14,
“Defining and Managing TN Flat File Document Types”.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 33
2 Trading Networks User Interfaces
34 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
3 Configuring webMethods Trading Networks
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 35
3 Configuring webMethods Trading Networks
Important! When you use the Configure Properties page and save your updated
properties, Trading Networks updates all the properties with their values including
those that you might not have altered.
This is important if you are using Trading Networks in a clustered environment and
have the tn.cluster.notifyPropertyChange property set to true. Using the 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. If you want the servers in the cluster to maintain different
values for some of the properties, set the tn.cluster.notifyPropertyChange property to false,
and maintain the properties for each server individually.
In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
To see a list of the Trading Networks configuration properties and a description of each,
see Appendix D, “Trading Networks Configuration Properties”.
36 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
3 Configuring webMethods Trading Networks
Important! If you change the database after using Trading Networks, Trading
Networks does not copy the data in the current database to the new database.
However, you can use the Trading Networks export and import facility to export data
from your existing database. Then, after you change the database, you can import the
exported information into the new database. For more information, see Appendix C,
“Exporting and Importing Database Information”.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 37
3 Configuring webMethods Trading Networks
38 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
3 Configuring webMethods Trading Networks
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 39
3 Configuring webMethods Trading Networks
40 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
3 Configuring webMethods Trading Networks
1 On each Integration Server in the cluster, create a remote server alias for the other
servers in the cluster. For example, if you have two servers (Server1 and Server2) in
the cluster, you would create a remote server alias for Server2 on Server1, and a
remote server alias for Server1 on Server2. For information on how to create a remote
server alias, see Administering webMethods Integration Server.
Important! If you have already created a remote server alias so the server is part of
an Integration Server cluster (without Trading Networks), you need to create an
additional remote server alias for the server specifically for the Trading Networks
cluster.
2 To update the Trading Networks properties.cnf file for each Integration Server in the
cluster, perform the following:
a In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
b Add or update the following properties:
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 41
3 Configuring webMethods Trading Networks
Set this property to true... To notify all servers in the cluster about...
Important! When you use the Administration > Integration > B2B Settings >
Configure Properties page and save your updated properties, Trading
Networks updates all the properties with their values including those that you
might not have altered.
This is important if you are using Trading Networks in a clustered
environment and have the tn.cluster.notifyPropertyChange property set to true.
Using the 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. If you want the servers in the cluster to
maintain different values for some of the properties, set the
tn.cluster.notifyPropertyChange property to false, and maintain the properties for
each server individually.
42 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
3 Configuring webMethods Trading Networks
After completing the above procedure, the data cached in memory, user accounts, and
Trading Networks properties are automatically synchronized on all Integration Servers in
the cluster. To turn one of these synchronizations off for a server, modify the respective
property in the Trading Networks properties.cnf file. For example, if you wanted to
manually control user account creation, you would disable automatic user account
creation by turning off the tn.cluster.notifyProfileAddUser property.
Note: When you create a profile for a partner using My webMethods, Trading
Networks does not automatically create a user account, and you cannot configure it to
do so. However, you can always associate one or more My webMethods user
accounts with a profile. For more information, see “Managing the My webMethods
Users Associated with the Partner’s Profile” on page 174. For information about a My
webMethods user account is used, see “Central User Management—How Integration
Server Authorizes My webMethods Users” on page 58.
To configure profile settings when you create a profile from the Console
1 In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
2 Set whether Trading Networks should create a user account when a profile is added.
To indicate that Trading Networks should not create an IS user account, add or
update the tn.default.userCreation to false.
To indicate that Trading Networks should create an IS user account:
1 Add or update the tn.default.userCreation to true.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 43
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, add or update the tn.default.idType property.
Specify the external ID type (e.g., DUNS) that Trading Networks uses for the
user name of an IS user account that it creates for the partner.
3 Click Save.
1 In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
2 Add or update the following properties to configure how Trading Networks
performs document delivery:
tn.mail.from The e-mail address you want Trading Networks to use as the
“from” e-mail address in the e-mail messages that it sends to
deliver a document when instructed to use an E-mail delivery
method.
Example: If you want the e-mail messages to use the “from” e-
mail address TNAdmin@ifc.com, specify the following:
tn.mail.from=TNAdmin@ifc.com
tn.mail.subject The subject line you want Trading Networks to use in the e-
mail messages that it sends to deliver a document when
instructed to use an E-mail delivery method.
Example: If you want the e-mail messages to use the subject line
“Document from IFC”, specify the following:
tn.mail.subject=Document from IFC
3 Click Save.
44 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
3 Configuring webMethods Trading Networks
Note: If you want to be notified when tasks fail, you need to create an Integration
Server trigger that subscribes to the wm.tn.rec:TaskFailure IS document type. For more
information, see the Publish-Subscribe Developer’s Guide.
1 In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
2 Add or update the following property to configure settings that affect both delivery
and service execution tasks:
The value you specify for tn.task.sweepTime can affect how long Trading Networks
waits between attempts to retry a task. Typically, the wait between retries value is
governed by one of the following:
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 45
3 Configuring webMethods Trading Networks
Delivery The Wait between retries value on the Delivery Method tab of the
receiving partner’s profile.
Service The tn.task.ttw property value.
execution
However, Trading Networks could wait as long as the tn.task.sweepTime value. If the
task manager thread is idle when the wait between retries value expires, the task
manager thread will not wake up to process the task until the tn.task.sweepTime value
expires.
3 Add or update the following properties to configure settings that affect only service
execution tasks. These settings configure how many times Trading Networks
attempts to execute services that use reliable execution and how long Trading
Networks waits between attempts to re-execute a service that failed.
4 Click Save.
46 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
3 Configuring webMethods Trading Networks
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:
3 Click Save.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 47
3 Configuring webMethods Trading Networks
Required Recommended
Hard Disk Space RAM # of CPUs Hard Disk Space RAM # of CPUs
Important! The hard disk drive space listed above identifies only the amount of hard
disk drive space that Trading Networks requires for normal processing. It does not
account for the hard disk drive space that is necessary for temporarily saving the
large documents during processing. To use large document handling, you need to
define hard disk drive space where Trading Networks can temporarily save
documents (rather than store them in memory).
The size of the hard disk drive space for temporarily saving documents will vary
based on the number of documents that you process concurrently and the size of the
documents that you process. For example, if your typical concurrent document load
is 10, you would need a hard disk drive space that is 10 to 15 times the combined size
of the documents being processed concurrently.
1 In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
2 Add or update the following properties:
48 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
3 Configuring webMethods Trading Networks
3 Click Save.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 49
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, DB2 requires that you specify a size limit.
When defining the Trading Networks database, the DB2 SQL script defines the size of the
BizDocContent.Content field in the BIZDOCCONTENT table to have a 2M size limit. As
a result, the largest document that Trading Networks can save to the DB2 database is 2M.
If you are using a DB2 database for the Trading Networks database and want to save
documents that are larger than 2M, you must update the size limit for the
BizDocContent.Content field to accommodate the largest document you expect to
process.
Similarly, if you use the Trading Networks Archive tables, you must also update the size
of the ARCHIVE_BizDocContent.Content field.
watt.server.tspace.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. Each file that
the Integration Server stores in this directory is given the
name DocResxxxxx.dat, where xxxxx is a value that can
vary in length and character. The directory you specify is
on the same machine as the Integration Server. For
example:
For Windows:
watt.server.tspace.location=D:\LargeDocTemp
For UNIX:
watt.server.tspace.location=/opt/webmethods/
tspace
50 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
3 Configuring webMethods Trading Networks
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 51
3 Configuring webMethods Trading Networks
52 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
3 Configuring webMethods Trading Networks
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 53
3 Configuring webMethods Trading Networks
54 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
3 Configuring webMethods Trading Networks
1 In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
2 Add or update the following properties:
3 Click Save.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 55
3 Configuring webMethods Trading Networks
56 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
4 Configuring My webMethods to Work with Trading
Networks
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 57
4 Configuring My webMethods to Work with Trading Networks
Note: After Central User Management is set up, you still need to take action to
grant a My webMethods user Trading Networks administrator authority. For
instructions, see “Defining Trading Networks Administrators for My
webMethods” on page 64.
When a My webMethods user wants to view Trading Networks data and/or perform
Trading Networks actions, My webMethods Server invokes Trading Networks
services on the Integration Server to satisfy the request. When issuing the requests,
My webMethods Server presents the credentials of the logged in My webMethods
user to authenticate the user and authorize the request. For more information, see
“Granting My webMethods Users the Authority to Execute Trading Networks
Services” on page 65.
Note: After Central User Management is set up, you need to perform additional
actions to authorize users to perform various Trading Networks actions from My
webMethods. For more information, see “Defining Role-Based Access” on
page 65.
58 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
4 Configuring My webMethods to Work with Trading Networks
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. For more
information, see “Configuring Central User Management in Integration Server” on
page 59.
2 Identify the Integration Server that My webMethods should interact with for Trading
Networks requests. For more information, see “Identifying Trading Networks Server
to My webMethods Server” on page 59.
After Central User Management is set up, My webMethods users can be authorized to
perform Trading Networks functions by making them members of My webMethods
roles. For more information, see “How the Integration Server Authorizes a User” on
page 62.
1 In My webMethods:
Administration > Integration > B2B Settings > Administrative Preferences.
2 In the TRADING NETWORKS SERVER panel, do the following:
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 59
4 Configuring My webMethods to Work with Trading Networks
a In the IS Config Name field, click Other. Type the Trading Networks Server name
that you want to connect to. The default is LocalHost (http://localhost:5555).
b In the Server Hostname field, type the host name or IP address of the server that
hosts the Trading Networks Server. The default is localhost.
c In the Server Port field, type the port number for the Trading Networks Server. The
default is 5555.
d Select Use Secure Connection if you want to secure the communication between My
webMethods and the Trading Networks Server instance.
3 Click Save.
4 To continue adding Trading Networks Server instances, repeat steps step 2 and step 3.
Note: The fields in the General panel can be edited only by the administrator. If you are
not the administrator, all the fields in the General panel are grayed out.
1 In My webMethods:
Administration > Integration > B2B Settings > Administrative Preferences.
2 In the Trading Networks Server panel, do the following:
a In the IS Config Name field, select the Trading Networks Server that you want to
delete.
b Click Delete.
60 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
4 Configuring My webMethods to Work with Trading Networks
For example, consider that you and user A log on with the same credentials at the same
time, and user A updates the Trading Networks Server settings. The setting changes for
user A take effect immediately. However, 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, you will not be affected by the changes until you visit the Administrative
Preferences page.
When you want to access a Trading Networks Server instance from different My
webMethods Server instances, then ensure either of the following:
The My webMethods Server instances are in a clustered environment.
The roles and the user preferences configured in the My webMethods Servers are the
same.
where host name is the host name or IP address and port is the port number of My
webMethods Server.
If you do not set this parameter, Integration Server uses
http://localhost:8585/services/SAML as the default SAML resolver.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 61
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
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. For Role. For
more information, instructions, see
see “How Trading “Defining Trading
Networks Adds My Networks
webMethods Roles Administrators for
to ACLs” on My webMethods”
page 63. 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. For more permissions or data
information, see permissions, that
“How Trading role is added as a
Networks Adds My member of the TN
webMethods Roles MWS Users role. For
to ACLs” on more information
page 63. about general
functional
permissions and
data permissions,
see “Defining Role-
Based Access” on
page 65.
62 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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, you can
startup. For more associate one or
information, see more My
“How Trading webMethods users
Networks Adds My with the partner.
webMethods Roles Trading Networks
to ACLs” on automatically adds
page 63. users associated
with a partner to the
TN Partners role.
For instructions
about associating
My webMethods
users with a partner,
see “Managing the
My webMethods
Users Associated
with the Partner’s
Profile” on page 174
in Chapter 9,
“Defining and
Managing Partner
Profiles”.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 63
4 Configuring My webMethods to Work with Trading Networks
After Trading Networks maps the My webMethods roles to their corresponding ACLs, it
updates the watt.WmTN.mwsMap property, which is in the Integration Server server.cnf
file. Trading Networks sets the watt.WmTN.mwsMap property to the Trading Networks
version number. After this property is updated, Trading Networks will no longer attempt
to map the My webMethods roles to their corresponding ACLs at startup.
If you want to force Trading Networks to create these mappings again, you can edit the
Integration Server server.cnf file and remove the watt.WmTN.mwsMap property. As a
result, when Trading Networks starts up again, it will go through its processing to create
the mappings.
Note: If the user to which you want to grant Trading Networks administrator
authority does not already have a My webMethods user account, create a user
account for the user. You create a user using the Administration > System-Wide >
User Management > Users page. For instructions, see Administering My webMethods
Server.
1 In My webMethods:
Administration > System-Wide > User Management > Roles.
2 On the Roles page, click EDIT in the row for the TN Administrators role.
64 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
4 Configuring My webMethods to Work with Trading Networks
You do not need to take any action. The TN MWS Users role is added to the Allowed list
of the TNMWSUSers ACL at installation.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 65
4 Configuring My webMethods to Work with Trading Networks
The two types of permissions are general functional permissions and data permissions.
The data and actions that you control using each are distinct. For more information
about:
General functional permissions, see “Data and Actions Governed by General
Functional Permissions” on page 66.
Data permissions, see “Data and Actions Governed by Data Permissions” on page 68.
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, edit, delete) all public queues.
Manage Partner Use the Administration > Integration > B2B > Partner Groups page to
Groups manage (add, edit, delete) all partner groups.
Delete Partner Delete any partner profile. If a user’s role is granted this
Profile functional permission, Trading Networks displays the Delete
button on the Administration > Integration > B2B > Partner Profiles
page.
66 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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, edit, delete) all extended profile fields. If a user’s
Profile Fields role is granted this functional permission, Trading Networks
displays the Manage Extended Fields button on the Extended Fields
tab of a profile.
Add External ID Add new external ID types that can be used in profiles. If a
Types user’s role is granted this functional permission, Trading
Networks displays the Add ID Type button on the External IDs tab
of a profile.
Show SQL View the SQL Trading Networks uses to search the database for
data. This is for a search that was issued from a Trading
Networks search panel within My webMethods. If a user’s role
is granted this functional permission, Trading Networks
displays the Show SQL button on the search panel where this
feature is supported.
View User Use the Monitoring > Integration > B2B > User Preferences page to
Preferences view (but not update) user preferences.
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.
Edit B2B properties Use the Administration > Integration > B2B Settings > Configure
Properties page to edit Trading Networks Server properties.
Query Expiring Use the Administration > Integration > B2B Settings > Partner
Certificates Certificates page to query partner certificates that have expired
or that will expire soon.
Manage TN Use the Administration > Integration > B2B > Archive Schedules page
Archiving to manage (add, edit, delete) the criteria and schedules for
archiving and deleting documents.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 67
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, edit, delete) the immediate delivery methods that
Methods a user creates using the delivery methods that Trading
Networks provides (for example, HTTP, FTP, FTPS).
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.
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, you can also
submit EDI documents.
68 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
4 Configuring My webMethods to Work with Trading Networks
Note: When you select the Create Profile permission, the Edit Profile Summary and Edit
External IDs check boxes are selected automatically only after you save and re-open the
data set.
By default, a newly created profile gets added to all the data sets where the user has the
create profile permission. If the data set has the All Partners option selected, 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.
For more information about All Partners option, see “Defining Data Sets and Granting
Roles Permissions to Act on the Data Set” on page 72.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 69
4 Configuring My webMethods to Work with Trading Networks
If a user is granted the create profile data permission, only then does Trading Networks
display the Add Profile button on the Administration > Integration > B2B > Partner Profiles page
to add partner profiles. For more information about adding partner profiles, see “Adding
Partner Profiles” on page 154.
1 Define the roles to which you want to grant access. You define roles using the
Administration > System-Wide > User Management > Roles page. For more
information about defining roles, see Administering My webMethods Server.
2 Add members to the roles you want to use for Trading Networks role-based access.
You can make My webMethods users, groups, and/or roles members of a My
webMethods role. For more information about defining roles, see Administering My
webMethods Server.
3 Assign Trading Networks general functional permissions to roles.
For a description of the general functional permissions, see “Data and Actions
Governed by General Functional Permissions” on page 66. For instructions for
defining general functional privileges, see “Granting General Functional Permissions
to a Role” on page 71.
4 Assign Trading Networks data permissions to roles.
For a description of data permissions, see “Data and Actions Governed by Data
Permissions” on page 68. For instructions for defining data permissions, see
“Defining Data Permissions” on page 72. The general steps are:
a Define the data sets for which you want to assign data permissions. Consider how
you want to provide access when defining your data sets.
For example, you might want to create a single data set that identifies all Trading
Networks data so that you can assign various roles different access to all Trading
Networks data. You might want to allow one role to only view all the data and
another role to view all the data and also resubmit and reprocess transactions.
Another example is that you might want to allow all access rights to a role, but
only to a limited set of data. In this case, you would define multiple data sets, each
identifying the data on which a role can act.
70 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
4 Configuring My webMethods to Work with Trading Networks
For information about defining data sets, see, “About Defining Data Sets” on
page 72.
b Identify the roles that can act on the data set.
c For each role, edit the permissions to identify the actions that the role can perform
against the data set.
1 In My webMethods:
Administration > System-Wide > B2B Permissions > General Functional Permissions.
2 Click EDIT in the row containing the general functional permission that you grant
to one or more roles.
3 In the SELECT ROLE(S) dialog:
a Search for the roles to populate the Available list by typing a string contained in the
name(s) of the roles you want and clicking Search.
b To select the roles to which you want to grant permission, move the roles to the
Selected list.
c Click Apply.
1 In My webMethods:
Administration > System-Wide > B2B Permissions > General Functional Permissions.
2 Click EDIT in the row containing the general functional permission that you want to
remove from a role.
3 In the SELECT ROLE(S) dialog:
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 71
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.
b Click Apply.
Defining Data Sets and Granting Roles Permissions to Act on the Data Set
Before granting data permissions, you must define the roles to which you want to assign
data permissions. To define roles, use the Administration > System-Wide > User Management >
Roles page. For more information about defining roles, see Administering My webMethods
Server.
72 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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.
2 Click Add Data Set.
3 In the Data Set Name field, type a name for the data set.
4 Select the Dataset tab, if it is not already selected.
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.
To include all partners, select All Partners and continue with step 6.
To include a few partners, select Custom selection and continue with step 5b
below.
b If you selected Custom selection, you can do one or more of the following to
identify the partners in the data set:
Make the partner list relative to the logged in My webMethods user.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 73
4 Configuring My webMethods to Work with Trading Networks
3 To select the partners to add to the data set, move the partners to the
SELECTED PARTNERS list.
4 Click OK.
6 Define the TN document types to include in the data set using the DOCUMENT TYPES
panel:
a Select whether you want to include all or a subset of TN document types in the
data set.
To include all TN document types, select All Document Types and continue with
step step 7.
To include a subset of the document types, select Selected document types and
continue with step 6b below.
b If you selected Selected document types:
1 Click Edit.
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.
3 To select the TN document types to add to the data set, move the TN
document types to the SELECTED list.
4 Click OK.
7 Click Permissions tab.
8 Add one or more roles to which you want to grant data permissions to act on the data
in the data set. You must add at least one role. To add a role:
a Click Add Role.
b In the SELECT ROLE(S) dialog:
1 Search for the roles to populate the Available list by typing a string contained in
the name(s) of the roles you want and clicking Search.
2 To select the roles to which you want to grant permission, move the roles to
the Selected list.
3 Click Apply.
c Repeat step 8 for each role you want to add.
74 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
4 Configuring My webMethods to Work with Trading Networks
9 Grant data permissions to the roles you added in step 8. For each role:
a Click Edit in the row containing the role to which you want to grant data
permissions.
b In the EDIT PERMISSIONS dialog box, select the check boxes for the permissions
you want to assign the role and clear the check boxes for the permissions you do
not want the role to have.
c Repeat step 9 for each role you added in step 8.
10 Click Save.
1 In My webMethods:
Administration > System-Wide > B2B Permissions > Data Permissions.
2 Select the data permission rules that you want to remove.
3 Click Delete.
1 In My webMethods:
Administration > System-Wide > B2B Permissions > Data Permissions.
2 Click Data Set Name from which you want to remove a role’s permission.
3 Click the Permissions tab.
4 Select the roles that you want to remove.
5 Click Delete.
6 Click Save.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 75
4 Configuring My webMethods to Work with Trading Networks
webMethods role. Instead, you grant roles Trading Networks data permissions. For more
information about data permissions and general functional privileges, see “Defining
Role-Based Access” on page 65.
1 In My webMethods:
Administration > Integration > B2B Settings > Administrative Preferences.
2 In the Web Service Timeout field, which is in the GENERAL panel, specify the number of
seconds that My webMethods Server should wait for a response from a Trading
Networks Web service. The default is 60 seconds.
3 Click Save.
1 In My webMethods:
Administration > Integration > B2B Settings > Administrative Preferences.
2 In the GENERAL PANEL, fill in the following fields:
76 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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.
Reprocessing/Resubmission Limit The maximum number of documents that a My
webMethods user can resubmit or reprocess at
one time.
3 Click Save.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 77
4 Configuring My webMethods to Work with Trading Networks
78 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
5 Planning Your Network
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
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 79
5 Planning Your Network
Introduction
Before you begin planning your network, it is helpful if you have a basic understanding
of Trading Networks. For more information, see Understanding webMethods B2B:
webMethods Trading Networks Concepts Guide.
This chapter describes the tasks to plan for and to set up your trading network. The tasks
are presented in the proposed order in which you should complete them; however, based
on your unique situations, you might want to perform the tasks in an alternative order.
The general order of tasks is:
Tasks 1 through 6 define the behavior of your trading network. After you perform these
tasks, you have defined the document attributes, TN document types, profile fields, and
processing rules that determine how Trading Networks processes documents that it
receives.
You might want to perform these tasks in a development environment. After Tasks 1
through 6 are completed, you can use your development system to test your trading
network to ensure that documents are processed as intended. After you ensure your
trading network is defined properly, migrate your information to a production
environment.
You can migrate your document attributes, TN document types, profile fields, processing
rules, and your profile into your production system using the export and import facility
that Trading Networks provides. For more information, see Appendix C, “Exporting and
Importing Database Information”.
After you have migrated information to your production system, you can perform Task 7;
that is, add partners to your network.
80 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
5 Planning Your Network
You can also BAM enable Trading Networks using webMethods Optimize for B2B, that
is, you can analyze and monitor Trading Networks transaction data for business
purposes. To do so, you must complete all the tasks from 1 to 7. For information about
configuring and enabling Trading Networks for BAM, see Optimizing B2B with BAM:
webMethods Optimize for B2B User’s Guide.
The following sections provide more information about each task required to set up your
trading network. The description of each task points to sections of this manual or other
manuals that describe more information about the task and how to perform the steps
required to complete each task.
Step Action
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 81
5 Planning Your Network
Step Action
82 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
5 Planning Your Network
you to use for reporting. You can use it to search for specific documents that have been
sent through your system or to gather information about the documents that have been
sent through your system.
For Trading Networks to extract information, you have to define the pieces of
information within documents that are important to you. Trading Networks refers to
these pieces of information as document attributes. The following system attributes are
provided for you:
SenderID. Identification of the partner that sent the document
ReceiverID. Identification of the partner that is to receive the document
DocumentID. Identification of the document
UserStatus. A status that you or a partner has associated with the document
GroupID. Identification within a document that associates this document with other
documents in its group
ConversationID. Identification within a document that associates this document with
other documents in the same “conversation” of documents
SignedBody and Signature. Portions of the document that contain the data that was
digitally signed and the digital signature (available only for TN XML document
types; Trading Networks provides a different way to do this for TN flat file document
types)
DoctypeID or DoctypeName. The Trading Networks-generated internal identifier or name
of the TN flat file document type that you want Trading Networks to use for a TN flat
file document type
processingRuleID or processingRuleName. The Trading Networks-generated internal
identifier or name of the processing rule that you want Trading Networks to use for a
TN flat file document type
The system attributes are available out-of-the-box. You do not need to define them, and
you cannot delete them.
To identify other pieces of information within a document that are of interest, you can
define custom document attributes. For example, you might be interested in the total
amount of purchase orders you receive; in this case, define a custom attribute for total
purchase order. Typically, the documents for all variations of a transaction type have the
same pieces of information. For example, a cXML purchase order, OAG purchase order,
and CBL purchase order all have some piece of information that represents the total
purchase amount. You do not define multiple custom attributes, one for each variation of
a transaction type—define a single custom attribute that can be used for all variations of
the transaction type.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 83
5 Planning Your Network
For each piece of information (attribute) that is of interest to you, complete the following
tasks:
84 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
5 Planning Your Network
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 85
5 Planning Your Network
86 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
5 Planning Your Network
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 87
5 Planning Your Network
88 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
5 Planning Your Network
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 89
5 Planning Your Network
90 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
5 Planning Your Network
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 91
5 Planning Your Network
92 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
5 Planning Your Network
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 93
5 Planning Your Network
Processing rules and conversation scripts are extremely flexible. To understand all of the
capabilities of processing rules and how to set them up, see “Defining and Managing
Processing Rules” on page 317.
94 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
II Managing Trading Partners
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 95
II Managing Trading Partners
96 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
6 About Trading Partners
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 97
6 About Trading Partners
98 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
6 About Trading Partners
Field Description
Corporation Name The name of the partner’s corporation, for example, “XYZ Steel
Company”.
Organization Unit The name of the organizational unit or division within the
partner’s corporation, for example, “Sales and Marketing”.
In the Console, the field name is Unit Name.
Status The status of the profile. For more information, see “Profile
Statuses” on page 113.
In the Console, the Status field is not listed in the profile
details. The status is shown only in the list of profiles.
Preferred Language The Preferred Language option is for use only by other
webMethods components (e.g., webMethods RosettaNet
Module) for localization purposes. Optionally, specify the
preferred language of the partner. Trading Networks does not
use this option for its own processing.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 99
6 About Trading Partners
Field Description
Partner Type The type of software the corporation uses to interact with the
trading network.
Value Meaning
External IDs
Trading Networks maintains external IDs for a partner and uses those external IDs to
identify sending and receiving partners that are identified within a document. For
example, within a document, the sending partner might be identified by its D-U-N-S
number. Trading Networks uses the value of the D-U-N-S number that it finds in the
document and matches it to profiles in its system. When it finds a profile with an external
ID of type DUNS that matches the value from the document, it determines the sender of
the document is the partner with the matching profile.
The following table lists the fields that Trading Networks uses for external IDs. These
fields are located:
In My webMethods on the External IDs tab of the Partner Profile page.
In Trading Networks Console on the Corporate tab of the Profile screen.
Field Description
ID Type The type of identification that a corporation uses within documents.
In the Console, the field name is External ID Type.
Value The alpha-numerical value for the external ID type. For example, if ID
type is “DUNS”, Value is the partner’s D-U-N-S number.
100 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
6 About Trading Partners
The external IDs can be used when creating a user account that is associated with the
profile. You can associate the profile with one or more My webMethods user accounts
and/or an Integration Server user account.
When you define or edit a profile in My webMethods, you can optionally associate
the profile with My webMethods user accounts. One method to defining a user
account is to have Trading Networks create a My webMethods user account and use
the value of an external ID that you select as the user name for the account.
When you define a profile using the Trading Networks Console, Trading Networks
can automatically create an Integration Server user account. You configure whether
you want Trading Networks to create the user account using the tn.default.userCreation
configuration property. When Trading Networks creates the user account, it uses the
value of the default external ID as the user name of the user account. You configure the
default external ID using the tn.default.idType.
When you associate a user account with the profile, the user account receives Trading
Networks partner authority. This allows the partner that the profile defines to use the
user account to access your Trading Networks system. For example, when the partner
sends a document to your Trading Networks system, the user can supply the user name
and password of the user account associated with their profile.
Addresses
You can identify one or more addresses for a corporation. The following table lists the
fields that Trading Networks uses for address. These fields are located:
In My webMethods on the Addresses tab of the Partner Profile page.
In Trading Networks Console on the Corporate tab of the Profile screen.
Field Description
Country The country where the partner’s corporation is located, for example
“USA”.
Address The street address of the partner’s corporation, for example, “123
Main Street”.
City The city where the partner’s corporation is located, for example,
“Los Angeles”.
State/Province The state or province where the partner’s corporation is located, for
example, “California”.
Postal Code The postal code (for example, a zip code) for the state or province
where the partner’s corporation is located, for example, “90001”.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 101
6 About Trading Partners
Contacts
You can define information about the people you interact with in a corporation, for
example, the names and phone numbers of your contacts. The following table lists the
fields that Trading Networks uses for contacts. These fields are located:
In My webMethods on the Contacts tab of the Partner Profile page or in the dialog box
you use to add or edit a contact listed on the Contacts tab.
In Trading Networks Console on the Contact tab of the Profile screen.
Field Description
Name This column contains the list of contacts defined for a partner’s
corporation. It is a combination of the Last Name and First Name fields.
This column is listed only in Trading Networks Console on the Contact
tab of the Profile screen. In My webMethods, a Name list is not
necessary because Trading Networks displays one row for each
contact you have defined for a partner on the Partner Profile Contacts
tab.
Contact Type The type of contact, for example, “Administrative”.
Note: Out-of-the-box, Trading Networks provides pre-defined contact
types. You can add additional contact types by using the built-in
service wm.tn.dictionary:addContactType. For more information, see the
webMethods Trading Networks Built-In Services Reference.
Title The contact’s job title, for example, “Trading Network
Administrator”.
In the Console, the field name is Role.
Last Name The contact's last name (surname).
First Name The contact's first (given) name.
E-Mail The contact's e-mail address.
Note: In the Console on the Processing Rules screen, Trading Networks
allows you to select a contact type for the Alert e-mail processing action.
The Alert e-mail processing action instructs Trading Networks to send
an e-mail message to the contacts of the selected contact type. If an
e-mail address is not specified for a contact of the selected contact
type, Trading Networks cannot send the e-mail message. For more
information, see “Action 2—Send an Alert E-mail” on page 341.
Telephone The contact's telephone number, for example, “1-800-555-1234”.
Extension The contact's extension number.
Pager The contact's pager number, for example, “1-330-555-7890”.
Fax The contact's fax number, for example, “1-888-555-4897”.
102 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
6 About Trading Partners
Field Description
Country The country where the contact is located, for example, “USA”.
Address The street address of the contact, for example, “123 Main Street, Suite
456”.
City The city where the contact is located, for example, “Los Angeles”
State/Province The state or province where the contact is located, for example,
“California”.
Postal Code The postal code (for example, a zip code) for the state or province
where the contact is located, for example, “90001”.
Delivery Settings
Trading Networks maintains the delivery methods in which it can deliver a document to
a partner. You must define the delivery methods you want Trading Networks to use to
deliver documents and provide information that is specific to the partner. For example,
for Trading Networks to deliver a document using HTTP, you define a delivery method
that uses HTTP. When you define this delivery method, you must provide the partners
host name and port that it uses to listen for HTTP requests.
You can access the delivery settings in My webMethods on the Delivery Settings tab of the
Partner Profile page.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 103
6 About Trading Partners
Field Description
Delivery The delivery method that Trading Networks can use when delivering
Method documents to the partner.
Delivery The name of the delivery method that you are creating. This field appears
Method only when you are creating a new delivery method.
Name
The value that you provide is prefixed with the delivery method that you
want to use, for example, HTTP - XYZSteel.
After you create the delivery method, Trading Networks automatically
creates the delivery service with the same name as that of the delivery
method.
Host The partner’s host name or IP address, for example, “XYZSteel.com”.
This option is only valid for HTTP, HTTPS, FTP, and FTPS protocols.
Port The port number on which the partner listens for incoming requests, for
example, “5555”. This option is only valid for HTTP, HTTPS, FTP, and
FTPS protocols.
104 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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…
Note: This field is for a partner profile only; Trading Networks does not
display it for your (Enterprise) profile.
Password The password that your Trading Networks system is to supply (along
with User Name) when connecting to the partner’s system using the
associated protocol (HTTP, HTTPS, FTP, or FTPS).
Note: This field is for a partner profile only; Trading Networks does not
display it for your (Enterprise) profile.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 105
6 About Trading Partners
Field Description
E-mail The e-mail address to use when delivering documents to the partner, for
example, “bizdoc@isteel.com”.
Use as The delivery method that the partner prefers be used to deliver
preferred documents to the partner’s system. If the Use as preferred protocol is not
protocol selected for any delivery method, Trading Networks uses Queue for
Polling.
If you select the “Web Service” Delivery Method, the following additional fields appear. For
information about web service delivery methods in Trading Networks, see Understanding
webMethods B2B: webMethods Trading Networks Concepts Guide.
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.
Web Service The name of the Web service connector that you created in Integration
Connector Server.
Mapping The name of the mapping service that provides input to the Web service
Service connector.
Output The output parameter of the Web service connector that contains the
Parameter required response. Depending on the value specified in the Response
Handling field, the response is in a new document or as an additional part
of the bizdoc.
Key/Value Any constant input values to the Web service connector.
If you select the “Queue for delivery” Delivery Method, the following additional fields
appear:
Note: You cannot select either the public or private queue as the preferred protocol.
Queue for
delivery Field Description
Use Public Queue Indicates you are defining a delivery method to deliver documents
to the partner by placing documents in a public scheduled delivery
queue. A public queue is a queue that can contain documents for
multiple receiving partners. For more information about public
queues, see “Defining Public Queues” on page 386.
When use this delivery method, 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
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. A private queue contains
only documents for the partner defined by the profile.
When you use this delivery method, you must define the following
fields as well:
Field Description
Delivery The delivery service to use for the private queue. Select
the delivery service from the list. For more
information, see “Adding and Registering New
Delivery Services” on page 405.
In the Console, the field name is Delivery Service.
Inputs tab The inputs for the delivery service you selected.
In the Console, the corresponding field is the Set Inputs
button.
State The state of the queue (Enable Queue, Drain Queue,
Suspend Delivery, or Disable Queue). For more
information about queue states, see “Scheduled
Delivery Queue States” on page 381.
In the Console, the field name is Queue State.
Process The schedule of when Trading Networks is to invoke
Queue the delivery service that will deliver documents from
this queue. For more information, see “Delivery
Schedule for Queues” on page 379. The available
options are:
Run Once. Trading Networks executes the delivery
service a single time. For more information, see
“Using the Run Once Option” on page 380
Simple Interval. Trading Networks executes the
delivery service repeatedly at an interval you
specify. For more information, see “Using the Fixed
Interval Option” on page 380.
Custom Interval. Trading Networks runs the delivery
service on the day(s) and at the time(s) that you
specify either during a specified date range or
indefinitely. For more information, see “Using a
Custom Interval Option” on page 381.
In the Console, these fields are on the Schedule tab.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 107
6 About Trading Partners
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.
If you specify 0, Trading Networks attempts to redeliver a
document five times. This is the default.
Trading Networks uses also uses the Delivery Maximum Retries for
scheduled delivery methods.
Wait Between The number of milliseconds (ms) you want Trading Networks to
Retries wait before making its first attempt to redeliver the document to the
partner’s system. Trading Networks uses the Retry Factor along with
the Wait Between Retries value to calculate how long to wait for
subsequent retry attempts.
If you specify 0, Trading Networks uses 20000 milliseconds (20
seconds) for Wait Between Retries. This is the default.
Note: Trading Networks only uses the Wait Between Retries and Retry
Factor options for reliable delivery with immediate delivery
methods. Trading Networks does not use the Wait Between Retries
and Retry Factor settings for scheduled delivery because the queue’s
delivery schedule dictates how often to retry delivery attempts.
108 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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. Trading Networks calculates the time to wait
by multiplying the last wait time by Retry Factor. Specify a whole
number greater than zero for Retry Factor.
Example: The following shows sample values for the reliable
delivery settings and how they affect the wait times between
attempts to redeliver a document.
Delivery Maximum Retries = 3
Wait Between Retries = 10000 ms
Retry Factor = 2
Retry 1 Retry 2 Retry 3
Polling Method The delivery method (e.g., Primary HTTP) that your Trading
Networks system uses to contact the partner’s system to request
documents that the partner has queued for your system. Select the
method from the list. If you do not want your Trading Networks
system to poll for documents, select the blank entry.
Polling Frequency How often Trading Networks is to poll the partner’s system to
retrieve documents that the partner has queued for your system.
Specify a number of minutes that is zero or greater. If you specify
zero, Trading Networks will not poll.
Note: Setting the polling frequency too low can have an adverse
effect on Trading Networks performance.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 109
6 About Trading Partners
Delivery Method
Tab Field Description
Suspend delivery Whether you want Trading Networks to suspend delivery for this
partner. When delivery is suspended, Trading Networks does not
deliver documents to the partner. For documents where the partner
is the receiving partner:
For immediate deliveries, the deliveries fail.
For deliveries that use reliable delivery or scheduled deliveries
where the partner is the receiving partner, Trading Networks
holds the delivery tasks until delivery is resumed for this
partner.
This field is not available in the Console.
Extended Fields
Trading Networks lists the extended fields that you define for partner profiles in the
following locations:
In My webMethods on the Extended Fields tab of the Partner Profile page.
In Trading Networks Console on the Extended Fields tab of the Profile screen.
Users
You can optionally associate one or more My webMethods users with a profile. The My
webMethods user accounts associated with a profile are listed on the Users tab of a profile
in My webMethods.
When you associate a user account with the profile, the user account receives Trading
Networks partner authority. This allows the partner that the profile defines to use the
user account to access your Trading Networks system. For example, when the partner
sends a document to your Trading Networks system, the user can supply the user name
and password of the user account associated with their profile.
Certificates
Trading Networks maintains partner certificates in the profile in the following locations.
In My webMethods on the Certificates tab of the Partner Profile page.
In Trading Networks Console on the Security tab of the Profile screen.
The following table lists the types of certificate information that you define:
110 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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 digitally signs a
document when the built-in service wm.tn.doc:sign is invoked. For
more information about this service, see the webMethods Trading
Networks Built-In Services Reference.
In a partner profile, Trading Networks uses the certificate information
to verify the digital signature of documents that were digitally
signed by the partner. Trading Networks verifies a digital signature
when instructed to do so by the Verify Digital Signature pre-
processing action. For more information, see “Verifying the Digital
Signature of an XML Document” on page 242 and “Verifying the
Digital Signature of Flat File Documents” on page 302.
If you include the private key in this certificate information,
Trading Networks can also use this certificate information to
digitally sign documents on behalf of the partner. You might have
the private key if the profile describes an internal group, for
example a department within your corporation
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 111
6 About Trading Partners
Type Description
Encrypt/ Certificate information that Trading Networks uses to decrypt or
Decrypt encrypt information.
In the your (Enterprise) profile, you can supply a certificate information
that Trading Networks uses to decrypt documents that your
enterprise receives from partners.
In a partner profile, Trading Networks uses the certificate information
to encrypt information that is being sent to a partner.
If you include the private key in this certificate information, this
certificate information can also be used to decrypt documents that
were encrypted with the partner’s public key. You might have the
private key if the profile describes an internal group, for example a
department within your corporation.
Trading Networks maintains this information for other webMethods
components (e.g., webMethods RosettaNet Module) that take
advantage of this feature. You can also add your own functionality that
takes advantage of this certificate information. You can obtain the
certification information by using built-in services.
In the Console, this is referred to as Decrypt/Encrypt.
Note: Trading Networks does not check to see whether the CA that
signed the certificate is included in the list of trusted CAs that the
webMethods Integration Server maintains. For more information, see
security information in Administering webMethods Integration Server.
Permissions
Trading Networks lists all the data sets for which the My webMethods user has the
Create Profile permission. You can add a partner to a data set by selecting the check box
against the data set name. If the check box against the data set name is not selected, the
partner does not belong to the data set. To add the partners to all the data sets, select the
check box against the Rule Name check box.
The partner must be in at least one data set where the My webMethods user has the
Create Profile permission. If the user attempts to remove the partner from all the data
sets, and that partner does not belong to any data set that has the All Partners option
selected, then an error message is displayed and the changes are not saved.
112 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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. 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.
Administrators can edit the data sets using the Dataset tab.
For more information about the All Partners and Custom Selection options and about editing
data sets, see “Defining Data Sets and Granting Roles Permissions to Act on the Data Set”
on page 72.
Profile Statuses
Profiles can have one of the statuses listed in the following table:
Status Meaning
Active You have filled in the profile and Trading Networks has
programmatically determined that all profile fields (standard and
extended) are valid. You have enabled the profile to set the status to
“Active”.
Your (Enterprise) profile must be enabled before you can exchange
documents with partners. Additionally, if you enable a partner’s profile,
you will be able to exchange documents with that partner.
Inactive You have disabled the profile.
Either you have just added the profile, but not yet enabled it, or you have
disabled the profile.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 113
6 About Trading Partners
114 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
7 Defining and Managing Profile Fields
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 115
7 Defining and Managing Profile Fields
Required Fields
A required field is one that you want supplied for all profiles. Several of the standard
fields, as defined out-of-the-box, are required. Those that are not, you can mark as
required if you want. When you add extended fields, you can mark them as required. All
profiles on your system must have a value for required profile fields.
When you create your own profile or add a profile for a partner, you must supply
information for all required fields before Trading Networks will allow you to enable the
profile. When you are filling in a profile, Trading Networks places an asterisk (*) next to
the required fields, so you can easily determine the fields that are required.
116 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
7 Defining and Managing Profile Fields
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 117
7 Defining and Managing Profile Fields
118 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
7 Defining and Managing Profile Fields
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 119
7 Defining and Managing Profile Fields
120 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
7 Defining and Managing Profile Fields
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
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
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
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
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
122 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
7 Defining and Managing Profile Fields
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.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 123
7 Defining and Managing Profile Fields
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:
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.
4 Click OK.
124 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
7 Defining and Managing Profile Fields
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.
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
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.
7 Click OK.
126 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
7 Defining and Managing Profile Fields
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
7 Defining and Managing Profile Fields
Note: Use caution when changing fields from required to not required. If you have
services that use the field or if you might create or update services that use the field,
the information might not be available if the partner is not required to supply it.
When you already have profiles in your system and then change an extended field
from not required to required, you must manually edit the existing profiles for the
updated extended profile fields. This is true even when the updated extended profile
fields has a default value.
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
edit.
3 Update the field(s) you want to change. For a description, of what you can specify, see
step 6 on page 125.
4 Click OK.
Note: To permanently remove the extended profile field from the database, your
database administrator must remove it. Before you can remove the field, you must
first remove all rows from the PartnerProfileField table that reference the profile field
you want to delete.
128 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
7 Defining and Managing Profile Fields
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
disable.
3 Clear the check box in the Enabled field.
4 Click OK.
Important! To perform this procedure, you must first perform the procedure described
in “Disabling Extended Profile Fields” on page 128.
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
disable.
3 Select the check box in the Enabled field.
4 Click OK.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 129
7 Defining and Managing Profile Fields
130 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
8 Defining and Managing Your Profile (Your Enterprise)
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 131
8 Defining and Managing Your Profile (Your Enterprise)
Field Specify...
Corporation The name of your corporation, for example, “XYZ Steel Company”.
Name
Organization Optionally, the name of the organizational unit or division within
Unit your corporation, for example, “Sales and Marketing”.
Status Whether you want your profile enabled or disabled.
To enable the profile, select Active.
To disable the profile, select Inactive.
Note: You should always keep your profile disabled until you
complete filling in all the information you require in a profile.
Preferred Optionally, the language preference you use if needed for another
Language webMethods component (e.g., webMethods RosettaNet Module).
132 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
8 Defining and Managing Your Profile (Your Enterprise)
4 Add at least one external ID to your profile. To add each external ID, perform the
procedure below. Be sure to include an external ID type for each type of identification
that you use in documents. You can specify an unlimited number of external ID types.
a Click the External IDs tab.
b If the external ID type you want to use is not yet available, perform the following
to add it:
1 Click Add ID Type.
2 In the Type Name file, specify the name of the new external ID type.
3 Click OK.
c To add the external ID, click Add ID.
d Fill in the following fields:
Field Specify...
Note: You can add multiple external IDs that use the same type.
ID Value The value of the external ID type. For example, if you selected DUNS
and your D-U-N-S number is 987654321, specify 987654321 for ID
Value. The maximum length you can specify for an external ID is 128
characters.
e Click OK.
5 You can do one of the following:
Continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the
profile.
Click Save and Close to save the changes and close the profile.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 133
8 Defining and Managing Your Profile (Your Enterprise)
Note: Although the last step of each profile indicates that you should save the profile,
you can edit several tabs of the profile before saving.
After you have completed your profile, you might need to update it from time to time.
The following are some reasons for updating your own partner profile:
Change in your corporation information.
Change in your contact details.
Change in the port number on which Trading Networks listens for incoming requests.
Addition of extended profile fields that you need to fill in for your profile.
Change in the default certificate that Trading Networks uses to digitally sign
documents.
134 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
8 Defining and Managing Your Profile (Your Enterprise)
Field Specify...
Corporation The name of your corporation, for example, “XYZ Steel Company”.
Name
Organization The name of the organizational unit or division within your
Unit corporation, for example, “Sales and Marketing”.
Status Whether you want your profile enabled or disabled.
To enable the profile, select Active.
To disable the profile, select Inactive.
Preferred The language preference you use if needed for another webMethods
Language component (e.g., webMethods RosettaNet Module).
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 135
8 Defining and Managing Your Profile (Your Enterprise)
Field Specify...
Note: You can add multiple external IDs that use the same type.
ID Value The value of the external ID type. For example, if you selected DUNS
and your D-U-N-S number is 987654321, specify 987654321 for ID
Value. The maximum length you can specify for an external ID is 128
characters.
d Click OK.
5 To edit an external ID, change the information in the row containing the external ID
that you want to update. You can:
Select a new external ID type from the ID TYPE list.
Type a new value in the VALUE field.
6 To delete an external ID:
a Select the check boxes beside the external IDs that you want to delete.
b Click Delete.
136 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
8 Defining and Managing Your Profile (Your Enterprise)
4 To add an address:
a Click Add Address.
b Fill in the following fields:
Field Specify...
Address The street address for your corporation, for example, “123
Address Line 2 Main Street, Suite 456”.
Address Line 3
City The city where your corporation is located, for example, “Los
Angeles”.
State/Province The state or province where your corporation is located, for
example, “California”.
Postal Code The postal code (for example, a zip code) for the state or
province where your corporation is located, for example,
“90001”.
Country The country where your corporation is located, for example,
“USA”.
c Click OK.
5 To edit an existing address:
a Click in the EDIT column for the address you want to edit.
b Update the fields. For a description, see step 4b above.
c After updating the fields, click OK.
6 To delete an address:
a Select the check boxes beside the addresses that you want to delete.
b Click Delete.
7 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the
profile.
Click Save and Close to save the changes and close the profile.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 137
8 Defining and Managing Your Profile (Your Enterprise)
Field Specify...
138 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
8 Defining and Managing Your Profile (Your Enterprise)
Field Specify...
c Click OK.
5 To edit a contact:
a Click in the EDIT column for the address you want to edit.
b Update the fields. For a description, see step 4b above.
c After updating the fields, click OK.
6 To delete a contact:
a Select the check boxes beside the contacts that you want to delete.
b Click Delete.
7 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the
profile.
Click Save and Close to save the changes and close the profile.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 139
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.
140 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
8 Defining and Managing Your Profile (Your Enterprise)
Primary FTP Host The host name or IP address of your system, for
Primary FTPS example, “XYZSteel.com”.
Primary HTTP
Port The port number on which your system listens
Primary HTTPS
for incoming requests, for example, “5555”.
Secondary FTP
Secondary FTPS Note: If you do not supply a port number,
Secondary HTTP Trading Networks uses the following defaults:
Secondary HTTPS HTTP—80; HTTPS—443; FTP or FTPS—21.
FTP
FTPS
HTTP Location Where to deliver documents when using this
HTTPS delivery method.
For HTTP or HTTPS, specify the URL partners
should use to send documents to your
system via HTTP or HTTPS. This is typically
the following:
/invoke/wm.tn/receive
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 141
8 Defining and Managing Your Profile (Your Enterprise)
142 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
8 Defining and Managing Your Profile (Your Enterprise)
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 143
8 Defining and Managing Your Profile (Your Enterprise)
e If you prefer that partners use this delivery method to deliver documents to your
Trading Networks system, select the Use as preferred protocol check box.
If the Use as preferred protocol is not selected for any delivery method, Trading
Networks uses the Queue for polling delivery method.
f Click OK.
4 To edit a delivery method:
a Click in the EDIT column for the delivery method you want to edit.
b Update the fields. For a description, see step 4d above.
c If you prefer that partners use this delivery method to deliver documents to your
Trading Networks system, select the Use as preferred protocol check box.
If the Use as preferred protocol is not selected for any delivery method, Trading
Networks uses the Queue for polling delivery method.
d After updating the fields, click OK.
5 To delete a delivery method:
a Select the check boxes beside the delivery methods that you want to delete.
b Click Delete.
6 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the
profile.
Click Save and Close to save the changes and close the profile.
144 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
8 Defining and Managing Your Profile (Your Enterprise)
Note: If you do not know what to specify for an extended field and the description
does not indicate what to specify, contact your Trading Networks administrator to
determine what to specify.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 145
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.
b Select Add new user.
c In the User Information section of the dialog, fill in the following fields:
Field Specify...
User name The user name that you want to assign to the user you are
adding.
The user ID can be 1 through 255 characters and can
contain only alphanumeric ASCII characters with no
spaces. The user ID is not case sensitive.
d Click OK.
5 To associate an existing My webMethods user account with your profile:
a Select Add existing user.
b In the Search for Available Users, specify a single keyword that is contained in the
first name, last name, e-mail address, or user name of the user account that you
want to associate with the profile.
c Click Go.
d To associate users with your profile, move the users from the AVAILABLE USERS to
the SELECTED USERS list.
e Click OK.
6 To add a new My webMethods user account where you use the value of one of your
external IDs as the user name for the user account and associate that user account
with your profile:
a Select Add user from external ID.
b Select the external ID you want to use from the External ID list.
c In the User Information section of the dialog, fill in the following fields:
146 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
8 Defining and Managing Your Profile (Your Enterprise)
Field Specify...
d Click OK.
7 To remove My webMethods user accounts that are associated with your profile.
a Select the check boxes beside the user accounts that you want to delete.
b Click Remove.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 147
8 Defining and Managing Your Profile (Your Enterprise)
Likewise, if you add a private key, be sure also to add the certificate and CA certificate(s)
that are associated with the private key.
When looking for a certificate set to use, Trading Networks first looks for a certificate set
associated with a specific partner. For example, if Trading Networks needs to digitally
sign a document to send to partner A, it first looks in your profile to determine whether
you have a certificate set for partner A. If you do, Trading Networks uses those
Sign/Verify certificates. If it does not have a set of certificates for the specific partner,
Trading Networks uses the Default certificate set.
a Under the Default branch of the tree on the Certificates tab, click in the EDIT
column for the certificates a you want to add (SSL, Encrypt/Decrypt, or Sign/Verify).
b To add the private key, click Browse and use the Choose File dialog box to select
the private key file.
c To add a certificate, click Add Certificate, then click Browse and use the Choose File
dialog box to select the certificate file.
d Click OK.
5 To add certificate sets that you want Trading Networks to use when with specific
partners:
a Click Add Certificate Set.
b Use the search panel to search for the profiles of the partners you want to add
certificate sets for. For instructions for how to search for the partner profiles:
148 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
8 Defining and Managing Your Profile (Your Enterprise)
2 Click in the EDIT column for the certificates you want to add (SSL,
Encrypt/Decrypt, or Sign/Verify).
3 To add the private key, click Browse and use the Choose File dialog box to
select the private key file.
Note: If you add a private key, be sure also to add the certificate and CA
certificate(s) that are associated with the private key.
4 To add a certificate, click Add Certificate; then click Browse and use the Choose
File dialog box to select the certificate file.
5 Click OK.
6 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the
profile.
Click Save and Close to save the changes and close the profile.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 149
8 Defining and Managing Your Profile (Your Enterprise)
5 Click in the EDIT column for the certificates you want to update (SSL,
Encrypt/Decrypt, or Sign/Verify).
6 To remove the private key, select the Clear Private Key check box.
7 To add or update the private key, click Browse and use the Choose File dialog box to
select the private key file.
8 To add a new certificate:
a To add a certificate, click Add Certificate; then click Browse and use the Choose File
dialog box to select the certificate file.
b Click OK.
9 To remove a certificate, in the Certificates section of the screen, click in the REMOVE
column for the certificate you want to remove.
10 Click OK.
11 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the
profile.
Click Save and Close to save the changes and close the profile.
150 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
8 Defining and Managing Your Profile (Your Enterprise)
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 151
8 Defining and Managing Your Profile (Your Enterprise)
152 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 153
9 Defining and Managing Partner Profiles
Prerequisite
1 Create and enable your Enterprise profile. For instructions, see “Creating Your Own
Profile” on page 132 and “Enabling Your Profile—Changing the Status to Active”
on page 150.
2 Review the fields you need to fill out for partner profiles.
3 For each partner, obtain the partner information that you require in the profiles on
your system and have this information available when you create the profile.
Perform the procedure in this section to add a partner profile and fill in the minimum
fields to create the profile. For instructions for how to add additional information to the
profile, see “Updating Partner Profiles” on page 159. Although this section describes how
to create the base profile, then edit the profile to add additional information, you can add
all information when creating the profile. You can make your changes to multiple tabs
and save one time.
If you want to add a partner profile that is similar to an existing profile, use the procedure
in “Copying a Partner Profile” on page 180. When you copy an existing profile, the form
for the new profile is pre-filled with information from the profile that you select to copy.
Field Specify...
Corporation The name of the partner’s corporation, for example, “XYZ Steel
Name Company”.
Organization Optionally, the name of the organizational unit or division within
Unit the corporation, for example, “Sales and Marketing”.
154 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
Field Specify...
Note: You should keep the profile Inactive until you have completed
filling in all the information you require in a profile, for example,
delivery methods, users, etc.
Preferred Optionally the language preference the partner uses if needed for
Language another webMethods component (e.g., webMethods RosettaNet
Module).
4 Add at least one external ID to the profile. To add each external ID, perform the
procedure below. Be sure to include an external ID type for each type of identification
that the partner uses in documents. You can specify an unlimited number of external
ID types.
a Click the External IDs tab.
b If the external ID type you want to use is not yet available, perform the following
to add it:
1 Click Add ID Type.
2 In the Type Name file, specify the name of the new external ID type.
3 Click OK.
c To add the external ID, click Add ID.
d Fill in the following fields:
Field Specify...
Note: You can add multiple external IDs that use the same type.
ID Value The value of the external ID type. For example, if you selected
DUNS and your D-U-N-S number is 987654321, specify 987654321
for ID Value. The maximum length you can specify for an external
ID is 128 characters.
e Click OK.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 155
9 Defining and Managing Partner Profiles
156 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
If you separate keywords with a space, Trading Networks searches for profiles where
the keywords are in either the external IDs or the corporation name; however, both
keywords must be present for Trading Networks to find a match. For example, if you
specify abc corp, Trading Networks would return a profile with an external ID value
that is abc and the corporation name is corp. However, if neither the external IDs nor
the corporation name contain abc, even if the corp name is corp, Trading Networks
would not return the profile because the keyword abc is not present.
If you put the keywords in quotes, Trading Networks searches for profiles where all
keywords are in either the external ids and/or corporation name. For example, if you
specify “abc corp”, Trading Networks returns profiles where the external IDs contain
abc corp and/or where the corporation name contains abc corp.
If you leave the text box blank, Trading Networks searches for all partner profiles that
you are authorized to view. For more information about how to specify keywords, see
the Working with My webMethods guide.
4 Click Go to execute the search.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 157
9 Defining and Managing Partner Profiles
Note: If you specify multiple criteria for a single field, when forming the query to
search for profiles, Trading Networks always uses an OR condition between each
criteria, regardless of what you specify for the Search Condition field.
158 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
1 Search for the profile you want to view. If you need procedures for this step, see
“Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.
Note: Although the last step of each profile indicates that you should save the profile,
you can edit several tabs of the profile before saving.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 159
9 Defining and Managing Partner Profiles
1 Search for the profile you want to update. If you need procedures for this step, see
“Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.
Field Specify...
Corporation The name of the partner’s corporation, for example, “XYZ Steel
Name Company”.
Organization The name of the organizational unit or division within the partner’s
Unit corporation, for example, “Sales and Marketing”.
Status Whether you want the profile enabled or disabled.
To enable the profile, select Active.
To disable the profile, select Inactive.
Preferred The language preference the partner uses if needed for another
Language webMethods component (e.g., webMethods RosettaNet Module).
160 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
1 Search for the profile you want to update. If you need procedures for this step, see
“Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.
Field Specify...
Note: You can add multiple external IDs that use the same type.
ID Value The value of the external ID type. For example, if you selected DUNS
and your D-U-N-S number is 987654321, specify 987654321 for ID
Value. The maximum length you can specify for an external ID is 128
characters.
d Click OK.
5 To edit an external ID, change the information in the row containing the external ID
that you want to update. You can:
Select a new external ID type from the ID TYPE list.
Type a new value in the VALUE field.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 161
9 Defining and Managing Partner Profiles
1 Search for the profile you want to update. If you need procedures for this step, see
“Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.
Field Specify...
Address The street address for the partner’s corporation, for example,
Address Line 2 “123 Main Street, Suite 456”.
Address Line 3
City The city where the partner’s corporation is located, for
example, “Los Angeles”.
State/Province The state or province where the partner’s corporation is
located, for example, “California”.
162 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
Field Specify...
Postal Code The postal code (for example, a zip code) for the state or
province where the partner’s corporation is located, for
example, “90001”.
Country The country where the partner’s corporation is located, for
example, “USA”.
c Click OK.
5 To edit an existing address:
a Click in the EDIT column for the address you want to edit.
b Update the fields. For a description, see step 4b above.
c After updating the fields, click OK.
6 To delete an address:
a Select the check boxes beside the addresses that you want to delete.
b Click Delete.
7 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the
profile.
Click Save and Close to save the changes and close the profile.
1 Search for the profile you want to update. If you need procedures for this step, see
“Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 163
9 Defining and Managing Partner Profiles
Field Specify...
c Click OK.
5 To edit a contact:
a Click in the EDIT column for the address you want to edit.
b Update the fields. For a description, see step 4b above.
c After updating the fields, click OK.
6 To delete a contact:
a Select the check boxes beside the contacts that you want to delete.
b Click Delete.
164 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
1 Search for the profile of the partner you want to update. 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.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 165
9 Defining and Managing Partner Profiles
1 Search for the profile you want to update. If you need procedures for this step, see
“Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.
Note: You can also use the Delivery Settings tab to manage delivery methods. For
more information, 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. Specify a whole number.
Note: The Wait Between Retries and Retry Factor options are only
used when Trading Networks is using reliable delivery for an
immediate delivery method (as opposed to a scheduled
delivery method). Trading Networks does not use the Wait
Between Retries and Retry Factor settings for reliable delivery
with scheduled delivery because the queue’s delivery schedule
dictates how often to retry delivery attempts.
166 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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. Trading Networks
calculates the time to wait by multiplying the last wait time by
Retry Factor. Specify a whole number greater than zero for Retry
Factor.
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.
Polling Frequency How often in minutes you want your Trading Networks to
poll the partner’s system for documents.
Note: For more information about the Suspend Delivery check box, see “Suspending
Delivery for a Partner” on page 181.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 167
9 Defining and Managing Partner Profiles
1 Search for the profile you want to update. If you need procedures for this step, see
“Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.
Note: You can also use the Delivery Settings tab to manage reliable delivery and
polling settings. For more information, see “Managing Reliable Delivery and
Polling Settings in a Partner Profile” on page 165.
Primary FTP Host The host name of the partner’s system, for
Primary FTPS example, “XYZSteel.com”.
Primary HTTP
Port The port number on which the partner’s system
Primary HTTPS
listens for incoming requests, for example,
Secondary FTP
“5555”.
Secondary FTP
Secondary HTTP Note: If you do not supply a port number,
Secondary HTTPS Trading Networks uses the following defaults:
FTP HTTP—80; HTTPS—443; FTP or FTPS—21.
FTPS
HTTP
HTTPS
168 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 169
9 Defining and Managing Partner Profiles
170 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 171
9 Defining and Managing Partner Profiles
172 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
Queue for Use Public The public queue you want to use.
delivery Queue
Select the Use Public Queue and then select the
name of a public queue from the list.
Use Private The definition of the private queue.
Queue
For instructions for how to define a private
queue, see “Defining Private Queues” on
page 383.
e If the partner prefers that your system uses this delivery method to deliver
documents to the partner’s system, select the Use as preferred protocol check box.
If the Use as preferred protocol is not selected for any delivery method, Trading
Networks uses the Queue for polling delivery method.
Note: You cannot select the Queue for delivery as the preferred protocol.
f Click OK.
4 To edit a delivery method:
a Click in the EDIT column for the delivery method you want to edit.
b Update the fields. For a description, see step 4d above.
c If the partner prefers that your system uses this delivery method to deliver
documents to the partner’s system, select the Use as preferred protocol check box.
If the Use as preferred protocol is not selected for any delivery method, Trading
Networks uses the Queue for polling delivery method. You cannot select the Queue
for delivery as the preferred protocol.
d After updating the fields, click OK.
5 To delete a delivery method:
a Select the check boxes beside the delivery methods that you want to delete.
b Click Delete.
6 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the
profile.
Click Save and Close to save the changes and close the profile.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 173
9 Defining and Managing Partner Profiles
1 Search for the profile you want to update. If you need procedures for this step, see
“Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.
Note: If you do not know what to specify for an extended field and the description
does not indicate what to specify, contact your Trading Networks administrator to
determine what to specify.
174 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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. 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.
Field Specify...
User name The user name that you want to assign to the user you are adding.
The user ID can be 1 through 255 characters and can contain only
alphanumeric ASCII characters with no spaces. The user ID is not
case sensitive.
d Click OK.
5 To associate an existing My webMethods user account with the partner profile:
a Select Add existing user.
b In the Search for Available Users, specify a single keyword that is contained in the
first name, last name, e-mail address, or user name of the user account that you
want to associate with the partner.
c Click Go.
d To associate users with the partner profile, move the users from the AVAILABLE
USERS to the SELECTED USERS list.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 175
9 Defining and Managing Partner Profiles
e Click OK.
6 To add a new My webMethods user account where you use the value of one of the
partner’s external IDs as the user name for the user account and associate that user
account with the partner profile:
a Select Add user from external ID.
b Select the external ID you want to use from the External ID list.
c In the User Information section of the dialog, fill in the following fields:
Field Specify...
d Click OK.
7 To remove My webMethods user accounts that are associated with the partner
profile.
a Select the check boxes beside the user accounts that you want to delete.
b Click Remove.
176 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
When looking for a certificate set to use, Trading Networks first looks for a certificate set
associated with a specific partner. For example, if Trading Networks needs to verify the
digital signature of partner A, it first looks for a partner A certificate set. If found, Trading
Networks uses those Sign/Verify certificates. If it does not have a set of certificates for the
specific partner, Trading Networks uses the Default certificate set.
1 Search for the profile you want to update. If you need procedures for this step, see
“Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 177
9 Defining and Managing Partner Profiles
a Under the Default branch of the tree on the Certificates tab, click in the EDIT
column for the certificates a you want to add (SSL, Encrypt/Decrypt, or Sign/Verify).
b To add the private key, click Browse and use the Choose File dialog box to select
the private key file.
c To add a certificate, click Add Certificate, then click Browse and use the Choose File
dialog box to select the certificate file.
d Click OK.
5 To add certificate sets that you want Trading Networks to use when with specific
partners:
a Click Add Certificate Set.
b Use the search panel to search for the profiles of the partners you want to add
certificate sets for. For instructions for how to search for the partner profiles:
Keyword searches, see “Performing a Keyword Search for Partner Profiles” on
page 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 partners that you want to add certificate sets for by moving the partner
profiles from the AVAILABLE PARTNERS list to the SELECTED PARTNERS list.
d Click OK.
Trading Networks adds a branch to the tree for each partner you selected.
e For each partner, perform the following to add a certificate set for that partner:
1 Expand the tree for the partner.
2 Click in the EDIT column for the certificates you want to add (SSL,
Encrypt/Decrypt, or Sign/Verify).
3 To add the private key, click Browse and use the Choose File dialog box to
select the private key file.
Note: If you add a private key, be sure also to add the certificate and CA
certificate(s) that are associated with the private key.
4 To add a certificate, click Add Certificate; then click Browse and use the Choose
File dialog box to select the certificate file.
5 Click OK.
178 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
1 Search for the profile you want to update. If you need procedures for this step, see
“Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.
5 Click in the EDIT column for the certificates you want to update (SSL,
Encrypt/Decrypt, or Sign/Verify).
6 To remove the private key, select the Clear Private Key check box.
7 To add or update the private key, click Browse and use the Choose File dialog box to
select the private key file.
8 To add a new certificate:
a To add a certificate, click Add Certificate; then click Browse and use the Choose File
dialog box to select the certificate file.
b Click OK.
9 To remove a certificate, in the Certificates section of the screen, click in the REMOVE
column for the certificate you want to remove.
10 Click OK.
11 You can do one of the following:
Click a different profile tab to continue editing the profile without saving.
Click Save to save the changes you have made and continue working on the
profile.
Click Save and Close to save the changes and close the profile.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 179
9 Defining and Managing Partner Profiles
1 Search for the profile you want to copy. If you need procedures for this step, see
“Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.
2 Click in the ACTION column in the row containing the partner profile you want to
copy.
3 In the Partner Details panel, fill in the following fields:
Field Specify...
Corporation The name of the partner’s corporation, for example, “XYZ Steel
Name Company”.
Organization Optionally, the name of the organizational unit or division within
Unit the corporation, for example, “Sales and Marketing”.
Status Whether you want the profile enabled or disabled.
To enable the profile, select Active.
To disable the profile, select Inactive.
Note: You should keep the profile Inactive until you have completed
filling in all the information you require in a profile, for example,
delivery methods, users, etc.
Preferred Optionally the language preference the partner uses if needed for
Language another webMethods component (e.g., webMethods RosettaNet
Module).
4 Click the External IDs tab and add external IDs for the partner. For instructions, see
“Managing Your Partner’s External IDs” on page 161.
5 Make any other changes you need to make to the profile. For instructions, see the
sections in “Updating Partner Profiles” on page 159.
180 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
Reliable service execution tasks are also affected when deliveries are suspended. When
delivery is suspended for a partner, Trading Networks assigns the service execution tasks
a HELD status. As a result, Trading Networks does not attempt to execute the services.
When delivery is resumed, Trading Networks updates the task statuses to PENDING and
as a result, Trading Networks attempts to execute the services.
1 Search for the profile of the partner for whom you want to suspend delivery. If you
need procedures for this step, see “Performing a Keyword Search for Partner Profiles”
on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 181
9 Defining and Managing Partner Profiles
1 Search for the profile of the partner for whom you want to resume delivery. If you
need procedures for this step, see “Performing a Keyword Search for Partner Profiles”
on page 157 or “Performing an Advanced Search for Partner Profiles” on page 158.
Deleting a Profile
When you delete a profile from the Trading Networks Console, Trading Networks
removes most of the profile data from its database, but keeps all documents, entries, and
TPAs associated with the partner. You can no longer view the profile or any related TPAs.
If you decide to delete a profile, you must also delete all related TPAs before deleting the
profile.
Trading Networks does not provide a way to “undelete” a profile. If a partner sends you a
document after you delete its profile, Trading Networks treats the document as an
unknown document.
Important! When you delete a partner’s profile, Trading Networks does not delete the
associated user accounts. To delete an My webMethods user account, see
Administering My webMethods Server. To delete an Integration Server user account, see
Administering webMethods Integration Server.
1 Search for the profile(s) you want to delete. If you need procedures for this step, see
“Performing a Keyword Search for Partner Profiles” on page 157 or “Performing an
Advanced Search for Partner Profiles” on page 158.
2 Select the check boxes beside the partner profiles that you want to delete.
3 Click Delete.
182 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
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.
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
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.
To search for partner certificates that are expired or that are expiring soon
184 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
9 Defining and Managing Partner Profiles
To search for partner certificates that are expired or that are expiring soon
Note: If you select Expired, Trading Networks searches for expired certificates.
Use Custom to specify a custom time period. See below for more information.
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
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 187
10 Defining and Managing Partner Groups
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
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 189
10 Defining and Managing Partner Groups
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.
190 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
10 Defining and Managing 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)
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 193
11 Defining and Managing Trading Partner Agreements (TPAs)
Sender Name of the trading partner that has the sender role in the TPA. You
select the sender from the profiles defined on your Trading
Networks system, including your own profile (Enterprise).
Receiver Name of the trading partner that has the receiver role in the TPA.
You select the receiver from the profiles defined on your Trading
Networks system, including your own profile (Enterprise).
Agreement ID An application-specific field that uniquely identifies the type of
agreement between two partners.
194 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
11 Defining and Managing Trading Partner Agreements (TPAs)
IS Document Type An IS document type that specifies the data that you define in the
TPA. For more information about changing the data, see “Changing
the TPA Data Inputs in the IS Document Type” on page 204.
When using the TPA feature for your own custom application, these
are the parameters that your custom applications need access to
during document exchange. Use the webMethods Developer to
create the IS document type that contains the parameters you need
for your custom application. For more information on how to create
an IS document type, see Developing Integration Solutions:
webMethods Developer User’s Guide.
webMethods components that use the TPA feature come with the IS
document type you need to use for the TPA data. For example, the
webMethods EDI Module supplies the wm.b2b.editn.TPA:EDITPA IS
document type and the webMethods ebXML Module supplies the
wm.ip.ebxml.cpa.rec:tpaDataSchema IS document type. For more
information about EDI TPAs, see the webMethods EDI Module
Installation and User’s Guide.
Control Number A field that is available for application-specific use. Trading
Networks does not update the Control Number field.
When using the TPA feature for your own custom application, you
can use the Control Number field in any way you want. Some
webMethods’ components that take advantage of the TPA feature
use the Control Number field. For example, the webMethods EDI
Module uses the control number to ensure documents are processed
in order and that no documents have been lost or unprocessed.
Data Status This field applies only when the Agreement Status is Agreed. The data
status indicates whether you can update the values for the TPA data
defined in the IS document type (located in the panel on the lower
portion of the Agreement Details dialog box). The data status can be
one of the following:
Modifiable - the TPA data can be changed
Non-modifiable - the TPA data cannot be changed
Note: Trading Networks uses the data status only after the TPA has
an Agreed status. For more information about TPA statuses, see
“Changing a TPA Agreement Status” on page 202. For more
information about changing the TPA data defined in the IS
document type, see “Changing the TPA Data Inputs in the IS Document
Type” on page 204.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 195
11 Defining and Managing Trading Partner Agreements (TPAs)
Export Service A service that exports a Trading Networks TPA and converts it to an
industry-standard format. After creating a TPA, if you need to
obtain the industry-standard format of a TPA, you can execute your
export service. Defining an export service is optional.
Initialization A service that sets default values for the IS document type data of
Service the TPA. Defining an initialization service is optional. You can set
this field to point to an IS service that can provide the initial values
for that data.
When using the TPA feature for your own custom application, you
can create an initialization service that populates the parameters in
the IS document type with default values. Some webMethods’
components that take advantage of the TPA feature supply an
initialization service. For example, the webMethods EDI Module
supplies the service wm.b2b.editn.TPA:initService that populates the
EDITPA with the default values for an EDI TPA. The webMethods
ebXML Module supplies the wm.ip.ebxml.cpa:initTPA initialization
service.
For more information about EDI TPAs, see the webMethods EDI
Module Installation and User’s Guide. For more information about
ebXML CPAs, see the webMethods ebXML Installation and User’s
Guide.
Description This is an optional field that you can use to specify a description for
the TPA. Specify 1-1024 characters. There is no restriction to the
characters that you can use.
Defining a TPA
You define TPAs on the Agreement Details screen of the Trading Networks Console.
After you set the attributes of your TPA on the top portion of this screen and select the IS
document type, Trading Networks displays the corresponding IS document type data
tree on the bottom panel of the screen. The right side of this panel displays the input
values (TPA data inputs) to variables of the IS document type.
196 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
11 Defining and Managing Trading Partner Agreements (TPAs)
To define a TPA
New—The TPA fields are empty. Select Agreements > New. Trading Networks
displays the Agreement Details screen to allow
you to fill in the information for 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, and then
agreements that you duplicate. select Agreements > Duplicate. Trading Networks
You can update any or all fields displays the Agreement Details screen.
from the duplicated TPA
agreement.
You can use this function to
create a template TPA.
3 Fill in the following fields on the Agreement Details screen for the TPA you want to
create:
Note: The Sender, Receiver, and Agreement ID fields must be unique for each TPA.
After you create a TPA, you cannot change or update these fields of the TPA.
Sender Name of the trading partner that has the sender role in the
transaction the TPA will govern. Type in the name of the sender
or click the Select button to select the sender from the
Partner Selection Dialog. This list includes your own profile
(Enterprise).
For EDI, to create a template that you will duplicate to create
other TPAs, you can use the default value of Unknown.
For more information about how to select a sender, see
“Selecting TN Document Types” on page 33.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 197
11 Defining and Managing Trading Partner Agreements (TPAs)
Receiver Name of the trading partner that has the receiver role in the
transaction the TPA will govern. Type in the name of the
receiver or click the Select button to select the receiver from
the Partner Selection Dialog. This list includes your own profile
(Enterprise). For EDI, to create a template that you will duplicate
to create other TPAs, you can use the default value of Unknown.
For more information about how to select a receiver, see
“Selecting TN Document Types” on page 33.
Agreement ID An identifier that indicates the type of agreement between the
two partners. The Sender, Receiver, and Agreement ID values
together uniquely identify a TPA.
Note: You will not be able to continue creating a TPA unless you
supply the Agreement ID. After you supply the Agreement ID, you
can: create the TPA or continue to supply data for the
remaining fields.
198 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
11 Defining and Managing Trading Partner Agreements (TPAs)
Data Status Whether you want to be able to modify the values of the TPA
data of the IS document type. The data status is only applicable
when the agreement status is Agreed.
For more information about statuses, see “Changing a TPA
Agreement Status” on page 202.
Export Service A service to convert the data in the Trading Networks TPA to
an industry-format trading partner agreement. For more
information about the export service, see “Information You
Supply to Define a TPA” on page 194.
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.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 199
11 Defining and Managing Trading Partner Agreements (TPAs)
Note: Trading Networks disables the OK button until you supply the Sender, Receiver,
and Agreement ID fields. If you clear any of the Sender, Receiver, and Agreement ID fields
during the creation of the TPA, Trading Networks will disable the OK button, as well
as the other TPA fields. You will not be able to save the TPA unless you supply the
Sender, Receiver, and Agreement ID fields.
Managing TPAs
The following table describes the tasks you can perform against TPAs:
To view TPAs
a Select Show Query on the toolbar to have Trading Networks display the search
criteria.
200 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
11 Defining and Managing Trading Partner Agreements (TPAs)
b To indicate that you want to use one or more of the search criteria, select the check
box next to each criterion you want to use. Then fill out the corresponding
information as follows.
Sender The name of the trading partner that has the sender role for
the TPA. Type in the name of the sender or click the Select
button to select the sender from the Partner Selection Dialog.
For more information about the Select button, see
“Selecting TN Document Types” on page 33.
Receiver The name of the trading partner that has the receiver role for
the TPA. Type in the name of the receiver or click the
Select button to select the receiver from the Partner Selection
Dialog. For more information about the Select button, see
“Selecting TN Document Types” on page 33.
Agreement ID The Agreement ID of the TPA that you want to view.
Agreement The status of the agreement that you want to view: Proposed,
Status Disabled, or Agreed. For more information about statuses, see
“Changing a TPA Agreement Status” on page 202.
IS Document The IS document type for the TPA data you want to use. 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.
Timestamp The time Trading Networks last updated the TPA either
when the TPA was created or last updated. Select an entry
from the list. To specify a date range, select Custom from the
list. Then specify dates in the Beginning and Ending fields. You
can type in a date value, or click Select Date to open a
dialog that allows you to select the date from a calendar.
For more information about the TPA attribute fields, see “Information You Supply to
Define a TPA” on page 194.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 201
11 Defining and Managing Trading Partner Agreements (TPAs)
c Select Run Query on the toolbar. Trading Networks updates the Agreements
table on the bottom portion of the screen with the query results.
d Double click to select the partner you want from query results in the Profiles table
on the bottom portion of the screen. Trading Networks displays the Agreement
Details screen.
For more information about the tabs and fields on this screen, see “Defining a
TPA” on page 196.
For procedures on how to change the information in your partner’s profile, see
“Updating TPAs” on page 202.
Updating TPAs
Use the following procedure to update a TPA.
To update a TPA
1 Select the TPA you want to update. If you need procedures for this step, see “Finding
and Viewing TPAs” on page 200.
2 Select Agreements > Edit.
3 Update the TPA fields you want to change:
For information on what you can specify for the fields in the Agreement Details
screen, see step 3 on page 197.
For instructions on how to change the Agreement Status, see the next section,
“Changing a TPA Agreement Status”.
Important! You cannot modify or update the Sender, Receiver, or Agreement ID field of
a TPA.
4 For instructions on how to update the inputs for the IS document type, see “Changing
the TPA Data Inputs in the IS Document Type” on page 204.
202 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
11 Defining and Managing Trading Partner Agreements (TPAs)
Select the Disabled status when you no longer want Trading Networks to use a specific
TPA. For example, in a transaction between two partners (e.g., Partner A and Partner B)
who sell products to one another, the agreement status of the TPA might change
depending upon business conditions. If Partner A is delinquent on payments to Partner
B, then Partner B might change Partner A’s agreement status to Disabled - so that no further
transactions could occur. After Partner A pays his payments, however, Partner B would
change the agreement status to Agreed.
The following table explains what each status is and the changes you can make to the
Agreement Status.
Note: To modify the data of the TPA, you must change the
agreement status from Agreed to Proposed. For more information,
see “Changing the TPA Data Inputs in the IS Document Type” on
page 204.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 203
11 Defining and Managing Trading Partner Agreements (TPAs)
Agreed
-OR-
Right-click and select from the menu items: Proposed, Disabled, or Agreed.
Trading Networks displays the new status in the Agreement Status column.
204 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
11 Defining and Managing Trading Partner Agreements (TPAs)
Use the following procedure to change the inputs for the IS document type.
1 Select the TPA you want to update. If you need procedures for this step, see “Finding
and Viewing TPAs” on page 200.
2 Update the TPA data input in the IS document type fields you want to change using
one of the following three methods:
Note: To access the TPA data inputs to change them, you need to have the
following values: 1) the Agreement Status is Proposed or 2) the Agreement Status is
Agreed and the Data Status is Modifiable. For more information, see “Changing a TPA
Agreement Status” on page 202.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 205
11 Defining and Managing Trading Partner Agreements (TPAs)
Deleting a TPA
When you delete a TPA, Trading Networks deletes all of the TPA data from its database.
Important! Trading Networks does not provide a way to “undelete” the TPA.
Before you delete a profile that is referenced by a TPA, you must first delete any
related TPAs. If you accidentally deleted the profile and not the TPA, you can delete
the invalid TPA. For more information, see “Deleting a Profile” on page 182.
You can only delete TPAs with the Proposed or Disabled agreement status. You cannot
delete TPAs with an Agreed status. If you want to delete a TPA with an Agreed status, you
will need to first change the agreement status to either Proposed or Disabled, and then
Trading Networks allows you to delete the TPA.
To delete a TPA, perform the following procedure:
To delete a TPA
1 Select the TPA you want to delete. If you need procedures for this step, see “Finding
and Viewing TPAs” on page 200.
2 Select Agreements > Delete to delete the TPA. When Trading Networks prompts you to
verify that you want to delete the TPA, click Yes.
Note: If you are deleting a non-modifiable agreement, you will need to use the
wm.tn.tpa:deleteTPA service. For more information, see the webMethods Trading Networks
Built-In Services Reference guide.
206 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
III Defining Transaction Processing
Defining and Managing Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Defining and Managing TN XML Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Defining and Managing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Defining and Managing Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 207
III Defining Transaction Processing
208 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
12 Defining and Managing Document Attributes
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 209
12 Defining and Managing Document Attributes
System
Attribute Description
For more information about these system attributes, see “Important Attributes that You
Should Extract from an XML Document” on page 226 or “Attributes To Extract From
Documents” on page 293.
You should define custom document attributes for all types of documents that you expect
to receive; a document attribute is not associated with a specific document type. Later,
when you define your TN document types, you will specify which document attributes
to include in each document type. Instructions for creating document types appear in
Chapter 13, “Defining and Managing TN XML Document Types” and Chapter 14,
“Defining and Managing TN Flat File Document Types”.
To define a document attribute you specify the attribute’s name, description, and data
type (DATETIME, DATETIME LIST, NUMBER, NUMBER LIST, STRING, or STRINGLIST). In addition,
you can specify whether Trading Networks should save the attribute to the database (the
default behavior).
210 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
12 Defining and Managing Document Attributes
When you define a TN document type, you identify the attributes that you want Trading
Networks to extract from the type of document. Different kinds of documents have
different formats, so the location of attributes within a document is based on the specific
kind of document. To identify the attributes, you specify the name of the attribute and
how Trading Networks is to locate the attribute in the specific type of document. In
addition, you can indicate whether you require the attribute to be extracted. If you mark
an attribute as required and Trading Networks is unable to extract the attribute from the
document, Trading Networks records the error.
In the TN document type (or in a processing rule), you can specify that you want Trading
Networks to save the document to the database. If you do this, Trading Networks saves
the custom attributes it extracts. Trading Networks saves a custom attribute only if the
TN document type or processing rule indicates to save that attribute.
Note: Regardless of whether you save custom attributes or not, Trading Networks
always saves all system attributes except Signature and SignedBody.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 211
12 Defining and Managing Document Attributes
For more information about document attributes, see Understanding webMethods B2B:
webMethods Trading Networks Concepts Guide.
Note: If new attributes are created while you have an open My webMethods session,
those attributes will not be included in My webMethods displays until you log out
then back into My webMethods or until you refresh your cache in My webMethods.
For more information about how to refresh your My webMethods cache, see
information about My webMethods user preferences in Managing B2B Integrations:
webMethods Trading Networks User’s Guide.
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.0
12 Defining and Managing Document Attributes
Name The name you want to give to the attribute. You can specify
1 to 64 characters. You can use any character except a single
quote (').
Example: If you are defining an attribute for the price of an item
in a purchase order, you might use the name “LineItemPrice”.
Type The data type of the attribute. Select the data type (DATETIME,
DATETIME LIST, NUMBER, NUMBER LIST, STRING, or STRINGLIST)
from the list.
Description Optional. A description of the attribute. You can specify 1 to
256 characters. You can use any character except a single quote
(').
Example: If you are defining an attribute for the price of an item
in a purchase order, you might specify the description “The
price of an item in a purchase order”.
Enabled Whether this attribute is enabled or not. If the document
attribute is disabled, select this check box to enable it. For more
information, see “Enabling Document Attributes” on page 216
or “Disabling Document Attributes” on page 215.
Save Whether this attribute is eligible to be saved to the Trading
Networks database.
If you select this check box and the pre-processing actions
indicate to save attributes to the database, Trading
Networks saves this attribute to the database.
If you do not select this check box and the pre-processing
actions indicate to save attributes to the database, Trading
Networks does not save this attribute. Deselect this check
box if the attribute value is needed during document
processing, but does not need to be kept in the database.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 213
12 Defining and Managing Document Attributes
To display disabled document attributes, click Show All to show both enabled (yellow
light bulbs) and disabled (darkened light bulbs) items.
214 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
12 Defining and Managing Document Attributes
To hide disabled document attributes, click Show Enabled to only show enabled
(yellow light bulbs) items. Trading Networks does not display any disabled (darkened
light bulbs) items.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 215
12 Defining and Managing Document Attributes
Note: To permanently remove the document attribute from the database, your
database administrator must remove it. When you remove a document attribute from
the database, you must also remove all TN document types that reference this
attribute and all documents that had this attribute extracted from them.
Important! To perform this procedure, you must first perform the procedure described
in “Displaying Disabled Document Attributes” on page 214.
216 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
12 Defining and Managing Document Attributes
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 217
12 Defining and Managing Document Attributes
218 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 219
13 Defining and Managing TN XML Document Types
220 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
for both the identifying XQL queries and the XQL queries to extract attributes. For
more information, see “Namespace Mappings in TN XML Document Types” on
page 236.
Options. You can use the options to define items for later processing. When specifying
the options for an XML document, you can specify:
An IS document type that defines the structure of the XML document and that can
be used to parse the XML document into an IData object. Trading Networks uses
the IS document type if you invoke the wm.tn.doc.xml:bizdocToRecord service to
convert the document content in the BizDocEnvelope to an IData object. For more
information, see “Specifying an IS Document Type for TN XML Document Types”
on page 241.
An IS schema that defines the structure of the XML document. Trading Networks
uses this IS schema if you indicate you want to Trading Networks to perform the
pre-processing action to validate the structure of the XML document. For more
information, see “Specifying an IS Schema for TN XML Document Types” on
page 241.
Whether you want Trading Networks to perform any or all of the pre-processing
actions. Pre-Processing actions are actions that Trading Networks performs before
using the processing rule actions to process the XML document. For more
information, see “Specifying Pre-Processing Actions for TN XML Document
Type” on page 242.
For more information about processing large document types, see Appendix F, “Large
Document Handling”.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 221
13 Defining and Managing TN XML Document Types
Important! If the documents you expect use equivalent namespaces but have
different prefixes, you must also define namespace mappings for Trading
Networks to correctly locate the nodes identified by the XQL queries. For more
information, see “Namespace Mappings in TN XML Document Types” on
page 236.
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.
Each document that passes through your system should match exactly one TN document
type. Trading Networks matches documents against all enabled TN document types. If a
document matches more than one, Trading Networks cannot determine which of the
matching TN document types it should use.
To set up the identification information in a TN XML document type, specify one or more
of the following items described in the table below:
222 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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.
224 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 225
13 Defining and Managing TN XML Document Types
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.
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.
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.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 229
13 Defining and Managing TN XML Document Types
<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
<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.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 231
13 Defining and Managing TN XML Document Types
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
13 Defining and Managing TN XML Document Types
Note: When Trading Networks extracts a NUMBER or NUMBER LIST from a document, it
uses the number parsing behavior of java.lang.Number. For example, if the NUMBER or
NUMBER LIST contains the value “100zzz”, Trading Networks interprets the value as
“100”, instead of throwing an error as it would if the value were “zzz100”. If you want
to redefine this parsing behavior, you can write a custom attribute transformation.
For more information about custom transformations, see below, “Specifying a
Custom Transformation Service”.
The following sample CBL document shows two line items and the quantity to purchase
of each. To store the total number of items ordered in the attribute TotalItems, specify an
XQL query that specifies an array of numbers that contains the quantity of each line item,
and specify the format SUM.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 233
13 Defining and Managing TN XML Document Types
<PurchaseOrder>
. This element of the query indicates to
. select all occurrences of
. <OrderDetail> tags.
<ListOfOrderDetail>
<OrderDetail>
<BaseItemDetail>
<LineItemNum>1</LineItemNum>
.
.
.
<Quantity>
<Qty>10</Qty>
</Quantity>
.
.
.
<BaseItemDetail>
</OrderDetail> The XQL query points to these
<OrderDetail> tags. Trading Networks uses the
<BaseItemDetail> SUM format and stores the value
<LineItemNum>2</LineItemNum> 15 for the TotalItems attribute.
.
.
.
<Quantity>
<Qty>5</Qty>
</Quantity>
.
.
.
<BaseItemDetail>
</OrderDetail>
<ListOfOrderDetail>
.
.
.
</PurchaseOrder>
234 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
For more information about the inputs and outputs, see the section “Setting Input and
Output Values for Custom Transformation Services” below.
To view these specifications, use webMethods Developer. The specifications are located
in the WmTN package. For more information about these specifications, see the
webMethods Trading Networks Built-In Services Reference.
Note: The values may be null or an empty (zero length) string. For an
array data type (e.g., DATETIME LIST), any element in the values array
can be null or an empty string. Make sure that your custom
transformation service can handle null values or empty strings.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 235
13 Defining and Managing TN XML Document Types
As output, Trading Networks expects that you return the transforms values in the
following output variable:
For information about creating the service, seeDeveloping Integration Solutions: webMethods
Developer User’s Guide.
236 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
<order xmlns:standard="http://www.standards.org"
xmlns:custom="http://www.unitedsteel.com/orderDocs">
The namespace is associated with a URI that
uniquely identifies the 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. 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. Jones</custom:contact>
</standard:seller> This element is in the standard
namespace
<standard:LineItem>
<standard:LineItemNumber>1</standard:LineItemNumber>
<standard:partNumber>C8C8C8</standard:partNumber>
<standard:quantity>10</standard:quantity>
<custom:description>bar steel</custom:description>
</standard:LineItem>
This element is in the custom
</order> namespace
XML documents that use namespaces contain the xmlns attribute, which defines a
namespace. Each namespace is associated with a URI. Note that the URI does not have to
point to anything. It is used to uniquely identify the namespace.
Elements are considered to be in the same namespace if they are all associated with the
same URI. The xmlns attribute specifies the URI for a namespace and optionally, a prefix
associated with that namespace. When a namespace is associated with a string, this string
is used as a prefix when naming the elements in that namespace, which allows you to
easily identify the elements that belong to a specific namespace. For example, if a
document contains a namespace that is associated with the prefix string standard and the
quantity element is in the standard namespace, the element is represented in the XML
document as <standard:quantity>.
The exception for naming elements in a namespace with a prefix is when the elements
belong to the default namespace. When an XML document uses a default namespace, the
elements in the default namespace do not use a prefix. The documents with a default
namespace contain an xmlns attribute that specifies only the URI for a namespace, for
example:
xmlns=“http://www.standards.org”
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 237
13 Defining and Managing TN XML Document Types
However, not all documents use the same prefix for the same namespace. For example,
one document might use standard for a prefix and another might use CBL_standard.
Namespaces are the same if they identify the same URI, not the same prefix. As a result,
the following xmlns attributes identify the same namespace:
xmlns:standard=“http://www.standard.org/”
xmlns:CBL_standard=“http://www.standard.org/”
As a result, if the above xmlns attributes are used in two different documents, the XQL
queries for elements within those documents are different: For example, the following
XQL queries might represent the same elements:
/Order[0]/standard:buyer
/Order[0]/CBL_standard:buyer
However, if you execute the /Order[0]/standard:buyer XQL query against the document
that uses the prefix CBL_standard, the XQL query will fail.
The solution to this problem is namespace mappings. In a TN XML document type, you
define namespace mapping to identify all the prefixes that point to the same URI (in
other words, identify the same namespace).
Namespace Mappings
Namespace mappings map the prefixes used by namespaces to the URIs used by those
namespaces. With this information, if Trading Networks receives an XML document that
contains a prefix that you have in the namespace mappings, it can make the appropriate
substitutions in the XQL queries, if necessary, so that the queries find the elements of the
XML document as expected.
For example, you create your TN XML document type using a sample document that
uses the following namespace:
xmlns:standard=“http://www.standard.org/”
You have a trading partner that sends you documents, but the trading partner uses the
following namespace:
xmlns:CBL_standard=“http://www.standard.org/”
Note that the URIs are identical meaning it is the same namespace; however, the prefixes
are different. To accommodate the different prefixes, the TN XML document type
contains the following namespace mappings:
238 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Prefix URI
standard http://www.standard.org/
CBL_standard http://www.standard.org/
With this namespace mapping, a TN XML document type definition can use the XQL
query /Order[0]/standard:buyer, and Trading Networks will make the proper
substitution for a document that uses the CBL_standard prefix rather than the standard
prefix.
With the namespace mapping, the following XQL query will locate the "buyer" element in either of the following documents.
XQL query = /order[0]/standard:buyer
<order xmlns:standard="http://www.standards.org"
xmlns:custom="http://www.unitedsteel.com/orderDocs"> The XQL query points to this
element in this document
<standard:buyer>
<standard:DUNS>987654321</standard:DUNS>
<standard:company>SMK Products</standard:company>
<custom:contact>Mr. Smith</custom:contact>
<custom:customerNum>01031995</custom:customerNum>
</standard:buyer>
</order>
<order xmlns:CBL_standard="http://www.standards.org"
The XQL query points to this
xmlns:custom="http://www.unitedsteel.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. Smith</custom:contact>
<custom:customerNum>01031995</custom:customerNum>
</CBL_standard:buyer>
</order>
Define namespace mappings for a TN XML document type if the XML documents that
your trading partners send to Trading Networks use namespaces that are equivalent but
have different prefixes. If you do not define namespace mappings, the identifying XQL
queries and the XQL queries that locate document attributes will fail. As a result, if the
TN XML document types use identifying queries, Trading Networks will not match the
document to the TN XML document type. If the TN XML document type specifies XQL
queries to locate and extract attribute information, those queries will fail and Trading
Networks will not extract the attribute information.
To define namespace mappings, you can define them manually, or if you are using a
sample document, you can have Trading Networks populate the namespace mappings
table with the prefix and URIs from the xmlns attributes that define namespaces in the
sample document.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 239
13 Defining and Managing TN XML Document Types
Guideline Sample
Each prefix in the namespace
mappings table for a TN XML Prefix URI
document type must be unique. aaa http://www.ww.com
bbb http://www.xx.com
ccc http://www.yy.com
ddd http://www.zz.com
Note: Because Trading Networks uses the literal prefix0 to identify the default
namespace, you should not use prefix0 as the prefix in any document.
Additionally, be sure to include a mapping for each prefix/URI combination that you
expect to receive in XML documents from your trading partners. If Trading Networks
receives a document that uses a prefix not defined in the namespace mappings table, it
performs a literal match of the XQL queries against the document.
240 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 241
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. For more information, see below, “Specifying Pre-Processing Actions
for TN XML Document Type” on page 242.
242 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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. If the partner’s profile does not contain the certificates to use for
verification, Trading Networks cannot verify the digital signature.
For more information about how Trading Networks verifies the digital signature, see
Appendix B, "Security within Trading Networks" in Understanding webMethods B2B:
webMethods Trading Networks Concepts Guide.
Important! If the structure of a document is not valid, the validation service can return
many error messages. To limit the number of error messages, set the
tn.doc.validate.max_errs property in the Trading Networks properties file. For example,
to limit the number of errors to ten, specify the following:
tn.doc.validate.max_errs=10
For more information, see “Trading Networks Configuration Properties” on page 36.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 243
13 Defining and Managing TN XML Document Types
Note: There could be performance issues if you choose to use custom services for
duplicate checking based on the logic in the service you select.
The following lists reasons Trading Networks might be unable to correctly determine
whether a document is a duplicate:
Trading Networks previously received a document that it did not save to the database
and the same document is sent again.
Trading Networks previously received a document and saved it to the database, but
did not extract the DocumentID, SenderID, and/or ReceiverID system attributes from the
document.
244 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
You selected the Document ID, sender and document type option and Trading Networks
was unable to match the document to a TN document type.
Trading Networks saves the results of the duplicate document check to the pipeline. As a
result, it is available for your use in processing actions that you define in the processing
rule. For more information about the pipeline variables that are available to processing
actions, see “Action 1—Execute a Service” on page 334.
Additionally, Trading Networks uses the results of the duplicate document check in the
Save Document to Database pre-processing action.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 245
13 Defining and Managing TN XML Document Types
246 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Note: If new TN document types are created while you have an open My webMethods
session, those TN document types will not be included in My webMethods displays
until you log out then back into My webMethods or until you refresh your cache in
My webMethods. For more information about how to refresh your My webMethods
cache, see information about My webMethods user preferences in Managing B2B
Integrations: webMethods Trading Networks User’s Guide.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 247
13 Defining and Managing TN XML Document Types
1 In Trading Networks Console, perform one of the following procedures to start a new
TN XML document type and load a sample document.
248 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Note: Trading Networks displays a tree view of the XML document in the left side
on the screen. To view the document source, click Show Source.
4 Type the name you want to give the TN XML document type in the Name field. This
field is required.
5 Optionally, type a description for the TN XML document type in the Description field.
6 Click the Identify tab. Perform one or more of the following procedures to specify
information that indicates how Trading Networks is to identify documents. For
details about specifying any of this information, see “Identification Information in TN
XML Document Types” on page 222.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 249
13 Defining and Managing TN XML Document Types
Identifying Queries 1 In the sample document, select the node that you want the
identifying query to represent.
When you select a node, Trading Networks fills in the
Query field with the XQL query for the selected node and
displays the value in the Value field.
Note: This “filled in” query is for a specific node in the XML
document. This node is applicable for DATETIME, STRING, or
NUMBER data types. But, if you want to use DATETIME LIST,
STRING LIST, NUMBER (with Average, Minimum, Maximum, and
Sum), or NUMBERLIST data types, you need to update the
query so that it identifies an array of values.
For information about XQL queries, see Appendix E, “XQL
Reference”.
2 Right click and select Add an identifying query.
Trading Networks displays the Add an identifying query
dialog box. Trading Networks fills the Query field with the
XQL query for the node that you selected and the Value
field with the value of the node.
If you want the TN XML document type to require the
identifying query to evaluate to a value, specify the
value in the Value field.
If you do not want the TN XML document type to
require the identifying query to evaluate to a specific
value, clear the Value field.
3 Click OK.
Trading Networks adds the identifying query to the list on
the right.
4 Repeat this procedure for each identifying query that you
want to add.
Note:
To delete a query from the TN document type, select
the query row and click Delete selected identifying
query.
To view (in the sample document) the node that a
query represents, select the query row and click
Show node.
250 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Root Tag Click the Set button next to the Root Tag field. Trading
Networks determines the root tag of the sample document and
uses its value to populate the Root Tag field.
DOCTYPE Identifier Click the Set button next to the DOCTYPE Identifier field. Trading
Networks obtains the value that follows the SYSTEM or
PUBLIC literal string in the document type declaration
(DOCTYPE) in the sample document. If both literal strings
exist, Trading Networks uses the value after the SYSTEM
literal string. Trading Networks populates the DOCTYPE
Identifier field with the value it obtains from the document type
declaration in the sample document.
Pipeline Matching
1 Click Add New Pipeline Match.
2 Specify the following values in the Add Pipeline Matching
dialog box.
Name. Name of the pipeline matching variable.
Value. The value of the pipeline matching variable. This
field is optional. If you specify both the Name and the
Value of the pipeline matching variable, Trading
Networks checks to see that both exist in the pipeline.
If you specify only the Name and no Value, then Trading
Networks checks to see if the Name exists.
3 Click OK. Trading Networks adds the pipeline matching
variable to the list.
4 Repeat this procedure for each pipeline matching variable
that you want to add.
Important! You must supply at least one criterion that Trading Networks is to use to
recognize an XML document; that is, you must supply at least one identifying
query, a value for the Root Tag field, a value for the DOCTYPE Identifier field, or a
pipeline matching variable.
5 Click the Extract tab. Perform the following procedure for each attribute that you want
Trading Networks to extract from documents identified by this TN XML document
type. For details about what to specify for these fields, see “Extraction Information In
TN XML Document Types” on page 226.
a In the sample document, select the node that represents the attribute that you
want Trading Networks to extract.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 251
13 Defining and Managing TN XML Document Types
Note: This “filled in” query is for a specific node in the XML document. This
node is applicable for DATETIME, STRING, or NUMBER data types. But, if you
want to use DATETIME LIST, STRING LIST, NUMBER (with Average, Minimum,
Maximum, and Sum), or NUMBERLIST data types, you need to update the query
so that it identifies an array of values.
c In the Name field, select the name of the attribute from the list. Trading Networks
fills in the Description and Type fields based on the document attribute definition.
d If you want Trading Networks to flag an error if it encounters an error attempting
to extract this document attribute, select the Required check box. For more
information, see “Indicating that Attributes are Required in TN XML Document
Types” on page 228.
e Use the Transformation option to specify how Trading Networks is to handle
attribute data before storing it in the Trading Networks database. The data type of
the attribute (shown in the Type field) determines the Built-in or Custom
transformation options available. For more information, see “Transformation
Information for Extracted Attributes of TN Document Types” on page 229.
1 Built-in. Select an existing built-in transformation provided by Trading
Networks.
252 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Has STRING or You can specify whether you want Trading Networks
STRING LIST data to alter the string value before storing it to UPPERCASE
type (but not or LOWERCASE. For more information, see “Specifying
SenderID or Built-In Transformation Information for Attributes
ReceiverID) with the STRING or STRING LIST Data Type” on
page 231.
Has NUMBER data You should specify the operation that Trading
type and the XQL Networks should perform on the numbers in the array.
query identifies an For more information, see “Specifying Built-In
array of numbers Transformation Information for Attributes with the
NUMBER Data Type” on page 233.
Note: To delete an attribute from the TN document type, select the attribute
row and click Delete attribute. To view (in the sample document) the node
that a query represents, select the attribute row; then click Show node.
Important! If you do not extract the system attributes, Trading Networks does
not have this information available for processing rules or querying
documents.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 253
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, click Set.
To add the namespace information to the current namespace mappings, click
Append.
When you click either Set or Append, Trading Networks populates the namespace
table with the namespace information from all xmlns attributes in the sample
document.
For more information about namespaces, see “Namespace Mappings in TN XML
Document Types” on page 236.
7 Click the Options tab and fill in the fields. For details about these fields, see “Options
in TN XML Document Types” on page 240. For information specific to pre-processing
actions, see “Specifying Pre-Processing Actions for TN XML Document Type” on
page 242.
254 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 255
13 Defining and Managing TN XML Document Types
256 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 257
13 Defining and Managing TN XML Document Types
258 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Type the following query in the Query field and click Test Query:
Trading Networks updates the Value field to contain the value for
TotalLineNum, which is 1.
Show Source—all Use this button to display the source of the XML document. When
tabs you click this button, Trading Networks opens a new window that
contains the document source.
(Show Node)— Click to have Trading Networks highlight the node in the
Identify and Extract sample document that an XQL query for an identifying query or
tabs attribute represents.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 259
13 Defining and Managing TN XML Document Types
To define a TN XML document type when you do not have a sample document
1 In Trading Networks Console, perform one of the following procedures to start a new
TN XML document type.
New— The TN XML document type 1 Select View > Document Types.
fields are empty, and you load a
2 Select Types > New.
sample document from the file
system. 3 In the Create New DocType dialog
box, select the XML document type
category from the list.
Duplicate— The TN XML document 1 Select View > Document Types.
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.
duplicate.
You can update any or all fields from
3 Select Types > Duplicate.
the duplicated TN XML document
type.
4 In the Name field, type the name you want to give the TN XML document type. This
field is required.
5 Optionally, type a description for the TN XML document type in the Description field.
6 Click the Identify tab. Perform one or more of the following procedures to specify
information that indicates how Trading Networks is to identify documents. For
details about specifying any of this information, see “Identification Information in TN
XML Document Types” on page 222.
260 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Identifying Queries
1 Click Add an identifying query. Trading Networks
displays the Add an identifying query dialog box.
2 In the Query field, type an XQL query that represents a
node in a document that must exist for this TN XML
document type to be used for a document. For information
about XQL queries, see Appendix E, “XQL Reference”.
3 If you want the TN XML document type to require the
identifying query to evaluate to a specific value, type that
value in the Value field.
4 Click OK.
5 Repeat this procedure for each identifying query that you
want to add.
Type the value of the root tag from within the XML documents
that this TN XML document type is to match.
DOCTYPE Identifier Type the value of the system identifier or public identifier
from the document type declaration (DOCTYPE) within the
XML documents that this TN XML document type is to match.
Pipeline Matching
1 Click Add New Pipeline Match.
2 Specify the following values in the Add Pipeline Matching
dialog box.
Name. Name of the pipeline matching variable.
Value. The value of the pipeline matching variable. This
field is optional. If you specify both the Name and the
Value of the pipeline matching variable, Trading
Networks checks to see that both exist in the pipeline.
If you specify only the Name and no Value, then Trading
Networks checks to see if the Name exists.
3 Click OK. Trading Networks adds the pipeline matching
variable to the list.
4 Repeat this procedure for each pipeline matching variable
that you want to add.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 261
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; that is, you must supply at least one identifying
query, a value for the Root Tag field, a value for the DOCTYPE Identifier field, or a
pipeline matching variable.
5 Click the Extract tab. Perform the following procedure for each attribute that you want
Trading Networks to extract from documents identified by this TN XML document
type. For details about what to specify for these fields, see “Extraction Information In
TN XML Document Types” on page 226.
a Click Add an attribute. Trading Networks displays the Add an attribute dialog
box.
b In the Name field, select the name of the attribute from the list. Trading Networks
fills in the Type and Description fields based on the document attribute definition.
c If you want Trading Networks to flag an error if it encounters an error attempting
to extract this document attribute, select the Required check box. For more
information, see “Indicating that Attributes are Required in TN XML Document
Types” on page 228.
d In the Query field, type an XQL query that identifies the location of the attribute
within an XML document. For information about XQL queries, see Appendix E,
“XQL Reference”.
e If necessary, use the Transformation option to specify how Trading Networks is to
handle attribute data before storing it in the Trading Networks database. The data
type of the attribute (shown in the Type field) determines the Built-in or Custom
transformation options available. For more information, see “Transformation
Information for Extracted Attributes of TN Document Types” on page 229.
Important! If you do not extract the system attributes, Trading Networks does
not have this information available for processing rules or querying
documents.
262 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 263
13 Defining and Managing TN XML Document Types
Important! If you do not extract the system attributes, Trading Networks does
not have this information available for processing rules or querying
documents.
Note: To delete an attribute from the TN document type, select the attribute
query and then click Delete an attribute.
6 To define namespace mappings, click the Namespaces tab. Perform the following for
each namespace mapping you want to add to the table. For more information about
namespaces, see “Namespace Mappings in TN XML Document Types” on page 236.
a In the Namespace Mappings section of the screen on the right, click Add a
namespace mapping. Trading Networks adds a row to the namespace mappings
table.
b In the Namespace Prefix column, type the prefix for the namespace. If you are
adding a mapping for the default namespace, specify prefix0.
c In the URI Mapping column, type the URI for the namespace.
Note:
To delete a namespace mapping from the TN document type, select the
row for the namespace and click Delete selected namespace mapping.
To edit a namespace mapping, type over the existing information.
7 Click the Options tab and fill in the fields. For details about these fields, see “Options
in TN XML Document Types” on page 240. For information about pre-processing
actions, see “Specifying Pre-Processing Actions for TN XML Document Type” on
page 242.
264 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 265
13 Defining and Managing TN XML Document Types
Check for Duplicate Whether you want Trading Networks to determine whether it
Document has already received the document. Select one of the
pre-processing following:
action
Use built-in service to check for duplicate document
Use custom service to check for duplicate document. To create a
new service, click New Service. To select an existing
service, click Find Service.
Note: There could be performance issues if you choose to
use custom services for duplicate checking based on the
logic in the service you select.
For more information about how to create a custom
duplicate checking service, see, “Creating a Duplicate
Document Check Service” on page 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.
For more information about this pre-processing action, see
“Checking for Duplicate of the XML Document” on page 244.
Save Document to Whether you want Trading Networks to save the document to
Database the database; select Save all documents, Save only unique
preprocessing documents, or Do not save. Trading Networks performs this
action pre-processing action before it performs the processing actions
defined by the processing rule.
If you select to save documents to the database, select from the
list whether you want Trading Networks the document’s
content, attributes, and/or activity log information to the
database.
For more information about this pre-processing action, see
“Saving an XML Document to the Database” on page 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., if you want to deliver a document via
a queue), Trading Networks will bypass reliable delivery and
invoke the specified delivery service once.
266 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 267
13 Defining and Managing TN XML Document Types
Important! The TN XML document type must include at least one criterion that
Trading Networks can use to recognize a document; that is, at least one
identifying query, a value for the Root Tag field, a value for the DOCTYPE Identifier
field, or a pipeline matching variable.
268 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
To update this
Identify tab
parameter … Use these procedures when you have a sample document loaded…
Note: This “filled in” query is for a specific node in the XML
document. This node is applicable for DATETIME, STRING, or
NUMBER data types. But, if you want to use DATETIME LIST,
STRING LIST, NUMBER (with Average, Minimum, Maximum, and
Sum), or NUMBERLIST data types, you need to update the query
so that it identifies an array of values.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 269
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, click the Set button next to the DOCTYPE
Identifier field.
To remove the value from the DOCTYPE Identifier field, clear the
DOCTYPE Identifier field.
Pipeline Matching
To add a pipeline matching variable—Click Add New Pipeline
Match. In the Add Pipeline Matching dialog box, specify the
Name and optionally, the Value for the pipeline matching
variable. Click OK to save the variable and close the dialog
box.
To update a pipeline matching variable, click the row
containing the pipeline matching variable you want to
update and click Edit Selected Pipeline Match. In the
Update Pipeline Matching dialog box, update the Name
and Value fields for that variable. Click OK to save your
updates and close the Update Pipeline Matching dialog
box.
To delete a pipeline matching variable, click the row containing
the pipeline matching variable you want to delete and click
Remove Selected Pipeline Match.
7 To update extraction information, click the Extract tab. For information about how to
specify information on this tab, see “Extraction Information In TN XML Document
Types” on page 226.
To add an attribute—In the sample document, select the node that represents the
attribute that you want Trading Networks to extract. Right click and select Add an
attribute. Trading Networks opens the Add an attribute dialog box and populates
the Query field with the XQL query for the selected node.
Note: This “filled in” query is for a specific node in the XML document. This
node is applicable for DATETIME, STRING, or NUMBER data types. But, if you
want to use DATETIME LIST, STRING LIST, NUMBER (with Average, Minimum,
Maximum, and Sum), or NUMBERLIST data types, you need to update the query
so that it identifies an array of values.
270 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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, select the name of the attribute from the list.
b If you want Trading Networks to flag an error if it encounters an error
attempting to extract this document attribute, select the Required check box.
For more information, see “Indicating that Attributes are Required in TN
XML Document Types” on page 228.
c If necessary, use the Transformation option to specify how Trading Networks
is to handle attribute data before storing it in the Trading Networks
database.
d The data type of the attribute (shown in the Type field) determines the Built-
in or Custom transformation options available.
Important! If you do not extract the system attributes, Trading Networks does
not have this information available for processing rules or querying
documents.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 271
13 Defining and Managing TN XML Document Types
272 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Important! The TN document type must include at least one criterion that Trading
Networks is to use to recognize an XML document; that is, at least one identifying
query, a value for the Root Tag field, a value for the DOCTYPE Identifier field, or a
pipeline matching variable.
Identifying Queries
To add an identifying query—Click . Trading Networks
displays the Add an identifying query dialog box. In
the Query field, type an XQL query that represents a
node in a document that must exist for this TN
document type to be used for a document.
Note: This “filled in” query is for a specific node in the
XML document. This node is applicable for DATETIME,
STRING, or NUMBER data types. But, if you want to use
DATETIME LIST, STRING LIST, NUMBER (with Average,
Minimum, Maximum, and Sum), or NUMBERLIST data
types, you need to update the query so that it identifies
an array of values.
If you want the TN document type to require that the
identifying query evaluate to a specific value, type that
value in the Value field. Click OK to close the Add an
identifying query dialog box.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 273
13 Defining and Managing TN XML Document Types
274 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
6 To update extraction information, click the Extract tab. For information about how to
specify information on this tab, see “Extraction Information In TN XML Document
Types” on page 226.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 275
13 Defining and Managing TN XML Document Types
Namespace Prefix The prefix for the namespace. If you are adding a mapping
for the default namespace, specify prefix0.
URI Mapping The URI for the namespace.
Note: To permanently remove the TN document type from the database, your
database administrator must remove it. When you remove a TN document type from
the database, you must also remove all documents that are associated with the TN
document type.
276 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
Note: To view the Enabled column (if it is not currently displayed), select Document
Types > Show All.
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.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 277
13 Defining and Managing TN XML Document Types
Documents that match more than one defined TN XML document type. This type of document
would be an unknown TN document type because Trading Networks cannot
determine which of the matching TN XML document types to use. If your testing
finds a document that matches multiple TN document types (also called an ambiguous
document), you should update TN document types so that the document matches
exactly one TN XML document type.
To test the TN XML document types, you must have sample documents available in your
file system. To perform a test, you select the sample document. Trading Networks uses
the identification information in all TN XML document types to determine all TN
document types that match the specified document. Trading Networks highlights all
matching TN XML document types on the Document Types screen.
Note that Trading Networks does not test the sample document against disabled TN
document types. This means the Trading Networks does not highlight the disabled TN
document types that the document would match.
Important! During the test, Trading Networks does not actually process the document.
That is, Trading Networks does not perform any pre-processing or processing actions
on the document.
Perform the following procedure to test your TN XML document types for a specified
document.
278 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
13 Defining and Managing TN XML Document Types
1 In My webMethods: Administration > Integration > B2B Settings > Submit Documents.
2 In the Submit Method field, select one of the following options based on how you want
to submit the document.
Select Copy text to copy the file contents.
Select Upload file to upload the file.
Note: When you select the Upload file option, Trading Networks automatically
refreshes the page to display a corresponding field FileName. See step 4.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 279
13 Defining and Managing TN XML Document Types
280 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Defining Document Gateway Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Defining TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Managing TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 281
14 Defining and Managing TN Flat File Document Types
Overview
Flat file documents present data in a record-based storage format. Unlike XML files, flat
files do not have structural information embedded within the data. Trading Networks’
definition of a flat file is any file or document with a format that is non-describing, that is,
a document that does not contain metadata. In other words, flat file data is externalized
as a set of records (a list of records containing fields and composites) without any
structural information.
Because the records are not structured in a flat file document, the application receiving
the flat file must have knowledge of the flat file’s structure to read its content. To provide
this structural knowledge, you create a document gateway service and a corresponding
TN flat file document type for each type of document you expect to receive.
A document gateway service is the entry point for flat files into Trading Networks. It is a
Java or flow service that you create to provide information to Trading Networks about a
flat file. To provide this information, your service defines values in a pipeline variable
named TN_parms. The service should define values for:
System attributes, for example SenderID and ReceiverID in the TN_parms/SenderID
and TN_parms/ReceiverID, respectively.
Optional system variables, for example variables that specify the content type and
content encoding you want Trading Networks to use for the document.
Custom attributes (the document data).
After supplying the values needed in the TN_parms pipeline variable, the gateway service
passes control to Trading Networks for processing. Trading Networks will retrieve the
flat file information from the TN_parms pipeline variable.
In addition to creating a document gateway service, you define a corresponding TN flat
file document type that Trading Networks will use when it receives the document from the
gateway service. In a TN flat file document type you specify:
Values of variables within the TN_parms pipeline variable that Trading Networks uses
to match the document type to the incoming flat file document. For example, you
might define the document type to match when the TN_parms/Department variable has
a value of Billing and the TN_parms/Service_code variable has a value of XYZ.
The system and custom attribute values to extract. You can only extract values for the
attributes that the gateway service has placed in the TN_parms pipeline variable. In
addition, you can transform certain types of attribute data before Trading Networks
stores it in the database, using built-in or custom transformations.
Whether you want Trading Networks to process the documents that match the TN
document type using a processing rule or want to prevent Trading Networks from
performing processing rule actions.
Whether to perform pre-processing actions (such as validating the data structure and
checking for duplicate documents) before executing a processing rule.
282 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
Key Value
Department Billing
Service_code XYZ
A document would match this TN document type only if the gateway service adds
both of those pipeline variables (within TN_parms) and the variables have the
specified values. (You could have omitted the Service_code value if you wanted to
receive Billing department documents with any service code.)
Tip! Rather than having Trading Networks search all of your TN flat file document
types to find a match, you can explicitly specify in the gateway service the TN flat
file document type to use for the document. Specifying the document type
eliminates the overhead of that search.
Trading Networks logs a recognition error if any of the following conditions are met:
The data in the TN_parms pipeline variable does not match the pipeline matching
criteria in any TN flat file document type
The data in the TN_parms pipeline variable matches the pipeline matching criteria
in multiple TN flat file document types
The data in the TN_parms pipeline variable explicitly identifies the TN flat file
document type to use, but that TN document type does not exist
4 After finding a single matching TN flat file document type, Trading Networks adds
the extracted attributes to the BizDocEnvelope, which is placed in the pipeline as a
variable named bizdoc. A BizDocEnvelope represents a routable Trading Networks
transaction. It contains the flat file document, and Trading Networks adds additional
information that it uses for routing and processing.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 283
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. To extract attribute values, Trading Networks looks for
the values within the TN_parms pipeline variable. Trading Networks places the
extracted attribute values into the BizDocEnvelope.
In addition, Trading Networks can transform the extracted attribute values before
storing them into the BizDocEnvelope, using the optional built-in or custom
transformations that you specified.
By default if Trading Networks cannot extract a particular attribute value, it will not
log an error; it completes processing (assuming it finds no errors) and sets the
processing status to DONE.
If you want Trading Networks to log an error when it cannot extract particular
attribute values, you can designate those attributes as being required for extraction. In
this case, Trading Networks completes processing, logs the error to the activity log,
and sets the processing status to DONE W/ERRORS.
Continuing with the example document type Acme_XYZ_Invoices, suppose your
trading network expects to receive a document whose TN_parms will contain the
following attributes:
Attribute Value
You can extract any of these attributes. SenderID and ReceiverID are system
attributes that Trading Networks always requires in TN_parms, and always extracts.
Extracting all other system attributes, such as DocumentID, is optional. You extract
system attribute values if you want to use them as criteria for determining the
processing rule to use for a document, transaction analysis, process management, and
more. You can extract document data to perform any processing you want, such as
calculations.
6 Trading Networks does one of the following based on whether processing rule
routing is enabled or disabled:
If the TN flat file document type indicates that processing rule routing is disabled, Trading
Networks performs the pre-processing actions defined by the TN document type;
it then ends its processing. Trading Networks does not search for a processing
rule, nor does it perform any processing rule actions.
284 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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, Trading Networks passes the document to the Process
Engine, which in turn will determine the process model to use to process the
document.
If the TN flat file document type indicates that processing rule routing is enabled, Trading
Networks performs a processing rule lookup to determine the processing rule to
use for the incoming flat file document. For details, see Chapter 15, “Defining and
Managing Processing Rules”.
Tip! Trading Networks performs a processing rule lookup for each document
to determine the processing rule to use for it. Alternatively, you can explicitly
specify in the gateway service the processing rule to execute for a given TN
document type, thus bypassing the lookup (and its overhead).
You can also specify this same set of pre-processing actions in the processing
rule that you associate with the TN flat file document type. In the processing
rule, you can specify whether to use the pre-processing actions specified in the
processing rule, or to use the ones specified in the document type. For details,
see “Pre-Processing Actions” on page 331.
2 Trading Networks executes the processing rule actions. For details, see
Chapter 15, “Defining and Managing Processing Rules”.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 285
14 Defining and Managing TN Flat File Document Types
Note: If new TN document types are created while you have an open My webMethods
session, those TN document types will not be included in My webMethods displays
until you log out then back into My webMethods or until you refresh your cache in
My webMethods. For more information about how to refresh your My webMethods
cache, see information about My webMethods user preferences in Managing B2B
Integrations: webMethods Trading Networks User’s Guide.
286 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
d Explicitly specify the processing rule to use for processing the document
(optional).
This is an alternative to having Trading Networks look up the appropriate
processing rule to use, thus eliminating the overhead of that lookup. Use the
system variables TN_parms/processingRuleID and TN_parms/processingRuleName
for this purpose.
e Place the gateway service’s name into the pipeline to enable documents that
invoke this gateway service to be resubmitted if necessary (optional).
Use the system variable TN_parms/$receiveSvc for this purpose.
f Specify the content type and content encoding you want Trading Networks to use
for the document (optional).
This is an alternative to having Trading Networks automatically determine the
content type and content encoding of the document. Use the system variables
TN_parms/$contentType and TN_parms/$contentEncoding for this purpose.
3 Specify all custom attribute values (the document data) that the matching document
type is to extract. Make sure that the name and case you use for the TN_parms
pipeline variable match exactly to the attribute name that is defined in the TN flat file
document type.
4 Invoke either wm.tn:receive or wm.tn.doc.ff:routeFlatFile to pass ffdata and TN_parms to
Trading Networks.
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. If InputStream does not
support marking, ensure that you transform InputStream to support marking.
Otherwise, Trading Networks will lose the bytes read by the gateway service when
attempting to save the document content to the BizDocEnvelope.
If your document gateway service is a flow service, use the services provided in the pub.io
folder in the WmPublic package. The WmPublic package must be enabled to use these
services. For descriptions of the pub.io services, see webMethods Integration Server Built-In
Services.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 287
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. To do so, explicitly specify the content type and/or content
encoding in the TN_parms/$contentType and the TN_parms/$contentEncoding variables,
respectively.
For example, if a document with a content type of text/plain and an encoding of SJIS is
submitted to a service and that service passes the document into the pipeline to your
gateway service, the original content type and content encoding will be lost. The pipeline
has a content type of application/x-wmidatabin and a content encoding of UTF8. In this
case, either your gateway service or the service that invoked it, should specify text/plain
for TN_parms/$contentType and SJIS for TN_parms/$contentEncoding.
Important! Perform this action only if absolutely necessary because parsing can be
time-consuming and return very large outputs that consume much memory.
Note: Do not convert a document in both the gateway service and the TN document
type. If you convert a document in the gateway service, it will remain in the pipeline.
288 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 289
14 Defining and Managing TN Flat File Document Types
290 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 291
14 Defining and Managing TN Flat File Document Types
Tip! The gateway service can specify a value for either the TN_parms/DoctypeID or
TN_parms/DoctypeName variable to explicitly specify the document type to use for the
flat file document. Doing so eliminates the overhead of the search that Trading
Networks would have to perform to find the matching TN flat file document type.
Key Value
Department Billing
Service_code XYZ
A document would match this document type only if it contains both of those variables
within TN_parms and the variables have those values. (You could have omitted the
Service_code value if you wanted to receive Billing department documents with any
service code.)
292 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
Attribute Value
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 293
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.00
You can extract any of these attributes. Trading Networks always extracts the system
attributes SenderID and ReceiverID. Extracting all other system attributes, such as
DocumentID, is optional. You extract system attribute values if you want to use them as
criteria for determining the processing rule to use for a document, transaction analysis,
process management, and more. You can extract document data to perform any
processing you want, such as calculations. For more information, see “System Attributes
To Extract From Documents” on page 295.
294 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 295
14 Defining and Managing TN Flat File Document Types
true in a TN flat file document type, Trading Networks would determine the sender
of the document based on the user account 123456789, find the profile (and therefore
the internal ID), and put that value in the BizDocEnvelope.
Important! When you resubmit a flat file document with the Retrieve SenderID from
session option selected, the resubmit might fail. If you set up Sender criteria in a
processing rule, the first time the document arrives, the criteria matches a
processing rule based on the SenderID value 123456789 because that is the value
determined via the Retrieve SenderID from session option.
However, if you resubmit the document, that same processing rule will not be
selected based on the Retrieve SenderID from session option. This is because when
you resubmit the document from the Trading Networks Console, the user is the IS
user account that you used to log in to the Trading Networks Console (e.g.,
Administrator), which will not match sender 123456789 in the Sender criteria of
the processing rule. It could end up matching another processing rule and then go
through completely different processing.
DocumentID
When Trading Networks has a value for DocumentID, you can perform the following
tasks.
Determine whether the incoming flat file document is a duplicate, by checking the
value of the document ID; that is, determine whether Trading Networks has already
received the document. For details, see “Checking for Duplicates of the Flat File
Document” on page 303.
Search for the flat file document in My webMethods or the Trading Networks
Console by searching for documents with the specific document ID.
ConversationID
You can use ConversationID to have Trading Networks pass the document to process
management after it performs its own processing (e.g., the actions identified by a
processing rule). You define the actions taken against a document during process
management by creating a process model. For more information about creating process
models, see the Getting Started with 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 true.
UserStatus
When Trading Networks has a value for UserStatus, you can perform the following tasks.
Specify the user status as a criterion for determining the processing rule to use for the
flat file document. For more information, see “Processing Rule Criteria” on page 322.
Search for the flat file document in My webMethods or the Trading Networks
Console by searching for documents with the specific user status.
296 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
GroupID
When Trading Networks has a value for GroupID, you can search for this flat file and all
other flat files that have the same group ID in My webMethods or the Trading Networks
Console.
Built-In Transformations for DATETIME and DATETIME LIST Data Type Attributes
If you specify an attribute that has the data type DATETIME or DATETIME LIST, Trading
Networks requires you to identify the date format. Trading Networks maintains a list of
built-in common date/time formats from which you can select. However, if the date/time
format you need to use is not in the list, you can type the format you need.
To specify the date/time format, use a pattern string based on the “Time Format Syntax”
described for the java.text.SimpleDateFormat class. Trading Networks extracts the value
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.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 297
14 Defining and Managing TN Flat File Document Types
values as substitutions in a string that you supply. If you do not specify transformation
information for a string attribute, Trading Networks saves the data exactly as it extracted
it.
Following are descriptions of the built-in transformation options for string attributes.
Format Description
Uppercase Stores the extracted string attribute value in all uppercase. For
example, if the extracted attribute value is “Purchase Order”,
Trading Networks stores “PURCHASE ORDER” for the attribute
value.
Lowercase Stores the extracted string attribute in all lowercase. For example, if
the attribute value is “Purchase Order”, Trading Networks stores
“purchase order” for the attribute value.
String Substitutes extracted values with a pattern that you specify. Trading
Substitution Networks uses the java.text.MessageFormat class to perform this
transformation.
For example, suppose your document gateway service extracts the
names of three items in a purchase order and places them into an
attribute named itemName in your TN_parms variable as follows:
/TN_parms/itemName = {“WidgetA”, “WidgetB”, “WidgetC”}
Suppose you want to replace the three names with a single string
that contains the three names. To do this, use this field to specify the
following string substitution pattern for itemName:
“Item Name: {0}, {1}, {2}”
298 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
Format Description
Average Stores the average value of all the numbers in the array. For
example, if the array contains the numbers [2, 3, 4, 5], Trading
Networks stores the value 3.5.
Minimum Stores the smallest number in the array. For example, if the array
contains the numbers [2, 3, 4, 5], Trading Networks stores the
value 2.
Maximum Stores the largest number in the array. For example, if the array
contains the numbers [2, 3, 4, 5], Trading Networks stores the
value 5.
Sum Stores the sum of all the numbers in the array. For example, if the
array contains the numbers [2, 3, 4, 5], Trading Networks stores
the value 14.
No format Stores the first value of the array as the value of the attribute. For
specified example, if the array contains the numbers [2, 3, 4, 5], Trading
Networks stores the value 2.
For example, suppose your document gateway service extracts the quantity of each item
of a purchase order, and you want to sum the quantities of all items. Suppose you defined
the following attributes in your TN_parms variable and in your TN document type:
If you select the Sum built-in transformation for totalQuantity, it will sum its value (an of
quantities), and produce a single number. For example, if the value of totalQuantity is the
following array:
/TN_parms/totalQuantity = {2, 3, 4, 5}
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 299
14 Defining and Managing TN Flat File Document Types
To view these specifications, use webMethods Developer and look in the WmTN
package. For more information, see the webMethods Trading Networks Built-In Services
Reference.
Trading Networks passes the following input variables:
300 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
Trading Networks expects you to return the transformed values in the following output
variable:
For information about creating a service, see Developing Integration Solutions: webMethods
Developer User’s Guide.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 301
14 Defining and Managing TN Flat File Document Types
Note: Additionally, you can specify this same set of pre-processing actions in a
processing rule. In the processing rule, you can specify whether to use the pre-
processing actions specified in the processing rule, or to use the ones specified in the
document type. This enables you to overwrite the pre-processing actions. For details,
see “Pre-Processing Actions” on page 331.
302 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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.
Note: Alternatively, you can perform the same validation and conversion in your
document gateway service (see “Converting a Flat File Document to an IS Document”
on page 288). Do not convert a document in both locations. If you convert a document
in the gateway service, it will remain in the pipeline.
To implement this action, use the Options tab in the TN document type’s definition to:
Select the Validate Structure option.
Specify the name of the TN document type’s flat file schema in the Parsing schema
option. The Input for Flat File Validation dialog prompts you to select the parsing
settings. Trading Networks will save the parsed contents if you select the keepResults
option. You only need to specify a flat file schema if you want to validate the structure
of the document. (You create flat file schemas in webMethods Developer, as described
in the Flat File Schema Developer’s Guide.)
At run time, the Validate Structure option invokes pub.flatfile:convertToValues, which is a service
in the WmFlatFile package (see the Flat File Schema Developer’s Guide). This service
invokes the flat file parser to validate the document’s structure and content, based on the
flat file schema that you named in the Parsing schema option, and saves the parsed
contents if you selected the keepResults option.
If the document structure is invalid, Trading Networks:
1 Performs the remainder of the pre-processing actions you specified (if any).
2 Adds the error information to the BizDocEnvelope in the pipeline variable
bizdoc/Errors, which your processing rule can access.
3 Logs the error to the activity log, if you selected the Save Document to Database
pre-processing option and the Activity Log option.
4 Performs the processing actions specified in the processing rule.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 303
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. To check for a
duplicate document using the document ID and sender, you must instruct Trading
Networks to extract the DocumentID and SenderID system attributes from the
document.
Document ID, sender and receiver—Trading Networks assures that it does not already
have a document with the same document ID, sender, and receiver in its database. To
check for a duplicate document using the document ID, sender, and receiver, you
must instruct Trading Networks to extract the DocumentID, SenderID, and
ReceiverID system attributes from the document.
Document ID, sender and document type—Trading Networks assures that it does not
already have a document with the same document ID, sender, and TN document type
in its database. To check for a duplicate document using the document ID and sender
you must instruct Trading Networks to extract the DocumentID and SenderID system
attributes from the document.
To create a custom duplicate document check service, see “Creating a Duplicate
Document Check Service” on page 333.
Note: A custom duplicate checking service can affect performance, depending on its
logic.
304 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
If you do not
save this... Then the consequences of not saving are...
Content If you use the Deliver Document actions, Trading Networks will not
use reliable delivery or scheduled delivery.
If Trading Networks is to use a delivery option that requires
document content to be saved, Trading Networks will bypass
reliable delivery and invoke the specified delivery service once,
but only if the Trading Networks property tn.task.attempt.notPersisted
is set to true (the default). For more information, see
“tn.task.attempt.notPersisted” on page 489.
You will not be able to view content when monitoring transactions
using My webMethods or Trading Networks Console.
You will not be able to resubmit or re-process the document.
Attribute You will not be able to view custom attributes when monitoring
transactions using My webMethods or Trading Networks Console
(i.e., attributes will contain only information for system
attributes). However, you can still use the processing rules
extended criteria for the document.
In My webMethods or Trading Networks Console, you will not be
able to search for documents based on the attribute values because
their values were not saved to the database.
You might get different or unexpected results when you reprocess
a document. Because the attributes are not saved when you
reprocess the document, Trading Networks will not match
processing rules that use extended criteria. Instead, Trading
Networks will match to another processing rule, for example the
default processing rule, and perform the process actions identified
in that matching rule. Trading Networks does not perform
document recognition again and therefore does not re-extract the
attributes.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 305
14 Defining and Managing TN Flat File Document Types
If you do not
save this... Then the consequences of not saving are...
For example, if you use extended criteria to select a processing
rule when the value of the custom attribute Total Amount is
greater than 10000, Trading Networks would not select that
processing rule when reprocessing a document because the value
of the Total Amount attribute would not be available and
therefore would not match the extended criteria.
Activity Log You will not be able to view activity log entries when monitoring
transactions using My webMethods or Trading Networks
Console.
You will not be able to view the activity log entries when
managing the activity log using My webMethods or Trading
Networks Console.
Note: Trading Networks always saves documents that will be passed on to process
management regardless of the setting of the Save Document to Database pre-processing
option. Trading Networks passes documents on to process management if it extracted
a conversation ID from the document. For more information about process
management, see the Getting Started with BPM guide and the webMethods Designer
Online Help.
306 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
1 In Trading Networks Console, perform one of the following procedures to start a new
TN flat file document type.
New— The TN flat file document 1 Select View > Document Types.
type fields are empty.
2 Select Types > New.
3 Select Flat file for the TN document type
category.
4 Click OK.
Duplicate— The TN flat file 1 Select View > Document Types.
document type fields are filled with
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.
duplicate.
You can update any or all fields
3 Select Types > Duplicate.
from the duplicated TN flat file
document type.
4 In the Name field (required), type the name you want to give the TN flat file document
type.
5 Optionally, type a description for the TN document type in the Description field.
6 Click the Configure tab.
7 Click the Identify panel to specify the criteria that Trading Networks will use to match
flat file documents to the TN document type. For details about the information you
specify on this panel, see “Pipeline Matching Criteria Used to Identify the TN
Document Type” on page 292.
Note: You must specify at least one attribute; otherwise Trading Networks will not
use the TN document type.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 307
14 Defining and Managing TN Flat File Document Types
Attribute Specify
Name Name of the TN_parms variable.
Value Optional. The value of the TN_parms variable. If you specify a
value, Trading Networks finds a match only if the variable has the
specified value.
c Click OK to save the attribute and close the Add Pipeline Matching dialog box.
8 In the Extract panel, specify the system attributes and document attributes (document
data) that you want Trading Networks to extract from documents. For details about
what to specify for these fields, see “Attributes To Extract From Documents” on
page 293.
Important! If you do not extract the system attributes, Trading Networks will not
have this information available for processing rules or querying documents.
b In the Name field, select the name of the attribute from the list. Trading Networks
fills in the Type field based on the document attribute definition. To view more
details about all of the document attributes, click Document Attributes to view
the Document Attributes screen.
c Select the Required check box if you want Trading Networks to throw an error
when it cannot extract the attribute.
Note: 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.
d Use the Retrieve SenderID from session option as an alternative way to set the value
of the SenderID system attribute. If set, rather than look in TN_parms\SenderID
for the value to use, Trading Networks uses the connected user. For more
information, see “System Attributes To Extract From Documents” on page 295.
e Use the Transformation fields to specify how Trading Networks is to handle
attribute data before storing it in the Trading Networks database. The data type of
the attribute (shown in the Type field) determines the Built-in or Custom
308 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
Is SenderID or ReceiverID You must select from the pull-down list the type
of the external IDs (for example, DUNS) for both
attributes so that Trading Networks can match
the externals ID in SenderID and ReceiverID with
the external IDs in the profiles. This is how
Trading Networks verifies the identities of the
sender and receiver.
When Trading Networks finds a match, it
automatically transforms the external IDs in
TN_parms/SenderID and TN_parms/ReceiverID
into its internal IDs before storing them in the
BizDocEnvelope.
Has DATETIME or You must specify a date format. Select a built-in
DATETIME LIST data type format or type in your own. For more
information, see “Built-In Transformations for
DATETIME and DATETIME LIST Data Type
Attributes” on page 297.
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.
Alternatively, you can have Trading Networks
use the extracted values as substitutions in a
string that you supply. For more information, see
“Built-In Transformations for STRING or
STRING LIST Data Type Attributes” 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. For more information, see “Built-In
Transformations for NUMBER Data Type
Attributes” on page 298.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 309
14 Defining and Managing TN Flat File Document Types
f Click OK to save the new attribute and close the Add an attribute dialog box.
Trading Networks returns to the Extract panel of the Document Type Details
screen. Trading Networks displays the name of the extracted attributes and their
built-in or custom transformation services.
Note: To delete an attribute from the TN document type, select the attribute
row and click Delete attribute.
.
Important! Keep in mind that the pre-processing actions specified in the processing
rules can override pre-processing actions specified in a TN document type. For
details, see “Pre-Processing Actions” on page 331.
310 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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. You only need to
specify a flat file schema if you select the Validate Structure pre-
processing option.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 311
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. Trading Networks executes
pre-processing this pre-processing action before executing the processing rule
action that you associate with the TN document type. Select a built-in
service or use a custom service. For more information, see
“Checking for Duplicates of the Flat File Document” on
page 303.
312 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 313
14 Defining and Managing TN Flat File Document Types
To add a pipeline matching variable, click Add New Pipeline Match. Click OK to save
the variable and close the dialog box.
To update a pipeline matching variable, click the row containing the pipeline matching
variable you want to update and click Edit Selected Pipeline Match. In the Update
Pipeline Matching dialog box, update the Name and Value fields for that variable.
Click OK to save your updates and close the Update Pipeline Matching dialog box.
To delete a pipeline matching variable, click the row containing the pipeline matching
variable you want to delete and click Remove Selected Pipeline Match.
6 To update extraction information, click the Extract panel. For details about what to
specify on this panel, see “Attributes To Extract From Documents” on page 293.
7 To update the system attributes, click on the System Attributes tab. For details about
what to specify for these fields, see “System Attributes To Extract From Documents”
on page 295.
To select a system attribute to extract, select the appropriate check box in front of the
attribute name.
Use the Transform and Argument fields to specify detail information for how
Trading Networks is to handle attribute data before storing it in the Trading
Networks database. For a summary of actions you can take for adding a new
system attribute, see step 8 on page 308.
To deselect a system attribute, deselect the appropriate check box in front of the
attribute name.
8 To update custom attribute information, click on the Custom Attributes tab. Custom
attributes are the user-defined ones on the Document Attributes screen. For more
information about document attributes, see Chapter 12, “Defining and Managing
Document Attributes”.
To add a custom attribute, click Add New Attribute. Then, add a new custom
attribute. For a summary of actions you can for take for adding a new custom
attribute, see step 4 on page 212.
To view more details about all of the document attributes, click Document
Attributes to view the Document Attributes screen.
To update a custom attribute, click Edit Selected Attribute. For a summary of actions
you can take for custom attributes, see step 4 on page 212.
To delete a custom attribute from the TN document type—Select the row for the attribute
and click Remove Selected Attribute.
314 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
14 Defining and Managing TN Flat File Document Types
9 To update options, click the Options tab. For details about these fields, see “Pre-
Processing Actions in the TN Flat File Document Type” on page 302.
10 After you have made all your changes, click OK. Trading Networks closes the screen.
Note: To permanently remove the TN document type from the database, your
database administrator must remove it. When you remove a TN document type from
the database, you must also remove all documents that are associated with the TN
document type.
Note: To view the Enabled column (if it is not currently displayed), select Document
Types > Show All.
Important! To enable TN document types, you must first display inactive TN document
types as described in “Viewing TN Flat File Document Types” on page 313.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 315
14 Defining and Managing TN Flat File Document Types
316 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 317
15 Defining and Managing Processing Rules
Note: If you are working in a clustered environment, all Trading Networks servers
must be set up for cluster synchronization. That is, the servers must set the
tn.cluster.sync.remoteAliases property correctly. For more information about how to
configure Trading Networksfor a clustered environment, see “Shared Trading
Networks Database in a Clustered Environment”.
318 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Note: If you are working with a queried list of processing rules, remember that
Trading Networks adds the new rule to the full, unfiltered list of processing rules
(e.g., all of the processing rules). Adding a new processing rule and causing the
processing rule order to change may also affect the ordinals of the rules that are not
displayed on your query results table.
The table below explains what happens to the order of the processing rules if you add a
new processing rule using each of the Add options.
Example: The following diagrams demonstrate what happens if you highlight Processing
Rule B, Ordinal 12 as the rule to add your new processing rule in relation to.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 319
15 Defining and Managing Processing Rules
Processing
Rule B is now
Ordinal 13
320 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Note: If you reorder processing rules, there is no “undo” function that will return the
processing rules to their original order.
If you are working with a queried list of processing rules, remember that Trading
Networks adds the new rule to the full, unfiltered list of processing rules (e.g., all of the
processing rules). Adding a new processing rule and causing the processing rule order to
change may also affect the ordinals of the rules that are not displayed on your query
results table.
Keep rules with specific criteria before rules with general criteria. You should also set up
a default processing rule that you want Trading Networks to use when a document does
not match any of the other processing rules. Trading Networks ships with a default
processing rule that you can use. Place the default processing rule in the last position of
the full, unfiltered processing rules list. For more information about the default
processing rule, see “Setting Up a Default Processing Rule” on page 363.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 321
15 Defining and Managing Processing Rules
Keep rules with specific criteria before rules with general criteria. You should also set up
a default processing rule that you want Trading Networks to use when a document does
not match any of the other processing rules. Trading Networks ships with a default
processing rule that you can use. Place the default processing rule in the last position of
the full, unfiltered processing rules list. For more information about ordering processing
rules, see “Processing Rules Order” on page 318. For more information about the default
processing rule, see “Setting Up a Default Processing Rule” on page 363.
The rest of this section describes the types of criteria you can specify in a processing rule.
322 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 323
15 Defining and Managing Processing Rules
324 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
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.dsp
PO
Step Description
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 325
15 Defining and Managing Processing Rules
Step Description
5 The code for the web form invokes the wm.tn:submit built-in service that sends
the document back to the Integration Server for processing. Trading
Networks recognizes the TN document type is PO and determines the user
status, which is either “accepted” or “rejected.”
6 The document matches either the processing rule that indicates the TN
document type must be PO and the user status is “accepted” or the TN
document type is PO and the user status is “rejected.” This processing action
in these rules indicates Trading Networks is to invoke a service. This service
processes the purchase order appropriately.
You can set the user status processing rule criterion to one of the following:
326 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
You can set the error processing rule Content Criteria to one of the following:
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 327
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 for the custom attribute (in the TN
document type) did not identify a node in the
document.
You do not need to specify a value when you
specify this operator.
Is not null Has any value. You do not need to specify a value
when you specify this operator.
Equals Matches exactly the value that you specify.
Contains Contains the character string that you specify for
the value.
Not equals Has a value that does not match the value that you
specify.
STRINGLIST Is null Has no value. The attribute has no value if the
XQL query (defined in the TN document type)
that Trading Networks used to extract the attribute
failed.
You do not need to specify a value when you
specify this operator.
Is not null Has any value. You do not need to specify a value
when you specify this operator.
Includes Includes the value that you specify.
NUMBER Is null Has no value. The attribute has no value if the
XQL query for the custom attribute (in the TN
document type) did not identify a node in the
document.
You do not need to specify a value when you
specify this operator.
Is not null Has any value. You do not need to specify a value
when you specify this operator.
Equals Matches exactly the value that you specify.
Less than Has a value that is less than the value that you
specify.
Greater than Has a value that is greater than the value that you
specify.
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.0
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.
Not equals Has a value that does not match the value that you
specify.
NUMBERLIST Is null Has no value. The attribute has no value if the
XQL query for the custom attribute (in the TN
document type) did not identify a node in the
document.
You do not need to specify a value when you
specify this operator.
Is not null Has any value. You do not need to specify a value
when you specify this operator.
Includes Includes the value that you specify.
DATETIME Is null Has no value. The attribute has no value if the
XQL query for the custom attribute (in the TN
document type) did not identify a node in the
document.
You do not need to specify a value when you
specify this operator.
Is not null Has any value. You do not need to specify a value
when you specify this operator.
Equals Matches exactly the value that you specify.
Before Is a date that is before the date that you specify.
After Is a date that is after the date that you specify.
DATETIMELIST Is null Has no value. The attribute has no value if the
XQL query for the custom attribute (in the TN
document type) did not identify a node in the
document.
You do not need to specify a value when you
specify this operator.
Is not null Has any value. You do not need to specify a value
when you specify this date list.
Value along with the operator, instructs Trading Networks how to match documents
based on the value of the attribute extracted from the documents.
Even when a document contains the attribute information that you specify, Trading
Networks might still have a null value for the attribute. The following lists reasons
this might occur:
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 329
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.
The TN document type of the document is unknown. (Trading Networks does not
extract attributes for unknown TN document types.)
Note: For custom attributes that are extracted from an XML document, Trading
Networks returns specific values for different attribute data types. For more
information about these extraction values, see “Extracting Custom Attributes
From XML Documents” on page 505.
You can specify multiple custom attributes in the extended criteria. Trading Networks
only selects the processing rule if all the criteria you specify match.
Note: If the pre-processing actions do not indicate that Trading Networks is to save the
attributes, Trading Networks does not save the custom attributes. However, you can
still use extended criteria for the document. For more information about the pre-
processing actions, see “Pre-Processing Actions” on page 331.
If you reprocess a document, Trading Networks does not recognize the TN document
type again and therefore does not re-extract the attributes. If you reprocess a
document for which Trading Networks did not save the attributes, Trading Networks
will not match processing rules that use extended criteria. Instead, Trading Networks
will match to another processing rule, for example the default processing rule, and
perform the process actions identified in that matching rule. For more information
about reprocessing a document, see Managing B2B Integrations: webMethods Trading
Networks User’s Guide.
330 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Rule Action
1: Execute for orders >$10000 Perform special handling
2: Execute for orders <$10 Discard order
3: Execute for all other orders Perform standard handling
If you assign the rule 2 identifier as the value of processingRuleID, and an application
submits an order greater than $10, rule 2 will discard the order.
Pre-Processing Actions
Trading Networks performs pre-processing actions before it processes the document using
the processing rule actions. You can specify pre-processing actions in both the TN
document type and the processing rule. You specify the pre-processing actions in the
processing rule to override the actions that are specified in the TN document type.
Trading Networks performs the pre-processing actions in the following order. Use pre-
processing actions to instruct Trading Networks to:
Verify Digital Signature—Trading Networks verifies the digital signature of a document.
To verify that the document arrived unchanged, Trading Networks assures the signed
body has not changed by verifying the digital signature. To verify that the sender is
who it claims to be, Trading Networks matches the certificate from the digital
signature to the certificate that Trading Networks has on file for the partner.
Validate Structure—Trading Networks validates the structure of the document against
an IS schema. Trading Networks assures that the document matches the structure
identified by the IS schema (using the pub.schema:validate built-in service).
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 331
15 Defining and Managing Processing Rules
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.
Trading Networks saves the results of the duplicate check to the pipeline. As a result,
this information is available for use in the processing actions that you define in the
processing rule.
Save Document to Database—Trading Networks saves a copy of the document content,
attributes, and/or activity log information to the database. Trading Networks uses the
results of the duplicate check in the Save Document to Database pre-processing action.
Certain delivery options require saving the document content to the database, for
example, if you want to deliver a document via a queue. If you do not select to save
the document content and Trading Networks is to use a delivery option that requires
document content to be saved, Trading Networks will bypass reliable delivery and
invoke the specified delivery service once.
For more information about pre-processing actions for XML documents, see “Specifying
Pre-Processing Actions for TN XML Document Type” on page 242. For more information
about pre-processing actions for flat file documents, see “Pre-Processing Actions in the
TN Flat File Document Type” on page 302.
332 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
For all pre-processing actions, you can indicate in the processing rule that you want
Trading Networks to:
Use the setting in the TN document type
Perform the pre-processing action regardless of the setting in the TN document type
Not perform the action regardless of the setting in the TN document type
For more information about pre-processing options, see Understanding webMethods B2B:
webMethods Trading Networks Concepts Guide.
For duplicate checking services, Trading Networks passes the following output variables:
duplicate String Whether the service determined the document is a duplicate. The
service should return either true or false for duplicate.
The specification is located in the WmTN package. For more information about this
specification, see the webMethods Trading Networks Built-In Services Reference.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 333
15 Defining and Managing Processing Rules
Send an alert e-mail message to one of the contacts defined for the sender of the
document, one of the contacts defined for the receiver of the document, the
webMethods system administrator, or another e-mail that you specify.
Change the user status for the document.
Deliver the document to the receiver using a defined delivery method.
Respond to the caller with a message that you specify.
If you select to have Trading Networks perform more than one of the above actions,
Trading Networks performs the actions in the order listed above. For example, if you
select to execute a service, send an alert e-mail message, and deliver the document to the
receiver, Trading Networks performs the actions in that order.
If Trading Networks encounters an error performing one of the actions, it will continue to
attempt the other actions. For example, if the service specified in the rule does not exist,
Trading Networks will receive an error attempting to invoke the service. In this situation,
Trading Networks logs the error in the activity log and continues, attempting to send the
alert e-mail message and deliver the document to the receiver.
For more information about processing rule actions and delivery methods, see
Understanding webMethods B2B: webMethods Trading Networks Concepts Guide.
Prerequisite
Before you can use the Execute a service action, the service that you want to invoke must
exist on the Integration Server. If the service does not exist, you can access the
Developer from the Processing Rules screen to create the service.
When you use the Execute a service action, you specify the service you want Trading
Networks to execute and whether you want Trading Networks to invoke the service
synchronously or asynchronously. In addition, you can optionally set input values to
hardcode input values for the service.
Note: If you are using large document processing, see “Creating Services that
Recognize Large Document Handling” on page 512.
334 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 335
15 Defining and Managing Processing Rules
336 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Service Execution
Task Setting Description
Maximum Retries The number of times you want Trading Networks to attempt to
re-execute a service.
Wait Between The number of milliseconds (ms) you want Trading Networks to
Retries wait before making its first attempt to re-execute the service.
(Trading Networks uses the Retry Factor along with the Wait Between
Retries value to calculate how long to wait for subsequent retry
attempts.)
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 337
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. Trading Networks calculates the
time to wait by multiplying the last wait time by the value you
specify for Retry Factor.
Example: The following shows sample values for the settings described in the table above
and how they affect the wait times between attempts to re-execute a service.
Maximum Retries = 3
Wait Between Retries = 10000 ms
Retry Factor = 2
Retry 1 Retry 2 Retry 3
Wait until next attempt 10000 ms 20000 ms 40000 ms
With the above settings, if the original attempt to execute the service fails, Trading
Networks waits 10000 milliseconds before it makes its first retry attempt. If the first retry
attempt fails, Trading Networks determines the next retry wait period by multiplying the
last wait value (10000 ms) by the Retry Factor (2). This results in 20000 ms; Trading
Networks waits 20000 ms between the first failed retry attempt an the second retry
attempt. If the second retry attempt fails, Trading Networks multiplies the last wait value
(20000 ms) by the Retry Factor (2). This results in 40000 ms; Trading Networks waits 40000
ms between the second retry attempt and the third retry attempt.
Trading Networks keeps track of the progress and status of each service execution task. If
the service execution task fails, you can troubleshoot the problem. If you can correct the
problem, you can restart the service execution task to have Trading Networks attempt to
execute the service again. You can view information about service execution tasks from
My webMethods and the Trading Networks Console. For more information about
managing and tracking service execution tasks, see Managing B2B Integrations:
webMethods Trading Networks User’s Guide.
338 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
If you use synchronous or asynchronous, Trading Networks does not require the service to
have specific output values. However, if you use service execution task, your service must
provide values for the serviceOutput output variable, which is an IS document (IData
object) that contains the following String variables:
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 339
15 Defining and Managing Processing Rules
Variable in the
serviceOutput Specify…
status Whether the service executed successfully or unsuccessfully. Your
service must provide one of the following values for the reliable
execution feature of Trading Networks to operate correctly:
Value Meaning
You can view the task detail information described above, plus other task-related
information, such as, the number of times Trading Networks has attempted to retry the
service from My webMethods and Trading Networks Console. For instructions on how to
view tasks, see information about managing tasks in Managing B2B Integrations:
webMethods Trading Networks User’s Guide.
340 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
each processing rule. For the processing rule that is triggered by a document for which
you want to add an entry, set the input value of the flag to indicate the service should add
an entry. For the processing rule that is triggered by a document for which you want to
update an entry, set the input value of the flag to indicate the service should update an
entry, and so on.
Prerequisite
Before you can use the Alert e-mail action, your Trading Networks system must be set up
to allow Trading Networks to send e-mail messages. Do this by specifying the address
of the Simple Mail Transfer Protocol (SMTP) server through which the Integration
Server is to issue e-mail messages.
To specify the address of the SMTP server, use the following procedure:
1 In Server Administrator: Settings > Logging.
2 Click Edit logging settings.
3 In the Email Notification section of the screen, set the SMTP Server field to the domain
name or IP address of the SMTP server that you want the Integration Server to use.
4 Click Save Changes.
When you use the Alert e-mail action, you specify the recipient that is to receive the e-mail
message, the subject line for the e-mail message, and the body (or content) of the e-mail
message.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 341
15 Defining and Managing Processing Rules
342 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
If the TN document type is “Purchase Order”, the sender's corporation name is “XYZ
Steel Company”, and the organizational unit is “Alloys Division”, the following shows
how the above sample e-mail message body would be rendered:
Trading Networks received a Purchase Order document from XYZ Steel Company--
Alloys Division.
When Trading Networks executes the Alert E-mail action, the pipeline contains the
information described in “Action 1—Execute a Service” on page 334. In addition, if the
processing rule specifies the Execute a service action and the service is executed
synchronously, the pipeline also contains any information that the service placed in the
pipeline.
For details about the output template tags that you can use, see the Dynamic Server Pages
and Output Templates Developer’s Guide.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 343
15 Defining and Managing Processing Rules
Important! Trading Networks uses the receiver that is extracted from the document. If
you use the Execute a service action and the executed service updates the receiver
identified in the original document, Trading Networks will not deliver the document
to the partner that service specified as the receiver – unless that service updates the
receiver in the bizdoc in the pipeline. If the service does not update the receiver,
Trading Networks delivers the document to the receiver identified when it initially
received the document for processing.
The following lists the prerequisite to using the Deliver Document By action.
Prerequisite
To use the Deliver Document By action, the TN document type must indicate that Trading
Networks is to extract the ReceiverID system attribute from the document. Trading
Networks uses the receiver information to determine the partner to which to deliver
the document.
344 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Immediate Delivery
When the Deliver Document By processing action indicates Immediate Delivery, Trading
Networks attempts to deliver a document directly to the receiving partner. You can create
immediate delivery methods using the delivery methods that Trading Networks
provides. In addition, Trading Networks provides built-in immediate delivery methods.
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:
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 345
15 Defining and Managing Processing Rules
Note: You can also use reliable delivery by invoking the built-in service,
wm.tn.delivery:deliver.
The following table lists the reliable delivery settings that you define in the Delivery Method
tab of the partner’s profile. When using reliable delivery with an immediate delivery
method, Trading Networks uses these settings to establish the parameters for the delivery
task that governs the delivery of the document.
Reliable Delivery
Setting Description
Delivery The number of times you want Trading Networks to attempt to
Maximum Retries redeliver a document.
Wait Between The number of milliseconds (ms) you want Trading Networks to
Retries wait before making its first attempt to redeliver the document.
(Trading Networks uses the Retry Factor along with the Wait Between
Retries value to calculate how long to wait for subsequent retry
attempts when delivering documents using an immediate delivery
method.)
Retry Factor The factor you want Trading Networks to use when determining
how long to wait before making the second and subsequent
attempts to redeliver the document when using an immediate
delivery method. Trading Networks calculates the time to wait by
multiplying the last wait time by the value you specify for Retry
Factor.
346 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Scheduled Delivery
When the Deliver Document By processing action indicates scheduled delivery, Trading
Networks batches documents that are then delivered at scheduled times. Trading
Networks also creates the delivery task for the document and places the delivery task in
the queue specified by the processing rule. The queue specified in the processing rule is a
scheduled delivery queue that you have previously defined.
Note: The queue is not a queue in the traditional sense. It is a set of rows in the Trading
Networks database. Each queued delivery task that is associated with a document is a
row in the same table of the Trading Networks database.
For scheduled delivery, Trading Networks supports two types of queues—public queues
and private queues. You can select to use a public queue or to use a specific partner’s
private queue.
Note: If you select Receiver’s Queue, Trading Networks looks up a queue in the
receiver’s profile. If the receiver’s profile does not contain a queued delivery method
(i.e., does not define a queue), then Trading Networks will be unable to deliver the
document by this method and instead, Trading Networks makes the document
pollable (Queue for polling).
Once you select a queue for the scheduled delivery method, the next time Trading
Networks runs a scheduled delivery service and reads documents from that specified
queue, all documents in that queue will be delivered.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 347
15 Defining and Managing Processing Rules
scheduled for delivery, you define reliable delivery settings in the profile for each of your
partners. To keep track of the attempts to deliver a document, Trading Networks
establishes a delivery task.
Note: You can also use reliable delivery by invoking the built-in service,
wm.tn.delivery:deliver.
When using reliable delivery with a scheduled delivery method, Trading Networks only
uses only the following reliable delivery setting that you define in the Delivery Method tab
of the partner’s profile.
Unlike for the immediate delivery method, Trading Networks does not use the Wait
Between Retries and Retry Factor settings for reliable delivery with scheduled delivery
because the queue’s delivery schedule dictates how often to retry delivery attempts.
348 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
When Trading Networks queues the document for polling, it places the document in an
internally-defined queue. Trading Networks does not deliver the documents that are in
this queue. Instead, Trading Networks waits for a partner to poll for the documents.
When a specific partner polls for documents, Trading Networks returns all the
documents in the queue for which that partner is the receiver.
The receiving partners define the protocol (e.g., HTTP) to use to poll for the document
and how frequently to poll for documents.
Preferred Protocol
If you select Receiver’s Preferred Protocol, Trading Networks looks up the receiver’s profile
and uses the delivery method that is identified as that partner’s preferred delivery
method. This preferred delivery method can be an immediate delivery or queued for
polling.
In addition to the above delivery methods, you can create customized delivery services
and register them with Trading Networks to define your own custom delivery methods.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 349
15 Defining and Managing Processing Rules
Note: If you are working in a clustered environment, all Trading Networks servers
must be set up for cluster synchronization. That is, the servers must set the
tn.cluster.sync.remoteAliases property correctly. For more information about how to
configure Trading Networks for a clustered environment, see “Shared Trading
Networks Database in a Clustered Environment”.
350 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Add — To add a new 1 Click the row where you want to add the
processing rule in a specific new processing rule.
order relative to a selected
2 Select Rules > Add and then one of the
processing rule.
following:
For more information about
a Above— Add a new processing rule
adding processing rules, see
above the highlighted processing rule.
“Adding Processing Rules
and the Order of Processing b Below— Add a new processing rule
Rules” on page 318 below the highlighted processing rule.
c Last—Add a new processing rule to the
bottom of the full unfiltered processing
rules list. All other processing rules
keep their original ordinal numbers.
3 On the Processing Rule Details screen, specify the name you want to give the
processing rule in the Name field. Specify 1-64 characters. There is no restriction to the
characters that you can use.
4 If you do not want this processing rule to be enabled, deselect the default Enabled
field.
5 Optionally, specify a description for the processing rule in the Description field. Specify
1-255 characters. There is no restriction to the characters that you can use.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 351
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. A document must meet all the criteria that you specify on
both the Criteria and Extended Criteria tabs for Trading Networks to use the processing
rule to process the document. For more information, see “Processing Rule Criteria”
on page 322.
352 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 353
15 Defining and Managing Processing Rules
354 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
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. A document must meet all
the criteria that you specify on both the Criteria and Extended Criteria tabs for Trading
Networks to use the processing rule to process the document.
For each custom attribute that you want to use, specify the following Content Criteria:
8 Click the Pre-Processing tab and fill in the fields to specify the pre-processing actions
you want Trading Networks to perform for documents that meet the criteria specified
in this processing rule. By default, Trading Networks checks all pre-processing
actions.
For more information about pre-processing actions for XML documents, see
“Specifying Pre-Processing Actions for TN XML Document Type” on page 242. For
more information about pre-processing actions for flat file documents, see “Pre-
Processing Actions in the TN Flat File Document Type” on page 302.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 355
15 Defining and Managing Processing Rules
Verify Digital Signature Whether you want Trading Networks to verify the digital
signatures of documents. Select one of the following:
Defer to Document Type to use the Verify setting that is
specified in the TN document type for the document.
Verify digital signature to always verify digital signatures
or digitally sign documents that Trading Networks
processes with this processing rule.
Do not verify digital signature to never verify digital
signatures or digitally sign documents that Trading
Networks processes with this processing rule.
Validate Structure Whether you want Trading Networks to validate the
structure of documents. Select one of the following:
Defer to Document Type to use the Validate setting that is
specified in the TN document type for the document.
Validate structure to always validate the structure of the
documents that Trading Networks processes with this
processing rule.
Do not validate structure to never validate the structure of
the documents that Trading Networks processes with
this processing rule.
Check for Duplicate Whether you want Trading Networks to determine
Document whether it already received the document. Select one of
the following:
Defer to Document Type to use the Check for Duplicate
Document setting that is specified in the TN document
type for the document.
Use built-in services to check for duplicate document of
XML or flat file documents against a Trading
Networks built-in service.
If you select Use built-in services to check for duplicate
document, select whether you Trading Networks
should use the: Document ID only; both the Document ID
and sender; the Document ID, sender and receiver; or the
Document ID, sender and document type.
356 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 357
15 Defining and Managing Processing Rules
9 Click the Action tab and select one or more of the following processing rule actions.
The default for a new processing rule is to have all five actions enabled. To disable a
processing rule action, deselect the appropriate check box in the Enable column on the
left.
When you select a processing rule action, Trading Networks displays the
corresponding panel for each action on the right side of the screen. Complete your
selections for each processing rule action as explained below.
Important! If you select more than one action, Trading Networks performs the
actions in the order they are listed on the Processing Rules screen. For example, if
you select to execute a service, send an alert e-mail message, and deliver the
document to the receiver, Trading Networks performs the actions in that specific
order. For more information, see “Processing Rule Actions” on page 333.
Execute a service. Specify the service you want Trading Networks to invoke for the
document and how you want Trading Networks to invoke the service. Optionally,
you can also hardcode input parameters for the service.
358 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
For more information about the Execute a service processing rule action,
see“Action 1—Execute a Service” on page 334. If you are using large document
processing, see “Creating Services that Recognize Large Document Handling” on
page 512.
a Perform one of the following to specify the service you want Trading
Networks to invoke for the processing action:
To create a new service, click New Service (folder with yellow highlight)
to open the Developer to create the service. For more information about
creating services, see Developing Integration Solutions: webMethods
Developer User’s Guide.
b Specify how to invoke the service:
To invoke the service synchronously, select synchronous.
To invoke the service asynchronously, select asynchronous.
To invoke the service asynchronously and use a service execution task,
select service execution task.
c To set inputs for the service, click Set Inputs. Trading Networks displays the
input parameters for the service. Type in values for the parameters you
want to hardcode an input value. After specifying inputs, click OK.
d If you need to update the service, click Edit Service. Trading Networks opens
the Developer from which you can update the service.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 359
15 Defining and Managing Processing Rules
Change User Status—Specify the user status you want to associate with the
document. In the Change to field, specify a character string containing 1-255
characters. There is no restriction on the characters you can use.
For more information about the User Status processing rule action, see “Defining a
Processing Rule Based on a Saved Document” on page 362.
Deliver Document By—Specify the delivery method you want to use to deliver the
document.
For more information about the Deliver Document By processing rule action, see
“Action 4—Deliver the Document to the Receiver” on page 344
Queue for polling Trading Networks queues a document for polling. For
more information, see “Defining Queue for Polling” on
page 390.
Receiver’s The delivery method that is identified as the receiving
Preferred Protocol partner’s preferred delivery method. This preferred
delivery method can be an immediate delivery or queued
for polling.
Immediate Delivery Specify an immediate delivery method from the list.
For more information, see “Immediate Delivery” on
page 345.
360 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Scheduled Delivery Specify the scheduled delivery queue to use from the list.
Scheduled Delivery indicates that documents matching the
processing rule will not be delivered immediately, but will
be queued and delivered later by scheduled delivery.
The scheduled delivery queue can be a public or private
queue (Receiver’s queue). Select the public queue from the
list of registered public queues. Select Receiver’s queue to
place documents that match this processing rule in the
receiving partner’s selected queue. The next time Trading
Networks runs a scheduled delivery service and reads
documents from the specified queue, all documents in that
queue will be delivered.
For more information about queues and scheduled
delivery, see “Scheduled Delivery” on page 347 and
“About Scheduled Delivery Queues” on page 378.
Important! If you select the Scheduled Delivery processing
action, you must use the Save Document to Database pre-
processing action. If you do not save the document,
Trading Networks maintains no information about this
document after it processes the document.
Respond With —Specify the message you want to return to the caller that sent the
document and the content type of the message.
For more information about the Respond With processing rule action, see
“Action 5—Respond With a Message” on page 349.
Content type The content type of the message in the Content type field. For
example, if the message is and XML document, type
“text/xml”.
Message The message in the Message field. Specify a character string.
There are no limits to the length or the characters you can
specify. You can include output template tags to create a
dynamic message.
To use a larger input window to specify the message, click
Expand.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 361
15 Defining and Managing Processing Rules
10 Click OK. Trading Networks closes the Processing Rule Details screen, and saves all
changes you have made to processing rules. This includes saving all new rules you
added, rules you changed, rules you disabled or enabled, and all changes you made
to the order of the rules.
Processing Rule
Tab How Trading Networks Defines the Information on the Tab
Criteria Trading Networks sets the processing rule criteria as follows:
Sender criterion—Set to the sender that is associated with the
document; that is, either the sender identified within a
document or unknown.
Receiver criterion—Set to the receiver that is associated with
the document; that is, either the receiver identified within a
document or unknown.
Document type criterion—Set to the TN document type that
was used for the document or unknown if it the document did
not match a TN document type.
User status criterion—Set to the value of the user status that is
associated with the document, if any.
Extended Criteria Trading Networks does not set any extended criteria.
Pre-Processing Trading Networks sets the pre-processing actions as follows:
Verify digital signature—Set to always verify the digital
signature of the document.
Validate structure—Set to always validate the structure of the
document.
Check for duplicate document—Set to use the setting in the
TN document type for the duplicate check pre-processing
action.
Save document to database—Set to always save a copy of the
document content, attribute, and/or activity log information.
Action Trading Networks sets the processing action to ignore the
document.
362 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
You can make any changes to the criteria, extended criteria, pre-processing actions, or
processing actions.
1 From Trading Networks Console, use the Transaction Analysis screen to display the
sample document that you want to use. Select View > Transaction Analysis.
2 Click the row containing the document that you want to view.
3 Select Transactions > Create Processing Rule.
4 To change the criteria, select the Criteria tab; then, update the settings as you want. For
information about how to update the settings, see step 6 on page 352.
5 To change the custom attribute (extended) criteria, select the Extended Criteria tab; then,
update the settings as you want. For information about how to update the settings,
see step 7 on page 355.
6 To change the pre-processing actions, select the Pre-Processing tab; then, update the
settings as you want. For information about how to update the settings, see step 8 on
page 355.
7 To change the processing actions, select the Action tab; then, update the settings as you
want. For information about how to update the settings, see step 9 on page 358.
8 Click OK. Trading Networks saves the processing rule and closes the Processing Rule
Details screen.
Note: Trading Networks saves the new rule at the top of the list of processing rules.
For instructions on how to move the processing rule to another position in the list, see
“Ordering the Processing Rules” on page 364.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 363
15 Defining and Managing Processing Rules
Note: If you do update the Default rule, make sure that it remains last in the full,
unfiltered processing list.
5 Click OK. Trading Networks closes the Processing Rule Details screen and saves the
changes to the processing rule.
Note: If you reorder processing rules, there is no “undo” function that will return the
processing rules to their original order.
Note: You can only move and reorder processing rules if their ordinals are
contiguous.
364 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
3 Click Rules > Move > Select to select the processing rule (s) you want to move.
Note: If you reorder processing rules, there is no “undo” function that will return
the processing rules to their original order.
4 Highlight the processing rule you want to move your selected rule in relation to.
5 Once you have highlighted the location, perform the following to move your selected
processing rule:
Trading Networks reassigns the ordinal numbers for all affected processing rules.
Repeat this step until the processing rules are listed in the order you want. You can
order the processing rules in any direction. The default processing rule should always
be listed last. For more information, see “Processing Rules Order” on page 318.
If you want, you can test the order of your processing rules to assure you have them
in the correct order. For more information, see “Testing the Order of Processing
Rules” below.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 365
15 Defining and Managing Processing Rules
Important! During the test, Trading Networks does not actually process the document.
That is, Trading Networks does not perform any pre-processing or processing actions
on the document.
Perform the following procedure to test the order of your processing rules.
366 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
2 Select Run Query on the toolbar. Trading Networks displays the processing rules
table.
3 Perform one of the following to view processing rule information from the table:
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 367
15 Defining and Managing Processing Rules
a With your cursor, double click on the row containing the processing row
you want more detailed information about. Trading Networks displays the
Processing Rule Details screen for the selected processing rule.
b On the Processing Rule Details screen, you can:
1 View the information. For more information about the tabs and fields
on this screen, see “Defining Processing Rules” on page 350.
2 Edit the information. For more information on how to change the
information on the Processing Rule Details screen, see “Updating
Processing Rules” on page 372.
a Select Show Query on the toolbar. Trading Networks displays the Basic
Criteria and Detail View tabs.
b Go to step 6 to change the table format using the Detail View tab.
4 If you cannot find the processing rule you are looking for, you can perform a more
detailed query to refine the results on the processing rules table. Select Show Query
on the toolbar. Trading Networks displays the Basic Criteria and Detail View tabs.
5 To narrow down the list of processing rules from which to choose, select the Basic
Criteria tab and fill in the fields to specify basic search criteria. To indicate that you
want to use one or more of the basic search criteria, select the check box next to each
criterion you want to use. Then fill out the corresponding information as follows.
368 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 369
15 Defining and Managing Processing Rules
To specify a user status for the query, click Add New; then,
type the user status in the newly added row.
To remove a user status from a query, select the row
containing the user status you want to delete and then click
Delete Selected.
Name The name of the processing rule. Type in a character string
contained in the processing rule name.
You can use the pattern-matching characters “%” in the
processing rule name search. For example
Type this: To find:
370 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
Last Modified The time Trading Networks last updated the processing rule
Time either when the processing rule was created or last updated.
Select an entry from the list.
To specify a date range, select Custom from the list. Then specify
dates in the Beginning and Ending fields. You can type in a date
value, or click Select Date to open a dialog that allows you to
select the date from a calendar.
Ordinals The ordinal for the processing rule that you are searching for.
The ordinal corresponds to the order placement where Trading
Networks has assigned the rule you are searching for in the
processing rules list.
You can specify an ordinal range by using the From and To fields
to indicate the beginning and end of the range.
6 Select the Detail View tab and fill in the fields to specify how Trading Networks
displays information in the processing rules table.
a In the Display Column panel, check each field that you want Trading Networks to
include in the Detail view. Trading Networks displays a column for each checked
field. Trading Networks always displays the Ordinals and Name columns. Trading
Networks displays the Senders and Receivers columns by default.
b In the Search Order panel, select the search order that you want Trading Networks
to follow when performing a query. To change the search order, use the up and
down buttons.
Move a search criteria up, select the criteria you want to have
precedence from the Search Order list and then click .
Move a search criteria down, select the criteria you want to have
precedence from the Search Order list and then click .
For more information about the Detail view, see “Detail View of Processing Rules” on
page 367.
7 Select Run Query on the toolbar. Trading Networks displays the processing rules
table with the results from the refined query.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 371
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.
For more information about the tabs and fields on this screen, see “Defining
Processing Rules” on page 350.
For more information on how to change the information on the Processing Rule
Details screen, see “Updating Processing Rules” on page 372.
372 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
15 Defining and Managing Processing Rules
9 To update the processing actions, click the Action tab. Then, update the processing
actions. For information about how to update the settings, see step 9 on page 358.
10 Click OK. Trading Networks closes the Processing Rule Details screen and saves the
changes to the processing rule.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 373
15 Defining and Managing Processing Rules
2 Select Run Query on the toolbar. Trading Networks displays the processing rules
table.
If you want to delete a processing rule that is currently disabled, make sure that
disabled processing rules are visible on the processing rules table. To do so:
a Select Show Query on the toolbar. Trading Networks displays the Basic Criteria
and Detail View tabs.
b Select the Detail View tab.
c In the Display Column panel, check the Enabled field so that Trading Networks
includes it in the Detail view.
d Select Run Query on the toolbar. Trading Networks updates the processing
rules table. Now you can see the disabled processing rules (No in the Enabled
column).
3 Click the row containing the processing rule(s) you want to delete. You can select
multiple processing rules using the <Shift> (for a contiguous block of rules) and <Ctrl>
(for more than one non-contiguous processing rule) keys.
Important! This is an actual delete of the processing rule. The processing rule is not
deactivated; it is removed from the Trading Networks system. You will not be able
to recover it later.
4 Select Rules > Delete. Trading Networks confirms that you want to delete the selected
processing rule(s). Click Yes to delete.
374 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
IV Setting Up Document Delivery
Defining and Managing Queues in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
Creating Delivery Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.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
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 377
16 Defining and Managing Queues in Trading Networks
What is a Queue?
A queue in Trading Networks is a grouping of outbound documents that can be delivered
in batch. Note that a Trading Networks queue is not a queue in the traditional sense.
Instead, it is a set of rows in the Trading Networks database. When documents are placed
in a queue, Trading Networks does not deliver them immediately, rather, Trading
Networks delivers them based on a schedule defined for the queue.
Trading Networks supports queues for two different purposes— scheduled delivery and
polling.
For more information about delivery methods and queues, see Understanding webMethods
B2B: webMethods Trading Networks Concepts Guide.
378 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
16 Defining and Managing Queues in Trading Networks
Private Queues
A private queue is a queue that contains only delivery tasks that correspond to documents
aimed for a specific receiving partner. You define private queues in the delivery settings
of a partner’s profile. The queue will only contain delivery tasks that correspond to
documents that are to be delivered to the partner defined by the profile.
For more information, see “Delivery Settings” on page 103 and “Defining Private
Queues” on page 383.
Public Queues
A public queue is a queue that can contain delivery tasks that correspond to documents
that are aimed for multiple receiving partners.
For more information, see “Defining Public Queues” on page 386.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 379
16 Defining and Managing Queues in Trading Networks
Custom Interval. Trading Networks runs the delivery service on the day(s) and at
the time(s) that you specify either during a specified date range or indefinitely.
For more information, see “Using a Custom Interval Option” on page 381.
Important! Do not attempt to use the Integration Server Administrator to change the
schedule for a delivery service! If you do so, the data passed to the service will be lost
and the service will be unable to deliver documents. Use My webMethods to change
the delivery schedule and other queue settings
For more information about scheduled delivery services, see “What is a Scheduled
Delivery Service?” on page 394.
Note: If the scheduled run-time occurs when the server is not running, when you
initialize server, the server throws an exception.
380 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
16 Defining and Managing Queues in Trading Networks
There might be times however when you want Trading Networks to wait for a delivery
service to complete execution before it starts the next scheduled execution of the service.
For example, suppose your delivery service is scheduled to run every minute, but
sometimes takes longer than that to complete. By default, Trading Networks will start the
next subsequent execution even though the previous one has not yet completed. To have
Trading Networks wait for the service to complete before beginning its next scheduled
execution, check the Do not overlap task box.
With the Fixed Interval option, there is no end date or time associated with a repeating
delivery task. Trading Networks continues to execute the delivery service until you
change the queue schedule. If you want to specify an end date or time, use a custom
interval option, described below.
State Meaning
Enabled Enabled
Trading Networks can place delivery tasks into
IN OUT
the queue and can invoke the scheduled delivery
service to deliver the documents that are
associated with the delivery tasks in the queue.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 381
16 Defining and Managing Queues in Trading Networks
State Meaning
Disabled Disabled
Trading Networks cannot place delivery tasks
X X into the queue or deliver documents that are
associated with delivery tasks in the queue.
All delivery tasks that are in the queue when you
disable it remain in the queue. If you enable or
drain the queue, Trading Networks will once
again invoke the scheduled delivery service that
is associated with the queue to deliver the
documents that correspond to those delivery
tasks.
There are two reasons you might want to disable
a queue. 1) If the delivery service is defective and
you need to debug and fix it, or 2) if a processing
rule has been placed on the wrong queue and
you need to change the rule and/or reassign some
tasks to another queue.
When the Deliver Document By processing action of
a processing rule specifies to use a queue that is
disabled, the delivery fails because Trading
Networks cannot place the delivery task in the
queue. Trading Networks sets the delivery task
status to FAILED and logs a message to the
activity log.
Draining Draining
Trading Networks cannot place delivery tasks
X OUT
into the queue, but Trading Networks can invoke
the scheduled delivery service to deliver the
documents that are associated with the delivery
tasks in the queue.
Drain a queue if you want to empty it, so you can
delete it. You can also drain a queue to perform
maintenance changes (e.g., change queue
settings, update delivery services).
When the Deliver Document By processing action of
a processing rule specifies to use a queue that is
draining, the delivery fails because Trading
Networks cannot place the delivery task in the
queue. In this situation, Trading Networks sets
the delivery task status to FAILED and logs a
message to the activity log.
382 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
16 Defining and Managing Queues in Trading Networks
State Meaning
Suspended Suspende
Trading Networks can place delivery tasks into
IN X the queue, but Trading Networks cannot deliver
documents that are associated with delivery
tasks that are in the queue.
You might suspend a queue if a trading partner
indicates that it is temporarily unable to accept
documents.
All delivery tasks that are in the queue when you
suspend it remain in the queue. If you enable or
drain the queue, Trading Networks will once
again invoke the scheduled delivery service that
is associated with the queue to deliver the
documents that correspond to those delivery
tasks.
1 Search for the profile for which you want to add a private queue. If you need
procedures for this step, see “Searching for Partner Profiles” on page 156.
2 Click Edit in the row for the partner profile for which you want to add a private
queue.
3 Click the Delivery Settings tab.
4 In the DELIVERY METHODS panel, click Add Delivery Method.
5 From the Delivery Method list, select Queue for delivery.
6 Select Use Private Queue.
7 Click Edit.
8 From the Delivery Service field, select the delivery service to use with the private
queue.
9 Click the Inputs tab and fill in the inputs to the delivery service.
Select Include empty values for string types? if you want the input parameters to include
fields that you leave blank. If you select this option and you leave a field blank,
Trading Networks passes an empty string for the value. If you do not select this
option and you leave a field blank, the field is not included in the inputs.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 383
16 Defining and Managing Queues in Trading Networks
10 From the State list, select the state of the queue (Enable, Disable, Drain, or Suspend
Delivery). For a description of these states, see “Scheduled Delivery Queue States” on
page 381.
11 Click the Schedule tab and from the Process Queue list, select how often (Run Once, Fixed
Interval, Hourly, Daily, Weekly, Monthly, or Yearly) that you want Trading Networks to
invoke the delivery service to deliver documents in the queue.
12 Based on your selection from the Process Queue list, fill in the associated fields.
Run Once In the Date and Time fields, specify the one time you want
Trading Networks to execute the delivery service. For more
information, see “Using the Run Once Option” on page 380.
Fixed Interval In the Interval fields, specify the interval of time you want
Trading Networks to wait between executions of the delivery
service. You can specify the interval in seconds, minutes, hours,
days, or weeks.
If you want Trading Networks to wait for a delivery service to
complete execution before it starts the next scheduled execution
of the service, check Do not overlap task.
When you add or update a fixed interval schedule for a queue
that is Enabled or Draining, Trading Networks invokes the service
immediately. Subsequent invokes are governed by the interval.
For more information, see “Using the Fixed Interval Option” on
page 380.
Hourly Specific times when you want Trading Networks to execute the
Daily delivery service.
Weekly
Use the DATE RANGE fields to specify the days when you want
Monthly
Trading Networks to start and end executing the service. You
Yearly
can select:
A timeframe from the drop-down list and Trading Networks
will update the Start Date/Time and End Date/Time fields.
Custom from the drop-down list and then update the Start
Date/Time and End Date/Time fields to specify your custom
time frame.
384 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
16 Defining and Managing Queues in Trading Networks
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 385
16 Defining and Managing Queues in Trading Networks
386 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
16 Defining and Managing Queues in Trading Networks
5 In the State field, select the state of the queue (Enable, Disable, Drain, or Suspend
Delivery). For a description of these states, see “Scheduled Delivery Queue States” on
page 381.
6 Click the Inputs tab and fill in the inputs to the delivery service.
Select Include empty values for string types? if you want the input parameters to include
fields that you leave blank. If you select this option and you leave a field blank,
Trading Networks passes an empty string for the value. If you do not select this
option and you leave a field blank, the field is not included in the inputs.
7 Click the Schedule tab and from the Process Queue list, select how often (Run Once, Fixed
Interval, Hourly, Daily, Weekly, Monthly, or Yearly) that you want Trading Networks to
invoke the delivery service to deliver documents in the queue.
For additional instructions for how to complete the fields on the Schedule tab, see
step 12 on page 384.
8 Click Save.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 387
16 Defining and Managing Queues in Trading Networks
1 Search for the profile for which you want to add a private queue. If you need
procedures for this step, see “Searching for Partner Profiles” on page 156.
2 Click Edit in the row for the partner profile for which you want to add a private
queue.
3 Click the Delivery Settings tab.
388 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
16 Defining and Managing Queues in Trading Networks
4 Click Edit in the row for the Queue for delivery delivery method.
If this delivery method is using a private queue, the Use Private Queue check box is
selected in the EDIT - QUEUE FOR DELIVERY dialog box.
5 Click Edit.
6 For State, select the queue state you want: Enable, Disable, Drain, or Suspend Delivery.
7 Click OK to close the Private Queue dialog box.
8 Click OK to close the EDIT - QUEUE FOR DELIVERY dialog box.
9 Click Save to save the changes to the profile.
3 Click Edit in the row containing the public queue that you want to update.
4 For State, select the queue state you want: Enable, Disable, Drain, or Suspend Delivery.
5 Click Save.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 389
16 Defining and Managing Queues in Trading Networks
method and polling frequency you use for a specific partner is defined in the delivery
settings of the partner’s profile. For more information about the polling information in
your partner’s profile, see “Delivery Settings” on page 103.
1 Search for the profile you want to update; that is, the profile of the partner for which
you want to define how your system will poll for documents in that partner’s system.
If you need procedures for this step, see “Searching for Partner Profiles” on page 156.
Polling Method The method you want your Trading Networks system to use
access the partner’s system to request queued documents.
Polling Frequency How often you want your Trading Networks system to poll your
partner’s system for documents.
For more information about these settings, see “Delivery Settings” on page 103.
5 Click Save to save the profile.
390 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
16 Defining and Managing Queues in Trading Networks
1 Make sure the partner Integration Server running webMethods for Partners and the
hub Integration Server running webMethods Trading Networks have the correct
license keys (that is, the partner server uses the partner key and the hub server uses
the hub key).
2 Locate the server configuration file at <ServerDirectory>\config\server.cnf, where
ServerDirectory is the directory in which you installed the Integration Server
running webMethods for Partners.
3 In the server configuration file, ensure that the watt.server.partner property exists
and is set properly. The property should be set to the host name for the hub
Integration Server. For example, if the host name for the hub Integration Server were
“HostName,” the property would be
watt.server.partner=HostName
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 391
16 Defining and Managing Queues in Trading Networks
392 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
17 Creating Delivery Services
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 393
17 Creating Delivery Services
Note: Use the Trading Networks tn.transport.user property to indicate the user account to
use when invoking a delivery service. By default, Trading Networks uses the
Administrator user account to invoke services. For more information about this
property, see “tn.transport.user” on page 496.
For more information about immediate and scheduled delivery services, see Understanding
webMethods B2B: webMethods Trading Networks Concepts Guide.
394 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
17 Creating Delivery Services
You associate scheduled delivery services with delivery queues. You can associate a
single scheduled delivery service with one or more delivery queues. Delivery queues also
have delivery schedules associated with them. Trading Networks invokes the scheduled
delivery service at the times dictated by the delivery schedule.
Trading Networks places delivery tasks in the queues. When the Deliver Document By
processing action indicates to use scheduled delivery (i.e., a queue name or Receiver’s
Queue), Trading Networks creates a delivery task for the document that is to be delivered
and places the delivery task into the queue. When the schedule associated with the queue
indicates, Trading Networks invokes the scheduled delivery service. The scheduled
delivery service retrieves the list of delivery tasks that are in the queue. It is the
responsibility of the scheduled delivery service to retrieve the document, attempt to
deliver the document, and update the status of the delivery task to indicate whether the
delivery was successful or not.
Note: The queue is not a queue in the traditional sense. It is a set of rows in the Trading
Networks database. Each queued delivery task that is associated with a document is a
row in the same table of the Trading Networks database.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 395
17 Creating Delivery Services
Variable in the
serviceOutput Specify…
status Whether the service executed successfully or unsuccessfully. Your
service must provide one of the following values:
Value Meaning
success The delivery of the document was successful.
fail The delivery of the document failed.
statusMessage Optional. A delivery-specific message about the outcome of the
delivery.
transportTime Optional. The number of milliseconds it took for the service to
deliver the document.
output Optional. Return information from the delivery service, for
example, response bytes received from an HTTP post.
For information about creating the service, see Developing Integration Solutions:
webMethods Developer User’s Guide.
Important! Do not save your immediate delivery service in the WmTN package or any
other webMethods package that contains webMethods software. If you do, when you
upgrade the webMethods software, your service will be lost.
Note: If you are using large document processing, see “Creating Services that
Recognize Large Document Handling” on page 512.
Note: Trading Networks cannot handle large documents that are delivered using the
web service delivery method.
For more information about handling of large documents, see Appendix F, “Large
Document Handling”. For more information about the wm.tn.doc:getDeliveryContent service
and the structure of the BizDocEnvelope (wm.tn.rec:BizDocEnvelope), see the webMethods
Trading Networks Built-In Services Reference.
396 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
17 Creating Delivery Services
Important! Do not save your scheduled delivery service in the WmTN package or any
other webMethods package that contains webMethods software. If you do, when you
upgrade the webMethods software, your service will be lost.
Note: If you are using large document processing, see “Creating Services that
Recognize Large Document Handling” on page 512.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 397
17 Creating Delivery Services
398 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
17 Creating Delivery Services
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 399
17 Creating Delivery Services
400 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
17 Creating Delivery Services
The actions in bold are items that all scheduled delivery services should perform. For
more information, see “Required Logic to Include in the Scheduled Delivery Service” on
page 398.
The above shows only a sample of one way to create the service. You might have different
requirements for your service. For example, you might want to combine several
documents and transmit them as one large document or might want to limit the number
of documents sent to a destination in a single invocation of your service.
As shown above, the scheduled delivery service might need to make a connection to a
remote server. The typical approach is to open the connection after you have determined
that the queue has delivery tasks in it (that is, the queue is not empty). You can determine
whether the queue is empty by invoking the wm.tn.queuing:getQueuedTask service. If this
service returns null, the queue is empty. After your scheduled delivery service has acted
on the delivery tasks in the queue, your service can then close the connection to the
remote server.
Some transport protocols require additional actions after opening a connection and
before you begin delivering documents. For example, for the FTP protocol, after
performing the LOGIN to connect to the remote server, a cd (change directory) is
performed to navigate to the appropriate directory.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 401
17 Creating Delivery Services
Handling Exceptions
When the queue schedule dictates, the wm.tn.queuing:deliverBatch service is invoked. The
wm.tn.queuing:deliverBatch service, in turn, invokes your scheduled delivery service and
passes your service information about the queue.
This wm.tn.queuing:deliverBatch service catches any exceptions thrown by your scheduled
delivery service or the underlying transport service that your services uses to deliver the
document. In response to an exception, the wm.tn.queuing:deliverBatch service increments the
retry count for the current delivery task and logs the exception to the activity log.
If your scheduled delivery service needs to take action in response to an exception, use
the pub.flow:getLastError built-in service to detect whether an exception was thrown.
If you are creating your scheduled delivery service using the flow language, and you
want to exit your scheduled delivery service due to a failure, use the following flow
operation:
EXIT $flow and signal FAILURE
The above flow operation causes the wm.tn.queuing:deliverBatch service to increment the
current delivery task’s retry count and log the exception to the activity log. You provide
the information that Trading Networks logs to the activity log. To provide this
information, be sure you specify meaningful information in:
failure-message property of the EXIT flow operation
logMsg variable in Pipeline out; map meaningful text to this variable
402 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
17 Creating Delivery Services
3
4
6
7
8
9
10
11
12
13
Flow
Operations Description
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 403
17 Creating Delivery Services
Flow
Operations Description
404 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
17 Creating Delivery Services
Note that the wm.tn.transport:batchFtp service does not do any exception handling. All
transport-level exceptions cause the current invocation of the wm.tn.transport:batchFtp
service to terminate, and the exception will be handled by its caller,
wm.tn.queuing:deliverBatch. The wm.tn.transport:batchFtp service will be invoked again for the
delivery queue, according to the queue’s schedule.
Note: If you are using large document processing, see “Creating Services that
Recognize Large Document Handling” on page 512.
1 Use the webMethods Developer (or your own Java development environment) to
create the delivery service.
For immediate delivery services, see “Creating an Immediate Delivery Service”
on page 395.
For scheduled delivery services, see “Creating a Scheduled Delivery Service” on
page 397.
For large document processing, see “Creating Services that Recognize Large
Document Handling” on page 512.
For general information about creating services, see Developing Integration Solutions:
webMethods Developer User’s Guide.
When you create the service, you must place it in a package. Do not place it in the
WmTN packages because it will be overwritten when you upgrade Trading
Networks.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 405
17 Creating Delivery Services
Note: If you use your own Java development environment, you need to use a jcode
utility to put the Java code into the Integration Server namespace; that is, place it
in a package and folder. The jcode utility is provided. For more information, see
Developing Integration Solutions: webMethods Developer User’s Guide.
406 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
17 Creating Delivery Services
For this
parameter... Specify...
serviceName The name you want to assign to the delivery service, e.g.,
Message Queue. This is the name that Trading Networks displays
in lists in My webMethods and the Console.
host The host name of the Integration Server. If you leave host blank,
Trading Networks uses “localhost”. If the delivery service
resides on the local machine, specify localhost or leave host
blank.
When you leave host blank or specify localhost, Trading
Networks assumes that the delivery service is on the local
server.
When you specify any other value for host, Trading
Networks assumes the delivery service is on a remote server.
This is true even if the value you specify is the host name for
the local machine.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 407
17 Creating Delivery Services
For this
parameter... Specify...
ifc The fully-qualified folder name of the new delivery service you
want to use, e.g., TNCustomize.deliveryServices.
service The service name of the new delivery service you want to use,
e.g., messageQueue.
scheduled Whether you are adding an immediate or scheduled delivery
service.
For this type… Specify…
Scheduled true
d Click OK.
Note: To make changes to the parameters you specified when adding the delivery
service (e.g., to specify a different service):
First, remove the service using wm.tn.delivery:removeService
Then, follow this “To add and register a new delivery service” procedure again on
to re-register the service specifying your changes.
408 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
V Appendices
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 409
V Appendices
410 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
A Queries in Trading Networks Console
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 411
A Queries in Trading Networks Console
Query toolbar
on the Trading
Partners
screen
Enlarged view
of the Query
toolbar
Queries List
The following table lists the query functions that correspond with the Trading Networks
Console toolbar, along with a description of each function.
This query
toolbar item... Represents...
Show Query. Displays the query panels for a screen.
412 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
A Queries in Trading Networks Console
This query
toolbar item... Represents...
Run Query. Runs the query using the settings you specified on the query
panels.
[Queries Queries List. Drop-down list of all saved queries. Trading Networks
List] displays the last query run on the Console
Save Query. Updates the current query by saving the changes you have
made to the query criteria
Save Query As. Creates a new saved query by saving the query criteria
that you specified.
Revert to Saved Query. Reverts the query information and resets it to the
saved query settings in the database.
Delete Query. Deletes the currently selected query.
Trading Networks lists all of the saved queries in the Queries List on the toolbar.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 413
A Queries in Trading Networks Console
Display area
showing only
the
query results
table (e.g,.
Profiles table)
Use the following buttons on the left of the toolbar to display the query tabs and panels.
414 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
A Queries in Trading Networks Console
To view the above Trading Partners screen with the query tabs, click Show Query on
the toolbar.
Display area
showing
query tabs...
Using the Query panel of the toolbar, you can perform basic search functions: create and
save a query, select and run a query, revert back to the original query, and delete a query.
1 Enable the query panel. For instructions, see “Enabling the Query Functions” on
page 414.
2 Specify the search criteria you want to save on each of the query tabs.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 415
A Queries in Trading Networks Console
3 Run the query, select Run Query on the toolbar. Trading Networks displays the
query results table in the bottom panel. For more information, see “Navigating
Through the Results Table” below.
1 Enable the query panel. For instructions, see “Enabling the Query Functions” on
page 414. Trading Networks displays the last query that was run in this screen view.
2 Select the query from the list of saved queries, which is located on the toolbar.
3 To run the query, select Run Query on the toolbar. Trading Networks displays the
query results in the results table in the bottom panel.
416 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
A Queries in Trading Networks Console
1 Enable the query panel. For instructions, see “Enabling the Query Functions” on
page 414.
2 Select the query for which you want to update search criteria from the list of saved
queries, which is located on the toolbar.
3 Make your changes to the search criteria for the saved query by updating the fields on
the query tabs.
4 Re-run the query by selecting Run Query on the toolbar. Trading Networks updates
the results table displayed in the bottom panel
5 Select Save Query on the toolbar to re-save the query with your updates.
1 Enable the query panel. For instructions, see “Enabling the Query Functions” on
page 414.
2 Select the existing query to base the new query on from the list of saved queries,
which is located on the toolbar.
3 Make your changes to the search criteria for the new query by updating the fields on
the query tabs.
4 Re-run the modified query by selecting Run Query on the toolbar. Trading
Networks updates the results table displayed in the bottom panel with the
information from the newly created query.
5 Select Save Query As to save the new query with your changes.
6 In the Save as dialog box, type the name you want to give the query in the Query Name
field. Click OK. Trading Networks adds the query to the list.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 417
A Queries in Trading Networks Console
To revert to a saved query, after running a new query, select Revert to Saved Query.
Trading Networks updates the query panels to display the settings for the saved query,
runs the saved query, and displays the query results
Note: The Revert to Saved Query function is only available after you change query
settings and run the query.
To delete a query
1 Enable the query panel. For instructions, see “Enabling the Query Functions” on
page 414.
2 Select the query you want to delete from the list of saved queries, which is located on
the toolbar.
3 Select Delete Query. Click Yes to verify that you want to delete the query.
418 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
B Archiving and Deleting Documents
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 419
B Archiving and Deleting Documents
Archiving Documents
When Trading Networks archives a document, it does the following:
Moves the document information into the corresponding archival tables.
The archival tables mirror the production tables, as shown in the table below. Data in
the archival tables is identical to the data in the production Trading Networks tables.
Removes the document information and the references to the document from all
production tables in the Trading Networks database.
You can access the archived information from My webMethods. For example, you can
view information about archived documents on the Transactions, Tasks, or Activity Log
pages in My webMethods. You can work with archived data just like you do with
production data (for example, resubmit or reprocess transactions, and stop and restart
420 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
B Archiving and Deleting Documents
tasks.). Using webMethods Reporting, you can also view the Trading Networks reports
based on archived data. For information about webMethods Reporting, see the
webMethods Reporting Guide.
Deleting Documents
With the basic deletion feature, when Trading Networks deletes a document, it removes
all associated document information (from the archival tables and production tables) in
the database. The extended deletion feature enables you to delete documents either from
archival tables, production tables, or both.
Note: If Trading Networks repeatedly deletes Trading Networks data from the Oracle
database, the database tables may become skewed. To resolve this issue, regenerate
the statistics of the table.
1 In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 421
B Archiving and Deleting Documents
422 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
B Archiving and Deleting Documents
folder:subfolder:service wm.tn.archive:archive
Persistence That you want the server to maintain this user task in the
event that the server is restarted by selecting the Persist
after restart check box.
Clustering Whether you want the task to run anywhere in your
cluster of servers. For more information on clusters, see
the webMethods Integration Server Clustering Guide.
5 In the Schedule Type and Details section of the screen, specify that you want the service
to be executed periodically, by selecting either Repeating or Complex. Then, specify the
additional parameters to indicate when and how often you want the archival and
deletion service to run.
Repeating The number of seconds that you want the server to wait
between executions of the service in the Interval field. For
example, if you want the service to run once every 24 hours,
specify 86400.
In the Repeating field, select the Repeat from end of invocation
check box to indicate that if the current occurrence of the task
is not complete when the interval elapses, that you want the
server to wait until the current occurrence of the task
completes before repeating the task.
Note: The service executes for the first time immediately after
you schedule the user task.
Complex Repeating The date and time of the first execution of the service in the
Start Date and Start Time fields and how often after the initial
execution that you want the service to run using the
parameters in the Run Mask field.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 423
B Archiving and Deleting Documents
Example:
To specify that you want the service to execute daily at 10 p.m.
starting on March 15, 2001, specify the following parameters:
Start Date 2001/3/15
Start Time 22:00:00
End Date leave blank
End Time leave blank
Months no selection
Days no selection
Weekly Days no selection
Hours 22
Minutes 0
Note: Omitting the End Date and End Time indicates that the
service is to run indefinitely.
Note: For more information about these parameters, see information about
scheduling services in Administering webMethods Integration Server.
424 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
B Archiving and Deleting Documents
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 425
B Archiving and Deleting Documents
Persistence That you want the server to maintain this user task in the
event that the server is restarted by selecting the Persist
after restart check box.
Clustering Whether you want the task to run anywhere in your
cluster of servers. For more information on clusters, see
the webMethods Integration Server Clustering Guide.
7 In the Schedule Type and Details section of the screen, specify that you want the service
to be executed periodically, by selecting either Repeating or Complex. Then, specify the
additional parameters to indicate when and how often you want the archival and
deletion service to run.
Repeating The number of seconds that you want the server to wait
between executions of the service in the Interval field. For
example, if you want the service to run once every 24 hours,
specify 86400.
In the Repeating field, select the Repeat from end of invocation
check box to indicate that if the current occurrence of the task
is not complete when the interval elapses, that you want the
server to wait until the current occurrence of the task
completes before repeating the task.
Note: The service executes for the first time immediately after
you schedule the user task.
Complex Repeating The date and time of the first execution of the service in the
Start Date and Start Time fields and how often after the initial
execution that you want the service to run using the
parameters in the Run Mask field.
Example:
To specify that you want the service to execute daily at 10 p.m.
starting on March 15, 2001, specify the following parameters:
Start Date 2001/3/15
Start Time 22:00:00
End Date leave blank
426 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
B Archiving and Deleting Documents
Note: Omitting the End Date and End Time indicates that the
service is to run indefinitely.
Note: For more information about these parameters, see information about
scheduling services in Administering webMethods Integration Server.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 427
B Archiving and Deleting Documents
Field Specify...
Name The name of the archive or delete schedule that you are creating.
Description A brief description of the schedule.
Status Whether you want the schedule to be enabled or disabled. When
you enable or disable the schedule, the schedule service in the
Integration Server Scheduler is activated or deactivated,
respectively.
To enable the schedule, select Active.
To disable the schedule, select Suspended.
Note: Keep the status as Suspended until you provide all the
information for the archival or the deletion.
4 Click the Schedule Options tab, if it is not already selected. Complete the following
fields:
Field Specify...
Action Type Whether you want to set up either the archival or the deletion of
Trading Networks data.
To set up the archival, select Archive. This is the default.
To set up the deletion, select Delete.
Datasource Whether the data to be deleted must be archived data, production
data, or both. This field appears only when you select the Delete
option in the Action Type field.
Select Archived Data when you want to delete data from the
archival database tables. This is the default.
Select Both Production and Archived Data when you want to delete
both production data and archived data from the database.
Select Production Data when you want to delete production data.
Days The number of days so that Trading Networks archives or deletes
documents that are older than the number of days you specify.
428 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
B Archiving and Deleting Documents
Field Specify...
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 429
B Archiving and Deleting Documents
5 In the Criteria panel, specify the archival or deletion criteria in the following fields:
Field Specify...
Sender The name of the sender of whose documents you want to archive or
delete.
If you do not want to limit the data based on the sender, leave this
field blank.
Receiver The name of the receiver of whose documents you want to archive
or delete.
If you do not want to limit the data based on the receiver, leave this
field blank.
Document The name of the TN document type of which documents you want
Type to archive or delete.
If you do not want to limit the data based on the TN document
type, leave this field blank.
Processing The processing status of the documents you want to archive or
Status delete, for example, ACCEPTED, DONE, REPROCESSED, and so on.
If you do not want to limit the data based on the processing status
of the documents, leave this field blank.
For information about processing statuses, see Managing B2B
Integrations: webMethods Trading Networks User’s Guide.
User Status The user status of the documents you want to archive or delete.
Select NULL when the value of the user status is null.
Select NOT NULL when the value of the user status is anything
other than null.
If you do not want to limit the data based on the user status of the
documents, leave this field blank.
For information about user statuses, see Understanding webMethods
B2B: webMethods Trading Networks Concepts Guide.
6 In the Data to Archive or Delete panel, select the required data that Trading Networks
must archive or delete. Trading Networks identifies the documents based on the
criteria you select in the Criteria panel.
If you want to archive or delete all the document data, that is, the transactions
data, select Transaction Details (BizDoc).
430 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
B Archiving and Deleting Documents
If you do not want to archive or delete all the document data, select one or more of
the following options:
.
Select To...
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 431
B Archiving and Deleting Documents
Select To...
Run Once Run the archival or deletion only once. You specify the
date and time for the schedule.
This is the default.
Fixed Interval Run the archival or deletion at a fixed interval of time, for
example, every 5 hours.
Hourly Run the archival or deletion on an hourly basis. You
specify the minutes of the hour for the schedule. For
example, run the archival or deletion every hour at 3:15
A.M, 4:15 A.M, 5:15 A.M, and so on.
Daily Run the archival or deletion on a daily basis. You specify
the time in hours and minutes for the schedule. For
example, run the archival or deletion every day at 11:20
P.M.
Weekly Run the archival or deletion on a weekly basis. You
specify the days of the week, and the time in hours and
minutes for the schedule. For example, every Monday,
Tuesday, and Fridays at 1:00 AM, 5:30 A.M, and 12:00 PM.
Monthly Run the archival or deletion on a monthly basis. You
specify the dates, days of the week, and time in hours and
minutes for the schedule. For example, run the archival or
deletion on 5th, 10th, 15th, and 25th that occur on
Mondays and Fridays, at 5:00 AM and 6:00 PM.
Yearly Run the archival or deletion on a yearly basis. You specify
the months, dates, days of the week, and time in hours
and minutes for the schedule. For example, run the
archival or deletion in January, June and December, on
10th and 25th that occur on Sundays, at 5:00 AM and
12:00 PM.
432 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
B Archiving and Deleting Documents
5 Based on the option you select in the Run Schedule field, complete the additional fields
to specify when you want to run the archival or deletion.
If you select Run Once, complete the following fields:
Field Specify...
Field Specify...
Fixed Interval The time interval between every execution of the archival or
deletion. Select the unit of time in the list box. For example, if
you specify the value 2 and select Hours in the list box, then
the archival or deletion occurs every 2 hours.
Do not overlap Whether Trading Networks must wait for the archival or
task deletion from an earlier execution to complete before it starts
the next scheduled execution.
If you select the check box, Trading Networks waits for
the archival or deletion to complete.
If you do not select the check box, Trading Networks
starts with the next scheduled execution irrespective of
whether the earlier scheduled execution is complete.
Field Specify...
Date Range The time period for the archive or delete schedule that you
are creating.
Select from the list of built-in ranges, such as This Day or This
Year, or select Custom to specify your own custom date range.
Start Date The starting date and time of the archive or delete schedule.
This field is automatically populated if you select the built-in
date ranges in the Date Range field. If you select Custom as the
date range, you must specify the start date and time.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 433
B Archiving and Deleting Documents
Field Specify...
End Date The end date and time of the archive or delete schedule.
This field is automatically populated if you select the built-in
date ranges in the Date Range field. If you select Custom as the
date range, you must specify the end date and time.
No end date Whether the schedule has an end date.
If you select the check box, the archive or delete schedule
is valid for an indefinite period of time.
If you do not select the check box, specify an end date
and time of the archive or delete schedule in the End Date
field.
Run schedule at The minutes after every hour when the archival or deletion
these hours must occur. For example, if you select 28, then the archival or
deletion occurs every hour after 28 minutes, that is, at, 1:28
AM, 2:28 AM, 3:28 AM, 1:28 PM, 2:28 PM and so on.
You can also select multiple minutes. For example, if you
select 28 and 35, the archival or deletion occurs at 1:28 AM,
1:35 AM, 2:28 AM, 2:35 AM and so on.
The time is in the 24 hour format.
Do not overlap Whether Trading Networks must wait for the archival or
task deletion from an earlier execution to complete before it starts
the next scheduled execution.
If you select the check box, Trading Networks waits for
the archival or deletion to complete.
If you do not select the check box, Trading Networks
starts with the next scheduled execution regardless of
whether the earlier scheduled execution is complete.
Field Specify...
Date Range For the description of each of these fields, see “Date Range”,
Start Date “Start Date”, “End Date”, and “No end date”
End Date
No end date
434 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
B Archiving and Deleting Documents
Field Specify...
Run schedule The time in hours and minutes when the archival or deletion
everyday at these must occur. For example, if you select, 09.00 as the hour and
times 15 as the minutes, then the archival or deletion occurs every
day at 9:15 A.M.
You can also select multiple hours and minutes. For
example, if you select, 09:00 and 23:00 hours, and 15 and 45
as the minutes, then the archival or deletion occurs every
day at 9:15 A.M, 9:45 A.M, 11:15 P.M, and 11:45 P.M.
The time is in the 24 hour format.
Do not overlap Whether Trading Networks must wait for the archival or
task deletion from an earlier execution to complete before it starts
the next scheduled execution.
If you select the check box, Trading Networks waits for
the archival or deletion to complete.
If you do not select the check box, Trading Networks
starts with the next scheduled execution regardless of
whether the earlier scheduled execution is complete.
Field Specify...
Date Range For the description of each of these fields, see “Date Range”,
Start Date “Start Date”, “End Date”, and “No end date”.
End Date
No end date
Run schedule The day of the week, and time in hours and minutes when
every week the archival or deletion must occur. For example, if you
select Monday as the day, 11:00 as the hour, and 15 as the
minutes, the archival or deletion occurs every Monday, at
11:15 A.M.
You can also select multiple days, hours, and minutes. For
example, if you select Monday, Wednesday, and Friday as
the days, 11:00 and 23:00 as the hours, and 00 and 30 as the
minutes, then the archival or deletion occurs every Monday,
Wednesday, and Friday, at 11:00 A.M, 11:30 A.M, 11:00 P.M,
and 11:30 P.M.
The time is in the 24 hour format.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 435
B Archiving and Deleting Documents
Field Specify...
Do not overlap Whether Trading Networks must wait for the archival or
task deletion from an earlier execution to complete before it starts
the next scheduled execution.
If you select the check box, Trading Networks waits for
the archival or deletion to complete.
If you do not select the check box, Trading Networks
starts with the next scheduled execution regardless of
whether the earlier execution is complete.
Field Specify...
Date Range For the description of each of these fields, see “Date Range”,
Start Date “Start Date”, “End Date”, and “No end date”.
End Date
No end date
Run schedule The date, day of the week, and time in hours and minutes
every month when the archival or deletion must occur. The archival or
deletion occurs only when the date and the day of the week
match. For example, if you select 5th as the date, Monday as
the day, 5:00 as the hours, and 10 as the minutes, then the
archival or deletion occurs every Monday the 5th at 5:10
A.M.
You can also select multiple dates, days, hours, and minutes.
For example, if you select 5th and 25th as the dates,
Saturdays and Sundays as the days, 5:00 and 23:00 as the
hours, and 00 and 45 as the minutes, then the archival or
deletion occurs at the following times:
Every 5th that occurs on either a Saturday or a Sunday, at
5:00 A.M, 5:45 A.M, 11:00 P.M, and 11:45 P.M.
Every 25th that occurs on either a Saturday or a Sunday,
at 5:00 A.M, 5:45 A.M, 11:00 P.M, and 11:45 P.M.
The time is in the 24 hour format.
436 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
B Archiving and Deleting Documents
Field Specify...
Do not overlap Whether Trading Networks must wait for the archival or
task deletion from an earlier execution to complete before it starts
the next scheduled execution.
If you select the check box, Trading Networks waits for
the archival or deletion to complete.
If you do not select the check box, Trading Networks
starts with the next scheduled execution regardless of
whether the earlier scheduled execution is complete.
Field Specify...
Date Range For the description of each of these fields, see “Date Range”,
Start Date “Start Date”, “End Date”, and “No end date”.
End Date
No end date
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 437
B Archiving and Deleting Documents
Field Specify...
Run schedule The month, date, day of the week, and time in hours and
every year minutes when the archival or deletion must occur. The
archival or deletion occurs only when the month, date, and
the day of the week match. For example, if you select
January as the month, 5th as the date, Monday as the day,
9:00 as the hours and 0.00 as the minutes, then the archival or
deletion occurs when January 5th occurs on a Monday, at
9:00 A.M.
You can also select multiple months, dates, days, hours, and
minutes. For example, if you select January and June as the
months, 10th and 30th as the dates, Saturday and Sunday as
the days, 5:00 and 23:00 as hours, and 00 as the minutes, then
the archival or deletion occurs at the following times:
January 10th that occurs on a Saturday or a Sunday, at
5:00 A.M and 11:00 P.M.
January 30th that occurs on a Saturday or a Sunday, at
5:00 A.M and 11:00 P.M.
June 10th that occurs on a Saturday or a Sunday, at 5:00
A.M and 11:00 P.M.
June 30th that occurs on a Saturday or a Sunday, at 5:00
A.M and 11:00 P.M.
The time is in the 24 hour format.
Do not overlap Whether Trading Networks must wait for the archival or
task deletion from an earlier execution to complete before it starts
the next scheduled execution.
If you select the check box, Trading Networks waits for
the archival or deletion to complete.
If you do not select the check box, Trading Networks
starts with the next scheduled execution regardless of
whether the earlier scheduled execution is complete.
438 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
B Archiving and Deleting Documents
3 In the Search Results panel, click in the row that contains the schedule you want to
edit.
4 In the Archive Schedule Details page, update the archive or delete schedule details. For
information about the fields for the schedule details, see “Setting the Archival and
Deletion Criteria” on page 427 and “Scheduling the Archival and Deletion of
Documents” on page 432.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 439
B Archiving and Deleting Documents
5 Click Save.
3 In the Search Results panel, click in the row that contains the schedule you want to
copy.
4 In the Archive Schedule Details page, update the archive or delete schedule details to
create a new archive or delete schedule. For information about the fields for the
schedule details, see “Setting the Archival and Deletion Criteria” on page 427 and
“Scheduling the Archival and Deletion of Documents” on page 432.
5 Click Save. Trading Networks creates a new archive or delete schedule.
440 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
C Exporting and Importing Database Information
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 441
C Exporting and Importing Database Information
Important! The export/import feature is only for migrating Trading Networks objects
between databases on your system that use the same version of Trading Networks. It
is not for:
Migrating database information from one version of Trading Networks to
another.
Sharing Trading Networks objects with trading partners.
When you export Trading Networks objects, Trading Networks creates a file that contains
the data you exported. You place the file in a location available to the target Trading
Networks system and import the data from the file into the database on the target
Trading Networks system.
Trading Networks objects are available for export regardless of whether they are disabled
or deleted. There is no indication as to which are disabled, enabled, or deleted. Trading
Networks maintains the current state (e.g., disabled, enabled, deleted) of the Trading
Networks objects that you migrate.
442 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
C Exporting and Importing Database Information
Trading Partner Agreements (TPAs), see “Migrating Trading Partner Agreements (TPAs)”
on page 452.
Queries that you defined for Console screens, see “Migrating Queries” on page 453.
Public queues, see “Migrating Public Queues” on page 454.
Data permissions, see “Migrating Data Permissions” on page 455.
You cannot export/import information about the documents that are in your system, for
example, document content, tasks, and activity log entries.
To export data using the Console, you use the Export Data dialog box; to import, use the
Import Data dialog box. Trading Networks displays a tree structure in these dialog boxes
that contains the items that are available for you to export/import.
Note: To export/import using the command line utilities, see “Using the tnexport and
tnimport Utilities” on page 460.
Trading Networks
object Trading Networks checks for...
Profile field Profile field with the same profile field name.
Profile Profile with the same Corporation Name and Unit Name.
Trading Partner TPA with the same sender name, receiver name and agreement
Agreement (TPA) ID.
Document Attribute with the same name.
attribute
TN Document TN Document Type with the same name.
Type
Processing rule Processing rule with the same name.
If Trading Networks finds a matching item using either method, Trading Networks
prompts as to whether it should overwrite that item in the target system. For more
information about how Trading Networks overwrites the items in the target system, see
“Using the Overwrite Dialog Box” on page 458.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 443
C Exporting and Importing Database Information
Export Data dialog with a TN Document Type that has dependencies selected
Note: The Import Data dialog box shows some, but not all of the dependencies. For
example, the Import Data dialog box cannot display the IS service dependencies
because these dependencies are not recorded in the exported file.
444 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
C Exporting and Importing Database Information
Migrating Profiles
To migrate profiles, use the following items in the Export Data and Import Data dialog
boxes:
Items in
Export/Import
Data Dialog box Use to migrate... Dependencies
Partner Data Data for: Profile Groups
Standard profile fields Delivery Methods
Extended profile fields External ID Types
Certificate information on the Security Contact Types
tab of the profile.
For more information,
For more information, see “Partner Data” see “Partner Data
on page 446. Dependencies” on
page 446.
External ID Types External ID types referenced by the None
profiles on your system.
Trading Networks lists all external ID
types defined in the database. These
include all the standard external ID types
(e.g., DUN, DUNS+4) that are installed
with Trading Networks and all custom
external ID types that you add using the
wm.tn.dictionary:addIDType service.
Contact Types Contact types referenced by the profiles on None
your system.
Trading Networks lists all contact types
defined in the database. These include both
the standard contact types (i.e., Technical
and Administrative) that are installed with
Trading Networks and all custom contact
types that you add using the
wm.tn.dictionary:addContactType service.
Profile Groups Partner groups that you have registered on None
your Trading Networks system.
Important! You cannot use export/import to share your profile with a partner. When
you export your (Enterprise) profile, Trading Networks records that the profile is the
Enterprise profile. Trading Networks does not allow you to import the Enterprise
system from your system into a partner's system.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 445
C Exporting and Importing Database Information
Note: When importing profiles, if any of the dependent data is not defined, Trading
Networks throws an error and does not import the profile. For example, if the contact
type is not already defined in the target system before importing a contact of that
type, an error is thrown and that profile is not imported.
Partner Data
Trading Networks lists each partner by its corporation name under the Partner Data item.
Note: The Enterprise profile is also listed by its corporation name. It is not listed under
Enterprise.
For each partner that is listed under Partner Data, Trading Networks lists the following
elements:
Profile. Select this item to migrate the data for the standard profile fields for the
specific partner.
Security Data. Select this item to migrate the certificate information from the Security
tab of the partner's profile. If the profile has no information on the Security tab, the
Security Data element will not be listed under Partner Data in the tree.
One element for each extended profile field. Select these items to migrate the data for the
extended profile fields for the specific partner. If you have not defined extended
fields, no extended field elements will be listed under Partner Data in the tree.
Partner Data
Element Dependencies Description
Profile Partner Groups The partner groups that are identified in the partner’s
profile.
Use the Profile Groups tree element to migrate the
partner groups.
446 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
C Exporting and Importing Database Information
Partner Data
Element Dependencies Description
Delivery The delivery methods that are defined for the
Methods partner.
If only the built-in immediate delivery methods are
defined for the partner, no action is needed.
If immediate delivery methods that you create or the
custom delivery services are defined for the partner,
you cannot migrate the delivery methods. You must
create these methods in the target system.
External ID The external ID types that are used by the partner.
Types
If the partner uses custom external ID types that you
added using the wm.tn.dictionary:addIDType service,
migrate the those external ID types using the External
ID Types item.
Trading Networks also lists standard external ID
types. You do not need to migrate these unless they
have been deleted from the target system.
Contact Types The contact types that are used by the partner.
If the partner uses custom contact types that you
added using the wm.tn.dictionary:addContactType service,
migrate those contact types using the Contact Types
item.
Trading Networks also lists standard contact types.
You do not need to migrate these unless they have
been deleted from the target system.
Queues The public queues used by the partner.
You migrate the queues using the Public Queues item.
Security Data Profile The partner’s profile. You migrate the profile when
you select the Profile element under Partner Data.
Extended Field Definition The profile field definition for the extended profile
Profile Fields field.
Use the Field Definitions item to migrate the definition
for the extended profile field. For more information,
see “Migrating Profile Fields” on page 448.
Profile The partner’s profile. You migrate the profile when
you select the Profile element under Partner Data.
In addition to migrating the queue, ensure you move the scheduled delivery services that
are associated with the queues to the target system.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 447
C Exporting and Importing Database Information
Items in
Export/Import
Data Dialog box Use to migrate... Dependencies
Field Definitions Definitions for standard and extended profile Field Group
fields.
For more
Note: To migrate the data for profile fields, use information, see
the Partner Data item. For more information, see “Field Definitions
“Partner Data” on page 446. Dependencies”
on page 448.
Field Groups Profile field groups that you added to your None
system on the Extended Field group of a profile or
by using the wm.tn.dictionary:addFieldGroup service.
Trading Networks lists all field groups,
including the standard field groups that are
installed with Trading Networks (e.g.,
Corporation, Delivery, Contact). You only need
to migrate custom field groups that you add.
448 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
C Exporting and Importing Database Information
Items in Export/Import
Data Dialog box Use to migrate... Dependencies
Document Types Definitions for TN Document Types. IS Services
Attributes
For more
information, see
“Document Type
Dependencies”
on page 449.
DocType Categories Categories of documents (e.g., XML and None
Flat File). All Trading Networks systems
(which is a sub-item
will have the TN Document Type
under Binary Data)
categories. You do not need to migrate
them.
Dependencies Description
IS Services The fully-qualified name of the following types of services that
you can specify in a TN Document Type:
Duplicate checking service for the Check for Duplicate
Document pre-processing action
Custom attribute transformation services if specified for an
attributes to extract.
If a TN Document Type that you are migrating uses either or
both of these types of services, ensure that you move the IS
services to the target Trading Networks system.
Attributes The custom document attributes that are associated with the TN
Document Type.
Use the Attributes item to migrate the custom attributes for the
TN Document Type. For more information, see “Migrating
Custom Document Attributes” on page 450.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 449
C Exporting and Importing Database Information
Note: You do not need to migrate system attributes because the system attributes are
defined when you install Trading Networks, and you cannot delete nor alter their
definitions.
Items in
Export/Import Data
Dialog box Use to migrate... Dependencies
Document Definitions for custom document attributes. None
Attributes
Items in
Export/Import Data
Dialog box Use to migrate... Dependencies
Processing Rules Processing rules IS Services
Delivery Methods
For more information, see
“Processing Rules Dependencies”
on page 451.
When you select to export and import processing rules, be aware of the order of the
processing rules. Trading Networks maintains processing rules in a specific order. This is
the order in which Trading Networks selects a processing rule to use for processing an
incoming document. (Trading Networks uses the first processing rule that matches.)
450 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
C Exporting and Importing Database Information
Trading Networks maintains the list of processing rules that you want to export and
import in the order it is in the target system. When you import a processing rule, Trading
Networks replaces the matching processing rules and appends the non-matching
processing rules without changing the order of the list in the target system, irrespective of
its order in the source system.
Note: When you import processing rules, you can select to replace all the processing
rules in the target Trading Networks system with the imported processing rules by
selecting the Replace Processing Rule List option in the Import Data dialog box.
Dependencies Description
IS Services The fully-qualified names of the following types of services that
you can specify in a processing rule:
Service you identify with the Execute a Service processing
action
Duplicate checking service for the Check for Duplicate Document
pre-processing action if a custom service is specified
If a processing rule that you are migrating uses either or both of
these types of services, ensure that you move the IS services to
the target Trading Networks system.
Delivery Methods The immediate delivery method that is used in the Deliver
Document By action of the processing rule.
If the processing rule uses a custom immediate delivery method
that you added, ensure that you move the corresponding IS
services to the target Trading Networks system, and use the
wm.tn.delivery:registerService service to register the IS service using
the same delivery method name.
If the processing rule uses a built-in immediate delivery method,
no action is needed.
If the processing rule contains the immediate delivery methods
that you create or the custom delivery services, you cannot
migrate the delivery methods. You must create these methods in
the target system.
Although the Dependencies does not list the following Trading Networks objects, they are
also required if referenced in a processing rule. Review the processing rules you want to
export/import and migrate the following if appropriate.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 451
C Exporting and Importing Database Information
Profiles for senders identified in the Sender criterion on the Criteria tab of the
processing rule, see “Migrating Profiles” on page 445.
Profiles for the receivers identified in the Receiver criterion on the Criteria tab of the
processing rule, see “Migrating Profiles” on page 445.
TN Document Types identified in the Document Type criterion on the Criteria tab of the
processing rule, see “Migrating TN Document Types” on page 449.
Custom document attributes identified on the Extended Criteria tab of the processing
rule, see “Migrating Custom Document Attributes” on page 450.
Queues referenced by a Scheduled Delivery used by the Deliver Document By processing
action. To create the queues on the target system, you can do one of the following:
Use the tnexport and tnimport utilities to export all public and private queues.
For more information, see “Using the tnexport and tnimport Utilities” on
page 460.
Manually create the required queue on the target system. Be sure to use the exact
queue name with the same combination of upper and lowercase letters when
defining the queue on the target system.
In addition to migrating the queue, ensure you move the scheduled delivery service
that are associated with the queue to the target system.
Note: When importing processing rules, Trading Networks determines whether the
associated senders, receivers, and TN Document Types exist in the target system with
the same internal ID or name. If they do not exist, Trading Networks throws an error
and does not import the processing rule.
Items in
Export/Import Data
Dialog box Use to migrate... Dependencies
Agreements TPAs Profiles
IS Services
IS Document Types
For more information, see
“Agreements Dependencies” on
page 453.
452 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
C Exporting and Importing Database Information
Agreements Dependencies
The following table shows the dependencies for Agreements. For more information about
dependencies, see “Dependencies For Trading Networks Objects” on page 444.
Dependencies Description
Profiles The profiles of the partners that are associated with the TPA. A
TPA is associated with two trading partners on your system, one
that acts as the sender and one that acts as the receiver. Migrate
the profiles for the sender and receiver. For more information,
see “Migrating Profiles” on page 445.
IS Services The fully-qualified names of the following types of services that
you can specify in a TPA:
Initialization service
Export service
If a TPA that you are migrating uses either or both of these types
of services, ensure that you move the IS services to the target
Trading Networks system.
IS document types The fully-qualified name of the IS document type that defines the
structure of the TPA data.
Ensure that you migrate this IS document type to the target
Trading Networks system.
Note: When importing TPAs, Trading Networks determines whether the associated
senders and receivers exist in the target system with the same internal ID or name. If
they do not exist, Trading Networks throws an error and does not import the TPA.
Migrating Queries
You can migrate all the queries you have defined for the Trading Networks Console
screens (e.g., queries you defined for the Transaction Analysis screen to search for specific
documents). To migrate all of your queries, use the following item in the Export Data and
Import Data dialog boxes.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 453
C Exporting and Importing Database Information
Items in
Export/Import Data
Dialog box Use to migrate... Dependencies
Query All queries that you have defined for all screens None
of the Trading Networks Console:
(a sub-item
under Binary Data) Trading Partners
Document Types
Processing Rules
Agreements
Transaction Analysis
Tasks
Activity Log
Note: This migrates only queries defined in the Console. Searches you save in My
webMethods are not stored in the Trading Networks database.
Items in
Export/Import Data
Dialog box Use to migrate... Dependencies
Public Queues Public queues. IS services
Dependencies Description
IS Services The fully-qualified names of the delivery service associated with
the queue. Be sure to move the IS services to the target Trading
Networks system.
454 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
C Exporting and Importing Database Information
Dependencies Description
Profiles All profiles that are part of the data set definitions for data
permission rules.
TN Document All TN Document Types that are part of the data set definitions for
Types data permission rules.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 455
C Exporting and Importing Database Information
Dependencies Description
My webMethods The My webMethods roles that the data permission rules
roles reference. These roles are defined in the My webMethods Server
database not the Trading Networks database, and as a result, you
cannot import/export them with the Trading Networks tnexport
and tnimport command line utilities. You must ensure the My
webMethods Server setup is the same in the target system.
For more information about how profiles and TN Document Types are used to define the
data set of a data set permission rule, see “Defining Data Permissions” on page 72.
When you export the data permissions, and you do not include the dependent profiles,
and TN document types, then when importing, Trading Networks throws a warning
indicating that the required dependent does not exist in the target system. It then
continues to import the other items.
3 Click OK.
4 In the Save File dialog box, specify the file to which you want Trading Networks to
write the database information. Then, click Save.
Note: The file that contains the exported data is a binary-encoded file.
456 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
C Exporting and Importing Database Information
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 457
C Exporting and Importing Database Information
458 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
C Exporting and Importing Database Information
Suppressing the Overwrite Dialog Box and Forcing the Overwrite of Items
If you want Trading Networks to automatically overwrite the matching items in the
target database, select the Force Import check box on the Import Data dialog box. When
you select the Force Import check box, Trading Networks does not display the Overwrite
dialog box. It overwrites the matching items without prompting for confirmation.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 459
C Exporting and Importing Database Information
6 Click OK.
Note: If there are any import errors, Trading Networks displays the Import Errors
dialog. This dialog lists each item that has an error. To see more details of the error,
select the item in the Name column.
Use these utilities to perform a bulk transfer of data from one Trading Networks system
to another.
tnexport Utility
Use the tnexport utility to export all objects of the selected types. For example, if you
specify you want to export processing rules, all processing rules defined in the Trading
Networks database are exported. The format of the tnexport command line is as follows:
where:
outfile is one of the following:
-bin binfile Use the -bin option to export the data to a binary file. binfile is the
path and file name to which you want to export the data. The
directory in which you want the output file placed must already
exist. If you specify a relative path, Trading Networks uses a
directory relative to the directory from which you are running the
tnexport utility. If the file already exists, Trading Networks
overwrites it.
Note: Binary output is much smaller than the XML output, but
cannot be read by humans.
-xml xmlfile Use the -xml option to export the data to an XML file. xmlfile is the
path and file name to which you want to export the data. The
directory in which you want the output file placed must already
exist. If you specify a relative path, Trading Networks uses a
directory relative to the directory from which you are running the
tnexport utility. If the file already exists, Trading Networks
overwrites it.
460 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
C Exporting and Importing Database Information
Examples
You want to export all profiles, all extended field values in the profiles, and all the
extended field definitions to the XML file \TradingNetworks\ExportedData.xml. Use
the following command line:
tnexport -xml \TradingNetworks\ExportedData.xml -profiles -extflds -flddefs
You want to export all data in the Trading Networks database to the binary file
ExportedData.bin, and you want the utility to create the ExportedData.bin file in the
same directory as where you are running the utility. Use the following command line:
tnexport -bin ExportedData.bin -all
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 461
C Exporting and Importing Database Information
tnimport Utility
Use the tnimport utility to import all data in a specified file. The file you specify must
contain data that you previously exported from a Trading Networks database using
either the tnexport utility or the Trading Networks Console.
Note: After using the tnimport utility, you must reload the WmTN package to be able
to use the imported data.
where:
infile is one of the following:
-bin binfile Use the -bin option to import the data from a binary file.
binfile is the path and file name of the binary file that
contains the data to import. If you specify a relative path,
Trading Networks looks for the directory relative to the
directory from which you are running the tnimport utility.
-xml xmlfile Use the -xml option to import the data from an XML file.
xmlfile is the path and file name of the XML file that contains
the data to import. If you specify a relative path, Trading
Networks looks for the directory relative to the directory
from which you are running the tnimport utility.
462 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
C Exporting and Importing Database Information
-replaceRuleList Indicates whether you want the tnimport utility to replace all
the processing rules in the input file to the current list of
processing rules. This applies only to importing processing
rules.
If you do not specify this option, the tnimport utility replaces
only the matching processing rules in the target system and
appends the non-matching processing rules to the existing
list on the target system.
Examples
You want to import the data in the XML file \TradingNetworks\ExportedData.xml.
You want the tnimport utility to overwrite objects that have the same ID or name as
those in the input file, and you want to completely overwrite the matching processing
rules and append the non-matching processing rules to the current list. Use the
following command line:
tnimport -xml \TradingNetworks\ExportedData.xml -db -force
You want to view information about the data in the input file ExportedData.bin that
resides in the same directory as the tnimport utility. You do not want to import it into
your database. Use the following command line:
tnimport -bin ExportedData.bin
You want to import all data in the binary file ExportedData.bin that resides in the
same directory as the tnimport utility. You want the tnimport utility to replace all the
existing list of processing rules in the target system with the imported processing
rules. Use the following command line:
tnimport -bin ExportedData.bin -db -replaceRuleList
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 463
C Exporting and Importing Database Information
464 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Updating Properties on the Configure Properties Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Alphabetical Listing of the Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Cluster Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Database Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Database Query Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Data Level Security Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
Debugging Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
Document Archiving Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
Document Delivery Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Document Validation Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Flat File Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Large Document Handling Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Localization Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Performance Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Profile Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Task Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Miscellaneous Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 465
D Trading Networks Configuration Properties
Overview
You can update properties from My webMethods using the Administration > Integration >
B2B Settings > Configure Properties page. Updating properties on the Configure Properties
page changes the properties in the Trading Networks properties.cnf file. The
properties.cnf file is located in the
Software AG_directory\IntegrationServer\packages\WmTN\config\ directory, where
Software AG_directory\IntegrationServer is the directory in which your Integration Server
is installed.
Property Category
tn.archive.archiveAfterDays Document Archiving Properties
tn.archive.batchSize Document Archiving Properties
tn.archive.batchBackoffTime Document Archiving Properties
tn.archive.deleteAfterDays Document Archiving Properties
tn.archive.maxRows Document Archiving Properties
tn.BigDocThreshold Large Document Handling Properties
tn.check.ambiguous.docs Miscellaneous Properties
tn.clean.routePipeline Performance Properties
tn.cluster.notifyCacheChange Cluster Properties
tn.cluster.notifyProfileAddUser Cluster Properties
466 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
Property Category
tn.cluster.notifyPropertyChange Cluster Properties
tn.cluster.sync.remoteAliases Cluster Properties
tn.db.fetchMaxRows Performance Properties
tn.db.sortDocTimestamp Performance Properties
tn.default.idType Profile Properties
tn.default.userCreation Profile Properties
tn.delivery.ftpTransferType Document Delivery Properties
tn.dls.EnableLogDataSetChanges Data Level Security Properties
tn.doc.saveAsDone Performance Properties
tn.doctype.includeHidden Miscellaneous Properties
tn.doc.validate.max_errs Document Validation Property
tn.export.deleted.profiles Profile Properties
tn.ff.contenttypes Flat File Property
tn.ism.stats.saveFrequency Miscellaneous Properties
tn.locale.country Localization Properties
tn.locale.language Localization Properties
tn.locale.variant Localization Properties
tn.mail.from Document Delivery Properties
tn.mail.onuserfail Miscellaneous Properties
tn.mail.subject Document Delivery Properties
tn.profile.EnableLogProfileChanges Profile Properties
tn.query.maxrows Database Query Properties
tn.query.threshold Database Query Properties
tn.receive.clearKeys Performance Properties
tn.receive.clearTNObjects Performance Properties
tn.recursion.max Miscellaneous Properties
tn.resubmit.return.bizdocs Performance Properties
tn.server.seq Miscellaneous Properties
tn.store.encoding Database Properties
tn.store.logsql Data Level Security Properties
tn.store.pool.stmt Performance Properties
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 467
D Trading Networks Configuration Properties
Property Category
tn.task.attempt.notPersisted Task Properties
tn.task.dbupdate.enableNotifications Task Properties
tn.task.dbupdate.retryEnabled Task Properties
tn.task.dbupdate.retrySweepTime Task Properties
tn.task.init.groupSize Task Properties
tn.task.init.pauseLength Task Properties
tn.task.maxRetries Task Properties
tn.task.notifyFailure Task Properties
tn.task.pauseOnMaxThreads Task Properties
tn.task.retryFactor Task Properties
tn.task.sweepTime Task Properties
tn.task.threadpool.pct Task Properties
tn.task.ttw Task Properties
tn.tpa.cacheSize Performance Properties
tn.transport.user Task Properties
tn.xml.cacheXQLQueryResults Performance Properties
tn.xml.xqlThreshold Large Document Handling Properties
Cluster Properties
Set these properties to configure Trading Networks to run in a clustered environment.
Note: If you are using Trading Networks in a cluster, be sure to set the tn.query.threshold
property to -1.
468 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
tn.cluster.notifyCacheChange
Description: Controls whether an Integration Server will notify other servers in
the cluster when a change occurs in any of the following:
TN document types
processing rules
attributes
profile summaries
delivery services
Specify either true or false. If you specify true, use the
tn.cluster.sync.remoteAliases property to specify the servers in the cluster
that should be notified.
Default Value: true
Example: To configure Trading Networks so that it will not notify servers in the
cluster, use the following:
tn.cluster.notifyCacheChange=false
tn.cluster.notifyProfileAddUser
Description: Controls whether when a user account is created on one Integration
Server in a cluster, the user account is also created on the other
servers in the cluster. Specify either true or false. If you specify true,
use the tn.cluster.sync.remoteAliases property to specify the servers in the
cluster that should be notified.
Default Value: true
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 469
D Trading Networks Configuration Properties
tn.cluster.notifyPropertyChange
Description: Controls whether when you update the Trading Networks properties
on one Integration Server in a cluster that the Trading Networks
properties are updated on the other servers in the cluster. Specify
either true or false. If you specify true, use the
tn.cluster.sync.remoteAliases property to specify the servers in the cluster
that should be notified.
Default Value: true
tn.cluster.sync.remoteAliases
Description: Specifies the remote server aliases for the other servers in the cluster.
Default Value: No default; if you do not provide a value, Trading Networks cannot
notify other servers when there are changes.
Example: If you have two servers, Server1 and Server2, running in a cluster,
you must create a remote server alias for Server1 on Server2, and a
remote server alias for Server2 on Server1. For example, the
tn.cluster.sync.RemoteAliases property for Server1 would look like
the following:
tn.cluster.sync.remoteAliases=Server2
If you have more than two Integration Servers (for example, Server1,
Server2, and Server3) running in a cluster, separate the remote server
aliases with a comma. For example, the tn.cluster.sync.RemoteAliases
property for Server 1 in this instance would look like the following:
tn.cluster.sync.remoteAliases=Server2,Server3
470 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
Database Properties
tn.store.encoding
Description: Identifies the encoding that your database is using. When a string is
passed to an INSERT or UPDATE statement and that string is too
long to fit into a column, Trading Networks uses the value of this
property to determine where to truncate the string.
Default Value: If you do not specify a value, Trading Networks uses the default
system encoding.
Example: To indicate that your database uses the SHIFT_JIS encoding, specify
the following:
tn.store.encoding=SHIFT_JIS
tn.query.maxrows
Description: Specifies the default number of rows that the query services return.
The query services are services in the wm.tn.query folder. An input
variable to the query services allows you to specify a maximum
number of rows that you want returned from a query. However, if
you do not specify the number of rows to return when you invoke a
query service, the query service uses the value you specify for this
property. If a query returns more rows than allowed by this property,
the query service silently drops the rows that exceed the value you
specify.
Default Value: 0 (This value means there is no maximum.)
Example: If you want to set the default value for the number of rows a query
service returns to 500, specify the following:
tn.query.maxrows=500
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 471
D Trading Networks Configuration Properties
tn.query.threshold
Description: The number of rows of query results that Trading Networks stores in
the session object.
You can have Trading Networks store query results in the session
object to optimize query execution. Trading Networks stores the
number of rows that you specify in the session object on the server
and uses the caching component to store the remaining rows of query
results. This caching component stores these results in Coherence
cache.
Trading Networks uses this property for all queries that you perform
from My webMethods and the Console, for example, queries for
documents, tasks, and activity logs. In addition, this is the default for
queries that you perform using the built-in services in the wm.tn.query
folder. For more information about the built-in service in the
wm.tn.query folder, see the webMethods Trading Networks Built-In
Services Reference.
If you are using Trading Networks in a cluster, Trading Networks
should not store query results in the session object. To prevent
Trading Networks from storing query results in the session object, set
this property to –1.
If you are not using Trading Networks in a cluster, for best
performance, this setting should be the page size you use for query
results. Trading Networks uses a page size of 50 for queries
performed through the Console.
Default Value: 50
Example: To indicate that you do not want Trading Networks to store query
results in a session object because you are using Trading Networks in
a cluster, specify the following:
tn.query.threshold=-1
472 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
tn.dls.EnableLogDataSetChanges
Description: Controls whether you want to log actions related to role-based access.
When you use My webMethods to manage data permissions and
general functional permissions, Trading Networks logs changes that
you make.
Default Value: false
When you specify false, Trading Networks does not log role-based
access auditing information.
Example: If you want Trading Networks to log role-based access auditing
information, specify the following:
tn.dls.EnableLogDataSetChanges=true
Debugging Properties
tn.store.logsql
Description: Specifies whether you want Trading Networks to write each SQL
statement to the server log as it executes the statement. Writing the
SQL statements to the log will cause the server to run more slowly.
You should only use this feature when in a development
environment and not in a production environment. Specify true to
have Trading Networks write the SQL statements to the log or false
to prevent Trading Networks from writing the SQL statements to the
log.
Note: To view the SQL statements in the server log, you must have the
detail level for your server log set to 9 or higher. You specify the level
of detail you want to view in the server log using the -debug startup
option when you start the Integration Server.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 473
D Trading Networks Configuration Properties
tn.archive.archiveAfterDays
Description: Specifies the number of days so that Trading Networks archives
documents older than the specified number of days. Specify a
number from 0 through 730365. If you omit this property or specify 0
for this property, Trading Networks does not archive documents.
Default Value: No default. If you omit this property, Trading Networks does not
archive documents.
Example: To archive documents 30 days after they are received, specify the
following:
tn.archive.archiveAfterDays=30
tn.archive.batchSize
Description: Specifies the number of documents that Trading Networks must
archive or delete in a batch. Trading Networks archives or deletes
documents in batches.
If the number of documents available for archival or deletion is less
than the value that you set for this property, then Trading Networks
archives or deletes only those number of documents in the batch.
There is no limit for the batch size.
Default Value: 100
tn.archive.batchBackoffTime
Description: Specifies the pause time in seconds between two batches of archival
or deletion. There is no time limit for the pause time.
Default Value: 15
474 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
tn.archive.deleteAfterDays
Description: Specifies the number of days so that Trading Networks deletes
documents older than the specified number of days. Specify a
number from 0 through 730365. If you omit this property or specify 0
for this property, Trading Networks does not delete documents.
Default Value: No default. If you omit this property, Trading Networks does not
delete documents.
Example: To delete documents 60 days after they are received, specify the
following:
tn.archive.deleteAfterDays=60
tn.archive.maxRows
Description: Specifies the maximum number of documents that must be archived
or deleted in each schedule. These documents are archived or deleted
in batches with the size that you provide in the “tn.archive.batchSize”
property.
The value you provide in this property must be greater than or equal
to the value of the tn.archive.batchSize property.
Default Value: -1. -1
indicates that there is no limit to the maximum number of
documents that can be archived or deleted in a schedule.
Example: To archive or delete a maximum of 100000 documents in each
schedule, specify the following:
tn.archive.maxRows=100000
tn.delivery.ftpTransferType
Description: Controls the transfer type for FTP delivery of documents. Specify
active if you want to use active mode FTP to deliver documents.
Specify passive if you want to use passive mode FTP.
Default Value: passive
Example: If you want to use active mode FTP to deliver documents, specify the
following:
tn.delivery.ftpTransferType=active
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 475
D Trading Networks Configuration Properties
tn.mail.from
Description: The e-mail address you want Trading Networks to use as the “from”
e-mail address in the e-mail messages that it sends to deliver a
document when instructed to use an e-mail delivery method.
Default Value: No default.
Example: If you want the e-mail messages to use the “from” e-mail address
TNAdmin@ifc.com, specify the following:
tn.mail.from=TNAdmin@ifc.com
tn.mail.subject
Description: The subject line you want Trading Networks to use in the e-mail
messages that it sends to deliver a document when instructed to use
an e-mail delivery method.
Default Value: By default, Trading Networks does not specify a subject line in e-mail
messages.
Example: If you want the e-mail messages to use the subject line “Document
from IFC”, specify the following:
tn.mail.subject=Document From IFC
tn.doc.validate.max_errs
Description: The maximum number of errors that Trading Networks returns when
errors occur when validating a document. If the structure of a
document is not valid, the validation service can return many error
messages. Set this property to limit the number of returned error
messages.
Default Value: 10
476 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
tn.ff.contenttypes
Description: The content types you want the Integration Server to associate with
flat file documents. Use this property to register content types for flat
file documents. To set this property, specify a comma-separated list of
all the content types you want the Integration Server to treat as flat
files.
If you do not include this property in the properties.cnf file, by
default the Integration Server treats documents with the content type
text/plain as flat files.
You cannot register the following content types as flat files:
application/x-www-form-urlencoded
text/xml
application/x-wmrpc2
application/x-x509v3-bin
application/x-wmrpc
application/x-wmrpc-bin
application/x-wmidatabin
application/wm-soap
application/soap
application/soap+xml
Default Value: text/plain
Example: If you want the Integration Server to treat documents with the
content types text/plain, text/csv, text/richtext, and multipart/digest
as flat files, specify the following:
tn.ff.contenttypes=text/plain,text/csv,text/richtext,multipart
/digest
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 477
D Trading Networks Configuration Properties
tn.BigDocThreshold
Description: The threshold size at which Trading Networks should consider a
document to be large.
Possible Values: -n, any negative whole number indicating that Trading Networks
considers no documents as large. Trading Networks processes all
documents in the traditional manner, reading the document content
into memory during processing.
0,indicating that Trading Networks considers all documents large.
Because all documents that Trading Networks receives contain more
than 0 bytes, Trading Networks uses large document handling for all
documents.
n,
any positive whole number indicating the number of bytes over
which Trading Networks considers a document to be large.
Default Value: -1, indicating that Trading Networks considers no documents to be
large.
Example: If you want Trading Networks to consider all documents over
1,000,000 bytes to be large, set this property to 1000000:
tn.BigDocThreshold=1000000
tn.xml.xqlThreshold
Description: Determines the maximum number of bytes that Trading Networks
reads into memory from the start of an XML document to perform
the XQL queries that are defined in a TN XML document type. The
XQL queries can be identifying queries or queries to extract
attributes. In your TN document types, if you have XQL queries that
point to nodes beyond the number of bytes that Trading Networks
reads, the queries will fail. For more information about queries in TN
document types, see the Chapter 13, “Defining and Managing TN
XML Document Types”.
Specify a positive whole number greater than 1000. If you specify a
value less than 1000, Trading Networks reads 1000 bytes.
478 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
Localization Properties
Use the localization properties to change the server’s locale. When you change the locale,
Trading Networks displays error messages and screen labels using the language that is
associated with the locale. To display the messages and screen labels in the language,
Trading Networks must have the appropriate resource bundle. These resource bundles
reside in the tncore.zip file, which was copied to your system during installation. If you
change the locale but the resource bundle does not exist for that locale, Trading Networks
attempts to find the best match. For information about how Trading Networks selects the
resource bundle that matches best, see Sun® Microsystems’ documentation for the
java.util.ResourceBundle class. By default, Trading Networks uses the locale of the host
machine.
To change the locale you must set, at a minimum, the tn.locale.language and tn.locale.country
properties. If you do not specify both of these properties, Trading Networks continues to
use the default locale (the locale of the host machine).
tn.locale.language
Description: The two-letter ISO 639 language code for the language you want
Trading Networks to use for messages and screen labels.
Example: The two-letter ISO 639 language code for the French language is “fr”.
To set this property to identify the French language, specify:
tn.locale.language=fr
tn.locale.country
Description: The two letter ISO 3166 country code for the country that is
associated with the language.
Example: The two-letter ISO 3166 country code for Canada is “CA”. If you want
to localize for the French language in Canada, set tn.locale.language
to "fr" (as shown above) and set tn.locale.country to "CA":
tn.locale.country=CA
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 479
D Trading Networks Configuration Properties
tn.locale.variant
Description: A variant code that further distinguishes the locale, if necessary.
Typically you use the variant code if there is a difference based on the
platform on which the server is running. If you need to specify more
than one variant code, separate them with an underscore, placing the
most important codes first.
For more information about variant codes, see the Sun Microsystems’
documentation for the java.util.Locale class.
Example: You might specify a variant code because of font differences between
platforms. If you are running on UNIX, you might set the variant
code to UNIX:
tn.locale.variant=UNIX
Performance Properties
tn.clean.routePipeline
Description: Removes some of the contents of the pipeline when a document is
routed. If set to true, this property removes all data from the pipeline
except bizdoc, rule, TN_parms, and $tnReprocess. Setting this property
to true can help prevent the pipeline from growing very large, which
could affect system performance.
Default Value: false
Example: If you want Trading Networks to remove some of the contents of the
pipeline when a document is routed, specify the following:
tn.clean.routePipeline=true
tn.db.fetchMaxRows
Description: Specifies the maximum number of result rows that Trading Networks
must retrieve from the database for each query.
If you set the value as 0 (zero), then all the rows of the query result
are retrieved from the database.
480 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
tn.db.sortDocTimestamp
Description: Specifies whether Trading Networks must sort the result rows based
on their timestamps in the descending order.
If you specify true, then Trading Networks sorts the rows based on
the timestamps.
If you set the value as false, then Trading Networks does not sort the
rows.
Default Value: true
Example: If you want to sort the rows based on the timestamps, specify the
following:
tn.db.sortDocTimestamp=true
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 481
D Trading Networks Configuration Properties
tn.doc.saveAsDone
Description: When Trading Networks originally receives a document, it saves
information about the resulting BizDocEnvelope for that document
to the database. When it saves the BizDocEnvelope to the database, it
sets the status of the BizDocEnvelope. Based on this property,
Trading Networks can set the status of the BizDocEnvelope to one of
the following:
NEW If you set this property to false, Trading Networks sets the
status of the BizDocEnvelope to NEW. This status means that
Trading Networks has received the document, but not yet
processed it.
DONE If you set this property to true, Trading Networks sets the
status of the BizDocEnvelope to DONE. Typically, the DONE
status means that Trading Networks has completed processing
the document. However, you can use this property to have
Trading Networks immediately set the status to DONE. This
saves a database update per document if Trading Networks
completes processing of the document normally with no errors.
Default Value: false (This value means that new BizDocEnvelopes are saved with the
NEW status.)
Example: If you want Trading Networks to immediately set the status of a
BizDocEnvelope to DONE, specify the following:
tn.doc.saveAsDone=true
482 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
tn.receive.clearKeys
Description: Specifies the pipeline variables that represent Trading Networks
objects that you want Trading Networks to drop from the pipeline
when the tn.receive.clearTNObjects property is set to true. Specify a
comma-separated list naming the pipeline variables that you want
Trading Networks to drop. Do not use spaces in the list. Your list can
contain the following Trading Networks objects:
node
bizdoc
sender
receiver
flags
ffdata
TN_parms
If you specify a pipeline variable other than the ones listed above,
Trading Networks ignores it, and Trading Networks will not drop the
variable.
Default Value: null (which means no variables appear in the pipeline)
Example: If you want Trading Networks to drop the pipeline variables node,
flags, and ffdata, specify the following:
tn.receive.clearKeys=node,flags,ffdata
tn.receive.clearTNObjects
Description: Specifies whether you want Trading Networks to drop pipeline
variables that represent Trading Networks objects. Trading Networks
drops the pipeline variables after it completes the execution of the
wm.tn:receive entry point service.
You specify the pipeline variables to drop using the tn.receive.clearKeys
property. Dropping these objects reduces the time it takes to process
each document and improves the overall performance of the server
because the content handler does not have to format the objects for
return to the client.
Specify true if you want Trading Networks to drop the objects;
specify false if you do not want Trading Networks to drop the
objects.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 483
D Trading Networks Configuration Properties
Example: If you do not want Trading Networks to drop the Trading Networks
objects, specify the following:
tn.receive.clearTNObjects=false
tn.store.pool.stmt
Description: Specifies whether you want Trading Networks to cache SQL
statements in memory rather than read them from
WmTN/config/dbops.sql. Specify true to have Trading Networks
cache SQL statements; specify false to have Trading Networks read
SQL statements from a file.
Default Value: true
tn.resubmit.return.bizdocs
Description: Specifies whether you want the wm.tn.doc:resubmit and
wm.tn.doc:resubmits services to return BizDocEnvelopes in the pipeline.
You use the wm.tn.doc:resubmit and wm.tn.doc:resubmits services to
resubmit documents that are in the Trading Networks database for
processing. When you resubmit a document, Trading Networks has a
BizDocEnvelope for the original document that was in the database
and forms an additional BizDocEnvelope for the new instance of the
document being resubmitted. This property controls whether the
wm.tn.doc:resubmit and wm.tn.doc:resubmits services leave these
BizDocEnvelopes in the pipeline when returning to the caller.
Performance is improved if the BizDocEnvelopes are not returned in
the pipeline. For more information about the wm.tn.doc:resubmit and
wm.tn.doc:resubmits services, see the webMethods Trading Networks Built-
In Services Reference.
Specify false if you do not want the BizDocEnvelopes returned in the
pipeline; specify true if you do want the BizDocEnvelopes returned
in the pipeline.
484 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
tn.tpa.cacheSize
Description: Specifies the maximum number of trading partner agreements
(TPAs) that Trading Networks caches in memory. Trading Networks
only caches TPAs that have an Agreed status. Caching TPAs speeds
up the run-time retrieval of TPAs; however, it also increases the
amount of memory used by the server.
Default Value: 1000
Example: If you want Trading Networks to cache 1500 TPAs, specify the
following:
tn.tpa.cacheSize=1500
tn.xml.cacheXQLQueryResults
Description: Specifies whether Trading Networks should save and reuse the
results of XQL queries executed against an XML document while
attempting to match that XML document to an TN XML document
type.
During document recognition, Trading Networks attempts to locate a
single TN document type that the inbound document matches. For an
XML document, the TN XML document types can contain XQL
queries that Trading Networks performs to determine whether the
XML document contains a specific node and optionally whether that
node contains a specific value. Several of your TN XML document
types might use the same XQL queries. Each time the XQL query is
executed, it would produce the same result for the inbound XML
document.
Specify true for this property to have Trading Networks perform
each unique XQL query only a single time and save the results for
subsequent TN XML document types that might use the same XQL
query. Specify false if you want Trading Networks to perform all
XQL queries in each TN XML document type whether they have
previously been executed for the document or not.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 485
D Trading Networks Configuration Properties
Profile Properties
tn.default.idType
Description: Specifies the external ID type (e.g., D-U-N-S® number) that Trading
Networks initially displays when creating or editing a profile in My
webMethods and the Console. For example, when you add a profile
in My webMethods and click Add ID on the External IDs tab, Trading
Networks makes the external ID type that you identify using this
property as the selected item in the ID Type list.
When creating a profile from the Console, this property also works in
conjunction with the tn.default.userCreation property, which determines
whether Trading Networks will create an Integration Server user
account for a profile created from the Console.
Default Value: DUNS
486 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
tn.default.userCreation
Description: Specifies whether you want Trading Networks to create an
Integration Server user account when you define a profile in Trading
Networks Console. When this property is true, Trading Networks
automatically creates an Integration Server user account when a new
partner profile is created from Console. The user name of the account
is set to the value of the new partner's external ID identified by the
tn.default.idType property. For example, if the tn.default.idType is set to
DUNS and the D-U-N-S number in the profile that you are adding is
987654321, Trading Networks will create an Integration Server user
account where the user name is "987654321".
tn.export.deleted.profiles
Description: Displays deleted profiles in the Export Data dialog box. Specify true
or false.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 487
D Trading Networks Configuration Properties
When the value for this property is false, Trading Networks does not
display the deleted profiles.
Example: If you want Trading Networks to display the deleted profiles in the
Export Data dialog box, specify the following:
tn.export.deleted.profiles=true
tn.profile.EnableLogProfileChanges
Description: Specifies whether you want Trading Networks to log profile auditing
information to the activity log when you manage profiles from My
webMethods. This property also controls whether you want to log
actions related to role-based access.
If profile logging is enabled, when you manage profiles using My
webMethods, Trading Networks logs changes that you make to
profile components, for example addresses, contacts, delivery
methods, etc. Trading Networks logs activity log entries when you
add, update, and/or delete profile components.
Similarly, when you use My webMethods to manage data
permissions and general functional permissions, Trading Networks
logs changes that you make.
Note: This property affects only profile actions you take from My
webMethods. It has no affect for actions taken from Trading
Networks Console.
When you specify false, Trading Networks does not log profile and
role-based access auditing information.
Example: If you want Trading Networks to log profile and role-based access
auditing information, specify the following:
tn.profile.EnableLogProfileChanges=true
488 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
Task Properties
tn.task.attempt.notPersisted
Description: For Trading Networks to use reliable service execution for a
document, the document must be saved. If a processing rule is
executed that is configured to perform reliable service execution, and
the document has not been saved, this property determines whether
to attempt a single asynchronous execution of the service.
Default Value: true
tn.task.dbupdate.enableNotifications
Description: Controls whether you want Trading Networks to publish an IS
document (i.e., raise an Integration Server event) when it attempts to
update the database for a task after a database failure condition
occurs.
You can use webMethods Developer to define a trigger that
subscribes to the IS document and takes appropriate actions. For
more information about creating triggers, see the Publish-Subscribe
Developer’s Guide.
Specify either true or false for this property. If you specify true,
Trading Networks publishes an IS document. Trading Networks
publishes an IS document each time it retries to update the database,
whether the attempt was successful or failed. The IS document that
Trading Networks publishes is in the format defined by the
wm.tn.rec:TaskDbUpdate IS document type. For more information about
the wm.tn.rec:TaskDbUpdate IS document type, see the webMethods
Trading Networks Built-In Services Reference.
Default Value: false
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 489
D Trading Networks Configuration Properties
tn.task.dbupdate.retryEnabled
Description: Controls whether Trading Networks tries to update the database
again after it encounters a database failure when trying to update the
information for a task.
If Trading Networks encounters an error when attempting to update
the information for a task, for example because it lost connectivity to
the database, the information that Trading Networks is maintaining
in memory for the task will not match the information stored in the
database. If the server is shut down, the task information will be
incorrect upon server restart.
If you want Trading Networks to continuously attempt to retry
updating the database until the update is successful or until the
server shuts down, specify true; otherwise specify false.
Default Value: true
tn.task.dbupdate.retrySweepTime
Description: Specifies the number of seconds between attempts to retry updating
the database information for a task.
Trading Networks only uses this property when the
tn.task.dbupdate.retryEnabled property is true.
Default Value: 300
Example: If you want Trading Networks to retry updating the database every
600 seconds (10 minutes), specify the following:
tn.task.dbupdate.retrySweepTime=600
490 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
tn.task.init.groupSize
Description: Specifies the number of tasks that Trading Networks processes at one
time during server startup. Trading Networks uses a background
thread during startup to read the task data from the database and
create the tasks in groups. The number of tasks in a group is the value
you specify for this property. After creating a group of tasks, Trading
Networks pauses for the amount of time specified by the
tn.task.init.pauseLength property. By pausing between groups, this makes
CPU cycles available to other Integration Server functions that are
initializing during startup. This improves performance when starting
Trading Networks when there are many pending tasks.
Default Value: 100
tn.task.init.pauseLength
Description: Specifies the number of seconds that Trading Networks pauses
between processing groups of tasks during server startup. Trading
Networks uses a background thread during startup to read the task
data from the database and create the tasks in groups. The number of
tasks in a group is the value you specify for the tn.task.init.groupSize
property. After creating a group of tasks, Trading Networks pauses
for the amount of time specified by this property. By pausing
between groups, this makes CPU cycles available to other Integration
Server functions that are initializing during startup. This improves
startup performance when starting Trading Networks when there are
many pending tasks.
Default Value: 10 (seconds)
Example: To have Trading Networks pause for 15 seconds between the groups
of tasks that it processes during startup, specify the following:
tn.task.init.pauseLength=15
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 491
D Trading Networks Configuration Properties
tn.task.maxRetries
Description: Specifies the number of times you want Trading Networks to attempt
to re-execute a service when it is executing the service using reliable
execution and the service fails. Specify a whole number.
Default Value: 5
tn.task.notifyFailure
Description: Controls whether you want Trading Networks to publish an IS
document (i.e., raise an Integration Server event) when a task fails.
You can use the webMethods Developer to define a trigger that
subscribes to the IS document and takes appropriate actions. For
more information about creating triggers, see the Publish-Subscribe
Developer’s Guide.
The IS document that Trading Networks publishes is in the format
defined by the wm.tn.rec:TaskFailure IS document type. For more
information about the wm.tn.rec:TaskFailure IS document type, see the
webMethods Trading Networks Built-In Services Reference.
To have Trading Networks publish an IS document when a task fails,
specify true; otherwise, specify false.
Default Value: false
492 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
tn.task.pauseOnMaxThreads
Description: Specifies the number of milliseconds that Trading Networks pauses
when the task manager runs out of threads. You control the number
of threads that the task manager is allocated using the
tn.task.threadpool.pct property. If the number of threads specified by the
tn.task.threadpool.pct property are in use and Trading Networks has
more tasks to process, Trading Networks pauses the number of
milliseconds specified by this property to allow some of the working
threads to complete and become available.
Default Value: 500 (milliseconds)
Example: If you want Trading Networks to pause for 750 milliseconds when the
task manager runs out of threads, specify the following:
tn.task.pauseOnMaxThreads=750
tn.task.retryFactor
Description: The factor you want Trading Networks to use when determining how
long to wait before making the second and subsequent attempts to re-
execute a service that Trading Networks is executing using reliable
execution.
Trading Networks calculates the time to wait by multiplying the last
wait time by tn.task.retryFactor. Specify a whole number greater than
zero for tn.task.retryFactor.
Example: The following shows sample values for the reliable execution
properties and how they affect the wait times between attempts to re-
execute a failed service.
tn.task.maxRetries=3
tn.task.ttw=10000
tn.task.tn.task.retryFactor=2
Retry 1 Retry 2 Retry 3
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 493
D Trading Networks Configuration Properties
tn.task.sweepTime
Description: Specifies the number of seconds the reliable task manager thread
remains idle before checking for tasks it needs to perform (for
example, a task to deliver a document or execute a service).
The task manager thread becomes idle when all tasks are completed,
failed, or in the wait period between attempts. The task manager
thread waits the number of seconds you specify with this property
before waking up to check for tasks it needs to process. The tasks that
the task manager attempts to process when it wakes up are those
tasks that failed on their last attempt and have not yet reached their
retry limit.
The minimum allowable value for this property is 1 second. If you
attempt to set this property to a value less than 1 second, the new
value will be ignored. In other words, if you set tn.task.sweepTime to
any value below 1 second, the task manager remains idle for 1 second
before checking for tasks it needs to perform.
Example: To set the sweep time to 500 seconds, specify the following:
tn.task.sweepTime=500
494 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
tn.task.threadpool.pct
Description: Controls the percentage of the Integration Server’s pool of threads
that the task manager can use to process tasks simultaneously. This is
to prevent the task manager from consuming all Integration Serverr
threads when the task manager has a large number of tasks to
process.
Possible property values can range from .2 to .8. If you set the
property value less than the range, the task manager ignores the
value and takes the lowest value of the range, or .2. If you set the
property value greater than the range, the task manager ignores the
value and takes the greatest value of the range, or .8. No matter how
small you set the property value, the task manager is guaranteed to
always have at least one thread with which to execute tasks.
Default Value: .5
tn.task.ttw
Description: Specifies the number of milliseconds you want Trading Networks to
wait before making its first attempt to re-execute a failed service
when Trading Networks is executing the service using reliable
execution. (Trading Networks uses this setting along with
tn.task.retryFactor to calculate how long to wait for subsequent retry
attempts.)
Default Value: 300
Example: If you want Trading Networks to wait 500 milliseconds after a service
fails before making the first attempt to re-execute the service, specify
the following:
tn.task.ttw=500
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 495
D Trading Networks Configuration Properties
tn.transport.user
Description: Specifies the user account to use to invoke a service that Trading
Networks is executing reliably due to a processing action in a
processing rule. This affects the user account used to invoke the built-
in delivery services (which are in the wm.tn.transport folder), custom
delivery services that you create, and services invoked by service
execution tasks.
To have Trading Networks use the currently connected user to invoke
services, do not supply a value for the tn.transport.user property. By
default, Trading Networks will use the currently connected user to
invoke services. This is the user that submitted the document to
Trading Networks, unless you are resubmitting or reprocessing a
document. When you resubmit or reprocess a document, the current
user is the user issuing the resubmit or reprocess.
If you want Trading Networks to use a user account other than the
currently connected user's account, use this property to specify the
user name. If you want an Administrator account to execute services
from processing rules, specify Administrator. Some Integration
Server administrators might delete the built-in Administrator
account and create a new one with a different name. If
tn.transport.user is Administrator, Trading Networks will use an
account from the Administrators group, though it might not be the
built-in Administrator account.
Important! Ensure that the ACL you use to protect the service grants
Execute access to the user you specify.
Default Value: No default. Trading Networks will use the currently-connected user
to invoke services fro processing rules.
496 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
Miscellaneous Properties
tn.check.ambiguous.docs
Description: Determines whether Trading Networks searches through all TN
document types to find a matching TN document type or uses the
first match.
By default, Trading Networks searches through all TN document
types to find a single TN document type to use for the incoming
document. If it finds multiple TN document types that match it
considers the document to be an unknown document because it does
not know which TN document type to use.
However, you can use this property to configure Trading Networks
to stop looking for TN document types after it finds the first match
and uses the first matching TN document type for the incoming
document.
Default Value: true
Example: If you want Trading Networks to use the first TN document type it
finds that matches an incoming document and not check through all
TN document types, specify the following:
tn.check.ambiguous.docs=false
tn.doctype.includeHidden
Description: Determines whether the wm.tn.doctype:list service returns the built-in
TN document types. You can override this property when you invoke
the wm.tn.doctype:list service by using the includeHidden input variable.
Because the Trading Networks Console uses the wm.tn.doctype:list to
retrieve the list of TN document types, this property also controls
whether to show or hide the built-in TN document types in the
Trading Networks Console.
Specify true if you want the wm.tn.doctype:list service to return the
built-in TN document types and therefore also show them in the
Trading Networks Console. Specify false if you do not want the
wm.tn.doctype:list service to return the built-in TN document types and
therefore hide them in the Trading Networks Console.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 497
D Trading Networks Configuration Properties
Example: If you do not want the wm.tn.doctype:list service to return the built-
in TN document types and want to hide the built-in TN document
types in the Trading Networks Console, specify the following:
tn.doctype.includeHidden=false
tn.ism.stats.saveFrequency
Description: Specifies how frequently (in seconds) you want Trading Networks to
save document processing statistics to the database. You can view
these statistics using My webMethods.
Default Value: 30 (seconds)
Example: If you want Trading Networks to save document processing statistics
to the database every 45 seconds, specify the following:
tn.ism.stats.saveFrequency=45
tn.mail.onuserfail
Description: Specifies whether you want Trading Networks to send an e-mail
message to the Integration Server Administrator to alert the
administrator of the following errors:
Sender of the document is not the same as the current user
Trading Networks has no profile for current user
Trading Networks was unable to retrieve the profile summary for
the sender
Sender's profile is Inactive, which does not allow for sending
documents
Sender's profile has been deleted
Internal exception prevented processing from completing
Specify true if you want Trading Networks to send the alert e-mail
messages. Otherwise, specify false.
Default Value: false
Example: If you want Trading Networks to send alert e-mail messages for the
above error conditions, specify the following:
tn.mail.onuserfail=true
498 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
D Trading Networks Configuration Properties
tn.recursion.max
Description: Specifies the maximum number of successive times that Trading
Networks can use a processing rule for a specific document. If
Trading Networks attempts to recursively use a processing rule more
times than the number you specify for this property, Trading
Networks aborts processing of the document.
Trading Networks recursively uses a processing rule if the processing
rule uses the Execute a Service processing action to synchronously
invoke a service that calls the wm.tn:submit service to submit the same
BizDocEnvelope to Trading Networks, and Trading Networks selects
the same processing rule again.
Default Value: 0
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 499
D Trading Networks Configuration Properties
tn.server.seq
Description: Trading Networks uses this property when generating internal IDs.
To guarantee that Trading Networks internal IDs are unique across
all servers, they consist of:
hash code of the hostname
server sequence number
timestamp -AND-
counter
The second element, “server sequence number”, is the value of the
tn.server.seq property. Use this property only if you are running more
than one instance of Trading Networks on the same machine. In this
situation, each instance of Trading Networks should be given a
unique value for tn.server.seq.
If you run multiple instances of Trading Networks on one machine
and do not supply a value for this property, you run the risk of
Trading Networks generating duplicate internal IDs. If you supply an
invalid value (less than 0 or greater than 31), Trading Networks
ignores the setting and uses 0 for the server sequence number portion
of generated internal IDs, which again runs the risk of generating
duplicate internal IDs.
Default Value: Specify a value from 0 to 31, inclusive.
Example: If you have two instances of Trading Networks running on the same
machine, you should specify the tn.server.seq property for each
instance of Trading Networks. For example, for the first instance,
specify the following:
tn.server.seq=1
500 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
E XQL Reference
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 501
E XQL Reference
502 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
E XQL Reference
<emph>I</emph> have.</p>
<definition-list>
<term>Trenton</term>
<definition>misery</definition>
</definition-list>
</excerpt>
</book>
<my:book style='leather' price='29.50' xmlns:my='http://www.placeholder-name-
here.com/schema/'>
<my:title>Who's Who in Trenton</my:title>
<my:author>Robert Bob</my:author>
</my:book>
</bookstore>
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 503
E XQL Reference
504 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
E XQL Reference
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 505
E XQL Reference
506 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
E XQL Reference
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 507
E XQL Reference
508 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
F Large Document Handling
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 509
F Large Document Handling
510 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
F Large Document Handling
Increase the largest size of a document that Trading Networks can save to the
database. You only need to do this if you are using DB2 for the database and if you
need to save documents that are greater than 2M. For more information, see
“Increasing the Size of the Largest Document that Can Be Saved When Using DB2” on
page 50.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 511
F Large Document Handling
failed identifying query causes Trading Networks not to select the TN document type for
the document. A failed attribute query causes Trading Networks to be unable to extract
the attribute information from the document.
For more information about specifying identifying queries and queries for extracting
document attributes in TN XML document types, see Chapter 13, “Defining and
Managing TN XML Document Types”.
Important! Large XML files that are sent to Trading Networks for processing must
contain the XML declaration (e.g., <?xml...) as the first line. If a large XML document
contains any blank space before the XML declaration, Trading Networks throws an
exception when attempting to process the document.
512 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
F Large Document Handling
Use the following fields in bizdoc to determine whether the document is stored in
memory or on the hard disk drive space:
LargePart?–This field that is within the ContentParts field, indicates whether the
content part is considered large. Its value is true if Trading Networks considers the
content part large; otherwise it is false.
LargeDocument?–This field indicates whether any of the content parts of the
document are large. If at least one of the content parts is considered large, its value is
true. If all content parts are not considered large, its value is false.
If a content part is considered large, Trading Networks sets StorageType to tspace and
leaves the Content variable null. If the document is not considered large, Trading
Networks stores the document content in the Content variable and leaves StorageType null.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 513
F Large Document Handling
byteCount If you specified bytes for getAs, specify the number of bytes of
content that you want Trading Networks to retrieve.
514 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
F Large Document Handling
You can invoke this service for all documents. The service determines whether the
document is considered large or not. If the document is not considered large, the service
returns a byte array that contains the retrieved delivery content. If the document is
considered large, the service retrieves the delivery content using a Java InputStream
object.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 515
F Large Document Handling
Click to display the next 1,000 bytes. Click to display the previous 1,000 bytes.
516 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
G Enabling a Document Delivery Using a Web Service
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Enabling the Delivery of Documents Using a Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 517
G Enabling a Document Delivery Using a Web Service
Overview
This appendix discusses the step by step procedure required to enable a document
delivery using a web service.
For information about the working of a web service delivery method, see Understanding
webMethods B2B: webMethods Trading Networks Concepts Guide.
518 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0
G Enabling a Document Delivery Using a Web Service
1 Using Developer, create a Java service or a flow service. The output of the service
must have the same document structure as that of the Web service connector’s input
document structure. For information about the procedure for creating a Java service
or a flow service, see Developing Integration Solutions: webMethods Developer User’s
Guide.
2 Map the pipeline variables with the required input values of the Web service
connector.
In most cases, you might want to map the bizdoc attributes with the relevant input
parameters of the Web service connector. In such cases, the input for the mapping
service is the bizdoc.
Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0 519
G Enabling a Document Delivery Using a Web Service
To perform additional steps when the web service response must be in a new document
1 Define a document type for the inventory status document so that Trading Networks
recognizes the document.
2 Define a processing rule for that document type to specify how you want Trading
Networks to process the inventory status document.
You can now send the inventory status request to company ABC using a web service. The
Web service connector invokes the web service available at company ABC’s end. The web
service sends the status back to your Trading Networks. Based on the response handling
mechanism you chose, the status document is either added to the bizdoc or sent as a new
document to your Trading Networks. When the status document is sent as a new
document, Trading Networks recognizes the document and processes the document
based on the processing rule you defined for the inventory status document.
520 Building B2B Integrations: webMethods Trading Networks Administrator’s Guide Version 8.0