How to manage WebMethods Broker

1. Title Page
Administering webMethods Broker
Version 8.2
April 2011

2. Copyright
& Docu-
ment ID
This document applies to webMethods Broker Version 8.2 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 © 2001-2011 Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, United States of America, and/or
their licensors.
Detailed information on trademarks and patents owned by Software AG and/or its subsidiaries is located at
http://documentation.softwareag.com/legal/.
Use of this software is subject to adherence to Software AG's licensing conditions and terms. These terms are part of the product
documentation, located at http://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).
This software may include portions of third-party products. For third-party copyright notices and license terms, please refer to “License
Texts, Copyright Notices and Disclaimers of Third-Party Products”. This document is part of the product documentation, located at
http://documentation.softwareag.com/legal/and/or in the root installation directory of the licensed product(s).
Document ID: BR-AG-82SP1-20110401A

3. Table of Contents
About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Documentation Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Online Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1. webMethods Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Publish-and-Subscribe Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Producers and Consumers Are De-coupled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Interaction Is Asynchronous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Delivery Quality of Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Broker's Relationship with Other webMethods Components . . . . . . . . . . . . . . . . . . . . . . . . 27
Broker Client APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
webMethods Broker Architecture and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Broker Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Broker User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Client Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Clients (Client State Objects) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Storage Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Queue Storage (QS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Territories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Territory Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Cluster Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Broker Security Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
2. Using My webMethods to Administer webMethods Broker . . . . . . . . . . . . . . . . . . . . . . 41
Managing Broker Using My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Selecting a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Using My webMethods with Earlier Versions of Broker . . . . . . . . . . . . . . . . . . . . . . . . 42
Who Can Use the Broker User Interface? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Extending Access to Other Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Accessing the Broker User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
How My webMethods Interacts with Broker Servers . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Logging Out of My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Adding Broker Servers to My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Administering webMethods Broker Version 8.2 3

4. Adding an Individual Broker Server to My webMethods . . . . . . . . . . . . . . . . . . . . . . . . 45
Discovering Broker Servers on a Specified Broker Monitor Host Machine . . . . . . . . . . 46
Uploading a List of Broker Servers into My webMethods . . . . . . . . . . . . . . . . . . . . . . . 47
Creating the Definitions File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Uploading the Definitions File to My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . 47
Removing Broker Servers from My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Configuring the Connection Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Viewing and Editing the Connection Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Using My webMethods with ACL-Protected Broker Servers . . . . . . . . . . . . . . . . . . . . . . . . 51
3. Broker Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
The Role of Broker Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
How Broker Monitor Starts Broker Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
How Broker Monitor Monitors the State of Broker Servers . . . . . . . . . . . . . . . . . . . . . . 55
Status Messages Logged by Broker Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Starting Broker Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Starting Broker Monitor Automatically on Windows Systems . . . . . . . . . . . . . . . . . . . . 56
Starting Broker Monitor Manually on Windows Systems . . . . . . . . . . . . . . . . . . . . . . . 56
Starting Broker Monitor Automatically on UNIX Systems . . . . . . . . . . . . . . . . . . . . . . . 57
Starting Broker Monitor Manually on UNIX Systems . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Stopping Broker Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Stopping Broker Monitor on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Stopping Broker Monitor on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
How to Determine Whether Broker Monitor Is Running . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Checking on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Checking on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Ports and Running Multiple Instances of Broker Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Viewing the Port Setting for Broker Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Changing the Port Setting for Broker Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Configuring Broker Monitors to Start Automatically on UNIX Systems . . . . . . . . . . . . . . . . 63
4. Managing Broker Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Broker Data Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Broker Server Configuration File (awbroker.cfg) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Starting Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Starting Broker Server from My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Starting Broker Server Using the broker_start Command . . . . . . . . . . . . . . . . . . . . . . 68
Starting Broker Server from Windows Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Stopping Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Stopping Broker Server from My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Stopping Broker Server Using the broker_stop Command . . . . . . . . . . . . . . . . . . . . . . 70
Stopping Broker Server from Windows Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . 71
Broker Server Communication Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Ports Used by Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
4 Administering webMethods Broker Version 8.2

5. Ports and Multiple Broker Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Viewing the Base Port Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Changing the Base Port Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Broker Server Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Controlling Queue Size for Volatile Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Limiting Memory Usage by Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Maximum Limit Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Values for the max-memory-size Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
The preallocate-memory Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Selecting the Maximum Memory Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Limitations of the Maximum Memory Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Configuring the max-memory-size Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Configuring Queue Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
The Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
The Storage Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Combined and Separate Storage Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Default Queue Storage Files Created by the Installer . . . . . . . . . . . . . . . . . . . . . . . . . 82
Default File Names and Sizes Created by server_config . . . . . . . . . . . . . . . . . . . . . . . 83
Modifying the Size of the Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Modifying the Size of a Storage File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Adding a Storage File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Viewing Queue Storage Utilization and Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Configuring the Cache Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Default Cache Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Selecting a Cache Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Modifying the Cache Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Viewing the Cache Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Configuring Broker Server to Use Asynchronous Write Mode . . . . . . . . . . . . . . . . . . . . . . . 93
Viewing the Write-Mode Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Running Multiple Broker Servers on the Same Host Machine . . . . . . . . . . . . . . . . . . . . . . . 95
Running Multiple Broker Servers in a Single webMethods Broker Environment . . . . . 95
Running Multiple Instances of webMethods Broker on the Same Host . . . . . . . . . . . . 96
Creating a Broker Server with the Default Log and Storage Files . . . . . . . . . . . . . . . . . . . . 97
Creating a Broker Server that Specifies Size and Location of Files . . . . . . . . . . . . . . . . . . 99
Deleting a Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Viewing Status Information for a Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Broker Server License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Contents of License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Viewing and Changing the License Using My webMethods . . . . . . . . . . . . . . . . . . . . . 105
Viewing and Changing the License Using server_config . . . . . . . . . . . . . . . . . . . . . . . 106
Monitoring Resource Utilization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
The Broker Server Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Log File Names and Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Message Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Administering webMethods Broker Version 8.2 5

6. Including Log Messages in Other Logging Systems . . . . . . . . . . . . . . . . . . . . . . . 109
Configuring the Logging Behavior of Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Configuring the Logging Behavior of Broker Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Viewing the Broker Server Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Purging the Broker Server Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
The Messaging Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Message Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Log File Names and Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Continuous versus Daily Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Viewing the Messaging Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Configuring the Messaging Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Purging the Messaging Log that Uses Daily Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Purging the Messaging Log that Uses Continuous Files . . . . . . . . . . . . . . . . . . . . . . . 116
Backing Up and Restoring a Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Metadata that Is Backed Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
When to Perform a Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Other Files That You Should Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Backing Up Territories and Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Choosing the Correct Backup Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Backing Up a Separate Storage Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Files that Are Backed Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Backing Up an ACL-Protected Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Restoring a Separate Storage Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Resynchronizing a Restored Broker with its Territory . . . . . . . . . . . . . . . . . . . . . . 123
Backing Up a Combined Storage Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Preparing for the Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Precautions and Alternatives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Restoring a Combined Storage Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Pausing Document Publishing on the Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Configuring Streaming in Broker Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Configuration Parameters For Streaming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Setting Locale on UNIX Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
5. Managing Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Role of Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Creating a Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Deleting a Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Configuring a Default Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Determining Which Broker Is the Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Designating a Default Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Using Document Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Determining Whether Document Logging Is Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Checking the Length of the Document Logging Queue . . . . . . . . . . . . . . . . . . . . . . . . 137
Routing Documents to the Dead Letter Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
The Dead Letter Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
6 Administering webMethods Broker Version 8.2

7. Relationship to Dead Letter Queues Created by Client Applications . . . . . . . . . . 138
Activating the Dead Letter Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Viewing and Purging the Dead Letter Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Disabling the Dead Letter Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Viewing Status Information for a Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Viewing Basic Operating Statistics for the Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Managing Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Viewing Running Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
About Configuring the Transaction Timeout Options . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Configuring the Transaction Timeout Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Setting the Recover Mode for XA Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Manually Performing a Commit or Roll Back . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Viewing and Purging Lost Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
6. Managing Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
What Are Documents and Document Types? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Creating Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
About Document Type Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Document Type Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Time to Live . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Document Type Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Document Type Storage Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Client Group Storage Types and Document Type Storage Types . . . . . . . . . . . . 153
Document Field Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Infosets Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Viewing Document Types on a Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Viewing Document Type Configuration Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Viewing Document Type Fields and Infosets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Modifying Document Type Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Copying Document Types Between Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Copying and Pasting Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Deleting Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
7. Managing Client Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Defining a Client Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Client Groups and Broker Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Client Group Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Client Queue Storage Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Queue Storage Type and Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Queue Storage Type and Document Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Client Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Client Group Access Control Lists (ACLs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
System-Defined Client Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Administering webMethods Broker Version 8.2 7

8. admin Client Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
accessLabelAdapter Client Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
adapters Client Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
eventLog Client Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Working with Client Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Searching for Client Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Creating a Client Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Viewing and Editing Client Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Adding Document Type Permissions for Client Groups . . . . . . . . . . . . . . . . . . . . . . . . 176
Removing Document Type Permissions for Client Groups . . . . . . . . . . . . . . . . . . . . . . 176
Copying Client Groups between Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Using Copy and Paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Deleting a Client Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
8. Managing Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
What Is a Client? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Client State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Shared State Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Shared State Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Storage Type and Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Viewing Clients on a Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Viewing Client Configuration Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Viewing Client Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Managing Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Viewing Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Deleting Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Managing Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Viewing Session Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Viewing Detailed Session Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
About Disconnecting Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Before Disconnecting a Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Disconnecting a Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Copying Clients between Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Copying and Pasting Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Deleting Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
9. Working with Test Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
What Is a Test Client? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Viewing Test Clients on a Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Creating Test Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Creating a Test Client that Uses Basic Authentication . . . . . . . . . . . . . . . . . . . . . . . . . 200
Creating a Test Client that Uses SSL Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Working in Test Client View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
8 Administering webMethods Broker Version 8.2

9. Managing Document Subscriptions for a Test Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Creating Subscriptions for a Test Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Creating or Editing a Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Deleting Subscriptions for a Test Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Publishing Documents with a Test Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Building an Outgoing Documents List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Adding Blank Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Loading Documents from a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Copying and Pasting Documents in the Outgoing Documents List . . . . . . . . . . . . 207
Adding Comments to Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Publishing Documents with a Test Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Before Publishing Documents with a Test Client . . . . . . . . . . . . . . . . . . . . . . . . . 209
Publishing or Delivering Documents with a Test Client . . . . . . . . . . . . . . . . . . . . . 209
Stopping Publishing by a Test Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Retrieving Documents for a Test Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Clearing the Incoming Documents List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Clearing the Test Client Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Saving Outgoing or Incoming Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Disconnecting a Test Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Reconnecting Test Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Reconnecting a Test Client that Uses Basic Authentication . . . . . . . . . . . . . . . . . . . . . 215
Reconnecting a Test Client that Uses SSL Authentication . . . . . . . . . . . . . . . . . . . . . . 215
Deleting a Test Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
10. Managing Client Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
What Is a Client Queue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Client Queue Ownership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Viewing Client Queue Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Locking a Client Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Unlocking a Client Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Viewing Lock Information for a Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Browsing a Client Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Filtering Queue Contents while Browsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Saving Client Queue Documents to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Inserting Documents into a Client Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Loading Documents from a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Copying and Pasting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Inserting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Deleting Documents from a Client Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Clearing Client Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Before Clearing a Client Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Clearing a Client Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Proactively Deleting Documents from a Client Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Administering webMethods Broker Version 8.2 9

10. 11. Managing Forwarding Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
What Is a Forwarding Queue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Navigating to the Forwarding Queue Browser Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Navigating to the Forwarding Queue for a Remote Broker in Your Territory . . . . . . . . 232
Navigating to the Forwarding Queue for a Remote Broker in Your Cluster . . . . . . . . . 232
Navigating to the Forwarding Queue for a Remote Broker in a Remote Territory . . . . 233
Navigating to the Forwarding Queue for a Remote Broker in a Remote Cluster . . . . . 233
Locking and Unlocking the Forwarding Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Browsing a Forwarding Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Filtering Forwarding Queue Contents while Browsing . . . . . . . . . . . . . . . . . . . . . . . . . 237
Filtering Contents for a Remote Broker in Your Territory or Cluster . . . . . . . . . . . 237
Filtering Contents for a Remote Broker in a Remote Territory or Cluster . . . . . . . 238
Saving the Forwarding Queue Documents to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Inserting Documents into a Forwarding Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Loading Documents from a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Copying and Pasting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Inserting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Deleting Documents from a Forwarding Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Proactively Deleting Documents from a Forwarding Queue . . . . . . . . . . . . . . . . . . . . . . . . 242
12. Using Topology View and Document Trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Topology View of Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Data Displayed in the Broker Topology View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Displaying the Broker Topology View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
About Tracing Documents in Broker Topology View . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Tracing Documents in the Topology View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Setting Your User Preferences for the Display Settings . . . . . . . . . . . . . . . . . . . . . . . . 248
Defining How to Display Data in the Broker Topology View . . . . . . . . . . . . . . . . . 249
Defining the Brokers and Clients to Display in the Topology View . . . . . . . . . . . . 251
Editing Existing Node Groupings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Deleting Node Groupings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
About Ordering the Node Groupings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Ordering Node Groupings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Defining the Documents to Include in Traces . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Table View of Trace Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Data Displayed in Trace View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Setting Your User Preferences for the Trace View . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Running Document Traces in Trace View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Refreshing the Data in the Trace View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Stopping the Trace in the Trace View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Exporting the Data in the Trace View to a .csv File . . . . . . . . . . . . . . . . . . . . . . . . 258
Clearing the Trace Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Topology View of Territories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Data Displayed in the Territory Topology View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
10 Administering webMethods Broker Version 8.2

11. Displaying the Territory Topology View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
About Tracing a Document in the Territory Topology View . . . . . . . . . . . . . . . . . . . . . 262
Tracing a Document in the Territory Topology View . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Setting Your User Preferences for the Territory Topology View . . . . . . . . . . . . . . . . . . 263
Defining How to Display Data in the Territory Topology View . . . . . . . . . . . . . . . . 264
Identifying the Territories to Show in the Topology View . . . . . . . . . . . . . . . . . . . 265
Editing Existing Node Groupings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Deleting Node Groupings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
About Ordering the Node Groupings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Ordering Node Groupings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Viewing Documents that Are Included in Territory Topology Document Traces . 269
13. Managing Broker Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Broker Security Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Authentication Identities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Access Control Lists (ACLs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Securing Broker System Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Securing the Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Securing the Broker User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Securing Broker Command-Line Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Securing Client Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Securing Territories and Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Securing Clusters and Cluster Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Securing Broker Server Using Basic Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Using the Basic Authentication Security Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Enabling Basic Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Basic Authentication Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Basic Authentication Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Default Values for Active Directory Parameters . . . . . . . . . . . . . . . . . . . . . . . 288
Default Values for SunOne Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Default Values for OpenLdap Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Basic Authentication Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Configuring Basic Authentication Identity for a Broker Server . . . . . . . . . . . . . . . . . . . 289
Disabling the Basic Authentication Identity of a Broker Server . . . . . . . . . . . . . . . . . . 290
Securing Broker Server Using SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Broker Security Model and OpenSSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Assigning SSL Identities for a Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
One-Way and Two-Way SSL Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
SSL Authentication and Broker Port Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Broker Server Identity and SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Certificate Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Keystore File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Keystore File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Certificate Chains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Administering webMethods Broker Version 8.2 11

12. Installing a Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Truststore File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Truststore File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
How Broker Uses a Keystore and Truststore . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Protecting Keystore and Truststore Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Using SSL Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
OpenSSL Cryptography . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Configuring SSL for Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Creating Keystores and Truststores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Loading Keystores and Truststores into My webMethods . . . . . . . . . . . . . . . . . . . 299
Loading Keystores from the Machine on Which Broker is Administered . . . . 299
Loading Keystores on the Machine Hosting My webMethods Server . . . . . . 299
Loading Truststores from the Machine on Which Broker is Administered . . . 300
Loading Truststores on the Machine Hosting My webMethods Server . . . . . 300
Modifying Keystores and Truststores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Configuring an SSL Identity for a Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Disabling the SSL Identity for a Broker Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Configuring SSL for Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Securing Broker Server Using CRL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Configuring Certificate Revocation Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Configuring CRL Checking For the Entire Certificate Chain . . . . . . . . . . . . . . . . . 305
Securing Broker Server Using Basic Authentication Over SSL . . . . . . . . . . . . . . . . . . . . . . 305
Securing Broker Server Using FIPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Starting Broker Server in FIPS mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Access Control Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Authenticator vs. User ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
How User Rights Are Granted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Client Group ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
admin Client Group ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Broker Server ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Territory ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Cluster ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Territory Gateway ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Cluster Gateway ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Configuring Access Control Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
About Configuring Broker Server ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Adding Authenticator Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Adding User Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Disabling Broker Server ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Deleting Authenticator Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Granting Access Permissions to a New Client . . . . . . . . . . . . . . . . . . . . . . . . 317
About Configuring Client Group ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Registering User Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Registering Authenticator Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
About Controlling Which Brokers Can Join a Territory . . . . . . . . . . . . . . . . . . . . . 320
12 Administering webMethods Broker Version 8.2

13. Specifying Brokers Using User Name DNs . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Specifying Brokers Using Authenticator Names . . . . . . . . . . . . . . . . . . . . . . . 321
Deleting Brokers From a Territory ACL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
About Controlling Which Brokers Can Join a Cluster . . . . . . . . . . . . . . . . . . . . . . 322
Specifying Brokers Using User Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Specifying Brokers Using Authenticator Names . . . . . . . . . . . . . . . . . . . . . . . 323
Deleting Brokers From a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Setting Permissions to Connect to Remote Brokers across a Territory Gateway . 325
Configuring Broker Gateway ACLs Using User Names . . . . . . . . . . . . . . . . . 325
Configuring Broker Gateway ACLs Using Authenticator Names . . . . . . . . . . 325
About Setting Permissions to Connect to Remote Brokers across a
Cluster Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Configuring Cluster Gateway ACLs Using Broker User Names . . . . . . . . . . . 326
Configuring Cluster Gateway ACLs Using Broker Authenticator Names . . . . 326
ACLs and Migration Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Broker Security and My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Configuring a Basic Authentication Identity for the Broker User Interface Component 328
Configuring an SSL Identity for the Broker User Interface Component . . . . . . . . . . . . 329
About Restoring the Identity of the Broker User Interface Component's Identity . . . . . 330
Restoring the Identity of the Broker User Interface Component's SSL Identity . . . 330
Restoring the Identity of the Broker User Interface Component's
Basic Authentication Identity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Disabling the Identity of the Broker User Interface Component . . . . . . . . . . . . . . . . . . 331
Converting Certificate Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Broker Certificate Conversion Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Single Certificate Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Trusted Roots and Truststore Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Downloading the Broker Certificate Conversion Utility . . . . . . . . . . . . . . . . . . . . . 333
Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Remarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
14. Managing Territories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Introduction to Territories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Why Implement a Territory? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
How Brokers in a Territory Communicate with Each Other . . . . . . . . . . . . . . . . . . . . . 337
Subscriptions Maintained by a Remote Broker Object . . . . . . . . . . . . . . . . . . . . . 338
How Subscription Filters Are Handled in a Territory . . . . . . . . . . . . . . . . . . . 338
The Queue Maintained by a Remote Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
How Delivered Documents Are Handled in a Territory . . . . . . . . . . . . . . . . . . 339
How Brokers Synchronize Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Exporting and Importing Territory Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Securing a Territory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Leaving a Territory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Creating a Territory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Requirements Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Administering webMethods Broker Version 8.2 13

14. Creating Territories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Adding Brokers to a Territory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Removing a Broker from a Territory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Deleting a Territory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Viewing a List of Known Territories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Viewing Information about a Remote Broker Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Deleting a Remote Broker Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
15. Managing Territory Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Territory Gateway Connections, Territory Gateways, and Territory Gateway Pairs . . . 350
Territory Gateway Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
Connecting Multiple Territories with Territory Gateway Connections . . . . . . . . . . . . . . 351
Creating a Territory Gateway Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
Creating a "One-Way" Territory Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Configuring and Controlling Territory Gateway Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Creating a Territory Gateway Pair if You Control Both Brokers . . . . . . . . . . . . . . . . . . . . . . 355
Defining the Territory Gateway Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Specifying which Documents Types Territories Can Exchange . . . . . . . . . . . . . . . . . . 356
Specifying Permissions for Receiving Individual Document Types . . . . . . . . . . . . . . . 356
Specifying Permissions for Forwarding Individual Document Types . . . . . . . . . . . . . . 357
Using Client Groups to Specify Permissions on Document Types . . . . . . . . . . . . . . . . 358
Creating a Territory Gateway Pair if You Control Only One Broker . . . . . . . . . . . . . . . . . . . 359
Defining One Side of a Territory Gateway Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Specifying which Documents the Territory Gateway Can Forward and Receive . . . . . 360
Using Territory Gateway Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Filtering Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Filter Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Filter Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Viewing Information about a Territory Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Viewing Information about Documents Flowing between the Gateways . . . . . . . . . . . . . . . 367
Deleting a Territory Gateway Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Removing an Allowed Document Type from a Territory Gateway . . . . . . . . . . . . . . . . . . . . 369
Pausing and Resuming a Territory Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Pausing a Territory Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Resume a Territory Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Preventing Connection Timeouts between Territories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Viewing and Modifying the Keep-Alive Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Configuring the Forwarding Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Refusing Document-Type Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
Viewing or Configuring the Global Refuse Update Option . . . . . . . . . . . . . . . . . . . . . . 373
Viewing or Configuring the Refuse Update Option for an Individual Document Type . 374
Using Broker Remote Publish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Broker in the Same Territory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
Broker Peer of Local Territory Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
14 Administering webMethods Broker Version 8.2

15. Broker in a Different Territory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
Same as Delivering Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
16. Managing Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
Introduction to Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Why Implement a Cluster? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
How Brokers in a Cluster Communicate with Each Other . . . . . . . . . . . . . . . . . . . . . . 379
How Delivered Documents Are Handled in a Cluster . . . . . . . . . . . . . . . . . . . . . . 379
How Brokers Synchronize Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
Exporting and Importing Cluster Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
Securing a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Leaving a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Creating Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Requirements Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Creating a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Adding Brokers to a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Removing a Broker from a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Deleting a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Viewing a List of Known Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
17. Managing Cluster Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Cluster Gateway Connections, Cluster Gateways, Cluster Gateway Pairs, and
Cluster Gateway Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Cluster Gateway Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Connecting Multiple Clusters with Cluster Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Creating a Cluster Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Creating a "One-Way" Cluster Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Configuring and Controlling Cluster Gateway Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Creating a Cluster Gateway when You Control Both Sides . . . . . . . . . . . . . . . . . . . . . . . . . 392
Defining the Cluster Gateway Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Exchanging Document Types across a Cluster Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Specifying Individual Document Types a Cluster Gateway Can Receive . . . . . . . . . . . 393
Specifying Individual Document Types a Cluster Gateway Can Forward . . . . . . . . . . 394
About Using Client Groups to Specify Permissions on Document Types . . . . . . . . . . . 395
Using Client Groups to Specify Permissions on Document Types . . . . . . . . . . . . . . . . 396
Creating a Cluster Gateway when You Control Only One Side . . . . . . . . . . . . . . . . . . . . . . 396
Defining One Side of a Cluster Gateway Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Specifying which Documents the Cluster Gateway Can Forward and Receive . . . . . . 398
Filtering Documents across a Cluster Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Filtering Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Filter Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Filter Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Viewing Cluster Gateway Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Editing Cluster Gateway Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Administering webMethods Broker Version 8.2 15

16. Viewing Document Details across a Cluster Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Deleting a Cluster Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Removing an Allowed Document Type from a Cluster Gateway . . . . . . . . . . . . . . . . . . . . . 407
Pausing and Resuming a Cluster Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Pausing a Cluster Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Resuming a Cluster Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Preventing Connection Timeouts between Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Configuring the Forwarding Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Refusing Document Type Updates from a Remote Cluster Gateway . . . . . . . . . . . . . . . . . 411
Blocking Document Types Globally . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Blocking Document Types Individually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
18. Using My webMethods with JMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
JMS and Traditional Broker Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
webMethods JMS Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
JMS Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
JMS Messaging Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Pub-Sub Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Point-to-Point Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
JMS Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Message Consumer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Durable Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Message Delivery Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Message Acknowledgement Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Temporary Topics and Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Binding Administered Objects in JNDI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Using Basic Authentication with JMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Using SSL with JMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Managing JMS Clients: A Road Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Managing JNDI Naming Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Listing the JNDI Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Viewing a JNDI Provider's Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Editing a JNDI Provider's Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Adding a JNDI Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Managing Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Viewing the List of Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
Viewing the Detailed Information About Connection Factories . . . . . . . . . . . . . . . . . . . 429
Adding Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
Modifying Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Deleting Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
Managing Cluster Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
Viewing a List of Cluster Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Viewing Detailed Information About Cluster Connection Factories . . . . . . . . . . . . . . . 434
16 Administering webMethods Broker Version 8.2

17. Adding Cluster Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Load-Balancing Policies for Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
Editing Cluster Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Modifying Cluster Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
Deleting Cluster Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Managing Composite Cluster Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Viewing Detailed Information About Composite Cluster Connection Factories . . . . . . 444
Adding Composite Cluster Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
Modifying Composite Cluster Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
Deleting Composite Cluster Connection Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
Managing Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
Binding Destinations to JNDI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
About Creating Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
Creating a JMS Topic From a Naming Directory (JNDI) . . . . . . . . . . . . . . . . . . . . 449
Creating a JMS Topic Without Using a Naming Directory (JNDI) . . . . . . . . . . . . . 450
Creating a JMS Queue From a Naming Directory (JNDI) . . . . . . . . . . . . . . . . . . . 450
Creating a JMS Queue Without Using a Naming Directory (JNDI) . . . . . . . . . . . . 451
Viewing and Editing Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Deleting a Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
Assigning Publish and Subscribe Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
Creating a Durable Subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
19. Export and Import of Broker Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Description of Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Using My webMethods for Export and Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
XML Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Configuring Export and Import Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Broker Server and Broker Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Broker Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Client Groups, Clients, and Document Types . . . . . . . . . . . . . . . . . . . . . . . . 461
Territory Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Specifying the Import Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Using Command-Line Utilities for Export and Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Exporting Broker Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Importing Broker Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
Automating Export and Import with Command Files . . . . . . . . . . . . . . . . . . . . . . . . . . 464
Replicating Broker Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
Building a Production System Using Export and Import . . . . . . . . . . . . . . . . . . . . . . . . 465
Importing and Exporting Broker Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
Exporting a Broker Server and Its Dependent Objects . . . . . . . . . . . . . . . . . . . . . . . . . 465
Importing a Broker Server and Its Dependent Objects . . . . . . . . . . . . . . . . . . . . . . . . . 466
Exporting Territories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Importing Territories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Administering webMethods Broker Version 8.2 17