webMethods Integration Server Administrator’s Guidedocshare01.docshare.tips/files/11352/113524469.pdf · 2016. 5. 31. · Administering webMethods Integration Server Version 8.0

Title Page

Administering webMethods Integration Server

Version 8.0

April 2011

Copyright& Docu-ment ID

This document applies to webMethods Integration Server 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 © 1998–2009 Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, United States of America, and/or their licensors.

The name Software AG, webMethods, and all Software AG product names are either trademarks or registered trademarks of Software AG and/or Software AG USA, Inc. and/or their licensors. Other company and product names mentioned herein may be trademarks of their respective owners.

Use of this software is subject to adherence to Software AG’s licensing conditions and terms. These terms are part of the product documentation, located at http://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).

This software may include portions of third-party products. For third-party copyright notices and license terms, please refer to "License Texts, Copyright Notices and Disclaimers of Third Party Products." This document is part of the product documentation, located at http://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).

Document ID: IS-AG-80SP1-20110728

http://documentation.softwareag.com/legal/http://documentation.softwareag.com/legal/http://documentation.softwareag.com/legal/

Table of Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Documentation Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Online Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1. The Role of the Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21What Does an Administrator Do? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Typical Administrative Responsibilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22The Integration Server Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Receiving Administrative Messages from the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23The Administrator User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

The Administrator’s Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Adding Backup Administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

2. An Overview of the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Integration Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26The Role of the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Retrieving Data for Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

How the Server Executes Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Integration Server Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

3. Starting and Stopping the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Starting the webMethods Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Starting the Server from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37What Happens When You Start the Server? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

How to Tell if the Server Is Running Correctly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Running Integration Server as a Windows Application vs. a Windows Service . . . . . . . . . . 40

Switching the Server from a Windows Service to a Windows Application . . . . . . . . . . 41Switching the Server from a Windows Application to a Windows Service . . . . . . . . . . 41

Passing Java System Properties to Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Shutting Down the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Viewing Active Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Restarting the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Server Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Integration Server Data Integrity and Recoverability Considerations . . . . . . . . . . . . . . 47Critical Integration Server Data Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Administering webMethods Integration Server Version 8.0 3

Table of Contents

4. Using the Integration Server Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49What Is the Integration Server Administrator? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Starting the Integration Server Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Accessing Integration Server Administrator through My webMethods . . . . . . . . . . . . . . . . . 51Basic Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52The Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

5. Managing Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Purpose of Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Defining a User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Predefined User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Adding User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Removing User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Adding an Administrator User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Adding a Developer User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Changing Passwords and Password Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Password Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Disabling and Enabling Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Disabling a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Enabling a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Defining Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Predefined Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Adding Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Adding Users to a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Removing Users from a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Viewing Group Membership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Removing Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

6. Configuring the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Viewing and Changing Licensing Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

The License Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Viewing Licensing Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Changing Licensing Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Renewal Reminders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Renewing a Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Adding Licensed Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Licensed Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Managing the Server Thread Pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Setting the Session Timeout Limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Configuring Outbound HTTP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Specifying Outbound HTTP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Setting Up Aliases for Remote Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Adding an Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

4 Administering webMethods Integration Server Version 8.0

Table of Contents

Testing the Connection to a Remote Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Editing an Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Deleting an Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Specifying Third-Party Proxy Servers for Outbound Requests . . . . . . . . . . . . . . . . . . . . . . 85Creating a Proxy Server Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Editing a Proxy Server Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Enabling and Disabling a Proxy Server Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Changing an Existing Default Proxy Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Deleting a Proxy Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Bypassing a Proxy Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Configuring Where the Integration Server Writes Logging, Status, and Other Information . 90Switching from the Embedded Database to an External RDBMS . . . . . . . . . . . . . . . . . . . . 90Working with Extended Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Configuring Integration Server to Work with Servers Running HTTP 1.0 and Above . . 92Specifying Character Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Using a 64-bit JVM on Solaris and HP-UX Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Publishing Information about Integration Server Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Configuring Integration Server to Connect to CentraSite . . . . . . . . . . . . . . . . . . . . . . . 94Testing the Connection to CentraSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

7. Configuring Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Considerations for Adding Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Prerequisites to Configuring a Port for SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Port Usage and Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Adding an HTTP Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Using Advanced Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Adding an HTTPS Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Adding a File Polling Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Adding an FTPS Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Adding an FTP Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117Adding an E-mail Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Adding an HTTP Diagnostic Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Adding an HTTPS Diagnostic Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Suspending an HTTP/HTTPS Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Resuming an HTTP/HTTPS Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Testing for HTTPS Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Specifying an FTP/FTPS Port Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Changing the Primary Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Deleting a Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Editing a Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Enabling/Disabling a Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Configuring How Ports Handle Client Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Adding a Security Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137


Table of Contents

8. Setting Up the Server Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Specifying Amount and Type of Information to Include in the Server Log . . . . . . . . . . . . . . 141Specifying Whether to Queue Server Log Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Overriding Logging Level and Server Log Location for a Session . . . . . . . . . . . . . . . . . . . . 144Changing the Default Server Log Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Sending Messages About Critical Issues to E-mail Addresses . . . . . . . . . . . . . . . . . . . . . . 145Performing Additional Processing on Log Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Viewing the Server Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Using an Alternative Server Log Entry Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Changing the Log Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Specifying the Date and Time Format to Use in Log Entries . . . . . . . . . . . . . . . . . . . . 149Displaying Logged Data in Different Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Changing the Display Permanently for All Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Changing the Display Temporarily for the Server Log . . . . . . . . . . . . . . . . . . . . . . . . . 150

Globalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

9. Configuring Document Stores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Configuring the Default Document Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Configuring the Trigger Document Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Maintaining Inbound Document History for Received Documents . . . . . . . . . . . . . . . . . . . . 159Enabling Inbound Client-Side Queuing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Configuring the Outbound Document Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Setting the Capacity of the Outbound Document Store . . . . . . . . . . . . . . . . . . . . . . . . 161Selecting a User Account for Invoking Services Specified in Broker/Local Triggers . . . . . . 161Managing the Document History Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

10. Connecting Integration Server to Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Establishing the Primary Port for Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Configuring an Integration Server-to-Broker Server Connection . . . . . . . . . . . . . . . . . . . . . 166Specifying the Keep-Alive Mode for the Broker Connection . . . . . . . . . . . . . . . . . . . . . . . . 169

Setting Server Configuration Parameters for Keep-Alive Mode . . . . . . . . . . . . . . . . . . 170Normal Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Listen Only Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Disabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Connecting Multiple Non-Clustered Integration Servers to the Same Broker . . . . . . . . . . . 172Load Balancing with a Non-Clustered Group of Integration Servers . . . . . . . . . . . . . . 172Important Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

11. Configuring Integration Server for JMS Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Working with JNDI Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Creating a JNDI Provider Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Editing a JNDI Provider Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178


Table of Contents

Deleting a JNDI Provider Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Performing a Test Lookup for a JNDI Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Working with JMS Connection Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Connecting to the webMethods JMS Provider with the Native webMethods API . . . . . 180Creating a JMS Connection Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Allowing Destinations to be Managed through the JMS Connection Alias and Designer 185

Specifying a Retry Interval for Failed Connections . . . . . . . . . . . . . . . . . . . . . . . . 186Specifying a Keep Alive Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

Editing a JMS Connection Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Enabling and Disabling a JMS Connection Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187Deleting a JMS Connection Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

Creating Administered Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Using SSL with JMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Supported JMS Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Adding JMS Provider Client Libraries to Integration Server Classpath . . . . . . . . . . . . . . . . 189

12. Setting Up Aliases for Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Creating an Endpoint Alias for a Provider Web Service Descriptor . . . . . . . . . . . . . . . . . . . 197Creating an Endpoint Alias for a Consumer Web Service Descriptor . . . . . . . . . . . . . . . . . 199

13. Setting Up HTTP URL Aliases for Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Displaying HTTP URL Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

Portability of Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Creating an HTTP URL Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Deleting an HTTP URL Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

14. Securing Communications with the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210Anatomy of an Integration Server SSL Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

Integration Server and SSL Connection Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210Integration Server as an SSL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211Integration Server as an SSL Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

Roadmap for Configuring SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Creating Integration Server Keys and Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213Creating a Keystore and Truststore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214Obtaining the Certificates and Keys of the Partner Application . . . . . . . . . . . . . . . . . . 214Configuring an HTTPS or FTPS Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Keystores and Truststores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Keystore File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Keystore File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215HSM-Based Keystores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Creating a Keystore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Truststore File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216


Table of Contents

Truststore File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216How Integration Server Uses a Keystore and Truststore . . . . . . . . . . . . . . . . . . . . . . . 216Protecting Keystore and Truststore Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217Keystore, Truststore, and Key Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Creating Keystore and Truststore Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217Configuring Server-Side SSL Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Specifying the Integration Server SSL Authentication Credentials . . . . . . . . . . . . . . . . 221Controlling Server SSL Security Level by Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Usage of CA Certificates: Technical Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

Handling Expired CA Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Customizing Usage of the Trusted Certificates Directory . . . . . . . . . . . . . . . . . . . . . . . 223

WS-Security and Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

15. Controlling Access to Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Controlling Access to Resources by Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227Restricting IP Addresses that Can Connect to a Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

Controlling IP Access to All Ports (Globally) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228Allow Inbound Connections from Specified Hosts (Deny all Others) . . . . . . . . . . . 228Deny Inbound Connections from Specified Hosts (Allow All Others) . . . . . . . . . . 229

Controlling IP Access to Individual Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230Allow Inbound Requests from Specified Hosts (Deny All Others) . . . . . . . . . . . . . 230Deny Inbound Requests from Specified Hosts (Allow All Others) . . . . . . . . . . . . . 231

Restricting the Services Available from a Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233Allow Access to Specified Services (Deny All Others) . . . . . . . . . . . . . . . . . . . . . . . . . 233Deny Access to Specified Services (Allow All Others) . . . . . . . . . . . . . . . . . . . . . . . . . 234

Controlling the Use of Directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Controlling Access to Resources with ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

About ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237Package Replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Implicit and Explicit Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240Users that Belong to More than One Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Predefined ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241When Does the Server Perform ACL Checking? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 Creating ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Allowing or Denying Group Access to ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243Deleting ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244Default Settings and Inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

What Happens When You Change Existing ACL Assignments . . . . . . . . . . . . . . 245Assigning ACLs to Folders, Services, and Other Elements . . . . . . . . . . . . . . . . . . . . . 245Assigning ACLs to Files the Server Can Serve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Rules for Using .access Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248Removing ACL Protection from a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248


Table of Contents

16. Authenticating Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250Basic Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250Client Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

Checklist for Using Client Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251Certificate Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

Ports and Certificate Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252Importing a Certificate (Client or CA Signing Certificate) and Mapping It to a User 252Changing a Certificate Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Client Certificates and Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254HTTPS Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254FTPS Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

Using Multiple Client Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256Checklist for Presenting Multiple Client Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . 256Importing Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256Setting Up a Remote Server Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257Coding Your Flow Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

Client Authentication and Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Accessing Integration Server Data through My webMethods . . . . . . . . . . . . . . . . . . . . . . . 258

17. Customizing Authentication Using JAAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262Using JAAS with Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262JAAS Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

X509LoginModule and BasicLoginModule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264X509ValidatorModule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

Pluggable Authentication Modules (PAMs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265Writing a Custom JAAS Login Module for Integration Server . . . . . . . . . . . . . . . . . . . . . . . 265

Extend SagAbstractLoginModule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265Implement Commit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266Place the JAR File in the Integration Server Classpath . . . . . . . . . . . . . . . . . . . . . . . . 266Modify the JAAS Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

JAAS Custom Login Module Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267JAAS Login Module for Integration Server: Sample Code . . . . . . . . . . . . . . . . . . . . . . 267JAAS Custom Login Module: Code Explanation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268JAAS Configuration File: Sample Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

18. Master Passwords and Outbound Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272Managing Outbound Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273Changing the Master Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Changing the Expiration Interval for the Master Password . . . . . . . . . . . . . . . . . . . . . . . . . 275About the configPassman.cnf File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275Working with Outbound Password Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

Controlling Name and Location of Outbound Password File . . . . . . . . . . . . . . . . . . . . 276


Table of Contents

Controlling Encryption of Outbound Password File . . . . . . . . . . . . . . . . . . . . . . . . . . . 276Working with Master Password Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Storing the Master Password in a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277Prompting for the Master Password at Server Initialization . . . . . . . . . . . . . . . . . . . . . 278

What To Do if You Lose or Forget Your Master Password . . . . . . . . . . . . . . . . . . . . . . . . . 278When There Are Problems with the Master Password or Outbound Passwords at Startup 279

Determining Whether You Can Restore the Passwords . . . . . . . . . . . . . . . . . . . . . . . . 280Restoring the Master Password and Outbound Password Files . . . . . . . . . . . . . . . . . . 280Resetting the Master Password and Outbound Passwords . . . . . . . . . . . . . . . . . . . . . 281

E-mail Listeners and Package Replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

19. Securing Your Server with PKI Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

About PKI Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284PKI Profile Checking Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285Supported Hardware and Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286Configuring PKI System Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287Creating a PKI Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289Creating the PKI Profile Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292Connecting to and Disconnecting from the PKI System . . . . . . . . . . . . . . . . . . . . . . . . . . . 293Logging in a PKI Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293Deleting a PKI Profile Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294Viewing and Updating Information for a PKI Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294Viewing or Updating PKI Profile Alias Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294Determining Whether a PKI Profile Is Logged In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295Recovering a PKI Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296Changing the Password for a PKI Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298Updating Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299Exporting a PKI Profile from the File System to an HSM Device . . . . . . . . . . . . . . . . . . . . . 299Installing an Entrust PKI Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301Password Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301About CRL Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

How Often Is the CRL Downloaded? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

20. Setting Up a Reverse HTTP Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306How Reverse HTTP Gateway Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307Advantages to Reverse HTTP Gateway vs. Traditional Third-Party Proxy Servers . . . . . . 308Setting Up the Reverse HTTP Gateway Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

Setting Up the Gateway External Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310Setting Up the Gateway Registration Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

Connecting Your Internal Server to a Reverse HTTP Gateway Server . . . . . . . . . . . . . . . . 316Setting Up the Internal Registration Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

Performing Client Authentication on the Reverse HTTP Gateway Server . . . . . . . . . . . . . . 320


Table of Contents

Frequently Asked Questions About Reverse HTTP Gateway . . . . . . . . . . . . . . . . . . . . . . . 321

21. Configuring a Central User Directory or LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326Overview of How Integration Server Works with Externally Defined Users and Groups . . . 327

How the Server Uses Externally Defined Users and Groups . . . . . . . . . . . . . . . . . . . . 327When the Server Accesses Externally Defined Information . . . . . . . . . . . . . . . . . . . . . 327How Integration Server Authenticates Externally Defined Clients . . . . . . . . . . . . . . . . 328

Configuring Central User Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328Overview of Using LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

About LDAP and Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330Configuring the Server to Use LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

Mapping an LDAP User’s Access to ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336Stopping Use of an LDAP as an External Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

Considerations for User Accounts and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337Granting Administrator Privileges to External Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338Granting Developer Privileges to External Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340Granting Access to Services and Files to External Users . . . . . . . . . . . . . . . . . . . . . . . . . . 341

22. Managing Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343Using Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

Predefined Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345Sample Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

How the Server Stores Package Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347Manifest File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

Finding Information about Your Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350Viewing the Packages that Reside on Your Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

Filtering the List of Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351Determining Whether the Server Successfully Loaded the Package . . . . . . . . . . 352Determining Whether the Package Is Enabled or Disabled . . . . . . . . . . . . . . . . . 353

Displaying Information about a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353Displaying Information about Services and Folders in a Package . . . . . . . . . . . . . . . . 356Displaying Documentation for a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

Working with Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357Creating a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

Activating a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358Reloading a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359Enabling a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359Disabling a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360Deleting a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360Recovering a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361Archiving a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

Copying Packages from One Server to Another . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362Overview of Package Replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362Version Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366


Table of Contents

Who Can Subscribe? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367Guidelines for Using Package Replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

The Publishing Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368Displaying Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368Adding Subscribers from a Publishing Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368Updating Subscriber Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370Removing Subscribers for a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371Publishing a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

Specifying File and Version Information for a Release or Archive . . . . . . . . . . . . . . . . 373The Subscribing Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

Displaying Packages That Your Server Subscribes To . . . . . . . . . . . . . . . . . . . . . 377Manually Pulling a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378Subscribing to a Package from a Subscribing Server . . . . . . . . . . . . . . . . . . . . . . 379Updating Your Subscription Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381Canceling a Subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384Installing a Package Published by Another Server . . . . . . . . . . . . . . . . . . . . . . . . 384

Using a Package Class Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

23. Managing Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387About Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388Fully Qualified Service Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

Package Names and Service Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389HTTP URL Aliases for Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

Finding Information about Services and Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390Listing Folders and Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390Displaying Information about a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

Working with Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392Manually Adding a Service to the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392Testing Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392Canceling and Killing Threads Associated with a Service . . . . . . . . . . . . . . . . . . . . . . 393

Canceling or Killing a Thread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393Running Services When Packages Are Loaded, Unloaded, or Replicated . . . . . . . . . . . . . 395

What Is a Startup Service? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395What Is a Shutdown Service? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395What Is a Replication Service? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396Guidelines for Using Startup, Shutdown, and Replication Services . . . . . . . . . . . . . . . 396

Running Services in Response to Specific Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

24. Scheduling Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397Scheduling Services to Execute at Specified Times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398Scheduling a User Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

Using the Once Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399Using the Simple Repeating Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399Using the Complex Repeating Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400Using the Clustering Target Node Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403


Table of Contents

Tasks in a Clustered Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404Viewing Scheduled User Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

Filtering the List of Scheduled Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409Updating Scheduled User Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410Suspending User Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

Suspending a Single User Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410Suspending All User Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

Resuming Suspended User Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412Resuming a Suspended User Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412Resuming All Suspended User Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

Canceling a Scheduled User Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413Viewing the Scheduled System Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

25. Caching Service Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415What Is Caching? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416When Are Cached Results Returned? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416Resetting the Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418Viewing Service Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

26. Configuring Guaranteed Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419About Guaranteed Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420Configuring the Server for Guaranteed Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

Settings Shared by Both Inbound and Outbound Transactions . . . . . . . . . . . . . . . . . . 421Settings for Inbound Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422Settings for Outbound Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423Specifying an E-Mail Address and SMTP Server for Error Messages . . . . . . . . . . . . . 424

Administering Guaranteed Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425Shutting Down Guaranteed Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425Reinitializing Guaranteed Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

Inbound Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425Outbound Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

27. Locking Administration and Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428Choosing Local Server Locking or VCS Integration Locking . . . . . . . . . . . . . . . . . . . . . . . . 428Disabling and Re-enabling Locking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429

Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431Remote Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431Server User Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431Package Replication and Publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431Package and Folder Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431Source Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432Upgrading webMethods Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432


Table of Contents

28. Managing Broker/Local Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434Managing Document Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435

Increasing or Decreasing Threads for Document Retrieval . . . . . . . . . . . . . . . . . . . . . 435When to Increase or Decrease Threads for Document Retrieval . . . . . . . . . . . . . 436

Decreasing the Capacity of Trigger Document Stores . . . . . . . . . . . . . . . . . . . . . . . . . 437Suspending and Resuming Document Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438

Suspending and Resuming Document Retrieval for All Triggers . . . . . . . . . . . . . . 439Suspending and Resuming Document Retrieval for a Specific Trigger . . . . . . . . . 441

Managing Document Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443Increasing or Decreasing Threads for Document Processing . . . . . . . . . . . . . . . . . . . 443

When to Increase or Decrease Threads for Processing Documents . . . . . . . . . . . 444Decreasing Document Processing for Concurrent Triggers . . . . . . . . . . . . . . . . . . . . . 445Suspending and Resuming Document Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

Suspending and Resuming Document Processing for all Triggers . . . . . . . . . . . . 447Suspending and Resuming Document Processing for Specific Triggers . . . . . . . 449

Limiting Server Threads for Broker/Local Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451Cluster Synchronization for Broker/Local Trigger Management . . . . . . . . . . . . . . . . . . . . . 453

Configuring Cluster Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453Cluster Synchronization at Run Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454Monitoring Cluster Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

Modifying Broker/Local Trigger Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

29. Managing JMS Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460Controlling Thread Usage for JMS Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

Viewing Thread Usage for JMS Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460Increasing or Decreasing Thread Usage for JMS Triggers . . . . . . . . . . . . . . . . . . . . . . 461

Enabling, Disabling, and Suspending JMS Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462Viewing Exactly-Once Processing Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

30. Using Integration Server to Manage XA Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . 465Overview of XA Transaction Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

How the Integration Server Persists the State of a Transaction . . . . . . . . . . . . . . . . . . 466How the Integration Server Resolves Uncompleted Transactions . . . . . . . . . . . . . . . . 467About Unresolved XA Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468Details for an Unresolved XA Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

Configuring XA Options in Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471Enabling or Disabling XA Transaction Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471Configuring the XA Recovery Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472Configuring XA Server Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472

Manually Resolving a Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473

31. Using BPEL with Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476webMethods BPEL Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477


Table of Contents

Configuring the webMethods BPEL Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478Configuring the BPEL Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

Specifying the Database Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478Setting up a BPEL Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479

Deploying the BPEL Engine Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480BPEL ACLs and Integration Server Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481

A. Integration Server Deployment Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484Stage 1: Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484Stage 2: Basic Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485Stage 3: Setting Up Users, Groups, and ACLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486Stage 4: Publishing Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487Stage 5: Installing Run-Time Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488Stage 6: Preparing Clients for Communication with the Server . . . . . . . . . . . . . . . . . . . . . . 488Stage 7: Setting Up Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489Stage 8: Startup and Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490Stage 9: Archive Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491

B. Server Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494watt.com. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494watt.config. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494watt.core. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494watt.debug. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496watt.debug2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497watt.infradc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497watt.net. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498watt.security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503watt.server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506watt.ssl. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547watt.tnextdc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547watt.tx. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547watt.wm.tnextdc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548

C. Diagnosing the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550Configuring the Diagnostic Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550

Diagnostic Thread Pool Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550Diagnostic Port Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551

Using the Diagnostic Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551Starting the Integration Server in Safe Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553When the Server Automatically Places You in Safe Mode . . . . . . . . . . . . . . . . . . . . . . . . . 554Generating Thread Dumps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554

Generating a Dump of an Individual Thread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555Generating a Dump of the JVM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556


Table of Contents

D. FIPS 140-2 Compliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557FIPS 140-2 Compliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558

E. Using Pluggable Authentication Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560Customizing Authentication with Pluggable Authentication Modules . . . . . . . . . . . . . . . . . . 560

Overview of Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562

F. Using Integrated Windows Authentication with Integration Server . . . . . . . . . . . . . . . 567Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568Working with Integrated Windows Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568Activating and Deactivating Integrated Windows Authentication . . . . . . . . . . . . . . . . . . . . . 569

G. Wireless Communication with the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . . 571Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572How Does the Integration Server Communicate with Wireless Devices? . . . . . . . . . . . . . . 572Using URLs for Wireless Access to the Integration Server . . . . . . . . . . . . . . . . . . . . . . . . . 574

Invoking a Service with a URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574Requesting a WML or HDML Page with a URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575

WML and HDML Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577

H. Debugging Service Exceptions Using the Error Log . . . . . . . . . . . . . . . . . . . . . . . . . . . 579Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580Controlling the Level of Exception Logging Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580Displaying the Error Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580Interpreting the Error Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580

Understanding the Service Stack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581Understanding the Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582Understanding the Stack Trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583


About This Guide

This guide is for the administrator of a webMethods Integration Server. It provides an overview of how the server operates and explains common administrative tasks such as starting and stopping the server, configuring the server, setting up user accounts and security, and managing packages and services.

Document Conventions

Note: This guide describes features and functionality that may or may not be available with your licensed version of webMethods Integration Server. For information about the licensed components for your installation, see the Settings > License page in the webMethods Integration Server Administrator.

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 font

Identifies text you must type or messages displayed by the system.

{ } 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 (...).


About This Guide

Documentation InstallationYou 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 InformationYou can find additional information about Software AG products at the locations listed below.

For webMethods... The documentation is downloaded to...

6.x The installation directory of each product.

7.x A central directory named _documentation in the main installation directory (webMethods by default).

8.x A central directory named _documentation in the main installation directory (Software AG by default).

Note: The Empower Product Support Web site and the Software AG Documentation Web site replace Software AG ServLine24 and webMethods Advantage.

If you want to... Go to...

Access the latest version of product documentation.

Software AG Documentation Web site

http://documentation.softwareag.com

Find information about product releases and tools that you can use to resolve problems.

See the Knowledge Center to:

Read technical articles and papers.

Download fixes and service packs.

Learn about critical alerts.

See the Products area to:

Download products.

Get information about product availability.

Access older versions of product documentation.

Submit feature/enhancement requests.

Empower Product Support Web site

https://empower.softwareag.com


http://documentation.softwareag.comhttps://empower.softwareag.com/KnowledgeCenter/default.asphttps://empower.softwareag.com/Products/default.asphttps://empower.softwareag.com

About This Guide

Access additional articles, demos, and tutorials.

Obtain technical information, useful resources, and online discussion forums, moderated by Software AG professionals, to help you do more with Software AG technology.

Use the online discussion forums to exchange best practices and chat with other experts.

Expand your knowledge about product documentation, code samples, articles, online seminars, and tutorials.

Link to external Web sites that discuss open standards and many Web technology topics.

See how other customers are streamlining their operations with technology from Software AG.

Software AG Developer Community for webMethods

http://communities.softwareag.com/webmethods

If you want to... Go to...


http://communities.softwareag.com/webmethods

About This Guide


1 The Role of the Administrator What Does an Administrator Do? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Typical Administrative Responsibilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

The Integration Server Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Receiving Administrative Messages from the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

The Administrator User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Adding Backup Administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24


1 The Role of the Administrator

What Does an Administrator Do?In an IS environment, the administrator is responsible for installing, configuring, and maintaining the webMethods Integration Server. He or she is also responsible for ensuring the server is secure, available to clients, and running at peak performance. Usually, one person is appointed as the administrator, although most sites identify at least one other person to act as a backup.

Typical Administrative ResponsibilitiesIf you are the webMethods Integration Server Administrator for your site, you might be involved in some or all of the following activities.

Installing and upgrading the Integration Server, which includes tasks such as equipping the server computer with appropriate hardware and software, downloading and installing the server program, and implementing upgrades as needed.

Starting and stopping the server, which includes shutting down the server when necessary (e.g., for routine maintenance or reconfiguration) and restarting it afterwards. It also includes performing your site’s standard recovery procedures following a hardware or software failure of the server computer. For information about these activities, see Chapter 3, “Starting and Stopping the Server”.

Configuring server settings, which includes setting basic operating parameters such as the maximum session limits, log file options, and port assignments. For information about these activities, see Chapter 6, “Configuring the Server”.

Administering users and groups, which includes defining user names and passwords for authorized users and assigning them to groups. For information about this task, see Chapter 5, “Managing Users and Groups”. Alternatively, you can configure the server to acquire user and group information from an external system (e.g., LDAP). For more information, see Chapter 21, “Configuring a Central User Directory or LDAP”.

Administering server security, which includes identifying other administrators, assigning access controls to individual services, and configuring the server’s use of digital certificates. For more information about this task, see Chapter 16, “Authenticating Clients”, Chapter 14, “Securing Communications with the Server”, Chapter 17, “Customizing Authentication Using JAAS”, and Chapter 15, “Controlling Access to Resources”.

Managing packages and services, which includes tasks such as activating/deactivating services, copying packages, and updating services and/or packages as necessary. For more information about this task, see Chapter 22, “Managing Packages” and Chapter 23, “Managing Services”.



The Integration Server AdministratorThe “Integration Server Administrator” is the utility you use to accomplish administrative tasks. You use it to monitor server activity, examine log information, add users, enable/disable services, and adjust the server’s performance features. For information about the Integration Server Administrator, see Chapter 4, “Using the Integration Server Administrator”.

Receiving Administrative Messages from the ServerThe Integration Server issues e-mail messages for a variety of failure conditions (for example, internal errors, binding errors, and transaction manager errors). As an administrator, you are the one who should receive these messages and take appropriate action when errors occur.

To ensure that you (or an appropriate alternate) receive messages from the server, you must set the E-mail Notification parameters using the Integration Server Administrator as described in “Specifying an E-Mail Address and SMTP Server for Error Messages” on page 424.

The Administrator UserEvery Integration Server is installed with a predefined user account called “Administrator.” By default, this user is the only one who can perform administrative tasks with the Integration Server Administrator.

The Administrator’s PasswordThe predefined password assigned to the Administrator user account is “manage”.

To learn how to change passwords, see “Adding an Administrator User” on page 60.

Important! The predefined password for the Administrator account is “manage”. The predefined password for the Developer account is “isdev”. The predefined password for the Replicator account is “iscopy”.

Change all of these passwords immediately after installing the webMethods Integration Server. Otherwise, your server will be vulnerable to anyone who knows the default passwords that webMethods installs on its servers. When assigning a password, make it something that is difficult to guess. For example, make it a mixture of upper- and lowercase letters, numbers, and special characters. Do not use a name, a phone number, your license plate, your social security number, or other generally available information. Do not write passwords down. Do not tell anyone the password unless you are sure of that person’s identity.



Adding Backup AdministratorsIt is a good idea to designate at least one individual as a “backup administrator,” who can administer the Integration Server when you are not available.

To add a backup administrator to your server, create a regular user account for the user (if he or she does not already have one); then add that user account to the “Administrators” group.

Only members of the “Administrators” group can use the Integration Server Administrator. For information about creating user accounts and adding them to groups, see Chapter 5, “Managing Users and Groups”.

Note: If you use an external directory for user and group information, see “Granting Administrator Privileges to External Users” on page 338 for information about adding administrators.


2 An Overview of the Server Integration Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

The Role of the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

How the Server Executes Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Integration Server Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34


2 An Overview of the Server

Integration SolutionsSoftware AG provides two offerings for integration solutions:

webMethods ESB, which is designed for department-level, standards-based integration. webMethods ESB includes a lightweight license restricted version of webMethods Integration Server.

webMethods Integration Platform which is designed for enterprise-wide, standards- and application-based integration through messaging. It includes a full version of webMethods Integration Server, and webMethods Broker.

The Role of the ServerThe webMethods Integration Server hosts packages that contain services and related files. The Integration Server comes with several packages. For example, it includes packages that contain built-in services that your developers might want to invoke from their services or client applications and services that demonstrate some of the features of the Integration Server. You can create additional packages to hold the services that your developers create. Your developers can create services that perform functions, such as, integrating your business systems with those of your partners, retrieving data from legacy systems, and accessing and updating databases.

The Integration Server provides an environment for the orderly, efficient, and secure, execution of services. It decodes client requests, identifies the requested services, invokes the services, passes data to them in the expected format, encodes the output produced by the services, and returns output to the clients.

Additionally, the server authenticates clients, verifies that they are authorized to execute the requested service, maintains audit-trail logs, and promotes throughput using facilities such as service result caching.



ArchitectureThe Integration Server listens for client requests on one or more ports. You can associate the type of protocol that the server uses for each port. The server supports HTTP, HTTPS, FTP, FTPS, and e-mail ports.

When applications are built around the thin client, the application uses an HTTP or HTTPS port for communication with the server. When using HTTP or HTTPS ports, the clients communicate using the webMethods Remote Procedure Call (RPC). Because the server supports both HTTP and HTTPS, it can listen on an HTTP port for non-secure client requests and an HTTPS port for secure requests.

To interact with the server without using the webMethods RPC, use an FTP or FTPS port. A typical use for an FTP or FTPS port is to get a directory listing, change to the directory that contains the service you want to invoke, put a file that contains input to the service, and run the service. The server returns the output from the service to the directory in which the service resides. Use an e-mail port to receive requests through an e-mail server, such as POP3 or IMAP.

You can define as many ports as you want. When you initially install the server, it has an HTTP port at 5555.

Note: Unlike HTTP, FTP, and e-mail, HTTPS and FTPS provide for secure data transmission. They do this through encryption and certificates. Without HTTPS or FTPS, unauthorized users might be able to capture or modify data, use IP spoofing to attack servers, access unauthorized services, or capture passwords. If you must pass passwords, make sure the back-end application has minimal privileges.

Note: When you install the server, it also defines a port type of webMethods/Diagnostic at 9999. The diagnostic port uses the HTTP protocol and provides you access to the Integration Server when it is unresponsive. For more information about the diagnostic port, see Appendix C, “Diagnosing the Integration Server”.



The Server Listens for Requests on Ports that You Specify

There may be times when you want to use the standard port numbers used by Web servers: port 80 for HTTP requests and port 443 for HTTPS requests. If your Integration Server