webMethods Integration Server Administrators Guide

Version 9.10

April 2016

This document applies to webMethods Integration Server Version 9.10 and to all subsequent releases.
Specications contained herein are subject to change and these changes will be reported in subsequent release notes or new editions.
Copyright 2007-2016 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or
its aliates and/or their licensors.
The name Software AG and all Software AG product names are either trademarks or registered trademarks of Software AG and/or
Software AG USA Inc. and/or its subsidiaries and/or its aliates and/or their licensors. Other company and product names mentioned
herein may be trademarks of their respective owners.
Detailed information on trademarks and patents owned by Software AG and/or its subsidiaries is located at
hp://softwareag.com/licenses.
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 hp://softwareag.com/licenses 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, license terms, additional rights or
restrictions, please refer to "License Texts, Copyright Notices and Disclaimers of Third Party Products". For certain specic third-party
license restrictions, please refer to section E of the Legal Notices available under "License Terms and Conditions for Use of Software AG
Products / Copyright and Trademark Notices of Software AG Products". These documents are part of the product documentation, located
at hp://softwareag.com/licenses and/or in the root installation directory of the licensed product(s).
Document ID: IS-AG-910-20160415

M
Table of Contents

Table of Contents
About this Guide............................................................................................................................27
Document Conventions............................................................................................................ 27
Online Information.................................................................................................................... 28
The Role of the Administrator......................................................................................................29
What Does an Administrator Do?............................................................................................ 30
Typical Administrative Responsibilities.....................................................................................30
The Integration Server Administrator....................................................................................... 31
Receiving Administrative Messages from the Server...............................................................31
The Administrator User.............................................................................................................31
The Administrator's Password...........................................................................................31
Adding Backup Administrators................................................................................................. 32
An Overview of the Server........................................................................................................... 33
The Role of the Server.............................................................................................................34
About Integration Server Instances...................................................................................34
Architecture............................................................................................................................... 35
Services............................................................................................................................. 37
Retrieving Data for Services............................................................................................. 37
How the Server Executes Services..........................................................................................39
How the Server Loads Java Classes.......................................................................................40
Class Loaders....................................................................................................................40
OSGi Bundle Class Loader........................................................................................41
Integration Server Class Loaders.............................................................................. 41
Classpaths......................................................................................................................... 42
How the Integration Server Classpaths Are Specified............................................... 42
Changing Classpath Information at Startup............................................................... 44
How Class Loading Works................................................................................................ 45
Class Loading Process.............................................................................................. 45
Scenario One: Integration Server Knows Where the Class Lives.......................46
Scenario Two: Integration Server Does Not Know Where the Class Lives......... 47
Scenario Three: Package Class Loader Does Not Defer to the Integration Server
Class Loader....................................................................................................... 47
Where to Place Classes and Jar Files for Packages........................................................48
Where to Place Custom and Third-Party Jar Files........................................................... 49
Accelerating Class Loading...............................................................................................49
Integration Server Security....................................................................................................... 50
Logging..................................................................................................................................... 51
Caching..................................................................................................................................... 51
Starting and Stopping the Server................................................................................................ 53
Starting the webMethods Integration Server............................................................................54
webMethods Integration Server Administrators Guide Version 9.10

M
Table of Contents

Starting an Integration Server Instance on Windows........................................................54

Starting Integration Server on UNIX................................................................................. 54
Starting a Server Instance from the Command Prompt....................................................55
What Happens When You Start the Server?........................................................................... 61
How to Tell if the Server Is Running Correctly..................................................................61
Running Integration Server as a Windows Application vs. a Windows Service....................... 62
Switching the Server from a Windows Service to a Windows Application........................ 63
Switching the Server from a Windows Application to a Windows Service........................ 63
Passing Java System Properties to Integration Server............................................................64
Shutting Down the Integration Server...................................................................................... 65
Shutting Down the Integration Server from Integration Server Administrator....................65
Shutting Down Integration Server from Windows............................................................. 65
Shutting Down Integration Server from the Command Prompt.........................................66
Viewing Active Sessions...........................................................................................................66
Viewing the Integration Server Process ID.............................................................................. 66
Restarting the Integration Server............................................................................................. 67
Server Recovery....................................................................................................................... 68
Integration Server Data Integrity and Recoverability Considerations................................68
Critical Integration Server Data Files......................................................................... 69
The Java Service Wrapper.......................................................................................................69
The Java Service Wrapper Configuration Files................................................................ 70
JVM Configuration............................................................................................................. 70
The Wrapper Log.............................................................................................................. 71
Logging Properties..................................................................................................... 71
Fault Monitoring.................................................................................................................72
Generating a Thread Dump.............................................................................................. 72
Running Multiple Integration Server Instances.......................................................................... 73
Overview................................................................................................................................... 74
Guidelines for Running Multiple Integration Server Instances on the Same Machine.............. 74
About Creating a New Integration Server Instance..................................................................74
About the is_instance Script.....................................................................................................75
Syntax................................................................................................................................ 75
is_instance Script Commands...........................................................................................75
Creating a New Integration Server Instance............................................................................ 76
Installing and Updating Packages on a Server Instance......................................................... 78
Deleting Packages from a Server Instance..............................................................................79
Updating Language Packs on a Server Instance.....................................................................80
Deleting a Server Instance.......................................................................................................81
Using the Integration Server Administrator................................................................................83
What Is the Integration Server Administrator?......................................................................... 84
Starting the Integration Server Administrator........................................................................... 84
Starting Integration Server Administrator on Windows.............................................................85
Accessing Integration Server Administrator through My webMethods..................................... 85
Basic Operation........................................................................................................................ 86
webMethods Integration Server Administrators Guide Version 9.10

M
Table of Contents

Logging Off the Integration Server Administrator..............................................................87

Getting Help.......................................................................................................................87
The Configuration File.............................................................................................................. 88
Software AG Command Central...............................................................................................88
Managing Users and Groups........................................................................................................89
Users and Groups.................................................................................................................... 90
Purpose of Users and Groups.......................................................................................... 90
Defining a User Account.......................................................................................................... 91
Predefined User Accounts.................................................................................................91
Adding User Accounts.......................................................................................................92
Removing User Accounts..................................................................................................93
Adding an Administrator User........................................................................................... 94
Adding a Developer User..................................................................................................95
Changing Passwords.........................................................................................................96
Setting Password Requirements....................................................................................... 97
Disabling and Enabling Users.................................................................................................. 98
Disabling a User................................................................................................................98
Enabling a User.................................................................................................................99
Defining Groups........................................................................................................................99
Predefined Groups.......................................................................................................... 100
Adding Groups.................................................................................................................101
Adding Users to a Group................................................................................................ 102
Removing Users from a Group....................................................................................... 103
Viewing Group Membership............................................................................................ 104
Removing Groups............................................................................................................105
Configuring the Server................................................................................................................107
Viewing and Changing Licensing Information........................................................................ 108
The License Key..............................................................................................................108
Viewing Licensing Information..................................................................................108
Changing Licensing Information...............................................................................108
Renewal Reminders................................................................................................. 109
Renewing a Key.......................................................................................................109
Adding Licensed Features....................................................................................... 109
Licensed Sessions...........................................................................................................109
Viewing Active Sessions.......................................................................................... 110
Managing the Server Thread Pool......................................................................................... 110
Managing Server Sessions.....................................................................................................112
Setting the Session Timeout Limit.................................................................................. 112
Setting the Stateful Session Limit................................................................................... 113
Configuring Outbound HTTP Settings....................................................................................114
Specifying Outbound HTTP Settings.............................................................................. 116
Setting Up Aliases for Remote Integration Servers............................................................... 117
Adding an Alias for a Remote Integration Server........................................................... 118
Testing the Connection to a Remote Server...................................................................120
webMethods Integration Server Administrators Guide Version 9.10

M
Table of Contents

Editing an Alias............................................................................................................... 120

Deleting an Alias............................................................................................................. 120
Specifying Third-Party Proxy Servers for Outbound Requests.............................................. 121
How Integration Server Uses Proxy Servers.................................................................. 121
Creating a Proxy Server Alias.........................................................................................123
Editing a Proxy Server Alias........................................................................................... 126
Disabling a Proxy Server Alias........................................................................................127
Enabling a Proxy Server Alias........................................................................................ 127
Specifying a Default Proxy Server Alias......................................................................... 127
Deleting a Proxy Server Alias......................................................................................... 128
Bypassing a Proxy Server...............................................................................................128
Configuring Where the Integration Server Writes Logging, Status, and Other Information.....129
Switching from the Embedded Database to an External RDBMS..........................................129
Working with Extended Configuration Settings...................................................................... 130
Configuring Integration Server to Work with Servers Running HTTP 1.0 and Above.............131
Specifying Character Encoding.............................................................................................. 131
Configuring the JVM...............................................................................................................132
Specifying the JDK or JRE for Integration Server..................................................................132
Changing the JVM Heap Size Used by Integration Server.................................................... 133
Publishing and Retracting Information about Integration Server Assets................................ 134
Configuring Integration Server to Connect to CentraSite................................................134
Testing the Connection to CentraSite............................................................................. 135
Setting a Port for Remote Client JMX Monitoring.................................................................. 136
Configuring Integration Server to Accept a Debug Connection During Startup......................136
Using CORS with Integration Server......................................................................................137
How Integration Server Handles CORS Requests..........................................................137
Configuring Integration Server to Accept CORS Requests.............................................137
Managing JDBC Pools................................................................................................................ 141
Overview................................................................................................................................. 142
Managing Functional Alias Definitions................................................................................... 143
Assigning Connection Pools to Functional Aliases......................................................... 143
Testing Functional Aliases...............................................................................................144
Restarting Functional Aliases..........................................................................................145
Using Fail-Fast Mode with a Functional Alias.................................................................145
Managing Pool Aliases........................................................................................................... 146
Creating Connection Pool Aliases Manually................................................................... 146
Creating Connection Pool Aliases by Copying an Existing Pool Alias............................ 151
Editing a Connection Pool Alias......................................................................................151
Testing a Connection Pool Alias..................................................................................... 152
Deleting a Connection Pool Alias....................................................................................152
Managing Driver Aliases.........................................................................................................153
Creating Database Driver Alias Definitions..................................................................... 153
Editing Database Driver Aliases......................................................................................153
Deleting Database Driver Aliases................................................................................... 154

webMethods Integration Server Administrators Guide Version 9.10

M
Table of Contents

Configuring Ports.........................................................................................................................155
About Ports............................................................................................................................. 156
Available Port Types........................................................................................................156
Default Ports....................................................................................................................157
About the Port Alias........................................................................................................ 158
Package Associations......................................................................................................159
Considerations for Adding Ports.............................................................................................159
Reasons to Add Additional Ports.................................................................................... 159
Considerations for Configuring Ports.............................................................................. 160
AS/400 Considerations.............................................................................................160
Bind Addresses........................................................................................................ 160
Prerequisites to Configuring a Port for SSL.............................................................160
Port Usage and Security..........................................................................................161
Adding an HTTP Port............................................................................................................. 161
Advanced Controls.......................................................................................................... 167
Editing Advanced Controls.......................................................................................167
Adding an HTTPS Port...........................................................................................................168
About File Polling Ports..........................................................................................................176
Adding a File Polling Port............................................................................................... 177
Adding an FTPS Port............................................................................................................. 183
Adding an FTP Port................................................................................................................187
Adding an E-Mail Port............................................................................................................ 189
Security Considerations for E-Mail Ports........................................................................ 196
Adding an HTTP Diagnostic Port........................................................................................... 196
Adding an HTTPS Diagnostic Port.........................................................................................200
Suspending an HTTP/HTTPS Port.........................................................................................205
Resuming an HTTP/HTTPS Port........................................................................................... 206
Testing for HTTPS Requests..................................................................................................206
Using an FTP/FTPS Port Range............................................................................................207
Specifying an FTP/FTPS Port Range............................................................................. 207
About the Primary Port...........................................................................................................208
Changing the Primary Port..............................................................................................209
Deleting a Port........................................................................................................................209
Editing a Port..........................................................................................................................210
About Enabling/Disabling a Port.............................................................................................210
Disabling a Port...............................................................................................................210
Enabling a Port................................................................................................................211
Configuring How Ports Handle Client Certificates..................................................................211
Adding a Security Provider.....................................................................................................212
Configuring the Allowed Protocols for JSSE per Port............................................................ 213
Setting Up the Server Log.......................................................................................................... 215
Overview of the Server Log................................................................................................... 216
Specifying Amount and Type of Information to Include in the Server Log..............................217
Logging Levels................................................................................................................ 219
webMethods Integration Server Administrators Guide Version 9.10

M
Table of Contents

Specifying Whether to Queue Server Log Entries................................................................. 219

Changing the Default Server Log Location............................................................................ 220
Configuring the Server Log to Rotate Based on Size............................................................ 221
Sending Messages About Critical Issues to E-mail Addresses..............................................222
Performing Additional Processing on Log Entries..................................................................223
Viewing the Server Log.......................................................................................................... 223
Using an Alternative Server Log Entry Format............................................................... 224
Changing the Log Displays.................................................................................................... 225
Specifying the Date and Time Format to Use in Log Entries..........................................225
Displaying Logged Data in Different Languages.............................................................226
Changing the Display Permanently for All Logs............................................................. 226
Changing the Display Temporarily for the Server Log.................................................... 227
Overriding Logging Level and Server Log Location for a Session......................................... 227
Globalization........................................................................................................................... 229
Configuring Integration Server for webMethods Messaging.................................................. 231
Overview................................................................................................................................. 232
Working with Messaging Connection Aliases.........................................................................232
Predefined Messaging Connection Aliases.....................................................................233
Creating a Broker Connection Alias................................................................................234
Creating a Universal Messaging Connection Alias......................................................... 238
Editing a Messaging Connection Alias............................................................................243
Enabling a Messaging Connection Alias.........................................................................245
About Disabling a Message Connection Alias................................................................ 245
Disabling a Messaging Connection Alias.................................................................246
Messaging Connection Alias Status................................................................................247
Specifying the Default Messaging Connection Alias.......................................................248
Deleting a Messaging Connection Alias......................................................................... 249
Authenticating Connections to the Universal Messaging Server............................................249
Configuring Integration Server to Connect to an SSL-Enabled Port on Universal
Messaging...............................................................................................................................252
Configuring a Universal Messaging Connection Alias for One-Way SSL........................253
Configuring a Universal Messaging Connection Alias for Two-Way SSL........................254
Specifying the Keep-Alive Mode for the Broker Connection.................................................. 255
Setting Server Configuration Parameters for Keep-Alive Mode...................................... 256
Normal Mode................................................................................................................... 257
Listen Only Mode............................................................................................................ 257
Disabled........................................................................................................................... 258
Synchronizing Broker Clients When the Primary Port for Integration Server Changes.......... 258
Configuring Document Stores................................................................................................ 258
Configuring the Default Document Store........................................................................ 259
About the Trigger Document Store................................................................................. 261
Configuring the Trigger Document Store................................................................. 261
Maintaining Inbound Document History for Received Documents.................................. 263
Enabling Inbound Client-Side Queuing........................................................................... 263

webMethods Integration Server Administrators Guide Version 9.10

M
Table of Contents

About the Outbound Document Store.............................................................................263

Configuring the Rate at which Integration Server Drains the Outbound Document
Store......................................................................................................................... 264
Setting the Capacity of the Outbound Document Store...........................................265
Associating a User Account with webMethods Messaging Trigger Services.................. 265
Specifying a User Account for Invoking webMethods Messaging Trigger
Services.................................................................................................................... 266
Load Balancing with a Non-Clustered Group of Integration Servers......................................267
Important Considerations.................................................................................................267
Configuring Integration Server for JMS Messaging.................................................................269
Overview................................................................................................................................. 270
Working with JNDI Providers..................................................................................................270
Predefined JNDI Provider Aliases...................................................................................270
Creating a JNDI Provider Alias....................................................................................... 271
Editing a JNDI Provider Alias..........................................................................................273
Deleting a JNDI Provider Alias........................................................................................274
Creating a JNDI Provider Failover List........................................................................... 274
Performing a Test Lookup for a JNDI Provider............................................................... 275
JNDI Provider Cache and Timeout Behavior for Administered Objects.......................... 275
Working with JMS Connection Aliases...................................................................................276
Connecting to webMethods Broker with the Native webMethods API............................ 276
Predefined JMS Connection Aliases...............................................................................276
Creating a JMS Connection Alias................................................................................... 277
Allowing Destinations to be Managed through the JMS Connection Alias and
Designer................................................................................................................... 287
Allowing Multiple Connections for a JMS Connection Alias.....................................288
About the Connection Client ID........................................................................ 289
Creating a Dedicated Listener for Receiving Replies.............................................. 290
Configuring Producer Caching for Sending JMS Messages.................................... 291
Configuring Automatic Retry when Sending JMS Messages Using the pub.jms:send
Service......................................................................................................................292
About Retrying the pub.jms:send Service when webMethods Universal
Messaging Is the JMS Provider........................................................................294
Editing a JMS Connection Alias......................................................................................295
Enabling and Disabling a JMS Connection Alias............................................................295
Deleting a JMS Connection Alias....................................................................................296
Specifying a Connection Monitoring Period.................................................................... 296
Specifying a Retry Interval for Failed Connections......................................................... 297
Specifying a Keep-Alive Interval..................................................................................... 297
Creating Administered Objects...............................................................................................297
Monitoring a Connection Factory Object for Changes........................................................... 297
Polling for Changes......................................................................................................... 298
Registering an Event Listener......................................................................................... 299
How Integration Server Updates the Connection............................................................299
Configuring Integration Server to Monitor a Connection Factory Object......................... 300
webMethods Integration Server Administrators Guide Version 9.10

M
Table of Contents

Using SSL with JMS...............................................................................................................302

Supported JMS Providers.......................................................................................................303
About Using webMethods Universal Messaging as the JMS Provider............................303
Adding JMS Provider Client Libraries to Integration Server Classpath.................................. 305
Adding Client Libraries for Earlier Versions of Universal Messaging.............................. 309
Configuring Endpoint Aliases for Web Services......................................................................311
Overview................................................................................................................................. 312
Creating an Endpoint Alias for a Provider Web Service Descriptor for Use with HTTP/S.......313
Creating an Endpoint Alias for a Consumer Web Service Descriptor for Use with HTTP/S... 320
Creating an Endpoint Alias for Message Addressing for Use with HTTP/S........................... 331
Creating an Endpoint Alias for a Provider Web Service Descriptor for Use with JMS............338
Creating an Endpoint Alias for a Consumer Web Service Descriptor for Use with JMS.........344
Creating an Endpoint Alias for Message Addressing for Use with JMS.................................352
Timestamps in the WS-Security Header................................................................................ 359
Configuring Reliable Messaging in Integration Server............................................................361
Overview of Reliable Messaging............................................................................................ 362
Understanding Reliable Messaging Terminology............................................................ 362
Using Reliable Messaging in Integration Server.................................................................... 363
Persistent Storage Support for Reliable Messaging Data...............................................364
Limitations When Using Reliable Messaging in Integration Server.................................365
Configuring Reliable Messaging in Integration Server........................................................... 365
Reliable Messaging Sequence Reports................................................................................. 368
Client and Server Sequences......................................................................................... 368
Viewing Reliable Messaging Sequence Reports.............................................................369
Closing a Sequence............................................................................................................... 370
Terminating a Sequence.........................................................................................................370
Sending an Acknowledgement Request................................................................................ 371
Configuring Integration Server to Use Kerberos......................................................................373
Overview................................................................................................................................. 374
About Kerberos.......................................................................................................................374
Kerberos Terminology......................................................................................................374
Prerequisites to Configuring Kerberos................................................................................... 375
Limitations When Using Kerberos Authentication in Integration Server................................. 375
Configuring Integration Server to Use Kerberos.................................................................... 376
Order of Precedence for Principal Name and Password................................................ 378
JAAS Contexts for Kerberos.................................................................................................. 379
Troubleshooting Kerberos Configuration................................................................................ 379
Setting Up HTTP URL Aliases....................................................................................................381
Overview................................................................................................................................. 382
Creating an HTTP URL Alias................................................................................................. 383
Specifying the URL Path.................................................................................................385
Using Port Mappings with a URL Alias...........................................................................385

webMethods Integration Server Administrators Guide Version 9.10

10

M
Table of Contents

Adding a Port Mapping to a URL Alias....................................................................386

Deleting a Port Mapping for a URL Alias.................................................................387
Using a URL Alias for the Empty Path......................................................................... 387
Creating a URL Alias for the Empty Path................................................................ 387
Enabling Partial Matching of URL Aliases............................................................................. 388
Displaying HTTP URL Aliases................................................................................................389
About HTTP URL Alias Association................................................................................389
Editing a URL Alias................................................................................................................ 390
Deleting a URL Alias.............................................................................................................. 390
Portability of URL Aliases and Possible Conflicts.................................................................. 391
Configuring Integration Server to Connect to an SFTP Server...............................................393
Overview of SFTP.................................................................................................................. 394
Creating an SFTP Server Alias..............................................................................................394
Editing an SFTP Server Alias......................................................................................... 395
Creating an SFTP User Alias.................................................................................................396
Editing an SFTP User Alias............................................................................................ 399
Testing the Connection to the SFTP Server................................................................... 399
Securing Communications with the Server.............................................................................. 401
Overview................................................................................................................................. 402
Anatomy of an Integration Server SSL Connection............................................................... 402
Integration Server and SSL Connection Type.................................................................402
Integration Server as an SSL Server.............................................................................. 403
Integration Server as an SSL Client............................................................................... 403
Roadmap for Configuring SSL............................................................................................... 404
Creating Integration Server Keys and Certificates.......................................................... 405
Creating a Keystore and Truststore................................................................................ 406
Obtaining the Certificates and Keys of the Partner Application...................................... 406
Configuring an HTTPS or FTPS Port..............................................................................406
Keystores and Truststores......................................................................................................407
Keystore File....................................................................................................................407
Keystore File Formats.............................................................................................. 407
HSM-Based Keystores............................................................................................. 407
Creating a Keystore................................................................................................. 408
Truststore File..................................................................................................................408
Truststore File Formats............................................................................................ 408
How Integration Server Uses a Keystore and Truststore................................................408
Protecting Keystore and Truststore Files........................................................................ 409
Keystore, Truststore, and Key Aliases............................................................................ 409
Default Keystore and Truststore Aliases..................................................................410
Creating Keystore Aliases........................................................................................410
Creating Truststore Aliases...................................................................................... 412
Configuring Server-Side SSL Settings................................................................................... 414
Specifying the Integration Server SSL Authentication Credentials................................. 414
Controlling Server SSL Security Level by Port...................................................................... 415
webMethods Integration Server Administrators Guide Version 9.10

11

M
Table of Contents

Storing SSL Information for the Integration Server JVM in a Secure Manner........................ 415
Order of Precedence for the javax.net.ssl Properties..................................................... 416
Usage of CA Certificates: Technical Considerations..............................................................417
Handling Expired CA Certificates....................................................................................417
Customizing Usage of the Trusted Certificates Directory................................................417
WS-Security and Integration Server.......................................................................................418
Using SAML for Web Service Client Authentication...............................................................418
Requirements for Using SAML for Authentication...........................................................418
Identifying Trusted STSs to Integration Server............................................................... 419
Controlling Access to Resources.............................................................................................. 421
Overview................................................................................................................................. 422
Controlling Access to Resources by Port...............................................................................422
Restricting IP Addresses that Can Connect to a Port.....................................................423
Controlling IP Access to All Ports (Globally)............................................................424
Allow Inbound Connections from Specified Hosts (Deny All Others)................ 424
Deny Inbound Connections from Specified Hosts (Allow All Others)................ 425
Allow Inbound Requests from Specified Hosts (Deny All Others)............................426
Deny Inbound Requests from Specified Hosts (Allow All Others)............................427
If You Inadvertently Deny IP Access to All Hosts.................................................... 428
Resetting the Global Setting IP Access Setting................................................428
Resetting the IP Access Setting for an Individual Port..................................... 429
Restricting the Services or Web Service Descriptors Available from a Port....................429
Allow Access to Specified Services (Deny All Others)............................................ 430
Deny Access to Specified Services (Allow All Others)............................................ 432
Resetting a Port to the Default Access.............................................................433
Controlling the Use of Directives............................................................................................433
Controlling Access to Resources with ACLs..........................................................................435
About ACLs..................................................................................................................... 435
Package Replication.................................................................................................438
Implicit and Explicit Protection................................................................................. 438
Users that Belong to More than One Group............................................................438
Predefined ACLs............................................................................................................. 439
When Does the Server Perform ACL Checking?............................................................440
Creating ACLs................................................................................................................. 440
Allowing or Denying Group Access to ACLs...................................................................441
Deleting ACLs..................................................................................................................441
Default Settings and Inheritance..................................................................................... 442
What Happens When You Change Existing ACL Assignments............................... 443
Assigning ACLs to Folders, Services, and Other Elements............................................443
Removing an ACL from a Folder or Service...................................................................444
Assigning ACLs to Files the Server Can Serve.............................................................. 445
Rules for Using .access Files...................................................................................445
Removing ACL Protection from a File............................................................................ 446
Authenticating Clients.................................................................................................................447
webMethods Integration Server Administrators Guide Version 9.10

12

M
Table of Contents

Overview................................................................................................................................. 448
Basic Authentication............................................................................................................... 448
Digest Authentication..............................................................................................................449
Kerberos Authentication..........................................................................................................450
Client Certificates....................................................................................................................450
Checklist for Using Client Certificates.............................................................................450
Certificate Mapping..........................................................................................................451
Ports and Certificate Mappings................................................................................451
Importing a Certificate (Client or CA Signing Certificate) and Mapping It to a
User.......................................................................................................................... 452
Changing a Certificate Mapping...............................................................................453
Client Certificates and Port Configuration....................................................................... 454
HTTPS Ports............................................................................................................ 454
FTPS Ports...............................................................................................................455
Using Multiple Client Certificates............................................................................................456
Checklist for Presenting Multiple Client Certificates........................................................456
Importing Certificates.......................................................................................................457
Setting Up a Remote Server Alias..................................................................................457
Coding Your Flow Services............................................................................................. 458
Client Authentication and Access Control.............................................................................. 458
Accessing Integration Server Data through My webMethods................................................ 459
Configuring the MWS Single Sign-On Resource Setting................................................ 459
Customizing Authentication Using JAAS................................................................................. 461
Overview................................................................................................................................. 462
Using JAAS with Integration Server....................................................................................... 462
JAAS Configuration File......................................................................................................... 462
Pre-installed Login Modules............................................................................................ 463
X509ValidatorModule.......................................................................................................464
Pluggable Authentication Modules (PAMs)............................................................................ 464
Writing a Custom JAAS Login Module for Integration Server................................................ 465
Extend SagAbstractLoginModule.................................................................................... 465
Implement Commit()........................................................................................................ 466
Place the JAR File in the Integration Server Classpath..................................................466
Modify the JAAS Configuration File................................................................................ 466
JAAS Custom Login Module Example................................................................................... 467
JAAS Login Module for Integration Server: Sample Code..............................................467
JAAS Custom Login Module: Code Explanation.............................................................468
JAAS Configuration File: Sample Module....................................................................... 469
Master Passwords and Outbound Passwords......................................................................... 471
Overview................................................................................................................................. 472
Managing Outbound Passwords............................................................................................ 473
Backing Up Outbound Password and Master Password Files...............................................474
Changing the Master Password............................................................................................. 474
Changing the Expiration Interval for the Master Password.................................................... 475
webMethods Integration Server Administrators Guide Version 9.10

13

M
Table of Contents

About the configPassman.cnf File..........................................................................................475

Working with Outbound Password Settings........................................................................... 476
Controlling Name and Location of Outbound Password File.......................................... 476
Controlling Encryption of Outbound Password File.........................................................477
Working with Master Password Settings................................................................................477
Storing the Master Password in a File............................................................................477
Prompting for the Master Password at Server Initialization............................................ 478
What to Do if You Lose or Forget Your Master Password..................................................... 479
When Problems Exist with the Master Password or Outbound Passwords at Startup........... 480
Determining Whether You Can Restore the Passwords................................................. 480
Restoring the Master Password and Outbound Password Files.....................................481
Resetting the Master Password and Outbound Passwords............................................482
E-mail Listeners and Package Replication.............................................................................483
Securing Integration Server with CSRF Guard.........................................................................485
What is CSRF?.......................................................................................................................486
How Does Integration Server Prevent CSRF Attacks?.......................................................... 486
Understanding CSRF Guard Terminology..............................................................................486
Configuring CSRF Guard in Integration Server......................................................................488
Limitations when Configuring CSRF Guard in Integration Server.......................................... 490
Configuring webMethods Enterprise Gateway......................................................................... 493
Overview................................................................................................................................. 494
How Enterprise Gateway Works............................................................................................ 494
Enterprise Gateway Ports............................................................................................... 495
Enterprise Gateway Rules and Alerts............................................................................. 496
About Enterprise Gateway Rules.............................................................................496
About Enterprise Gateway Alerts.............................................................................497
Version Interoperability Between Enterprise Gateway Server and Internal Server.................498
Advantages of Enterprise Gateway over Traditional Third-Party Proxy Servers.................... 499
About Denial of Service Protection........................................................................................ 500
About Trusted IP Addresses........................................................................................... 500
About Mobile Application Protection.......................................................................................501
About Mobile Data Synchronization....................................................................................... 501
About SQL Injection Protection.............................................................................................. 502
About Antivirus Scan Filter.....................................................................................................502
About Custom Filter................................................................................................................503
Clustering in the Enterprise Gateway Configuration.............................................................. 504
Setting Up an Enterprise Gateway.........................................................................................505
Configuring the Enterprise Gateway Ports.............................................................................506
Deleting Enterprise Gateway External and Registration Ports........................................511
Connecting Your Internal Server to an Enterprise Gateway Server....................................... 512
Viewing Connections to the Enterprise Gateway Registration Port........................................516
Performing Client Authentication on Enterprise Gateway Server...........................................516
Working with Enterprise Gateway Rules................................................................................517
Creating an Enterprise Gateway Rule............................................................................ 517
webMethods Integration Server Administrators Guide Version 9.10

14

M
Table of Contents

Enabling an Enterprise Gateway Rule............................................................................ 522

Disabling an Enterprise Gateway Rule........................................................................... 523
Editing an Enterprise Gateway Rule............................................................................... 523
Copying an Enterprise Gateway Rule.............................................................................523
Changing the Priority of an Enterprise Gateway Rule.................................................... 524
Deleting an Enterprise Gateway Rule.............................................................................524
Specifying Alert Options......................................................................................................... 525
Specifying Default Alert Options..................................................................................... 525
Specifying Rule-Specific Alert Options............................................................................526
Preventing Denial of Service Attacks..................................................................................... 527
Limiting Requests Globally..............................................................................................527
Limiting Requests by IP Address....................................................................................528
Controlling Use of Mobile Applications...................................................................................529
Frequently Asked Questions about Enterprise Gateway........................................................531
Configuring OAuth.......................................................................................................................535
What Is OAuth?...................................................................................................................... 536
Using OAuth with Integration Server......................................................................................537
Integration Server as an OAuth Client............................................................................ 537
Integration Server as an Authorization Server................................................................ 537
Integration Server as a Resource Server........................................................................537
Authorization Grant Types Supported by Integration Server..................................................538
Authorization Code Grant................................................................................................538
Implicit Grant................................................................................................................... 540
The Integration Server OAuth Services................................................................................. 542
Important Considerations for Using OAuth Features............................................................. 543
Configuring the Authorization Server..................................................................................... 543
Configuring OAuth Settings.............................................................................................544
Defining Clients............................................................................................................... 546
Registering Clients................................................................................................... 546
Enabling and Disabling Clients................................................................................ 549
Editing Clients.......................................................................................................... 550
Deleting Clients........................................................................................................ 550
Defining Scopes.............................................................................................................. 550
Adding a Scope........................................................................................................551
Editing Scopes......................................................................................................... 551
Deleting Scopes....................................................................................................... 552
Associating Scopes and Clients......................................................................................552
Adding Associations Between Clients and Scopes..................................................553
Removing Client and Scope Associations............................................................... 554
Viewing Associations Between Clients and Scopes................................................ 555
Viewing and Deleting Tokens.......................................................................................... 556
Viewing Tokens.........................................................................................................556
Deleting Tokens........................................................................................................556
Customizing the Approval Page......................................................................................557

webMethods Integration Server Administrators Guide Version 9.10

15

M
Table of Contents

About Using Integration Server as the Resource Server....................................................... 557

Configuring a Central User Directory or LDAP........................................................................ 559
Before You Begin....................................................................................................................560
Overview of How Integration Server Works with Externally Defined Users and Groups........ 560
How the Server Uses Externally Defined Users and Groups..........................................561
When the Server Accesses Externally Defined Information............................................561
How Integration Server Authenticates Externally Defined Clients...................................561
Configuring Central User Management..................................................................................562
Requirements for Central User Management................................................................. 563
Considerations for My webMethods Server Query Roles............................................... 563
Overview of Using LDAP........................................................................................................564
About LDAP and Caching............................................................................................... 564
Configuring the Server to Use LDAP..................................................................................... 565
Defining an LDAP Directory to Integration Server.......................................................... 567
Mapping an LDAP User's Access to ACLs..................................................................... 571
Stopping Use of an LDAP as an External Directory....................................................... 571
Considerations for User Accounts and Groups......................................................................572
About Keeping Internal and External User Accounts and Group Names Unique............572
About User Groups and Package Replication................................................................ 573
About Granting Administrator Privileges to External Users....................................................573
Granting Administrator Privileges to an Externally Defined User.................................... 574
Granting Developer Privileges to External Users...................................................................575
Granting Access to Services and Files to External Users......................................................576
Managing Packages.....................................................................................................................579
Using Packages......................................................................................................................580
Predefined Packages.......................................................................................................580
The Package Repository................................................................................................. 584
Sample Package............................................................................................................. 584
How the Server Stores Package Information.........................................................................585
Manifest File.................................................................................................................... 587
Finding Information about Your Packages............................................................................. 587
Viewing the Packages that Reside on Your Server........................................................ 589
Filtering the List of Packages...................................................................................589
Refining the Filtered Package List........................................................................... 590
Determining Whether the Server Successfully Loaded the Package.......................590
Determining Whether the Package Is Enabled or Disabled.....................................591
Displaying Information about a Package........................................................................ 592
Package Information.................................................................................................592
Displaying Information about Services and Folders in a Package.................................. 594
Displaying Documentation for a Package....................................................................... 594
Accessing a Web Document for a Package............................................................ 595
Working with Packages.......................................................................................................... 595
Creating a Package.........................................................................................................596
Activating a Package.......................................................................................................597
webMethods Integration Server Administrators Guide Version 9.10

16

M
Table of Contents

Reloading a Package...................................................................................................... 597

Enabling a Package........................................................................................................ 598
Disabling a Package........................................................................................................598
Deleting a Package......................................................................................................... 599
Recovering a Package.................................................................................................... 599
Archiving a Package........................................................................................................600
Copying Packages from One Server to Another....................................................................600
Overview of Package Replication................................................................................... 601
Version Checking.............................................................................................................605
Who Can Subscribe?............................................................................................... 606
Guidelines for Using Package Replication...............................................................607
The Publishing Server..................................................................................................... 608
Displaying Subscribers for a Specific Package........................................................608
Displaying Subscribers for all Packages..................................................................608
Adding Subscribers from a Publishing Server......................................................... 609
Updating Subscriber Information..............................................................................610
Removing Subscribers for a Package......................................................................611
Publishing a Package...............................................................................................612
Creating a Release........................................................................................... 613
Sending a Release............................................................................................613
Specifying File and Version Information for a Release or Archive.................................. 613
The Subscribing Server...................................................................................................617
Displaying Packages to Which Your Server Subscribes.......................................... 618
Manually Pulling a Package.....................................................................................618
Subscribing to a Package from a Subscribing Server............................................. 619
Requesting a Subscription to a Package from Another Server.........................619
Updating Your Subscription Information...................................................................621
Canceling a Subscription......................................................................................... 624
About Installing Packages Published by Another Server.........................................624
Installing a Package Published by Another Server...........................................625
Using a Package Class Loader..............................................................................................626
Hot Deployment of Packages.................................................................................................627
How Hot Deployment Works........................................................................................... 627
Determining Package Dependencies during Hot Deployment................................. 628
Limitations When Hot Deploying the Packages.............................................................. 628
Configuring the Hot Deployment Settings.......................................................................629
Managing Services...................................................................................................................... 631
About Services........................................................................................................................632
Fully Qualified Service Names............................................................................................... 632
Package Names and Service Names............................................................................. 633
HTTP URL Aliases for Services......................................................................................633
Finding Information about Services and Folders....................................................................634
Listing Folders and Services........................................................................................... 634
Displaying Information about a Service.......................................................................... 634

webMethods Integration Server Administrators Guide Version 9.10

17

M
Table of Contents

Service Information...................................................................................................635
Manually Adding a Service to the Server...............................................................................636
Testing Services......................................................................................................................636
Canceling and Killing Threads Associated with a Service..................................................... 637
Canceling or Killing a Thread..........................................................................................637
Running Services When Packages Are Loaded, Unloaded, or Replicated............................ 638
What Is a Startup Service?............................................................................................. 639
What Is a Shutdown Service?.........................................................................................639
What Is a Replication Service?.......................................................................................639
Guidelines for Using Startup, Shutdown, and Replication Services................................640
Running Services in Response to Specific Events................................................................ 640
Managing Global Variables.....................................................................................................640
Creating a Global Variable.............................................................................................. 641
Deleting Global Variables................................................................................................ 642
Scheduling Services....................................................................................................................643
Overview................................................................................................................................. 644
Tasks Provided by Integration Server............................................................................. 644
Scheduling a User Task......................................................................................................... 644
Viewing Scheduled User Tasks.............................................................................................. 649
Filtering the List of Scheduled Tasks.............................................................................. 650
Updating Scheduled User Tasks............................................................................................ 651
Suspending User Tasks..........................................................................................................651
Suspending a Single User Task......................................................................................651
Suspending All User Tasks............................................................................................. 652
Resuming Suspended User Tasks......................................................................................... 652
Resuming a Suspended User Task.................................................................................652
Resuming All Suspended User Tasks.............................................................................653
Canceling a Scheduled User Task......................................................................................... 654
Viewing the Scheduled System Tasks................................................................................... 654
Simple Repeating Option........................................................................................................654
Complex Repeating Option.................................................................................................... 656
Target Node Options...............................................................................................................660
Tasks in a Clustered Environment.................................................................................. 661
How Transitioning to or from Daylight Savings Time Affects Scheduled Tasks......................662
Caching Service Results.............................................................................................................665
What Is Caching?................................................................................................................... 666
When Are Cached Results Returned?................................................................................... 666
Resetting the Cache...............................................................................................................668
Resetting the Cache for All Services.............................................................................. 668
Resetting the Cache for a Specific Service.................................................................... 668
Monitoring Service Cache Usage...........................................................................................669
Changing the Service Results Cache to Return a Value Instead of a Reference...................669
Configuring Guaranteed Delivery...............................................................................................671

webMethods Integration Server Administrators Guide Version 9.10

18

M
Table of Contents

About Guaranteed Delivery.................................................................................................... 672

Configuring the Server for Guaranteed Delivery.................................................................... 673
Settings Shared by Both Inbound and Outbound Transactions...................................... 673
Settings for Inbound Transactions...................................................................................674
Settings for Outbound Transactions................................................................................675
Specifying an E-Mail Address and SMTP Server for Error Messages............................ 676
Using Guaranteed Delivery with Multiple Servers that Share an ISInternal Database.... 677
Administering Guaranteed Delivery........................................................................................677
Shutting Down Guaranteed Delivery...............................................................................677
Reinitializing Guaranteed Delivery.................................................................................. 678
Reinitializing Guaranteed Delivery for Inbound Transactions.................................. 678
Reinitializing Guaranteed Delivery for Outbound Transactions................................678
Configuring Ehcache on Integration Server............................................................................. 681
What is Ehcache?.................................................................................................................. 682
Caching Configurations.......................................................................................................... 682
On-Heap Cache...............................................................................................................683
Local Disk Store.............................................................................................................. 683
BigMemory.......................................................................................................................684
Terracotta Server Array................................................................................................... 685
Understanding Caches and Cache Managers....................................................................... 687
System Caches............................................................................................................... 688
Cache Manager Configuration Files.......................................................................................688
Specifying the Parameters for a Cache.......................................................................... 689
Dynamic vs. Non-Dynamic Cache Parameters........................................................689
Installing, Viewing, and Changing the Terracotta License......................................................690
Determining if You Have a Terracotta License................................................................691
Adding a Terracotta License............................................................................................691
Configuring an On-Heap Cache............................................................................................. 691
Considerations for Configuring On-Heap Cache.............................................................692
Configuring a BigMemory Cache........................................................................................... 693
Allocating Direct Memory Space to Integration Server................................................... 694
Considerations for Configuring BigMemoryCache.......................................................... 695
Configuring a Distributed Cache............................................................................................ 696
Configuring tc-config.xml on the Terracotta Server Array............................................... 699
Considerations for Configuring a Distributed Cache....................................................... 700
Cache-Wide and Client-Specific Parameters for a Distributed Cache............................ 701
Cache-Wide Parameters.......................................................................................... 701
Client-Specific Parameters....................................................................................... 702
The Rejoin Behavior of a Distributed Cache...................................................................703
The Nonstop Behavior of a Distributed Cache............................................................... 704
Making a Cache Searchable.................................................................................................. 705
Defining Attributes........................................................................................................... 706
Extracting Attributes by Class.................................................................................. 707
Working with Cache Managers.............................................................................................. 708

webMethods Integration Server Administrators Guide Version 9.10

19

M
Table of Contents

Creating a Cache Manager.............................................................................................708

Viewing or Modifying a Cache Manager......................................................................... 709
Shutting Down a Cache Manager................................................................................... 709
Starting a Cache Manager.............................................................................................. 710
Reloading a Cache Manager.......................................................................................... 710
Deleting a Cache Manager............................................................................................. 711
Reinitializing a Cache Manager...................................................................................... 711
Adding a Cache Manager Configuration File to Integration Server.................................712
Manually Editing a Cache Manager Configuration File...................................................713
Working with Caches..............................................................................................................715
Creating a Cache............................................................................................................ 715
Viewing or Modifying Cache Settings............................................................................. 726
Modifying Settings for a Distributed Cache.....................................................................727
Disabling a Cache........................................................................................................... 727
Enabling a Cache............................................................................................................728
Clearing a Cache.............................................................................................................728
Deleting a Cache.............................................................................................................729
Logging Ehcache Activity....................................................................................................... 729
Logging Ehcache Caching Services............................................................................... 730
Logging Cache Manager Activity in the Terracotta Server Array.................................... 730
Configuring the Enhanced XML Parser.....................................................................................731
What Is the Enhanced XML Parser?..................................................................................... 732
How Does the Enhanced XML Parser Work?........................................................................732
When Is the Enhanced XML Parser Used?........................................................................... 734
What Services Consume an Enhanced Node?...............................................................735
Configuring the Enhanced XML Parser..................................................................................735
Setting the Partition Size........................................................................................................738
Viewing Peak Usage Statistics...............................................................................................739
Locking Administration and Best Practices............................................................................. 741
Introduction............................................................................................................................. 742
Choosing Local Server Locking or VCS Integration Locking................................................. 742
Disabling and Re-enabling Locking........................................................................................742
Disabling Locking............................................................................................................ 743
Re-Enabling Locking........................................................................................................743
Best Practices.........................................................................................................................744
Remote Server Configuration..........................................................................................744
Server User Names.........................................................................................................744
Package Replication and Publishing...............................................................................744
Package and Folder Organization...................................................................................745
Source Code....................................................................................................................745
Upgrading webMethods Integration Server.....................................................................745
Managing webMethods Messaging Triggers............................................................................ 747
Introduction............................................................................................................................. 748

webMethods Integration Server Administrators Guide Version 9.10

20

M
Table of Contents

Managing Document Retrieval............................................................................................... 748

Increasing or Decreasing Threads for Document Retrieval from webMethods Broker.... 749
When to Increase or Decrease Threads for Retrieving Documents from webMethods
Broker....................................................................................................................... 750
Decreasing the Capacity of Trigger Queues...................................................................751
Decreasing the Capacity and Refill Level for webMethods Messaging Triggers...... 751
Suspending and Resuming Document Retrieval............................................................ 753
About Suspending and Resuming Document Retrieval for All Triggers................... 753
Suspending or Resuming Document Retrieval for All webMethods Messaging
Triggers..............................................................................................................754
About Suspending and Resuming Document Retrieval for a Specific Trigger..........755
Suspending or Resuming Document Retrieval for a webMethods Messaging
Trigger............................................................................................................... 756
Managing Document Processing............................................................................................757
Increasing or Decreasing Threads for Processing Documents Received by webMethods
Messaging Triggers......................................................................................................... 758
When to Increase or Decrease Threads for Processing Documents....................... 759
Decreasing Document Processing for Concurrent Triggers............................................ 759
Decreasing Execution Threads for Concurrent webMethods Messaging Triggers...760
Suspending and Resuming Document Processing......................................................... 761
About Suspending and Resuming Document Processing for all Triggers................762
Suspending or Resuming Document Processing for All webMethods Messaging
Triggers..............................................................................................................762
About Suspending and Resuming Document Processing for Specific Triggers....... 764
Suspending or Resuming Document Processing for a Specific webMethods
Messaging Trigger.............................................................................................764
Limiting Server Threads for webMethods Messaging Triggers.............................................. 766
Setting the Maximum Number of Server Threads for webMethods Messaging
Triggers............................................................................................................................ 766
Cluster Synchronization for webMethods Messaging Trigger Management...........................768
Configuring Cluster Synchronization............................................................................... 768
Cluster Synchronization at Run Time..............................................................................768
Monitoring Cluster Synchronization.................................................................................770
Modifying webMethods Messaging Trigger Properties...........................................................770
Managing Trigger Service Retries and Shutdown Requests..................................................772
Delaying Polling Requests for webMethods Messaging Triggers.......................................... 774
How Integration Server Delays a Polling Request for a webMethods Messaging
Trigger..............................................................................................................................775
Serial Triggers Migrated to Integration Server 9.9 or Later from 9.8 or Earlier.......................777
Synchronizing the webMethods Messaging Trigger and Named Object on Universal
Messaging........................................................................................................................778
Managing JMS Triggers.............................................................................................................. 781
Introduction............................................................................................................................. 782
Enabling, Disabling, and Suspending JMS Triggers.............................................................. 782

webMethods Integration Server Administrators Guide Version 9.10

21

M
Table of Contents

Configuring Integration Server to Enable JMS Triggers Automatically after a Consumer

Error................................................................................................................................. 785
Controlling Thread Usage for JMS Triggers...........................................................................785
Viewing Thread Usage for JMS Triggers........................................................................ 785
Throttling Thread Usage for JMS Triggers......................................................................786
Establishing a Threshold for Using Multiple Threads with a Concurrent JMS Trigger..... 787
Configuring Integration Server Session Reuse...................................................................... 788
Configuring JMS Session Reuse............................................................................................789
Delaying Polling Requests for Concurrent JMS Triggers....................................................... 789
How JMS Trigger Delays a Polling Request...................................................................790
Examples of Extended Polling Delay Configuration.................................................792
About WS Endpoint Triggers..................................................................................................792
Editing WS Endpoint Triggers......................................................................................... 793
Using a Document History Database with Exactly-Once Processing.................................... 797
Overview................................................................................................................................. 798
Removing Expired Entries from the Document History Database..........................................798
Clearing Expired Entries from the Document History Database..................................... 798
Viewing Exactly-Once Processing Statistics.......................................................................... 799
Clearing Exactly-Once Processing Statistics..........................................................................799
Using Integration Server to Manage XA Transactions.............................................................801
Overview of XA Transaction Management.............................................................................802
How the Integration Server Persists the State of a Transaction..................................... 802
How the Integration Server Resolves Uncompleted Transactions.................................. 803
About Unresolved XA Transactions................................................................................ 804
Details for an Unresolved XA Transaction...................................................................... 806
Configuring XA Options in Integration Server........................................................................ 807
Enabling or Disabling XA Transaction Recovery............................................................ 808
Configuring the XA Recovery Store................................................................................ 808
Configuring XA Server Parameters.................................................................................809
Manually Resolving a Transaction..........................................................................................810
Content Handlers......................................................................................................................... 813
How the Server Uses Content Handlers................................................................................ 814
How the Server Chooses a Content Handler for an HTTP Request...................................... 814
How the Server Chooses a Content Handler for an FTP Request........................................ 814
Content Handlers for HTTP and FTP Requests.................................................................... 814
About Content Handlers for HTTP Responses...................................................................... 819
Accept Header Field........................................................................................................819
About Content Handlers for FTP Responses.........................................................................820
Quiescing the Server for Maintenance......................................................................................821
Overview................................................................................................................................. 822
What Happens when Integration Server Enters Quiesce Mode?....................................822
What Tasks Can You Perform in Quiesce Mode?...........................................................824

webMethods Integration Server Administrators Guide Version 9.10

22

M
Table of Contents

What Happens when Integration Server Exits Quiesce Mode?...................................... 824

Specifying the Quiesce Port...................................................................................................825
Quiescing Integration Server.................................................................................................. 825
Starting the Server in Quiesce Mode from the Command Prompt..................................826
Quiescing an Active Server from Integration Server Administrator................................. 827
Restarting a Server in Quiesce Mode from Integration Server Administrator..................828
Exiting Quiesce Mode.............................................................................................................829
Deploying Quiesce Mode Configuration.................................................................................829
Diagnosing the Integration Server.............................................................................................831
Introduction............................................................................................................................. 832
Configuring the Diagnostic Port..............................................................................................832
Diagnostic Thread Pool Configuration.............................................................................832
Diagnostic Port Access................................................................................................... 833
Using the Diagnostic Utility.................................................................................................... 833
Diagnostic Utility Performance........................................................................................ 834
Running the Diagnostic Utility from Integration Server Administrator..............................834
Running the Diagnostic Utility Service............................................................................ 835
Starting the Integration Server in Safe Mode.........................................................................836
Starting Integration Server in Safe Mode........................................................................836
When the Server Automatically Places You in Safe Mode.....................................................837
Generating Thread Dumps..................................................................................................... 838
Generating a Dump of an Individual Thread...................................................................839
Generating a Dump of the JVM...................................................................................... 840
Integration Server Deployment Checklist................................................................................. 841
Introduction............................................................................................................................. 842
Stage 1: Installation................................................................................................................842
Stage 2: Basic Configuration..................................................................................................843
Stage 3: Setting Up Users, Groups, and ACLs......................................................................844
Stage 4: Publishing Packages................................................................................................845
Stage 5: Installing Run-Time Classes.................................................................................... 846
Stage 6: Preparing Clients for Communication with the Server............................................. 847
Stage 7: Setting Up Security..................................................................................................847
Stage 8: Startup and Test...................................................................................................... 849
Stage 9: Archive Sources.......................................................................................................850
Server Configuration Parameters...............................................................................................851
Introduction............................................................................................................................. 852
watt.art.................................................................................................................................... 852
watt.broker...............................................................................................................................853
watt.brokerCoder.....................................................................................................................853
watt.cachedirective..................................................................................................................854
watt.cds................................................................................................................................... 854
watt.config............................................................................................................................... 855
watt.core..................................................................................................................................855

webMethods Integration Server Administrators Guide Version 9.10

23

M
Table of Contents

watt.debug...............................................................................................................................860
watt.debug2.............................................................................................................................862
watt.infradc..............................................................................................................................862
watt.net....................................................................................................................................863
watt.security.............................................................................................................................874
watt.server...............................................................................................................................879
watt.ssl.................................................................................................................................... 973
watt.ssh................................................................................................................................... 974
watt.wm.tnextdc...................................................................................................................... 975
watt.tx......................................................................................................................................975
watt.xslt................................................................................................................................... 976
FIPS 140-2 Compliance............................................................................................................... 979
FIPS 140-2 Compliance......................................................................................................... 980
Using NTLM Authentication and Integrated Windows Authentication with Integration
Server............................................................................................................................................ 981
Overview................................................................................................................................. 982
Using NTLM Authentication when Integration Server Acts as the Client............................... 982
Working with Integrated Windows Authentication.................................................................. 982
Activating and Deactivating Integrated Windows Authentication............................................983
Activating Integrated Windows Authentication................................................................ 983
Deactivating Integrated Windows Authentication............................................................ 984
Wireless Communication with the Integration Server............................................................. 985
Overview................................................................................................................................. 986
How Does the Integration Server Communicate with Wireless Devices?.............................. 986
Using URLs for Wireless Access to the Integration Server....................................................988
Invoking a Service with a URL........................................................................................988
Requesting a WML or HDML Page with a URL............................................................. 989
WML and HDML Samples......................................................................................................990
Debugging Service Exceptions Using the Error Log...............................................................993
Introduction............................................................................................................................. 994
Controlling the Level of Exception Logging Detail................................................................. 994
Displaying the Error Log.........................................................................................................994
Interpreting the Error Log....................................................................................................... 995
Understanding the Service Stack....................................................................................995
Understanding the Error Messages................................................................................ 997
Understanding the Stack Trace.......................................................................................997
Server Log Facilities....................................................................................................................999
About Server Log Facilities.................................................................................................. 1000
Integration Server................................................................................................................. 1000
WmMobileSupport Package................................................................................................. 1007
WmXSLT Package................................................................................................................1008
Flat File................................................................................................................................. 1008
webMethods Integration Server Administrators Guide Version 9.10

24

M
Table of Contents

Mediator................................................................................................................................ 1008
Index............................................................................................................................................ 1011

webMethods Integration Server Administrators Guide Version 9.10

25

Even Header

webMethods Integration Server Administrators Guide Version 9.10

26

Odd Header

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, conguring the server, seing up user accounts and
security, and managing packages and services.
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 Integration Server Administrator.

Document Conventions
Convention

Description

Bold

Identies elements on a screen.

Narrowfont

Identies storage locations for services on webMethods

Integration Server, using the convention folder.subfolder:service .

UPPERCASE

Identies keyboard keys. Keys you must press simultaneously

are joined with a plus sign (+).

Italic

Identies variables for which you must supply values specic to

your own situation or environment. Identies new terms the rst
time they occur in the text.

Monospace
font

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

webMethods Integration Server Administrators Guide Version 9.10

27

Even Header

Convention

Description

[]

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

Online Information
SoftwareAG Documentation Website
You can nd documentation on the Software AG Documentation website at hp://
documentation.softwareag.com. The site requires Empower credentials. If you do not
have Empower credentials, you must use the TECHcommunity website.
Software AG Empower Product Support Website
You can nd product information on the Software AG Empower Product Support
website at hps://empower.softwareag.com.
To submit feature/enhancement requests, get information about product availability,
and download products, go to Products.
To get information about xes and to read early warnings, technical papers, and
knowledge base articles, go to the Knowledge Center.
Software AG TECHcommunity
You can nd documentation and other technical information on the Software AG
TECHcommunity website at hp://techcommunity.softwareag.com. You can:
Access product documentation, if you have TECHcommunity credentials. If you do
not, you will need to register and specify "Documentation" as an area of interest.
Access articles, code samples, demos, and tutorials.
Use the online discussion forums, moderated by Software AG professionals, to
ask questions, discuss best practices, and learn how other customers are using
Software AG technology.
Link to external websites that discuss open standards and web technology.

webMethods Integration Server Administrators Guide Version 9.10

28

Odd Header
The Role of the Administrator

1 The Role of the Administrator

What Does an Administrator Do? ................................................................................................

30

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

30

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

31

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

31

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

31

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

32

webMethods Integration Server Administrators Guide Version 9.10

29

Even Header
The Role of the Administrator

What Does an Administrator Do?

In an IS environment, the administrator is responsible for installing, conguring, 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 Responsibilities

If you are the webMethodsIntegration Server administrator for your site, you might be
involved in some or all of the following activities.
Installing and upgrading the 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 shuing down the server when
necessary (e.g., for routine maintenance or reconguration) 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 "Starting and Stopping the Server" on page 53.
Configuring server settings, which includes seing basic operating parameters such as
the maximum session limits, log le options, and port assignments. For information
about these activities, see "Conguring the Server" on page 107.
Administering users and groups, which includes dening user names and passwords for
authorized users and assigning them to groups. For information about this task, see
"Managing Users and Groups" on page 89. Alternatively, you can congure the
server to acquire user and group information from an external system (e.g., LDAP).
For more information, see "Conguring a Central User Directory or LDAP" on page
559.
Administering server security, which includes identifying other administrators,
assigning access controls to individual services, and conguring the server's use
of digital certicates. For more information about this task, see "Customizing
Authentication Using JAAS" on page 461, "Securing Communications with the
Server" on page 401, "Customizing Authentication Using JAAS" on page 461,
and "Securing Communications with the Server" on page 401.
Managing packages and services, which includes tasks such as activating/deactivating/
copying packages and updating services and/or packages as necessary. For more
information about this task, see "Managing Packages" on page 579 and "Managing
Services" on page 631.
Administering multiple instances of the server, which includes performing all or some of
the activities listed above to manage two or more Integration Servers running on the

webMethods Integration Server Administrators Guide Version 9.10

30

Odd Header
The Role of the Administrator

same machine. For more information about running multiple instances of Integration
Server on the same machine, see "Running Multiple Integration Server Instances" on
page 73.

The Integration Server Administrator

The 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 "Using the Integration Server Administrator " on
page 83.

Receiving Administrative Messages from the Server

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

The Administrator User

Every Integration Server is installed with a predened 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 Password

The predened password assigned to the Administrator user account is "manage."
Important: Change this password immediately after installing the webMethods
Integration Server. Otherwise, your server will be vulnerable to anyone who
knows the default password that webMethods installs on its servers.
When assigning a password, make it something that is dicult to guess. For example,
make it a mixture of upper- and lowercase leers, numbers, and special characters.
Passwords cannot be null values or empty strings. 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.

webMethods Integration Server Administrators Guide Version 9.10

31

Even Header
The Role of the Administrator

Important: Change the predened passwords for the Developer and Replicator accounts
as well. The predened password for the Developer account is "isdev". The
predened password for the Replicator account is "iscopy."
For instructions on changing a password, see "Adding an Administrator User" on page
94.

Adding Backup Administrators

It 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 "Managing Users and Groups" on page 89.
Note:

If you use an external directory for user and group information, see "About
Granting Administrator Privileges to External Users" on page 573 for
information about adding administrators.

webMethods Integration Server Administrators Guide Version 9.10

32

Odd Header
An Overview of the Server

2 An Overview of the Server

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

34

Architecture ..................................................................................................................................

35

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

39

How the Server Loads Java Classes ..........................................................................................

40

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

50

Logging .........................................................................................................................................

51

Caching ........................................................................................................................................

51

webMethods Integration Server Administrators Guide Version 9.10

33

Even Header
An Overview of the Server

The Role of the Server

The webMethods Integration Server hosts packages that contain services and related
les. The Integration Server comes with core Integration Server packages. For example,
all Integration Server instances include 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.
webMethods Integration Server provides an environment for the orderly, ecient, and
secure execution of services. It decodes client requests, identies 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, veries that they are authorized to execute
the requested service, maintains audit-trail logs, and promotes throughput using
facilities such as service result caching.

About Integration Server Instances

webMethods Integration Server allows you to create and run multiple instances
of the server on one machine. When you install webMethods Integration Server,
you specify a name for the initial instance. The default name of the initial
instance is default. The Software AG installer creates the instance under the
Software AG_directory\IntegrationServer\instances directory. You can create additional
instances of Integration Server using the scripts provided by Integration Server or
through Software AG Command Central.
Each instance has a home directory under Software AG_directory\IntegrationServer
\instances that contains its own packages, conguration les, log les, and updates.
You administer and apply packages and updates to each Integration Server instance
separately. You can apply the latest xes using the Software AG Update Manager.
The Software AG_directory\IntegrationServer directory is the parent directory for
all server instances you create. It contains common and shared les that all server
instances use, such as common jar les and xes. For information about creating and
running multiple Integration Server instances, see "Running Multiple Integration Server
Instances" on page 73.
Note:

Unless otherwise specied, the terms Integration Server and the server in
this guide refer to an Integration Server instance.

webMethods Integration Server Administrators Guide Version 9.10

34

Odd Header
An Overview of the Server

Architecture
The 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.
Most clients use an HTTP or HTTPS port for communication with the server. 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.
Note:

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

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 le 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 dene as many ports as you want on each Integration Server instance. The
default sever instance has an HTTP port at 5555.
Note:

The default server instance also denes a diagnostic port 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 "Diagnosing the Integration Server " on page 831.

webMethods Integration Server Administrators Guide Version 9.10

35

Even Header
An Overview of the 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 runs on a Windows system, this is not a problem. However, if your Integration
Server runs on a UNIX system, using a port number below 1024 requires that the server
run as "root." For security reasons, Software AG discourages this practice. Instead,
run your Integration Server using an unprivileged user ID on a high number port
(for example 1024 or above) and use the port remapping capabilities present in most
rewalls to move requests to the higher numbered ports.

webMethods Integration Server Administrators Guide Version 9.10

36

Odd Header
An Overview of the Server

Services
Client requests involve executing one or more services. The server maintains
successfully loaded services as runnable objects within the server's program space.
When you initialize the server, the server loads the services that are contained in enabled
packages into memory. When you or another administrator enable a disabled package,
the server loads services that are in that package.
Services Execute within the Integration Server's Virtual Machine

When a client invokes a service, that service runs as a thread within the Integration
Server program. Depending on what function the service is to accomplish, it can also
create additional threads to perform tasks simultaneously.

Retrieving Data for Services

Tasks that services perform often include retrieving data from data sources. The server
can retrieve data (for example, XML and HTML data) from local data sources or by
issuing HTTP, HTTPS, FTP, FTPS, e-mail, or le polling requests to resources such as
web servers and JDBC-enabled databases.

webMethods Integration Server Administrators Guide Version 9.10

37

Even Header
An Overview of the Server

There are a number of methods you can use to send les from a client to the Integration
Server. The Integration Server provides the following automated mechanisms:
Post a le to a service via HTTP or HTTPS.
FTP a le to a service.
Submit a le to a service via a le polling port.
E-mail a le to a service as an aachment.
Note:

If you use Trading Networks, you can send some les, specically at les,
directly to Trading Networks. For more information about how Trading
Networks processes at les, see the "Dening and Managing Flat File
Document Types" chapter in webMethods Trading Networks Administrators
Guide.

When a client submits a le to the Integration Server, the server uses the appropriate
content handler to parse the contents of the le and pass them to the target service.
For all transmission methods except le polling, the client species the service to be
executed. For le polling, the server always executes the service associated with the le
polling port.
For more information about sending and receiving XML les, see webMethods Service
Development Help. For more information about sending and receiving at les, see the
Flat File Schema Developers Guide. Refer to the webMethods Integration Server Built-In
Services Reference for information about services you can invoke from the service you
write.
When the server uses HTTP or HTTPS to access data from external data sources, you can
optionally route the requests through a proxy server.

webMethods Integration Server Administrators Guide Version 9.10

38

Odd Header
An Overview of the Server

The Server Gets Data from Local Resources or Resources on the Internet

How the Server Executes Services

When the Integration Server receives a request from a client, it performs the following
actions:
1. The server authenticates the client.
2. If a session already exists for the client, the server uses the existing session. If one
does not exist, the server creates a session.
3. The server determines the content-type of the service request so it can prepare data
for the requested service.
4. The server uses the supplied service name to look up the service.

webMethods Integration Server Administrators Guide Version 9.10

39

Even Header
An Overview of the Server

5. The server determines whether access to the requested service is being controlled
based on the port on which the request came in. If there is no restriction, the server
continues with the execution of the service.
6. The server looks up the Access Control List (ACL) for the service and determines
whether the client is to be granted access to the service. If the ACL indicates that the
client is allowed to access the service, the server continues with the execution of the
service.
7. If auditing is enabled, the server adds an entry to the Audit Log to mark the start of
the request.
8. The server starts gathering service statistics for the service.
9. The server checks to see if the results for this service are in the service-results cache.
If service results are cached and the inputs for the cached results match the inputs
for this request, the server returns the cached results. If matching results are not
cached, the server invokes the service. If the service is a ow service, which can
consist of several services, it invokes each service in the ow.
Note:

For each service in a ow, the server performs steps 6 through 11.

10. The server ends the gathering of server statistics for the service.
11. If auditing is enabled, the server adds an entry to the Audit Log to mark the end of
the request.
12. The server encodes the service results as specied by the content type.
13. The server returns the results to the client.

How the Server Loads Java Classes

Integration Server runs in the Java Virtual Machine (JVM). When Integration Server, or
any Java application, needs access to a class, the JVM locates the executable bytecode
of the class and brings it into the JVM. This process is referred to as loading the class and
is handled by class loaders. The class loaders in Integration Server and the JVM are
designed to load classes from dierent locations, as described below.

Class Loaders
Integration Server employs two kinds of class loaders:
OSGi bundle class loader
Integration Server class loaders

webMethods Integration Server Administrators Guide Version 9.10

40

Odd Header
An Overview of the Server

OSGi Bundle Class Loader

The OSGi Bundle classloader is the parent classloader for Integration Server. This
class loader is provided by the OSGi framework (Eclipse Equinox) and shipped with
webMethods Integration Server.
By default, the OSGi Bundle classloader cannot access any jars specied in the
CLASSPATH environment variable or in some Java specic parameters (for example,
the -javaagent parameter). If you want to access jars specied in either the CLASSPATH
environment variable or a Java specic parameter, you must add the following entry in
the Software AG_directory\proles\IS_instance_name \cong.ini le as follows:
osgi.parentClassloader=app

Note:

After you add the osgi.parentClassloader property to the cong.ini le, you
must restart Integration Server.

Integration Server Class Loaders

These class loaders are provided as part of Integration Server. They load classes required
for Integration Server to function.
Integration Server Server Class Loader loads the classes that comprise the core of
Integration Server. This loader loads from the Server Classpath, which you can see on
the About page, and which is described below.
Integration Server Package Class Loaders load Integration Server packages. These
packages include those created by users through Designer and predened packages
that are provided as part of Integration Server. Each package has its own class
loader.
The following diagram shows the dierent class loaders and their relationship in the
class loader chain:

webMethods Integration Server Administrators Guide Version 9.10

41

Even Header
An Overview of the Server

Classpaths
Some class loaders rely on classpaths to tell them which directories to search when
looking for classes. A classpath is a list of directories to be searched. Integration Server
uses the Integration Server classpath.
The Integration Server About screen shows the directories that make up these
classpaths. The following image shows a portion of that display.

How the Integration Server Classpaths Are Specified

When you start Integration Server, a script le named startup.bat (on Windows)
or startup.sh (on Unix) runs. Among other things, the startup.bat/sh le builds an
Integration Server classpath variable, which consists of the following:
Directory or variable

Description

The wrapper.java.additional.202=

Variable dened in custom_wrapper.conf

that denes directories to prepend to the
beginning of the classpath.

-Dwatt.server.prepend.classes

property of the
Software AG_directory
/proles/
IS_instance_name /conguration/
custom_wrapper.conf

webMethods Integration Server Administrators Guide Version 9.10

42

Odd Header
An Overview of the Server

Directory or variable

Description

The wrapper.java.additional.203=

Variable dened in custom_wrapper.conf

that denes directories to append to the
end of the classpath.

-Dwatt.server.append.classes

property of the
Software AG_directory
/proles/
IS_instance_name /conguration/
custom_wrapper.conf

Software AG_directory\IntegrationServer The application.classpath property

\instances\instance_name \bin
from IntegrationServer\instances
\ini.cnf
\instance_name \bin\ini.cnf. This
typically species classes in the following
directories, in this order:
IntegrationServer\lib
SoftwareAG\common\lib
Software AG_directory\IntegrationServer All custom or third party .jar and .zip les
\instances\instance_name \lib\jars
in this directory.
\custom
Note:Use this directory to store your custom
or third party .jar and .zip les that
you want to make available to a server
specic instance.
Software AG_directory\IntegrationServer All .jar and .zip les from this directory
\instances\instance_name \packages
in each package. The les are added to
\package_name \code\jars\static
the classpath in the order returned by the
File.list() method.
Note:Jars contained in this directory will be
loaded even if the associated package is
disabled.
Software AG_directory\IntegrationServer If this directory exists, then:
\instances\instance_name \packages
IntegrationServer\instances
\package_name \code\libs
\instance_name \packages
\package_name \code\classes is included,
if it exists.
IntegrationServer\instances
\instance_name \packages
\package_name \code\classes.zip is
included, if it exists.

webMethods Integration Server Administrators Guide Version 9.10

43

Even Header
An Overview of the Server

Directory or variable

Description

Software AG_directory\IntegrationServer Valid, and non-voided updates and xes.

\instances\instance_name \updates
Software AG_directory\IntegrationServer All .jar and .zip les in this directory.
\lib\jars
Software AG_directory\IntegrationServer Common custom and third party .jar
\lib\jars\custom
and .zip les in this directory.
Note:Use this directory to store your custom
and third party .jar and .zip les that
you want to make available to all
server instances.
Software AG_directory\IntegrationServer Common valid, and non-voided updates
\updates
and xes.
Note:The updates and xes in this directory
are available to all server instances.
Note:

In some cases, the Integration Server About page will display

the names of les that do not exist. If lenames specied in the

wrapper.java.additional.202=-Dwatt.server.prepend.classes
and wrapper.java.additional.203=-Dwatt.server.append.classes

properties for the Integration Server classpath do not exist, they will still be
displayed on the Integration Server About page. If the ini.cnf le refers to jar
les that do not exist, they will also be displayed on the About page and the
following error will be wrien to the server log for each non-existent jar le:
Classpath entry in ini.cnf not found: <jar_file_name>.

Changing Classpath Information at Startup

When Integration Server starts, it checks the custom_wrapper.conf les for modications
to some of the Java system parameters and variables used by the server. If the
custom_wrapper.conf le contains overrides to the classpath information, the server
uses those seings during startup.
Note:

Beginning with Integration Server version 9.7, Integration Server no longer

obtains seings from setenv.bat/sh or server.bat/sh. At startup, Integration
Server obtains all classpath modications from custom_wrapper.conf.

The custom_wrapper.conf le contains variables that you can change to add directories
to the Java and Integration Server classpaths. Use the following variables to add
directories to the beginning and the end of the Integration Server classpath:

webMethods Integration Server Administrators Guide Version 9.10

44

Odd Header
An Overview of the Server

To add directories
to the...

Edit...

Beginning of
the classpath

wrapper.java.additional.202=Dwatt.server.prepend.classes=

End of the
classpath

wrapper.java.additional.203=Dwatt.server.append.classes=

Although this le comes with a number of variables already specied, you can add
additional ones.
For more detailed information about where and how these variables are added to
the classpaths, see "Classpaths" on page 42. For more information about the
custom_wrapper.conf and the properties you can set, see Software AG Infrastructure
Administrator's Guide.

How Class Loading Works

When Integration Server executes a service that calls a class, the current class loader
defers the search to its parent class loader. If the parent class loader does not have access
to the class, it defers to its parent. This process continues up the chain until it reaches the
OSGi bundle class loader. Once control passes to the OSGi bundle class loader, it follows
the class loader rules dened in the OSGi standard.

Class Loading Process

As stated earlier, the class loading process is aected by a number of factors, including
the following:
Whether a package uses its own class loader or defers to the Integration Server class
loader.
A package's manifest.v3 le controls a number of characteristics of a package,
including whether the package's class loader defers to its parent class loader. The
default is to defer to the parent class loader. However, Integration Server will use the
package class loader instead, if the following is specied in the manifest.v3 le:
<value name='classloader'>package</value>

If you use the package class loader, the jar les containing the classes you
want to make available must be in the Integration Server_directory\instances
\instance_name \packages\packageName \code\jars directory. For more information
about using a package class loader, refer to "Using a Package Class Loader" on page
626.
How Integration Server searches for a class when no package information is
available.

webMethods Integration Server Administrators Guide Version 9.10

45

Even Header
An Overview of the Server

When the Integration Server receives a request to load a class for which no
package information is available, by default, it will search all packages in the
Integration Server_directory\instances\instance_name \packages directory. To
potentially save search time, you can control the order in which packages are
searched by using the wa.server.classloader.pkgpriority server conguration
parameter.
The following sections provide scenarios that describe how the class
loading process works, and how the changes to the manifest.v3 le and
wa.server.classloader.pkgpriority server conguration parameter aect that process.
Scenario One: Integration Server Knows Where the Class Lives
In this scenario, a service from PackageA calls a class that Integration Server knows
resides in PackageX. PackageA is dependent on PackageX.
The manifest.v3 les for both PackageA and PackageX specify "server" as the class
loader, which means that the package class loader is to defer the search to its parent,
which in both cases is the Integration Server class loader.
1. A service in PackageA calls a class that has not yet been loaded into memory.
2. PackageA's class loader, rather than looking for the class itself, passes the request up
to its parent class loader, which is the Integration Server class loader.
3. The Integration Server class loader passes the request up to the OSGi bundle class
loader.
4. The OSGi bundle class loader does not nd the class.
5. The request comes back to the Integration Server class loader, which searches for the
class, rst in cache, and then in the Integration Server classpath.
6. The Integration Server class loader does not nd the class.
7. The request comes back to PackageA's class loader, which searches for the class,
rst in cache, and then in the following directories under the server instances
home package directory (IntegrationServer\instances\instance_name \packages
\package_name), in this order:
PackageA\code\jars
PackageA\code\classes
PackageA\lib
PackageA\resource folders
8. PackageA's class loader does not nd the class in any of these directories.
9. PackageA's class loader delegates the search to PackageX's class loader.
10. PackageX's class loader searches for the class in cache and then in:
PackageX\code\jars

webMethods Integration Server Administrators Guide Version 9.10

46

Odd Header
An Overview of the Server

PackageX\code\classes
PackageX\lib
PackageX\resource folders
11. PackageX's class loader nds the class in PackageX's resource folder.
Scenario Two: Integration Server Does Not Know Where the Class Lives
In some cases, Integration Server will receive a request to load a class, but is not given
any information about where the class lives.
In this case, steps 1-6 are the same as in Scenario One, but because Integration Server
does not know which package contains the class, it cannot go directly to the class
loader for a particular package. Instead, Integration Server will start looking through all
packages in the Integration Server_directory\instances\instance_name \packages directory.
If you know which packages are most likely to contain the classes being searched for,
you can reduce the number of packages searched by specifying the order in which
Integration Server is to search packages. You control the search order by using the
wa.server.classloader.pkgpriority server conguration parameter. For example, you
could specify the following:
wa.server.classloader.pkgpriority=PackageD,PackageF
With this seing, Integration Server will search PackageD and PackageF for the class
before searching in PackageA, PackageB, and PackageC.
Scenario Three: Package Class Loader Does Not Defer to the Integration Server Class Loader
By default, a package class loader defers the search for a class to its parent, which is
always the Integration Server class loader. There may be times, however, when you want
the package class loader to perform the search instead of deferring to the Integration
Server class loader. For example, you might have a package that contains a newer
version of a class than the one Integration Server is using.
To use the package class loader, specify the following in the manifest.v3 le for the
package:
<value name='classloader'>package</value>

The following shows how class loading works when the package class loader does not
defer to the Integration Server class loader.
1. A service in PackageA calls a class that has not yet been loaded into memory.
2. PackageA's class loader, rather than deferring the search to the parent class
loader, performs the search itself, looking rst in cache, and then in the PackageA
directories, in this order:
PackageA\code\jars
PackageA\code\classes
PackageA\lib

webMethods Integration Server Administrators Guide Version 9.10

47

Even Header
An Overview of the Server

PackageA\resource folders
If the package class loader does not nd the class after searching the directories
shown above, the class loader moves up the dependency chain, searching packages
on which PackageA depends.

Where to Place Classes and Jar Files for Packages

If you add jar les or class les to directories in the classpath, be careful where you put
them. If you place a le in the wrong location, the package that needs the class might
not have access to it. Or, if you have two dierent classes with the same name, a service
might pick up the wrong version of the class.
The following picture shows the directory structure for a package.

Shared jar les that are used by services in multiple IS packages are stored within the
same package as a service and are placed in the Integration Server_directory\instances
\instance_name \lib\jars directory.
Note:

You can share jar les between multiple Integration Server instances by
placing them in the IntegrationServer\lib\jars directory. Files located at the
instance-level (i.e. IntegrationServer\instances\instance_name \lib\jars) take
precedence over the les located at the IntegrationServer\lib\jars directory.

If you need to add your own class or jar les, follow these guidelines:
If you want the le to be available just to the package that needs it, place the le in
the jar or classes directory for that package.
These les will also be available to packages that are dependent on this package.
If you change these class or jar les, you can simply reload the package to pick up
the changes; it is not necessary to restart the Integration Server.

webMethods Integration Server Administrators Guide Version 9.10

48

Odd Header
An Overview of the Server

If you want a le to be available to that package and across an entire Integration

Server instance, place the le in Integration Server_directory\instances
\instance_name \packages\package_name \code\jars\static.
If you change the jar le, you must restart the Integration Server for the changes to
take eect.
For more information about the package directory structure, refer to "How the Server
Stores Package Information" on page 585.
As an alternative to placing a le in the Integration Server directory structure, you
can place a le elsewhere on the machine and refer to the le using the following
properties in the Software AG_directory/proles/IS_instance_name /conguration/
custom_wrapper.conf le.
wrapper.java.additional.202=-Dwatt.server.prepend.classes=
wrapper.java.additional.203=-Dwatt.server.append.classes=

For more information about changing the Integration Server classpath, refer to "How the
Integration Server Classpaths Are Specied" on page 42 and "Changing Classpath
Information at Startup" on page 44.

Where to Place Custom and Third-Party Jar Files

If you want to use any custom or third-party jar les with an Integration Server instance,
store them in the Integration Server_directory\instances\instance_name \lib\jars\custom
directory. For example, if you want to use a third-party JMS provider client, a thirdparty JNDI provider, or custom JDBC drivers for WmDB, place the client libraries in
the custom directory. Review the documentation for your third-party application to
determine an exact list of required jar les.
Note:

Any jar les you place in this directory can be migrated using the Integration
Server migration utility.

Note:

You can make jar les available to all server instances by placing them at the
common level in the IntegrationServer\lib\jars\custom directory.

Accelerating Class Loading

Class loading can be a time consuming process when many directories and classes
are involved. Depending on your application and how it is used, the following server
conguration parameters might make class loading run more quickly:
wa.server.coder.bincoder.trycontextloaderrst.
When this property is set to true, when Integration Server encodes or decodes a
pipeline, it uses the context loader before using the class loader for the currently
executing thread. If a referenced class belongs to a particular package, it may be
faster to use the context loader rst.

webMethods Integration Server Administrators Guide Version 9.10

49

Even Header
An Overview of the Server

wa.server.classloader.pkgpriority=packageName, packageName
Species a comma-delimited list of the packages Integration Server is to search
rst when no information has been provided about the location of class. Refer to
"Scenario Two: Integration Server Does Not Know Where the Class Lives" on page
47 and "wa.server." on page 879 for more information about this property.

Integration Server Security

Integration Servers security mechanisms prevent its unauthorized administration,
prevent data from being intercepted during transmission, and protect Integration Server
services from unauthorized access. You can congure Integration Server to:
Use an Enterprise Gateway Server to intercept requests from external clients before
passing the requests to your Integration Server. This allows you to isolate Integration
Server behind an internal rewall.
Require clients to present valid credentials (i.e., user name and password or a client
certicate) to authenticate a connection.
Authorize access to individual services by user groups, through use of Access
Control Lists (ACLs) that you associate with a service. For the greatest security,
associate all services with an ACL.
Provide transport-level security through Secure Sockets Layer (SSL), and messagelevel security for web services through WS-Security.
Digitally sign documents and verify digital signatures.
Control access to services based on the port through which a service request is
received.
Restrict who can access Integration Server Administrator, and who can use
Software AG Designer to connect to the Integration Server.
Require clients to present valid user names (with passwords) that have
Administrator privileges before allowing access to the Integration Server
Administrator functions.
Simplify security administration by storing Integration Server SSL certicates and
private keys in industry-standard keystore les.
Allow dierent client certicates to be used for dierent connections.
Integration Server security also depends on the security of its underlying operating
system. Make sure you do the following:
Follow all vendor recommendations for secure conguration.
Remove unnecessary network services that may contain security aws, such as
telnet.

webMethods Integration Server Administrators Guide Version 9.10

50

Odd Header
An Overview of the Server

Regularly check for and install updates and patches from the operating system
vendor that might aect security.
See your operating systems documentation for instructions on accomplishing these
tasks.
For information about security auditing, refer to the webMethods Audit Logging Guide.

Logging
Logging for the platform provides important data you need to monitor platform activity
and correct problems. Integration Server maintains this logging data. For complete
information and instructions about working with logging data, see the webMethods Audit
Logging Guide and "Seing Up the Server Log" on page 215.

Caching
Caching is an optimization feature that can improve the performance of services by
maintaining frequently used data in memory. Caching can signicantly improve
response time of services that retrieve information from high-trac web servers and
databases.
Integration Server uses the caching capabilities of Ehcache to provide:
Service results caching. When you enable services to cache results, Integration Server
saves the service invocation results in the cache for a specied period of time. While
the results are in cache, rather than re-invoking the service, Integration Server can
quickly retrieve the service results for subsequent clients' requests for the service.
For more information about service caching, see "Caching Service Results" on page
665.
Data caching. With Ehcache, you can dene individual caches in which services
can cache data. Services that want to cache data do so using the caching services
provided in the pub.cache folder. Ehcache enables you to cache virtually any kind
of object. Additionally, it provides advanced features such as o-heap caching and
distributed caching. For more information about using Ehcache, see "Conguring
Ehcache on Integration Server " on page 681.

webMethods Integration Server Administrators Guide Version 9.10

51

Even Header

webMethods Integration Server Administrators Guide Version 9.10

52

Odd Header
Starting and Stopping the Server

3 Starting and Stopping the Server

Starting the webMethods Integration Server ...............................................................................

54

What Happens When You Start the Server? ...............................................................................

61

Running Integration Server as a Windows Application vs. a Windows Service ...........................

62

Passing Java System Properties to Integration Server ...............................................................

64

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

65

Viewing Active Sessions ..............................................................................................................

66

Viewing the Integration Server Process ID ..................................................................................

66

Restarting the Integration Server .................................................................................................

67

Server Recovery ...........................................................................................................................

68

The Java Service Wrapper ..........................................................................................................

69

webMethods Integration Server Administrators Guide Version 9.10

53

Even Header
Starting and Stopping the Server

Starting the webMethods Integration Server

The webMethods Integration Server must be running in order for clients to execute
services. If you are using the server in a development environment, it must be running
in order for your developers to build, update, and test services using the Software AG
Designer.
Keep the following points in mind when starting Integration Server:
Integration Server stores some conguration les and log les on disk. Make
sure that there is enough free disk space on the Integration Server machine to
accommodate these les. Running out of disk space can aect performance and can
lead to errors.
Make sure that the external database to which Integration Server connects is
available before staring Integration Server. If the database is unavailable at
Integration Server startup, some components, such as the scheduler, will not be
initialized and will not work properly.

Starting an Integration Server Instance on Windows

Start an instance of Integration Server from the Windows Start menu as described below.
To start Integration Server on Windows
1. Click Start.
2. In the All Programs menu, click the SoftwareAG folder.
3. Click the Start Servers folder.
4. Click Start Integration Server.
5. Click StartinstanceName .
Note:

If your Integration Server has been congured to request a master

password for outbound password encryption, you will be prompted for
this password in a popup window or from the server console. Refer to
"Managing Outbound Passwords" on page 473 for more information
about this password.

Starting Integration Server on UNIX

Keep the following points in mind when starting Integration Server on UNIX using the
startup.sh script le:
Run the startup.sh script only when logged in as a non-root user. Running the script
as root might reduce the security of your system.

webMethods Integration Server Administrators Guide Version 9.10

54

Odd Header
Starting and Stopping the Server

The server can consume more les and sockets on a UNIX system than on other
systems. Therefore, if you are running the server on a UNIX system, Software AG
recommends that run it with at least 102 le descriptors. You can increase the
number of available le descriptors by entering the following command from the
UNIX command prompt before starting the server:
ulimit -n number

To start Integration Server on UNIX

1. Navigate to the following directory:
Software AG_directory\proles\IS_instance_name\bin
where instance_name is the name of the Integration Server instance.
Note:

The startup.bat/sh and shutdown.bat/sh scripts contained in the

Integration Server_directory\instances\instance_name\bin directory are
deprecated. Software AG recommends the use of the scripts contained
in the Software AG_directory\proles\IS_instance_name\bin directory.
If you will manage Integration Server through Command Central,
you must use the scripts located in the Software AG_directory\proles
\IS_instance_name\bin directory.

2. Execute the startup.sh script le.

Note:

If your Integration Server has been congured to request a master

password for outbound password encryption, you will be prompted for
this password in a popup window or from the server console. Refer to
"Managing Outbound Passwords" on page 473 for more information
about this password.

Starting a Server Instance from the Command Prompt

You can start server instances from the command prompt. When you start a server
instance from the command prompt, you have the option of overriding certain seings
in the conguration le. You can also start the server instance in "debug" mode, so you
can record or display server activity.
Note:

If you are running the Windows Server 2008 r2 operating system with the
User Account Control security feature enabled, the command prompt you
use to run the startup.bat service must be launched with full Administrator
privileges. To launch the command prompt with full Administrator
privileges, navigate to All Programs > Accessories, right-click on the
Command Prompt listing, and select the Run as Administrator option. If you
are not logged into the operating system with Administrator privileges, you
will be prompted to supply Administrator credentials.

webMethods Integration Server Administrators Guide Version 9.10

55

Even Header
Starting and Stopping the Server

When starting a server instance from the command prompt in Integration Server, you
update the custom_wrapper.conf with the server overrides before running startup.bat/
sh.
To start a server instance from the command prompt in Integration Server
1. If you need to override seings in the conguration le, perform the following:
a. In a text editor, open the custom_wrapper.conf le from the following directory:
Software AG_directory\proles\IS_instance_name\conguration
where instance_name is the name of the Integration Server instance.
b. Add the following property to custom_wrapper.conf:
wrapper.app.parameter.n=switch

where n is the next unused sequential number for the wrapper.app.parameter

properties in the le and switch is the switch command.
Most switches require that you add an additional property to
custom_wrapper.conf as the very next property in the sequence, as follows:
wrapper.app.parameter.n=switch_parameter

where n is the sequential number and switch_parameter is the value of the switch.
For example, to change the default port number to 8080, you would enter the
following to custom_wrapper.conf:
wrapper.app.parameter.7=-port
wrapper.app.parameter.8=8080

For more information about the wrapper.app.parameter property, see Software

AG Infrastructure Administrator's Guide.
The following table describes the switches you can use to override seings in the
conguration le:
switch

Description

-port

Species the port on which the server listens for HTTP

requests. If you add a wrapper.app.parameter
property to custom_wrapper.conf for the -port
switch, you must also add a wrapper.app.parameter
property in which you specify the TCP/IP port
number to use.
The rst wrapper.app.parameter property species
that you want to override the port by using the port switch, and the next wrapper.app.parameter
property species the port number to use. For
example:
wrapper.app.parameter.7=-port

webMethods Integration Server Administrators Guide Version 9.10

56

Odd Header
Starting and Stopping the Server

switch

Description
wrapper.app.parameter.8=8080

Note: Keep the following points in mind when

overriding the port number:
This switch overrides the value assigned to
wa.server.port.
The -port switch permanently adds a new
HTTP port to the WmRoot package. This
new port is added as the primary port and
contains default values. If a port with the
same TCP/IP number already exists in the
WmRoot package, the -port switch overrides
its seings with the new default values. In
eect, deleting the existing port and then
adding a new port with default seings.
To use port 80 (the standard for HTTP) or
port 443 (the standard for HTTPS), UNIX
users must be running as "root." For security
reasons, a beer method is to use a higher
number port (5555 for HTTP and 8080 for
HTTPS), and if necessary have the rewall
remap port 80 to the desired port. See
"Architecture" on page 35 for a discussion of
remapping ports.
-home

Species the server's home directory. If you

add a wrapper.app.parameter property to
custom_wrapper.conf for the -home switch, you must
also add a wrapper.app.parameter property in
which you specify the complete path for the home
directory.
The rst wrapper.app.parameter property species
that you want to override the home directory
by specifying the -home switch, and the next
wrapper.app.parameter property species the
complete path for the home directory. For example:
wrapper.app.parameter.9=-home
wrapper.app.parameter.10=D:\wmtest\server

Note: This switch overrides the value assigned to

wa.server.home.
-debug

Species the level of detail you want the server to

maintain in its server log for this session. The -debug
switch overrides the value specied for the Default

webMethods Integration Server Administrators Guide Version 9.10

57

Even Header
Starting and Stopping the Server

switch

Description
facility on the Settings > Logging page and assigned to
wa.debug.level.
If you add a wrapper.app.parameter property to
custom_wrapper.conf for the -debug switch, you
must also add a wrapper.app.parameter property
in which you specify the level of detail you want to
record in the log. You can specify the following levels:
Specify...

To record...

Fatal

Fatal messages only.

Error

Error and fatal messages.

Warn

Warning, error, and fatal

messages.

Info

Informational, warning, error, and

fatal messages.

Debug

Debug, informational, warning,

error, and fatal messages.

Trace

Trace, debug, informational,

warning, error, and fatal
messages.

The rst wrapper.app.parameter property

species that you want to override the debug level
by specifying the -debug switch, and the next
wrapper.app.parameter property species the level
of detail you want to record in the log. For example:
wrapper.app.parameter.11=-debug
wrapper.app.parameter.12=fatal

Note: Prior to Integration Server 7.1, Integration Server

used a number-based system to set the level
of debug information wrien to the server
log. Integration Server maintains backward
compatibility with this system. For more
information about the number-based logging
levels, see the description of the wa.debug.level
property in "Server Conguration Parameters" on
page 851.

webMethods Integration Server Administrators Guide Version 9.10

58

Odd Header
Starting and Stopping the Server

switch

Description

-log

Species where you want the server to write

its server log information for this session. If
you add a wrapper.app.parameter property
to custom_wrapper.conf for the -log switch,
you must also add a wrapper.app.parameter
property in which you specify the destination of
the log information. You can specify the following
destinations:
Option

Description

lename

Specify the fully qualied path

to the le in which you want
the server to write server log
information for this session. The
default is serveryyyymmdd .log.

none

Display server log information on

the computer screen. When you
use this option, the server records
a timestamp in the journal log le,
but does not record any other log
information in the le.

The rst wrapper.app.parameter property species

that you want to override the destination of the log
information by specifying the -log switch, and the
next wrapper.app.parameter property species
either the complete path for the home directory or
none. For example:
wrapper.app.parameter.13=-log
wrapper.app.parameter.14=none

Note: This switch overrides the value assigned to

wa.debug.logle for this session.
-quiesce

Species that Integration Server starts the

server in quiesce mode. When you add
a wrapper.app.parameter property to
custom_wrapper.conf for the -quiesce switch,
Integration Server starts in quiesce mode. The quiesce switch does not require an additional
wrapper.app.parameter property. For example:
wrapper.app.parameter.15=-quiesce

webMethods Integration Server Administrators Guide Version 9.10

59

Even Header
Starting and Stopping the Server

switch

Description
For more information about quiesce mode, see
"Quiescing the Server for Maintenance" on page
821.

c. In the custom_wrapper.conf, update the wrapper.app.parameter.2 property to

reect the total number of wrapper.app.parameter properties that you added
in the previous steps.
For example, if wrapper.app.parameter.2 is set to 4 (the default) and
you add two wrapper.app.parameter properties, you would increase the
value of wrapper.app.parameter.2 by two. After making your edits, the
wrapper.app.parameter.2 would appear as follows:
wrapper.app.parameter.2=6

For more information about the wrapper.app.parameter property, see Software

AG Infrastructure Administrator's Guide.
d. Save and close custom_wrapper.conf.
For more information about seing properties in custom_wrapper.conf, see Software
AG Infrastructure Administrator's Guide.
2. At a command prompt, type the following command:
cd
Software AG_directory
\profiles\IS_instance_name \bin

where instance_name is the name of the Integration Server instance.

Note:

The startup.bat/sh and shutdown.bat/sh scripts contained in the

Integration Server_directory\instances\instance_name\bin directory are
deprecated. Software AG recommends the use of the scripts contained
in the Software AG_directory\proles\IS_instance_name\bin directory.
If you will manage Integration Server through Command Central,
you must use the scripts located in the Software AG_directory\proles
\IS_instance_name\bin directory.

3. Type the following command to start the server instance:

For Windows:

startup.bat

For UNIX:

startup.sh

webMethods Integration Server Administrators Guide Version 9.10

60

Odd Header
Starting and Stopping the Server

What Happens When You Start the Server?

When you start Integration Server, it performs a series of initialization steps to make
itself ready for client requests. The server:
1. Establishes the operating environment by using the conguration parameters located
in the conguration le (Integration Server_directory\instances\instance_name \cong
\server.cnf).
2. Initializes processes that perform internal management.
3. Loads information about all the enabled packages and their services that reside in
the Integration Server_directory\instances\instance_name \packages directory. If a
package depends on other packages, the server loads the prerequisite packages rst.
The server does not load disabled packages.
4. Executes the startup services for each loaded package.
5. Initializes the guaranteed delivery engine. The server checks the job store for
pending guaranteed delivery transactions. It retries the pending transactions as the
guaranteed delivery conguration seings specify. For more information, refer to
"Conguring Guaranteed Delivery" on page 671.
6. Schedules internal system tasks.

How to Tell if the Server Is Running Correctly

To determine whether your server is running, start your browser and point it to the
Integration Server instance. (See "Starting the Integration Server Administrator " on page
84 if you need instructions for this step.)
If the server is running, you will be prompted for a name and password.
If the server is not running, your browser will issue an error message similar to the
following:
"Cannot open the Internet site http://localhost:5555."
"A connection with the server could not be established."

If Integration Server detects a problem with the master password or outbound

passwords at startup, it will place you in safe mode, which is a special mode from which
you can diagnose and correct problems. When Integration Server is in safe mode, it
displays the Integration Server Administrator, but Integration Server is not connected to
any external resources.
When you are placed into safe mode because of problems with the master password or
outbound passwords, you will see the following message in the upper left corner of the
Server Statistics screen of the Integration Server Administrator:
SERVER IS RUNNING IN SAFE MODE. Master password sanity check failed -- invalid
master password provided.

webMethods Integration Server Administrators Guide Version 9.10

61

Even Header
Starting and Stopping the Server

These problems can be caused by a corrupted master password le, a corrupted

outbound password le, or by simply mis-typing the master password when you
are prompted for it. If you suspect you have mis-typed the password, shut down the
server and restart it, this time entering the correct password. If this does not correct
the problem, refer to "When Problems Exist with the Master Password or Outbound
Passwords at Startup" on page 480 for instructions.

Running Integration Server as a Windows Application vs. a

Windows Service
Integration Server can run as either a Windows application or a Windows service.
Use a Windows application if you want to control when the Integration Server
initializes. When Integration Server is a Windows application, you must manually
start it.
If you installed the Integration Server as a Windows service and now want it to
be a Windows application, you can manually remove the Windows service for the
Integration Server. After removing the Windows service, the Integration Server
will still be available as a Windows application. See "Switching the Server from a
Windows Service to a Windows Application" on page 63.
Use a Windows service to have Integration Server automatically initialize when the
machine on which it is installed initializes. When you use a Windows service, you do
not have to manually restart Integration Server following a machine restart.
If you installed Integration Server as a Windows application and now want it to be a
Windows service, you can manually register the Integration Server service.
See "Switching the Server from a Windows Application to a Windows Service" on
page 63.
Note:

If you want the Integration Server to prompt for the master password for
outbound passwords at server initialization, do not run it as a Windows
service. For more information about outbound passwords and the master
password, refer to "Securing Communications with the Server" on page
401.

You can run multiple Integration Server instances as applications and multiple
Integration Server instances as services on a single machine. For example, you can run
two instances of Integration Server as an application and two instances of Integration
Server as services on the same machine.

webMethods Integration Server Administrators Guide Version 9.10

62

Odd Header
Starting and Stopping the Server

Switching the Server from a Windows Service to a Windows

Application
If Integration Server was installed as a Windows service, and you want Integration
Server to run as a Windows application, you must remove the Windows service for the
Integration Server.
To manually remove the Windows service for the Integration Server
1. If the Windows service is running, stop it. You can stop the Windows service by
either using the Integration Server Administrator to shut down the Integration
Server or from the Services dialog box in the Microsoft Windows Control Panel.
2. Open a command prompt, navigate to the Software AG_directory \proles
\IS_instance_name \bin directory and run the following command to create the
Integration Server service:
service.bat -remove

Note:

The installSvc.bat le located in Integration Server_directory\instances

\instance_name \support\win32 directory is deprecated.
Software AG recommends using the service.bat le from the
Software AG_directory\proles\IS_instance_name \bin directory.

Switching the Server from a Windows Application to a Windows

Service
To switch the server from a Windows application to a Windows service, you must
manually register the Integration Server instance to run as a Windows service.
Note:

The user whose identity will be used to run the Integration Server as a
Windows service must have Power User privileges.

To manually register an Integration Server instance to run as a Windows service

1. Edit the custom_wrapper.conf le to t your environment.
For example, you might change the Java minimum heap size by updating the
wrapper.java.initmemory property. The custom_wrapper.conf le is located in the
Software AG_directory\proles\IS_instance_name \conguration directory.
For more information about seing values in the custom_wrapper.conf le, see
Software AG Infrastructure Administrator's Guide.
2. Open a command prompt, navigate to the Software AG_directory \proles
\IS_instance_name \bin directory and run the following command to create the
Integration Server service:

webMethods Integration Server Administrators Guide Version 9.10

63

Even Header
Starting and Stopping the Server

service.bat -install

Note:

The installSvc.bat le located in Integration Server_directory\instances

\instance_name \support\win32 directory is deprecated.
Software AG recommends using the service.bat le from the
Software AG_directory\proles\IS_instance_name \bin directory.

In the Microsoft Windows Control Panel in the Services dialog box, verify that the
service for Integration Server has been created.
3. Start the service from one of the following places:
Services dialog box in the Microsoft Windows Control Panel
Command prompt using the following command:
net start <SVCNAME>

where <SVCNAME> is the name of the service created in the previous step.

Passing Java System Properties to Integration Server

You can pass Java system properties to Integration Server by modifying the
custom_wrapper.conf le.
To pass Java system properties to Integration Server
1. Open the custom_wrapper.conf le in a text editor. You can nd the
custom_wrapper.conf le in the following directory:
Software AG_directory\proles\IS_instance_name \conguration
2. Add a wrapper.java.additional.n property that species the property name
and value that you want to pass to Integration Server, where n is a unique sequence
number. The property name must be preceded by -D.
For example, the wrapper.java.additional properties in the
custom_wrapper.conf le would look similar to the following:
wrapper.java.additional.11=-Dmy.prop1=value1
wrapper.java.additional.12=-Dmy.prop2=value2

For more information about seing values in the custom_wrapper.conf le, see
Software AG Infrastructure Administrator's Guide.
3. Save and close the le.
4. Restart the server for the changes to take eect.

webMethods Integration Server Administrators Guide Version 9.10

64

Odd Header
Starting and Stopping the Server

Shutting Down the Integration Server

You can shut down the server to stop the Integration Server and all active sessions. You
can perform this task from Integration Server Administrator or from the command
prompt.

Shutting Down the Integration Server from Integration Server

Administrator
Use this procedure to shut down the Integration Server and all active sessions from
Integration Server Administrator.
To shut down the server
1. Open the Integration Server Administrator if it is not already open.
2. In the upper right corner of any Integration Server Administrator screen, click
Shutdown and Restart.
3. Select whether you want the server to wait before shuing down or to shut down
immediately.
Delay number minutes or until all client sessions are complete. Specify the number of
minutes you want the Integration Server to wait before shuing down. It then begins
monitoring user activity and automatically shuts down when all non-administrator
sessions complete or when the time you specify elapses (whichever comes rst).
Perform action immediately. The server and all active sessions terminate immediately.
4. For instructions on how to view the active sessions, refer to "Viewing Active
Sessions" on page 66.
5. Click Shutdown.

Shutting Down Integration Server from Windows

You can shut down any instance of Integration Server and all active session from the
Windows start menu.
To shut down Integration Server on Windows
1. Click Start.
2. In the All Programs menu, click the SoftwareAG folder.
3. Click the Stop Servers folder.
4. Click Stop Integration Server.
5. Click StopinstanceName.

webMethods Integration Server Administrators Guide Version 9.10

65

Even Header
Starting and Stopping the Server

Shutting Down Integration Server from the Command Prompt

Use this procedure to shut down the server and all active sessions from the command
prompt.
To shut down the server from the command prompt
1. At a command prompt, type the following command to switch to the server
instance's home directory:
cd
Software AG_directory
\profiles\IS_instance_name \bin

where instance_name is the name of the Integration Server instance.

Note:

The startup.bat/sh and shutdown.bat/sh scripts contained in the

Integration Server_directory\instances\instance_name\bin directory are
deprecated. Software AG recommends the use of the scripts contained
in the Software AG_directory\proles\IS_instance_name\bin directory.
If you will manage Integration Server through Command Central,
you must use the scripts located in the Software AG_directory\proles
\IS_instance_name\bin directory.

2. Type the following command to stop the server:

For Windows:

shutdown.bat

For UNIX:

shutdown.sh

Viewing Active Sessions

When Integration Server is running, you can view the sessions that are currently active.
To view active sessions
1. Open the Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Statistics.
3. Click on the current number of sessions.

Viewing the Integration Server Process ID

Each instance of Integration Server runs on an operating system as a separate JVM
process. There are times when it is necessary to perform a thread dump or stop a
particular instance of Integration Server (for example, in Windows Task Manager). In

webMethods Integration Server Administrators Guide Version 9.10

66

Odd Header
Starting and Stopping the Server

order to do this, it is necessary to know the process ID of the Integration Server process
(or server process ID) on which to perform the particular operation. You can view the
server process ID in the Integration Server Administrator About page.
To view the process ID
1. Open the Integration Server Administrator if it is not already open.
2. Click About in the upper right-hand part of the screen.
3. Scroll down to the Server Process Id eld in the Server Environment area.

Restarting the Integration Server

Restart the server when you need to stop and reload Integration Server. You should
restart the server when:
You make certain configuration changes. Some conguration changes require the server
to be restarted before they take eect. This document indicates when you are
required to restart the server for conguration changes.
You want to incorporate updated services that cannot be dynamically reloaded. This typically
occurs for non-Java services.
To restart the server
1. Open the Integration Server Administrator if it is not already open.
2. In the upper right corner of any Integration Server Administrator screen, click
Shutdown and Restart.
3. Select whether you want the server to wait before restarting or to restart
immediately.
Delay number minutes or until all client sessions are complete. Specify the number of
minutes you want the Integration Server to wait before restarting. It then begins
monitoring user activity and automatically restarts when all non-administrator
sessions complete or when the time you specify elapses (whichever comes rst).
Perform action immediately. The server and all active sessions terminate
immediately. Then the server restarts.
For instructions on how to view the active sessions, refer to "Viewing Active
Sessions" on page 66.
4. Click Restart.

webMethods Integration Server Administrators Guide Version 9.10

67

Even Header
Starting and Stopping the Server

Server Recovery
If a hardware or software problem causes Integration Server to fail, restart the server
using the normal startup procedure. The server will aempt to perform cleanup and
initialization processes to reset the operating environment.
As part of the recovery process, the server automatically:
Reloads the cache environment to its pre-failure state.
Restores the transaction manager's guaranteed delivery queues. See "Conguring
Guaranteed Delivery" on page 671 for additional information about guaranteed
delivery recovery options.
Services that your site has created might have their own unique recovery requirements.
Consult with your developers for information about these requirements.
Some circumstances might require manual intervention to restart the server.
Tip:

Before restarting Integration Server, you can collect diagnostic data to

troubleshoot run-time issues. For information about using the diagnostic port
and utility, see "Diagnosing the Integration Server " on page 831. Also refer
to this chapter for information on generating thread dump to troubleshoot
reasons for server slowdown or unresponsiveness.

Integration Server Data Integrity and Recoverability Considerations

The Integration Server utilizes a webMethods physical storage technology to persist
critical operational data. This storage technology employs database-like technology
of logging and transactional management. Under normal operations these facilities
maintain the integrity, consistency, and recoverability of data persisted to these les.
However, even with these safeguards, abnormal server shutdown and catastrophic
failures can occur, which could result in these les being left in an unrecoverable state.
Shuing down Integration Server by any means other than the Integration Server
Administratormay result in critical data les being left in an unrecoverable state. This
will result in the inability to restart the Integration Server without manual intervention
to remove or recover the damaged data les.
Important: Establish site-specic backup and restore procedures to protect these critical
data les.
The mission-critical nature of the data stored in the Integration Server's data les
requires that it be backed up periodically for disaster recovery. As in all critical data
resources, the potential exists for a physical failure to leave the Integration Server data
les in a corrupted state. In these situations the method of recovery is to replace these
data les with the most current backup. The frequency and nature of these backups
depends on the critical nature of the data being stored. Backups of these data les

webMethods Integration Server Administrators Guide Version 9.10

68

Odd Header
Starting and Stopping the Server

should be an oine process with the Integration Server in an idle or shutdown state, i.e.
no disk activity.
Important: Implement site-specic procedures to periodically backup the critical
Integration Server data les. You can use any le-system backup utility.
Perform the backup process only when the Integration Server is shutdown or
in a quiesce state, (no disk activity). This restriction ensures that the backup
will capture these critical data les in a consistent state. Backing up an active
Integration Server may result in capturing a snapshot of the data les that
are in an inconsistent state and therefore unusable for recovery purposes.

Critical Integration Server Data Files

There are two subdirectories in Integration Server's currently working directory
that contain critical data les that must be backed up for recovery purposes. These
subdirectories are:
./DocumentStore
The les in this subdirectory contain the locally persisted documents being
processed by Integration Server. The loss of these les will result in the loss of any
persisted documents. Back up these six les:
ISResubmitStoredata0000000
ISResubmitStorelog0000000
ISTransStoredata0000000
ISTransStorelog0000000
TriggerStoredata0000000
TriggerStorelog0000000
./WmRepository4
The les in this subdirectory contain metadata for Integration Server. The loss of
these les could result in loss of conguration information and may require manual
reconguration. Back up these two les:
FSDdata0000000
FSDlog0000000

The Java Service Wrapper

webMethods Integration Server runs on the on the Software AG Common Platform,
which in turn runs in a Java Virtual Machine (JVM). The Java Service Wrapper is an
application developed by Tanuki Software, Ltd. It is a utility program that launches the
JVM in which Integration Server runs.

webMethods Integration Server Administrators Guide Version 9.10

69

Even Header
Starting and Stopping the Server

In addition to launching the JVM, the Java Service Wrapper oers features for
monitoring the JVM, logging console output, and generating thread dumps. The
following sections describe how Integration Server uses the features of the Java Service
Wrapper. For an overview of the Java Service Wrapper, see the webMethods crossproduct document, Software AG Infrastructure Administrator's Guide.

The Java Service Wrapper Configuration Files

For Integration Server, the conguration les for the Java Service Wrapper reside in the
following directory.
Software AG_directory\proles\IS_instanceName \conguration
When you start Integration Server, property seings in the following les determine the
conguration of the JVM and the behavior of the logging and monitoring features of the
Java Service Wrapper.
File name

Description

wrapper.conf

Contains property seings that are installed by

Integration Server.
Do not modify the contents of this le unless asked
Important:
to do so by Software AG.

custom_wrapper.conf

Contains properties that modify the installed seings in

wrapper.conf.
If you need to modify the property seings for the Java
Service Wrapper, you make your changes in this le.
Note: Beginning with Integration Server version 9.7,
Integration Server no longer obtains seings from
setenv.bat/sh or server.bat/sh. At startup, Integration
Server obtains all classpath modications from
custom_wrapper.conf. For more information about
how Integration Server builds classpaths, see "How
the Server Loads Java Classes" on page 40.

The following sections describe conguration changes that Integration Server supports
for Java Service Wrapper. For Integration Server, do not make any conguration changes
to the Java Service Wrapper other than the ones described in the following sections.

JVM Configuration
When the Java Service Wrapper launches the JVM, it provides conguration
seings that, among other things, specify memory seings and the directories in the

webMethods Integration Server Administrators Guide Version 9.10

70

Odd Header
Starting and Stopping the Server

classpath. When you start Integration Server, the Java Service Wrapper receives these
conguration seings from the wrapper.conf and custom_wrapper.conf les in the
Software AG_directory\proles\IS_instance_name \conguration folder.
If you need to modify the default property seings for Integration Server, you can
override the seings using the custom_wrapper.conf le, which is located in the
Software AG_directory\proles\IS_instance_name \conguration. For more information
for conguring custom_wrapper.conf properties for Integration Server, see "Conguring
the Server" on page 107. For general information about the Java Service Wrapper, see
Software AG Infrastructure Administrator's Guide.

The Wrapper Log

The Java Service Wrapper records console output in a log le. The log contains the
output sent to the console by the wrapper itself and by the JVM in which Integration
Server is running. The wrapper log is especially useful when you run Integration Server
as a Windows service, because console output is normally not available to you in this
mode.
The Java Service Wrapper log for Integration Server is located in the following le:
Software AG_directory\proles\IS_instanceName \logs\wrapper.log
To view the log, simply open the log le in a text editor.

Logging Properties
The wrapper.console and wrapper.log properties in the wrapper conguration les
determine the content, format, and behavior of the wrapper log.
The logging seings that Integration Server installs are suitable for most environments.
However, you can modify the following properties if the installed seings do not suit
your needs. For procedures and additional information, see the webMethods crossproduct document, Software AG Infrastructure Administrator's Guide.
Property

Value

wrapper.console.format

The format of the messages displayed in the console.

wrapper.console.loglevel

The level of detail displayed in the console.

wrapper.logfile

The le into which console output for Integration

Server is logged.

wrapper.logfile.format

The format of the messages recorded in the wrapper

log le.

webMethods Integration Server Administrators Guide Version 9.10

71

Even Header
Starting and Stopping the Server

Property

Value

wrapper.logfile.loglevel

The level of detail recorded in the wrapper log le.

This seing must be a level that is equal to or lower
than the seing in wrapper.console.loglevel.

wrapper.logfile.maxsize

The maximum size to which the log can grow.

wrapper.logfile.maxfiles

The number of old logs the Java Service Wrapper

retains.

wrapper.syslog.loglevel

Which messages are wrien to the Event Log on

Windows systems, or the syslog on UNIX systems.

Fault Monitoring
The Java Service Wrapper can monitor the JVM for the certain conditions and then
restart the JVM or perform other actions when it detects these conditions.
The following table describes the fault-monitoring features Integration Server uses or
allows you to congure. To learn more about these features, see the webMethods crossproduct document, Software AG Infrastructure Administrator's Guide.
Feature

Enabled?

User configurable?

JVM timeout

Yes

No. Do not modify the wrapper.ping properties

unless asked to do so by Software AG.

Deadlock
detection

No

No. Do not enable this feature.

Console ltering

No

No. Do not enable this feature.

Generating a Thread Dump

The Java Service Wrapper provides a utility for generating a thread dump of the JVM. A
thread dump can help you locate thread contention issues that can cause thread blocks
or deadlocks.
For information about generating a thread dump using the Java Wrapper Service, see the
webMethods cross-product document, Software AG Infrastructure Administrator's Guide.

webMethods Integration Server Administrators Guide Version 9.10

72

Odd Header
Running Multiple Integration Server Instances

4 Running Multiple Integration Server Instances

Overview .......................................................................................................................................

74

Guidelines for Running Multiple Integration Server Instances on the Same Machine .................

74

About Creating a New Integration Server Instance .....................................................................

74

About the is_instance Script ........................................................................................................

75

Creating a New Integration Server Instance ................................................................................

76

Installing and Updating Packages on a Server Instance .............................................................

78

Deleting Packages from a Server Instance .................................................................................

79

Updating Language Packs on a Server Instance ........................................................................

80

Deleting a Server Instance ..........................................................................................................

81

webMethods Integration Server Administrators Guide Version 9.10

73

Even Header
Running Multiple Integration Server Instances

Overview
You can create and run multiple instances of Integration Server on the same host
machine with a single physical installation of webMethods Integration Server. This is
not the same as clustering, which is described in webMethods Integration Server Clustering
Guide. When running multiple instances of Integration Server on the same host machine,
each server has its own packages, conguration les, log les, and updates; however,
unlike clustering, all of the server instances can share common libraries. Sharing
the common library les reduces the amount of overhead and eort involved when
installing xes and patches on each server.
You manage each server instance separately using the Integration Server Administrator.
You can also perform certain management, conguration, and monitoring tasks from
a single location using Software AG Command Central. For information about using
Software AG Command Central to manage Integration Server instances, see the
Command Central documentation.

Guidelines for Running Multiple Integration Server Instances

on the Same Machine
The following guidelines apply to running two or more Integration Server instances on
the same machine:
The common libraries are located under SoftwareAG\common and
Integration Server_directory\lib. The les in these libraries can be used by all server
instances. For example, you can make custom jar les available to all server instances
by placing them in the Integration Server_directory\lib\jars\custom directory.
Updates and custom jars located at the instance level take precedence over the
updates and custom jars located in the common libraries.
Every port number on each server instance must be unique unless the host machine
has more than one NIC. The ports include the primary port, diagnostic port, and all
other ports described in "Conguring Ports" on page 155.
You do not need an additional license to create and run multiple Integration Server
instances. However, creating and running additional server instances will increase
the number of concurrent processes. Before creating additional server instances,
check your system resources and your Software AG license.

About Creating a New Integration Server Instance

You can create a new Integration Server instance using the Integration
Server instance creation script, is_instance.bat/sh, which is located in the
Integration Server_directory\instances directory.

webMethods Integration Server Administrators Guide Version 9.10

74

Odd Header
Running Multiple Integration Server Instances

When you create a new Integration Server instance, the script creates a new folder under
the SoftwareAG\proles\IS_instance_name directory containing OSGI component les.
The script also creates a home directory for the instance under
Integration Server_directory\instances\instance_name . The home directory contains the
predened packages described in "Predened Packages" on page 580.
If you want the server instance to use components or services contained in other
packages, you must add the packages to the instance directory. For example, if you want
the server instance to use webMethods Deployer or webMethods Mediator, you must
add the WmDeployer or WmMediator package to the instance directory. Packages are
located in the package repository, which is installed by default and is located under the
Software AG_directory\IntegrationServer\packages directory.
For information about how to create a new Integration Server instance, see "Creating
a New Integration Server Instance" on page 76. For information about how to
add packages to a server instance, see "Installing and Updating Packages on a Server
Instance" on page 78.

About the is_instance Script

The is_instance.bat/sh script creates, updates, and deletes an Integration Server instance.
It also installs, updates, or deletes packages and language packs on an Integration Server
instance.
The is_instance.bat/sh script is located in the following directory:
Integration Server_directory\instances

Syntax
At the command prompt, use the following syntax:
Integration Server_directory\instances\is_instance.batcommand parameters
If the command syntax is not correct, the script writes error information to the console.

is_instance Script Commands

The following table provides descriptions for the commands that can be used with the
is_instance.bat/sh script.
Command

Description

create

Creates a new instance of Integration Server. For

more information about using this parameter, see

webMethods Integration Server Administrators Guide Version 9.10

75

Even Header
Running Multiple Integration Server Instances

Command

Description
"Creating a New Integration Server Instance" on
page 76.

update

Adds the specied list of packages to the Integration

Server instance. For more information about using
this parameter, see "Installing and Updating
Packages on a Server Instance" on page 78.

deletePackages

Deletes packages from the Integration Server

instance. For more information about using this
parameter, see "Deleting Packages from a Server
Instance" on page 79.

updateLanguagePack

Updates language pack les for the Integration

Server instance. "Deleting Packages from a Server
Instance" on page 79.

delete

Deletes the Integration Server instance. For more

information about using this parameter, see
"Deleting a Server Instance" on page 81.

Creating a New Integration Server Instance

Use the create command to create a new Integration Server instance.
Before creating a new instance, review the information in "Guidelines for Running
Multiple Integration Server Instances on the Same Machine" on page 74 and "About
Creating a New Integration Server Instance" on page 74.
To create a new Integration Server instance
1. Navigate to the following directory:
Integration Server_directory\instances
2. Run the instance script as follows:
is_instance.bat/sh create
-Dinstance.name=instance_name
-Dprimary.port=primary_port_number
-Ddiagnostic.port=diagnostic_port_number
-Djmx.port=jmx_port_number
-Dlicense.file=license_file_location
-Dinstall.service=install_service
-Ddb.alias=database_alias_name
-Ddb.type=database_type
-Ddb.username=database_username
-Ddb.password=database_password
-Ddb.url=database_URL

webMethods Integration Server Administrators Guide Version 9.10

76

Odd Header
Running Multiple Integration Server Instances

Where...

Specify...

instance_name

A unique name for the new instance.

primary_port_number

Optional. A default HTTP port number for the new

instance. The port number must be unique for each
Integration Server instance. The default value is 5555.

diagnostic_port_number Optional. A default diagnostic port number for the

new instance. The port number must be unique for

each Integration Server instance. The default value is
9999.

jmx_port_number

Optional. A default JMX port number for the new

instance. The port number must be unique for each
Integration Server instance. The default value is 8075.

license_file_location Optional. The location of your Integration Server

license le.

The script copies the license le from the

specied location to IntegrationServer/
instances/instance_name /cong/licenseKey.xml le.
This parameter is optional; however, if a license
le location is not specied, the Integration Server
instance will shut down after 30 minutes.
Note: If the location name contains spaces, you must
surround the name of the location with quotation
marks ( ). For example:
-Dlicense.file=license file location
install_service

Optional. Whether to register the service for the

instance. The default is false.
Note: This option is valid only for Windows platforms.

db.alias

Optional. The alias name for the database. The

default value is JDBC_POOL_ALIAS.

db.type

The type of database used by the new server instance.

Specify one of the following databases:
sql - Microsoft SQL Server
oracle - Oracle

webMethods Integration Server Administrators Guide Version 9.10

77

Even Header
Running Multiple Integration Server Instances

Where...

Specify...
db2 - DB2

These values are not case-sensitive. The default is the

embedded IS internal database.
db.username

The user name assigned to the Integration Server

database.

db.password

The password of the Integration Server database

user.

db.url

The connection URL for the database.

3. Optionally, add packages to the server instance. For instructions, see "Installing and
Updating Packages on a Server Instance" on page 78.
4. Start the Integration Server instance by running the startup.bat/sh le located in the
Software AG_directory \proles\IS_instance_name \bin directory.
Note:

The startup.bat/sh and shutdown.bat/sh scripts contained in the

Integration Server_directory\instances\instance_name\bin directory are
deprecated. Software AG recommends the use of the scripts contained
in the Software AG_directory\proles\IS_instance_name\bin directory.
If you will manage Integration Server through Command Central,
you must use the scripts located in the Software AG_directory\proles
\IS_instance_name\bin directory.

Installing and Updating Packages on a Server Instance

Use the update command to update existing packages and to install other packages on a
server instance.
When you run the update command, the script copies the packages you specify from the
webMethods Integration Server package repository to the new instance.
Note:

When you install or update packages using the installer, you have the option
to install packages on the initial instance created by the installer. If you
select this option, packages are copied to that instance automatically during
installation; therefore, you do not need to run the update command on that
instance.

Note:

Application Platform and ActiveTransfer can be used with the instance of

Integration Server created by the installer only.

webMethods Integration Server Administrators Guide Version 9.10

78

Odd Header
Running Multiple Integration Server Instances

To update packages on an Integration Server instance

1. Stop the Integration Server instance.
2. Navigate to the following directory:
Integration Server_directory\instances
3. Run the is_instance script as follows:
is_instance.bat update -Dinstance.name=instance_name -Dpackage.list=package_list

Where...

Specify...

instance_name

The name of the instance to which you want to add

packages.

package_list

A comma separated list of packages to add to the server

instance. For example, packageA,packageB.
Note: This option does not accept white-space characters (or
blank spaces).
Specify all to add all non-predened packages in the
webMethods Integration Server package repository located
in the Integration Server_directory\packages directory.
For a list of predened packages, see "Predened
Packages" on page 580.

The script adds the packages to the Integration Server_directory\instances

\instance_name \packages directory.

Deleting Packages from a Server Instance

The deletePackages command removes the specied package or list of packages from
a server instance.
To delete packages from an Integration Server instance
1. Stop the Integration Server instance.
2. Navigate to the following directory:
Integration Server_directory\instances
3. Run the is_instance script as follows:
is_instance.bat deletePackages -Dinstance.name=instance_name Dpackage.list=package_list

webMethods Integration Server Administrators Guide Version 9.10

79

Even Header
Running Multiple Integration Server Instances

Where...

Specify...

instance_name

The name of the instance from which you want to delete

packages.

package_list

A comma-separated list of packages to remove

from the Integration Server instance. For example,
packageA,packageB.
Note: This option does not accept white-space characters (or
blank spaces).

The is_instance script removes the specied packages located under the
Integration Server_directory\instances\instance_name \packages\package_name
directory.

Updating Language Packs on a Server Instance

After installing, modifying, or removing language pack les on webMethods Integration
Server, you must run the updateLanguagePack command on each server instance to
synchronize and propagate the les.
Note:

When you install or update language packs using the installer, you have
the option to install packages on the instance created by installer. If you
select this option, language packs are synchronized on that instance
automatically during installation; therefore, you do not need to run the
updateLanguagePack command on the instance created by installer.

To update language pack files on an Integration Server instance

1. Stop the Integration Server instance.
2. Navigate to the following directory:
Integration Server_directory\instances
3. Run the is_instance script as follows:
is_instance.bat updateLanguagePack -Dinstance.name=instance_name Dinstall.mode=mode

Where...

Specify...

instance_name

The name of the instance to update.

mode

The processing mode to indicate whether the script is

to add or remove language pack les (such as jars and

webMethods Integration Server Administrators Guide Version 9.10

80

Odd Header
Running Multiple Integration Server Instances

Where...

Specify...
DSPs, HTMLs, class) from the instance. Specify one of the
following:
install to add or update language pack les. When this

option is specied, the script copies the language pack

les from the package repository to the specied instance.
Note: Be sure to install the language pack using the
Software AG Installer before you update the
instance. If the les do not exist in the package
repository, the script cannot update the instance.
uninstall to remove language pack les. When this

option is specied, the script removes the language pack

les from the instance.
Note: Be sure to uninstall the language pack using
the Software AG Installer before running Dinstall.mode=uninstall or the les will not be
removed from the instance.

Deleting a Server Instance

The delete command removes all les and folders located under the
Integration Server_directory\instances\instance_name and SoftwareAG\proles
\IS_instance_name directories.
Important: After you delete a server instance, you cannot retrieve any of its les or
directories, including any custom directories.
To delete an Integration Server instance
1. Stop the Integration Server instance.
2. Navigate to the following directory:
Integration Server_directory\instances
3. Run the is_instance script as follows:
is_instance.bat delete -Dinstance.name=instance_name

Where...

Specify...

instance_name

The name of the instance you want to delete.

webMethods Integration Server Administrators Guide Version 9.10

81

Even Header

webMethods Integration Server Administrators Guide Version 9.10

82

Odd Header
Using the Integration Server Administrator

5 Using the Integration Server Administrator

What Is the Integration Server Administrator? .............................................................................

84

Starting the Integration Server Administrator ...............................................................................

84

Starting Integration Server Administrator on Windows ................................................................

85

Accessing Integration Server Administrator through My webMethods ........................................

85

Basic Operation ............................................................................................................................

86

The Configuration File ..................................................................................................................

88

Software AG Command Central ..................................................................................................

88

webMethods Integration Server Administrators Guide Version 9.10

83

Even Header
Using the Integration Server Administrator

What Is the Integration Server Administrator?

The Integration Server Administrator is an HTML-based utility you use to administer
the webMethods Integration Server. It allows you to monitor server activity, manage
user accounts, make performance adjustments, and set operating parameters.
You can run the Integration Server Administrator from any browser-equipped
workstation on your network. (The Integration Server Administrator is a browser-based
application that uses services to accomplish its work.)

Starting the Integration Server Administrator

To use the Integration Server Administrator, open your browser and point it to the port
on the host machine where the Integration Server instance is running.
The server must be running in order to use Integration Server Administrator. If the
server is not running, your browser will issue an error similar to the following:
"Cannot open the Internet site http://localhost:5555."
"A connection with the server could not be established."

To start the Integration Server Administrator

1. Start your browser.
2. Point your browser to the host and port where the Integration Server instance is
running.
Examples
If the server were running on the default port on the same machine where you are
running the Integration Server Administrator, you would type:
http://localhost:5555

If the server were running on port 4040 on a machine called QUICKSILVER, you
would type:
http://QUICKSILVER:4040

3. Log on to the server with a user name and password that has administrator
privileges.
If you just installed the Integration Server, you can use the following default values:
User Name:

Administrator

Password:

manage

Important: Use the exact combination of upper- and lowercase characters shown
above; user names and passwords are case sensitive.

webMethods Integration Server Administrators Guide Version 9.10

84

Odd Header
Using the Integration Server Administrator

Starting Integration Server Administrator on Windows

Start Integration Server Administrator from the Windows Start menu as described
below.
To start Integration Server Administrator on Windows
1. Click Start.
2. In the All Programs menu, click the SoftwareAG folder.
3. Click the Administration folder.
4. Click Integration Server Administrator.
5. Click instanceName .
6. Log on to the server with a user name and password that has administrator
privileges.
If you just installed the Integration Server, you can use the following default values:
User Name:

Administrator

Password:

manage

Important: Use the exact combination of upper- and lowercase characters shown
above; user names and passwords are case sensitive.

Accessing Integration Server Administrator through My

webMethods
If you are working in My webMethods, you can also access Integration Server
Administrator through the My webMethods ESB Administration window. Use
the following procedure to add an Integration Server Administrator to the ESB
Administration window.
To make Integration Server Administrator available through My webMethods
1. From My webMethods, go to Navigate > Applications > Administration > Integration > ESB.
2. Click Add Server ... and complete the elds as follows:
Field

Entry

Description

Brief description for the Integration Server.

webMethods Integration Server Administrators Guide Version 9.10

85

Even Header
Using the Integration Server Administrator

Field

Entry

Server Host

Host machine for an Integration Server you want to

administer from My webMethods.

Server Port

Integration Server port to which My webMethods Server

will send requests.

Single Sign On

If you use the My webMethods Server single sign-on

feature, users who log on to My webMethods Server will
be able to administer the Integration Server without having
to log on to it as well. For instructions on seing up the
single sign-on feature, see "Accessing Integration Server
Data through My webMethods " on page 459.

Use Secure
Connection

Whether My webMethods Server should use SSL to

connect to the Integration Server.
Note: You can only select this option if the Integration
Server is congured to use SSL and certicates. For
more information, see "Securing Communications
with the Server" on page 401.

Color

Choose the color to use for the border around the

interface. If you have multiple s, you can use this feature
to distinguish Integration Servers from each other; for
example, you could use orange for Integration Servers in
your production environment, and blue for Integration
Servers in your test environment.

3. Click OK.

Basic Operation
When you start the Integration Server Administrator, your browser displays the
Statistics screen.

webMethods Integration Server Administrators Guide Version 9.10

86

Odd Header
Using the Integration Server Administrator

The Integration Server Administrator Screen

The Navigation panel on the left side of the screen displays the names of menus from
which you can select a task. To start a task, click a task name in the Navigation panel.
The server displays a screen that corresponds to the task you select.

Logging Off the Integration Server Administrator

Log o the Integration Server Administrator when you no longer need to continue your
current session. When you log o the Integration Server Administrator, the server cleans
up your session and clears the cache in the browser.
To log off the Integration Server Administrator
1. Click Log Off in the upper right corner of the Integration Server Administrator screen.
Integration Server displays a dialog box to ensure you want to log o.
2. Click OK to log o the Integration Server Administrator.
The browser displays a screen conrming that the session is terminated.

Getting Help
You can obtain information about the Integration Server Administrator by clicking
the Help link in the upper right corner of any Integration Server Administrator screen.
The help system displays a description of the parameters for the screen and a list of

webMethods Integration Server Administrators Guide Version 9.10

87

Even Header
Using the Integration Server Administrator

procedures you can perform from the screen. From this window, click Show Navigation
Area to view the help system's table of contents from which you can search for a specic
procedure or screen description.

The Configuration File

Conguration seings for the Integration Server are stored in
the server conguration le (server.cnf). This le resides in the
Integration Server_directory\instances\instance_name\ cong directory and contains
parameters that determine how the server operates.
Typically, you will use the Integration Server Administrator to set parameters in the
server.cnf le, but there may be times when you need to edit the le directly with a text
editor.
For a list of parameters in the server.cnf le and their default values, see "Server
Conguration Parameters" on page 851.

Software AG Command Central

Software AG Command Central is a tool that release managers, infrastructure engineers,
system administrators, and operators can use to perform administrative tasks from
a single location. Command Central can assist with the following conguration,
management, and monitoring tasks:
Infrastructure engineers can see at a glance which products and xes are installed,
and where. Engineers can also easily compare installations to nd discrepancies.
System administrators can congure environments using a single web UI, commandline tool, or API so maintenance can be performed with a minimum of eort and
risk.
Release managers can prepare and deploy changes to multiple servers using
command-line scripting for simpler, safer lifecycle management.
Operators can monitor server status and health, as well as start and stop servers
from a single location. They can also congure alerts to be sent to them in case of
unplanned outages.
For more information about Software AG Command Central, see the Command Central
documentation.

webMethods Integration Server Administrators Guide Version 9.10

88

Odd Header
Managing Users and Groups

6 Managing Users and Groups

Users and Groups ........................................................................................................................

90

Defining a User Account ..............................................................................................................

91

Disabling and Enabling Users ......................................................................................................

98

Defining Groups ...........................................................................................................................

99

webMethods Integration Server Administrators Guide Version 9.10

89

Even Header
Managing Users and Groups

Users and Groups

Use the Integration Server Administrator to dene user and group information to
the server. The denition for a user contains the user name, password, and group
membership. The denition for a group contains the group name and a list of users in
the group. The server stores and maintains the information.
Alternatively, you can set up the webMethods Integration Server to access the
information from an external directory if your site uses one of the following external
directories for user and group information:
Central user management
Lightweight Directory Access Protocol (LDAP)
This chapter describes only how the Integration Server works when user and group
information is dened internally. For information about using an external directory with
the Integration Server, see "Conguring a Central User Directory or LDAP" on page
559.

Purpose of Users and Groups

Integration Server uses user and group information to authenticate clients and
determine the server resources that a client is allowed to access.
If the server is using basic authentication (user names and passwords) to authenticate
a client, it uses the user names and passwords dened in user accounts to validate the
credentials a client supplies.
After a client is authenticated (whether through basic authentication or client
certicates), the server uses the group membership to determine if a client is authorized
for the requested action, such as, using the Integration Server Administrator or invoking
a service.
Access to the server's resources is controlled at the group level. By seing up users and
groups, you can control who can:
Configure and manage the server. Only users that are members of the Administrators
group (administrator privilege) can access the Integration Server Administrator.
Create, modify, and delete services that reside on the server. Only users that are members
of the Developers group (developer privileges) can connect to the server from
Software AG Designer.
Access services and files that reside on the server. Access to services and les is protected
at the group level.

webMethods Integration Server Administrators Guide Version 9.10

90

Odd Header
Managing Users and Groups

Defining a User Account

When you create a user account on Integration Server, you specify a user name,
password, and group membership.
User name. A user name is a unique name that identies a client. You can specify
a user name that represents an actual person (e.g., "JDSmith" for John D. Smith),
or you can specify a user name to represent applications, job functions, or
organizations. For example, you might set up generically named user names such as
"MktgPurchAgent," "MktgTimeKeeper," and so forth, to represent job functions.
Password. A password is an arbitrary string of characters that you associate with
a user name. The server uses the password when authenticating a client who has
submied a valid user name. For more information about authentication, see
"Customizing Authentication Using JAAS" on page 461.
A password is meant to be a secret code shared only by the server, the server
administrator, and the owner of the user account. Its purpose is to give the server
added assurance that a request is coming from a legitimate user. Only administrators
can assign a password to a user name and change a password for an existing
account. For additional security, the server hashes passwords before storing them.
Note:

Integration Server also provides password digest as an authentication

option.

Group membership. The group membership identies the groups to which a user
belongs. Access to the server's resources is controlled at the group level:
Only users that are members of the Administrators group can congure and
manage the server using the Integration Server Administrator. For more information
about controlling access to the Integration Server Administrator, see "FIPS 140-2
Compliance" on page 980.
Only users that are members of the Developers group can connect to the server from
Software AG Designer to create, modify, and delete services. For information, see
"Adding a Developer User" on page 95.
The server protects access to services and les using Access Control Lists (ACLs).
You set up ACLs that identify groups that are allowed or not allowed to access a
resource. For more information about protecting services and les, see "Controlling
Access to Resources with ACLs" on page 435.

Predefined User Accounts

The server has the following predened user accounts:

webMethods Integration Server Administrators Guide Version 9.10

91

Even Header
Managing Users and Groups

User

Groups

Description

Administrator

Everybody
Administrators
Replicators

A user account that has administrator

privileges. You can use the Administrator
user account to access the Integration Server
Administrator to congure and manage the
server.

Default

Everybody
Anonymous

The server uses the information dened for the

Default user when the client does not supply a
userid.

Developer

Everybody
Developers

A user that can connect to the server from

Software AG Designer to create, modify, and
delete services that reside on the server.

Replicator

Everybody
Replicators

The user account that the server uses during

package replication. For more information
about package replication, see "Copying
Packages from One Server to Another" on page
600.

Adding User Accounts

Use the following procedure to add a user account for a user.
To add a user account to the server
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
3. Click Add and Remove Users.
4. In the Create Users section of the screen, specify the following information:
For this parameter...

Specify...

User Names

A unique user name made up of a combination of leers,

numbers, or symbols. You can specify one user name per
line. Press ENTER to separate the lines.
User names are case sensitive. When you create a user
Important:
account, type it exactly as you want the client to enter
it.

webMethods Integration Server Administrators Guide Version 9.10

92

Odd Header
Managing Users and Groups

For this parameter...

Specify...
Note: The string "SAMLart" is a reserved word in Integration
Server. Do not create an Integration Server user name
consisting of this word.

Password

A password made up of a combination of leers, numbers, or

symbols.
A password is required and cannot be a null value or an
empty string.
Passwords are case sensitive. Type these values exactly
Important:
as you want the client to enter it.
Be sure to select passwords that are dicult to guess. For
example, use a mixture of upper- and lowercase leers,
numbers, and special characters. Do not use a name, phone
number, social security number, license plate or other
generally available information.

Re-Enter
Password

The same password again to make sure you typed it

correctly.

5. Select Allow Digest Authentication to use password digest as an authentication option.

6. Click Create Users.

Removing User Accounts

Use the following procedure to delete a user account when it is no longer needed.
Keep the following points in mind when deleting user accounts:
When you delete a user, Integration Server automatically removes the user from the
members lists of all the groups to which it was assigned.
The following built-in user accounts cannot be deleted: Administrator, Default,
Developer, and Replicator.
To delete a user account from the server
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
3. Click Add and Remove Users.
4. In the Remove Users section of the screen, select the user names for the user accounts
you want to delete.

webMethods Integration Server Administrators Guide Version 9.10

93

Even Header
Managing Users and Groups

5. Click Remove Users. The server issues a prompt to verify that you want to delete the
user account. Click OK to remove the user account.

Adding an Administrator User

A user has administrator privileges if he or she belongs to the Administrators group or
to any other group added to the Allow List of the Administrators ACL. To determine
if a user has administrator privileges, the server authenticates the user to obtain his or
her user name. (For information about how the server determines the user name, see
"Customizing Authentication Using JAAS" on page 461.) After determining the user
name, the server determines if the user belongs to a group that is allowed and does not
belong to any group that is denied access by the Administrators ACL. If so, the server
allows access to the Integration Server Administrator.
To grant administrator privileges to a user, you must assign that user to the
Administrators group or to a group you have added to the Allow list of the
Administrators ACL. In addition, you must make sure the user is not a member of a
group that is denied access by the Administrators ACL.
Important: The user to whom you want to grant administrative privileges must already
have a user account on the Integration Server. If the user does not already
have a user account, create one before you perform the following steps.
To grant administrative privileges to a user
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
Under Local User Management, the Groups area of the screen (on the right) contains
two lists. Users in this Group is a list of users currently in the selected group. Remaining
Users is a list of users not currently in the selected group.
3. In the Groups area of the screen, in the Select group list, select Administrators.
4. In the Remaining Users list, select (highlight) the user or users to whom you want to
grant administrator privileges.
To select additional users without deselecting currently selected users, press the
CTRL key while you click on the users you want to select. To deselect a user, press
the CTRL key while you click the currently selected entry.
5. After you have selected all the users you want to add to the group, click
. The server moves the selected users to the Users in this
Group list.
6. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

94

Odd Header
Managing Users and Groups

Adding a Developer User

A developer can use Software AG Designer to view, create, modify, and delete packages,
folders, services, and other elements that reside on the server. Before the server allows a
connection from Designer, it ensures that the user has developer privileges.
A user has developer privileges if he or she belongs to the Developers group or to any
other group added to the Allow List of the Developers ACL. To determine if a user
has developer privileges, the server authenticates the user to obtain their user name.
(For information about how the server determines the user name, see "Customizing
Authentication Using JAAS" on page 461.) After determining the user name, the
server determines if the user belongs to a group that is allowed and does not belong
to any group that is denied access by the Developers ACL. If so, the server allows the
connection between Designer and the server to be established.
To grant developer privileges to a user, you must assign that user to the Developers
group or to a group you have added to the Allow list of the Developers ACL. In
addition, you must make sure the user is not a member of a group that is denied access
by the Developer ACL.
Important: List, Read, and Write ACLs are a mechanism for protecting against
accidental tampering or destruction of elements. A developer making a
deliberate aempt can bypass this mechanism. Do not rely on ACLs for
protection in a hostile environment.
Important: The user to whom you want to grant developer privileges must already have
a user account on the Integration Server. If the user does not already have a
user account, create one for the user before you perform the following steps.
To grant developer privileges to a user
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
Under Local User Management, in the Groups area of the screen (on the right) contains
two lists. Users in this Group is a list of users currently in the selected group. Remaining
Users is a list of users not currently in the selected group.
3. In the Groups area of the screen, in the Select group list, select Developers.
4. In the Remaining Users list, select (highlight) the user or users to whom you want to
grant developer privileges.
To select additional users without deselecting currently selected users, press the
CTRL key while you click on the users you want to select. To deselect a user, press
the CTRL key while you click the currently selected entry.
5. After you have selected all the users you want to add to the group, click
. The server moves the selected users to the Users
Currently in this Group list.

webMethods Integration Server Administrators Guide Version 9.10

95

Even Header
Managing Users and Groups

6. Click Save Changes.

Changing Passwords
You can change the password for your user account or other user accounts. Keep the
following points in mind when changing passwords:
Do not change a password if you are outside of the corporate rewall and you did
not use SSL to connect to the Integration Server.
Passwords cannot be null values or empty strings.
Be sure to select passwords that are dicult to guess. For example, use a mixture of
upper- and lowercase leers, numbers, and special characters. Do not use a name,
phone number, social security number, license plate or other generally available
information; the security of your system depends on it.
You cannot use the Integration Server Administrator or Software AG Designer to
administer users or groups stored in an external directory. This restriction includes
changing the passwords of these users.
To change a user's password
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
3. In the Users section of the screen, select the user name for the user whose password
you want to change and click change password.
4. Enter the following information:
For this parameter...

Specify...

New Password

The new password, made up of any combination of leers,

numbers, or symbols. Null values and empty strings are
invalid.
Passwords are case sensitive. Type this value exactly as
Important:
you want the client to enter it.
Be sure to select passwords that are dicult to guess. For
example, use a mixture of upper- and lowercase leers,
numbers, and special characters. Do not use a name, phone
number, social security number, license plate or other
generally available information.

Confirm
Password

The same password again to make sure you typed it

correctly.

webMethods Integration Server Administrators Guide Version 9.10

96

Odd Header
Managing Users and Groups

5. Select Allow Digest Authentication to use password digest as an authentication option.

6. Click Save Password.

Setting Password Requirements

For security purposes, Integration Server places length and character restrictions on
passwords for administrator and non-administrator users. Integration Server contains
a default set of password requirements; however, you can change these with the
Integration Server Administrator. A non-administrator must observe these restrictions
when changing a password. An administrator user receives a warning if he or she
changes a password to one that does not meet these restrictions.
You can use the wa.server.password.mode conguration property to specify whether
or not to enforce the password restrictions when seing passwords for administrator or
non-administrator users. When this property is set to strict, the password restrictions
are enforced and when set to lax, the password restrictions are not enforced.
To set password length and character requirements for non-Administrator users
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
3. Click Password Restrictions.
4. Click Edit Password Restrictions.
5. Fill in information in the following elds:
Field

Description

Default

Enable Password
Change?

Whether users are allowed to change

their passwords. These users must have
developer privileges.

Yes

Minimum Password
Length

Minimum number of characters (alphabetic

characters, digits, and special characters
combined) the password must contain.

Minimum Number of
Upper Case Characters

Minimum number of upper case alphabetic

characters the password must contain.

Minimum Number of
Lower Case Characters

Minimum number of lower case alphabetic

characters the password must contain.

Minimum Number of
Digits

Minimum number of digits the password

must contain.

webMethods Integration Server Administrators Guide Version 9.10

97

Even Header
Managing Users and Groups

Field

Description

Default

Minimum Number of
Special Characters
(neither alphabetic nor
digits)

Minimum number of special characters,

such as asterisk (*), period (.), and question
mark (?) the password must contain.

Note:The use of special characters is

regulated by the following restrictions:
A password cannot begin with an
asterisk (*).
Passwords cannot contain
quotation marks ("), backslashes
(\), ampersands (&), or
less-than signs (<). Use the
wa.server.illegalUserChars
conguration property to restrict the
use of additional characters.

Disabling and Enabling Users

There may be times when you need to disable a user. Doing so makes password
cracking aacks harder by eliminating well-known user names. When you disable a
user, login aempts with that user name will fail authentication and be rejected. For
example, you might disable the user account of a developer who is on vacation, or
the account of a trading partner whose trading privileges are suspended. Because the
user has been disabled rather than deleted, you can later reinstate the account without
changing the password or reseing permissions.
For deployment, you should disable the Administrator user to prevent someone from
trying to guess the password and gain access to your system. Before disabling the
Administrator user, you must rst create another user, for example SmithAdmin, and
add it to the Administrators, Developers, and Replicators groups. Then disable the
Administrator user. (Internal server functions that run as the Administrator user, such as
start up and shut down services, will still be able to run as Administrator.) Then you can
use the SmithAdmin user to administer your Integration Server.

Disabling a User
Use the following procedure to disable a user.
Important: Before you disable the Administrator user, make sure you have dened
another user with administrator privileges so you are not locked out of the
server.

webMethods Integration Server Administrators Guide Version 9.10

98

Odd Header
Managing Users and Groups

To disable a user
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
3. Click Enable and Disable Users.
4. In the Enabled Users list select (highlight) the user or users you want to disable.
To select additional users without deselecting currently selected users, press the
CTRL key while you click on the users you want to select. To deselect a user, press
the CTRL key while you click the currently selected entry.
5. At the boom of the Enabled Users area of the screen click
.
The server moves the selected users to the Disabled Users area of the screen.
6. Click Save Changes.

Enabling a User
Use the following procedure to enable a user. The only time you will need to enable a
user is if the system administrator explicitly disabled it.
To enable a user
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
3. Click Enable and Disable Users.
4. In the Disabled Users list select (highlight) the user or users you want to enable.
To select additional users without deselecting currently selected users, press the
CTRL key while you click on the users you want to select. To deselect a user, press
the CTRL key while you click the currently selected entry.
5. At the boom of the Disabled Users area of the screen click
.
The server moves the selected users to the Enabled Users area of the screen.
6. Click Save Changes.

Defining Groups
A group is a named collection of users that share privileges. The privileges can be:
Administrator privileges
Replicator privileges

webMethods Integration Server Administrators Guide Version 9.10

99

Even Header
Managing Users and Groups

Developer privileges
Privileges to invoke a service
Privileges to allow the server to serve les
Privileges to invoke a service or access les are granted and denied by Access Control
Lists (ACLs) that you set up. When an administrator creates ACLs, he or she identies
groups that are allowed to access services and les and groups that are denied access to
services and les.
Administrator, replicator, and developer privileges are typically granted by adding a
user to the Administrators, Replicators, or Developers group, respectively. Alternatively,
you can create new groups and add them to the allow lists of the Administrators,
Replicators, or Developers ACLs.
Create groups that identify groups of users that will share the same privileges. When
you create a group denition, you specify a group name and the members of the group.
Group name. A group name is a unique name that identies the group. You can
use any name, for example, a name that denes a department (Marketing) or job
function (Programmers).
Members. List of user names that are members of the group.

Predefined Groups
Integration Server is installed with the following predened groups.
Group Name

Members

Description

Administrators

Administrator

This group identies users that have

administrator privileges. A user must have
administrator privileges to congure and
manage the server.
Membership in this group gives substantial
Important:
power to aect the conguration of
the Integration Server. Use caution in
assigning membership in this group to
individuals who can be trusted to use the
privilege carefully.

Anonymous

Default

This group identies users that have not

supplied a userid.

Developers

Developer

This group identies users that have developer

privileges. A user must have developer

webMethods Integration Server Administrators Guide Version 9.10

100

Odd Header
Managing Users and Groups

Group Name

Members

Description
privileges to connect to the server from the
Designer.
Membership in this group gives substantial
Important:
power to aect the conguration of
the Integration Server. Use caution in
assigning membership in this group to
individuals who can be trusted to use the
privilege carefully.

Everybody

Administrator
Default
Developer
Replicator

All users are a member of this group. Every

new user is automatically added to the
Everybody group.

Replicators

Administrator
Replicator

This group identies users that have replicator

privileges. The Replicators group gives its
members the authority to perform package
replication. (By default, the server uses
members of the Replicators group for package
replication.)
Users do not have to be members of the
Replicators group to perform package
replication. As long as user is a member of a
group that is assigned to the Replicators ACL, it
can perform package replication.
For more information about package
replication, see "Copying Packages from One
Server to Another" on page 600.
Membership in this group gives substantial
power to aect the conguration of the
Integration Server. Use caution in assigning
membership in this group to individuals who
can be trusted to use the privilege carefully.

Adding Groups
Use the following procedure to add groups.
To add a new group to the server
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.

webMethods Integration Server Administrators Guide Version 9.10

101

Even Header
Managing Users and Groups

3. Click Add and Remove Groups.

4. In the Create Groups area of the screen, type a unique group name made up of a
combination of leers, numbers, or symbols.
Important: Group names cannot contain spaces and special characters such as
comma (,), quotation marks ( or ), backslash (\), and forward slash (/).
You can add more than one group at a time by specifying multiple lines, one group
to a line. Press ENTER to separate lines.
5. Click Create Groups.

Adding Users to a Group

Use the following procedure to add users to a group.
Note:

You cannot change the membership of the Everybody group.

To add users to a group

1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
The server displays the following screen.

The Groups area of the screen (on the right) contains two lists. Users in this Group is a
list of users currently in the group. Remaining Users is a list of users not currently in
the group.
3. Under Groups, in the Select group list, select the group to which you want to add a
user.

webMethods Integration Server Administrators Guide Version 9.10

102

Odd Header
Managing Users and Groups

4. In the Remaining Users list select (highlight) the user or users you want to add to the
group.
To select additional users without deselecting currently selected users, press the
CTRL key while you click on the users you want to select. To deselect a user, press
the CTRL key while you click the currently selected entry.
5. After you have selected all the users you want to add to the group, click
. The server moves the selected users to the Users
Currently in this Group list.
6. Click Save Changes.

Removing Users from a Group

Use the following procedure to remove users from a group.
Note:

You cannot change the membership of the Everybody group.

To remove a user from a group

1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
The server displays the following screen.

The Groups area of the screen (on the right) contains two lists. Users in this Group is a
list of users currently in the group. Remaining Users is a list of users not currently in
the group.
3. Under Groups, in the Select group list, select the group from which you want to
remove a user.

webMethods Integration Server Administrators Guide Version 9.10

103

Even Header
Managing Users and Groups

4. In the Users in this Group area of the screen, select (highlight) users that you want to
remove from the group.
To select additional users without deselecting currently selected users, press the
CTRL key while you click on the users you want to select. To deselect a user, press
the CTRL key while you click the currently selected entry.
5. At the boom of the Users in this Group area of the screen click
. The server moves the selected users to the Remaining
Users area of the screen.

Viewing Group Membership

Use the following procedure to view the members or a group or change the members in
a group.
To view group membership for a group
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel click User Management.
The server displays the following screen.

The Groups area of the screen (on the right) contains two lists. Users Currently in this
Group is a list of users currently in the selected group. Remaining Users is a list of users
not currently in the selected group.
3. Under Groups, in the Select group list, select the group for which you want to view
membership.
4. The server displays the users in the Users in this Group list.

webMethods Integration Server Administrators Guide Version 9.10

104

Odd Header
Managing Users and Groups

Removing Groups
Use the following procedure to remove groups that you no longer need.
Note:

You cannot delete any of the following groups: Administrators, Developers,

Replicators, Anonymous, and Everybody.

To delete a group from the server

1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
3. Click Add and Remove Groups.
4. In the Remove Groups area of the screen, select the groups you want to remove.
5. Click Remove Groups.

webMethods Integration Server Administrators Guide Version 9.10

105

Even Header

webMethods Integration Server Administrators Guide Version 9.10

106

Odd Header
Configuring the Server

7 Configuring the Server

Viewing and Changing Licensing Information ............................................................................

108

Managing the Server Thread Pool .............................................................................................

110

Managing Server Sessions ........................................................................................................

112

Configuring Outbound HTTP Settings .......................................................................................

114

Setting Up Aliases for Remote Integration Servers ...................................................................

117

Specifying Third-Party Proxy Servers for Outbound Requests ..................................................

121

Configuring Where the Integration Server Writes Logging, Status, and Other Information ........

129

Switching from the Embedded Database to an External RDBMS .............................................

129

Working with Extended Configuration Settings ..........................................................................

130

Configuring Integration Server to Work with Servers Running HTTP 1.0 and Above ................

131

Specifying Character Encoding ..................................................................................................

131

Configuring the JVM ..................................................................................................................

132

Specifying the JDK or JRE for Integration Server .....................................................................

132

Changing the JVM Heap Size Used by Integration Server .......................................................

133

Publishing and Retracting Information about Integration Server Assets ....................................

134

Setting a Port for Remote Client JMX Monitoring .....................................................................

136

Configuring Integration Server to Accept a Debug Connection During Startup .........................

136

Using CORS with Integration Server .........................................................................................

webMethods Integration Server Administrators Guide Version 9.10

137

107

Even Header
Configuring the Server

Viewing and Changing Licensing Information

When you purchase a webMethods Integration Server, your organization is granted a
license to use it with certain features and functionality and with a specied number of
concurrent users (simultaneous sessions).
The license expires after a time period specied by your particular purchase agreement.

The License Key

Before you install Integration Server, you are provided with a license key le that you
place in the le system of the machine on which Integration Server will run. This le
contains your license key, which is a special code associated with your license.
When you install Integration Server, the setup program asks you to provide
the name and location of this le. The setup program then copies this le to the
Integration Server_directory\instances\instance_name\ cong directory with the name
licenseKey.xml. If this le is inadvertently deleted, Integration Server reverts to demo
mode. In this mode, there are only two licensed sessions and the server automatically
shuts down 30 minutes after it is started.

Viewing Licensing Information

To view licensing information or change the license key for your Integration Server, use
the Licensing screen in the Integration Server Administrator.
To view licensing information
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Licensing.
Integration Server displays a list of features, with a check mark next to each feature
you are licensed to use.
3. To view more detailed licensing information, click Licensing Details.
Integration Server displays detailed information, including the actual license key, the
list of features you are licensed to use, the maximum number of concurrent sessions
allowed to run on the server, and partner and Trading Networks information.

Changing Licensing Information

Use the following procedure to change your license key when your license expires or
you change your license to include dierent features.
Important: Before performing these steps, you must obtain a new license key le
from Software AG and copy it to the le system of the machine on which
Integration Server runs.

webMethods Integration Server Administrators Guide Version 9.10

108

Odd Header
Configuring the Server

To change the License Key

1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Licensing.
3. Click Licensing Details.
4. Click Edit Licensing Detail.
The server displays the Edit screen.
5. In the Integration ServerLicense Key File eld, enter the pathname for the license key le
you obtained from Software AG.
6. Click Save Changes.
Integration Server copies the contents of the license key le to
Integration Server_directory\instances\instance_name\ cong\licenseKey.xml and
updates the Integration ServerLicense Key File eld to reect that name.
Note:

Integration Server updates the expiration date automatically after you click
Save Changes. It is not necessary to restart Integration Server.

Renewal Reminders
Approximately 30 days before your license expires, Integration Server sends an e-mail
message to the administrative-message recipient, reminding him or her to renew the
license. In addition, the server displays the following message at the top of all pages on
the Integration Server Administrator:
License key expires in about xxx days ... contact Software AGfor a new key.

Renewing a Key
If you need to obtain a new key or renew your license, contact your Software AG sales
representative.

Adding Licensed Features

Available features are based on your contract with Software AG. To add features to your
contract, contact your Software AG sales representative.

Licensed Sessions
Your license allows a specied number of users to have sessions in the Integration Server
concurrently. The Integration Server creates a session when a developer connects to
the server from Software AG Designer or an IS client connects to the server to execute
services. If a user aempts to access the server while the maximum number of sessions
are in use, the server rejects the request and returns the following error to the user:
Server has reached client limit.

webMethods Integration Server Administrators Guide Version 9.10

109

Even Header
Configuring the Server

You can view the current number of active sessions and the licensed session limit using
the Statistics screen in the Integration Server Administrator. This value is permanently
associated with your license key and can only be changed by obtaining a new license.
Any connection made to the server by a non-Administrator user (that is, a user that is
not part of the Administrators group) consumes a licensed session. The session exists
until it times out (based on the server's Session Timeout seing) or the requester stops
the session by invoking the wm.server:disconnect service.
If a user invokes a stateless service and a session does not already exist for the user, the
server creates a session. If the user is a non-Administrator, the user consumes a licensed
session. After the service completes, the server removes the session and reduces the
number of licensed sessions in use.
Note:

If Integration Server receives multiple requests simultaneously and does not

have the resources to handle them, the server's performance might decrease.
You can tune performance by adjusting the concurrent stateful sessions limit
on the server. For more information, see "Managing Server Sessions" on page
112.

Viewing Active Sessions

Use the following procedure to view the number of active sessions and to check the
licensed sessions limit.
To view the number of active sessions and the licensed sessions limit
1. Open the Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Statistics.
The server displays the current number of active sessions in use in the Total Sessions
eld. The server displays the maximum number of licensed sessions your license
allows in the Licensed Sessions elds.
For detailed information about the active sessions, click the number in the Total
Sessions eld.

Managing the Server Thread Pool

To beer tune your server's performance, you can congure the minimum and
maximum number of threads. The server uses threads to execute services, retrieve
documents from the messaging provider, and execute triggers. When the server starts,
the thread pool initially contains the minimum number of threads. The server adds
threads to the pool as needed until it reaches the maximum allowed. If this maximum
number is reached, the server waits until processes complete and return threads to the
pool before beginning more processes.
You can also set a warning level for available threads. When the percentage of available
threads is equal to or less than the warning level, the server generates a journal log
webMethods Integration Server Administrators Guide Version 9.10

110

Odd Header
Configuring the Server

message to alert you to the reduced thread availability. The server generates another
journal log message when the number of available threads is greater than the threshold.
To view system threads that are running on the server, navigate to the Server > Statistics >
System Threads screen. See Canceling or Killing a Thread for more information.
To configure the server thread pool
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Resources.
3. Click Edit Resource Settings.
4. Under Server Thread Pool, update the server thread pool seings, as follows:
For this parameter...

Specify...

Maximum Threads

The maximum number of threads that the server

maintains in the server thread pool. If this maximum
number is reached, the server waits until processes
complete and return threads to the pool before running
more processes. The default is 75.

Minimum Threads

The minimum number of threads the server maintains

in the server thread pool. When the server starts, the
thread pool initially contains this minimum number
of threads. The server adds threads to the pool as
needed until it reaches the maximum allowed, which is
specied in the Maximum Threads eld. The default is 10.

Available Threads
Warning Threshold

Threshold at which the server starts to warn of

insucient available threads. When the percentage
of available server threads equals this percentage, the
server generates a Journal log message indicating the
current available thread percentage and stating:
Available Thread Warning Threshold Exceeded

The default is 15%.

When you enter a percentage and save your changes,
the server automatically calculates the number of
threads and displays the number next to the specied
percentage.
Tip: When the percentage of available threads falls
below the warning level, you might want to
decrease the number of documents the server
receives and processes for webMethods messaging

webMethods Integration Server Administrators Guide Version 9.10

111

Even Header
Configuring the Server

For this parameter...

Specify...
triggers. For more information, see Managing
webMethods Messaging Triggers.

Scheduler Thread
Throttle

Percentage of server threads the scheduler function is

permied to use. The default is 75%.

5. Click Save Changes.

Managing Server Sessions

Integration Server starts a new session for every remote client that connects to it. If a
session becomes idle or inactive for a long period of time or if too many stateful sessions
are created simultaneously, the server's performance might be aected.
Integration Server provides various controls that you can use to manage sessions.
Specically, you can:
Limit the number of minutes an idle session can remain active.
Limit the number of stateful sessions that can be created on the server concurrently.
Set a warning level for available stateful sessions.

Setting the Session Timeout Limit

Once a session starts, it remains active until the client application specically issues
a disconnect instruction to the server (which forces an immediate termination) or the
session "times out" due to inactivity, whichever comes rst.
If a session is idle for a long period of time, it usually means that the client is no longer
active or that the connection between client and the server has been lost. The server
constantly monitors for inactive sessions, and terminates sessions that are idle for
more than the allowed period of time. If the server did not take steps to clear out such
sessions, they would remain active indenitely, wasting valuable server resources.
To set the session timeout limit
1. Open the Integration Server Administrator if it is not already open.
In the Settings menu of the Navigation panel, click Resources.
2. Click Edit Resource Settings.
3. Under Session in the Session Timeout eld, enter maximum number of minutes an
idle session can remain active (in other words, how long you want the server to wait
before terminating an idle session).
To set the Session Timeout parameter appropriately, you must be familiar with the
clients that use your server. If your clients are all Java programs, you can usually
webMethods Integration Server Administrators Guide Version 9.10

112

Odd Header
Configuring the Server

reduce the timeout value to 6 or 7 minutes. You may need to experiment with this
seing to nd the appropriate value for your site. By default, the server uses a
timeout limit of 10 minutes. This is an appropriate value for most sites. However,
you may have to increase this value if your clients normally have lengthy delays
(greater than 10 minutes) between successive requests.
4. Click Save Changes.

Setting the Stateful Session Limit

Integration Server starts a new session for every remote client that connects to it. This
can be a problem if the server receives multiple requests simultaneously and does not
have the resources to handle them.
The number of concurrent sessions allowed is specied by your license. However, you
can tune performance by seing the stateful session limit using the Resources screen in
Integration Server Administrator. When you set a stateful session limit and the number
of concurrent stateful sessions exceeds that limit, the server rejects new requests and
returns an error message to the user.
You can also set a warning level for available stateful sessions. When the percentage of
available stateful sessions is equal to or less than the warning level, the server generates
a message in the server log to alert you of stateful session use and availability.
To set the stateful sessions limit
1. Open the Integration Server Administrator if it is not already open.
In the Settings menu of the Navigation panel, click Resources.
2. Click Edit Resource Settings.
3. Under Session, update the server session seings, as follows:
For this parameter...

Specify...

Enable Stateful Session

Limit

Whether you want Integration Server to limit the

number of concurrent stateful sessions. If you want to
enable a stateful session limit, select Yes; otherwise,
select No.
When enabled, the number of stateful sessions that can
exist simultaneously on the server is dened by the
Maximum Stateful Sessions parameter.
You can view statistics for stateful sessions on
the Server > Statistics screen in Integration Server
Administrator. When disabled, statistics for stateful
sessions are still gathered and displayed on the Server >
Statistics screen.

webMethods Integration Server Administrators Guide Version 9.10

113

Even Header
Configuring the Server

For this parameter...

Specify...

Maximum Stateful
Sessions

The maximum number of concurrent stateful sessions

that can exist on the Integration Server. If a user
aempts to access the server and execute a stateful
service while the maximum number of stateful sessions
are in use, the server rejects the request and returns the
following error to the user:
Server is not accepting new requests at this time.

The value must be a positive integer. If a value is not

specied or the feature is disabled, the maximum
number of concurrent sessions is determined by the
licensed sessions limit specied in your Integration
Server license le.
Available Stateful
Sessions Warning
Threshold

Threshold at which Integration Server starts to warn

of insucient available stateful sessions. When the
percentage of available stateful sessions equals or falls
below the value of this property, Integration Server
generates a server log message stating:
{0}% or more of maximum number of concurrent stateful
sessions are in use. {1} sessions are available

The default is 25%.

4. Click Save Changes.

Configuring Outbound HTTP Settings

Outbound HTTP parameters control how the server presents and processes outbound
HTTP and HTTPS requests (i.e., requests that Integration Server issues on behalf of
a client). The parameters control behavior such as how long the server waits for a
response, how many times it retries a failed request, and so forth.
Developers can override some of the server's outbound HTTP seing defaults at run
time, as described below.
Parameter

Description

User Agent

Species the value that the server uses in the HTTP User
Agent request header that it sends when requesting a web
document. The User Agent header tells a web server what
type of browser is making the request. In the case of the
Integration Server, the User Agent header indicates the
type of browser that the Integration Server appears to be
to the web server. Some web servers examine this header

webMethods Integration Server Administrators Guide Version 9.10

114

Odd Header
Configuring the Server

Parameter

Description
to determine a client's capabilities so they can tailor their
responses accordingly.
When you install the Integration Server, the User Agent
parameter is set to Mozilla/4.0 [en] (WinNT; I). You can
change this value as you need; however, the value you
set should satisfy the majority of services that your server
executes.
Be sure your developers know the User Agent value your
server uses. If their applications require a dierent User
Agent, they can override the server's default at run time by
including an HTTP User Agent header with their request.

Maximum
Redirects

Species the number of times that the Integration Server

allows a request to be redirected (i.e., automatically sent
to another URL by the target server. If a request exceeds
the specied number of redirections, the Integration Server
immediately returns an I/O exception to the client.
When you install the Integration Server, Maximum Redirects
is set to 5. You will need to increase this value if the targets
that you access typically redirect their requests more than
this. (This may happen if the target operates in a clustered
environment.)

Timeout

Species the length of time the server waits for a response

from a target server. If the Integration Server does not receive
a response in the alloed time, it retries the request up to the
number of times specied by the Retries parameter. When the
allowed number of retries is exceeded, the server returns an
exception.
When you install the Integration Server, the Timeout
parameter is set to 300 seconds (5 minutes). To set Integration
Server to wait indenitely for a response from the target
server, set this parameter to 0.
If you set the Timeout parameter to 0 and the target
Important:
server does not respond to the request, the Integration
Server making the request cannot process new requests
due to thread pool exhaustion.
You can also specify number of seconds the server waits for
an HTTP request to be fullled using the wa.net.timeout
server conguration parameter. For more information, see
"Server Conguration Parameters" on page 851.

webMethods Integration Server Administrators Guide Version 9.10

115

Even Header
Configuring the Server

Parameter

Description

Retries

Species the number of times the server reissues a request

that has timed out (i.e., one from which it did not receive
a response within the time period specied by the Timeout
parameter).
When you install the Integration Server, Retries is set to 0.
This means that the server automatically returns an exception
if it does not get a response within the alloed time. Set
Retries to a value greater than 0 if you want the server to retry
(reissue) timed-out requests. The server will retry the request
the number of times you specify.
Make sure that your developers know the Retries value that
your server uses. If they need to use a dierent value, they
can explicitly assign a Retries value to their service.

Specifying Outbound HTTP Settings

Use the following procedure to specify the Outbound HTTP Seings.
To set the Outbound HTTP Settings
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Resources.
3. Click Edit Resource Settings.
4. Set the Outbound HTTP Settings as follows:
For this parameter...

Specify...

User Agent

The string that you want the server to supply in the

HTTP User Agent header if the client does not specify a
value. Type the string exactly as you want it to appear
in the HTTP header, including spaces, symbols, and
punctuation.

Maximum Redirects

An integer that indicates the number of times to allow a

request to be redirected before the server returns an I/O
exception to the client.

Timeout

An integer that indicates the number of seconds the

server waits for a response from the target server before
retrying the service or returning a timeout error to the
client.

webMethods Integration Server Administrators Guide Version 9.10

116

Odd Header
Configuring the Server

For this parameter...

Specify...

Retries

An integer that indicates the number of times the server

retries a service that has timed out before returning an
exception to the client.

5. Click Save Changes.

Setting Up Aliases for Remote Integration Servers

You can set up aliases for remote servers. Communication through the alias is optimized,
making transactions with the remote server faster.
Use a remote alias when:
Invoking services on otherIntegration Servers. After you establish aliases, you can use the
pub.remote:invokeand pub.remote.gd:*services to invoke services on remote servers by
identifying the remote servers by their aliases.
Presenting multiple client certificates. The Integration Server can present a single client
certicate to all servers or it can present dierent client certicates to dierent SSL
servers. In addition, the Integration Server can present certicates provided for
this purpose by other organizations. Seing up remote aliases for these SSL servers
makes it easier to present dierent certicates to them. See Using Multiple Client
Certicates for more information.
Performing package replication. For a subscriber to set up a subscription with a
publisher or pull a package from the publisher, you must dene the publishing
server as a remote server to the subscriber. The alias tells the subscribing server how
to connect to the publishing server to set up the subscription or pull the package. See
The Subscribing Server for more information.
The denition for an alias contains the connection information the server requires to
connect to a remote server. It identies the host name or IP address of the remote server
and indicates whether the server should use an HTTP or HTTPS connection to connect
to the remote server.
The alias also identies a user name and password that the server supplies to the remote
server. The remote server uses the user name and password to authenticate the client
and to determine if the client is authorized to execute the requested service.
In eect, the alias grants access to a remote service by allowing the user to impersonate
an authorized user on the remote server. Therefore, to prevent unauthorized users from
accessing services on remote servers, the alias also contains access control information.
You specify an ACL that protects the use of the alias. If a client that is authorized to
use the alias makes a request, the server will request the service on the remote server.
If a client that is not authorized to use the alias makes a request, the server rejects the
request and does not invoke the service on the remote server.

webMethods Integration Server Administrators Guide Version 9.10

117

Even Header
Configuring the Server

Adding an Alias for a Remote Integration Server

Use the following procedure to add an alias for a remote Integration Server.
To add an alias for a remote server
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Remote Servers.
3. Click Create Remote Server Alias.
4. Set the Remote Server Alias Properties as follows:
For this parameter...

Specify...

Alias

Name that you want to use for the alias. You can give the
remote server any alias name but it cannot include the
following illegal characters: #-&@^!%*:$./\\`;,~+=)(|}{][><" .

Host Name or IP
Address

Host name or IP address of the remote server

for which you are creating an alias (e.g.,
workstation5.webmethods.com).
Note: This eld does not accept white-space characters (or
blank spaces).

Port Number

Port number on which the remote server listens for

incoming requests from your server (e.g., 5555).

User Name

User name for a user account on the remote server. When

you invoke a service using this alias, the remote server
uses this user account for authentication and access
control. Specify a user name that has access to the services
you want to invoke on the remote server.

Password

Password identied in the user account for User Name.

Execute ACL

ACL that governs which user groups on your server can

use this alias for the remote server. Select an ACL from
the drop down list. By default, only members of groups
governed by the Internal ACL can use this alias.

Max Keep Alive

Connections

Sets the default number of client keep alive connections

to retain for a given target endpoint. If not specied, ve
keep alive connections are retained. This eld species
the maximum number of client connections that should

webMethods Integration Server Administrators Guide Version 9.10

118

Odd Header
Configuring the Server

For this parameter...

Specify...
be retained for any given remote host. In other words,
this is not a maximum number of connections that can be
established, but a limit on the number of inactive client
connections to retain for reuse.

Keep Alive Timeout

Species the length of time (in minutes) that your server

maintains an idle connection to a remote server. This value
will cause the connection to be retained for possible reuse
until it times out. If the specied keep alive timeout value
expires, the connection will close and the HTTP Listener
will aempt to create a new one.

Use SSL

Whether you want your server to connect to the remote

server using Secure Sockets Layer (SSL). If you want to use
SSL, select yes; otherwise, select no.
If you select yes, the remote server must be
Important:
congured to listen for incoming HTTPS requests.

Keystore Alias
(optional)

A user-specied, text identier for an Integration Server

keystore.
The alias points to a repository of keys and their associated
SSL certicates.

Key Alias (optional)

The alias for the Integration Server private key and

associated certicate, which must be stored in the keystore
specied by the above keystore alias.
You must create a key alias with a third-party certicate
utility, such as Java keytool. You cannot create a key alias
with Integration Server Administrator.

Retry Server

Host name or IP address (for example,

workstation6.webmethods.com) of a remote server you
want your local Integration Server to connect to if the
primary remote server is unavailable. The retry server
you specify will use the same port as the primary remote
server. If the remote server is part of a cluster, the local
Integration Server will, by default, try to connect to other
Integration Servers in the cluster before trying to connect
to the retry server. If clients are using the pub.remote:invoke
service to run services on a remote server, it is possible to
change this default behavior by using the $retryCluster
input parameter with the service. If you set this parameter
to false, the service will not try to use other Integration

webMethods Integration Server Administrators Guide Version 9.10

119

Even Header
Configuring the Server

For this parameter...

Specify...
Servers in the cluster. Instead, the service will immediately
try using the retry server specied on this screen.

5. Click Save Changes.

Testing the Connection to a Remote Server

After you add an alias, you can test the connection to the remote server to ensure that
the host name (or IP address) and port number specied for the alias identies an
Integration Server that is currently running. Use the following procedure to test the
connection.
To test the connection to a remote server
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Remote Servers.
3. Click the

icon in the Test column for the alias you want to test.

The server displays a status line that indicates whether the connection is successful
or not. The status line is displayed above the list of existing aliases.

Editing an Alias
If you need to update the information for an alias, you can edit it to make your changes.
Use the following procedure to edit an alias.
To edit an alias for a remote server
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Remote Servers.
3. Locate the alias you want to edit and click on the alias name.
4. Update the information for the alias.
5. Click Save Changes.

Deleting an Alias
If you no longer need an alias for a remote server, you can delete it. Use the following
procedure to delete an alias.
To delete an alias for a remote server
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Remote Servers.

webMethods Integration Server Administrators Guide Version 9.10

120

Odd Header
Configuring the Server

3. Locate the alias you want to delete and click the

icon in the Delete eld. The server
displays a dialog box that prompts you to verify your action. Click OK to verify that
you want to delete the alias.

Specifying Third-Party Proxy Servers for Outbound Requests

When Integration Server executes a request against a remote server, it issues an HTTP,
HTTPS, FTP, or SOCKS request to the specied target server. For example, Integration
Server might invoke a service on a remote Integration Server or execute a web service
connector that invokes a web service. If your Integration Server sits behind a rewall,
and must route these HTTP, HTTPS, FTP, or SOCKS requests through a third party
proxy server, you can use Integration Server Administrator to identify one or more
proxy servers to which Integration Server will route these requests.
For Integration Server to use a proxy server, you must dene a proxy server alias. The
proxy server alias identies a proxy server and a port on the server through which you
want to route requests.
You can congure Integration Server to route requests to one or more proxy server
aliases for each type of outbound request (HTTP, HTTPS, FTP, and SOCKS).
You can specify a default proxy server for each protocol type. Integration Server uses the
default proxy server alias when one is not specied by the pub.client:http, pub.client:ftp.login,
or pub.client.ftp service. Integration Server also uses the default proxy server alias when
executing a web service connector associated with an HTTP/S consumer web service
endpoint alias that does not specify a proxy alias.
Note:

If you have congured and enabled a SOCKS proxy server alias, it acts as a
fallback proxy server for HTTP, HTTPS, and FTP proxy server aliases. Even if
a SOCKS proxy is set as the default proxy server alias, Integration Server gives
precedence to the congured HTTP, HTTPS, and FTP proxy server aliases for
the corresponding outbound requests before aempting to connect through
the SOCKS proxy alias.

How Integration Server Uses Proxy Servers

When Integration Server sends a request to a remote server, Integration Server routes
the request through a proxy server unless the domain of the target server is listed as a
proxy bypass. When a domain appears on the proxy bypass list, Integration Server sends
requests directly to the target server. If a domain is not on the proxy bypass list, the
proxy server that Integration Server uses to send the request depends on the following
conditions:
Whether the request species a proxy server alias
Whether a default proxy server alias exists and is enabled.

webMethods Integration Server Administrators Guide Version 9.10

121

Even Header
Configuring the Server

The following table describes how Integration Server determines which proxy server to
use when sending a request. This process applies to the HTTP, HTTPS, FTP, and SOCKS
protocols.
Proxy
Server Alias
Specified?

Default Proxy
Server Alias
Exists?

Action taken by Integration Server

Yes

NA

If the specied proxy server alias is enabled,

Integration Server sends the request using
the proxy server in the specied proxy alias.
If the send aempt fails, Integration Server
does not aempt to make a direct connection
to the remote server. Also, Integration Server
does not use the proxy server specied in the
default proxy alias or any other proxy server
to send the request.
If the specied proxy server alias is disabled,
the send request fails.

No

Yes

If the default proxy server alias is enabled,

Integration Server sends the request
using the proxy server in the default
proxy server alias. If the send aempt
fails, Integration Server either sends
the request to the remote server using a
direct connection or throws an exception
depending on the seings specied for the
wa.net.proxy.fallbackToDirectConnection
parameter.
If the default proxy server alias is not
enabled, Integration Server sends the
request using a proxy server for any of
the congured proxy server aliases. If
the aempt to send a request made using
that proxy server fails, Integration Server
tries to send using another proxy server
alias. Integration Server continues making
aempts, using each enabled proxy server
alias (in an unspecied order) until the
request is sent or all proxy servers have
been tried but failed. After all proxy
servers fail, Integration Server either sends
the request to the remote server using a
direct connection or throws an exception
depending on the seings specied for the

webMethods Integration Server Administrators Guide Version 9.10

122

Odd Header
Configuring the Server

Proxy
Server Alias
Specified?

Default Proxy
Server Alias
Exists?

Action taken by Integration Server

wa.net.proxy.fallbackToDirectConnection
parameter.
No

No

Depends on the value specied for the

wa.net.proxy.useNonDefaultProxies
parameter.
If wa.net.proxy.useNonDefaultProxies
parameter is set to true, Integration Server
makes outbound requests using each enabled
proxy server alias (in an unspecied order)
until the request is sent successfully or all
proxy servers have been tried but failed.
After all proxy servers fail, Integration Server
sends the request to the remote server using
a direct connection or throws an exception
depending on the seings specied for the
wa.net.proxy.fallbackToDirectConnection
parameter.
If no proxy server aliases exist for the
specied protocol, Integration Server sends
the request to the remote server using a
direct connection or throws an exception
depending on the seings specied for the
wa.net.proxy.fallbackToDirectConnection
parameter.
If the
wa.server.proxy.useNonDefaultProxies
parameter is set to false, Integration Server
does not aempt to make outbound requests
using the enabled proxy server aliases.
Integration Server sends the request to the
remote server using a direct connection.

Creating a Proxy Server Alias

Proxy server alias names must be unique across protocols. In other words, you cannot
have proxy server aliases of the same name but of dierent protocols. For example, you
can have only one proxy server alias named myProxy across the HTTP, HTTPS, FTP,
or SOCKS protocols.

webMethods Integration Server Administrators Guide Version 9.10

123

Even Header
Configuring the Server

To create a proxy server alias

1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Proxy Servers.
3. Click Create Proxy Server Alias.
4. Under Proxy Server Alias Properties, provide information in the following elds:
For this parameter...

Specify...

Alias

The alias name to use for this host/port combination.

Host Name or IP
Address

The host name or IP address of the proxy server.

Port Number

The port on which this proxy server listens for requests.

User Name (optional)

The user name Integration Server must use when

accessing this proxy server.

Password (optional)

The password Integration Server must use to access

this proxy server.

Protocol

The type of protocol (HTTP, HTTPS, FTP, or SOCKS) to

use for the host/port combination.

Proxy Type

If you select FTP, additional parameters appear to help

you congure the Proxy Type. For requests that the
proxy server will be forwarding to an FTP server, you
must specify the following information:
The name of the FTP server
The name of a user on the FTP server
The password for that user.
The method you use to send this information to the
FTP proxy server depends on the type of proxy server
you have. Integration Server supports the following
proxy server types:
0. No proxy
Do not use an FTP proxy server. This is the default.
1. ftp_user@ftp_host no proxy auth

webMethods Integration Server Administrators Guide Version 9.10

124

Odd Header
Configuring the Server

For this parameter...

Specify...
Connect to the proxy server, but do not log into it. Then
send the following:
USER ftp_user@ftp_host
PASS ftp_password

2. ftp_user@ftp_host proxy auth

Connect to the proxy server, and log into it with:
USER proxy_user
PASS proxy_password

Then send the following:

USER ftp_user@ftp_host
PASS ftp_password

3. site command
Connect to the proxy server, and log into it with:
USER proxy_user
PASS proxy_password

Then send the following:

SITE ftp_host
USER ftp_user
PASS ftp_password

4. open command
Connect to the proxy server, and log into it with:
USER proxy_user
PASS proxy_password

Then send the following:

OPEN ftp_host
USER ftp_user
PASS ftp _password

5. ftp_user@proxy_user@ftp_host
Connect to the proxy server and log into it. Then send
the following:
USER ftp_user@proxy_user@ftp_host
PASS ftp_password@proxy_password

6. proxy_user@ftp_host
Connect to the proxy server, and log into it with:
USER proxy_user@ftp_host
PASS proxy_password

Then send the following:

USER ftp_user

webMethods Integration Server Administrators Guide Version 9.10

125

Even Header
Configuring the Server

For this parameter...

Specify...
PASS ftp_password

7. ftp_user@ftp_host proxy_user
Connect to the proxy server, but do not log into it. Then
send the following:
USER ftp_user@ftp_host proxy_user
PASS ftp_password
ACCT proxy_password

SOCKS Version

If you select SOCKS as the protocol, additional

parameters appear to help you congure the SOCKS
version. Select SOCKS v4or SOCKS v5 based on what
version of SOCKS protocol you would like to use to
connect to the proxy server.
Note: SOCKS protocol version 4 does not support
authentication. Do not specify authentication
credentials (i.e. username and password) if you
select SOCKS protocol version 4.

Default

Whether this proxy server alias should be the default

proxy server alias for its protocol type or not. Click Yes
or No. Only one default proxy server alias can be set for
each protocol type.

5. Click Save Changes.

Editing a Proxy Server Alias

If you need to make changes to the properties of a particular proxy server alias, you can
edit it.
To edit a proxy server alias
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Proxy Servers.
3. On the Proxy Servers List table, under Alias column, click on the name of the proxy
server alias you wish to edit.
The Edit screen appears.
4. Modify the required Proxy Server Alias Properties.
5. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

126

Odd Header
Configuring the Server

Disabling a Proxy Server Alias

Use the following procedure to disable a proxy server alias.
To disable a proxy server alias
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Proxy Servers.
3. On the Proxy Servers main screen, click Yes under the Enabled column of the Proxy
Servers List.
Integration Server displays a dialog box that prompts you to conrm your action.
4. Click OK to disable the proxy server alias.

Enabling a Proxy Server Alias

Use the following procedure to enable a proxy server alias.
To enable a proxy server alias
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Proxy Servers.
3. On the Proxy Servers main screen, click No under the Enabled column of the Proxy
Servers List.
Integration Server displays a dialog box that prompts you to verify your action.
4. Click OK to enable the proxy server alias.

Specifying a Default Proxy Server Alias

You can identify a default proxy server alias for each protocol type. Integration Server
uses the default proxy server alias when one is not specied by the pub.client:http,
pub.client:ftp.login, or pub.client.ftp services. Integration Server also uses the default proxy
server alias when a consumer web service endpoint alias for the HTTP or HTTPS
protocols does not specify a proxy server alias.
You can make any proxy server alias the default alias. However, there can be only one
default proxy for a given protocol type.
To select the default proxy server alias for a protocol
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Proxy Servers.

webMethods Integration Server Administrators Guide Version 9.10

127

Even Header
Configuring the Server

3. On the Proxy Servers List table, under Alias column, click on the name of the proxy
server alias to use as the default.
4. Under Proxy Server Alias Properties, click Yes in the Default section to make this your
new default proxy server.
5. Click Save Changes.
If another proxy server alias is already congured as the default proxy server alias
for that protocol, Integration Server displays a dialog box that prompts you to
conrm the change.
6. Click OK to change the default proxy server alias.

Deleting a Proxy Server Alias

If you no longer need a proxy server alias, you can delete it.
To delete a proxy alias
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Proxy Servers.
3. In the Proxy Servers List, locate the alias you want to delete and click the
the Delete column.

icon in

Integration Server displays a dialog box that prompts you to conrm your action.
4. Click OK to delete the selected proxy server alias.

Bypassing a Proxy Server

If you are using a proxy server for outbound HTTP, HTTPS, FTP, or SOCKS requests,
you can optionally route selected requests directly to their targets, bypassing the proxy.
To do this, use the Integration Server Administrator to dene a list of domains to which
you want Integration Server to issue requests directly.
To specify the proxy bypass addresses
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Proxy Servers.
3. Click Edit Proxy Bypass.
4. In the Addresses eld, type the fully qualied host and domain name of each server
to which you want the Integration Server to issue requests directly. Type the host
name and the domain name exactly as they appear in the URLs the server uses. To
enter multiple names, separate each with commas.
You can use the asterisk (*) to identify several servers with similar names. The
asterisk matches any number of characters. For example, if you want to bypass

webMethods Integration Server Administrators Guide Version 9.10

128

Odd Header
Configuring the Server

requests made to localhost, www.yahoo.com, home.microsoft.com, and all hosts

whose names begin with NYC, you would type:
localhost,www.yahoo.com,home.microsoft.com, NYC*.*

5. Click Save Changes.

The proxy bypass addresses appear under Proxy Bypass on the Proxy Servers main
screen.

Configuring Where the Integration Server Writes Logging,

Status, and Other Information
Integration Server collects and stores data about the dierent areas of Integration Server
functioning, including internal processing (scheduled jobs, Guaranteed Delivery, trigger
joins), auditing and logging, central user management, document history, and process
integrity. This data is stored in various database components that are identied to
Integration Server through functional aliases. For information about the data stored in the
dierent database components, and instructions on conguring functional aliases, refer
to Installing Software AG Products.

Switching from the Embedded Database to an External

RDBMS
If you installed your Integration Server with an embedded database, you can later
switch to an external RDBMS.
To switch from an embedded database to an external RDBMS
1. Navigate to the Security > Certificates > Client Certificates screen on the Integration
Server Administrator, and make a note of the certicate mappings.
2. Create the IS Internal and Cross Reference database components and connect them
to JDBC connection pools. See Installing Software AG Products for instructions.
Note:

After you connect the database components to the JDBC connection pools,
Integration Server will begin writing to the external RDBMS. You do not
have to set any properties.

3. Run the migration utility pub.scheduler:migrateTasksToJDBC to migrate your scheduled

tasks from the embedded database to the external RDBMS. See the webMethods
Integration Server Built-In Services Reference for more instructions.
Note:

This service migrates scheduled tasks only; certicate mappings and runtime data stored in the embedded database will not be migrated.

4. Navigate to the Security > Certificates > Client Certificates screen on the Integration
Server Administrator and re-specify your certicate mappings. See Importing
webMethods Integration Server Administrators Guide Version 9.10

129

Even Header
Configuring the Server

a Certicate (Client or CA Signing Certicate) and Mapping It to a User for

instructions.

Working with Extended Configuration Settings

There may be times when you want to view special server property seings. These
properties are specied in the server.cnf le, however you can view them and edit
them using the Integration Server Administrator. Typically, you do not need to change
these seings unless directed to by webMethods documentation or Software AG Global
Support.
Important: Typically, you will use the Integration Server Administrator to set properties
in the server.cnf le, but there may be times when you need to edit the le
directly with a text editor. Before updating this le directly, be sure to shut down
the Integration Server.
To view and edit extended configuration settings
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Extended.
The server displays a screen that lists conguration properties specied in the
server.cnf le.
3. By default, no properties are shown. If the properties you want to view are shown,
skip this step. To select properties to be displayed, click Show and Hide Keys.
The server displays a list of all properties included in the server.cnf le (their values
are not shown.) Select the box to the left of each property you want the server to
display and click Save Changes. The server displays the Extended Settings screen again,
this time with the selected properties and their values displayed.
4. To add, delete, or change a property seing, click Edit Extended Settings and type your
changes.
Important: Any change you make here will be reected in the server.cnf le.
5. Click Save Changes.
Any properties you added will automatically display a check mark
in the Show
and Hide Keys list and will be displayed, with their values, in the Extended Settings list.
6. Restart the server for the changes to take eect.
a. In the upper right corner of any Integration Server Administrator screen, click
Shutdown and Restart.
b. Select whether you want the server to wait before restarting or to restart
immediately.
c. Click Restart.

webMethods Integration Server Administrators Guide Version 9.10

130

Odd Header
Configuring the Server

Configuring Integration Server to Work with Servers Running

HTTP 1.0 and Above
Sometimes when your Integration Server connects to the partner server, the server may
crash before sending back a response. If your Integration Server maintains backward
compatibility with HTTP 0.9, it does not mandate a response code and consequently, it
treats no response from the target server as a valid response. This is an error.
Integration Server now contains a wa property that you can set to indicate whether it
maintains compatibility with another server using HTTP 0.9.
Use the following procedure to update your Integration Server to work with servers
running HTTP 1.0 and above only.
To set Integration Server to work with servers running HTTP 1.0 and above
1. In the Settings menu of the Navigation panel, click Extended.
2. Click Edit Extended Settings.
3. Type watt.server.http.pointnineSupport=false.
4. Click Save Changes.
Note:

Set wa.server.hp.pointnineSupport to true if you want Integration

Server to communicate with servers using HTTP 0.9 and above.

Specifying Character Encoding

To ensure interpretability with other applications, Integration Server supports multiple
forms of character encoding. The following table shows the default seings and the
server properties that control them.
Action

Default Setting

Controlling Property

Reading and writing text

files

Your JVM's le.encoding

property

wa.server.leEncoding

Reading text from and

writing text to the network

UTF-8

wa.server.netEncoding

Important: Consult with Software AG Global Support before changing these seings.
The default seings are appropriate in most cases. Seing them incorrectly
can cause unpredictable results.

webMethods Integration Server Administrators Guide Version 9.10

131

Even Header
Configuring the Server

Configuring the JVM

The conguration seings for the JVM in which Integration Server runs are specied
by properties contained in the custom_wrapper.conf. These seings are given to the
Java Service Wrapper when it launches the JVM. The procedures for updating the JVM
conguration seings are provided in the following topics:
Specifying the JDK or JRE for Integration Server
Changing the JVM Heap Size Used by Integration Server
Passing Java System Properties to Integration Server
For more information about the Java Service Wrapper, see Software AG Infrastructure
Administrator's Guide.

Specifying the JDK or JRE for Integration Server

Integration Server must point to a JDK or JRE. By default, Integration Server points to
the location of the JDK installed at the same time you installed Integration Server. If
necessary, you can specify a dierent location.
Before you specify the location of Java for Integration Server, determine whether you
need to specify the location of the JDK or the JRE. If you intend to use Designer to
develop and compile Java services on Integration Server, specify the location of the JDK.
If you will not be using this installation of Integration Server to compile Java services,
you can specify the location of a JRE.
Important: If you specify a dierent JDK or JRE, do not remove the JDK or JRE that
Software AG Installer installed with Integration Server. The JDK and JRE
installed with Integration Server are required to run the Software AG
Uninstaller.
To specify the Java location for Integration Server
1. Open the wrapper.conf le in a text editor. You can nd the wrapper.conf le in the
following location:
Software AG_directory\proles\IS_instance_name \conguration
2. Set the wrapper.java.command property so that it species the location of the JDK
or JRE installation directory. For example:
wrapper.java.command=C:\SoftwareAG\jvm\jvm\bin\java

Note:

If your Integration Server runs on a UNIX system, you must also modify
the LD_LIBRARY_PATH property so that it points to the location of the JDK
or JRE installation directory.

webMethods Integration Server Administrators Guide Version 9.10

132

Odd Header
Configuring the Server

3. Save and close the le.

4. Restart Integration Server.
Note:

If you change the Java location and you use Integration Server to
develop and compile Java services, you must also change the value of the
wa.server.compile conguration parameter. For more information about
wa.sever.compile, see "Server Conguration Parameters" on page 851.

Changing the JVM Heap Size Used by Integration Server

The JVM heap or on-heap size indicates how much memory is alloed for server
processes. At some point, you might need to increase the minimum and maximum heap
size to ensure that the JVM that Integration Server uses does not run out of memory.
You will want to consider the heap size when you congure your server to publish and
subscribe to documents and when you congure an on-heap cache.
The heap size is controlled by the following Java properties specied in the
custom_wrapper.conf le.
Property

Description

wrapper.java.initmemory

The minimum heap size. The default value is 256 MB.

wrapper.java.maxmemory

The maximum heap size. The default value is 1024

MB.

Your capacity planning and performance analysis should indicate whether you need to
set higher maximum and minimum heap size values.
To change the heap size
1. Open the custom_wrapper.conf le in a text editor. You can nd the
custom_wrapper.conf le in the following location:
Software AG_directory\proles\IS_instance_name \conguration
2. Set the wrapper.java.initmemory and wrapper.java.maxmemory parameters so
that they specify the minimum and maximum heap size required by Integration
Server. For example:
wrapper.java.initmemory=256
wrapper.java.maxmemory=512

3. Save and close the le.

4. Restart Integration Server.

webMethods Integration Server Administrators Guide Version 9.10

133

Even Header
Configuring the Server

Publishing and Retracting Information about Integration

Server Assets
You can publish information or metadata to a shared library or registry that resides
in CentraSite. By publishing this metadata, you make these assets available to other
CentraSite users. You can also retract published metadata from CentraSite.
The metadata that you can publish are about Integration Server assets, Integration
Server administrative assets, and Trading Networks (TN) document types. Integration
Server administrative assets include Adapter connections, Broker connections, and JMS
connection aliases. For a complete list of assets that you can publish, see webMethods
Service Development Help.
You can use Software AG Designer to select the assets for which you want to publish
or retract metadata to or from CentraSite. Designer publishes metadata using the
credentials dened in the CentraSite connection in Designer.
You can also use the pub.metadata.assets:publishPackages service in the WmAssetPublisher
package to publish metadata for packages and administrative assets. You can
create a scheduled task that uses this service to publish metadata regularly. The
pub.metadata.assets:publishPackages service uses the CentraSite credentials dened in
Integration Server to publish metadata.
Note:

Before publishing metadata about Integration Server assets, you must

congure Integration Server to connect to CentraSite. For instructions, see
"Conguring Integration Server to Connect to CentraSite " on page 134.

For detailed instructions on publishing and retracting metadata, see webMethods Service
Development Help. For information about administering the shared library in CentraSite,
see the CentraSite documentation.

Configuring Integration Server to Connect to CentraSite

Before you can publish metadata using the pub.metadata.assets:publishPackages service, you
must congure Integration Server to connect to the shared library in CentraSite.
To configure Integration Server to connect to CentraSite
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Metadata.
3. Click Edit Configuration.
4. Under Metadata Library Configuration, provide information in the following elds:

webMethods Integration Server Administrators Guide Version 9.10

134

Odd Header
Configuring the Server

For this parameter...

Specify...

IS Identifier

The name or the IP address of the machine on

which this Integration Server is running. By default,
Integration Server populates this eld with the IP
address of the machine. You can, however, enter a name
here, which Integration Server will treat as an alias. In
addition, Integration Server includes this name with
the published metadata. You can use any name, but it
cannot include the following illegal characters:
#-&@^!%*:$./\\`;,~+=)(|}{][><" .

CentraSite URL

The CentraSite URL to which to publish metadata

about Integration Server assets.

User Name

The name of the user account on CentraSite that will be

used for publishing and retracting metadata.

Password

Password for User Name.

5. Click Save Changes.

You can test the congured connection to ensure that Integration Server can connect
to CentraSite successfully using the details you provided. For instructions, see
"Conguring Integration Server to Connect to CentraSite " on page 134.

Testing the Connection to CentraSite

After you congure Integration Server to connect to CentraSite, you can test the
connection to ensure that the specied host name, IP address, and library name identify
a CentraSite library that is currently running.
To test the connection to CentraSite
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Metadata.
3. Click Test Connection.
Integration Server Administrator displays a status line that indicates whether the
connection is successful or not. The status line is displayed at the top of the screen.

webMethods Integration Server Administrators Guide Version 9.10

135

Even Header
Configuring the Server

Setting a Port for Remote Client JMX Monitoring

Integration Server enables you to use JMX monitoring from a remote client. JMX
monitoring is enabled by default, but you can set the JMX monitoring remote port in
the com.software.jmx.connector.pid-port .properties le of the Integration Server you
want to monitor, where port is the current JMX monitoring port. You cannot disable JMX
monitoring.
To set the port for remote client JMX monitoring
1. On the Integration Server that you want to monitor remotely, open the
com.software.jmx.connector.pid-port .properties le in a text editor. You can nd the
com.software.jmx.connector.pid-port .properties le in the following location:
Software AG_directory\proles\IS_instance_name \conguration
\com.softwareag.platform.cong.propsloader
2. Specify the port number of the JMX port in the port property. This is 8075 by
default.
3. Restart Integration Server.

Configuring Integration Server to Accept a Debug

Connection During Startup
Using Integration Server, you can connect a debugging tool to remotely debug Java
services running on Integration Server. You can specify the port on which Integration
Server listens for the debugger to aach.
Note:

For information about using Software AG Designer to debug Java services

that run on Integration Server, see Software AG Designer Online Help.

To configure Integration Server to accept a debug connection during startup

1. Shut down Integration Server.
2. If you need to change the port number, perform the following:
a. Open the startDebugMode.bat le in a text editor. You can nd the
startDebugMode.bat le in the following location:
Software AG_directory\proles\IS_instance_name \bin
b. Locate and change the DEBUG_PORT property to specify the port on which the
server should listen for the debugger to aach. The default is 10033.
c. Save your changes and close the startDebugMode.bat le.

webMethods Integration Server Administrators Guide Version 9.10

136

Odd Header
Configuring the Server

3. If Integration Server and the debugging tool are on dierent machines and you
require a rewall port, open a rewall port for the debug port.
4. Run startDebugMode.bat.
Integration Server logs the following on your console:
"Debug enabled (portNumber )"
Listening for transport dt_socket at address: portNumber

Integration Server restarts.

Using CORS with Integration Server

CORS (Cross-Origin Resource Sharing) is a specication that provides the standards for
user agents (such as web browsers) to allow client-side web applications running in one
origin to access resources from another origin. For security reasons, cross-origin requests
initiated by scripts are usually restricted by user agents; however, user agents can use
CORS to allow and dene these cross-origin communications.

How Integration Server Handles CORS Requests

Integration Server provides a set of extended seings to enable and congure processing
of CORS requests. A CORS request contains a set of HTTP headers that can be used to
identify the request and communicate with Integration Server. When support for CORS
is enabled, Integration Server checks all incoming requests for these headers. If a request
contains CORS headers, Integration Server aempts to validate the request. Integration
Server processes valid requests and includes CORS response headers in the response.
Note:

To use CORS, both the server and the client must communicate with the
CORS headers as dened by the CORS standard.

Configuring Integration Server to Accept CORS Requests

Use the following procedure to congure your Integration Server to accept and process
CORS requests.
To enable CORS processing on Integration Server
1. In the Settings menu of the Navigation panel, click Extended.
2. Click Edit Extended Settings.
3. Type watt.server.cors.enabled=true.
4. Specify the URIs from which Integration Server is to allow cross-origin requests to
access resources by typing the following:
watt.server.cors.allowedOrigins=<protocol>://<hostname>

webMethods Integration Server Administrators Guide Version 9.10

137

Even Header
Configuring the Server

or
watt.server.cors.allowedOrigins=<protocol>://<hostname>:<port>

Where <protocol> is either HTTP or HTTPS, <hostname> is the IP address or name of

the machine, and <port> is the port number.
Note:

The host name and IP address cannot be used interchangeably. If you

specify a host name, and a cross-origin request is received that uses the
corresponding IP address or vice versa, Integration Server will reject the
request.

The values are case-sensitive. Use a space or comma delimiter to specify multiple
values. You can use an asterisk (*) to indicate that any URI or origin is allowed.
For more information about seing the wa.server.cors.allowedOrigins service
conguration parameter, see "Server Conguration Parameters" on page 851.
5. Optionally, set any of the following parameters for CORS processing:
If you want to...

Type...

Specify values that Integration

Server can include with the
CORS Access-Control-ExposeHeaders header in response to a
CORS request.

watt.server.cors.exposedHeaders=
<value1,value2,value3>

Specify the host and port on

which clients can send crossorigin requests to Integration
Server.

watt.server.cors.host=<hostname>:<port>

Specify the amount of time in

seconds a user agent is allowed
to cache the results of a preight
request.

watt.server.cors.maxAge= <number
of seconds>

Have Integration Server set

the CORS Access-Control-AllowCredentials header in response to
all CORS requests.

watt.server.cors.supportsCredentials=true

Specify the request headers

Integration Server will allow in
cross-origin requests. Integration
Server includes these headers

watt.server.cors.supportedHeaders=
<header1,header2,header3>

Where value# is a response header that

applications can access. Examine your
client-side code to determine which
response headers, if any, are retrieved by
the client and therefore need to be exposed.

webMethods Integration Server Administrators Guide Version 9.10

138

Odd Header
Configuring the Server

If you want to...

as the value of the Access-ControlAllow-Headers response header
when replying to a pre-ight
request.

Specify the HTTP methods

Integration Server will allow in
cross-origin requests.

Type...
Where header# is a header that a client
can include in an actual request. Examine
your server-side code to determine which
request headers, if any, are read by your
server application and need to be explicitly
allowed.
watt.server.cors.supportedMethods=
<method1,method2,method3>

Possible values are OPTIONS, HEAD, GET,

POST, PUT, and DELETE. Integration Server
accepts any of these values by default.

See "Server Conguration Parameters" on page 851 for important usage

information and detailed descriptions of these parameters.
6. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

139

Even Header

webMethods Integration Server Administrators Guide Version 9.10

140

Odd Header
Managing JDBC Pools

8 Managing JDBC Pools

Overview .....................................................................................................................................

142

Managing Functional Alias Definitions .......................................................................................

143

Managing Pool Aliases ..............................................................................................................

146

Managing Driver Aliases ............................................................................................................

153

webMethods Integration Server Administrators Guide Version 9.10

141

Even Header
Managing JDBC Pools

Overview
When you choose to use an external RDBMS while installing Integration Server, the
installer asks you to supply the database connection. From this information, the installer
creates a JDBC connection pool and congures Integration Server to write the following
data to the external RDMS using that pool:
IS Internal
IS Core Audit Log
Cross Reference
Distributed Locking
Document History
Process Audit Log
Process Engine
To create additional JDBC connection pools or recongure Integration Server to write
dierent types of data using dierent pools, you can do so using the Integration Server
Administrator. The JDBC Pools screen enables you to specify the connection to a
database server that hosts database components. The JDBC Pools screen enables you to
manage the following:
Functional aliases
Pool aliases
Driver aliases
A functional alias is a connection pool that corresponds to a specic database component
(such as Scheduled Tasks and the Trading Networks Audit Log). The functional alias
directs auditing data and other information to a particular JDBC database. Functional
aliases are predened for the Integration Server during installation. You cannot add
or delete functional aliases, but you can change the JDBC connection pool to which a
functional alias is assigned. For more information about changing the JDBC connection
pool for functional aliases, see "Assigning Connection Pools to Functional Aliases" on
page 143.
You direct each function to write to its database components by pointing the function at
the appropriate connection pool.
The pool alias, also called a connection pool alias, denes the location and connection
parameters for the database. Integration Server uses this information to interact with
the database resource. When you create a pool alias denition, you must specify a driver
alias that identies a database driver to Integration Server. Integration Server uses this
database driver to connect to the dened database resource. For more information about
pool aliases, see "Managing Pool Aliases" on page 146. For more information about
driver aliases, see "Managing Driver Aliases" on page 153.

webMethods Integration Server Administrators Guide Version 9.10

142

Odd Header
Managing JDBC Pools

Managing Functional Alias Definitions

The Integration Server Administrator lists the functional aliases in the Functional
Alias Definitions area of the JDBC Pools screen. The functional aliases are predened
for Integration Server during installation. If you chose an external RDBMS for the
Integration Server database components and supplied the database connection
parameters, the installer automatically created a default connection pool from the
Integration Server database connection parameters you supplied. For more information
about conguring Integration Server to write to the external RDBMS and create the
functional aliases for particular components, see Installing Software AG Products.
You cannot add or delete functional aliases, but you can change the JDBC connection
pool to which a functional alias is assigned. For more information, see "Assigning
Connection Pools to Functional Aliases" on page 143.
Using Integration Server Administrator, you can view all of the functional aliases for
Integration Server. For each functional alias, you can view the following:
Minimum and maximum number of JDBC pool connections
Current total number of connections created for the JDBC pool
Number of available connections
For a description of the functional aliases installed with Integration Server, see Installing
Software AG Products.
You can also use Integration Server Administrator to assign a connection pool to a
functional alias. For more information, see "Assigning Connection Pools to Functional
Aliases" on page 143.

Assigning Connection Pools to Functional Aliases

Integration Server Administrator provides functions that correspond to most database
components. You direct each function to write to its database components by assigning
the pool alias of the database to the functional alias.
Keep the following points in mind when assigning connection pools to functional
aliases:
The ISInternal functional alias must be congured to point to either the embedded
IS Internal database or to the external RDBMS that Integration Server uses for
persistent storage.
Integration Server must have a JDBC connection pool that points to the My
webMethods Server database component, and the CentralUsers function in
Integration Server must point to that connection pool. For more information, see
"Requirements for Central User Management" on page 563.

webMethods Integration Server Administrators Guide Version 9.10

143

Even Header
Managing JDBC Pools

To assign a pool alias to a functional alias

1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > JDBC Pools.
3. In the Functional Alias Definitions area, for the functional alias you want to edit, click
Edit in the Edit Function column.
4. In the Associated Pool Alias eld, specify the connection pool that you want the
functional alias to use.
5. If you want to use fail-fast mode with this functional alias denition, select Yes next
to the Fail-Fast Mode Enabled option. If you do not want to use fail-fast mode with this
functional alias denition, select No.
The Currently in Fail-Fast Mode? eld indicates whether or not the JDBC functional alias
denition is currently in fail-fast mode.
Note:

Fail-fast mode applies only to functional alias denitions that have an

associated pool alias. For more information about fail-fast mode, see
"Using Fail-Fast Mode with a Functional Alias" on page 145.

6. Click Save Settings.

Integration Server displays the Settings > JDBC Pools screen.
7. In the Functional Alias Definitions area, initialize the pool by clicking Restart Function >
Restart in the column for the function.
8. Make sure Integration Server can connect to the database by clicking
column for the function.

in the Test

Integration Server Administrator displays a status line that indicates whether the
connection to the database is successful. The status line is displayed at the top of the
screen.
9. Repeat the previous steps for all function aliases to which you want to assign a
connection pool.
10. If you created a connection pool for the My webMethods Server database component
and pointed the CentralUsers function at it, go to the Settings > Resources screen and
make sure the MWS SAML Resolver URL eld is pointing to your My webMethods
Server host and port.
11. Restart Integration Server.

Testing Functional Aliases

Perform the following procedure to test functional aliases.

webMethods Integration Server Administrators Guide Version 9.10

144

Odd Header
Managing JDBC Pools

To test a functional alias

1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > JDBC Pools.
3. In the Functional Alias Definitions area, click
alias you want to test.

in the Test column for the functional

Integration Server Administrator displays a status line that indicates whether the
connection to the database is successful. The status line is displayed at the top of the
screen.

Restarting Functional Aliases

Perform the following procedure to restart a functional alias. You might do this when
you want to recycle the connections present in the connection pool associated with the
functional alias.
To restart a functional alias
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > JDBC Pools.
3. In the Functional Alias Definitions area for the functional alias you want to test, click
Restart in the Restart Function column. Integration Server Administrator prompts you
to conrm your action. Click OK to conrm that you want to restart the functional
alias.

Using Fail-Fast Mode with a Functional Alias

A JDBC functional alias can be congured to enter fail-fast mode when a transient error
caused by an unavailable database prevents the connection pool alias used by the JDBC
functional alias from establishing a connection to the database. When fail-fast is enabled
and Integration Server detects a loss of database availability, the JDBC functional alias
enters fail-fast mode. While the JDBC functional alias is in fail-fast mode, the following
occurs:
All aempts by an Integration Server component that uses the JDBC functional alias
to get a database connection will return immediately with a SQLException. This
prevents delays caused by waiting to complete the retry aempts that might be
congured for Integration Server component, such as logging, when a transient error
occurs.
The JDBC function monitors database connectivity. When database connectivity
is restored, the JDBC function exits fail-fast mode.Integration Server components
that use the JDBC functional alias to obtain a database connection will obtain a
connection when one is requested.

webMethods Integration Server Administrators Guide Version 9.10

145

Even Header
Managing JDBC Pools

Fail-fast mode is enabled for a JDBC functional alias when the Fail-Fast Mode Enabled
option is set to Yes on the Settings > JDBC Pools > Functional Definitions > Edit page for the
JDBC functional alias. The Currently in Fail-Fast Mode? eld indicates whether or not the
JDBC functional alias denition is currently in fail-fast mode.
Fail-fast mode can improve performance when used with synchronous audit logging.
For information about using fail-fast mode with audit logging, see the webMethods Audit
Logging Guide.

Managing Pool Aliases

The pool alias, also called a connection pool, denes the location and connection
parameters for the database. Integration Server uses this information to interact with
the database resource. The Integration Server Administrator lists the aliases of the
connection pools in the Pool Alias Definitions area of the JDBC Pools screen. This area of
the screen displays the pool aliases and their associated driver aliases. You can create
pool aliases manually or by copying an existing pool aliases.

Creating Connection Pool Aliases Manually

Perform the following procedure to create a pool alias manually and associate a pool of
JDBC connections with a database.
Note:

The database driver alias you want to use to connect to the pool must exist
before you can create a pool alias. For more information about creating
database driver aliases, see "Creating Database Driver Alias Denitions" on
page 153.

To create a connection pool alias manually

1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > JDBC Pools.
3. On the JDBC Pools screen, click Create a Pool Alias Definition.
4. On the Settings > JDBC Pools > Connection Aliases > New screen, complete the elds as
follows:
For this parameter...

Specify...

Alias Name

Name to use for the connection pool. The name can

include any characters that are valid for a le name in your
operating system.

Alias Description

Brief description of the pool.

webMethods Integration Server Administrators Guide Version 9.10

146

Odd Header
Managing JDBC Pools

For this parameter...

Specify...

Associated Driver
Alias

Database driver for Integration Server to use to connect to

the pool.

Database URL

URL for the database server. Sample URL formats for the
DataDirect Connect JDBC 5.1 driver are displayed Sample
Database URL.
Use the DataDirect Connect connection option
Important:
MaxPooledStatements=35 on all database URLs
except those for Trading Networks. This connection
option improves performance by caching prepared
statements. (Trading Networks caches its prepared
statements using its own pooling mechanism).
For DB2, if Integration Server will connect to a schema
Important:
other than the default schema for the specied
database user, you must specify these connection
options in the URL:
;AlternateId=schema;"InitializationString=
(SET CURRENT PATH=current_path,schema)";
MaxPooledStatements=35

AlternateID is the name of the default schema that

is used to qualify unqualied database objects in
dynamically prepared SQL statements.
Diagnostics

The DataDirect diagnostic feature for DataDirect Connect

JDBC drivers used by Integration Server to interact with an
external RDBMS.
Note: These options are for use with an external RDBMS only.
They are not for use with the embedded IS internal
database.
Option

Description

Spy

When selected, enables the DataDirect Spy

diagnostic feature for DataDirect Connect
JDBC drivers. DataDirect Spy logs JDBC calls
and SQL statement interactions between
Integration Server and an external RDBMS.
This check box is cleared by default.

webMethods Integration Server Administrators Guide Version 9.10

147

Even Header
Managing JDBC Pools

For this parameter...

Specify...
Snoop

When selected, Integration Server enables the

DataDirect Snoop tool for DataDirect Connect
JDBC drivers. The DataDirect Snoop tool logs
network packets between Integration Server
and an external RDBMS. You can use the
resulting log le for tracing and diagnostic
purposes.
This check box is cleared by default.

Spy Attributes

The name and location of the log le where Integration

Server will log diagnostic data collected by the DataDirect
Spy diagnostic feature. This value also denes DataDirect
Spy aributes. The default value is:
SpyAttributes=(log=(file)/logs/spy/
<alias_name>.log; logTName=yes;timestamp=yes)

Where <alias_name> is the name of the JDBC connection pool

alias.
Note: Typically, you do not need to change the default
value. However, you can modify the value if the
aributes do not meet the needs of your system. Be
aware that the diagnostic tool collects data from the
Integration Server_directory/instances/instance_name /
logs/spy directory. If you change the log le location,
the diagnostic utility might not import the data logged
by DataDirect Spy. For more information about using
the diagnostic utility, see "Using the Diagnostic Utility"
on page 833. For more information about seing
DataDirect Spy aributes, consult the documentation
on the DataDirect website.
Snoop Logging
Parameters

Denes the name and location of the log le where

Integration Server will log diagnostic data collected by the
DataDirect Snoop tool. This value also denes DataDirect
Snoop tool aributes. The default value is:
ddtdbg.ProtocolTraceEnable=true;ddtdbg.Protocol
TraceMaxline=16;ddtdbg.ProtocolTraceLocation=/logs/
snoop/
alias_name.log;ddtdbg.ProtocolTraceShowTime=true

Where alias_name is the name of the JDBC connection pool

alias.

webMethods Integration Server Administrators Guide Version 9.10

148

Odd Header
Managing JDBC Pools

For this parameter...

Specify...
Note: For DB2, include the following command at the end of
the value:
ddtdbg.ProtocolTraceEBCDIC=true

Typically, you do not need to change the default value.

However, you can modify the value if the aributes do not
meet the needs of your system. Be aware that the diagnostic
tool collects data from the Integration Server_directory/
instances/instance_name/logs/snoop directory. If you change
the log le location, the diagnostic utility might not import
the data logged by the DataDirect Snoop tool. For more
information about using the diagnostic utility, see "Using
the Diagnostic Utility" on page 833. For more information
about seing the DataDirect Snoop tool aributes, consult
the documentation on the DataDirect website.
User ID

Database user for Integration Server to use to connect to the

database.

Password

Password for Integration Server to use to connect to the

database. If a password is not required, leave this eld
blank.

Minimum
Connections

Minimum number of connections the pool must keep open

at all times.
If you use this pool alias for more than one function, each
pool instance keeps the specied number of connections
open. For example, if you specify keeping at least 3
connections open, and the IS Core Audit Log and the
Document History database components both use this pool,
the pool keeps a total of 6 connections open: 3 for the IS Core
Audit Log pool instance and 3 for the Document History
pool instance.
If your logging volume has sudden spikes, you can improve
performance by making sure the connections needed
to handle the increased volume open quickly. You can
minimize connection startup time during spikes by seing
this value higher, so that more connections remain open at
all times.

Maximum
Connections

Maximum number of connections the pools can have open at

one time. When the number of connection requests reaches
this value, Integration Server blocks the requests.

webMethods Integration Server Administrators Guide Version 9.10

149

Even Header
Managing JDBC Pools

For this parameter...

Specify...
Calculate this value as part of the total possible number
of connections that could be opened simultaneously by
all functions and applications that write to the database.
Make sure the total number does not exceed the database's
connection limit. If one of the applications opens more
connections than the database allows, the database will reject
subsequent requests for connections from any application.
To continue the previous example, if Trading Networks also
writes to the database and has a pool that could open up to
5 connections, you could specify only 17 as the maximum
number of connections for the current pool. The IS Core
Audit Log pool instance could use up to 17 connections, and
the Document History pool instance could use the remaining
5 connections.

Available
Connections
Warning
Threshold

Number of connections, expressed as a percentage of

Maximum Connections, that should be available in the pool at
all times.

Waiting Thread
Threshold Count

Maximum number of requests for connection that can be

waiting at one time.

When the number of connections falls to or below this

number, Integration Server logs a message to the server log.
If the number of connections later rises above this number,
Integration Server logs another message to the server log
stating that the connection pool threshold has been cleared.
To disable this threshold, set the value to 0.

When this number is exceeded, Integration Server logs a

message to the server log and starts a 5-minute interval
timer. If the number of requests still exceeds this number
at the end of the interval, Integration Server logs another
message to the server log. To disable this threshold, set the
value to 0.
Idle Timeout

Length of time, in milliseconds, the pool can keep an unused

connection open. After the specied period of time elapses,
the pool closes unused connections that are not needed to
satisfy the Minimum Connections value. The default expiration
time is 60000 milliseconds.

5. Make sure Integration Server can connect to the database by clicking Test Connection.
The status line is displayed at the top of the screen.
6. Click Save Settings.

webMethods Integration Server Administrators Guide Version 9.10

150

Odd Header
Managing JDBC Pools

Integration Server displays the Settings > JDBC Pools screen.

7. Check the values for the connection pool for the ISCoreAudit database component.
If the database user specied in the User ID eld is not the database user that created
the ISCoreAudit database component, set the wa.server.audit.schemaName
property to the name of the schema that contains the ISCoreAudit database
component. For instructions on seing this property, see "Server Conguration
Parameters" on page 851.

Creating Connection Pool Aliases by Copying an Existing Pool Alias

If you want to create a pool connection with a conguration similar to an existing pool
alias, you can copy the seings of an existing pool alias. You can then edit those seings
as necessary.
To copy a connection pool alias
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > JDBC Pools.
3. Click Copy a Pool Alias Definition.
4. Complete the elds as follows:
For this parameter...

Specify...

Copy From

The existing pool alias you want to copy. When you select an
existing pool alias, Integration Server uses the values from
the selected pool alias to populate the values of the pool alias
you are creating, except for the Alias Name, which is specied
in the Alias Name parameter.

Alias Name

Unique name to use for the pool alias. The name can
include any characters that are valid for a le name in your
operating system.

5. Click Copy Settings.

Integration Server Administrator displays the new pool alias in the Pool Alias
Definitions area of the JDBC Pools screen.

Editing a Connection Pool Alias

Complete the following procedure to edit a connection pool alias.
To edit a connection pool alias
1. Open Integration Server Administrator if it is not already open.

webMethods Integration Server Administrators Guide Version 9.10

151

Even Header
Managing JDBC Pools

2. In the Navigation panel, select Settings > JDBC Pools.

3. In the Pool Alias Definitions area, click Edit in the Edit Pool Alias column for the pool
alias you want to edit.
4. On the Settings > JDBC Pools > Connection Aliases > Edit screen, update the seings for
the pool alias.
5. Click Save Settings.

Testing a Connection Pool Alias

To test a connection pool alias, perform the following procedure.
To test a connection pool alias
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > JDBC Pools.
3. In the Pool Alias Definitions area, click
want to test.

in the Test column for the pool alias you

Integration Server Administrator displays a status line that indicates whether the
connection pool alias is valid. The status line is displayed at the top of the screen.

Deleting a Connection Pool Alias

Use the following procedure to delete a connection pool alias.
Note:

You cannot delete a pool alias if it is associated with a functional alias. If

the pool alias you want to delete is associated with a functional alias, you
should associate another connection pool alias with the functional alias before
deleting the pool alias. For more information about assigning connection pool
aliases to functional aliases, see "Assigning Connection Pools to Functional
Aliases" on page 143.

To delete a connection pool alias

1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > JDBC Pools.
3. In the Pool Alias Definitions area, click the
alias you want to delete.

icon in the Delete column for the pool

4. Integration Server Administrator displays a dialog box that prompts you to conrm
your action. Click OK to conrm that you want to delete the connection pool alias.

webMethods Integration Server Administrators Guide Version 9.10

152

Odd Header
Managing JDBC Pools

Managing Driver Aliases

The driver alias identies a database driver to Integration Server. Integration Server uses
this database driver to connect to the dened database resource. The Integration Server
Administrator lists the available driver aliases in the Driver Alias Definitions area of the
JDBC Pools screen.

Creating Database Driver Alias Definitions

Complete the following procedure to create a database driver alias denition that
identies a database driver. Integration Server uses this database driver to interact with
the webMethods audit database.
To create database drivers
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > JDBC Pools.
3. On the JDBC Pools screen, click Create a Driver Alias Definition and complete the elds
as described below.
For this parameter...

Specify...

Alias Name

Alias name to use for the driver. The name can be any length
and contain any characters.

Alias Description

Brief description of the driver alias.

Driver Class Name

Name of the Java class for the JDBC driver.

4. Click Save Settings.

Integration Server Administrator displays the new driver alias denition in the Driver
Alias Definitions area of the JDBC Pools screen.

Editing Database Driver Aliases

Complete the following procedure to edit a database driver alias.
To edit a database driver alias
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > JDBC Pools.
3. Locate the driver alias you want to edit and click Edit in the Edit Driver Alias column.

webMethods Integration Server Administrators Guide Version 9.10

153

Even Header
Managing JDBC Pools

4. Update the information for the driver alias.

Note:

You cannot edit the Alias Name eld.

5. Click Save Changes.

Deleting Database Driver Aliases

If you no longer need a database driver denition, you can delete it.
Note:

You cannot delete a database driver alias if it is associated to a pool alias

denition. You must rst disassociate the database driver alias from the
connection pool alias denition. For more information about editing a
connection pool alias denition, see "Editing a Connection Pool Alias" on page
151.

To delete a database driver alias

1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > JDBC Pools.
3. Locate the driver denition in the Driver Alias Definitions area, and click the
the Delete Driver Alias column.

icon in

4. Integration Server Administrator displays a dialog box that prompts you to conrm
your action. Click OK to conrm that you want to delete the database driver alias.

webMethods Integration Server Administrators Guide Version 9.10

154

Odd Header
Configuring Ports

9 Configuring Ports
About Ports ................................................................................................................................

156

Considerations for Adding Ports ................................................................................................

159

Adding an HTTP Port ................................................................................................................

161

Adding an HTTPS Port ..............................................................................................................

168

About File Polling Ports .............................................................................................................

176

Adding an FTPS Port .................................................................................................................

183

Adding an FTP Port ...................................................................................................................

187

Adding an E-Mail Port ................................................................................................................

189

Adding an HTTP Diagnostic Port ...............................................................................................

196

Adding an HTTPS Diagnostic Port ............................................................................................

200

Suspending an HTTP/HTTPS Port ............................................................................................

205

Resuming an HTTP/HTTPS Port ...............................................................................................

206

Testing for HTTPS Requests .....................................................................................................

206

Using an FTP/FTPS Port Range ...............................................................................................

207

About the Primary Port ..............................................................................................................

208

Deleting a Port ...........................................................................................................................

209

Editing a Port .............................................................................................................................

210

About Enabling/Disabling a Port ................................................................................................

210

Configuring How Ports Handle Client Certificates .....................................................................

211

Adding a Security Provider ........................................................................................................

212

Configuring the Allowed Protocols for JSSE per Port ...............................................................

213

webMethods Integration Server Administrators Guide Version 9.10

155

Even Header
Configuring Ports

About Ports
Integration Server listens for requests on ports that you specify. Each port is associated
with a specic type of protocol: HTTP, HTTPS, FTP, FTPS, e-mail, or le polling. In
addition to these port types, Integration Server also provides a diagnostic port, a quiesce
port, and two ports used by webMethods Enterprise Gateway.

Available Port Types

The following table describes the port types that you can congure:
Use this port
type...

To...

Refer to...

HTTP

Submit unsecured requests

to the server.

"Adding an HTTP Port" on

page 161

HTTPS

Submit requests to
the server using SSL
encryption.

"Adding an HTTPS Port" on

page 168

FTP

Move les to and from the

server.

"Adding an FTP Port" on page

187

FTPS

Move les to and from

the server using SSL
encryption.

"Adding an FTPS Port" on

page 183

E-mail

Receive requests through

an e-mail server, such as
POP3 or IMAP.

"Adding an E-Mail Port" on

page 189

File polling

Monitor the le system for

the arrival of new les and
perform special processing
upon arrival.

"Adding a File Polling Port" on

page 177

Diagnostic

Access Integration Server

Administrator when
the server becomes
unresponsive.

"Adding an HTTP Diagnostic

Port" on page 196

webMethods Integration Server Administrators Guide Version 9.10

156

Odd Header
Configuring Ports

Use this port

type...

To...

Refer to...

Quiesce

Enter and exit quiesce

mode for server
maintenance.

"Quiescing the Server for

Maintenance" on page 821

Enterprise
Gateway
Server

Listen for requests from

external clients and
maintain the connection
to the Internal Server in a
webMethods Enterprise
Gateway conguration.

"Conguring webMethods
Enterprise Gateway " on page
493

Internal Server

Connect the Internal Server

to the Enterprise Gateway
Server in a webMethods
Enterprise Gateway
conguration.

"Conguring webMethods
Enterprise Gateway " on page
493

Default Ports
The default Integration Server instance has the following pre-congured ports:
Alias

Protocol

Port Type

Port
Number

DefaultPrimary

HTTP

Primary

5555

DefaultDiagnostic

HTTP

Diagnostic

9999

Note:

The alias assigned to a default port on Integration Server cannot be changed.

If you want to use a dierent alias for the port, protocol, and port type used
by a default port, delete the port and recreate it with the new alias. To use a
dierent alias for the DefaultPrimary port, you must designate another port
as the primary port before deleting the DefaultPrimary port and recreating it
with a new alias.

If you are running multiple Integration Servers on the same machine, the primary and
diagnostic port numbers on each server must be unique. For more information about
running multiple Integration Server instances, see "Running Multiple Integration Server
Instances" on page 73.

webMethods Integration Server Administrators Guide Version 9.10

157

Even Header
Configuring Ports

About the Port Alias

When you create a port, you specify an alias for the port. The port alias serves as a
unique identier for the port. Often, the alias is a short descriptive name that identies
the purpose of the port. For example, you might want the port alias to identify the
primary function of the port, such as AdminPort, WebServicePort, or projectNamePort.
When using Software AG Command Central, the port alias can make it easier to
manage, congure, and compare ports. For example, if you assigned all of the
administration ports in a group of Integration Servers the same name or similar names,
you can more easily identify and therefore more easily compare the administration
ports.
A port alias must:
Be unique across the Integration Server.
Be between 1 and 255 characters in length.
Include one or more of the following: leers (a -z, A-Z), numbers (0-9), underscore
(_), period (.), and hyphen (-).
Once the port is created, the alias cannot be changed. The default ports provided with
Integration Server have pre-dened alias names as specied in "Default Ports" on page
157.
When you upgrade to Integration Server 9.5 or later from a previous version that did not
use port aliases, Integration Server assigns each port, with the exception of e-mail ports
and le polling ports, an alias using the following naming convention:
protocol Listener_portNumber _hostName _packageName
Where protocol is the protocol specied for the port, portNumber is the number assigned
to the port, hostName is the host name specied for the port, and packageName is the
package with which the port is associated.
For e-mail ports, Integration Server uses the following naming convention for the port
alias:
EMailListener_userName _hostName _packageName
Where userName is the user name specied for the port, hostName is the host name
specied for the port, and packageName is the package with which the port is associated.
For le polling ports, Integration Server uses the following naming convention for the
port alias:
FilePollingListener_monitoringDirectory @contentType
Where monitoringDirectory is the directory that Integration Server monitors for new
les, and contentType is the content type for the les the port processes. If the le polling
port does not specify a content type, Integration Server omits contentType from the port
alias.

webMethods Integration Server Administrators Guide Version 9.10

158

Odd Header
Configuring Ports

Integration Server uses the naming conventions described above to create an alias for a
port deployed from an earlier version of Integration Server and for a port installed with
a package created on an earlier version of Integration Server.
Note:

The alias that Integration Server assigns to a port cannot be changed.

Package Associations
All ports are associated with a package. By default, they are associated with WmRoot.
You can associate all port types except the diagnostic port with an application package.
By doing so, when you replicate the package, the package continues to use a port with
the same number on the new server. This feature is useful if you create an application
that expects input on a specic port. The application will continue to work after it is
replicated to another server.
Important: Be careful when seing up a port that is associated with a package. When
copied to the target server, the new port might decrease security on that
system. For example, suppose you replicate a package that is associated
with an HTTP port at 5556. The replication process creates an HTTP port
at 5556 on the target server. If the target server normally uses only HTTPS
ports because of their greater security, then the new port presents a possible
security hole on that server.

Considerations for Adding Ports

You can congure one or more additional ports. You can associate an HTTP, HTTPS,
FTP, FTPS, e-mail, or le polling protocol with the additional ports.
Important: If you are running multiple Integration Server instances on the same host
machine, the ports on each server must have a unique port number.

Reasons to Add Additional Ports

You might add additional ports for the following reasons:
If you have applications that require a specic port number.
If you want to support multiple types of listening protocols.
If you want to open several ports for the same protocol.
If you want to deploy your server in a webMethods Enterprise Gateway
conguration, in which an Enterprise Gateway Server sits in your DMZ and
intercepts requests before passing them to the server behind your inner rewall. For

webMethods Integration Server Administrators Guide Version 9.10

159

Even Header
Configuring Ports

instructions on adding Enterprise Gateway ports, see "Conguring webMethods

Enterprise Gateway " on page 493.

Considerations for Configuring Ports

The following are prerequisites and considerations for conguring ports.

AS/400 Considerations
The port queue is the number of outstanding inbound connections that are queued in a
TCP/IP stack. If your server runs on AS/400, you should limit the size of the port queue
by adding the line wa.server.portQueue=511 to the server property seings.
For instructions on adding server property seings, see "Working with Extended
Conguration Seings" on page 130.

Bind Addresses
When you add a port, you can specify an IP address to bind to the port. Specify a bind
address in the following situations:
Your machine has multiple IP addresses, and you want the port to use a specic
address.
You want multiple ports to use the same port number. In this case, each port must
specify a dierent bind address. For example, if port 7777 is associated with a bind
address, you cannot add another port 7777 that does not specify a bind address.
If you do not specify a bind address, the port listens to all network interfaces.

Prerequisites to Configuring a Port for SSL

Before conguring an HTTPS, FTPS, or e-mail port, you must congure the server to
use SSL and obtain the certicates that the server uses to validate client certicates. In
addition, for two-way SSL authentication (server also authenticates client), the certicate
for the partner application must have an Integration Server certicate mapping.
Configure the server to use SSL. For information about conguring the server to use
SSL, see "Securing Communications with the Server" on page 401.
Obtain CA certificates. These are the trusted root certicates that the server uses to
validate client certicates. One way to obtain these certicates is to extract them from
a web browser. Most web browsers that support SSL are shipped with the certicates
of well-known certicate authorities. Make sure the certicates are in DER format;
if not, convert them to DER format using your certicate management tool (such as
Java keytool).
Configure a certificate mapping for the partner application or resource. If the partner
application or resource that exchange information with Integration Server must
be authenticated using SSL, then that partner or resource must have a certicate
mapping. These certicates should be stored in the truststore and an alias created

webMethods Integration Server Administrators Guide Version 9.10

160

Odd Header
Configuring Ports

for the truststore prior to using them with Integration Server. For information, see
"HTTPS Ports" on page 454.

Port Usage and Security

For security reasons, by default, all ports except 5555 are congured to deny access to all
services except services specied in an allow list. You might need to perform additional
steps to make more services available through the port. See "Conguring How Ports
Handle Client Certicates" on page 211
Note:

If your Integration Server runs on a UNIX system, using a port number below
1024 requires that the server run as root. For security reasons, Software AG
discourages this practice. Instead, run your Integration Server using an
unprivileged user ID on a high number port (for example 1024 or above) and
use the port remapping capabilities present in most rewalls to move requests
to the higher numbered ports.

Adding an HTTP Port

To add an HTTP port, complete the following steps.
To add an HTTP port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Click Add Port.
4. In the Add Port area of the screen, select webMethods/HTTP.
5. Click Submit. Integration Server Administrator displays a screen requesting
information about the port. Provide the following information:
For this parameter...

Specify...

Enable

Indicate whether to enable (Yes) or disable (No) this

HTTP listener.

Port

The number you want to use for the port. Select

a number that is not already in use on this host
machine.
If you are running multiple Integration Servers
Important:
on the same host machine, make sure the port
numbers used on each server are unique.

Alias

An alias for the port that is unique for this Integration

Server. An alias must be between 1 and 255 characters

webMethods Integration Server Administrators Guide Version 9.10

161

Even Header
Configuring Ports

For this parameter...

Specify...
in length and include one or more of the following:
leers (a -z, A-Z), numbers (0-9), underscore (_),
period (.), and hyphen (-).

Description

A description of the port.

Package Name

The package associated with this port. When you

enable the package, the server enables the port. When
you disable the package, the server disables the port.
If you replicate this package, the Integration Server
creates a port with this number and the same seings
on the target server. If a port with this number already
exists on the target server, its seings remain intact.
This feature is useful if you create an application
that expects input on a specic port. The application
will continue to work after it is replicated to another
server.

Bind Address (optional)

IP address to which to bind this port. Specify a bind

address if your machine has multiple IP addresses and
you want the port to use this specic address. If you
do not specify a bind address, the server picks one for
you.

Backlog

The number of requests that can remain in the queue

for an enabled port before Integration Server begins
rejecting requests. The default is 200. The maximum
value is 65535.
Note: This parameter does not apply to disabled
ports. Integration Server refuses requests sent to
disabled ports.

Keep Alive Timeout

When to close the connection if the server has

not received a request from the client within this
timeout value (in milliseconds); or when to close the
connection if the client has explicitly placed a close
request with the server.

Threadpool

Whether the listener will use this pool exclusively

for dispatching requests. The existing Integration
Server thread pool is a global thread pool. If there
is a very high load on this resource, the user may
have to wait for the global thread pool to process his
request. However, with the private thread pool option

webMethods Integration Server Administrators Guide Version 9.10

162

Odd Header
Configuring Ports

For this parameter...

Specify...
enabled, requests coming into this port will not have
to compete with other server functions for threads.
To set up a private thread pool for requests coming
to this port, click Enable. You can change or accept the
default seings given below:
Threadpool Min refers to the minimum number of
threads for this private threadpool. The default is 1.
Threadpool Max refers to the maximum number of
threads for this private thread pool. The default is 5.
Threadpool Priority refers to the Java thread priority.
The default is 5.
Use this seing with extreme care because it will
Important:
aect server performance and throughput.
If you do not need to use the Threadpool feature, click
Disable.
When you view the ports details, the server reports
the total number of private threadpool threads
currently in use for the port.

6. Under Security Configuration, enter the following information:

For this parameter...

Specify...

Client Authentication

The type of client authentication you want Integration

Server to perform for requests that arrive on this
HTTP port. Select one of the following:
Option

Description

Username/Password

Integration Server prompts

the client for a user ID and
password.

Digest

Integration Server uses

password digest to authenticate
all requests. If the client does
not provide the authentication
information, Integration Server
returns an HTTP WWWAuthenticate header with
digest scheme to the client

webMethods Integration Server Administrators Guide Version 9.10

163

Even Header
Configuring Ports

For this parameter...

Specify...
requesting for authentication
information. If the client
provides the required
authentication information,
Integration Server veries and
validates the request.
A port that is congured
to use password digest for
authentication of client
requests will process a request
from a user only if the user is
congured to allow password
digest for authentication.
For more information about
conguring a user for digest
authentication, see "Adding
User Accounts" on page 92.
Request Kerberos
Ticket

Integration Server looks for a

Kerberos ticket in the HTTP
Authorization header using
the Negotiate authentication
scheme. If it does not nd the
ticket, Integration Server uses
user name and password for
basic authentication. If the
client does not provide any
authentication information,
Integration Server returns an
HTTP WWW-Authenticate
header with negotiate scheme
to the client requesting for
authentication information. If
the client provides the required
authentication information,
Integration Server veries and
validates the request.

Require Kerberos
Ticket

Integration Server looks for a

Kerberos ticket in the HTTP
Authorization header using
the Negotiate authentication
scheme. If it does not nd
the ticket, Integration Server
fails the authentication. If the
client does not provide any

webMethods Integration Server Administrators Guide Version 9.10

164

Odd Header
Configuring Ports

For this parameter...

Specify...
authentication information,
Integration Server returns an
HTTP WWW-Authenticate
header with negotiate scheme
to the client requesting for
authentication information. If
the client provides the required
authentication information,
Integration Server veries and
validates the request.

Kerberos Properties
(Optional)

Kerberos properties are used to enable Kerberos

authentication by providing Kerberos-related details
that will be used for handling service requests that
come with a Kerberos ticket. For information on
conguring Kerberos authentication, see "Kerberos
Authentication" on page 450.
JAAS Context

Specify the custom JAAS

context used for Kerberos
authentication.
In the following example, JAAS
Context is KerberosClient:
KerberosClient {
com.sun.security.auth.module.
Krb5LoginModule required
useKeyTab=true
keyTab=alice.keytab;
};

The is_jaas.cnf le distributed

with Integration Server
includes a JAAS context named
IS_KERBEROS_INBOUND
that can be used with inbound
requests.
Principal

Specify the name of the

principal to use for Kerberos
authentication.

Principal Password

Specify the password for

the principal that is used to
authenticate the principal to
the KDC. Specify the principal
password if you do not want to
use the keytab le that contains

webMethods Integration Server Administrators Guide Version 9.10

165

Even Header
Configuring Ports

For this parameter...

Specify...
the principals and their
passwords for authorization.
The passwords may be
encrypted using dierent
encryption algorithms.
If the JAAS login context
contains useKeyTab=false,
you must specify the principal
password.
Retype Principal
Password

Re-enter the principal

password.

Service Principal
Name Format

Select the format in which you

want to specify the principal
name of the service that is
registered with the principal
database.
host-based - Represent the
principal name using the
service name and the host
name, where host name is
the host computer. This is the
default.
username - Represent the
principal name as a named
user dened in the LDAP or
central user directory used for
authentication to the KDC.

Service Principal
Name

Specify the name of the

principal used with the service
that the Kerberos client wants
to access. Specify the Service
Principal Name in the following
format:
principal-name.instancename@realm-name

7. Click Save Changes.

8. On the Ports screen, click Edit to change the Access Mode if necessary. You may Set
Access Mode to Allow by Default or Reset to default access settings.

webMethods Integration Server Administrators Guide Version 9.10

166

Odd Header
Configuring Ports

For more information about seing access mode for a port and controlling IP access
for a port, see "Controlling Access to Resources by Port" on page 422
9. On the Ports screen, also check the list of ports to ensure that the status in the Enabled
column is Yes. If it is not, click No to enable the port.

Advanced Controls
By default, Integration Server accepts port connections requests as soon as it receives
them. This can be a problem if the port receives multiple requests simultaneously and
does not have the resources to handle them. You can handle this by specifying a delay
value using the Advanced Controls screen. With a delay value in place, Integration
Server will wait the specied number of milliseconds before accepting a connection
request on this port. The Advanced Controls screen provides you the capability to
control the rate at which the listener accepts connections, over the size of the private
thread pool, if it was enabled.

Editing Advanced Controls

To edit advanced controls, complete the following steps.
To edit advanced controls
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
You will see a Port List table in the main area of the screen.
3. In the Advanced column of this table, click Edit.
Integration Server displays a screen requesting information about Listener and
Private Thread Pool Controls. Note that the Diagnostic HTTP Listener State and
Private Threadpool areas of the screen are already populated with predened values.
4. Enter the following information:
For this parameter...

Specify...

Listener controls

The type of controls you want to set, to manage the

rate at which the listener accepts connections and other
controls when the private thread pool is enabled.
Suspend. Stops the listener from accepting any more
connections and subsequently dispatching any more
requests.
Increase By. Increases the time that the listener will wait
before accepting new client connections.

webMethods Integration Server Administrators Guide Version 9.10

167

Even Header
Configuring Ports

For this parameter...

Specify...
Decrease By. Decreases the time that the listener will
wait before accepting new client connections.
Set To (Delay ms). Sets the delay time interval in
milliseconds.

Private Thread Pool

Controls

The type of thread pool control you want, in order to

avoid the need for your port to compete with other
server functions when Integration Server is handling
multiple connections.
Increase By. Increases the number of threads in the
private thread pool.
Decrease By. Decreases the number of threads in the
private thread pool.
Set To (Threads). Sets the number of threads in the
private thread pool.

5. Click Apply to accept your changes. Else, click Cancel.

Adding an HTTPS Port

The HTTPS port enables Integration Server to authenticate the client and server securely
and encrypt the data exchanged. By default, the HTTPS listener uses the certicates
for the default Integration Server SSL key. However, you can congure the listener to
use its own private key residing in an Integration Server keystore (le- or SmartCard/
HSM-based). For more information, see "Conguring Server-Side SSL Seings" on page
414.
In addition, you can congure the type of client authentication that you want the server
to perform. Client authentication allows you to verify the identity of the client (for more
information, see "Authenticating Clients" on page 447).
To add an HTTPS port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Click Add Port.
4. In the Add Port area of the screen, select webMethods/HTTPS.
5. Click Submit. Integration Server Administrator displays a screen requesting
information about the port.
6. Under Regular HTTPS Listener Configuration, enter the following information:

webMethods Integration Server Administrators Guide Version 9.10

168

Odd Header
Configuring Ports

For this parameter...

Specify...

Enable

Indicate whether to enable (Yes) or disable (No) this

HTTPS or FTPS listener.

Port

The number you want to use for the port. Select a

number that is not already in use on this host machine.
If you are running multiple Integration Servers
Important:
on the same host machine, make sure the port
numbers used on each server are unique.

Alias

An alias for the port that is unique for this Integration

Server. An alias must be between 1 and 255 characters
in length and include one or more of the following:
leers (a -z, A-Z), numbers (0-9), underscore (_),
period (.), and hyphen (-).

Description

A description of the port.

Package name

Package associated with this port. When you enable

the package, the server enables the port. When you
disable the package, the server disables the port.
If you replicate this package, Integration Server creates
a port with this number and the same seings on
the target server. If a port with this number already
exists on the target server, its seings remain intact.
This feature is useful if you create an application
that expects input on a specic port. The application
will continue to work after it is replicated to another
server.

Bind Address (optional)

IP address to which to bind this port. Specify a bind

address if your machine has multiple IP addresses and
you want the port to use this specic address. If you
do not specify a bind address, the server picks one for
you.

Backlog

The number of requests that can remain in the queue

for an enabled port before Integration Server begins
rejecting requests. The default is 200. The maximum
value is 65535.

webMethods Integration Server Administrators Guide Version 9.10

169

Even Header
Configuring Ports

For this parameter...

Specify...
Note: This parameter does not apply to disabled
ports. Integration Server refuses requests sent to
disabled ports.

Keep Alive Timeout

When to close the connection if the server has

not received a request from the client within this
timeout value (in milliseconds); or when to close the
connection if the client has explicitly placed a close
request with the server.

Threadpool

Whether the listener will use this pool exclusively

for dispatching requests. The existing Integration
Server thread pool is a global thread pool. If there
is a very high load on this resource, the user may
have to wait for the global thread pool to process his
request. However, with the private thread pool option
enabled, requests coming into this port will not have
to compete with other server functions for threads.
Click Enable to enable the private thread pool seings.
You can change or accept the default seings given
below:
Threadpool Min refers to the minimum number of
threads for this private threadpool. The default is 1.
Threadpool Max refers to the maximum number of
threads for this private thread pool. The default is 5.
Threadpool Priority refers to the Java thread priority. The
default is 5.
Use this seing with extreme care because it will
Important:
aect server performance and throughput.
If you do not need to use the Threadpool feature, click
Disable.
When you view the ports details, the server reports
the total number of private threadpool threads
currently in use for the port.

7. Under Security Configuration, enter the following information:

webMethods Integration Server Administrators Guide Version 9.10

170

Odd Header
Configuring Ports

For this parameter...

Specify...

Use JSSE

If this port should support TLS 1.1 or TLS 1.2, click

Yes to create the port using the Java Secure Socket
Extension (JSSE) socket factory. The default is Yes.
If you set this value to No, the port supports only SSL
3.0 and TLS 1.0.
Note: To control the cipher suites used on
Integration Server ports that use JSSE
and handle inbound requests, set the
wa.net.jsse.server.enabledCipherSuiteList. For
more information, see "Server Conguration
Parameters" on page 851.

Client Authentication

The type of client authentication you want Integration

Server to perform for requests that arrive on this
HTTPS port. Select one of the following:
Option

Description

Username/Password

Integration Server prompts

the client for a user ID and
password.

Digest

Integration Server uses

password digest for
authentication of all requests.
If the client does not provide
the authentication information,
Integration Server returns an
HTTP WWW-Authenticate
header with digest scheme
to the client requesting for
authentication information. If
the client provides the required
authentication information,
Integration Server veries and
validates the request.
A port that is congured
Note:
to use password digest for
authentication of client
requests will process a
request from a user only
if the user is congured

webMethods Integration Server Administrators Guide Version 9.10

171

Even Header
Configuring Ports

For this parameter...

Specify...
to allow password digest
for authentication. For
more information about
conguring a user for digest
authentication, see "Adding
User Accounts" on page 92.
Request Client
Certificates

Integration Server requests

client certicates for all
requests. If the client does not
provide a certicate, the server
prompts the client for a userid
and password. If the client
provides a certicate:
The server checks whether
the certicate exactly matches
a client certicate on le
and is signed by a trusted
authority. If so, the client is
logged in as the user to which
the certicate is mapped in
Integration Server. If not, the
client request fails, unless
central user management is
congured.
If central user management
is congured, the server
checks whether the certicate
is mapped to a user in the
central user database. If so,
the server logs the client on
as that user. If not, the client
request fails.

Require Client
Certificates

Integration Server requires

client certicates for all
requests. The server behaves
as described for Request Client
Certificates, except that the
client must always provide a
certicate.

Request Kerberos
Ticket

Integration Server looks for a

Kerberos ticket in the HTTPS
Authorization header using

webMethods Integration Server Administrators Guide Version 9.10

172

Odd Header
Configuring Ports

For this parameter...

Specify...
the Negotiate authentication
scheme. If it does not nd
the ticket, Integration Server
tries to authenticate using
the client certicates from
the SSL handshake. If there
are no client certicates,
Integration Server, uses user
name and password for
basic authentication. If the
client does not provide any
authentication information,
Integration Server returns an
HTTP WWW-Authenticate
header with negotiate scheme
to the client requesting for
authentication information. If
the client provides the required
authentication information,
Integration Server veries and
validates the request.
Require Kerberos
Ticket

Kerberos Properties
(Optional)

Integration Server looks for a

Kerberos ticket in the HTTPS
Authorization header using
the Negotiate authentication
scheme. If it does not nd
the ticket, Integration Server
fails the authentication. If the
client does not provide any
authentication information,
Integration Server returns an
HTTP WWW-Authenticate
header with negotiate scheme
to the client requesting for
authentication information. If
the client provides the required
authentication information,
Integration Server veries and
validates the request.

Kerberos properties are used to enable Kerberos

authentication by providing Kerberos-related details
that will be used for handling service requests that
come with a Kerberos ticket. For information on

webMethods Integration Server Administrators Guide Version 9.10

173

Even Header
Configuring Ports

For this parameter...

Specify...
conguring Kerberos authentication, see "Kerberos
Authentication" on page 450.
JAAS Context

Specify the custom JAAS

context used for Kerberos
authentication.
In the following example, JAAS
Context is KerberosClient:
KerberosClient {
com.sun.security.auth.module.
Krb5LoginModule required
useKeyTab=true
keyTab=alice.keytab;
};

The is_jaas.cnf le distributed

with Integration Server
includes a JAAS context named
IS_KERBEROS_INBOUND
that can be used with inbound
requests.
Principal

Specify the name of the

principal to use for Kerberos
authentication.

Principal Password

Specify the password for

the principal that is used to
authenticate the principal to
the KDC. Specify the principal
password if you do not want to
use the keytab le that contains
the principals and their
passwords for authorization.
The passwords may be
encrypted using dierent
encryption algorithms.
If the JAAS login context
contains useKeyTab=false,
you must specify the principal
password.

Retype Principal
Password

webMethods Integration Server Administrators Guide Version 9.10

Re-enter the principal

password.

174

Odd Header
Configuring Ports

For this parameter...

Specify...
Service Principal
Name Format

Select the format in which you

want to specify the principal
name of the service that is
registered with the principal
database.
host-based - Represent the
principal name using the
service name and the host
name, where host name is
the host computer. This is the
default.
username - Represent the
principal name as a named
user dened in the LDAP or
central user directory used for
authentication to the KDC.

Service Principal
Name

Specify the name of the

principal used with the service
that the Kerberos client wants
to access. Specify the Service
Principal Name in the following
format:
principal-name.instancename@realm-name

8. Under Listener Specific Credentials, enter the following information:

Note:

Use these seings only if you want to use a dierent set of credentials from
the ones specied on the Certicates Screen.

For this parameter...

Specify...

Keystore Alias

Optional. A user-specied, text identier for an

Integration Server keystore.
The alias points to a repository of private keys and
their associated certicates. Although each listener
points to one keystore, there can be multiple keys and
their certicates in the same keystore, and more than
one listener can use the same keystore alias.

webMethods Integration Server Administrators Guide Version 9.10

175

Even Header
Configuring Ports

For this parameter...

Specify...
For more information, see "Creating Keystore Aliases"
on page 410.

Key Alias

Optional. The alias for the private key, which must be

stored in the keystore specied by the above keystore
alias.

Truststore Alias

Optional. The alias for the truststore. The truststore

must contain the trusted root certicate for the CA
that signed Integration Server certicate associated
with the key alias. The truststore also contains the
list of CA certicates that Integration Server uses to
validate the trust relationship.

9. Click Save Changes.

10. On the Ports screen, click Edit to change the Access Mode if necessary. You may Set
Access Mode to Allow by Default or Reset to default access settings.
For more information about seing access mode for a port and controlling IP access
for a port, see "Controlling Access to Resources by Port" on page 422
11. On the Ports screen, also check the list of ports to ensure that the status in the Enabled
column is Yes. If it is not, click No to enable the port.

About File Polling Ports

A le polling port periodically polls a monitoring directory for the arrival of les.
Integration Server then runs a special le processing service against the le. A le
polling port and processing works in the following way:
1. A le polling port on Integration Server periodically polls a monitoring directory for
the arrival of les. Each le polling port polls only one monitoring directory.
2. When it detects a new le, Integration Server copies the le to a working directory.
3. Integration Server executes the le processing service specied for the port. The
service might parse, convert, and validate the le then write it to the le system. This
service, which you write, is the only service that can be invoked through this port.
4. One of the following happens depending on whether or not the service processes the
le successfully:
If processing of le completes successfully, Integration Server moves the le to
the completion directory.
If processing of the le ends with an error, Integration Server moves the le to an
error directory.

webMethods Integration Server Administrators Guide Version 9.10

176

Odd Header
Configuring Ports

5. Integration Server cleans up the completion and error directories at a regular

interval. You can congure the how old a le must be before it can be removed from
the completion or error directories and how frequently Integration Server cleans up
the completion and error directories.
Note:

If Integration Server shuts down or becomes unavailable before completing

processing of a le in the working directory, the le remains in the working
directory after restart. Integration Server will not restart or resume processing
of a le left in the working directory. The administrator needs to decide
whether or not to move the le from the working directory to the monitoring
directory or to delete the le.

In a cluster of Integration Servers or non-clustered group of Integration Servers, le

polling works much the same way as it does on an individual Integration Server. The
only dierence is that more than one Integration Server polls the monitoring directory.
Once an Integration Server in a group retrieves a le from the monitoring directory, the
le is not available to other Integration Servers in the group.
To congure le polling, you must do the following:
Set up the Monitoring Directory on Integration Server. Other directories used for le
polling are automatically created by Integration Server.
Write a le processing service and make it available to Integration Server. See
webMethods Service Development Help and the Flat File Schema Developers Guide for
examples of such services.
Set up the le polling port on Integration Server.

Adding a File Polling Port

Use the following procedure to add a le polling port to Integration Server.
To add a file polling port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Click Add Port.
4. In the Add Port area of the screen, select webMethods/FilePolling.
5. Click Submit. Integration Server Administrator displays a screen requesting
information about the port.
6. Under Package, enter the following information:
For this parameter...

Specify...

Package Name

The package associated with this port.

webMethods Integration Server Administrators Guide Version 9.10

177

Even Header
Configuring Ports

For this parameter...

Specify...
When you enable the package, the server enables the
port. When you disable the package, the server disables
the port. If you are performing special le handling,
specify the package that contains the services that
perform that processing. If you want to process at les
from this port, select WmFlatFile, which contains built-in
services you can use to process at les.
Note: If you replicate this package, whether to a server
on the same machine or a server on a separate
machine, a le polling port with the same seings
is created on the target server. If a le polling port
already exists on the target server, its seings remain
intact. If the original and target servers reside on the
same machine, they will share the same monitoring
directory. If the target server resides on another
machine, by default, another monitoring directory
will be created on the target server's machine.

Alias

An alias for the port that is unique for this Integration

Server. An alias must be between 1 and 255 characters in
length and include one or more of the following: leers
(a -z, A-Z), numbers (0-9), underscore (_), period (.), and
hyphen (-).

Description

A description of the port.

7. Under Polling Information, enter the following information:

For this parameter...

Specify...

Monitoring Directory

Directory on Integration Server that you want to

monitor for les.

Working Directory
(optional)

Directory on Integration Server to which the server

should move les for processing after they have been
identied in the Monitoring Directory. Files must meet
age and le name requirements before being moved
to the Working Directory. The default sub-directory,
MonitoringDirectory \..\Work, is automatically
created if no directory is specied.\

Completion Directory
(optional)

Directory on Integration Server to which you want

les moved when processing is completed in the

webMethods Integration Server Administrators Guide Version 9.10

178

Odd Header
Configuring Ports

For this parameter...

Specify...
Monitoring Directory or Working Directory. The default
sub-directory, MonitoringDirectory \..\Done, is
automatically created if no directory is specied.
Note: Integration Server will not move a processed
le from the Working Directory to the Completion
Directory if the processed le has the same
name as a le that already exists in the
Completed Directory. To ensure that le names
are unique, you can instruct Integration
Server to append a time stamp to a le before
moving it to the Completion Directory. To do
this, update the properties.cnf le to include
appendTimeStampToFileName=true.
The properties.cnf le is located here:
Integration Server_directory\instances
\instanceName \packages\WmFlatFile\cong
If the properties.cnf le does not exist, create it.

Error Directory(optional)

Directory on Integration Server to which you want

les moved when processing fails. The default
sub-directory, MonitoringDirectory \..\Error, is
automatically created if no directory is specied.

File Name Filter (optional)

The le name lter for les in the Monitoring Directory.

Integration Server only processes les that meet the
lter requirements. If you do not specify this eld, all
les will be polled. You can specify paern matching
in this eld.

File Age (optional)

The minimum age (in seconds) at which a le in the

Monitoring Directory can be processed. Integration
Server determines le age based on when the le
was last modied on the monitoring directory. You
can adjust this age as needed to make sure the server
does not process a le before the entire le has been
copied to the Monitoring Directory. The default is 0.

Content Type

Content type to use for the le. The server uses

the content handler associated with the content
type specied in this eld. If no value is specied,
Integration Server performs MIME mapping based
on the le extension.

webMethods Integration Server Administrators Guide Version 9.10

179

Even Header
Configuring Ports

For this parameter...

Specify...
Note: When the content type is XML, the at le parser
uses UTF-8 as the default encoding. To override
the default encoding, update the properties.cnf
le to include lepollingport=encodingType
where encodingType is the encoding that you
want the at le parser to use for parsing XML
les.
The properties.cnf le is located here:
Integration Server_directory\instances
\instanceName \packages\WmFlatFile\cong
If the properties.cnf le does not exist, create it.

Allow Recursive Polling

Whether Integration Server is to poll all subdirectories in the Monitoring Directory. Select Yes or No.

Enable Clustering

Whether Integration Server should allow clustering

in the Monitoring Directory. Select Yes or No.

Lock File Extension

(optional)

Denes the polling for a particular extension.

Number of files to process

per interval (optional)

Species the maximum number of les that the

le polling listener can process per interval. When
you specify a positive integer, the le polling
listener processes only that number of les from
the monitoring directory. Any les that remain in
the monitoring directory will be processed during
subsequent intervals. If no value is specied, the
listener processes all of the les in the monitoring
directory.

8. Under Security, in the Run services as user parameter, specify the user name you want
to use to run the services assigned to the le polling directory. Click
to lookup
and select a user. The user can be an internal or external user.
9. Under Message Processing, supply the following information:
For this parameter...

Specify...

Enable

Whether to enable (Yes) or disable (No) this le

polling port.

Processing Service

Name of the service you want Integration Server

to execute for polled les. The server executes this

webMethods Integration Server Administrators Guide Version 9.10

180

Odd Header
Configuring Ports

For this parameter...

Specify...
service when the le has been copied to the Working
directory. This service should be the only service
available from this port.
If you change the processing service for a le
Important:
polling port, you must also change the list of
services available from this port to contain
just the new service. See below for more
information.

File Polling Interval

How often (in seconds) you want Integration Server

to poll the Monitoring Directory for les.

Log Only When Directory

Availability Changes

If you select No (the default), the listener will log

a message every time the monitoring directory is
unavailable.
If you select Yes, the listener will log a message in
either of the following cases:
The directory was available during the last polling
aempt but not available during the current aempt
The directory was not available during the last
polling aempt but is available during the current
aempt

Directories are an NFS

Mounted File System

For use on a UNIX system where the monitoring

directory, working directory, completion directory,
and/or error directory are network drives mounted
on the local le system.
If you select No (the default), the listener will call the
Java File.renameTo() method to move the les from
the monitoring directory to the working directory,
and from the working directory to the completion
and/or error directory.
If you select Yes, the listener will rst call the Java
File.renameTo() method to move the les from the
monitoring directory. If this method fails, the listener
will then copy the les from the monitoring directory
to the working directory and delete the les from
the monitoring directory. This operation will fail if
either the copy action or the delete action fails. The
same behavior applies when moving les from the
working directory to the completion and/or error
directory.

webMethods Integration Server Administrators Guide Version 9.10

181

Even Header
Configuring Ports

For this parameter...

Specify...

Cleanup Service (Optional)

The name of the service that you want to use to clean

up the directories specied under Polling Information.

Cleanup At Startup

Whether to clean up les that are located in the

Completion Directory and Error Directory when the le
polling port is started.

Cleanup File Age

(Optional)

The number of days to wait before deleting

processed les from your directories. The default is 7
days.

Cleanup Interval (Optional)

How often (in hours) you want Integration Server to

check the processed les for cleanup. The default is
24 hours

Maximum Number of
Invocation Threads

The number of threads you want Integration Server

to use for this port. Type a number from 1-10. The
default is 10.

10. Click Save Changes.

11. Make sure the port's access mode is properly set and that the le processing service
is the only service accessible from the port.
a. In the Ports screen, click Edit in the Access Mode eld for the port you just created.
b. Click Set Access Mode to Deny by Default.
c. Click Add Folders and Services to Allow List.
d. Type the name of the processing service for this port in the text box under Enter
one folder or service per line.
e. Remove any other services from the allow list.
f.

Click Save Additions.

Note:

If you change the processing service for a le polling port, remember

to change the Allow List for the port as well. Follow the procedure
described above to alter the allowed service list.

g. If you change the processing service for a le polling port, remember to change
the Allow List for the port as well. Follow the procedure described above to alter
the allowed service list.

webMethods Integration Server Administrators Guide Version 9.10

182

Odd Header
Configuring Ports

Adding an FTPS Port

The FTPS (FTP over SSL) port enables the server to authenticate the FTP client and
server in a secure manner, and encrypt the control and data exchange between the FTP
client and server.
Keep the following points in mind when conguring an FTPS port:
FTPS clients are always prompted for a userid and password.
By default, the FTPS port will work only with secure clients. A secure client is a
client that secures the connection by issuing the AUTH command. You also can
congure the FTPS listener to operate with clients that are not secure.
You can congure the FTPS port to use its own certicate or use Integration Server
certicate, or to request or require client certicates. In addition, you can congure
the listener to use a private key and certicate chain residing in a keystore (leor SmartCard/HSM-based). For more information about client certicates, see
"Authenticating Clients" on page 447.
By default, Integration Server does not perform certicate mapping for FTPS ports.
To use this feature, you must set the wa.net.ftpUseCertMap conguration property
to true. For more information about how client authentication works for FTPS
ports, see "Authenticating Clients" on page 447. For more information about
certicate mapping, see "Importing a Certicate (Client or CA Signing Certicate)
and Mapping It to a User" on page 452.
When a user logs in through an FTPS port, Integration Server can place the user
in the default FTP root directory or in the client user directory. Integration Server
chooses the directory based on the seing of the wa.server.login.userFtpDir
parameter. For more information, see "Server Conguration Parameters" on page
851.
To add an FTPS port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Click Add Port.
4. In the Add Port area of the screen, select webMethods/FTPS.
5. Click Submit. Integration Server displays a screen requesting information about the
port. Enter the following information:
For this parameter...

Specify...

Enable

Select whether to enable (Yes) or disable (No) this

FTPS port.

webMethods Integration Server Administrators Guide Version 9.10

183

Even Header
Configuring Ports

For this parameter...

Specify...

Port

The number you want to use for the port. Select

a number that is not already in use on this host
machine.
If you are running multiple Integration Servers
Important:
on the same host machine, make sure the port
numbers used on each server are unique.

Alias

An alias for the port that is unique for this

Integration Server. An alias must be between 1 and
255 characters in length and include one or more
of the following: leers (a -z, A-Z), numbers (0-9),
underscore (_), period (.), and hyphen (-).

Description

A description of the port.

Package Name

Package associated with this port. When you enable

the package, the server enables the port. When you
disable the package, the server disables the port.
If you replicate this package, Integration Server
creates a port with this number and the same seings
on the target server. If a port with this number
already exists on the target server, its seings
remain intact. This feature is useful if you create an
application that expects input on a specic port. The
application will continue to work after it is replicated
to another server.

Bind Address (optional)

IP address to which to bind this port. Specify a bind

address if your machine has multiple IP addresses
and you want the port to use this specic address. If
you do not specify a bind address, the server picks
one for you.

Passive Mode Listen

Address (optional)

Address to be sent by the PORT command. You can

specify a host name or IP address.
Note: This option is not applicable when the FTPS port
is bound to an IPv6 address. In that case, the
passive mode listen address is the same as the
port bind address.
When running in passive mode, the FTPS port sends
a PORT command to the FTPS client. The PORT
command species the address and port to which

webMethods Integration Server Administrators Guide Version 9.10

184

Odd Header
Configuring Ports

For this parameter...

Specify...
the client should connect to create a data connection.
If the FTPS port is behind a NAT server, however,
the address of the host on which Integration Server
runs is not visible to the FTPS client. Consequently
the PORT command does not contain the information
the client needs to connect to the server. To remedy
this situation, you can specify a value for the
wa.net.ftpPassiveLocalAddr property in the
server conguration le (server.cnf), which is
located in the Integration Server_directory\instances
\instance_name \cong directory (see "Server
Conguration Parameters" on page 851).
Alternatively, you can use the Passive Mode Listen
Address eld to specify the passive mode address for
an individual FTPS port. That way, you can specify
a dierent passive mode address for each FTPS port.
If an address is specied in the Passive Mode Listen
Address eld and in the wa.net.ftpPassiveLocalAddr
property, the PORT command uses the value
specied in the wa.net.ftpPassiveLocalAddr
property.

Secure Clients Only

Select this check box to prevent the FTPS listener

from operating with non-secure clients.

6. Under Security Configuration, in the Client Authentication list, select the type of client
authentication you want Integration Server to perform for requests that arrive on this
FTPS port.
Option

Description

Username/Password

Integration Server prompts the client for a user ID

and password.

Request Client Certificates

Integration Server requests client certicates for all

requests. If the client does not provide a certicate,
the server prompts the client for a userid and
password. If the client provides a certicate:
The server checks whether the certicate exactly
matches a client certicate on le and is signed
by a trusted authority. If so, the client is logged in
as the user to which the certicate is mapped in
Integration Server. If not, the client request fails,
unless central user management is congured.

webMethods Integration Server Administrators Guide Version 9.10

185

Even Header
Configuring Ports

Option

Description
If central user management is congured, the server
checks whether the certicate is mapped to a user
in the central user database. If so, the server logs the
client on as that user. If not, the client request fails.

Require Client Certificates

Integration Server requires client certicates for all

requests. The server behaves as described for Request
Client Certificates, except that the client must always
provide a certicate.

7. Under Listener Specific Credentials, enter the following information:

Note:

Use these seings only if you want to use a dierent set of credentials from
the ones specied on the Certicates Screen.

For this parameter...

Specify...

Keystore Alias

Optional. A user-specied, text identier for an

Integration Server keystore.
The alias points to a repository of private keys and
their associated certicates. Although each listener
points to one keystore, there can be multiple keys
and their certicates in the same keystore, and more
than one listener can use the same keystore alias.
For more information, see "Creating Keystore
Aliases" on page 410.

Key Alias

Optional. The alias for the private key, which must

be stored in the keystore specied by the above
keystore alias.

Truststore Alias

Optional. The alias for the truststore. The truststore

must contain the trusted root certicate for the CA
that signed Integration Server certicate associated
with the key alias. The truststore also contains the
list of CA certicates that Integration Server uses to
validate the trust relationship.

8. Click Save Changes.

9. On the Ports screen, click Edit to change the Access Mode if necessary. You may Set
Access Mode to Allow by Default or Reset to default access settings.

webMethods Integration Server Administrators Guide Version 9.10

186

Odd Header
Configuring Ports

For more information about seing access mode for a port and controlling IP access
for a port, see "Controlling Access to Resources by Port" on page 422
10. On the Portsscreen, also check the list of ports to ensure that the status in the Enabled
column is Yes. If it is not, click No to enable the port.

Adding an FTP Port

Using an FTP port, you can move les to and from Integration Server. Complete the
instructions below to congure an FTP port.
When a user logs in through an FTP port, Integration Server can place the user in the
default FTP root directory or in the client user directory. Integration Server chooses the
directory based on the seing of the wa.server.login.userFtpDir parameter. For more
information, see "Server Conguration Parameters" on page 851.
To add an FTP port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Click Add Port.
4. In the Add Port area of the screen, select webMethods/FTP.
5. Click Submit. Integration Server displays a screen requesting information about the
port. Enter the following information:
For this parameter...

Specify...

Port

The number you want to use for the port. Select

a number that is not already in use on this host
machine.
If you are running multiple Integration Servers
Important:
on the same host machine, make sure the port
numbers used on each server are unique.

Alias

An alias for the port that is unique for this

Integration Server. An alias must be between 1 and
255 characters in length and include one or more
of the following: leers (a -z, A-Z), numbers (0-9),
underscore (_), period (.), and hyphen (-).

Description

A description of the port.

webMethods Integration Server Administrators Guide Version 9.10

187

Even Header
Configuring Ports

For this parameter...

Specify...

Package Name

Package associated with this port. When you enable

the package, the server enables the port. When you
disable the package, the server disables the port.
If you replicate this package, Integration Server
creates a port with this number and the same seings
on the target server. If a port with this number
already exists on the target server, its seings
remain intact. This feature is useful if you create an
application that expects input on a specic port. The
application will continue to work after it is replicated
to another server.

Bind Address (optional)

IP address to which to bind this port. Specify a bind

address if your machine has multiple IP addresses
and you want the port to use this specic address. If
you do not specify a bind address, the server picks
one for you.

Passive Mode Listen

Address (optional)

The address that should be sent by the PORT

command. A host name or IP address can be
specied.
Note: This option is not applicable when the FTP port
is bound to an IPv6 address. In that case, the
passive mode listen address is the same as the
port bind address.
When running in passive mode, the FTP port sends
a PORT command to the FTP client. The PORT
command species the address and port to which
the client should connect to create a data connection.
If the FTP port is behind a NAT server, however,
the address of the host on which Integration Server
runs is not visible to the FTP client. Consequently the
PORT command does not contain the information
the client needs to connect to the server. To remedy
this situation, you can specify a value for the
wa.net.ftpPassiveLocalAddr property in the
server conguration le (server.cnf), which is
located in the Integration Server_directory\instances
\instance_name \cong directory (see "Server
Conguration Parameters" on page 851).
Alternatively, you can use the Passive Mode Listen
Address eld to specify the passive mode address for
an individual FTP port. That way, you can specify

webMethods Integration Server Administrators Guide Version 9.10

188

Odd Header
Configuring Ports

For this parameter...

Specify...
a dierent passive mode address for each FTP port.
If an address is specied in the Passive Mode Listen
Address eld and in the wa.net.ftpPassiveLocalAddr
property, the PORT command uses the value
specied in the wa.net.ftpPassiveLocalAddr
property.

6. Click Save Changes.

7. On the Ports screen, click Edit to change the Access Mode if necessary. You may Set
Access Mode to Allow by Default or Reset to default access settings.
For more information about seing access mode for a port and controlling IP access
for a port, see "Controlling Access to Resources by Port" on page 422
8. On the Ports screen, also check the list of ports to ensure that the status in the Enabled
column is Yes. If it is not, click No to enable the port.

Adding an E-Mail Port

By seing up one or more e-mail ports on your Integration Server, you can receive client
requests through an e-mail server (POP3 or IMAP). The client builds an e-mail that
contains the name of the service to run and parameters to pass to the service. The e-mail
can also contain user ID and password information.
Before adding an e-mail port, review the information in "Security Considerations for EMail Ports" on page 196.
To add an e-mail port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Click Add Port.
4. In the Add Port area of the screen, select webMethods/E-mail.
5. Click Submit. Integration Server displays the Edit E-mail Client Configuration screen
requesting information about the port.
6. Under Package, specify the following information:
For this parameter...

Specify...

Package Name

The package associated with this port. When you

enable the package, the server enables the port.
When you disable the package, the server disables
the port.

webMethods Integration Server Administrators Guide Version 9.10

189

Even Header
Configuring Ports

For this parameter...

Specify...
If you replicate this package, Integration Server
creates a port with this number and the same
seings on the target server. If a port with this
number already exists on the target server, its
seings remain intact. This feature is useful if you
create an application that expects input on a specic
port. The application will continue to work after it is
replicated to another server.

Alias

An alias for the port that is unique for this

Integration Server. An alias must be between 1 and
255 characters in length and include one or more
of the following: leers (a -z, A-Z), numbers (0-9),
underscore (_), period (.), and hyphen (-).

Description

A description of the port.

7. Under Server Information, supply the following information:

For this parameter...

Specify...

Enable

Whether to enable (Yes) or disable (No) the e-mail port.

The port can receive requests only when it is enabled.

Type

Type of mail server. Select POP3 or IMAP.

Host Name

Name of the machine on which the POP3 or IMAP

server is running.

Port

Port on the e-mail server to which Integration Server is

to connect.
For a POP3 mail server, the defaults are 110 for explicit
SSL and 995 for implicit SSL.
For an IMAP mail server, the defaults are 143 for
explicit SSL and 993 for implicit SSL.

User Name

User name that identies you to the e-mail server.

Password

Password associated with the user name that identies

you to the e-mail server.

webMethods Integration Server Administrators Guide Version 9.10

190

Odd Header
Configuring Ports

For this parameter...

Specify...

Transport Layer Security

Type of SSL encryption that Integration Server uses

when communicating with an e-mail server. You
can congure the port to use explicit, implicit, or no
Transport Layer Security.
Specify...

To...

None

Default. Use a non-secure mode when

communicating with an e-mail server.
When you specify None, the e-mail server
authenticates the e-mail client using only
the username and password.

Explicit

Use explicit security when

communicating with an e-mail server.
With explicit security, Integration Server
establishes an un-encrypted connection
to the e-mail server and then upgrades to
the secure mode.
With explicit Transport layer Security,
Integration Server can communicate
with e-mail servers that support and
do not support SSL encryption. If the email server does not support Transport
Layer Security, Integration Server will
disconnect the connection established to
the e-mail server. You can then establish
an un-secure connection with the e-mail
server by selecting the None option in the
Transport Layer Security eld and enabling
the port.

Implicit

Truststore Alias
(optional)

Use implicit security when

communicating with an e-mail server.
With implicit security, Integration
Server always establishes an encrypted
connection to the e-mail server. Only
clients that support SSL will be permied
access.

Optional. Alias for the truststore that contains

certicates presented by the e-mail server to
Integration Server. If you do not select a truststore
alias, the default truststore alias specied in the

webMethods Integration Server Administrators Guide Version 9.10

191

Even Header
Configuring Ports

For this parameter...

Specify...
wa.security.trustStoreAlias property will be used.
For more information about this property, see
"wa.security." on page 874. For more information
about truststore alias, see "Creating Keystore Aliases"
on page 410.

Time Interval

How often (in seconds) Integration Server is to check

for e-mails in the POP3 or IMAP server.

Log out after each mail

check

For use with IMAP and multithreading only. If you

select Yes, Integration Server logs out a read-only
thread to the IMAP mail server after checking for
mail on that thread. The main read/write thread to
the IMAP server remains intact. If you select No, all
the read-only threads remain intact. Select Yes if your
IMAP server restricts the number of connections it will
allow to remain logged in.

8. Under Security, provide the following information:

For this parameter...

Specify...

Run services as user

If you select Yes in the Require authentication within

message eld, the Run services as user eld remains blank
because Integration Server expects the user name and
password to be in the e-mail. If you select No in the
Require authentication within message eld, you must enter
the user under which the service is to run on Integration
Server.

Require authentication
within message

If you select Yes, Integration Server checks for $user and

$pass parameters in the Subject line of the e-mail. The
user name is the user under which the service is to run on
Integration Server. If you select No, you must specify the
user in the Run services as user eld above.
When you select No,
appears next to this eld. Click
to look up and select a user. The user can be an internal or
external user.

9. Under Message Processing, complete the following information:

webMethods Integration Server Administrators Guide Version 9.10

192

Odd Header
Configuring Ports

For this parameter...

Specify...

Global Service (optional)

Service to be executed on Integration Server. This

eld overrides a service specied in the Subject line
of the e-mail.

Default Service (optional)

Service to be executed if the e-mail does not provide

a valid service in the Subject line and the Global
Service eld is blank.

Send reply e-mail with

service output

Click Yes if you want Integration Server to send any

output generated by the service to the original sender
in an e-mail aachment. Click No if you do not want
to do so. If the original e-mail contained multiple
aachments, the reply contains an equal number of
aachments.

Send reply e-mail on error

Click Yes if you want Integration Server to report

any errors that occurred during service execution to
the original sender in the Body portion of an e-mail.
Click No if you do not want to do so.
Note: For more information about sending e-mail
notications when errors occur, see "Sending
Messages About Critical Issues to E-mail
Addresses" on page 222.

Delete valid messages

(IMAP only)

Click Yes if you want to delete a valid e-mail from the

IMAP server once Integration Server has successfully
received the e-mail. This seing helps prevent e-mails
from accumulating on the IMAP server, possibly
aecting disk space and performance. Integration
Server always deletes e-mails on a POP3 server. Click
No if you want to retain the e-mails on the IMAP
server.

Delete invalid messages

(IMAP only)

Click Yes if you want to delete invalid e-mails from

the IMAP server. Click No if you do want to remove
these e-mails from the server.
Invalid e-mails are those that reference services that
cannot be invoked. For example, if the referenced
service does not exist, the server will delete the email. If the service was invoked, but encountered
errors, the server considers the associated e-mail to
be valid.

webMethods Integration Server Administrators Guide Version 9.10

193

Even Header
Configuring Ports

For this parameter...

Specify...
This seing helps prevent invalid e-mails from
accumulating on the IMAP server, possibly aecting
disk space and performance. Integration Server
always deletes e-mails on a POP3 server.

Multithreaded processing
(IMAP only)

Click Yes if you want Integration Server to use

multiple threads for this port. This seing allows the
port to handle multiple requests at once and avoid a
boleneck. Click No if you do not need this feature.

Number of threads if
multithreading is turned
on.

Tells Integration Server the number of threads to use

for this port. The default is set to 0.

Invoke service for each

part of multipart message

Species whether Integration Server invokes the

service for each part of a multi-part message or just
once for the entire message.

Note: If the e-mail port is congured to allow

multithreading and if the e-mail port receives
a large number of messages in a short period
of time, the e-mail port will monopolize the
server thread pool for retrieving and processing
messages. This will slow down the performance
of Integration Server. To avoid this, you can
limit the number of threads used to process
messages received by the e-mail port by seing
the wa.server.email.waitForServiceCompletion
property. For more information about this
property, see "Server Conguration Parameters"
on page 851.

If you specify No, the entire e-mail is passed to the

appropriate content handler and then to the specied
service for execution. When you send an entire multipart e-mail, make sure the server includes the e-mail
headers from the beginning of the message, so that
the content handler and/or service knows how to
process the content type headers included in each
part of the e-mail. See Include e-mail headers when
passing message to content handler below.
If you specify Yes, Integration Server treats each
part of the message individually. That is, Integration
Server sends each part to the content handler and
then to the specied service. When you specify
Yes, you probably do not want to include the e-

webMethods Integration Server Administrators Guide Version 9.10

194

Odd Header
Configuring Ports

For this parameter...

Specify...
mail headers from the beginning of the message,
because each section has its own headers that the
content handler and/or the service already knows
how to process. See Include e-mail headers when passing
message to content handler below.

Include e-mail headers

when passing message to
content handler

Species whether Integration Server includes the email headers when passing an e-mail message to the
content handler. The e-mail headers are typically
found at the beginning of an e-mail message. Specify
Yes if you are processing a multi-part message as a
single message. This ensures that the content handler
and/or service can properly process the body of the
e-mail. Specify No if you are processing the dierent
parts of an e-mail individually. If you are processing
a single-part e-mail, you probably do not want to
include e-mail headers.

E-mail body contains URL

encoded input parameters

Species how Integration Server treats input

parameters it nds in e-mail messages. With this
value set to Yes, Integration Server considers a string
such as ?one=1+two=2 to be a URL encoded input
parameter. It then decodes this string into an IData
object, puts it into the pipeline, and passes it to the
service. With this value set to No, Integration Server
treats the string as plain text and passes it to the
appropriate content handler.

10. Click Save Changes.

11. On the Ports screen, click Edit to change the Access Mode if necessary. You may Set
Access Mode to Allow by Default or Reset to default access settings.
Note:

If you set port access restrictions, be sure the wa.net.email.validateHost

server conguration property is set to true, so Integration Server honors
your IP access restrictions.

For more information about seing access mode for a port and controlling IP access
for a port, see "Controlling Access to Resources by Port" on page 422
12. On the Ports screen, also check the list of ports to ensure that the status in the Enabled
column is Yes. If it is not, click No to enable the port.

webMethods Integration Server Administrators Guide Version 9.10

195

Even Header
Configuring Ports

Security Considerations for E-Mail Ports

Passing a userid and password in an e-mail presents a possible security exposure. While
the e-mail resides on the POP3 or IMAP server, someone might be able to access the
information in the e-mail using the userid and password. To make your communication
with the e-mail server secure, you can congure Integration Server to use either
explicit or implicit Transport Layer Security (TLS) through Secure Sockets Layer (SSL).
Integration Server uses client certicates for implementing Transport Layer Security and
authenticates the connection using the userid and password.

Adding an HTTP Diagnostic Port

The diagnostic port is a special port that uses threads from a dedicated thread pool to
accept requests via HTTP. The diagnostic port uses a dedicated thread pool so that you
can access Integration Server when it becomes unresponsive.
When you install Integration Server, it automatically creates the diagnostic port at 9999.
If another port is running on that Integration Server at 9999, the server will disable the
diagnostic port at startup.
Each Integration Server can have only one diagnostic port. If you want to add a new
diagnostic port, you must delete the existing port rst. For information about how to
delete a port, see "Deleting a Port" on page 209.
If you are running multiple Integration Servers on the same machine, you specied the
diagnostic port number for each server instance during the instance creation process.
If the diagnostic port numbers are not unique between Integration Server instances,
the rst Integration Server to start on the machine will have a functioning diagnostic
port, but Integration Servers that start after the rst one will not. For more information
about running multiple Integration Servers on the same machine, see "Running Multiple
Integration Server Instances" on page 73.
For more information about the diagnostic port, see "Diagnosing the Integration Server "
on page 831.
To add an HTTP diagnostic port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Click Add Port.
4. Under Add Port, select HTTP Diagnostic.
5. Click Submit.
6. On the Edit Diagnostic Port Configuration screen, enter the following information:

webMethods Integration Server Administrators Guide Version 9.10

196

Odd Header
Configuring Ports

For this parameter

Specify

Port

The number you want to use for the diagnostic port.

Select a number that is not already in use on this host
machine.
Note: The wa.server.diagnostic.port server
conguration parameter overrides this port
number.
If you are running multiple Integration Servers
Important:
on the same host machine, make sure the
diagnostic port number on each server is unique.

Alias

An alias for the port that is unique for this Integration

Server. An alias must be between 1 and 255 characters
in length and include one or more of the following:
leers (a -z, A-Z), numbers (0-9), underscore (_),
period (.), and hyphen (-).

Description

A description of the port.

Package Name

The package associated with this port. The default

package is WmRoot. When you enable the package,
the server enables the port. When you disable the
package, the server disables the port.
If you replicate this package, Integration Server
creates a port with this number and the same seings
on the target server. If a port with this number already
exists on the target server, its seings remain intact.
This feature is useful if you create an application
that expects input on a specic port. The application
will continue to work after it is replicated to another
server.
Note: You cannot change the Package Name associated
with this port. The diagnostic port must always be
associated with the WmRoot package.

Bind Address (optional)

The IP address to which you want to bind this port.

Specify a bind address if your machine has multiple
IP addresses and you want the port to use a specic
address. If you do not specify a bind address, the
server picks one for you.

webMethods Integration Server Administrators Guide Version 9.10

197

Even Header
Configuring Ports

For this parameter

Specify

Backlog

The number of requests that can remain in the queue

for an enabled port before Integration Server begins
rejecting requests. The default is 200. The maximum
value is 65535.
Note: This parameter does not apply to disabled
ports. Integration Server refuses requests sent to
disabled ports.

Keep Alive Timeout

When to close the connection if the server has

not received a request from the client within this
timeout value (in milliseconds); or when to close the
connection if the client has explicitly placed a close
request with the server.

Threadpool

Whether the listener will use this pool exclusively

for dispatching requests. The existing Integration
Server thread pool is a global thread pool. If there
is a very high load on this resource, the user may
have to wait for the global thread pool to process his
request. However, with the private thread pool option
enabled, requests coming into this port will not have
to compete with other server functions for threads.
Click Enable to enable the private thread pool seings.
You can change or accept the default seings given
below:
Threadpool Min refers to the minimum number of
threads for this private threadpool. The default is 1.
Threadpool Max refers to the maximum number of
threads for this private threadpool. The default is 5.
Threadpool Priority refers to the Java thread priority.
The default is 5.
Use this seing with extreme care because it will
Important:
aect server performance and throughput.
If you do not need to use the Threadpool feature, click
Disable.
When you view the ports details, the server reports
the total number of private threadpool threads
currently in use for the port.

webMethods Integration Server Administrators Guide Version 9.10

198

Odd Header
Configuring Ports

7. Under Security Configuration, enter the following information:

For this parameter...

Specify...

Client Authentication

The type of client authentication you want Integration

Server to perform for requests that arrive on this
HTTP port. Select one of the following:
Option

Description

Username/
Password

Integration Server prompts

the client for a user ID and
password.

Digest

Integration Server uses password

digest to authenticate all
requests. If the client does not
provide the authentication
information, Integration Server
returns an HTTP WWWAuthenticate header with digest
scheme to the client requesting
for authentication information. If
the client provides the required
authentication information,
Integration Server veries and
validates the request.
A port that is congured
Note:
to use password digest for
authentication of client
requests will process a request
from a user only if the user is
congured to allow password
digest for authentication.
For more information about
conguring a user for digest
authentication, see "Adding
User Accounts" on page 92.

8. Click Save Changes.

9. On the Ports screen, click Edit to change the Access Mode if necessary. You may Set
Access Mode to Allow by Default or Reset to default access settings.
For more information about seing access mode for a port and controlling IP access
for a port, see "Controlling Access to Resources by Port" on page 422

webMethods Integration Server Administrators Guide Version 9.10

199

Even Header
Configuring Ports

10. On the Ports screen, also check the list of ports to ensure that the status in the Enabled
column is Yes. If it is not, click No to enable the port.

Adding an HTTPS Diagnostic Port

The diagnostic port is a special port that uses threads from a dedicated thread pool to
accept requests via HTTP/S. The diagnostic port uses a dedicated thread pool so that you
can access Integration Server when it becomes unresponsive.
Each Integration Server can have only one diagnostic port. If you want to add a new
diagnostic port, you must delete the existing port rst. For information about how to
delete a port, see "Deleting a Port" on page 209.
If you are running multiple Integration Servers on the same machine, you specied the
diagnostic port number for each server instance during the instance creation process.
If the diagnostic port numbers are not unique between Integration Server instances,
the rst Integration Server to start on the machine will have a functioning diagnostic
port, but Integration Servers that start after the rst one will not. For more information
about running multiple Integration Servers on the same machine, see "Running Multiple
Integration Server Instances" on page 73.
To add an HTTPS diagnostic port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Click Add Port.
4. Under Add Port, select HTTPS Diagnostic.
5. Click Submit.
6. On the Edit Diagnostic Port Configuration screen, under Diagnostic HTTPS Listener
Configuration, enter the following information:
For this parameter...

Specify...

Enable

Select whether to enable (Yes) or disable (No) this

HTTPS diagnostic port.

Port

The number you want to use for the diagnostic port.

Select a number that is not already in use on this host
machine.
Note: The wa.server.diagnostic.port server
conguration parameter overrides this port
number.

webMethods Integration Server Administrators Guide Version 9.10

200

Odd Header
Configuring Ports

For this parameter...

Specify...
If you are running multiple Integration Servers
Important:
on the same host machine, make sure the
diagnostic port number on each server is unique.

Alias

An alias for the port that is unique for this Integration

Server. An alias must be between 1 and 255 characters
in length and include one or more of the following:
leers (a -z, A-Z), numbers (0-9), underscore (_),
period (.), and hyphen (-).

Description

A description of the port.

Package Name

The package associated with this port. The default

package is WmRoot. When you enable the package,
the server enables the port. When you disable the
package, the server disables the port.
If you replicate this package, Integration Server
creates a port with this number and the same seings
on the target server. If a port with this number already
exists on the target server, its seings remain intact.
This feature is useful if you create an application
that expects input on a specic port. The application
will continue to work after it is replicated to another
server.
Note: You cannot change the Package Name associated
with this port. The diagnostic port must always be
associated with the WmRoot package.

Bind Address (optional)

The IP address to which you want to bind this port.

Specify a bind address if your machine has multiple
IP addresses and you want the port to use a specic
address. If you do not specify a bind address, the
server picks one for you.

Backlog

The number of requests that can remain in the queue

for an enabled port before Integration Server begins
rejecting requests. The default is 200. The maximum
value is 65535.
Note: This parameter does not apply to disabled
ports. Integration Server refuses requests sent to
disabled ports.

webMethods Integration Server Administrators Guide Version 9.10

201

Even Header
Configuring Ports

For this parameter...

Specify...

Keep Alive Timeout

When to close the connection if the server has

not received a request from the client within this
timeout value (in milliseconds); or when to close the
connection if the client has explicitly placed a close
request with the server.

Threadpool

Whether the listener will use this pool exclusively

for dispatching requests. The existing Integration
Server thread pool is a global thread pool. If there
is a very high load on this resource, the user may
have to wait for the global thread pool to process his
request. However, with the private thread pool option
enabled, requests coming into this port will not have
to compete with other server functions for threads.
Click Enable if you wish to employ the private thread
pool seings. You can change or accept the default
seings given below:
Threadpool Min refers to the minimum number of
threads for this private threadpool. The default is 1.
Threadpool Max refers to the maximum number of
threads for this private thread pool. The default is 5.
Threadpool Priority refers to the Java thread priority.
The default is 5.
Use this seing with extreme care because it will
Important:
aect server performance and throughput.
If you do not need to use the Threadpool feature, click
Disable.
When you view the ports details, the server reports
the total number of private threadpool threads
currently in use for the port.

7. Under Security Configuration, enter the following information:

For this parameter...

Specify...

Client Authentication

The type of client authentication you want

Integration Server to perform for requests that arrive
on this HTTPS port. See "Authenticating Clients" on
page 447 for more information.
Select one of the following:

webMethods Integration Server Administrators Guide Version 9.10

202

Odd Header
Configuring Ports

For this parameter...

Specify...
Option

Description

Username/
Password

Integration Server prompts

the client for a user ID and
password.

Digest

Integration Server uses

password digest for
authentication of all requests.
If the client does not provide
the authentication information,
Integration Server returns an
HTTP WWW-Authenticate
header with digest scheme
to the client requesting for
authentication information. If
the client provides the required
authentication information,
Integration Server veries and
validates the request.
A port that is congured
Note:
to use password digest for
authentication of client
requests will process a request
from a user only if the user is
congured to allow password
digest for authentication.
For more information about
conguring a user for digest
authentication, see "Adding
User Accounts" on page 92.

Request Client
Certificates

Integration Server requests

client certicates for all
requests. If the client does not
provide a certicate, the server
prompts the client for a userid
and password. If the client
provides a certicate:
Integration Server checks
whether the certicate exactly
matches a client certicate
that is on le and signed by
a trusted authority. If so, the

webMethods Integration Server Administrators Guide Version 9.10

203

Even Header
Configuring Ports

For this parameter...

Specify...
client is logged in as the user
to which the certicate is
mapped in Integration Server.
If not, the client request
fails, unless central user
management is congured.
If central user management is
congured, Integration Server
checks whether the certicate
is mapped to a user in the
central user database. If so, the
server logs the client on as that
user. If not, the client request
fails.
Require Client
Certificates

Use JSSE

Integration Server requires

client certicates for all
requests. The server behaves
as described for Request Client
Certificates, except that the
client must always provide a
certicate.

If this port should support TLS 1.1 or TLS 1.2, click

Yes to create the port using the Java Secure Socket
Extension (JSSE) socket factory. The default is Yes.
If you set this value to No, the port supports only SSL
3.0 and TLS 1.0.
Note: To control the cipher suites used on
Integration Server ports that use JSSE
and handle inbound requests, set the
wa.net.jsse.server.enabledCipherSuiteList. For
more information, see "Server Conguration
Parameters" on page 851.

8. Under Listener Specific Credentials, enter the following information:

Note:

Use these seings only if you want to use a dierent set of credentials from
the ones specied on the Certicates Screen.

webMethods Integration Server Administrators Guide Version 9.10

204

Odd Header
Configuring Ports

For this parameter...

Specify...

Keystore Alias

Optional. A user-specied, text identier for an

Integration Server keystore.
The alias points to a repository of private keys and
their associated certicates. Although each listener
points to one keystore, there can be multiple keys and
their certicates in the same keystore, and more than
one listener can use the same keystore alias.
For more information, see "Securing Communications
with the Server" on page 401.

Key Alias

Optional. The alias for the private key, which must be

stored in the keystore specied by the above keystore
alias.

Truststore Alias

Optional. The alias for the truststore. The truststore

must contain the trusted root certicate for the CA
that signed Integration Server certicate associated
with the key alias. The truststore also contains the
list of CA certicates that Integration Server uses to
validate the trust relationship.

9. Click Save Changes.

10. On the Ports screen, click Edit to change the Access Mode if necessary. You may Set
Access Mode to Allow by Default or Reset to default access settings.
For more information about seing access mode for a port and controlling IP access
for a port, see "Controlling Access to Resources by Port" on page 422
11. On the Portsscreen, also check the list of ports to ensure that the status in the Enabled
column is Yes. If it is not, click No to enable the port.

Suspending an HTTP/HTTPS Port

By default, Integration Server accepts port connection requests as soon as it receives
them. The suspend port seing allows you to stop the port from accepting connections
or dispatching more requests.
Note:

If a request is made on the suspended listening port, and the backlog queue
is disabled, the listener will not accept any more connections or dispatch any
more requests. However, if the backlog queue is enabled and is not full, the
connection is queued. If you delete or disable a suspended port, the queued
connections are released.

webMethods Integration Server Administrators Guide Version 9.10

205

Even Header
Configuring Ports

Complete the following steps to suspend an HTTP or HTTPS port.

To suspend an HTTP or HTTPS port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. In the Port List table, click Edit in the Advanced column for the port you want to
suspend.
4. Under Listener Controls, select the Suspend check box.
5. Click Apply to save your changes.
6. Click Return to Ports to return to the Security > Ports screen.

Resuming an HTTP/HTTPS Port

You can resume a port that has been suspended.
To resume an HTTP or HTTPS port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. In the Port List table, click Edit in the Advanced column for the port you want to
resume.
4. Under Listener Controls, select the Resume check box.
5. Click Apply to save your changes.
6. Click Return to Ports to return to the Security > Ports screen.

Testing for HTTPS Requests

To test whether your server is listening to HTTPS requests on the port you specied,
bring up your browser and type in https://localhost:port.
If the port is working properly, you will see the logon screen for Integration Server
Administrator.
If Integration Server Administrator does not display, check to see if a service running
on the machine is listening to the same port.

webMethods Integration Server Administrators Guide Version 9.10

206

Odd Header
Configuring Ports

Using an FTP/FTPS Port Range

Integration Server provides FTP and FTPS listeners that listen for FTP/FTPS client data
connections on any free port. For FTPS, this port usage method requires all ports to be
open on the rewall, a situation that rewall administrators prefer to avoid.
You can specify a range of port numbers for the FTP/FTPS listener to use with a client
data connection that uses passive transfer mode (PASV). Integration Server provides
the following conguration parameters that you can use to specify the lower and upper
bounds of the port range:
wa.net.ftpPassivePort.min
wa.net.ftpPassivePort.max

Specifying an FTP/FTPS Port Range

Keep the following operational considerations in mind when seing a port range for FTP
and FTPS ports:
If the wa.net.ftpPassivePort.min and wa.net.ftpPassivePort.max parameters are
not present or undened, FTP/FTPS listeners continue the previous behavior of
listening on any free port.
If the value specied for wa.net.ftpPassivePort.min is less than 1, a default value of
1 is used. If the value specied for wa.net.ftpPassivePort.max is greater than 65534,
a default value of 65534 is used. When both of these conditions exist simultaneously,
FTP/FTPS listeners continue the previous behavior of listening on any free port.
An error message is returned to the FTP/FTPS client on the command channel when
the specied values do not fall within the expected range. For example, if one of the
properties is not dened, if the wa.net.ftpPassivePort.min value is larger than the
wa.net.ftpPassivePort.max value, or if one of the properties is not a valid number.
An error message is also returned when all the ports in the specied port range are
in use.
Specic details of the error messages are available in the serverYYYYMMDD.log le.
You can modify the port range properties in Integration Server Administrator at any
time.
Complete the following steps to specify a port range for FTP and FTPS port listeners.
To specify a port range for FTP and FTPS listeners
1. Start Integration Server and log on to Integration Server Administrator.
2. In Integration Server Administrator, select Extended in the Settings area of the
Navigation panel.

webMethods Integration Server Administrators Guide Version 9.10

207

Even Header
Configuring Ports

3. If the wa.net.ftpPassivePort.min and wa.net.ftpPassivePort.max parameters do not

appear the Extended Settings list, do the following:
a. Select Show and Hide Keys.
b. Select the check boxes next to wa.net.ftpPassivePort.min and
wa.net.ftpPassivePort.max.
c. Click Save Changes.
4. On the Settings > Extended page, click Edit Extended Settings.
5. Do the following:
For this extended setting...

Enter this value...

wa.net.ftpPassivePort.min

Minimum_Port_Number

wa.net.ftpPassivePort.max

Maximum_Port_Number

6. Values for Minimum_Port_Number and Maximum_Port_Number are port numbers

from 1 to 65534. When a port range is specied with these properties, only the ports
within the specied minimum and maximum port range (inclusive) are used as the
listening ports for incoming FTP/FTPS client data connections. You must specify both a
minimum and maximum seing.
7. Click Save Changes.

About the Primary Port

The primary port is an HTTP or HTTPS port that you designate as the main listening
port for Integration Server. The server does not reserve the primary port for any special
purpose. However, Integration Server will never allow the primary port to be deleted,
which guarantees that at least one port is always available.
If a primary port is not specied, Integration Server creates one at start up. By default,
Integration Server designates an HTTP port at 5555 as the primary port. If you created
multiple Integration Servers on the same machine, you specied a unique primary port
number for each server instance during the instance creation process.
The primary port number is also the port number that clients receive when they query
your server property wa.server.port .
Note:

If you change Integration Servers primary port number after conguring

the Broker, the Broker client for your Integration Server may become
unsynchronized with your Integration Servers conguration. After changing
the primary port, you need to synchronize your Broker clients to the
Integration Servers new port conguration. For more information, see

webMethods Integration Server Administrators Guide Version 9.10

208

Odd Header
Configuring Ports

"Synchronizing Broker Clients When the Primary Port for Integration Server
Changes" on page 258.

Changing the Primary Port

Keep the following points in mind when designating a port as the primary port:
The port must be an HTTP or HTTPS port.
The port must be associated with the WmRoot package.
The port must be enabled.
The port must be a standard port. That is, the primary port cannot be a diagnostic
port.
To change the primary port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Click Change Primary Port.
4. In the Select New Primary Port area of the screen, in the Primary Port list, select the port
you want to make the primary port.
Integration Server Administrator lists only those ports that meet the criteria for being
a primary port (enabled standard HTTP or HTTPS ports that are associated with the
WmRoot package).
5. Click Update.

Deleting a Port
If you no longer need a port, you can delete it.
Important: You cannot delete the primary port dened for the Integration Server.
To delete a port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Locate the port in the Port List, and click the
icon in the Delete column. The server
displays a dialog box that prompts you to conrm your action. Click OK to conrm
that you want to delete the port.

webMethods Integration Server Administrators Guide Version 9.10

209

Even Header
Configuring Ports

Editing a Port
After adding a port, you can edit the port conguration. The port must be disabled
before you can edit the conguration.
Note:

You cannot edit the port alias after a port has been created.

To edit a port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Locate the port you want to edit and click on the port number.
4. Click Edit <port type > Port Configuration.
5. Update the information for the port.
6. Click Save Changes.

About Enabling/Disabling a Port

If you want to temporarily prevent the server from accepting requests on one of its
ports, you can disable that port. This action blocks incoming requests from reaching
the server. When a port is disabled, clients receive an error message when they issue
requests to it. Later, you can enable the port. If you shut down and restart the server, the
port remains disabled until an administrator enables it. Disabling a port is a convenient
way to eliminate developer access to an Integration Server once it goes into production.
Another way to enable or disable a port is to enable or disable the package associated
with the port. You can associate a package with a specic port so that when you replicate
the package, it continues to use a port with the same number on the new server. When
a package is associated with a port, enabling the package enables the port and disabling
the package disables the port.
Important: You must leave at least the primary port enabled.

Disabling a Port
Complete the following steps to disable a port.
To disable a port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.

webMethods Integration Server Administrators Guide Version 9.10

210

Odd Header
Configuring Ports

3. Locate the port in the Port List, and click the

icon in the Enabled column to disable
the port. The server displays a dialog box that prompts you to verify your action.
Click OK to verify you want to disable the port.
The server replaces the

icon with No to indicate that the port is now disabled.

Enabling a Port
Complete the following steps to enable a port.
To enable a port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Locate the port in the Port List, and click No in the Enabled column to enable the port.
The server displays a dialog box that prompts you to verify your action. Click OK to
verify you want to enable the port.
The server replaces the No with the

icon to indicate that the port is now enabled.

Configuring How Ports Handle Client Certificates

This section describes how to use Integration Server Administrator to view or change
how a port handles client certicates. For more information about client certicates, see
"Authenticating Clients" on page 447.
To view or change how a port handles client certificates
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel of the screen, on the Security menu, click Ports.
3. Locate the port whose client certicate seings you want to view, change, or disable
(if it is not already disabled).
Note:

To disable a port, click the

icon in the Enabled column. The server
replaces the
icon with No to indicate that the port is now disabled.

4. Click the port number.

5. Click Edit HTTPS Port Configuration or Edit FTPS Port Configuration to update the
information in the elds, as necessary. For eld descriptions, see "Adding an HTTPS
Port" on page 168 or "Adding an FTPS Port" on page 183, respectively.
6. Click Save Changes.
7. Enable the port by clicking No in the Enabled column.

webMethods Integration Server Administrators Guide Version 9.10

211

Even Header
Configuring Ports

Adding a Security Provider

If you want to add an HTTPS or FTPS port with a listener that will use a private key and
certicate chain residing in a keystore and the keystore is managed by a non standard
Security Provider, you may need to add that Security Provider to Integration Server
Administrator.
When specifying keystore information in the HTTPS or FTPS port information screen, a
non standard Security Provider may not appear in the KeyStore Type parameter dropdown list. If the Security Provider that you want to use not appear in the list, use the
"Add New Security Provider" link to add the Security Provider.
To add a security provider
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Keystore.
3. Click Add Security Provider.
4. In the Add Security Provider area of the screen, in the Security Provider Class eld,
enter the Java class name of the security provider to be used for additional keystore
and truststore le types. For example, the name of nCipher's security provider is
com.ncipher.provider.km.nCipherKM.
Note:

Ensure that the corresponding jar le is in the classpath.

If the keystore type supported by the HSM is not one of the defaults supported by
Integration Server, modify the property wa.security.keyStore.supportedTypes or
wa.security.trustStore.supportedTypes respectively to add a new keystore type for
the keystore or truststore.
5. Click Add Provider.
Integration Server adds the security provider to the list of available security
providers. If the keystore type supported by the newly added security provider is
one of the default keystore types (JKS, PKCS12) supported by Integration Server and
you select that keystore type in the Keystore Type list for an HTTPS or FTPS port,
the corresponding provider will be available in the Provider list for that keystore
type.
If the keystore type is not supported, modify the properties
wa.security.keyStore.supportedTypes and wa.security.trustStore.supportedTypes
to add a new keystore type for the keystore and truststore.

webMethods Integration Server Administrators Guide Version 9.10

212

Odd Header
Configuring Ports

Configuring the Allowed Protocols for JSSE per Port

This section describes how to congure the allowed protocols for JSSE on a
per port basis. For more information about allowed protocols for JSSE, see
wa.net.jsse.server.enabledProtocols.
To configure the allowed protocols for JSSE per port
1. Shut down Integration Server.
2. Open the following le in text editor:
Integration Server_directory/instances/instanceName /packages/packageName /
listeners.cnf
where instanceName is the name of the Integration Server instance and packageName
is the name of the package associated with the port.
3. In the listeners.cnf le, locate the record for the HTTPS port for which you want to
specify the allowed protocols.
For example, if you want to make changes to port 5333, the port record will start
with the following:
<record name="HTTPSListener@5333" javaclass="com.wm.util.Values">)

4. After the <value name="useJSSE">true</value> entry in the port record, add the
following entry:
<value name="jsseEnabledProtocols">SSLprotocols</value>

where SSLprotocols is a comma-separated list of the SSL protocol versions that the
port supports.
For example, to enable TLS 1.1 and TLS 1.2 versions for the port add the following:
<value name="jsseEnabledProtocols">SSLv2Hello,TLSv1.1,TLSv1.2</value>

5. Save your changes and close the text editor.

6. Restart Integration Server.
Note:

The jsseEnabledProtocols value specied for the port

record in the listeners.cnf le overrides the value set by
wa.net.jsse.server.enabledProtocols server conguration parameter.

When the logging facility 0006 Server SSL Interface is set to the Debug logging level,
Integration Server writes messages about protocols used for inbound and outbound
ports to the server log. At the Trace logging level, Integration Server writes messages
about the enabled cipher suites. You can use these server log messages to conrm the
enabled protocols for any JSSE port.

webMethods Integration Server Administrators Guide Version 9.10

213

Even Header

webMethods Integration Server Administrators Guide Version 9.10

214

Odd Header
Setting Up the Server Log

10 Setting Up the Server Log

Overview of the Server Log .......................................................................................................

216

Specifying Amount and Type of Information to Include in the Server Log .................................

217

Specifying Whether to Queue Server Log Entries .....................................................................

219

Changing the Default Server Log Location ................................................................................

220

Configuring the Server Log to Rotate Based on Size ...............................................................

221

Sending Messages About Critical Issues to E-mail Addresses .................................................

222

Performing Additional Processing on Log Entries .....................................................................

223

Viewing the Server Log ..............................................................................................................

223

Changing the Log Displays ........................................................................................................

225

Overriding Logging Level and Server Log Location for a Session ............................................
Globalization ...............................................................................................................................

webMethods Integration Server Administrators Guide Version 9.10

227
229

215

Even Header
Setting Up the Server Log

Overview of the Server Log

The Integration Server server log contains information about operations and errors that
occur on Integration Server, such as the starting of Integration Server subsystems and
the loading of packages belonging to Integration Server or other webMethods products.
Entries are wrien to the server log by Integration Server's major subsystems, called
facilities. For example, the Integration Server package facility writes server log entries
when it loads and unloads packages, the Integration Server ow manager facility writes
server log entries when it processes a ow service, and Integration Server's HTTP ports
write server log entries when they receive requests. Entries are also wrien to the server
log by facilities for individual products that are installed on Integration Server, such as
Trading Networks Server or adapters. Below is an excerpt from a sample server log.
2009-04-22 17:20:45 EDT [ISS.0028.0012I] WmRoot: Startup service
(wm.server.soap:init)
2009-04-22 17:20:46 EDT [ISS.0028.0012I] WmRoot: Startup service
(wm.server.dbalias:initRepoAlias)
2009-04-22 17:20:46 EDT [ISS.0028.0012I] WmRoot: Startup service
(wm.server.tspace:init)
2009-04-22 17:20:46 EDT [ISS.0028.0012I] WmRoot: Startup service
(wm.server.ws:init)
2009-04-22 17:20:46 EDT [ISS.0028.0012I] WmPublic: Startup service
(pub.ldap:init)
2009-04-22 17:20:46 EDT [ISS.0028.0012I] WmPublic: Startup service
(pub.storage:startup)
2009-04-22 17:20:46 EDT [WmSharedCacheSC.config.0595I] Reading cache
configuration: distributedCache
2009-04-22 17:20:50 EDT [ISS.0028.0012I] WmVCS: Startup service
(wm.server.vcsadmin:startup)
2009-04-22 17:20:50 EDT [VCS.0132.0050I] VCS package initializing
2009-04-22 17:20:50 EDT [ISS.0028.0012I] WmVCS: Startup service
(wm.server.vcsui:addSolutions)
2009-04-22 17:20:50 EDT [ISS.0028.0012I] WmART: Startup service
(wm.art.admin:startup)
2009-04-22 17:20:50 EDT [ISS.0028.0012I] WmXSLT: Startup service
(wm.xslt.Admin:startup)
2009-04-22 17:20:50 EDT [ISS.0028.0012I] WmAssetPublisher: Startup service
(wm.server.metadata.admin:startup)
2009-04-22 17:20:50 EDT [ISS.0138.0052I] Asset Publisher package initializing
2009-04-22 17:20:50 EDT [ISS.0028.0012I] WmISExtDC: Startup service
(com.wm.isextdc.PkgInit:init)
2009-04-22 17:20:50 EDT [ISS.0028.0012I] WmARTExtDC: Startup service
(com.wm.artextdc.pkginit:init)
2009-04-22 17:20:50 EDT [ISP.0046.0012I] Enabling HTTP Listener on port 9999
2009-04-22 17:20:50 EDT [ISP.0046.0012I] Enabling HTTP Listener on port 5555
2009-04-22 17:20:50 EDT [ISP.0046.0012I] Enabling HTTP Listener on port 6666
2009-04-22 17:20:50 EDT [ISS.0098.0021I] Persistent Trigger Output Dispatcher
started
2009-04-22 17:20:50 EDT [ISS.0098.0021I] Volatile Trigger Output Dispatcher
started
2009-04-22 17:20:50 EDT [ISS.0098.0027I] PersistenceManager started all Stores
2009-04-22 17:20:50 EDT [ISS.0025.0036I] Dispatcher started
2009-04-22 17:20:50 EDT [ISS.0025.0005I] Port Manager started
2009-04-22 17:20:50 EDT [ISS.0025.0013I] Cache Sweeper started
2009-04-22 17:20:50 EDT [ISS.0014.0002C] Initialization completed in 21 seconds.
2009-04-22 17:20:51 EDT [ISS.0025.0016I] Config File Directory Saved

webMethods Integration Server Administrators Guide Version 9.10

216

Odd Header
Setting Up the Server Log

For a list of available facilities in Integration Server, see "Server Log Facilities" on page
999.
By default, all facilities write to the server log, and the facilities write log entries about
critical, error, warning, informational, and debug-related situations. You can have only
selected facilities write to the log, and you can increase or decrease the amount of data
the facilities provide. This exibility is useful for troubleshooting. For example, you
might temporarily increase the level of detail wrien to the server log to help uncover
the cause of an Integration Server error or performance problem, and return to a lower
level once the problem is resolved. You can also override the amount of information to
include in the server log for a particular Integration Server session.
By default, Integration Server queues log entries wrien by its facilities in memory, then
uses a background thread to write them to the server log. You can change that property
so that facilities write directly to the server log. Using a background thread improves
Integration Server performance, but writing directly causes the entries to appear in the
server log more quickly.
Integration Server always writes server log entries to at les; you cannot store the
server log in a database. By default, Integration Server writes server log entries for the
current day (dened as midnight to midnight) to the server.log le. However, you can
congure Integration Server to rotate the srever.log le by size instead of by day. For
more information, see "Conguring the Server Log to Rotate Based on Size" on page
221.
When rotating the server log le, either by day or by size, Integration Server renames the
current server.log le to have the archive le name and starts a new server.log le. The
archive le names include the date (yyyymmdd ) on which the log entries were originally
wrien.
By default, all log and archive les are stored in the
Integration Server_directory\instances\instance_name\ logs directory. For information
about changing the location of the server.log le, see "Changing the Default Server Log
Location" on page 220
You can override the location of the server log les for a particular session.. For more
information about overriding the location of the server log le or the logging levels for a
session, see "Overriding Logging Level and Server Log Location for a Session" on page
227.

Specifying Amount and Type of Information to Include in the

Server Log
You can specify logging levels for individual products and specic facilities within a
product. Because facilities inherit logging levels from the parent product and, in turn,
products inherit logging levels from the Default node, you can set the logging level
of the Default node to be the default logging level that you want to use for most of

webMethods Integration Server Administrators Guide Version 9.10

217

Even Header
Setting Up the Server Log

the products and facilities. Then, you can change the logging levels for the particular
products or facilities for which you want to generate more or less server log information.
By default, all products inherit the logging level of the Default node. Inherited values
are shown in gray text. When you explicitly change the logging level for a product or
facility, that level overrides the Default node level. Integration Server Administrator
displays explicitly set logging levels in bold text.
To specify the amount and type of information to include in the server log
1. In Integration Server Administrator, go to the Settings > Logging page.
2. In the Logger List, click Server Logger.
3. Click Edit Server Logger.
The Server Logger Configuration area lists Integration Server and products that are
installed on Integration Server, and the facilities for each of these. To see the facilities
and their current logging levels, expand the display by clicking .
4. Do one or more of the following:
To change the level for...

Take this action...

The Default node

Click the level to use in the Logging Level list for the
Default node. Integration Server Administrator resets all
products and facilities that inherit from the Default node
to the new level.

A particular
product

Click the level to use in the Logging Level list for the
product node. Integration Server Administrator resets all
facilities that inherit their values from the product to the
new level.
If you change a level for a particular product and later
want the product to inherit the logging level from the
default node again, reset the product logging level to be
the logging level of the default node.

A particular facility

Click the level to use in the Logging Level list for the
facility.
If you change a level for a facility and later want the
facility to inherit the logging level from the product
again, reset the facility logging level to be the logging
level of the product.

For more information about logging levels, see "Logging Levels" on page 219.
Important: Recording more information consumes more system resources.

webMethods Integration Server Administrators Guide Version 9.10

218

Odd Header
Setting Up the Server Log

5. Click Save Changes.

Logging Levels
The logging levels that you can specify are described below. Each logging level includes
the indicated type of message plus all messages from the levels above it (for example,
the Warn level includes Fatal, Error, and Warn messages).
Level

Integration Server records these entries...

Examples

Fatal

Failures that end operations in such

a way that the operations cannot
successfully continue without user
intervention. Failure is very likely to
aect other operations or products.

Product cannot read its

conguration le and has
no default seings

Error

Same as Fatal, except that existing

error handling renders the failure
unlikely to aect other operations or
products.

Business process step

failed due to a service
error caused by bad input
data

Warn

Problems that do not end operations,

or unexpected or unusual conditions
that might signal impending failure.

Multiple registered JMX

servers were discovered
when only one is needed

Info

Success of an event that you need to

know about.

Package loaded, or
connection pool initialized

Debug

Code-level statements recording

unusual conditions or decisions that
might lead to errors.

Expected an object to be
initialized but it is not, or
hash table is empty

Trace

Code-level statements recording

program ow and state during normal
execution.

Method entry/exit, or local

and global object state

Off

No information for the product or

facility is wrien to the server log.

Specifying Whether to Queue Server Log Entries

By default, Integration Server queues log entries wrien by its facilities in memory, then
uses a background thread to write them to the server log. Because only one facility can

webMethods Integration Server Administrators Guide Version 9.10

219

Even Header
Setting Up the Server Log

write to the server log at one time, queuing the entries improves performance by making
writing asynchronous. However, if Integration Server shuts down abnormally, all log
entries in the queue will be lost. For beer quality of service, do not queue the entries.
However, each facility will have to wait as long as necessary to write its entry to the
server log, so Integration Server performance might be aected.
To specify whether to queue server log entries
1. In Integration Server Administrator, go to the Settings > Extended page and click Show
and Hide Keys. Integration Server Administrator displays a list of the Integration
Server conguration properties you can change using this method.
2. Select the check box next to the watt.server.log.queued property.
3. Click Save Changes. Integration Server Administrator displays the property in the
Extended Settings box.
4. Click Edit Extended Settings.
5. In the Extended Settings box, set the property to true if you want to queue server log
entries or to false if you do not want to queue server log entries.
6. Click Save Changes.
7. Restart Integration Server.
Note:

To change the number of entries allowed in the server log queue, use the
wa.server.serverlogQueueSize parameter. The default size is 8192 bytes.

Changing the Default Server Log Location

You can change the default server log location. For example, if you want to save room on
the Integration Server host machine, you might change the log le storage location to a
directory on a dierent machine.
To store the server log files in a different directory
1. In Integration Server Administrator, go to the Settings > Extended page and click Show
and Hide Keys. Integration Server Administrator displays a list of the Integration
Server conguration properties you can change using this method.
2. Select the check box next to the watt.debug.logfile property.
3. Click Save Changes. Integration Server Administrator displays the property in the
Extended Settings box.
4. Click Edit Extended Settings. In the Extended Settings box, set the property as follows:
watt.debug.logfile=path to server log file directory

5. Click Save Changes, then restart Integration Server.

webMethods Integration Server Administrators Guide Version 9.10

220

Odd Header
Setting Up the Server Log

Configuring the Server Log to Rotate Based on Size

By default, the Integration Server server.log rotates daily at midnight. If services log
large payloads, the server.log can increase rapidly in size. In addition to consuming
resources, a large server.log le can be dicult to examine. To avoid this, you can
congure Integration Server to rotate the server.log le by size in addition to rotating by
day.
To configure the server log to rotate based on size
1. In Integration Server Administrator, go to the Settings > Extended page and click Show
and Hide Keys. Integration Server Administrator displays a list of the Integration
Server conguration properties you can change using this method.
2. Select the check box next to the watt.server.serverlogRotateSize property.
3. Click Save Changes. Integration Server Administrator displays the property in the
Extended Settings box.
4. Click Edit Extended Settings.
5. In the Extended Settings box, set the property to N[KB|MB|GB], where N is any valid
integer greater than or equal to 33. The minimum size at which Integration Server
rotates the server.log le is 33KB. Do not include any spaces between the integer and
the unit of measure.
6. Click Save Changes.
7. Restart Integration Server.
When wa.server.serverlogRotateSize is set to a valid value, Integration Server
rotates the server.log when the server.log le size reaches that size or at midnight,
whichever occurs rst. For example, if wa.server.serverlogRotateSize is set to
100KB and at midnight the server.log le size is 80KB, Integration Server still rotates
the server.log le at midnight.
When Integration Server rotates the server.log le, Integration Server
renames the current log to use the archive le name and starts a new
server.log le. If rotating based on size, the archive le name uses the format
server.log_yyyyMMdd_HHmmssSSSZ , where yyyyMMdd_HHmmssSSSZ is the date
and time the log le was created.
Note:

There is no default value for this parameter. If no value is specied for

wa.server.serverlogRotateSize, Integration Server rotates the server.log
le at midnight only. If an invalid value is specied, Integration Server
resets the parameter to -1. Note that a value of -1 results in the same
behavior as specifying no value for the parameter.

webMethods Integration Server Administrators Guide Version 9.10

221

Even Header
Setting Up the Server Log

Sending Messages About Critical Issues to E-mail Addresses

By default, Integration Server does not send notications of any log entries to an e-mail
address. You can congure Integration Server to automatically send notications to a
specied e-mail address each time a critical issue occurs.
To send messages about critical issues to e-mail addresses
1. In Integration Server Administrator, go to the Settings > Resources page and click Edit
Resource Settings.
2. In the SMTP Server eld, type the server name or IP address of the SMTP server to use
to send the messages.
3. In the Port eld, enter the port that Integration Server is to connect to on the specied
SMTP server.
4. From the Transport Layer Security list, select the type of SSL encryption that Integration
Server uses when communicating with the SMTP server port dened above.
Select...

To...

None

Default. Use a non-secure mode when communicating with

an SMTP server.

Explicit

Integration Server uses explicit security when

communicating with an SMTP server.

Implicit

Integration Server uses implicit security when

communicating with an SMTP server.

5. From the Truststore Alias list, select the alias for the truststore that contains the list
of certicates that Integration Server uses to validate the trust relationship between
Integration Server and the SMTP server. If you do not select a truststore alias, the
default truststore alias specied in the wa.security.trustStoreAlias property will be
used. For more information about this property, see "wa.security." on page 874.
For more information about truststore alias, see "Creating Keystore Aliases" on page
410.
6. In the Internal Email eld, type the e-mail address to which to send messages
about critical log entries. Typically, you would specify the e-mail address for the
Integration Server Administrator.
7. In the Service Email eld, type the e-mail address to which to send messages about
service failures. In a development environment, you might direct these messages to
the developer. In a production environment, you might direct these messages to the
Integration Server Administrator.

webMethods Integration Server Administrators Guide Version 9.10

222

Odd Header
Setting Up the Server Log

8. By default, Integration Server uses character set UTF-8 for the messages. If you want
to use a dierent character set, identify the character set in the Default E-mail Charset
eld.
9. Click Save Changes.
Integration Server connects to the specied SMTP server on:
Port 25 if Integration Server uses explicit or no Transport Layer Security.
Port 465 if Integration Server uses implicit Transport Layer Security.
The default is 25.
When sending a message, by default, Integration Server provides its own address
(the From Address) as Integration-Server@localhost , where localhost is the Integration
Server host machine. If you want to change this property, follow these steps:
a. In Integration Server Administrator, go to the Settings > Extended page.
Integration Server Administrator displays a list of Integration Server
conguration properties you can change using this method.
b. Click Edit Extended Settings. In the Extended Settings box, set the set the property as
follows:
wa.server.email.from=new From Address to use
c. Click Save Changes.
d. Restart Integration Server.

Performing Additional Processing on Log Entries

If you want to perform additional processing on log entries, you can create an event
handler. For example, you could create an event handler that sends service log entries
to another log, such as the Windows Event Log. For information, see the webMethods
Integration Server Built-In Services Reference and webMethods Service Development Help.

Viewing the Server Log

In Integration Server Administrator, go to the Logs > Server page to view the server log.
By default, Integration Server uses this format for server log entries:
time_stamp time-zone [product_code.logging_facility.message_number.log_level ] message_text
To see a list of logging facilities, go to the Settings > Logging page in Integration Server
Administrator. Integration Server gets the time zone value from your JVM.
Note:

In the default message format, the log level is displayed as one character and
will be one of the following: C (Fatal), E (Error), W (Warn), I (Info), D (Debug),
T (Trace). Your logging level seing determines the types of messages you see

webMethods Integration Server Administrators Guide Version 9.10

223

Even Header
Setting Up the Server Log

in the server log). See "Specifying Amount and Type of Information to Include
in the Server Log" on page 217 for more information about logging levels.
The following table shows some product codes:
Code

Meaning

ISU, ISS, ISC,

ISP, JBS, BAS,
BAT, BAA, BAJ,
BAL, BAP, BAR,
BAU, BAC, BAB,
BAF, BAQ

Internal Integration Server facilities/components

ART

Adapter runtime facilities

MNP

Mainframe package

MOD

webMethods Monitor (Facility 119)

MON

webMethods Monitor (Facility 120 Monitor DB)

SAP

SAP Adapter

TNS, TNC

Trading Networks

Using an Alternative Server Log Entry Format

Integration Server oers an alternative server log format that you can switch to:
(logger) [product_code.logging_facility.message_number ] time_stamp time_zone log_level
message_text
In this format:
The log level is spelled out and displayed after the time zone. It will be one of the
following: Fatal, Error, Warn, Info, Debug, Trace.
The logger eld is the name of the logger used by the Java-based log4j logging utility.
To change the format of server log entries
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Extended.
3. From the Settings > Extended page, click Show and Hide Keys.

webMethods Integration Server Administrators Guide Version 9.10

224

Odd Header
Setting Up the Server Log

Integration Server Administrator displays a list of the Integration Server

conguration properties you can change using this method.
4. Select the check box next to the watt.debug.layout property.
5. Click Save Changes.
displays the property in the Extended Settings box.
6. Click Edit Extended Settings.
7. In the Extended Settings box, set the property to legacy if you want to use the default
format or to new if you want to use the alternative format.
8. Click Save Changes.
9. Restart Integration Server.
10. Your logging level seing (see "Specifying Amount and Type of Information to
Include in the Server Log" on page 217 determines the types of messages you see
in the server log).

Changing the Log Displays

You can change the display of server log pages in Integration Server Administrator. You
can:
Specify the date and time format to use in log entries.
Display logged data in dierent languages.
Change various aspects of the display permanently.
Change various aspects of the server log's display temporarily.

Specifying the Date and Time Format to Use in Log Entries

By default, log entries in all logs shown in Integration Server Administrator use the
format yyyy -mm -dd hh :mm :ss . You can change this format to any other format that is
supported by the Java class java.text.SimpleDateFormat.
To specify the date and time format to use in log entries
1. In Integration Server Administrator, go to the Settings > Logging page.
2. In the Logger List, click Server Logger.
3. Click Edit Server Logger.
4. In the Format box, type the date and time format to use. You can specify any format
that is supported by the Java class java.text.SimpleDateFormat (for example, yyyy-MMdd HH:mm:ss z).
5. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

225

Even Header
Setting Up the Server Log

Note:

You can also change the date and time format for log entries using the
wa.server.dateStampFmt server conguration parameter. For more
information about this parameter, see "Server Conguration Parameters" on
page 851.

Displaying Logged Data in Different Languages

This section applies only to logged data that is stored in les.
If you want to view logged data in a language other than English, you might have
to adjust your text editor or command shell. Integration Server writes the les in the
Unicode UTF-8 encoding. These les do not contain a Byte Order Mark (BOM, Unicode
character U+FEFF). If the les contain non-ASCII data, such as log entries wrien in nonU.S. English, you might have to adjust the character encoding used by your text editor or
command shell so you can view the log entries.
On a UNIX system, you can adjust the character encoding by changing your locale
seing (LC_ALL) to the appropriate UTF-8 encoded locales. For example, to view
Japanese characters in a text editor or command shell on a Solaris system, you might
change your locale seing to ja_JP.UTF-8.
On a Windows system, because the les do not contain the BOM character, text editors
such as Notepad might not detect the UTF-8 encoding correctly. Adjust the encoding
manually so you can view the les. To view the logs in the cmd shell, you can use the
command chcp 65001.
Note:

Changing character encoding will also aect the audit logs, described in the
webMethods Audit Logging Guide.

Changing the Display Permanently for All Logs

By default, the number of log entries shown for all logs in Integration Server
Administrator is 35, and the refresh interval is 90 seconds. You can change these
defaults.
Keep the following points in mind when changing the display for the logs:
Increasing the number of entries displayed signicantly can slow system
performance.
Decreasing the refresh interval signicantly can slow system performance.
If you increase the number of displayed entries to a value greater than the threshold
established by the wa.server.log.alertMaxEntries conguration parameter,
Integration Server Administrator displays a warning.
Changing the log displays will also aect the audit logs, described in the webMethods
Audit Logging Guide.

webMethods Integration Server Administrators Guide Version 9.10

226

Odd Header
Setting Up the Server Log

To change the display for all logs

1. Open Integration Server Administrator.
2. Navigate to the Settings > Extended page and click Show and Hide Keys.
Integration Server Administrator displays a list of the Integration Server
conguration properties you can change using this method.
3. Select the check box next to the properties you want to change:
If you want to change...

Select this property...

The default for the Number of entries to

display eld

wa.server.log.maxEntries

The refresh interval for log entries

wa.server.log.refreshInterval

4. Click Save Changes. Integration Server Administrator displays the property in the
Extended Settings box.
5. Click Edit Extended Settings. In the Extended Settings box, set each property to a
positive integer.
6. Click Save Changes. Changes take eect immediately.
If the value that you set for Number of entries to display is more than the value
specied for wa.server.log.alertMaxEntries, every time the log entries are refreshed,
Integration Server Administrator displays a message informing that the number of
requested entries exceeds the threshold and that displaying more entries might aect
Integration Server performance. The message prompts you to conrm displaying the
requested number of entries.

Changing the Display Temporarily for the Server Log

To change the display for the server log temporarily, use the Log display controls area
at the top of the log display page and then click Refresh. The changes remain until you
change them again, or until you shut down Integration Server, whichever comes rst.

Overriding Logging Level and Server Log Location for a

Session
You can override the logging level property seing, server log location, or both for a
particular Integration Server session by starting Integration Server from the command
line with certain options.

webMethods Integration Server Administrators Guide Version 9.10

227

Even Header
Setting Up the Server Log

To override log level and server log location for a session

1. In a text editor, open the custom_wrapper.conf le from the following directory:
Software AG_directory\proles\IS_instance_name \conguration
where instance_name is the name of the Integration Server instance.
2. Add the following properties to custom_wrapper.conf:
wrapper.app.parameter.n =-debug
wrapper.app.parameter.n =level
wrapper.app.parameter.n =-log
wrapper.app.parameter.n =destination

Where:
This value...

Is...

A sequential number starting from the last

wrapper.app.parameter property in custom_wrapper.conf.
For example, if the last wrapper.app.parameter property
is wrapper.app.parameter.6, the next one would be
wrapper.app.parameter.7.

level

Amount of information to record for all products and facilities

listed on the Settings > Logging > View Server Logger Details page
for this session. For possible values, see "Specifying Amount
and Type of Information to Include in the Server Log" on page
217.
For this session only, this option overrides the values specied
on the Settings > Logging > View Server Logger Details page and on
the wa.debug.level property.

destination

Is either of the following:

Option

Description

lename

Fully qualied or relative path to the

le in which to write the server log
for this session.
For this session only, this option
overrides the value specied on the
wa.debug.logle property.

none

Displays the server log on your

console. Integration Server records a

webMethods Integration Server Administrators Guide Version 9.10

228

Odd Header
Setting Up the Server Log

This value...

Is...
timestamp with no other information
in the server log le for this session.
For this session only, this option
overrides the value specied on the
wa.debug.logle property.

3. In the custom_wrapper.conf, update the wrapper.app.parameter.2 property to

reect the total number of wrapper.app.parameter properties that you added in
the previous steps.
For example, if wrapper.app.parameter.2 is set to 4 (the default) and
you add four wrapper.app.parameter properties, you would increase the
value of wrapper.app.parameter.2 by four. After making your edits, the
wrapper.app.parameter.2 would appear as follows:
wrapper.app.parameter.2=8

For more information about the wrapper.app.parameter property, see Software AG

Infrastructure Administrator's Guide.
4. At a command prompt, type the following command:
cdSoftware AG_directory\profiles\IS_instance_name \bin

Note:

The startup.bat/sh and shutdown.bat/sh scripts contained in the

Integration Server_directory\instances\instance_name\bin directory are
deprecated. Software AG recommends the use of the scripts contained
in the Software AG_directory\proles\IS_instance_name\bin directory.
If you will manage Integration Server through Command Central,
you must use the scripts located in the Software AG_directory\proles
\IS_instance_name\bin directory.

5. Start Integration Server by entering this command:

For Windows: startup.bat
For UNIX: startup.sh

Globalization
If a webMethods product is equipped with webMethods language packs and some of
those language packs correspond to the language used by the operating environment
in which the product is running, the product writes its log entries in the language used
by the operating system. If the product is equipped with no language packs or with
language packs that do not correspond to the language used by the operating system, the
product writes its log entries in U.S. English.

webMethods Integration Server Administrators Guide Version 9.10

229

Even Header
Setting Up the Server Log

Suppose your operating environment uses Japanese as its language. You have installed
language packs including the Japanese Language Packs on Integration Server, so
Integration Server stores its own log entries in Japanese. You have not installed the
Japanese Language packs on Trading Networks, so Integration Server stores Trading
Networks' log entries in U.S. English.
Note:

Even if no language packs are installed on the webMethods product and

the product is using U.S. English, Integration Server might store log entries
from external sources, such as database drivers or adapter resources, in the
language used by the operating environment in which the product is running.

webMethods Integration Server Administrators Guide Version 9.10

230

Odd Header
Configuring Integration Server for webMethods Messaging

11 Configuring Integration Server for webMethods

Messaging

Overview .....................................................................................................................................

232

Working with Messaging Connection Aliases ............................................................................

232

Authenticating Connections to the Universal Messaging Server ...............................................

249

Configuring Integration Server to Connect to an SSL-Enabled Port on Universal Messaging ... 252
Specifying the Keep-Alive Mode for the Broker Connection ......................................................

255

Synchronizing Broker Clients When the Primary Port for Integration Server Changes .............. 258
Configuring Document Stores ....................................................................................................
Load Balancing with a Non-Clustered Group of Integration Servers .........................................

webMethods Integration Server Administrators Guide Version 9.10

258
267

231

Even Header
Configuring Integration Server for webMethods Messaging

Overview
webMethods messaging is an umbrella term that encompasses the sending and receiving
of documents (also called messages) across the webMethods platform. Within the
context of Integration Server, webMethods messaging includes the publishing of
documents in the native IData format from one Integration Server or an application
running on Integration Server to a webMethods messaging provider. The webMethods
messaging provider, either webMethods Universal Messaging or webMethods Broker,
routes the documents to subscribers on other Integration Servers that retrieve and
process the document.
To use Integration Server to create a publish-and-subscribe solution for webMethods
messaging, you need the following components:
Publishable document types that dene the content, structure, and properties of the
documents that can be published.
Services that publish instances of the publishable document types.
webMethods messaging triggers that subscribe to publishable document types and
specify services that processes instances of the publishable document types.
A webMethods messaging provider that handles the receipt of and routing of
documents to subscribers.
To congure Integration Server for webMethods messaging, you need to:
Create one or more aliases that congure a connection to the webMethods messaging
provider. For more information, see "Working with Messaging Connection Aliases"
on page 232.
Congure document stores for holding documents immediately before publication
or right after retrieval. For more information, see "Conguring Document Stores" on
page 258.
Create publishable document types, webMethods messaging triggers, and services
using the Service Development perspective in Software AG Designer. For more
information, see webMethods Service Development Help.

Working with Messaging Connection Aliases

A messaging connection alias denes the conguration needed to establish a connection
between Integration Server and a webMethods messaging provider. You can use
Universal Messaging and/or Broker as a webMethods messaging provider. For each
messaging provider that you want to use, you need to create a messaging connection
alias.

webMethods Integration Server Administrators Guide Version 9.10

232

Odd Header
Configuring Integration Server for webMethods Messaging

Although an Integration Server can only have one messaging connection alias that
connects to a Broker, you can have multiple messaging connection aliases that connect to
Universal Messaging servers.
You assign a messaging connection alias to publishable document types. Publishing
services use the assigned messaging connection alias to publish instances of that
document type to the messaging provider. webMethods messaging triggers use the
messaging connection alias to retrieve published documents from the messaging
provider.

Predefined Messaging Connection Aliases

Integration Server includes predened messaging connection aliases that Integration
Server creates the rst time it starts up.
The following table identies the predened messaging connection aliases that might be
available for Integration Server.
Messaging Connection Alias

Description

IS_BROKER_CONNECTION

A messaging connection alias that contains the

conguration information needed to establish a
connection to Broker.
Integration Server creates this alias only if Broker
is installed in the same installation directory as
Integration Server.
Note: If you migrated to Integration Server 9.5 SP1
or later from an earlier version of Integration
Server, and the earlier Integration Server
congured a connection to Broker, the existing
Broker conguration information is used for
the IS_BROKER_CONNECTION alias. As part
of migration, Integration Server enables the
IS_BROKER_CONNECTION alias and sets it
as the default messaging connection alias.

IS_LOCAL_CONNECTION

A messaging connection alias to use with

document types that will be published locally
only. In local publishing, a document is published
and received within Integration Server. In
local publishing, the document remains within
Integration Server. There is no involvement with a
webMethods messaging provider.

webMethods Integration Server Administrators Guide Version 9.10

233

Even Header
Configuring Integration Server for webMethods Messaging

Messaging Connection Alias

Description

IS_UM_CONNECTION

A messaging connection alias that contains the

conguration information needed to establish a
connection to a Universal Messaging server.

Creating a Broker Connection Alias

A Broker connection alias is a webMethods messaging connection alias that contains the
conguration information for establishing a connection to the Broker. Each Integration
Server can have only one Broker connection alias.
If Broker is installed in the same installation directory as Integration Server, Integration
Server creates a Broker connection alias named IS_BROKER_CONNECTION. Or, if you
migrated to Integration Server 9.5 SP1 or later from an earlier version of Integration
Server, and the earlier Integration Server congured a connection to Broker, the existing
Broker conguration information is used for the IS_BROKER_CONNECTION alias. If
this alias exists, you must delete it before you create another Broker connection alias.
Alternatively, you can edit IS_BROKER_CONNECTION to contain the conguration
information that you want.
To create a Broker connection alias
1. Open the Integration Server Administrator.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under webMethods Messaging Configuration, click webMethods Messaging Settings.
4. Click CreateBrokerconnection alias.
If a Broker connection alias already exists, Integration Server Administrator displays
a message stating that only one Broker connection alias can exist at a time.
5. Under General Settings, specify the following:
For this parameter...

Specify...

Connection Alias
Name

A unique name for the messaging connection alias.

Description

A description of the messaging connection alias.

Client Prefix

A string that identies the Integration Server to Broker.

The Broker Manager displays this prex for each client it
creates for the server. (The Broker creates multiple clients for
each server that connects to it.)

webMethods Integration Server Administrators Guide Version 9.10

234

Odd Header
Configuring Integration Server for webMethods Messaging

For this parameter...

Specify...

Share Client
Prefix

Whether Integration Server shares the client prex with

multiple Integration Servers. Leave the check box cleared if
you do not want the client prex to be shared.
You must select Share Client Prefix if the Integration Server:
Belongs to a cluster.
Belongs to a non-clustered group of Integration Servers that
operate in a load-balanced fashion.
For more information about conguring Integration Servers
to receive messages from the Broker in a load-balanced
fashion, see "Load Balancing with a Non-Clustered Group of
Integration Servers" on page 267.

6. Under Connection Settings, specify the following:

For this parameter...

Specify...

Broker Host

Name (DNSname : port or ipaddress : port ) of the machine on

which the Broker Server resides.

Broker Name

Name of the Broker as dened on the Broker Server. The

default name is Broker #1.

Client Group

Broker client group to which this Integration Server

belongs. A client group denes a single set of properties and
access permissions assigned to one or more clients (here,
Integration Servers) on a single Broker. If the specied client
group does not exist, the Integration Server creates it on the
named Broker upon establishing its initial connection.
Brokers do not share can-publish and can-subscribe
Important:
permissions across client groups. If you switch
an Integration Server from one client group to
another, you must restart the Integration Server and
synchronize all publishable document types with the
Broker. Next, you must shut down the server and use
My webMethods to delete all of the Broker clients
created for the server with the changed client group.
Restart the server with the changed client group.

7. Under Client Authentication Settings, specify the following:

webMethods Integration Server Administrators Guide Version 9.10

235

Even Header
Configuring Integration Server for webMethods Messaging

For this
parameter...

Specify...

Client
Authentication

The type of authentication an Integration Server client will

use to connect to the Broker. Choose one of the following
options:
None. Select this option if the Broker is congured to accept
anonymous connections.
Username/Password. Select this option if the Broker uses
basic client authentication. If you select this option, specify
the user name and password the client will use in the
Username and Password elds.
SSL. Select this option if Integration Server connects to
the Broker using the SSL port. If you select this option,
congure the SSL parameters by providing the following
information.
Parameter...

Specify...

Keystore

The full path to the keystore le for

this Integration Server. A keystore le
contains the credentials (private key/
signed certicate) that an entity needs
for SSL authentication. If the Broker
Server requires an SSL connection,
then the information in this le is
used to authenticate the Integration
Server client to that Broker Server.
The keystore le for an Integration
Server is stored on the machine on
which the Integration Server resides.

Keystore Type

The le type of the keystore le for

Integration Server. The le type can
be either PKCS12 or JKS.

Keystore Password

Password required to access the SSL

certicate in the keystore le for
Integration Server.

8. Under Encryption Settings, specify the following:

webMethods Integration Server Administrators Guide Version 9.10

236

Odd Header
Configuring Integration Server for webMethods Messaging

For this parameter...

Specify...

Encryption

Specify whether or not to encrypt the connection between the

Integration Server and the Broker.
Note: When you set Client Authentication to SSL, Encryption
must be set to Yes.
If you select Yes for the Encryption parameter, congure the
following truststore parameters.
Parameter...

Specify...

Truststore

The full path to the truststore le for the

Integration Server client. A truststore le
contains trusted root certicates for the
authorities responsible for signing SSL
certicates. For an SSL connection to be
made, a valid trusted root for the SSL
certicate stored in the keystore must be
accessible in a truststore le.
The truststore le for Integration Server
is stored on the machine on which the
Integration Server resides.

Truststore Type

The le type of the truststore le for

Integration Server. The le type is JKS.

9. Click Save Changes.

Integration Server creates the Broker connection alias.
10. Click Return to webMethods Messaging Settings.
11. Enable the Broker connection alias.
12. Restart Integration Server.
For more information about Broker and conguring SSL for Broker, see
Administering webMethods Broker.
Note:

You can congure the outbound document store, also known as the client
side queue, to contain documents published when the Broker used by this
connection alias is not available. For more information, see "About the
Outbound Document Store" on page 263

webMethods Integration Server Administrators Guide Version 9.10

237

Even Header
Configuring Integration Server for webMethods Messaging

Creating a Universal Messaging Connection Alias

A Universal Messaging connection alias is a webMethods messaging connection alias
that contains the conguration information for establishing a connection to a Universal
Messaging server. Each Integration Server can have multiple Universal Messaging
connection aliases.
Note:

You can create a Universal Messaging connection alias for use with
webMethods Universal Messaging 9.5 and higher. However, if you want
to use Integration Server with an earlier, supported version of Universal
Messaging, you must manually replace les in Software AG_directory\common
\lib with the those available in the version of Universal Messaging that
you want to use. For more information about replacing client libraries, see
"Adding Client Libraries for Earlier Versions of Universal Messaging " on
page 309.

To create a Universal Messaging connection alias

1. Open the Integration Server Administrator.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under webMethods Messaging Configuration, click webMethods Messaging Settings.
4. Click CreateUniversal Messagingconnection alias.
5. Under General Settings, specify the following:
For this parameter...

Specify...

Connection Alias
Name

A unique name for the messaging connection alias.

Description

A description of the messaging connection alias.

Client Prefix

A string that identies the Integration Server to Universal

Messaging.
If your Integration Server belongs to a cluster, make sure all
servers in the cluster use the same client prex.

Share Client
Prefix

Whether Integration Server shares the client prex with

multiple Integration Servers. Leave the check box cleared if
you do not want the client prex to be shared.
You must select Share Client Prefix if the Integration Server:
Belongs to a cluster.

webMethods Integration Server Administrators Guide Version 9.10

238

Odd Header
Configuring Integration Server for webMethods Messaging

For this parameter...

Specify...
Belongs to a non-clustered group of Integration Servers that
operate in a load-balanced fashion.
For more information about conguring Integration Servers
to receive messages from Universal Messaging in a loadbalanced fashion, see "Load Balancing with a Non-Clustered
Group of Integration Servers" on page 267.

6. Under Connection Settings, specify the following:

For this parameter...

Specify...

Realm URL

The URL for the Universal Messaging server in the format

protocol :// UM_host : UM_port where protocol is the protocol
for the port., such as nsp, nsps, or nhps. For example,
nsp://127.0.0.1:9000 or nsps://localhost:9000).
If the protocol for connecting to Universal Messaging
server is nsps or nhps, you must congure the connection
alias to enable Integration Server to connect to an SSLenabled port on Universal Messaging. You must set Client
Authentication to SSL and provide truststore and possibly
keystore information.
If you are using a cluster of Universal Messaging servers,
supply the list of URLs to each server in the cluster using a
comma or a semicolon:
Separate the URLs using a comma if Integration Server
always aempts to connect to the rst Universal Messaging
server in the list, only trying the second Universal
Messaging server in the list if the rst server becomes
unavailable.
Separate the URLs using a semicolon if Integration Server
connects to a randomly chosen URL from the list. This may
result in beer distribution of clients across the servers in
the cluster.
Note: You must specify a URL for everyUniversal Messaging
server in the cluster. Integration Server connects only
to the Universal Messaging servers for which you
specify a URL. Consequently, Integration Server creates
resources such as channels and named objects only
on the specied Universal Messaging servers. If you
specify only one Universal Messaging server in a
cluster, the resources will local to that server only.

webMethods Integration Server Administrators Guide Version 9.10

239

Even Header
Configuring Integration Server for webMethods Messaging

For this parameter...

Specify...

Maximum
Reconnection
Attempts

Specify the maximum number of reconnection aempts

that Integration Server makes if the connection to Universal
Messaging fails. If the connection cannot be re-established,
Integration Server writes messages to the error log and the
connection created by this messaging connection alias will
be stopped. The default is 5 aempts.
Note: The Maximum Reconnection Attempts value is a factor
only when an existing connection fails. The Maximum
Reconnection Attempts value is not a factor that
Integration Server considers when starting a messaging
connection alias.

7. Under Producer Settings, specify the following:

For this parameter...

Specify...

Enable CSQ

Whether a client side queue is used with this

Universal Messaging connection alias. Do one
of the following:
Select the Enable CSQ check box if you
want to use a client side queue with this
Universal Messaging connection alias.
When a client side queue is in use, if
the Universal Messaging server is not
available when Integration Server publishes
documents using this Universal Messaging
connection alias Integration Server writes
the documents to the client side queue.
Clear the Enable CSQ check box if you do
not want to use a client side queue with
this Universal Messaging connection alias.
When a client side queue is not in use,
if the Universal Messaging server is not
available when Integration Server publishes
documents using this Universal Messaging
connection alias, the publishing service ends
with an ISRuntimeException.

Maximum CSQ Size (messages)

The maximum number of documents

(messages) that can exist in the client
side queue for this Universal Messaging
connection alias. If the client side queue
is at capacity, publishing services that

webMethods Integration Server Administrators Guide Version 9.10

240

Odd Header
Configuring Integration Server for webMethods Messaging

For this parameter...

Specify...
use this connection alias will end with an
ISRuntimeException.
Specify -1 if you want the client side queue
to be able to contain an unlimited number of
messages.

Drain CSQ in Order

Whether Integration Server drains the client

side queue for this alias by sending the
messages to the Universal Messaging server
in the same order in which Integration Server
placed the messages in the client side queue.
Select the check box if you want Integration
Server to send messages from the client side
queue in the same order in which Integration
Server originally placed the messages in the
client side queue.
When the Drain CSQ in Order check box is
selected, after the connection to the Universal
Messaging server s re-established, Integration
Server continues to write new messages to
the client side queue until the client side
queue is completely drained. If the Drain CSQ
in Order check box is not selected, after the
connection to the Universal Messaging server
re-established, Integration Server sends new
messages directly to the Universal Messaging
server while it drains the client side queue.

Publish Wait Time While

Reconnecting

The number of milliseconds that a publishing

service using this Universal Messaging
connection alias will wait for a connection
to the Universal Messaging server to be
re-established after the connection fails.
If Integration Server re-establishes the
connection before the Publish Wait Time
While Reconnecting elapses, the publishing
service continues executing. If the specied
time elapses before a connection is reestablished, the publishing service ends with
an ISRuntimeException. The default is 0
milliseconds, which means that publishing
services will not wait for Integration Server to
re-establish the connection.

webMethods Integration Server Administrators Guide Version 9.10

241

Even Header
Configuring Integration Server for webMethods Messaging

For this parameter...

Specify...
Note:When a Universal Messaging connection
alias is congured to connect to a
Universal Messaging cluster, make sure
the Publish Wait Time While Reconnecting
value is long enough to accommodate
the time the Universal Messaging cluster
takes to establish a quorum after one of
the member servers fails.

8. Under Client Authentication Settings, specify the following:

For this
parameter...

Specify...

Client
Authentication

The type of authentication an Integration Server client will

use to connect to the Universal Messaging server. Choose
one of the following options:
None. Select this option if no authentication should be
performed. This is the default.
Username/Password. Select this option if the Universal
Messaging server performs basic client authentication
using user name/password combinations. If you select
this option, specify the user name and password the
client will use in the Username and Password elds.
SSL. Select this option if Integration Server connects to a
secure socket layer (SSL) port on Universal Messaging. If
the Realm URL species nsps or nhps as the protocol, you
must select SSL.

Truststore Alias

The alias for the truststore that contains the certicate

authority (CA) certicates for the Universal Messaging
server. You must select a truststore alias if the Universal
Messaging port is congured for either one-way
authentication or two-way authentication.

Keystore Alias

The alias for the keystore that contains the client

certicates that you want Integration Server to use when
connecting to the Universal Messaging port. You must
select a keystore alias if the Universal Messaging port is
congured for two-way authentication.
Note: A Universal Messaging port is congured for twoway authentication if the port species nsps or nhps

webMethods Integration Server Administrators Guide Version 9.10

242

Odd Header
Configuring Integration Server for webMethods Messaging

For this
parameter...

Specify...
and the Enable Client Cert Validation option is selected
for the port. Use Universal Messaging Enterprise
Manager to view the Enable Client Cert Validation option
specied for a port.

Key Alias

The alias to the key that contains the private key for
connecting to the Universal Messaging port securely. The
key alias must be in the keystore specied in Keystore Alias.
You must specify a Key Alias if you specify a Keystore Alias.

Note:

For more information about conguring a Universal Messaging to

connect to an SSL-enabled port on Universal Messaging see "Conguring
Integration Server to Connect to an SSL-Enabled Port on Universal
Messaging " on page 252.

9. Under Consumer Settings, do one of the following for the Enable Request/Reply Channel
and Listener check box.
If you intend to use this Universal Messaging connection alias to send request
documents, send reply documents, or receive reply documents as part of a
request/reply or publish-and-wait scenario, select the Enable Request/Reply Channel
and Listener check box. When this check box is selected, Integration Server will do
the following when the Universal Messaging connection alias starts:
Create a request/reply channel for this Universal Messaging connection
alias if one does not yet exist. The request/reply channel name includes
a string identifying the Integration Server, the client prex, and the text
RequestReply.
Start a listener on Integration Server that subscribes to the alias-specic
request/reply channel.
If you do not intend to use this Universal Messaging connection alias as part of a
request/reply or publish-and-wait scenario, to conserve resources on Integration
Server and Universal Messaging, clear the Enable Request/Reply Channel and
Listener check box.
10. Click Save Changes.
11. Enable the Universal Messaging connection alias.

Editing a Messaging Connection Alias

You can edit the properties of any messaging connection alias that you create or some
of the default messaging connection aliases created by Integration Server. Keep the
following points in mind before editing a messaging connection alias:

webMethods Integration Server Administrators Guide Version 9.10

243

Even Header
Configuring Integration Server for webMethods Messaging

You can edit any properties of an existing messaging connection alias with the
exception of the connection alias name.
You must disable a messaging connection alias before you can edit it.
You cannot edit the IS_LOCAL_CONNECTION alias.
To edit a messaging connection alias
1. Open the Integration Server Administrator.
2. In the Settings menu of the Navigation panel, click Messaging
3. Under webMethods Messaging Configuration, click webMethods Messaging Settings.
4. In the webMethods Connection Alias Definitions table, click the name of the messaging
connection alias that you want to edit.
5. Do one of the following depending on whether you are editing a Broker connection
alias or a Universal Messaging connection alias:
Click EditBrokerMessaging Connection Alias.
Click EditUniversal MessagingConnection Alias.
6. Update the information for the messaging connection alias.
7. Click Save Changes.
8. Enable the messaging connection alias. For more information about enabling a
messaging connection alias, see "Enabling a Messaging Connection Alias" on page
245.
9. If this is a Broker connection alias, you must restart Integration Server for your
changes to take eect.
Notes:
If you changed a Broker connection alias to connect to Broker in another territory,
you might need to synchronize your publishable document types with the new
Broker. For information about synchronizing publishable document types, see
webMethods Service Development Help.
If you change the client prex of a Universal Messaging connection alias for
which the Enable Request/Reply Channel and Listener check box is selected, Universal
Messaging creates a new request/reply channel with the new client prex. However,
Universal Messaging does not delete the previous request/reply channel for the
Universal Messaging connection alias. Use Universal Messaging Enterprise Manager
to delete the old channel.
If you edit a Universal Messaging connection alias by clearing the Enable Request/
Reply Channel and Listener check box is selected, the request/reply channel for
Universal Messaging connection alias remains on the Universal Messaging server.
If you want to delete the channel, use Universal Messaging Enterprise Manager to
delete the channel.

webMethods Integration Server Administrators Guide Version 9.10

244

Odd Header
Configuring Integration Server for webMethods Messaging

Enabling a Messaging Connection Alias

When a messaging connection alias is enabled, Integration Server can use it to send and
receive messages from the messaging provider on behalf of publishing services and
webMethods messaging triggers, respectively. Keep the following information about
messaging connection aliases in mind:
When you enable a Universal Messaging connection alias, the change takes eect
immediately. Publishing services and triggers begin using the alias to send and
receive messages from the messaging provider.
When you enable a Broker connection alias, you must restart Integration Server
before the change takes eect. Publishing services and webMethods messaging
triggers do not begin using the alias to send and receive documents until after
Integration Server restarts.
The IS_LOCAL_CONNECTION messaging connection alias cannot be enabled or
disabled. The alias is always available to Integration Server for local publishing.
To enable a messaging connection alias
1. Open the Integration Server Administrator.
2. In the Settings menu of the Navigation panel, click Messaging
3. Under webMethods Messaging Configuration, click webMethods Messaging Settings.
4. In the webMethods Connection Alias Definitions list, locate the messaging connection
alias that you want to enable.
5. Click No in the Enabled column to enable the messaging connection alias.
For a Universal Messaging connection alias, Integration Server Administrator
replaces No with
Yes.
For a Broker connection alias, Integration Server Administrator replaces No with
Yes [Pending Restart].
6. If this is a Broker connection alias, restart Integration Server for your changes to take
eect.

About Disabling a Message Connection Alias

You can disable any messaging connection alias on Integration Server. A disabled
messaging connection alias cannot be used to send messages to or receive messages from
the messaging provider specied in the alias. Specically, when a messaging connection
alias is disabled:
Publishing services that use the disabled alias end with an ISRuntimeException.
webMethods messaging triggers that use the alias are suspended.

webMethods Integration Server Administrators Guide Version 9.10

245

Even Header
Configuring Integration Server for webMethods Messaging

When you disable a Universal Messaging connection alias, you do not need to restart
Integration Server for the change to take eect.
Publishing services that use the alias receive an ISRuntimeException as soon as the
messaging connection alias is disabled.
Before suspending webMethods messaging triggers that use the alias Integration
Server waits a short time for triggers to nish processing messages the triggers
already received. Integration Server considers message processing to be complete
if the trigger service executes to completion (success or failure) and the trigger
acknowledges the message to the message provider. If the trigger service is long
running and cannot complete in the alloed time, Integration Server disables the
trigger and considers message processing to be incomplete.
Note:

Suspending a trigger does not stop the trigger service. Consequently, even
after Integration Server suspends the webMethods messaging trigger,
the trigger service will execute to completion. After the trigger service
completes, Integration Server aempts to acknowledge the message to
the messaging provider. However, the acknowledgment aempt fails
because the messaging connection alias is disabled. If the message is
guaranteed, the messaging provider redelivers the message when the
messaging connection alias is enabled and the trigger resumes. Redelivery
of messages can result in duplicate processing.

When you disable a Broker connection alias, you must restart Integration Server for the
change to the alias to take eect. The Broker connection alias is not actually disabled
until Integration Server restarts. This means that publishing services and webMethods
messaging triggers that use the alias continue to send and receive messages until restart
occurs. Upon restart, Integration Server suspends any webMethods messaging trigger
that use the messaging connection alias. Additionally, after restart, any publishing
services that use the messaging connection alias will end with an ISRuntimeException.
Note:

The IS_LOCAL_CONNECTION messaging connection alias cannot be

enabled or disabled. The alias is always available to Integration Server for
local publishing.

Disabling a Messaging Connection Alias

You might disable a Universal Messaging connection alias to:
Edit the messaging connection alias.
Prevent services from publishing messages to a messaging provider.
Stop receiving messages from a particular messaging provider.
Stop all webMethods messaging triggers that use a particular messaging provider.
Because a Universal Messaging connection alias does not require an Integration Server
restart for the change to take eect, disabling the alias is a quick way to stop the sending,
retrieval, and processing of messages from the Universal Messaging server in the alias.

webMethods Integration Server Administrators Guide Version 9.10

246

Odd Header
Configuring Integration Server for webMethods Messaging

To disable a messaging connection alias

1. Open the Integration Server Administrator.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under webMethods Messaging Configuration, click webMethods Messaging Settings.
4. In the webMethods Connection Alias Definitions list, locate the messaging connection
alias that you want to disable.
5. Click the

icon in the Enabled column to disable the messaging connection alias.

For a Universal Messaging connection alias, Integration Server Administrator

replaces
with No.
For a Broker connection alias, Integration Server Administrator replaces
No[Pending Restart].

Yes with

6. If this is a Broker connection alias, restart Integration Server for your changes to take
eect.

Messaging Connection Alias Status

A messaging connection alias can have one of the following statuses in the Enabled
column.
Status in Enabled Column

No

Description

Yes

The messaging connection alias is enabled.

Integration Server is connected to the messaging
provider and can use the alias to send and receive
messages.

Yes [Pending Restart]

The messaging connection alias is currently

disabled but will be enabled after Integration
Server restarts. Integration Server is not connected
to the messaging provider. Integration Server
cannot use the alias to send and receive messages.

Yes [Not Connected]

The messaging connection alias is enabled,

but Integration Server is not connected to the
messaging provider. Integration Server cannot use
the alias to send and receive messages.
The messaging connection alias is not enabled.
Integration Server cannot use the alias to send and
receive messages.

webMethods Integration Server Administrators Guide Version 9.10

247

Even Header
Configuring Integration Server for webMethods Messaging

Status in Enabled Column

No [Pending Restart]

Note:

Description
The messaging connection alias is currently
enabled but will be disabled after Integration
Server restarts. Currently, Integration Server
is connected to Broker; services can publish
messages to the Broker and triggers can retrieve
messages from Broker.

Integration Server Administrator does not display a status for the predened
IS_LOCAL_CONNECTION messaging connection alias. The alias cannot be
enabled or disabled and is always available to Integration Server for local
publishing.

Specifying the Default Messaging Connection Alias

The default messaging connection alias determines the messaging provider to which
messages are sent when the Connection alias name property for the publishable document
type is set to DEFAULT or is blank.
Services that publish instances of the publishable document type use the default
messaging connection alias to connect to the messaging provider and publish the
document.
webMethods messaging triggers that subscribe to that publishable document type
use the default messing connection alias to connect to the provider and retrieve the
messages.
That is, when the publishable document type has a Connection alias name property set
to DEFAULT or is blank, the default messaging connection alias determines which
messaging provider receives and routes published instances of the document.
The rst time Integration Server starts, Integration Server sets a default messaging
connection alias based on whether Integration Server was migrated from a previous
version and on what other products are installed in the same location.
To change the default messaging connection alias
1. Open the Integration Server Administrator.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under webMethods Messaging Configuration, click webMethods Messaging Settings.
4. Click Change Default Connection Alias.
5. Under Select New Default Connection Alias, in the Connection Alias Name list, select the
name of the messaging connection alias that you want to use as the new default
messaging connection alias.
6. Click Update.

webMethods Integration Server Administrators Guide Version 9.10

248

Odd Header
Configuring Integration Server for webMethods Messaging

Notes
After you change the default connection alias, Integration Server reloads all of the
webMethods messaging triggers that subscribe to publishable document types that
use the default messaging connection alias.
After you change the default connection alias, you need to synchronize publishable
document types that use the default alias with the messaging provider. This
ensures that the provider denitions on the new default messaging provider are
synchronized with publishable document types that use the default messaging
connection alias.

Deleting a Messaging Connection Alias

Before you delete a messaging connection alias, keep the following in mind:
The messaging connection alias must be disabled before it can be deleted. For
more information about disabling a messaging connection alias, see "Disabling a
Messaging Connection Alias" on page 246.
The messaging connection alias must not be assigned to a publishable document
type when you delete it. Integration Server does not prevent you from deleting a
messaging connection alias used by a publishable document type.
The predened messaging connection alias IS_LOCAL_CONNECTION cannot be
deleted.
To delete a messaging connection alias
1. Open the Integration Server Administrator.
2. In the Settings menu of the Navigation panel, click Messaging
3. Under webMethods Messaging Configuration, click webMethods Messaging Settings.
4. In the webMethods Connection Alias Definitions table, disable the messaging connection
alias if it is not yet disabled.
5. In the Delete column, click the
want to delete.

icon for the messaging connection alias that you

6. Click OK to verify that you want to delete the messaging connection alias.

Authenticating Connections to the Universal Messaging

Server
When webMethods Universal Messaging serves as the messaging provider, Integration
Server acts as the client, and the Universal Messaging realm server acts as the server.
Communication between Integration Server and the Universal Messaging server is
secured by way of ACL management on the Universal Messaging server. You can add
an extra layer of security for a connection between Integration Server and Universal
webMethods Integration Server Administrators Guide Version 9.10

249

Even Header
Configuring Integration Server for webMethods Messaging

Messaging, before the Universal Messaging server applies the ACLs, by authenticating
the connection with a user name and password. You specify this authentication method
when you create the Universal Messaging connection alias.
Note:

This feature applies to Integration Server 9.8 or later and Universal Messaging
9.6 or later.

When you congure a Universal Messaging connection alias to authenticate connections

between Integration Server and Universal Messaging in this way, user credentials are
exchanged using either the Simple Authentication and Security Layer (SASL) framework
or the Java Authentication and Authorization Service (JAAS) framework. Universal
Messaging uses the JAAS framework by default.
The Universal Messaging administrator determines which framework to use. Work with
the Universal Messaging administrator to have the following items in place before you
test the connection:
SASL framework: With this framework, the Universal Messaging server veries user
credentials based on a specied Directory instance, and credentials are stored in an
internal directory or in an external directory such as LDAP. Work with the Universal
Messaging administrator to have the following items in place:
Internal user repository. If you want to store user credentials in an internal user
repository, the Universal Messaging administrator should create the repository
using the Software AG Security Infrastructure command line tool. The Universal
Messaging administrator should also set the Nirvana.directory.provider system
property as indicated in the server property conguration table that follows.
External user repository configuration. If you want to store user credentials in an
external repository such as LDAP, the Universal Messaging administrator should
set the Nirvana.directory.provider system property as indicated in the server
property conguration table that follows.
Server property configuration. The Universal Messaging administrator should set
properties in the nserver.conf le, located in Universal Messaging_directory\server
\umserver\bin\ on the Universal Messaging server, as follows:
Set this property...

To...

Nirvana.auth.sagrepo.path

The relative or absolute path of the user

credentials text le that the Security
Infrastructure command line tool created

Nirvana.directory.provider

One of the following:

If user credentials are stored in an internal
user repository, set this property to:
com.pcbsys.foundation.security.auth.
fSAGInternalUserRepositoryAdapter

webMethods Integration Server Administrators Guide Version 9.10

250

Odd Header
Configuring Integration Server for webMethods Messaging

Set this property...

To...
If user credentials are stored in an external
user repository, set this property to:
com.pcbsys.foundation.security.auth.
fLDAPAdapter

Nirvana.auth.enabled

If this parameter is set to N and credentials

are passed with the connection request,
the Universal Messaging server ignores
the credentials and connects without
authentication.
Nirvana.auth.server.mandatory Y
For more information about internal and external user repositories, the Security
Infrastructure command line tool, and the nserver.cnf system properties, see the
Software AG Infrastructure Administrator's Guide and the Universal Messaging
documentation.
JAAS framework: With this framework, the Universal Messaging server invokes a
JAAS login module to verify user credentials. Organizations might choose this
method over SASL when they require custom logic for authenticating users (for
example, when a custom service is needed to extract user credentials from an
external database). Work with the Universal Messaging administrator to have the
following items in place:
Login module. The login module contains the code that retrieves and validates
passwords. If the user name/password combination supplied in the connection
alias diers from what is specied in the login module, Integration Server
displays an error message indicating that the connection failed.
JAAS configuration file. The Universal Messaging administrator should create a
JAAS conguration le, which denes the JAAS key and calls the login module,
on the Universal Messaging server.
Server property configuration. The Universal Messaging administrator should set
properties in the nserver.conf le, located in Universal Messaging_directory\server
\umserver\bin\ on the Universal Messaging server, as follows:
Set this property...

To...

Nirvana.auth.server.jaaskey

noauth

wrapper.java.classpath

The login module location

webMethods Integration Server Administrators Guide Version 9.10

251

Even Header
Configuring Integration Server for webMethods Messaging

For more information about login modules, JAAS conguration les, and the
nserver.cnf system properties, see the Software AG Infrastructure Administrator's
Guide and the Universal Messaging documentation.

Configuring Integration Server to Connect to an SSL-Enabled

Port on Universal Messaging
If Integration Server uses the Universal Messaging connection alias to connect to a
secure socket protocol port on the Universal Messaging server, you must congure the
alias to use SSL. You specify truststore and possibly keystore information in the alias.
This allows communication between Integration Server and Universal Messaging to be
secured through secure socket layers (SSL).
A Universal Messaging port uses SSL if the port species an interface protocol of NSPS
or NHPS. Depending on how the Universal Messaging port is congured, you need to
congure one-way SSL or two-way SSL.
In one-way SSL, the Integration Server acting as the client, connects to a Universal
Messaging port, supplies the CA certicate used by the Universal Messaging port,
but does not supply a client certicate.
Congure one-way SSL if the Universal Messaging port species NSPS or NHPS and
the Enable Client Cert Validation option is not selected for the port.
For more information, see "Conguring a Universal Messaging Connection Alias for
One-Way SSL" on page 253
In two-way SSL, the Integration Server acting as the client, connects to a Universal
Messaging port, provides a client certicate, and supplies the CA certicate used by
the Universal Messaging port.
Congure two-way SSL if the Universal Messaging port species NSPS or NHPS and
the Enable Client Cert Validation option is selected for the port.
For more information, see "Conguring a Universal Messaging Connection Alias for
Two-Way SSL" on page 254.
Note:

Use Universal Messaging Enterprise Manager to view the protocol and Enable
Client Cert Validation option selected for the port.

Note:

When using Integration Server versions 9.8 and 9.9, for Integration Server
to connect to an SSL-enabled port on Universal Messaging, you needed to
set javax.net.ssl* system properties in the JVM used with Integration Server.
As of Integration Server version 9.10, you congure the information needed
to establish an SSL connection in the Universal Messaging connection alias.
Specically, you provide the truststore alias and possibly keystore alias and
key alias in the connection alias. This allows the use of dierent truststores
and keystores for each connection alias.

webMethods Integration Server Administrators Guide Version 9.10

252

Odd Header
Configuring Integration Server for webMethods Messaging

Configuring a Universal Messaging Connection Alias for One-Way

SSL
In one-way SSL between Integration Server and Universal Messaging, to connect to the
Universal Messaging port, Integration Server supplies the CA certicate used by the
Universal Messaging but does not supply a client certicate.
You need to congure a Universal Messaging connection alias for one-way SSL if:
The Universal Messaging connection alias species a Realm URL with a protocol of
nsps or nhps.
The Enable Client Cert Validation option is not selected for the Universal Messaging
port. You can use Universal Messaging Enterprise Manager to view the status of the
Enable Client Cert Validation option.
Use the following procedure to congure a Universal Messaging connection alias for
one-way SSL.
To configure a Universal Messaging connection alias for one-way SSL
1. Create a truststore that contains the certicate authority (CA) of the certicates for
the Universal Messaging server.
2. Create a truststore alias for the truststore created in step 1.
For more information about creating a truststore alias, see "Creating Truststore
Aliases" on page 412.
3. Using Integration Server Administrator, congure the Universal Messaging
connection alias that creates a connection to an SSL port on the Universal Messaging
server to include the following:
For this parameter...

Do the following...

Realm URL

Make sure the Realm URL species a URL with

the correct SSL protocol, either nsps or nhps.

Client Authentication

Select SSL.

Truststore Alias

Select the truststore alias created in step 2.

4. Save the Universal Messaging connection alias.

Note:

To congure a Universal Messaging connection alias for one-way SSL, you

need to supply the name of the truststore alias. However, if you set Client
Authentication to SSL in the Universal Messaging connection alias but do not
supply the truststore alias, Integration Server looks for this information in the
JVM. For information about seing the SSL-related system properties in the

webMethods Integration Server Administrators Guide Version 9.10

253

Even Header
Configuring Integration Server for webMethods Messaging

JVM, see "Storing SSL Information for the Integration Server JVM in a Secure
Manner" on page 415.
Software AG recommends specifying the truststore alias, keystore alias, and
key alias information in the Universal Messaging connection alias instead of
relying on the JVM system properties.

Configuring a Universal Messaging Connection Alias for Two-Way

SSL
In two-way SSL between Integration Server and Universal Messaging, to connect to the
Universal Messaging port, Integration Server supplies the CA certicate used by the
Universal Messaging and a client certicate.
You need to congure a Universal Messaging connection alias for two-way SSL if:
The Universal Messaging connection alias species a Realm URL with a protocol of
nsps or nhps.
The Enable Client Cert Validation option is selected for the Universal Messaging port.
You can use Universal Messaging Enterprise Manager to view the status of the
Enable Client Cert Validation option.
Use the following procedure to congure a Universal Messaging connection alias for
two-way SSL.
To configure a Universal Messaging connection alias for two-way SSL
1. Create a truststore that contains the certicate authority (CA) of the certicates for
the Universal Messaging server.
2. Create a truststore alias for the truststore created in step 1.
For more information about creating a truststore alias, see "Creating Truststore
Aliases" on page 412.
3. Create a keystore that contains the client certicates used by Integration Server to
connect with Universal Messaging.
4. Create a keystore alias for the keystore created in step 3, making sure to specify a
key alias for the key that contains the private key for connecting to the Universal
Messaging port securely.
For more information about creating a keystore alias, see "Creating Keystore Aliases"
on page 410.
5. Verify that truststore used by Universal Messaging contains the certicate authority
of the certicates used byIntegration Server.
6. Using Integration Server Administrator, congure the Universal Messaging
connection alias that creates a connection to an SSL port on the Universal Messaging
server to include the following:

webMethods Integration Server Administrators Guide Version 9.10

254

Odd Header
Configuring Integration Server for webMethods Messaging

For this parameter...

Do the following...

Realm URL

Make sure the Realm URL species a URL with

the correct SSL protocol, either nsps or nhps.

Client Authentication

Select SSL.

Truststore Alias

Select the truststore alias created in step 2.

Keystore Alias

Select the keystore alias created in step 4.

Key Alias

Select the key alias created in step 4.

7. Save the Universal Messaging connection alias.

Note:

To congure a Universal Messaging connection alias for two-way SSL, you

need to supply a truststore alias, keystore alias, and key alias. However, if you
set Client Authentication to SSL in the Universal Messaging connection alias but
do not supply the truststore alias, keystore alias, and/or key alias needed to
establish an SSL connection with the Universal Messaging server, Integration
Server looks for this information in the JVM. For information about seing the
SSL-related system properties in the JVM, see "Storing SSL Information for the
Integration Server JVM in a Secure Manner" on page 415.
Software AG recommends specifying the truststore alias, keystore alias, and
key alias information in the Universal Messaging connection alias instead of
relying on the JVM system properties.

Specifying the Keep-Alive Mode for the Broker Connection

After conguring the connection to the Broker, you can specify the keep-alive mode that
you want Integration Server to use.
The keep-alive mode indicates whether the Broker checks for dropped connections from
a client and then explicitly disconnects the client if it has dropped the connection. By
disconnecting the client, the Broker makes any unacknowledged documents retrieved by
that client available for redelivery to other clients.
Note:

You can specify a keep-alive mode only if Integration Server connects to a

webMethods Broker version 6.1 or later.

If client state is not shared, an undetected broken connection does not pose a problem.
The Broker will automatically redeliver unacknowledged events to the client when it
reconnects. However, if the client state is shared and a client loses its connection to the
Broker, the client cannot retrieve the unacknowledged documents after it re-establishes

webMethods Integration Server Administrators Guide Version 9.10

255

Even Header
Configuring Integration Server for webMethods Messaging

the connection. (The default client for the Integration Server and all trigger clients are
shared-state clients.) This is because the same client ID is used by all the clients in a
shared-state client. The Broker cannot distinguish the reconnection of one client from the
ordinary reconnections of other clients with the same client ID. The unacknowledged
documents retrieved by the now disconnected client will not be made available for
redelivery until the Broker receives an explicit disconnect notice (generally, when the
TCP/IP connection nally times out). In some cases, this might be hours later.
To avoid a situation in which unacknowledged documents stay on the Broker for an
unacceptable period of time, you can select a keep-alive mode that will disconnect
unresponsive clients and make unacknowledged documents available for redelivery.
Note:

For more information about the Broker keep-alive feature and about sharedstate clients, see the webMethods Broker Java Client API Reference.

You can congure one of the following keep-alive modes:

Normal. The Broker sends a keep-alive message to the Integration Server at a specied
time interval (keep-alive period) and expects a response within another specied
time interval (max response time). If the Broker does not receive a response, it will
retry up to the number of times specied by the retry count. If the Integration Server
still does not respond to the keep-alive message, the Broker explicitly disconnects the
Integration Server. Normal is the default mode.
For example, by default, the Broker sends the Integration Server a keep-alive
message every 60 seconds. If the Integration Server does not respond within
60 seconds, the Broker sends up to three more keep-alive messages before
disconnecting the Integration Server. (The default retry count is 3.)
Listen Only. The Broker disconnects the Integration Server if there is no activity from
the Integration Server over a specied time interval (keep-alive period). In listen only
mode, the Broker does not send keep-alive messages to the Integration Server and
ignores the retry count.
For example, suppose that the Broker expects activity from the Integration Server
every 60 seconds. If there is no activity from the Broker after 60 seconds, the Broker
disconnects the Integration Server.
Disabled.The Broker disables keep-alive interaction with this Integration Server. The
Broker does not send keep-alive messages and does not disconnect the Integration
Server because of inactivity.
Note:

The Broker does not communicate directly with Integration Server.

The Broker Client API facilitates communication between Broker and
Integration Server.

Setting Server Configuration Parameters for Keep-Alive Mode

The keep-alive mode is determined by the combination of values for the following set of
server conguration parameters:

webMethods Integration Server Administrators Guide Version 9.10

256

Odd Header
Configuring Integration Server for webMethods Messaging

watt.server.brokerTransport.dur. Species the number of seconds of idle time that the

Broker waits before sending a keep-alive message to Integration Server. This is the
keep-alive period. The default is 60 seconds.
watt.server.brokerTransport.max. Species the number of seconds that the Broker
waits for the Integration Server to respond to a keep-alive message. This is the max
response time. The default is 60 seconds.
watt.server.brokerTransport.ret.Species the number of times the Broker re-sends keepalive messages before disconnecting an un-responsive Integration Server. This is the
retry count. The default is 3.
For information about seing a keep-alive mode using these parameters, see the sections
that follow. For more information about these parameters, see "Server Conguration
Parameters" on page 851.

Normal Mode
Use the seings in the following table to congure normal keep-alive mode. This is the
default mode.
Set this parameter...

To...

watt.server.brokerTransport.dur

Any integer greater than 0 but less than

2147483647. The default is 60.

watt.server.brokerTransport.max

Any integer greater than 0 but less than or equal to

2147483647. The default is 60.

watt.server.brokerTransport.ret

Any integer between 1 and 2147483647. The

default is 3.

Listen Only Mode

Use the seings in the following table to congure listen only keep-alive mode.
Set this parameter...

To...

watt.server.brokerTransport.dur

2147483647

watt.server.brokerTransport.max

Any integer greater than zero but less than

2147483647

watt.server.brokerTransport.ret

N/A. The retry count is ignored in listen only

mode.

webMethods Integration Server Administrators Guide Version 9.10

257

Even Header
Configuring Integration Server for webMethods Messaging

Disabled
Use the seings in the following table to disable keep-alive mode.
Set this parameter...

To...

watt.server.brokerTransport.dur

2147483647

watt.server.brokerTransport.max

2147483647

watt.server.brokerTransport.ret

Synchronizing Broker Clients When the Primary Port for

Integration Server Changes
It is important to establish the primary port for your Integration Serverbefore connecting
your server to the Broker. However, if you change the Integration Server's primary
port number after conguring a Broker connection alias, the Broker client for your
Integration Server may become unsynchronized with your Broker's conguration.
If you change the Integration Servers primary port after conguring the Broker
connection alias, you need to synchronize your Broker clients to the Integration Server's
new port conguration.
To synchronize Broker clients with the Integration Server's primary port
1. Using the Broker user interface, delete the clients that reect the server's original
primary port number, for example 10.3.33.129_5555_DefaultClient.
2. Delete the dispatch.cnf le from the Integration Server_directory \instances
\\instance_name\ cong directory.
3. Recongure the Broker connection alias, using the procedure described in "Creating
a Broker Connection Alias" on page 234.

Configuring Document Stores

Integration Server uses document stores to save documents to disk or to memory while
the documents are in transit or waiting to be processed. Integration Server maintains
three document stores for published documents.
Default document store. The default document store contains guaranteed documents
delivered to the default Broker client for the Integration Server. When Integration
Server retrieves documents delivered to its default Broker client, Integration Server

webMethods Integration Server Administrators Guide Version 9.10

258

Odd Header
Configuring Integration Server for webMethods Messaging

places the documents in the default document store. Documents remain in the
default document store until the dispatcher determines which triggers subscribe to
the document. The dispatcher then moves the documents to the trigger queues for
the subscribing triggers.
Trigger document store. The trigger document store contains locally published
guaranteed documents that are delivered to a specic webMethods messaging
triggers. For each trigger, Integration Server creates a queue for locally published
guaranteed documents in the trigger document store. A guaranteed document
remains in the trigger queue within the trigger document store until the server
successfully processes the document.
Outbound document store. The outbound document store, sometimes called a clientside queue, contains documents waiting to be sent to the Broker. Integration Server
places documents in the outbound document store when the congured Broker
is not available. When the connection to the Broker is restored, Integration Server
empties the outbound document store by sending the saved documents to the
Broker.
Note:

The outbound document store is used for guaranteed documents

published to the Broker only.

Using Integration Server Administrator, you can congure properties for each document
store.

Configuring the Default Document Store

The default document store contains published documents delivered directly to the
default Broker client for an Integration Server. Documents remain in the default
document store until the dispatcher moves the document to the trigger queues for the
subscribing webMethods messaging triggers.
Note:

You do not need to congure the default document store if you use Universal
Messaging as the messaging provider.

To configure the default document store

1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Resources.
3. Click Store Settings, and then click Edit Document Store Settings.
4. Set the Default Document Store parameters as follows:
For this parameter

Specify...

Store Location

The location of the default document store. By default, the

Integration Server saves document stores in the following
directory:

webMethods Integration Server Administrators Guide Version 9.10

259

Even Header
Configuring Integration Server for webMethods Messaging

For this parameter

Specify...
Integration Server_directory\instances\instance_name
\ DocumentStore
If you want to save the default document store in a dierent
location, specify the directory in this eld. If the directory
does not exist, the server creates it.
Make sure that you have write access to the specied
Important:
directory and that the directory does not contain
any characters considered illegal by your operating
system.

Initial Store Size

(MB)

The amount of disk space allocated to the default document

store at start up. The default store automatically increases
when it receives data that exceeds the initial size. The default
size is 25MB.
When seing the Initial Store Size, consider the size and
volume of documents that you expect to be delivered to the
default document store. If you expect large documents or
a high volume of documents, consider increasing the Initial
Store Size.
Make sure that there is enough free disk space on
Important:
the Integration Server machine to accommodate the
initial sizes of the default document store, the trigger
document store, and the XA recovery store.

Capacity

The maximum number of documents in the default

document store. The default is 10 documents.
The Capacity must be greater than the Refill Level.
If you set Capacity to 0, the server automatically suspends
the Refill Level. If you set the Capacity eld to 0, the server
displays "Suspended" next to the eld on the Settings >
Resources > Store Settings page.
Note: The Capacity eld displays " Broker Not Congured" if
there is not a Broker congured for the server.

Refill Level

The number of unprocessed documents that remain in

the default document store before the Integration Server
retrieves more documents from the Broker.
For example, if you assign the default document store
a Capacity of 10 and a Refill Level of 4, the server initially
retrieves ten documents. When only four documents remain

webMethods Integration Server Administrators Guide Version 9.10

260

Odd Header
Configuring Integration Server for webMethods Messaging

For this parameter

Specify...
to be processed in the default document store, the server
retrieves six more documents. If six documents are not
available, the server retrieves as many as possible.
The default rell level is 4 documents.
The Refill Level must be less than Capacity. If you set Capacity
to 0, the server automatically suspends the Refill Level.
Note: The Refill Level eld displays " Broker Not Congured"
if there is not a Broker congured for the server.

5. Click Save Changes.

6. If you changed one or more parameters that require server restart for the new value
to take eect, restart Integration Server.
Note:

An asterisk (*) next to a parameter indicates that you need to restart the
server for changes to take eect.

About the Trigger Document Store

The trigger document store contains trigger queues in which Integration Server keeps
locally published guaranteed documents awaiting processing. A document remains in
trigger queue in the trigger document store until one of the following occurs:
Integration Server successfully executes the trigger service specied in the trigger
condition satised by the document.
Integration Server discards the document because the document does not satisfy any
conditions in the trigger.
Integration Server discards the document because it is a duplicate of one already
processed by the trigger. This can occur only if the trigger is congured for exactlyonce processing.
Integration Server cannot determine whether the trigger processed the document
previously, assigns the document a status of In Doubt, and instructs the audit
subsystem to log the document. This can occur only if the trigger is congured for
exactly-once processing.

Configuring the Trigger Document Store

When you congure the trigger document store, you specify the location of the store and
the initial size of the store.
Note:

You do not need to congure the trigger document store if you use Universal
Messaging as the messaging provider.

webMethods Integration Server Administrators Guide Version 9.10

261

Even Header
Configuring Integration Server for webMethods Messaging

To configure the trigger document store

1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Resources.
3. Click Store Settings, and then click Edit Document Store Settings.
4. Set the Trigger Document Store parameters as follows:
For this parameter

Specify...

Store Location

The location of the trigger document store. By default,

Integration Server saves the trigger document store in the
following directory:
Integration Server_directory\instances\instance_name
\ DocumentStore
If you want to save the trigger document store in a
dierent directory, specify the directory in this eld. If the
directory does not exist, the server creates it.
Make sure that you have write access to the specied
Important:
directory and that the directory does not contain
any characters considered illegal by your operating
system.

Initial Store Size

(MB)

The amount of disk space allocated to the trigger

document store at start up. The trigger document store
automatically increases when it receives data that exceeds
the initial size. The default size is 35MB.
Make sure that there is enough free disk space on
Important:
the Integration Server machine to accommodate the
initial sizes of the default document store, the trigger
document store, and the XA recovery store.

5. Click Save Changes.

6. If you changed one or more parameters that require server restart for the new value
to take eect, restart Integration Server.
Note:

An asterisk (*) next to a parameter indicates that you need to restart the
server for changes to take eect.

webMethods Integration Server Administrators Guide Version 9.10

262

Odd Header
Configuring Integration Server for webMethods Messaging

Maintaining Inbound Document History for Received Documents

If Integration Server connects to a Broker version 6.0.1, you can congure the Inbound
Document History seing to maintain a history of documents received by the server. This
instructs the server to perform a very basic form of duplicate detection for all triggers.
If Integration Server connects to a Broker version 6.1 or later, you can congure
duplicate detection on a per trigger basis. For information about conguring duplicate
detection for webMethods messaging triggers using version 6.1 or later of Integration
Server, see the webMethods Service Development Help.
In a cluster of Integration Servers connected to a Broker version 6.0.1, each Integration
Server in the cluster maintains its own inbound document history information. That is,
the inbound document history information is not shared across the cluster.
Note:

The Inbound Document History (minutes) eld can be set only if Integration
Server connects to a Broker version 6.0.1. The eld is not available if the server
connects to a 6.1 or later version of the Broker. For detailed information about
conguring inbound document history, see the webMethods Integration Server
Administrators Guide version 6.0.1.

Enabling Inbound Client-Side Queuing

If Integration Server connects to a 6.0.1 version of the Broker, you can use inbound
client-side queuing. When inbound client-side queuing is enabled, Integration Server
stores received documents on disk and acknowledges documents to the Broker
immediately after receipt and storage. When inbound client-side queuing is disabled,
Integration Server stores received documents in memory and acknowledges documents
to the webMethods Broker after processing completes.
Note:

Inbound client-side queuing is not available when Integration Server connects

to a 6.1 or later version of the Broker. For information about using client-side
queuing with a 6.0.1 version of the Broker, see the webMethods Integration
Server Administrators Guide version 6.0.1.

About the Outbound Document Store

The outbound document store, sometimes called a client side queue (CSQ), contains
guaranteed documents published by Integration Server when the Broker specied in
the Broker connection alias is not available. After the connection to the Broker is reestablished, Integration Server sends the documents in the outbound document store to
the Broker.
Note:

The outbound document store is not used for guaranteed documents

published to Universal Messaging. Instead, each Universal Messaging
connection alias has its own client side queue. Conguring the client side

webMethods Integration Server Administrators Guide Version 9.10

263

Even Header
Configuring Integration Server for webMethods Messaging

queue for a Universal Messaging is part of creating the Universal Messaging

connection alias. For more information about creating a Universal Messaging
connection alias, see "Creating a Universal Messaging Connection Alias" on
page 238.
For Integration Server to use the outbound document store, the
wa.server.publish.useCSQ parameter must be set to always. If
wa.server.publish.useCSQ parameter is set to never, then Integration Server throws a
ServiceException when the Broker is unavailable at the time documents are published to
the Broker.
Integration Server can empty documents from the outbound document store in order
of publication or in parallel. The value of the wa.server.publish.drainCSQInOrder
parameter determines how the outbound store is emptied. By default, Integration
Server sends all newly published documents (guaranteed and volatile) to the outbound
document store until the outbound store has been emptied. This allows Integration
Server to maintain publication order. When Integration Server is congured to empty
the outbound store in parallel, the outbound store is emptied while new documents are
being published to the Broker.

Configuring the Rate at which Integration Server Drains the Outbound

Document Store
You can congure how quickly the server empties the outbound document store
by seing the Maximum Documents to Send per Transaction parameter on the Settings >
Resources > Store Settings > Edit Document Store Settings page. By default, this parameter is
set to 25 documents. To empty the outbound document store more quickly, increase the
number of documents sent per transaction. Keep in mind that the amount of memory
needed to send documents increases with the number of documents sent for each
transaction. If you want to use less memory to empty the outbound document store and
can allow the outbound document store to empty more slowly, decrease the number
of documents sent for each transaction. However, it is advisable to drain the outbound
document store as quickly as possible because Integration Server performs more quickly
and uses fewer resources when publishing documents directly to the Broker.
You only need to congure the rate at which Integration Server drains the outbound
document store (client side queue) if:
Integration Server publishes documents to the Broker. Integration Server does
not use the outbound document store when publishing documents to Universal
Messaging.
The outbound document store is enabled for Integration Server. That is, the
wa.server.publish.useCSQ parameter is set to always.
Tip:

You can monitor the number of documents in the outbound document store
by checking the value of the CSQ Count eld for the Broker connection alias on
the Settings > Messaging > webMethods Messaging Settings screen.

webMethods Integration Server Administrators Guide Version 9.10

264

Odd Header
Configuring Integration Server for webMethods Messaging

To configure how quickly Integration Server empties the outbound document store
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Resources.
3. Click Store Settings, and then click Edit Document Store Settings.
4. Under Outbound Document Store, in the Maximum Documents to Send per Transaction, type
the number of documents the server should send from the outbound document store
to the Broker for each transaction.
If there is no congured Broker, the Integration Server Administrator displays "
Broker Not Congured" next to the eld name.
5. Click Save Changes.

Setting the Capacity of the Outbound Document Store

By default, the outbound document store (client side queue) can contain a maximum
of 500,000 documents. After the outbound document store reaches capacity, the server
"blocks" or "pauses" any threads that are executing services that publish documents. The
threads remain blocked until the server begins draining the outbound document store.
The wa.server.control.maxPersist server parameter determines the capacity of the
outbound document store. If you plan to bring the Broker down for an extended time
period, consider editing this parameter to lower the capacity of the outbound document
store. If you keep the outbound document store at the default capacity, and the Broker
becomes unavailable, it is possible that storing outbound documents could exhaust
memory and cause Integration Server to fail. If the outbound document store has a lower
capacity, Integration Server will block threads instead of continuing to use memory by
storing documents.

Associating a User Account with webMethods Messaging Trigger

Services
When a client invokes a service via an HTTP request, Integration Server checks the
credentials and user group membership of the client against the Execute ACL assigned
to the service. Integration Server performs this check to make sure the client is allowed
to invoke that service. In a publish-and-subscribe situation, however, Integration Server
invokes the service when it receives a document rather than as a result of a client
request. Because Integration Server does not associate user credentials with a published
document, you can specify the user account for Integration Server to use when invoking
services associated with webMethods messaging triggers.
You can instruct Integration Server to invoke a service using the credentials of one of the
predened user accounts (Administrator, Central, Default, Developer, Replicator). You
can also specify a user account that you or another server administrator dened. When
Integration Server receives a document that satises a trigger condition, Integration

webMethods Integration Server Administrators Guide Version 9.10

265

Even Header
Configuring Integration Server for webMethods Messaging

Server uses the credentials for the specied user account to invoke the service specied
in the trigger condition.
Make sure that the user account you select includes the credentials required by the
execute ACLs assigned to the services associated with triggers. For example, suppose
that you specify "Developer" as the user account for invoking services in triggers. The
receiveCustomerInfo trigger contains a condition that associates a publishable document
type with the service addCustomer. The addCustomer service species "Replicator" for
the Execute ACL. When the trigger condition is met, the addCustomer service will not
execute because the user seing you selected (Developer) does not have the necessary
credentials to invoke the service (Replicator).
How you specify a user account for a webMethods messaging trigger service depends
on the messaging provider used by the trigger.
If the trigger receives message from Broker, specify the user account using
Integration Server Administrator. The user account you specify applies to all
webMethods messaging triggers that receive messages from the Broker. For more
information, see "Specifying a User Account for Invoking webMethods Messaging
Trigger Services" on page 266.
If the trigger receives messages from Universal Messaging, specify the user account
for a trigger using Designer. For each webMethods messaging trigger that retrieves
messages from Universal Messaging, you use the Execution user property to indicate
which users can invoke the trigger services for that trigger. For more information
about seing the execution user for a trigger, see webMethods Service Development
Help.

Specifying a User Account for Invoking webMethods Messaging Trigger

Services
For webMethods messaging triggers that receive messages from Broker, you set the
execution user using Broker. The user account you specify applies to all webMethods
messaging triggers that receive messages from the Broker.
To specify a user account to execute a webMethods messaging trigger service
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Resources.
3. Click Store Settings, and then click Edit Document Store Settings.
4. In the Trigger Document Store area of the screen, in the User eld, select the user
account whose credentials the Integration Server uses to execute a service specied
in a trigger condition. The user account can be selected from a central or external
directory. The default is Administrator.
5. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

266

Odd Header
Configuring Integration Server for webMethods Messaging

Load Balancing with a Non-Clustered Group of Integration

Servers
Integration Servers can receive messages from the same messaging provider in a loadbalanced manner if the Integration Servers are connected to the messaging provider as a
non-clustered group. In a non-clustered group, multiple Integration Servers act as a single
messaging client but are not members of a cluster.
Note:

In addition to the term non-clustered group, the terms stateless cluster

and external cluster are sometimes used to describe the situation in which a
group of Integration Servers function in a manner similar to a cluster but are
not part of a congured cluster.

Integration Servers can receive messages from the same messaging provider in a loadbalanced manner if the Integration Servers are connected to the messaging provider as a
non-clustered group.
To receive messages in a load-balanced fashion, each Integration Server must:
Connect to the same messaging provider. A group of non-clustered Integration Servers
can receive messages in a load-balanced fashion from Universal Messaging or
Broker. The messaging connection aliases should be the same on each Integration
Server.
Use the same client prefix. Use the Integration Server Administrator to specify the
client prex for your Integration Servers. For instructions, see "Creating a Broker
Connection Alias" on page 234 and"Creating a Universal Messaging Connection
Alias" on page 238.
Use the same client group. When Broker is the messaging provider, each Integration
Server must use the same client group. Use the Integration Server Administrator to
specify the client group for your Integration Servers. For instructions, see "Creating a
Broker Connection Alias" on page 234.
Have the same triggers. To receive message in a load-balanced manner, the nonclustered Integration Servers must act as a single messaging client, which includes
having the same document subscriptions. For information about conguring
webMethods messaging triggers, see webMethods Service Development Help.
Integration Servers in a non-clustered group can also share a document history database
and a cross-reference database without being in an Integration Server cluster.

Important Considerations
Keep the following points in mind when determining whether to connect a nonclustered group of Integration Servers to the same messaging provider for loadbalancing:

webMethods Integration Server Administrators Guide Version 9.10

267

Even Header
Configuring Integration Server for webMethods Messaging

If Universal Messaging is the messaging provider, the Integration Servers in the

group must be version 9.5 SP1 or later.
If Broker is the messaging provider, the Integration Servers in the group must be
version 7.1 or later.
The Integration Servers in the group must be the same version and at the same x
level.
The Integration Servers in the group can share a document history database and a
cross-reference database.
The actions that Integration Server takes when modifying triggers depends on the
following:
If Integration Servers are in a non-clustered group, how modications to triggers
are handled depends on how the Integration Servers have the Share Client Prefix
option set. For more information about seing this option, see "Creating a
Universal Messaging Connection Alias" on page 238.
If the Share Client Prefix option for the Integration Server connection to the
messaging provider is set to No, modifying a webMethods messaging trigger
on one of the Integration Servers could delete documents and other data
on the messaging provider. For example, when the messaging provider is
Broker, if you enable a trigger, disable a trigger, or change the processing
mode, the Integration Server deletes and then recreates the associated trigger
client queue on the Broker. This action deletes any documents that are in the
trigger client queue on the Broker.
If the Share Client Prefix option for the Integration Server connection to the
messaging provider is set to Yes, the Integration Servers act as if they are in
an Integration Server cluster whenever you perform Integration Server-tomessaging provider administration, such as modifying a trigger.
When Integration Servers are in an Integration Server cluster, if a webMethods
messaging trigger is modied on one of the servers, that server will not
synchronize the trigger changes with the associated object on the messaging
provider. If you enable or disable a trigger in a cluster of Integration Servers,
the associated subscriptions and object remain on the messaging provider. In a
non-clustered group of Integration Servers, it is your responsibility to manually
update the seings on the messaging provider.

webMethods Integration Server Administrators Guide Version 9.10

268

Odd Header
Configuring Integration Server for JMS Messaging

12 Configuring Integration Server for JMS Messaging

Overview .....................................................................................................................................

270

Working with JNDI Providers .....................................................................................................

270

Working with JMS Connection Aliases ......................................................................................

276

Creating Administered Objects ..................................................................................................

297

Monitoring a Connection Factory Object for Changes ...............................................................

297

Using SSL with JMS ..................................................................................................................

302

Supported JMS Providers ..........................................................................................................

303

Adding JMS Provider Client Libraries to Integration Server Classpath ......................................

webMethods Integration Server Administrators Guide Version 9.10

305

269

Even Header
Configuring Integration Server for JMS Messaging

Overview
To congure Integration Server for JMS messaging, you need to:
Create one or more JNDI provider aliases to specify where Integration Server can
look up administered objects when it needs create a connection to JMS provider or
specify a destination for sending or receiving messages.
Create one or more connection aliases that encapsulate the properties that
Integration Server needs to create a connection with the JMS provider.
Integration Server also includes various server conguration properties that you can
use to change the default server behavior. For a list of server conguration parameters
related to JMS, see "Server Conguration Parameters" on page 851.

Working with JNDI Providers

Each JMS provider can store JMS administered objects in a standardize namespace
called the Java Naming and Directory Interface (JNDI). JNDI is a Java API that provides
naming and directory functionality to Java applications.
As the JMS client, Integration Server uses a JNDI provider alias to encapsulate the
information needed to look up an administered object. When you create a JMS
connection alias, you can specify the JNDI provider alias that Integration Server should
use to look up administered objects (i.e., Connection Factories and Destinations).
Note:

If you connect directly to webMethods Broker using the native webMethods

API, you do not need to use a JNDI provider. If you choose to use
webMethods Broker but do not want to connect natively (using the
native webMethods API), you still need to use a JNDI provider. For
more information about using the native webMethods API to connect to
webMethods Broker, see "Connecting to webMethods Broker with the Native
webMethods API" on page 276.

Predefined JNDI Provider Aliases

Integration Server includes predened JNDI provider aliases. Integration Server creates
the aliases the rst time Integration Server starts. If the aliases existed in an Integration
Server that was migrated from a previous version, Integration Server keeps the existing
aliases. That is, Integration Server does not overwrite the previous alias denition.
The predened JNDI provider alias for Integration Server is DEFAULT_IS_JNDI_
PROVIDER, a JNDI provider alias with predened seings for establishing a connection
to the local instance of webMethods Universal Messaging. If webMethods Universal
Messaging is not installed in the same directory as Integration Server, then the
DEFAULT_IS_JNDI_PROVIDER uses a provider URL of nsp://localhost:9000.

webMethods Integration Server Administrators Guide Version 9.10

270

Odd Header
Configuring Integration Server for JMS Messaging

Note:

If you migrated to Integration Server version 9.10 or later from an earlier

version, then you might have the EventBusJndiProvider alias, which was
a predened JNDI provider alias in versions prior to 9.10. This alias points
to the local instance of webMethods Universal Messaging. If webMethods
Universal Messaging is not installed in the same directory as Integration
Server, then the EventBusJndiProvider uses a provider URL of nsp://
localhost:9000.

Creating a JNDI Provider Alias

Use the following procedure to create an alias to a JNDI provider.
To create a JNDI provider alias
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under JMS Conguration, click JNDI Settings.
4. Click Create JNDI Provider Alias.
5. Specify the following information for the JNDI provider alias:
In this field...

Specify...

JNDI Alias Name

The alias name that you want to assign to this JNDI

provider.

Description

A description for this JNDI alias.

Predefined JNDI
Templates

The JNDI template that you want to use.

The JNDI templates provide information that you
can use to complete alias conguration for a specic
provider.
Note: After you create a JNDI provider, Integration
Server Administrator displays Current Seings as
the value of the Predefined JNDI Templates eld. This
indicates that Integration Server uses the currently
specied seings for the JNDI provider alias.

Initial Context Factory

The class name of the JNDI provider. The JNDI

provider uses the initial context as the starting point for
resolving names for naming and directory operations.

webMethods Integration Server Administrators Guide Version 9.10

271

Even Header
Configuring Integration Server for JMS Messaging

In this field...

Specify...
If you selected a predened JNDI template, Integration
Server displays the initial context factory for the
provider.

Provider URL

The primary URL of the initial context for sessions

with the JNDI provider. The URL species the JNDI
directory in which the JNDI provider stores JMS
administered objects.
If you selected a predened JNDI template, replace
the placeholder information in brackets << >> with
information specic to your conguration.
If you are using webMethods Universal Messaging,
this is the Universal Messaging realm server in
the format nsp://UM_host :UM_port (for example,
nsp://127.0.0.1:9000).
If you are using a cluster of Universal Messaging realm
servers, supply a list of the URLs to each realm server
in the cluster. Use a colon or semi-colon to separate
each URL:
Separate the URLs using a comma if Integration
Server always aempts to connect to the rst
Universal Messaging server in the list, only trying the
second Universal Messaging server in the list if the
rst server becomes unavailable
Separate the URLs using a semicolon if Integration
Server connects to a randomly chosen URL from the
list. This may result in beer distribution of clients
across the servers in the cluster.

Provider URL Failover

List

The comma-separated list of the failover URLs of the

initial context for sessions with the JNDI provider. If
the connection to the primary JNDI provider becomes
unavailable, Integration Server automatically aempts
a connection to a JNDI provider specied in this list.
For more information about seing up a JNDI provider
failover list, see "Creating a JNDI Provider Failover
List" on page 274.

Security Principal

The principal name, or user name supplied by

Integration Server to the JNDI provider, if the provider
requires one for accessing the JNDI directory.

webMethods Integration Server Administrators Guide Version 9.10

272

Odd Header
Configuring Integration Server for JMS Messaging

In this field...

Specify...
For information about whether or not the JNDI
provider requires security principal information,
consult the product documentation for the JNDI
provider.

Security Credentials

The credentials, or password, that Integration Server

provides to the JNDI provider, if the provider requires
security credentials to access the JNDI directory.
For information about whether or not the JNDI
provider requires security credentials, consult the
product documentation for the JNDI provider.

Other Properties

Any additional properties the JNDI provider requires

for conguration. For example, you might need to
specify the classpath for any additional .jar or class les
that the JNDI provider needs to connect to the JNDI.
When you select a predened JNDI template,
Integration Server populates this eld with any
additional properties and placeholder information
required by the JNDI provider.
For more information about additional properties or
classes required by a JNDI provider and the location of
those les, see the product documentation for the JNDI
provider.

6. Click Save Changes.

Editing a JNDI Provider Alias

Use the following procedure to edit an existing JNDI provider alias.
To edit a JNDI provider alias
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under JMS Conguration, click JNDI Settings.
4. In the JNDI Provider Alias Denitions list, select the JNDI provider alias that you
want to edit. Integration Server Administrator displays details about the JNDI
provider alias.
5. Click Edit JNDI Provider Alias.
6. Edit the properties of the JNDI provider alias.

webMethods Integration Server Administrators Guide Version 9.10

273

Even Header
Configuring Integration Server for JMS Messaging

For more information about the elds, see "Creating a JNDI Provider Alias" on page
271.
7. Click Save Changes.

Deleting a JNDI Provider Alias

Use the following procedure to delete a JNDI provider alias.
Important: When you delete a JNDI provider alias, any service or JMS trigger that uses a
JMS connection alias that relies on the JNDI provider alias will fail.
To delete a JNDI provider alias
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under JMS Conguration, click JNDI Settings.
4. Locate the alias you want to delete and click the
icon in the Delete eld.
Integration Server displays a dialog box that prompts you to verify your action. Click
OK to verify that you want to delete the JNDI provider alias.

Creating a JNDI Provider Failover List

You can congure Integration Server to automatically connect to an alternate JNDI
provider if the connection to the primary JNDI provider becomes unavailable.
Use the Edit JNDI Provider Alias page to create a JNDI provider failover list containing
alternate URLs that Integration Server can use if the primary connection fails.
Keep the following points in mind when adding JNDI provider URLs to the failover list:
The JNDI providers must be the same type as the primary provider. For example,
if the primary provider is a webMethods Broker, then the JNDI providers in the
failover list must also be webMethods Brokers.
The administered objects on the providers must be identical to the each other.
Once Integration Server connects to a JNDI provider, it continues to use that JNDI
provider until the connection is lost or interrupted.
When you start or restart a connection alias, Integration Server aempts to connect
to the primary JNDI provider. If the connection fails, Integration Server immediately
aempts to connect to the rst JNDI provider in the failover list. If the connection
fails, Integration Server aempts to connect to the next JNDI provider in the list.
When using webMethods Broker as a JNDI provider, you can keep objects in sync
between webMethods Brokers using a webMethods Broker territory. That way
objects can automatically forward from on webMethods Broker to another within the
territory.

webMethods Integration Server Administrators Guide Version 9.10

274

Odd Header
Configuring Integration Server for JMS Messaging

When using a cluster of Universal Messaging realm servers as the JNDI provider,
Software AG recommends that you do not specify a Provider URL Failover List value.
The realm URLS specied in Provider URL function as the failover list.

Performing a Test Lookup for a JNDI Provider

Using Integration Server Administrator, you can perform a test lookup for the primary
JNDI provider and any failover JNDI providers specied in the Provider URL Failover List.
Test lookup veries that the URLs are valid.
Note:

Test lookup only veries the validity of the URLs; it does not check or
compare Objects in the JNDI namespace referenced by the specied provider
URL aliases.

To perform a test lookup for a JNDI provider

1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under JMS Conguration, click JNDI Settings.
4. Locate the alias you want to test and click the

icon in the Test Lookup eld.

Integration Server returns a list of the Objects located in the JNDI namespace.
Note:

The list displays the Objects in the JNDI namespace referenced by the rst
successful provider alias URL lookup. Therefore, the results displayed may
or may not be from the primary alias, they could be from a failover alias.

JNDI Provider Cache and Timeout Behavior for Administered Objects

Integration Server retrieves administered objects through JNDI when a JMS connection
alias is enabled. Integration Server does this by instantiating a new context object using
the specied JNDI provider. Integration Server employs this context to look up the
connection factory and destinations specied by the JMS triggers, message sending
services, and message receiving services that use the JMS connection alias.
Most JNDI provider implementations, including the webMethods Broker
implementation, automatically cache administered objects locally when the context is
instantiated. There are some JNDI providers, however, in which the caching and timeout
behavior for administered objects is congurable on the provider. In most cases, using
this type of provider is not an issue because the destination is cached by Integration
Server when it is looked up. Integration Server only needs to look it up one time, and
then all subsequent lookups are retrieved locally. However, if the administered objects
are not cached in the context or if they have timed out, then a lookup request may
require a new connection to the JNDI provider.
In this case, if the JNDI provider becomes unavailable after enabling the connection alias
but before retrieving the destination, a NamingException can occur. The JNDI failover
webMethods Integration Server Administrators Guide Version 9.10

275

Even Header
Configuring Integration Server for JMS Messaging

functionality in Integration Server addresses this situation. If Integration Server is unable

to retrieve the destination from its original context, it will create a new context from one
of the failover JNDI providers.
Keep in mind that, because Integration Server caches the destinations locally, it is
possible that the cached destinations may become stale. In this case, the original
destination will be used. You can reload administered objects by enabling and disabling
the connection alias or monitoring the connection object for changes. If the administered
objects are no longer usable, a ServiceException will occur. For more information about
monitoring connections, see "Monitoring a Connection Factory Object for Changes" on
page 297.

Working with JMS Connection Aliases

A JMS connection alias species the information that Integration Server needs to
establish an active connection between Integration Server and the JMS provider.
Integration Server uses a JMS connection alias to send messages to and receive messages
from the JMS provider.

Connecting to webMethods Broker with the Native webMethods API

When you use webMethods Broker as the JMS provider, you can congure a JMS
connection alias to use the native webMethods API. The native webMethods API
provides a way to connect the Integration Server directly to the webMethods
Broker acting as the JMS provider. This eliminates the need for connection factories.
Destinations can be created directly on the Broker and do not need to be stored in a JNDI
provider. Consequently, you do not need to use a JNDI provider if all JMS connection
aliases specify that the connection to webMethods Broker should be made using the
native webMethods API.
If you choose to use webMethods Broker but do not want to connect natively (using the
native webMethods API), you still need to use a JNDI provider.

Predefined JMS Connection Aliases

Integration Server includes predened JMS connection aliases. Integration Server creates
the aliases the rst time Integration Server starts. If the aliases existed in an Integration
Server that was migrated from a previous version, Integration Server keeps the existing
aliases. That is, Integration Server does not overwrite the previous alias denition.
Integration Server has the following predened JMS connection aliases:
JMS Connection Alias

Description

DEFAULT_IS_JMS
_CONNECTION

A JMS connection alias that denes a connection to

Universal Messaging using the predened JNDI provider
alias DEFAULT_IS_JNDI_PROVIDER.

webMethods Integration Server Administrators Guide Version 9.10

276

Odd Header
Configuring Integration Server for JMS Messaging

JMS Connection Alias

Description
Integration Server congures this JMS connection alias
when you launch the Integration Server the rst time.
This connection alias is disabled by default.

EventBus

A JMS connection alias for the EDA Event Bus

server that denes a connection to Universal
Messaging using the predened JNDI provider alias
DEFAULT_IS_JNDI_PROVIDER.
Integration Server congures this JMS connection alias
when you launch the Integration Server the rst time.
This connection alias is disabled by default.

PE_NON
TRANSACTIONAL_
ALIAS

A JMS connection alias for the Process Engine that

establishes a connection to Universal Messaging
using the predened JNDI provider alias
DEFAULT_IS_JNDI_PROVIDER.
Integration Server congures this alias when you launch
your Integration Server the rst time.
Note: Integration Server creates this alias even if the Process
Engine is not installed.

Creating a JMS Connection Alias

When you create a JMS connection alias, keep the following points in mind:
You can use JNDI to retrieve administered objects (Connection Factories and
Destinations) and then use the Connection Factory to create a connection. If you
intend to use a JNDI provider, you need to congure one or more JNDI provider
aliases before creating a JMS connection alias.
- or You can use the native webMethods API to create the connection directly on the
webMethods Broker. Because you can create Destinations at the Broker, you do not
need to congure a JNDI provider alias if you intend to use the native webMethods
API.
Note that if you elect to use the webMethods Broker but do not want to connect
natively, you will need to use a JNDI provider and congure one or more JNDI
provider aliases.
Each JMS connection alias has an associated transaction type. Within Integration
Server, certain functionality must be completed within a non-transacted session.

webMethods Integration Server Administrators Guide Version 9.10

277

Even Header
Configuring Integration Server for JMS Messaging

For example, to use Integration Server to send or receive large message streams,
you must specify a JMS connection alias whose transaction type is set to
NO_TRANSACTION.
To create a JMS connection alias
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under JMS Conguration, click JMS Settings.
4. Click Create JMS Connection Alias.
5. Set the following General Settings for the JMS connection alias:
For this field...

Specify...

Connection Alias
Name

Name of the connection alias. Each connection alias

represents a connection factory to a specic JMS provider.

Description

A description of the JMS connection alias.

Transaction Type

Whether sessions that use this JMS connection alias will

be transacted.

Connection Client ID

Select...

To...

NO_TRANSACTION

Indicate that sessions that use

this JMS connection alias are not
transacted.

LOCAL_TRANSACTION

Indicate that sessions that use this

JMS connection alias are part of a
local transaction.

XA_TRANSACTION

Indicate that sessions that use this

JMS connection alias are part of an
XA transaction.

The JMS client identier associated with the connections

established by this JMS connection alias.
Note: The connection client ID can be specied in the
JMS connection alias or in the Connection Factory.
If the connection client ID is specied in both
places, Integration Server uses the value from the
Connection Factory. For more information about

webMethods Integration Server Administrators Guide Version 9.10

278

Odd Header
Configuring Integration Server for JMS Messaging

For this field...

Specify...
the connection client ID, see "About the Connection
Client ID" on page 289.

User (optional)

User name needed to acquire a connection from the

connection factory.
For more information about whether or not the JMS
provider requires a user name and password to obtain a
connection, refer to the product documentation for the
JMS provider.

Password (optional)

Password needed to acquire a connection from the

connection factory.
For more information about whether or not the JMS
provider requires a user name and password to obtain a
connection, refer to the product documentation for the
JMS provider.

6. In the Create Connection Using list, select one of the following to indicate how
administered objects (connection factories and destinations) will be looked up:
If you intend to use a JNDI provider, select JNDI Lookup.
If you intend to use the native webMethods API to create the connection directly
on the webMethods Broker, select NativewebMethodsAPI.
7. If you selected JNDI Lookup in the Create Connection Using list, do the following in the
remaining elds under Connection Protocol Settings:
For this field...

Specify...

JNDI Provider Alias

Name

The alias to the JNDI provider that you want this JMS
connection alias to use to look up administered objects.
For information about creating a JNDI provider alias,
see "Creating a JNDI Provider Alias" on page 271.

Connection Factory
Lookup Name

The lookup name for the connection factory that you

want to use to create a connection to the JMS provider
specied in this JMS connection alias.
If the JMS connection alias connects to webMethods
Universal Messaging, specify the Universal Messaging
connection factory that you created when you set up
your Universal Messaging environment.
If you are using SonicMQ as the JMS provider, specify
the lookup name that refers to the serializable Java

webMethods Integration Server Administrators Guide Version 9.10

279

Even Header
Configuring Integration Server for JMS Messaging

For this field...

Specify...
object le containing the SonicMQ object denitions.
Include the .sjo extension as part of the lookup name.

Monitor webMethods
Connection
Factory

Polling Interval
(minutes)

How Integration Server monitors the connection factory

object for changes, if at all This only applies if a JMS
connection alias connects to the webMethods Broker
using a webMethods Connection Factory object in a
JNDI server.
Select...

To...

No

Indicate that Integration Server will

not monitor the connection factory.
This is the default.

Poll for changes

(specify interval)

Monitor the connection factory by

polling for changes at an interval
that you specify.

Poll for changes

(interval
defined
by webMethods
Connection Factory)

Monitor the connection factory

at an interval determined by the
refresh interval specied for the
webMethods Connection Factory
object. For more information about
conguring a cluster connection
factory, see Administering
webMethods Broker and webMethods
Broker Messaging Programmers
Guide.

Register change
listener

Monitor the connection factory by

registering an event listener.

The number of minutes between polling aempts. The

polling interval must be a positive integer. The default
value is 60 minutes.
Note: This eld is only available if you selected Poll for
changes (specify interval).

Note:

For more information, see "Monitoring a Connection Factory Object for

Changes" on page 297.

webMethods Integration Server Administrators Guide Version 9.10

280

Odd Header
Configuring Integration Server for JMS Messaging

8. If you selected NativewebMethodsAPI in the Create Connection Using list, do the

following to congure the connection to the Broker Server that you want to use as
the JMS provider for this JMS connection alias:
For this field...

Specify...

Broker Host

Name (DNSname :port or ipaddress :port ) of the machine on

which the Broker Server resides.

Broker Name

Name of the webMethods Broker as dened on the Broker

Server. The default name is Broker #1.

Client Group

The name of the client group to which you want

Integration Server to belong when it acts as a JMS client.
The client group that you specify must already exist on the
Broker Server. The default is IS-JMS.

Broker List

A comma delimited list of Broker Servers on which the

connection between the Integration Server (acting as the
JMS client) and the Broker (acting as the JMS provider) can
exist. This provides connection failover. If a connection
failure occurs to the rst Broker Server in the list, a
connection aempt will be made to the next Broker Server
listed. Use the following format for each webMethods
Broker:
{webMethods Broker Name]@<host>[:port]
Note: If a connection to a Broker Server is
already congured (via Settings > Messaging
> webMethods Messaging Settings), Integration Server
populates the elds under Connection Protocol
Seings with information about that Broker Server. If
that Broker Server functions as the JMS provider, you
may not need to edit any information. However, make
sure that the Client Group eld species the client
group to which you want Integration Server to belong
when it functions as a JMS client.

Keystore

The full path to this Integration Server's keystore le. A

keystore le contains the credentials (private key/signed
certicate) that an entity needs for SSL authentication.
If the Broker Server requires an SSL connection, then
the information in this le is used to authenticate the
Integration Server client to that Broker Server.

webMethods Integration Server Administrators Guide Version 9.10

281

Even Header
Configuring Integration Server for JMS Messaging

For this field...

Specify...
The Integration Server's keystore le is stored on the
machine on which the Integration Server resides.

Keystore Type

The le type of the Integration Server's keystore le, which

can be either PKCS12 or JKS.

Truststore

The full path to this Integration Server client's truststore

le. A truststore le contains trusted root certicates for
the authorities responsible for signing SSL certicates. For
an SSL connection to be made, a valid trusted root for the
SSL certicate stored in the keystore must be accessible in
a truststore le.
The Integration Server's truststore le is stored on the
machine on which the Integration Server resides.

Truststore Type

The le type of the Integration Server's truststore le,

which is JKS.

Encryption

Specify whether or not to encrypt the connection between

the Integration Server and the webMethods Broker.

9. Under Advanced Settings, specify the following information for the JMS connection
alias:
For this field...

Specify...

Class Loader

The name of the class loader that you want to use with
this JMS connection alias. Integration Server will use the
specied class loader when performing certain activities
with the JMS connection alias (send a message, receive a
message, create a connection, create a destination, etc.)
By default, Integration Server uses the server class loader.
However, you can specify the class loader for a package
instead. This may be helpful when working with third
party JMS providers. For example, you might place the
third party jars needed for each JMS provider in separate
packages, specically, in the Integration Server_directory/
instances/instance_name /packages/packageName /code/jars
directory. This can help prevent conicts between the jars
required for dierent JMS providers.

Maximum CSQ Size

(messages)

The maximum number of messages that can exist in the

client side queue for this JMS connection alias. Integration

webMethods Integration Server Administrators Guide Version 9.10

282

Odd Header
Configuring Integration Server for JMS Messaging

For this field...

Specify...
Server writes messages to the client side queue if the JMS
provider is not available when messages are sent. Each
JMS connection alias has its own client side queue.
Specify -1 if you want the client side queue to be able to
contain an unlimited number of messages. That is, specify
-1 if you do not want to set a maximum limit.
If you specify 0, Integration Serverwill not write messages
to the client side queue for this JMS connection alias.

Drain CSQ in Order

Whether Integration Server drains the client side queue

by sending the messages to the JMS provider in the same
order in which Integration Server placed the messages in
the client side queue.
Select the check box if you want Integration Server to send
messages from the client side queue in the same order in
which Integration Server originally placed the messages
in the client side queue.
When the Drain CSQ in Order check box is selected, after
the connection to the JMS provider is re-established,
Integration Server continues to write new messages to the
client side queue until the client side queue is completely
drained. If the Drain CSQ in Order check box is not selected,
after the connection to the JMS provider is re-established,
Integration Server sends new messages directly to the JMS
provider while it drains the client side queue.
Note: You can also specify the number of messages
Integration Server retrieves from the client side
queue for delivery to the JMS provider at one
time. By default, Integration Server sends 25
messages at a time. For more information about the
wa.server.jms.csq.batchProcessingSize property, see
"Server Conguration Parameters" on page 851.

Create Temporary
Queue

Whether Integration Server creates a temporary queue on

the JMS provider to handle request-reply operations that
do not specify a replyTo destination.
Select the check box if you want Integration Server to
create a temporary queue. Clear the check box if you do
not want Integration Server to create a temporary queue.

webMethods Integration Server Administrators Guide Version 9.10

283

Even Header
Configuring Integration Server for JMS Messaging

For this field...

Specify...
You must select the Create Temporary Queue check box if
you want to select the Enable Request-Reply Listener for
Temporary Queue check box.

Enable RequestReply Listener for

Temporary Queue

Species whether or not Integration Server creates

a single dedicated MessageConsumer for receiving
synchronous replies delivered to the temporary queue for
this JMS connection alias. When this check box is cleared,
Integration Server creates a new JMS MessageConsumer
for each reply message. In many situations, creating
one MessageConsumer per response does not impact
performance. However, in some situations, such as when
many threads invoke pub.jms:sendAndWait concurrently,
creating a MessageConsumer for every expected response
can impact performance. When this check box is selected,
Integration Server creates a dedicated consumer for
receiving replies to requests published using this JMS
connection alias. For more information about creating a
dedicated listener for receiving replies, see "Creating a
Dedicated Listener for Receiving Replies" on page 290.

Manage Destinations

Whether users can use Designer to create, list, and modify

destinations on the webMethods Broker or webMethods
Universal Messaging when working with JMS triggers.
Select the check box if you want Designer users to be able
to create, list, and modify destinations using a JMS trigger
that uses this JMS connection alias.
If this JMS connection alias connects to a webMethods
Broker in a production environment, Software AG
recommends that you prevent Designer users from
managing destinations. That is, in a production
environment, the Manage Destinations check box should be
cleared.
For more information about using Designer to manage
destinations, see "Allowing Destinations to be Managed
through the JMS Connection Alias and Designer " on page
287.

Create New
Connection per
Trigger

Whether Integration Server creates a separate connection

to the JMS provider for each JMS trigger.
Select the check box if you want Integration Server to
create a separate connection for each JMS trigger that uses
this JMS connection alias.

webMethods Integration Server Administrators Guide Version 9.10

284

Odd Header
Configuring Integration Server for JMS Messaging

For this field...

Specify...
If you want a concurrent JMS trigger that uses this JMS
connection alias to use multiple connections to the JMS
provider, you must congure the alias to create a separate
connection per trigger.
For more information, see "Allowing Multiple
Connections for a JMS Connection Alias" on page 288.

10. Under Producer Caching, specify the following to congure a default session pool
and destination-specic pools. For more information about producer caching, see
"Conguring Producer Caching for Sending JMS Messages" on page 291.
Note:

You can congure producer caching for non-transacted JMS connection

aliases only.

For this field...

Specify...

Caching Mode

Whether to enable caching of JMS Session and

MessageProducer objects for this JMS connection alias.
Select...

To...

DISABLED

Indicate that Integration Server

does not cache JMS Session or
MessageProducer objects.

ENABLED PER
DESTINATION

Enable caching of JMS Session

and MessageProducer objects.

Minimum Session
Pool Size (unspecified
destinations)

The minimum number of entries in the default session

pool. The default is 1.

Maximum Session
Pool Size (unspecified
destinations)

The maximum number of entries in the default session

pool. The default is 30.

Minimum Pool Size per

Destination

The minimum number of entries in each destinationspecic pool.

Maximum Pool Size per

Destination

The maximum number of entries in each destinationspecic pool. A value of 0 (or blank) indicates that
Integration Server does not create separate pools

webMethods Integration Server Administrators Guide Version 9.10

285

Even Header
Configuring Integration Server for JMS Messaging

For this field...

Specify...
for any of the destinations associated with the JMS
connection alias.

Destination Lookup
Name List

A semicolon delimited list of the lookup names for the

destinations for which you want Integration Server to
create separate pools.
Note: This eld appears only when the JMS connection
alias species JNDI Lookup for creating the
connection to the JMS provider.

Queue List

A semicolon delimited list of the queues for which you

want Integration Server to create separate pools.
Note: This eld only appears when the JMS connection
alias species Native webMethods API for creating
the connection to the webMethods Broker.

Topic List

A semicolon delimited list of the topics for which you

want Integration Server to create separate pools.
Note: This eld only appears when the JMS connection
alias species Native webMethods API for creating
the connection to the webMethods Broker.

Idle Timeout

The number of milliseconds before Integration Server

removes an inactive pool entry. The timeout value
applies to the default session pool and the destinationspecic pools.
A value of 0 indicates that pool entries never
expire. A value of -1 indicates that Integration
Server uses the system default as dened by the
wa.server.jms.producer.pooledSession.timeout
parameter.
This default is 60000 milliseconds

11. Under Producer Retry, specify the following to congure automatic retry of
pub.jms:send services that use this JMS connection alias to send a message to the JMS
provider. For more information about automatic retry, see "Conguring Automatic
Retry when Sending JMS Messages Using the pub.jms:send Service" on page 292.

webMethods Integration Server Administrators Guide Version 9.10

286

Odd Header
Configuring Integration Server for JMS Messaging

For this field...

Specify...

Max Retry
Count

The maximum number of times that Integration Server will

automatically retry a pub.jms:send service that fails because of
a transient error. A value of 0 indicates that automatic retry is
disabled for this JMS connection alias. The default is 0.

Retry Interval
(milliseconds)

The number of milliseconds that Integration Server waits

between retry aempts. The default is 1000 milliseconds (1
second).

Note:

If the JMS connection alias is transacted or uses a connection factory to

which the multi-send guaranteed policy is applied, Integration Server
ignores the producer retry values.

12. Click Save Changes.

13. Enable the JMS connection alias.

Allowing Destinations to be Managed through the JMS Connection Alias and

Designer
You can congure the JMS connection alias to enable Designer users to manage
destinations and durable subscribers when working with JMS triggers. When the JMS
connection alias is congured for managing destinations (i.e., the Manage Destinations
check box is selected), you can use Designer to create and modify destinations and
durable subscribers on webMethods Broker or webMethods Universal Messaging.
Note:

The ability to use Designer to manage destinations on Broker or Universal

Messaging is a design-time feature. In a production environment, this
functionality should be disabled.

To manage destinations on Broker, the following must be true

The JMS connection alias must use Broker as the JMS provider.
Broker must be Broker version 7.1 or higher.
The versions of following three Broker jar les installed on Integration Server must
be the 8.0 SP1 or higher versions of the les.
Software AG_directory/common/lib/wm-brokerclient.jar
Software AG_directory/common/lib/wm-jmsclient.jar
Software AG_directory/common/lib/wm-jmsnaming.jar
To manage destinations on Universal Messaging, the following must be true:
The JMS connection alias must use Universal Messaging as the JMS provider.

webMethods Integration Server Administrators Guide Version 9.10

287

Even Header
Configuring Integration Server for JMS Messaging

Universal Messaging must be version 9.5 or higher.

For more information about using Designer to modify Destinations on the Broker or
Universal Messaging, see webMethods Service Development Help.

Allowing Multiple Connections for a JMS Connection Alias

You can congure a JMS connection alias to instruct Integration Server to create a
separate connection to the JMS provider for each JMS trigger that uses the alias. Creating
separate connections for individual triggers can improve performance, especially when
processing a high volume of messages across many triggers.
By default, an alias creates a single connection to the JMS provider, and each JMS
trigger that uses the alias shares the same connection. Integration Server uses this same
connection to send JMS messages when executing pub.jms* services that specify the JMS
connection alias.
If you select the Create New Connection per Trigger check box when conguring a JMS
connection alias, Integration Server creates a new connection to the JMS provider for
each JMS trigger that uses the alias. These connections are in addition to the connection
that Integration Server uses for sending JMS messages. Therefore, if a JMS connection
alias is associated with 3 JMS triggers, there will be a total of 4 connections associated
with the alias.
When an alias creates a separate connection for each trigger, you can congure the
associated concurrent JMS triggers to obtain multiple connections to the JMS provider,
thereby noticeably improving trigger throughput. Keep in mind, however, that each
connection used by the trigger requires a dedicated Integration Server thread, regardless
of the current throughput.
Note:

If you select the Create New Connection per Trigger check box, then the Ignore
Locally Published feature on associated JMS triggers will not work. For the
trigger to ignore locally published messages, the publisher and subscriber
must share the same connection. When the JMS connection alias creates a new
connection per trigger, the publisher and subscriber will not share the same
connection.

Integration Server supports creating and using multiple connections for a single
JMS connection alias with the supported JMS providers. For a list of supported JMS
providers, see "Supported JMS Providers" on page 303.
Note:

When Integration Server creates multiple connections, Integration Server uses

the same client ID for each connection. While the webMethods Broker permits
this, some JMS providers do not support the use of multiple connections
with the same client ID or require additional conguration to support it.
This can be particularly true when working with topics and/or durable
subscribers. Review the JMS provider documentation before conguring the
JMS connection alias or a JMS trigger to use multiple connections.

webMethods Integration Server Administrators Guide Version 9.10

288

Odd Header
Configuring Integration Server for JMS Messaging

To use multiple connections for a single JMS connection alias when using webMethods
Broker as the JMS provider, the following must be true:
webMethods Broker must be webMethods Broker version 7.1 or higher.
The versions of following three webMethods Broker jar les installed on Integration
Server must be the 8.0 SP1 or higher versions of the les.
Software AG_directory/common/lib/wm-brokerclient.jar
Software AG_directory/common/lib/wm-jmsclient.jar
Software AG_directory/common/lib/wm-jmsnaming.jar
For more information about conguring JMS triggers, see the webMethods Service
Development Help in Software AG Designer.
About the Connection Client ID
The connection client ID is the JMS client identier associated with the connections
established by a JMS connection alias. The connection client ID that Integration Server
uses for a connection created from a JMS connection alias depends on one or more of the
following:
The value of the Connection Client ID eld for the JMS connection alias.
The connection client ID specied in the Connection Factory used by the JMS
connection alias.
Whether the JMS connection alias is congured to create a new connection for each
JMS trigger. That is, whether or not the Create New Connection per Trigger check box is
selected.
Using the above information, Integration Server determines the connection client ID as
follows:
If only the JMS connection alias species the connection client ID, Integration
Server uses this value for any connections created from the alias. When connecting
to the webMethods Broker natively (the Create Connection Using list is set to
NativewebMethodsAPI), Integration Server always uses the connection client ID from
the JMS connection alias.
If only the Connection Factory species the connection client ID, Integration Server
uses this value for any connections created from the alias.
If the JMS connection alias and the Connection Factory specify the connection client
ID, Integration Server uses the value in the Connection Factory. This is true when
working with all JMS providers, including the webMethods Broker.
When the Create New Connection per Trigger check box is not selected, each JMS trigger
that uses the JMS connection alias will use the same connection. Each connection will
have the same connection client ID.
When the Create New Connection per Trigger check box is selected, each JMS trigger that
uses the JMS connection alias will create its own connection to the JMS provider.

webMethods Integration Server Administrators Guide Version 9.10

289

Even Header
Configuring Integration Server for JMS Messaging

If Integration Server uses the connection client ID in the Connection Factory, each
connection for a JMS trigger will have the same connection client ID.
If Integration Server uses the connection client ID from the JMS connection
alias, each connection for a JMS trigger will be unique to the JMS trigger. The
connection client ID will consist of the value of the Connection Client ID eld in the
JMS connection alias plus the fully qualied name of the JMS trigger.
Note:

To receive messages in a load balanced manner, each JMS trigger must

connect to the webMethods Broker using the same connection client ID.
Because the Create New Connection per Trigger option can change the connection
client ID, you must be sure that use of this option is consistent across all
Integration Servers across the Integration Server group.

Creating a Dedicated Listener for Receiving Replies

Integration Server includes the ability to create a dedicated consumer for receiving
replies to a published request. You congure this functionality per JMS messaging
connection alias.
When the pub.jms:sendAndWait service executes a synchronous request-reply, Integration
Server sends the request message to the JMS provider and waits for a reply. By default
Integration Server creates a new JMS MessageConsumer for each reply message.
In many situations, creating one MessageConsumer per response does not impact
performance. However, in some situations, such as when many threads invoke
pub.jms:sendAndWait concurrently, creating a MessageConsumer for every expected
response can impact performance.
To address this, Integration Server includes an option named Enable RequestReply Listener for Temporary Queue that, when selected, creates a single dedicated
MessageConsumer for receiving synchronous replies sent by the JMS connection alias. If
Integration Server uses a single consumer to retrieve all synchronous replies for requests
sent by a particular JMS connection alias, when executing pub.jms:sendAndWait service,
Integration Server assigns a unique value to the new wm_tag eld used as a property in
the JMS message, specicallyJMSMessage/properties/wm_tag . When using pub.jms:reply to
reply to a JMS message request for which wm_tag is populated, the replying Integration
Server maps the value of wm_tag to JMSMessage/header/JMSCorrelationID eld in the
reply message.
To use a dedicated consumer to retrieve replies to all requests sent using a particular
JMS connection alias, the following must be true:
The JMS connection alias used to send the request must have the following
congured:
The Create Temporary Queue check box must be selected.
The Enable Request-Reply Listener for Temporary Queue check box must be selected.
This is a new option for a JMS connection alias.
The pub.jms:sendAndWait invocation:

webMethods Integration Server Administrators Guide Version 9.10

290

Odd Header
Configuring Integration Server for JMS Messaging

Must be synchronous (the async input parameter must be set to false).

Must not specify a value for the destinationNameReplyTo input parameter.

Configuring Producer Caching for Sending JMS Messages

When sending a JMS message, Integration Server creates and closes a new JMS Session
object and a JMS MessageProducer object for each message. This can introduce overhead
for some JMS providers. To improve performance when sending JMS messages, you can
congure producer-side pooling. For each JMS connection alias, Integration Server can
create the following:
A default session pool containing JMS Session objects. When a default session pool is
dened for a JMS connection alias, Integration Server draws from a pool of open JMS
Sessions for sending a JMS message instead of opening and closing a JMS Session
for each JMS message. Integration Server uses the default session pool only when
sending a message to a destination that does not have its own pool. When using the
default session pool, Integration Server creates a new MessageProducer each time it
sends a JMS message.
Destination pools containing Session objects and MessageProducer objects for
sending JMS messages to specic destinations. Integration Server creates a pool
for each specied destination. An entry in a destination-specic pool consists of
a Session object and a MessageProducer object. When sending a JMS message
to one of the specied destinations, Integration Server uses a Session object and
MessageProducer object from the pool instead of creating and closing a Session
object and MessageProducer object for each JMS message. For some JMS providers,
creating the Session and MessageProducer objects can be more time-consuming than
sending the JMS message.
Note:

You can only congure a default session pool and destination pools for nontransacted JMS connection aliases.

You can specify the minimum and maximum sizes for the default session pool and all
destination pools. Additionally, you can identify the destinations for which Integration
Server creates specic pools. If the JMS connection alias species the use of a connection
factory object to connect to the JMS provider, you specify a single list of destinations.
If the JMS connection alias species the Native webMethods API for connecting to the
webMethods Broker, you must specify separate lists for the queues and topics for which
you want Integration Server to create destination pools.
For example, suppose that a JMS connection alias named "myAlias" connects to the
webMethods Broker using the Native webMethods API and the elds are set as follows:
Field

Value

Minimum Pool Size

Maximum Pool Size

10

webMethods Integration Server Administrators Guide Version 9.10

291

Even Header
Configuring Integration Server for JMS Messaging

Field

Value

Minimum Pool Size per Destination

Maximum Pool Size per Destination

Queue List

myQueue1;
myQueue2

Topic List

myTopic

Idle Timeout

70000

Using the above information, Integration Server creates a default session pool with a
minimum size of 1 maximum size of 10. This pool contains JUMS Session objects only.
Integration Server uses an entry from the pool when sending a message to destination
that does not have its own pool.
Integration Server also creates three destination pools: one each for the queues
myQueue1 and myQueue2, and one for the topic myTopic. Each of these pools has
a maximum size of 5 pool entries. Messages sent to the destinations myQueue1,
myQueue2, or myTopic will use an entry (a Session object and MessageProducer object)
from the pool created for the destination. Messages sent to other destinations will use a
Session from the default session pool.
An entry in the default or destination-specic pools expires after the entry has been
inactive for over 70000 milliseconds (70 seconds).

Configuring Automatic Retry when Sending JMS Messages Using the

pub.jms:send Service
You can congure a JMS connection alias so that Integration Server automatically retries
a pub.jms:send service that uses the JMS connection alias if the service fails because of a
transient error. To congure automatic retry for instances of the pub.jms:send service that
use a particular JMS connection alias to send messages to the JMS provider, you specify
the following for the alias:
Maximum number of retry aempts.The Max Retry Count eld determines the
maximum number of times that Integration Server will retry a particular pub.jms:send
service. A Max Retry Count of 0 indicates that automatic retry is disabled for the JMS
connection alias.
Interval between retry aempts. The Retry Interval eld determines the number
of milliseconds that Integration Server waits between retry aempts. The default
interval is 1000 milliseconds (1 second).
The JMS connection alias must also meet the following criteria for a pub.jms:send service
that uses the alias to be retried after a transient error:

webMethods Integration Server Administrators Guide Version 9.10

292

Odd Header
Configuring Integration Server for JMS Messaging

The JMS connection alias must be enabled.

The JMS connection alias must have a transaction type of NO_TRANSACTION.
Integration Server will not retry a pub.jms:send service that is executed as part of a
transaction.
If the JMS connection alias species the Broker as the JMS provider, the JMS
connection alias must not use a cluster connection factory to which the multisend
guaranteed policy is applied.
The following table describes the retry process that Integration Server uses the
pub.jms:send service fails because of a transient error and the JMS connection alias is
congured for retry.
Stage

Description

Execution of the pub.jms:send service fails because of a transient

error.

Integration Server waits the length of the retry interval.

Note: If Integration Server begins to shut down while waiting to
retry, Integration Server interrupts the waiting period and
retries the service.
Note: If the JMS connection alias becomes disabled while
Integration Server waits to retry, Integration Server
interrupts the retry process. Depending on whether the
client side queue is enabled for the JMS connection alias,
either writes the JMS message to the client side queue or
throws the original exception that caused the pub.jms:send
service to fail. For more information, see the description for
stage 5, which follows.

Integration Server re-executes the pub.jms:send service.

If the pub.jms:send service fails again because of a transient error

Integration Server repeats steps 2 and 3 until one of the following
occurs:
The pub.jms:send service executes successfully.
Retry failure occurs because the maximum number of retry
aempts have been made.

If retry failure occurs, Integration Server will do one of the

following depending on whether or not the JMS connection alias
uses a client side queue:

webMethods Integration Server Administrators Guide Version 9.10

293

Even Header
Configuring Integration Server for JMS Messaging

Stage

Description
If the client side queue is in use, Integration Server writes the
message created by the pub.jms:send service to the client side
queue.
If the client side queue is not in use, Integration Server throws
the original exception thrown by the JMS provider.
Note: A client side queue is in use if the JMS connection alias
has a Maximum CSQ Size value greater than 0 (zero) and the
useCSQ input parameter is set to true for the pub.jms:send
service.

About Retrying the pub.jms:send Service when webMethods Universal Messaging Is the JMS
Provider
When the JMS connection alias is congured to retry the pub.jms:send service upon
transient error and Universal Messaging is the JMS provider, Integration Server may
make some changes to the local instance of the Universal Messaging connection factory
to prevent or at least delay an exception from being thrown by Integration Server.
Integration Server makes changes so that if Integration Server loses its connection to the
Universal Messaging cluster, Integration Server does not throw an exception right away.
Instead, Universal Messaging suppresses the exception for a period of time. During
this time, Universal Messaging aempts to restore the cluster quorum. Concurrently,
Integration Server aempts to re-establish a connection to Universal Messaging. During
this delay, Integration Server is not notied of the exception and the JMS connection
alias will not be stopped. However, JMS triggers that use the JMS connection alias will
not receive any messages. Additionally, any pub.jms:send services that were in the midst
of using the JMS connection alias to send a message will be retried based on the retry
interval and retry count set for the JMS connection alias. If Universal Messaging cannot
restore a cluster quorum, Integration Server throws the exception. At this point, any JMS
trigger that uses the JMS connection alias will be stopped and any services that send JMS
messages using the JMS connection alias will throw exceptions immediately. Integration
Server then aempts to reconnect to Universal Messaging.
Integration Server makes changes to the Universal Messaging connection factory if
the connection factory has a MaxReconAempts property set to -1. (A value of -1 is
the default and suggests that the MaxReconAempts value has not been changed on
Universal Messaging.) Integration Server makes the following changes to the local
instance of the Universal Messaging connection factory:
Sets ConxExceptionOnFailure to true.
Sets MaxReconAempts to 35.
Sets ReconnectInterval to 2000 milliseconds.
Integration Server makes changes to the local instance of the Universal Messaging
connection factory only. The ConnectionFactory will not be changed on the JNDI

webMethods Integration Server Administrators Guide Version 9.10

294

Odd Header
Configuring Integration Server for JMS Messaging

provider, which means that other clients that use the ConnectionFactory will not be
impacted.
To prevent Integration Server from making changes to the local instance of the Universal
Messaging connection factory, use the Universal Messaging Enterprise Manager to set
the MaxReconAempts property to a value greater than -1.

Editing a JMS Connection Alias

After you create a JMS connection alias, you might need to modify properties of the alias
you created or a default alias. For example, you might want to reduce the amount of
memory that the client side queue can occupy by decreasing the maximum number of
messages that can be placed in the client side queue. You can edit any properties of a
JMS connection alias with the exception of the alias name.
You must disable a JMS connection alias before you can edit it.
To edit a JMS connection alias
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under JMS Conguration, click JMS Settings.
4. In the JMS Connection Alias Denitions list, select the JMS connection alias that you
want to edit. Integration Server Administrator displays details about the connection
alias.
5. Click Edit JMS Connection Alias.
6. Edit the properties of the connection alias. For more information about the elds, see
"Creating a JNDI Provider Alias" on page 271. Note that the Connection Alias Name
eld cannot be modied.
7. Click Save Changes.

Enabling and Disabling a JMS Connection Alias

When a JMS connection alias is enabled, Integration Server can use the alias to obtain
connections, send messages, and receive messages on behalf of services and JMS
triggers. When a connection alias is disabled, Integration Server suspends all JMS
triggers that use the alias. Additionally, any services that use a disabled JMS connection
alias to send or receive messages will end in error.
To enable or disable a JMS connection alias
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under JMS Conguration, click JMS Settings.

webMethods Integration Server Administrators Guide Version 9.10

295

Even Header
Configuring Integration Server for JMS Messaging

4. In the JMS Connection Alias Denitions list, do one of the following in the Enabled
column:
Click No if the alias is disabled and you want to enable it.
If Integration Server cannot enable the alias, it displays a message under the alias
indicating why Integration Server cannot enable the alias.
Click Yes if the alias is enabled and you want to disable it.

Deleting a JMS Connection Alias

Before you delete a JMS connection alias, make sure of the following:
The JMS connection alias is disabled.
No services or JMS triggers rely on the JMS connection alias. If a JMS trigger uses a
JMS connection alias, Integration Server will prevent the JMS connection alias from
being deleted.
To delete a JMS connection alias
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under JMS Conguration, click JMS Settings.
4. In the JMS Connection Alias Denitions list, disable the alias if it is not already
disabled.
5. Locate the alias you want to delete and click the
icon in the Delete eld.
Integration Server displays a dialog box that prompts you to verify your action. Click
OK to verify that you want to delete the JMS connection alias.

Specifying a Connection Monitoring Period

Integration Server periodically checks the state of an active connection to the JMS
provider. You can congure how frequently Integration Server checks the connection
status using the wa.server.jms.connection.monitorPeriod property. The default is 45
seconds.
If the connection between Integration Server and the JMS provider fails, Integration
Server aempts to re-establish the connection automatically after a 20 second delay. You
can congure how long Integration Server waits between aempts to re-establish the
connection by changing the value of the wa.server.jms.connection.retryPeriod property
For more information about server conguration parameters, see "Server Conguration
Parameters" on page 851.

webMethods Integration Server Administrators Guide Version 9.10

296

Odd Header
Configuring Integration Server for JMS Messaging

Specifying a Retry Interval for Failed Connections

When a connection between Integration Server and the JMS provider fails, Integration
Server aempts to re-establish the connection automatically after a 20 second delay.
You can congure how long Integration Server waits between aempts to re-establish
the connection by changing the value of the wa.server.jms.connection.retryPeriod
property. For more information about this property, see "Server Conguration
Parameters" on page 851.

Specifying a Keep-Alive Interval

Integration Server periodically pings the JMS provider to keep the connection between
the Integration Server and the JMS provider active. The ping acts as a keep-alive request.
By default, Integration Server pings the JMS provider every 300 seconds. You can
congure how frequently Integration Server pings the JMS provider by changing the
value of the wa.server.jms.connection.pingPeriod property. For more information
about this property, see "Server Conguration Parameters" on page 851.

Creating Administered Objects

The JMS provider that you select should provide you with the tools to create and
congure administered objects in a JNDI namespace. Integration Server cannot be used
to create and congure administered objects. For more information about working with
administered objects, refer to the product documentation for your chosen JMS provider.

Monitoring a Connection Factory Object for Changes

When you create or edit the JMS connection aliases that use a connection factory object
to establish a connection to the webMethods Broker, you can indicate whether or not
Integration Server monitors the connection factory for changes.
When Integration Server uses a connection factory object to establish a connection to
the webMethods Broker, Integration Server uses JNDI Lookup to create the connection.
After establishing the connection, Integration Server normally does not lookup the
connection factory object again until the connection is restarted. Consequently, in
between connection restarts, the connection does not reect any changes that may have
been made to the connection factory object, such as a change to the cluster policy or a
change to the webMethods Brokers in a cluster. By monitoring the connection factory,
Integration Server can update the related connection automatically after the connection
factory changes.
You can congure Integration Server to monitor the connection factory object in one of
the following ways:

webMethods Integration Server Administrators Guide Version 9.10

297

Even Header
Configuring Integration Server for JMS Messaging

Poll for changes.Integration Server periodically looks up the specied connection

factory object from the JNDI provider and compares it to the connection factory
object used to establish the connection. If Integration Server detects a change, it
refreshes the connection automatically.
Listen for changes.Integration Server registers an event listener with the JNDI provider
to receive notications about changes to the cluster connection factory. When
Integration Server receives notication of a change it refreshes the connection
automatically.
Regardless of the method used to monitor changes, Integration Server aempts to
update and refresh the connection without interrupting any services sending a JMS
message or triggers receiving a JMS message. The following sections provide more
information about the monitoring options.

Polling for Changes

You can congure Integration Server to monitor a connection factory used by an active
connection by polling the JNDI provider for changes. In this situation, Integration
Server periodically compares the connection factory used to create the connection with
the connection factory in the JNDI provider. If Integration Server detects a change, it
refreshes the connection using the new connection factory denition automatically.
Two factors determine how frequently Integration Server polls the JNDI provider for
changes to a connection factory object:
The polling interval specied in the JMS connection alias. You set the polling interval
when you create or edit the JMS connection alias. The minimum polling interval that
you can specify is 1 minute. Alternatively, you can instruct Integration Server to use
the refresh interval specied for the webMethods connection factory object.
The connection monitoring period, which determines how frequently,
Integration Server checks the status of active connections to the webMethods
Broker. The connection monitoring period is determined by the
wa.server.jms.connection.monitorPeriod conguration property.
When the connection monitoring period elapses, Integration Server checks the status
of the JMS connection alias. Integration Server also compares the polling interval to the
time elapsed since the last poll to determine whether to poll for changes to the cluster
connection factory.
To ensure that Integration Server polls for connection factory changes at the specied
interval, the polling interval value should be greater than or equal to the value of the
wa.server.jms.connection.monitorPeriod property. If the value of the polling interval is
less than the value of the wa.server.jms.connection.monitorPeriod property, Integration
Server will not check for connection factory changes at the specied interval.
For example, suppose that a JMS connection alias species a polling interval of 1 minute
and wa.server.jms.connection.monitorPeriod is set to 10 minutes. Because checking
the polling interval and, if necessary, polling for changes, occurs only when Integration

webMethods Integration Server Administrators Guide Version 9.10

298

Odd Header
Configuring Integration Server for JMS Messaging

Server checks the connection, Integration Server polls the cluster connection factory for
changes every 10 minutes.
Note:

If the connection between Integration Server and the webMethods Broker

fails, Integration Server aempts to reconnect to the webMethods Broker at an
interval determined by the wa.server.jms.connection.retryPeriod property.
After Integration Server restores the connection, Integration Server polls
immediately for changes to the cluster connection factory specied in the JMS
connection alias.

Registering an Event Listener

You can monitor a connection factory used by a JMS connection alias for changes by
registering an event listener with the JNDI provider. Specically, Integration Server
registers an event listener to be notied about changes to the connection factory object in
the JNDI namespace. After registering an event listener, Integration Server can receive
notications for change events or error events for the cluster connection factory object.
Note:

Integration Server can register an event listener with any JNDI provider that
supports EventContext interface. The webMethods JNDI provider supports
the EventContext interface.

A change event indicates that changes occurred in the connection factory object used
by the JMS connection alias. When Integration Server receives a change event for the
connection factory object, Integration Server refreshes the connection to the webMethods
Broker using the new cluster connection factory object.
An error event indicates that a NamingExceptionEvent occurred on the JNDI provider. A
NamingExceptionEvent can occur for multiple reasons, one if which is if the connection
between Integration Server and the JNDI provider fails. After a NamingExceptionEvent
occurs, the JNDI provider deregisters the event listener. As part of monitoring the state
of the connection to the webMethods Broker, Integration Server monitors the state of an
event listener. If Integration Server determines that the event listener was deregistered,
Integration Server re-registers the change listener, polls the connection factory object for
changes, and, if necessary, refreshes the connection.
Note:

The value of the wa.server.jms.connection.monitorPeriod conguration

property determines the frequency with which Integration Server checks the
state of an active connection and any registered change listeners. The default
value is 45 seconds.

How Integration Server Updates the Connection

After Integration Server determines that the cluster connection factory changed,
Integration Server suspends all activity associated with the connection established for
the associated JMS connection alias. Then Integration Server updates the connection.
To ensure that in-ight messages are not lost and that duplicate messages are not

webMethods Integration Server Administrators Guide Version 9.10

299

Even Header
Configuring Integration Server for JMS Messaging

introduced, Integration Server completes the following sequence of tasks as part of

updating the connection:
1. Suspends any JMS triggers that use the connection that needs to be restarted. The
JMS trigger does not retrieve any more messages from the webMethods Broker, but
continues processing any messages it has already retrieved. After the JMS trigger
processes all the retrieved messages, Integration Server disables the JMS trigger.
2. Temporarily blocks any new threads for services that send a JMS message using
the JMS connection alias for the connection that needs to be restarted, specically
pub.jms:send, pub.jms:sendAndWait, and pub.jms:reply.
The value of the wa.server.jms.connection.update.blockingTime server
conguration parameter species the maximum amount of time the pub.jms* services
will wait for a connection while the connection used by the service is being updated.
The default is 1000 milliseconds. If Integration Server does not restart the connection
before the blocking time elapses, Integration Server throws an ISRuntimeException.
3. Waits for any pub.jms* services that are in the midst of using the connection to send
JMS messages to execute to completion.
The value of the wa.server.jms.connection.update.restartDelay server conguration
parameter determines how long Integration Server waits for services sending JMS
messages to execute to completion before restarting the connection. If the restart
delay elapses before the pub.jms*services nish executing, Integration Server throws
an ISRuntimeException.
4. Stops the connection for the JMS connection alias.
5. Refreshes the connection using the new cluster connection factory object. Refreshing
the connection eectively enables the JMS triggers.
6. Releases any blocking threads for pub.jms* services.

Configuring Integration Server to Monitor a Connection Factory

Object
Keep the following points in mind when conguring Integration Server to monitor the
connection factory object used by a JMS connection alias.
You can only monitor webMethods Connection Factory objects in a JNDI server.
When monitoring a composite cluster connection factory object, Integration Server
monitors for changes in the composite cluster connection factory object only.
Integration Server does not monitor the constituent cluster connection factory objects
for changes.
To use a change listener to monitor the connection factory, the JNDI provider must
support the EventContext interface.
You can congure Integration Server to use the Poll for changes (interval defined
by webMethods Connection Factory) option when monitoring a cluster or composite
connection factory only.

webMethods Integration Server Administrators Guide Version 9.10

300

Odd Header
Configuring Integration Server for JMS Messaging

When monitoring a connection factory by polling for changes, the frequency with
which Integration Server polls for changes is dependent upon the connection
monitoring period. Integration Server checks the connection at frequency
determined by the connection monitoring period. As part of checking the
connection, Integration Server determines whether the polling interval has elapsed.
If it has, Integration Server polls for changes to the cluster connection factory. If
the polling interval is less than the connection monitoring period (controlled by
wa.server.jms.connection.monitorPeriod parameter), Integration Server does not
poll for changes with the frequency specied by the polling interval.
You must disable a JMS connection alias before you can edit it.
Note:

The procedure below provides instructions for conguring monitoring

for a JMS connection alias that already exists. You can also congure
monitoring at the time you create an alias.

To configure Integration Server to monitor a connection factory

1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under JMS Conguration, click JMS Settings.
4. Under JMS Connection Alias Definitions, select the JMS connection alias for which you
want to monitor the associated connection factory for changes.
5. Click Edit JMS Connection Alias.
6. Under Connection Protocol Seings, in the Monitor webMethods Connection Factory list,
select one of the following:
Select...

To...

No

Indicate that Integration Server will not monitor the

connection factory. This is the default.

Poll for changes (specify

interval)

Monitor the connection factory by polling for changes

at an interval that you specify.

Poll for changes

(interval defined
by webMethods Connection
Factory)

Monitor the connection factory at an interval

determined by the refresh interval specied for the
webMethods Connection Factory object. For more
information about conguring a cluster connection
factory, see Administering webMethods Broker and
webMethods Broker Messaging Programmers Guide.

Register change listener

Monitor the connection factory by registering an event

listener.

webMethods Integration Server Administrators Guide Version 9.10

301

Even Header
Configuring Integration Server for JMS Messaging

7. If you selected Poll for changes (specify interval), in the Polling Interval (minutes), specify
the number of minutes between polling aempts. The polling interval must be a
positive integer. The default value is 60 minutes.
8. Click Save Changes.
Notes
When Integration Server starts the JMS connection alias, Integration Server does the
following:
Veries that the JMS connection alias connects to the webMethods Broker
Veries that the JNDI provider supports the EventContext interface, if the JMS
connection alias monitors the connection factory via an event listener
Integration Server throws a JMSSubsystemException if the any of the above criteria are
not met.

Using SSL with JMS

If the connection between Integration Server and the JMS provider is secured through
SSL, you must congure and enable SSL on the JMS provider.
When connecting to the JMS provider using JNDI (the JMS connection alias species
JNDI Lookup), congure SSL on the JMS provider. Specically, congure the connection
factory that will be used to connect Integration Server to the JMS provider. For more
information, refer to the documentation for the JMS provider.
Some JMS providers require that JMS clients use the JVM default SSL context for the SSL
handshake. To do this, JMS client must set the keystore location, truststore location, and
password information using the javax.net.ssl properties for the JVM. However, these
properties take String values which can result in storing password information in plain
text somewhere on the le system. If you do not want to store password information
in plain text, you can use Integration Server conguration parameters to store the
information needed to establish the SSL context. At start up, Integration Server sets
the javax.net.ssl properties by obtaining the store locations and passwords from the
aliases and then creates the default SSL context. For more information, see "Storing SSL
Information for the Integration Server JVM in a Secure Manner" on page 415.
When connecting to the webMethods Broker using the native webMethods API,
congure SSL information (Keystore, Keystore Type, Truststore, and Truststore Type)
when you create the JMS connection alias.
Note:

If Integration Server connects to the webMethods Broker using JNDI, you

need to congure the connection factory on the webMethods Broker. For more
information, see Administering webMethods Broker.

webMethods Integration Server Administrators Guide Version 9.10

302

Odd Header
Configuring Integration Server for JMS Messaging

Supported JMS Providers

Integration Server can be used with the following JMS providers.
JMS Provider

Version(s)

Apache ActiveMQ

5.4.*

JBoss Messaging

1.4.0 SP3 and higher, up to but not including 2.0

Oracle Streams Advanced

Queuing (AQ)

10.2.* and 11.2.0

SonicMQ

7.5 and 7.6

WebLogic

9.1, 9.2, 10.3, and 12.1.3

webMethods Broker

6.5 and higher

webMethods Universal
Messaging

9.5 and higher

WebSphere MQ

6.0, 7.0, and 7.5

Note:

Make sure to review your JMS provider documentation for information about
any limitations in JMS support.

About Using webMethods Universal Messaging as the JMS Provider

Keep the following points in mind when using Universal Messaging as the JMS
provider:
When using Universal Messaging, you do not need to add any client libraries to
the Integration Server classpath if Integration Server and Universal Messaging
are the same version. In webMethods 9.5 and higher, the Universal Messaging
client libraries are installed in Software AG_directory/common/lib by default. If you
want to connect to an earlier version of Universal Messaging, you must replace the
Universal Messaging client jars installed in Software AG_directory\common\lib. For
more information, see "Adding Client Libraries for Earlier Versions of Universal
Messaging " on page 309.
Integration Server uses synchronous publishing as the default when publishing
persistent messages to Universal Messaging.

webMethods Integration Server Administrators Guide Version 9.10

303

Even Header
Configuring Integration Server for JMS Messaging

When using Universal Messaging as the JMS provider, the JMS client can use
synchronous or asynchronous publishing. With synchronous publishing, the JMS
client sends messages to Universal Messaging one at a time. The JMS client receives
a response indicating a successful send only after the message has been delivered
to Universal Messaging. With asynchronous publishing, the JMS messages are
placed in a buer and then sent to Universal Messaging in batches. However, the
JMS client can receive a response indicating a successful send before the message is
actually delivered to Universal Messaging. Asynchronous publishing is faster than
synchronous publishing, but messages can be lost in the event the connection to
Universal Messaging fails or Integration Server becomes unavailable. The default
for a JMS client using Universal Messaging as the JMS provider is asynchronous
publishing. This default applies to all messages regardless of a persistent or nonpersistent delivery mode. However, to ensure delivery of a persistent message,
Integration Server always uses synchronous publishing to send a persistent JMS
message to Universal Messaging.
Message priority is not supported when Universal Messaging is the JMS provider.
Any priority assigned to a JMS message sent to Universal Messaging will be ignored.
If you are using Universal Messaging as the JMS provider and you want to use
durable subscribers, make sure to select the Shared Durable option when creating
a ConnectionFactory or TopicConnectionFactory using Universal Messaging
Enterprise Manager. For example, when creating a ConnectionFactory, select the
option named Connection Factory (Shared Durable).
When an Integration Server JMS connection alias is connected to a cluster of
Universal Messaging realm servers and the master realm server in the cluster
goes down, Integration Server stops the alias. This causes all JMS triggers
associated with the alias to stop, and all JMS sending services to fail with a
ResourceUnavailableException. The alias automatically reconnects to the cluster if
and when the cluster is able to reconcile itself (that is, the cluster is able to reelect a
new master realm server).
Integration Server enforces minimum values for the server conguration properties
that control the polling intervals for JMS triggers when Universal Messaging is
the JMS provider. The default values for these parameters are not optimal when
connecting to Universal Messaging. Lower polling intervals, including the default
values, can result in high CPU utilization on the Universal Messaging server and do
not provide a performance benet when working with Universal Messaging.
Parameter

Minimum value used with Universal Messaging

wa.server.jms.trigger.concurrent.
primaryThread.pollingInterval

3000 milliseconds

wa.server.jms.trigger.concurrent.
secondaryThread.pollingInterval

3000 milliseconds if the concurrent JMS

trigger does not use a join

webMethods Integration Server Administrators Guide Version 9.10

304

Odd Header
Configuring Integration Server for JMS Messaging

Parameter

Minimum value used with Universal Messaging

10 milliseconds if the concurrent JMS
trigger uses a join

wa.server.jms.trigger.serial.
primaryThread.pollingInterval

3000 milliseconds
Note:If the serial JMS trigger uses a join,
Integration Server uses a secondary
polling interval which is set to 10
milliseconds. Note that the secondary
polling interval is not congurable for a
serial JMS trigger.

You can increase the polling intervals by changing the server conguration
parameters. Keep in mind that the values you specify will be used with all JMS
providers. Integration Server only enforces a minimum when connecting to
Universal Messaging.
JMS triggers that use joins might aect the CPU utilization for Universal Messaging
even with the minimum values mentioned above. This is because the secondary
polling interval is low (10 milliseconds). The secondary polling interval needs to
be low so that the JMS trigger can quickly retrieve messages from the dierent
destinations. To reduce the impact on Universal Messaging, consider one of the
following approaches:
For a concurrent JMS trigger, congure the JMS connection alias used by the
trigger to use multiple connections and then set the JMS trigger Connection count
property to a value that is evenly divisible by the number of destinations. For
example, if a JMS trigger retrieves messages from two destinations, set Connection
count to 2, 4, 6, 8, and so on. If the JMS trigger retrieves messages from three
destinations, set Connection count to 3, 6, 9, and so on.
For a serial or concurrent JMS trigger, instead of using a join for the JMS trigger,
use a Universal Messaging channel join to gather messages from dierent
destinations into a single destination on the Universal Messaging server.

Adding JMS Provider Client Libraries to Integration Server

Classpath
Integration Server requires access to some of the JMS provider's Java client libraries. You
can do one of the following:
Place the libraries in the server's classpath by placing them in the
Integration Server_directory\instances\instance_name \lib\jars\custom directory, as
described in the procedure below.

webMethods Integration Server Administrators Guide Version 9.10

305

Even Header
Configuring Integration Server for JMS Messaging

Make the libraries available to all server instances by placing them in the
Integration Server_directory\lib\jars\custom directory.
Note:

Files located in the servers classpath take precedence over the les located
at the Integration Server_directory\lib\jars\custom directory.

Isolate the jars within a package classloader by placing them in the following
directory: packageName \code\jars.
If you place the les in the package classloader, make sure to set the Class Loader
property when conguring a JMS connection alias to this JMS provider.
The JMS provider's .jar les could potentially conict with other webMethods
components running under Integration Server. If you encounter a conict, consider
using a package class loader instead.
Note:

The webMethods Broker and JNDI provider .jar les are already included
in Integration Server. The Universal Messaging .jar les are included in
Software AG_directory/common/lib. If you want to use Integration Server
with a lower, supported version of Universal Messaging, you must manually
replace versions in Software AG_directory/common/lib with those from the
earlier version. For more information, see "Adding Client Libraries for Earlier
Versions of Universal Messaging " on page 309.

To add a third party JMS provider's JMS and JNDI libraries to the Integration Server classpath
1. Copy your JMS provider's Java API libraries from the locations specied below and
place them in Integration Server_directory \instances\instance_name \lib\jars\custom
directory.
JMS Provider
Apache ActiveMQ

Files to Copy
ActiveMQ_HOME \activemq-all-5.4.*.jar
Where ActiveMQ_HOME is the directory in which
Apache ActiveMQ is installed

JBoss Messaging

jboss-messaging-client.jar (This is available in the

JBoss Messaging distribution.)
JBOSS_HOME\ client\jbossall-client.jar
JBOSS_HOME \server\SERVER_NAME \deploy
\jboss-aop.deployer\jboss-aop.jar
JBOSS_HOME \server\SERVER_NAME \lib
\javassist.jar
JBOSS_HOME \server\SERVER_NAME \lib
\trove.jar

webMethods Integration Server Administrators Guide Version 9.10

306

Odd Header
Configuring Integration Server for JMS Messaging

JMS Provider

Files to Copy
Where JBOSS_HOME is the directory in which JBoss
is installed and SERVER_NAME is the name of the
messaging server
Note: JBoss Messaging 1.4.0 requires a patched version
of jboss-remoting.jar.

Oracle Streams
Advanced Queuing
(AQ)

For Oracle Streams Advanced Queuing (AQ) 10.2.*:

ORACLE_HOME \jdbc\lib\classes12.jar
ORACLE_HOME \jlib\orai18n.jar
ORACLE_HOME \lib\xmlparserv2.jar
ORACLE_HOME \rdbms\jlib\xdb.jar
ORACLE_HOME \rdbms\jlib\aqapi13.jar
ORACLE_HOME \rdbms\jlib\jmscommon.jar
Where ORACLE_HOME is ORACLE_BASE \product
\10.2.0\db_1 and ORACLE_BASE is the directory in
which the Oracle database is installed.
For Oracle Streams Advanced Queuing (AQ) 11.2.0:
ORACLE_HOME \jlib\orai18n.jar
ORACLE_HOME \lib\xmlparserv2.jar
ORACLE_HOME \rdbms\jlib\xdb.jar
ORACLE_HOME \rdbms\jlib\aqapi.jar
ORACLE_HOME \rdbms\jlib\jmscommon.jar
ORACLE_HOME \rdbms\jlib\ ojdbc6.jar
Where ORACLE_HOME is ORACLE_BASE \product
\11.2.0\db_1 and ORACLE_BASE is the directory in
which the Oracle database is installed.
Note: If you are using Oracle Streams Advanced
Queuing (AQ) 11.2.0 as the JMS provider,
the value of the wa.cong.systemProperties
property must include
"oracle.jms.conservativeNavigation=true".

SonicMQ

For SonicMQ version 7.5:

SonicMQ_directory \lib\mfcontext.jar

webMethods Integration Server Administrators Guide Version 9.10

307

Even Header
Configuring Integration Server for JMS Messaging

JMS Provider

Files to Copy
SonicMQ_directory \lib\sonic_Client.jar
SonicMQ_directory \lib\sonic_Crypto.jar
SonicMQ_directory \lib\sonic_mgmt_client.jar
SonicMQ_directory \lib\sonic_Selector.jar
SonicMQ_directory \lib\sonic_XA.jar
For SonicMQ version 7.6, all of the above, plus:
SonicMQ_directory \lib\mgmt_client.jar
SonicMQ_directory \lib\mgmt_cong.jar
SonicMQ_directory \lib\sonic_XMessage.jar
Where SonicMQ_directory is the directory in which
SonicMQ is installed.

WebLogic

For WebLogic 9.1 and 9.2:

WebLogic_directory \server\lib\weblogic.jar
For WebLogic 10.3 and 12.1.3:
WebLogic_directory \server\lib\wljmsclient.jar
WebLogic_directory \server\lib\wlnmclient.jar
WebLogic_directory \server\lib\wlclient.jar
Where WebLogic_directory is the directory in which
WebLogic is installed.

WebSphere MQ

For WebSphere MQ version 6.0:

WebSphereMQ \Java\lib\com.ibm.mq.jar
WebSphereMQ \Java\lib\com.ibm.mqjms.jar
For WebSphere MQ version 7.0, all of the above plus:
WebSphereMQ \Java\lib\com.ibm.mq.jmqi.jar
WebSphereMQ \Java\lib\dhbcore.jar
For WebSphere MQ version 7.5, all of the above plus:
WebSphereMQ \Java\lib\com.ibm.mq.headers.jar
WebSphereMQ \Java\lib\com.ibm.mq.pcf.jar
WebSphereMQ \Java\lib
\com.ibm.mq.commonservices.jar

webMethods Integration Server Administrators Guide Version 9.10

308

Odd Header
Configuring Integration Server for JMS Messaging

JMS Provider

Files to Copy
Where WebSphereMQ is the directory in which your
WebSphere MQ is installed.

2. Restart Integration Server.

Note:

The list of les for each JMS provider is a general guideline. The
requirements for each JMS provider may change. Make sure to review
the documentation for your JMS provider to determine an exact list of
required jar les.

Adding Client Libraries for Earlier Versions of Universal Messaging

When using Integration Server with the same version of Universal Messaging, you
do not need to add any client libraries to the Integration Server classpath. However,
if you want to use Integration Server with an earlier, supported version of Universal
Messaging, you must manually replace les in Software AG_directory\common\lib with
the those available in the version of Universal Messaging that you want to use.
Note:

If you want to use Integration Server with an earlier version of Universal

Messaging, Software AG recommends that you install Integration Server in a
directory by itself without any other Software AG products.

To replace client libraries with those from earlier versions of Universal Messaging
1. Copy the following les from the Software AG_directory \common\lib directory that
contains the installed version of Universal Messaging that you want to use.
nAdminAPI.jar
nAdminXMLAPI.jar
nclient.jar
nDeployer.jar
nJ2EE.jar
nJMS.jar
nP2P.jar
2. Place the copied les in the Software AG_directory \common\lib directory used by
Integration Server.
3. Restart Integration Server.

webMethods Integration Server Administrators Guide Version 9.10

309

Even Header

webMethods Integration Server Administrators Guide Version 9.10

310

Odd Header
Configuring Endpoint Aliases for Web Services

13 Configuring Endpoint Aliases for Web Services

Overview .....................................................................................................................................

312

Creating an Endpoint Alias for a Provider Web Service Descriptor for Use with HTTP/S ..........

313

Creating an Endpoint Alias for a Consumer Web Service Descriptor for Use with HTTP/S .......

320

Creating an Endpoint Alias for Message Addressing for Use with HTTP/S ...............................

331

Creating an Endpoint Alias for a Provider Web Service Descriptor for Use with JMS ...............

338

Creating an Endpoint Alias for a Consumer Web Service Descriptor for Use with JMS ............

344

Creating an Endpoint Alias for Message Addressing for Use with JMS ....................................

352

Timestamps in the WS-Security Header ....................................................................................

359

webMethods Integration Server Administrators Guide Version 9.10

311

Even Header
Configuring Endpoint Aliases for Web Services

Overview
A web service endpoint alias represents the network address and, optionally, any
security credentials to be used with web services. You can use the network address
properties to enable dynamic addressing for web services. The security credentials can
be used to control both transport-level and message-level security for web services.
In web service descriptors (WSD), an endpoint alias is associated with a binder. For
more information about associating an endpoint alias with a binder, see webMethods
Service Development Help.
For a consumer web service descriptor (WSD) and its associated web service connectors
(WSC), the alias information (including the addressing information and any security
credentials), is used at run time to generate a request and invoke an operation of the web
service.
For a provider WSD, the endpoint alias is used to construct the "location=" aribute
of the address element (which is contained within the port element) when WSDL is
requested for the web service. The security credentials might be used when constructing
a response to a web service request.
When you create a provider WSD, you can specify an existing endpoint alias, which
will be displayed (and can be changed) from the default binder of the WSD. Integration
Server uses a binder to collect the denitions for addresses, communication protocols,
and data formats for a particular port type in one container.
Integration Server uses message addressing endpoint aliases to send responses to
endpoints other than the one that initiated or sent the request. That is, when WSAddressing is enabled and the request SOAP message contains a non-anonymous
ReplyTo or FaultTo endpoint, Integration Server uses the message addressing endpoint
alias to determine the authentication details to be used to send a response to the ReplyTo
and FaultTo endpoints.
An endpoint alias is usually created for one or more of the following reasons:
Dynamic endpoint addressing. Because the actual value of the endpoint is looked up
at run time, using an endpoint alias saves you from having to specify or change the
server information each time you use the web service.
Security. An endpoint alias is required in order to congure WS-Security for web
service providers and consumers. For information about implementing WS-Security,
see the information about WS-Security in the Web Services Developers Guide.
WS-Addressing. Using the message addressing properties, you can specify the
authentication credentials required to send a response to a dierent address
than the request. The message addressing properties dene the WS-Addressing
information that can be aached to the SOAP message. For more information about
WS-Addressing, see Web Services Developers Guide.
WS-ReliableMessaging. Reliable messaging properties ensure the reliable delivery
of the message between the two endpoints (web service and client or reliable
webMethods Integration Server Administrators Guide Version 9.10

312

Odd Header
Configuring Endpoint Aliases for Web Services

messaging source and destination). You can congure reliable messaging properties
specic to a web service endpoint or at a global level for all web service endpoints
dened in the Integration Server.
When you create web service endpoint aliases, keep the following points in mind:
Alias names must be unique within the specied usage (provider or consumer)
and protocol. This can result in multiple endpoint aliases with the same name. For
example, you can have a provider alias named "aliasOne" for the HTTP protocol.
You could also have a consumer alias named "aliasOne" for the HTTP protocol and a
provider alias named "aliasOne" for the HTTPS protocol.
Integration Server saves web service endpoint aliases at the following location:
Integration Server_directory\instances\instance_name \cong\endpoints
The host name and port are required for a provider HTTP/S web service endpoint
alias, but are optional for a consumer HTTP/S web service endpoint alias.
If the Integration Server on which a consumer WSD resides sits behind a rewall and
the web service request needs to be routed through a proxy server, you can assign a
proxy alias to the consumer web service endpoint alias.

Creating an Endpoint Alias for a Provider Web Service

Descriptor for Use with HTTP/S
When creating a web service endpoint alias for provider web service descriptor that
uses an HTTP/S binder, you need to supply information that falls into the following
categories:
Web Service Endpoint Alias. Endpoint name, description, and transport type.
HTTP/S Transport Properties. Server on which the web service resides.
WS Security Properties. Information the SOAP processor needs to decrypt and verify
the inbound SOAP request and/or encrypt and sign the outbound SOAP response
and the details for adding the timestamp information.
Note:

WS-Security credentials such as private keys and public keys do not

always need to be provided in a web service endpoint alias. If this
information is not provided in the alias, Integration Server can obtain
the information from other locations. For more information about usage
and resolution order of certicates and keys for WS-Security, see the
Web Services Developers Guide.

Message Addressing Properties. WS-Addressing information that Integration Server

uses to generate the WS-Addressing headers of the SOAP requests and responses.
This includes the destination address of a message or fault and the authentication
credentials required to send a response to a dierent address than the one from
which request was received.

webMethods Integration Server Administrators Guide Version 9.10

313

Even Header
Configuring Endpoint Aliases for Web Services

Reliable Messaging Properties. Reliable messaging information specic to the web

service endpoint. By default, Integration Server applies the reliable messaging
conguration dened on the Settings > Web Services > Reliable Messaging > Edit
Configuration page to all web service providers and consumers. If you want to
override the server-level reliable messaging conguration for a specic web service
provider or consumer, dene reliable messaging properties for the associated web
service endpoint alias.
To create a WS provider web service endpoint alias for use with HTTP/S
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > Web Services.
3. Click Create Web Service Endpoint Alias.
4. Under Web Service Endpoint Alias Properties, provide the following information:
In this field...

Specify...

Alias

A name for the provider web service endpoint alias.

The alias name cannot include the following illegal characters:
# \ & @ ^ ! % * : $ . / \ \ ` ; , ~ + = ) ( | } { ] [ > < "

Description

A description for the endpoint alias.

Type

Provider

Transport Type

Specify the transport protocol used to access the web service.

Select one of the following:
HTTP
HTTPS

5. Under TransportType Transport Properties, provide the following information:

In this field...

Specify...

Host Name or IP
Address

Host name or IP address of the Integration Server for which

you are creating an alias.
If the host Integration Server is fronted by a proxy, specify the
host name or IP address of the proxy server.

Port

An active HTTP or HTTPS listener port dened on the

Integration Server specied in the Host Name or IP Address eld.

webMethods Integration Server Administrators Guide Version 9.10

314

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
If the host Integration Server is fronted by a proxy, specify the
port for the proxy server.

6. Under WS Security Properties, if the inbound SOAP request must be decrypted and/or
the outbound SOAP request must be signed, do the following:
In this field...

Specify...

Keystore Alias

Alias of the keystore containing the private key used to

decrypt the inbound SOAP request or sign the outbound
SOAP response.
The provider must have already given the consumer the
Important:
corresponding public key.

Key Alias

Alias of the private key used to decrypt the request or sign the
response. The key must be in the keystore specied in Keystore
Alias.

7. Under WS Security Properties, if the signing certicate chain of an inbound signed

SOAP message has to be validated, specify the following:
In this field...

Specify...

Truststore Alias

The alias for the truststore that contains the list of CA

certicates that Integration Server uses to validate the trust
relationship.

8. Under WS Security Properties, set the timestamp properties that Integration Server
uses when working with timestamps.
In this field...

Specify...

Timestamp
Precision

Whether the timestamp is precise to the second or millisecond.

If you set the precision to milliseconds, Integration Server uses
the timestamp format yyyy-MM-dd'T'HH:mm:ss:SSS'Z'. If
you set the precision to seconds, Integration Server uses the
timestamp format yyyy-MM-dd'T'HH:mm:ss'Z'.
If you do not select a precision value, Integration
Server will use the value specied for the
wa.server.ws.security.timestampPrecisionInMilliseconds
parameter.

webMethods Integration Server Administrators Guide Version 9.10

315

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...

Timestamp Time
to Live

The time-to-live value for the outbound message in seconds.

Integration Server uses the Timestamp Time to Live value to
set the expiry time in the Timestamp element of outbound
messages. The time-to-live value must be an integer greater
than 0.
If you do not specify a Timestamp Time to Live value,
Integration Server will use the value specied for the
wa.server.ws.security.timestampTimeToLive parameter.

Timestamp
Maximum Skew

The maximum number of seconds that the web services client

and host clocks can dier and still allow timestamp expiry
validation to succeed. Specify a positive integer or zero.
Integration Server uses the timestamp maximum skew value
only when you implement WS-Security via a WS-Policy.
Integration Server validates the inbound SOAP message only
when the creation timestamp of the message is less than the
sum of the timestamp maximum skew value and the current
system clock time.
If you do not specify a timestamp maximum skew value,
Integration Server will use the value specied for the
wa.server.ws.security.timestampMaximumSkew parameter.

For more information about timestamps in the WS-Security header, see "Timestamps
in the WS-Security Header" on page 359.
9. Under Kerberos Properties, provide the following Kerberos-related details that will be
used for all providers that use this endpoint alias.
Note:

These elds are available only for provider endpoint aliases using the
HTTPS transport type.

In this field...

Specify...

JAAS Context

The custom JAAS context used for Kerberos authentication.

In the following example, JAAS Context is
WS_KERBEROS_INBOUND:
WS_KERBEROS_INBOUND {
com.sun.security.auth.module.Krb5LoginModule required
refreshKrb5Config=true storeKey=true isInitiator=false debug=true;
};

webMethods Integration Server Administrators Guide Version 9.10

316

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
The is_jaas.cnf le distributed with Integration Server includes
a JAAS context named IS_KERBEROS_INBOUND that can be
used with inbound requests.

Principal

The name of the principal to use for Kerberos authentication.

Principal
Password

The password for the principal that is used to authenticate the

principal to the KDC. Specify the principal password if you
do not want to use the keytab le that contains the principals
and their passwords for authorization. The passwords may be
encrypted using dierent encryption algorithms. If the JAAS
login context contains useKeyTab=false, you must specify the
principal password.

Retype Principal
Password

The above principal password.

Service
Principal Name
Format

Select the format in which you want to specify the principal

name of the service that is registered with the principal
database.
Select...

To...

host-based

Represent the principal name using the service

name and the hostname, where hostname is the
host computer.
This is the default.

username

Service
Principal Name

Represent the principal name as a named user

dened in the LDAP or central user directory
used for authentication to the KDC.

The name of the principal for the service that the Kerberos
client wants to access. This can be obtained from the WSDL
document published by the provider of the Kerberos service.
Specify the Service Principal Name in the following format:
principal-name.instance-name@realm-name

10. Under Message Addressing Properties, provide the following addressing information
relating to the delivery of the message. The message addressing properties dene the
addressing information that can be aached to the SOAP message.

webMethods Integration Server Administrators Guide Version 9.10

317

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...

To

URI of the destination of the SOAP message.

In the Reference Parameters eld, specify
additional parameters, if any, that correspond to
<wsa:ReferenceParameters> properties of the endpoint
reference to which the message is addressed. Optionally,
you can specify metadata (such as WSDL or WS-Policy)
about the service in the Metadata Elements eld. You can
also specify Extensible Elements, which are elements other
than those specied as part of the Metadata and Reference
Parameters.
You can specify more than one reference parameter,
metadata element, or extensible element. Click the + icon
to add more rows and the x icon to delete the rows.

Response Map

Address to which the provider will send the reply or fault

message and the corresponding message addressing alias.
Integration Server retrieves the authentication details
needed to send the response from the message addressing
alias mapped to the address.
In the Address eld, specify the URI to which the provider
will send the reply or the fault message.
From the Message Addressing Alias list, select the message
addressing endpoint alias from which Integration Server
will retrieve the authentication details. Integration Server
uses the authentication details to send the response to the
ReplyTo or FaultTo endpoints.
Click the + icon to add more rows and the x icon to delete
the rows.

11. Under Reliable Messaging Properties, check Enable to provide reliable messaging
information specic to the endpoint alias you are creating.
12. Provide the following reliable-messaging information to ensure reliable delivery of
the message between a reliable messaging source and destination.
In this field...

Specify...

Retransmission
Interval

The time interval (in milliseconds) for which a reliable

messaging source waits for an acknowledgement from the
reliable messaging destination before retransmiing the
SOAP message. The default is 6000 milliseconds.

webMethods Integration Server Administrators Guide Version 9.10

318

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...

Acknowledgement
Interval

The time interval (in milliseconds) for which the

reliable messaging destination waits before sending an
acknowledgement for a message sequence. Messages
of the same sequence received within the specied
acknowledgement interval are acknowledged in one
batch. If there are no other messages to be sent to the
acknowledgement endpoint within the time specied as the
acknowledgement interval, the acknowledgement is sent as a
stand-alone message.
The default is 3000 milliseconds.

Exponential
Backoff

Maximum
Retransmission
Count

Whether to use the exponential backo algorithm to adjust

the retransmission interval of unacknowledged messages.
Adjusting the time interval between retransmission aempts
ensures that a reliable messaging destination does not get
ooded with a large number of retransmied messages.
Select...

To...

true

Increase the successive retransmission

intervals exponentially, based on the specied
retransmission interval. For example, if the
specied retransmission interval is 2 seconds,
and the exponential backo value is set to true,
successive retransmission intervals will be 2, 4,
8, 16, 32, and so on if messages continue to be
unacknowledged. This is the default.

false

Use the same time interval specied in

the Retransmission Interval eld for all
retransmissions.

The number of times the reliable messaging source must

retransmit a message if an acknowledgement is not received
from the reliable messaging destination. To specify that there
is no limit to the number of retransmission aempts, set the
value of Maximum Retransmission Count to -1. The default is 10.

13. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

319

Even Header
Configuring Endpoint Aliases for Web Services

Creating an Endpoint Alias for a Consumer Web Service

Descriptor for Use with HTTP/S
When you create an HTTP/S web service endpoint alias for use with consumer web
service descriptors, you need to supply information that falls into the following
categories:
Web Service Endpoint Alias. Endpoint name, description, and transport type.
HTTP/S Transport Properties.Optional. The host and port used to build the endpoint
URL. If the web service provider requires transport-based authentication, these
properties specify the authentication credentials to be added to the HTTP/S header.
For HTTPS transport, these properties specify the keystore alias and key alias of the
private key used for SSL communication with the web service provider. If the web
service request must be routed through a proxy server, these properties specify the
proxy server alias for the proxy server through which Integration Server routes the
HTTP/S request.
WS Security Properties. Information for the WS-Security header as determined by the
security policy for the web service. A web service security policy can require that:
SOAP message requests include a UserName token.
SOAP message responses be decrypted.
SOAP message requests be signed.
X.509 authentication be supported.
A Timestamp element be added to the security header.
Note:

WS-Security credentials such as private keys and public keys do not

always need to be provided in a web service endpoint alias. If this
information is not provided in the alias, Integration Server can obtain
the information from other locations. For more information about usage
and resolution order of certicates and keys for WS-Security, see the
Web Services Developers Guide.

Message Addressing Properties. Addressing information about the response delivery.

This information includes the reply endpoint where the replies should be sent, the
fault endpoint that species where the faults should be sent, and optional metadata
(such as WSDL or WS-Policy) about the service. This also includes additional
parameters, called Reference Parameters, that Integration Server uses to route the
message to the destination.
Reliable Messaging Properties. Provides reliable messaging information specic
to the web service endpoint. By default, Integration Server applies the reliable
messaging conguration dened on the Settings > Web Services > Reliable Messaging
> Edit Configuration page to all web service providers and consumers. If you want to
override the server-level reliable messaging conguration for a specic web service
webMethods Integration Server Administrators Guide Version 9.10

320

Odd Header
Configuring Endpoint Aliases for Web Services

provider or consumer, dene reliable messaging properties for the associated web
service endpoint alias.
To create a consumer web service endpoint alias for use with HTTP/S
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > Web Services.
3. Click Create Web Service Endpoint Alias.
4. Under Web Service Endpoint Alias Properties, provide the following information:
In this field...

Specify...

Alias

A name for the provider web service endpoint alias.

The alias name cannot include the following illegal characters:
# \ & @ ^ ! % * : $ . / \ \ ` ; , ~ + = ) ( | } { ] [ > < "

Description

A description for the endpoint alias.

Type

Consumer

Transport Type

Specify the transport protocol used to access the web service.

Select one of the following:
HTTP
HTTPS

Execute ACL

ACL that governs which user groups on your server can use
this web service endpoint alias. Select an ACL from the drop
down list. By default, only members of groups governed by
the Internal ACL can use this alias.
Integration Server performs the ACL check only if the specic
endpoint alias is used as the value of the endpointAlias input
parameter in a web service connector or the pub.client:soapClient
service. Integration Server does not perform the ACL check
when the consumer web service endpoint alias is assigned to a
binder used by the web service connector.

5. Under TransportType Transport Properties, provide the following information if you

want to overwrite the host and/or port information in the WSDL with the host and/
or port information in the web service endpoint alias. For more information about
how Integration Server builds the endpoint URL, see webMethods Service Development
Help.

webMethods Integration Server Administrators Guide Version 9.10

321

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...

Host Name or IP
Address

Host name or IP address of the server on which the web

service resides.

Port Number

An active HTTP or HTTPS type listener port dened on the

host server specied in the Host Name or IP Address eld.

Authentication Type

Specify the type of authentication you want to use to

authenticate the consumer.
Select...

To...

Basic

Use basic authentication (user name and

password) to authenticate the consumer.

Digest

Use password digest to authenticate the

consumer.

NTLM

Use NTLM authentication so that clients

that are already logged into a domain
can be authenticated using their existing
credentials.

6. If you are conguring the web service endpoint for transport-based authentication
such as HTTPS, specify all or a combination of the following optional elds:
In this field...

Specify...

User Name

User name used to authenticate the consumer at the HTTP or

HTTPS transport level on the host server.

Password

The password used to authenticate the consumer on the host

server.

Retype
Password

Re-enter the above password.

Keystore Alias

Alias to the keystore that contains the private key used to

connect to the web service host securely.
This eld applies to the HTTPS transport type only.

webMethods Integration Server Administrators Guide Version 9.10

322

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...

Key Alias

Alias to the key in the keystore that contains the private key
used to connect to the web service host securely. The key must
be in the keystore specied in Keystore Alias.
This eld applies to the HTTPS transport type only.

7. If web service requests must be sent through a proxy server, in the Proxy Alias eld,
do one of the following to specify which proxy server Integration Server uses:
If you want Integration Server to use a particular proxy server, select the alias for
that proxy server. Integration Server lists all the congured HTTP/S and SOCKS
proxy aliases in the Proxy Alias eld.
If you want Integration Server to use the default proxy server, leave this eld
blank.
For more information about how Integration Server uses proxy servers when
sending requests, see "How Integration Server Uses Proxy Servers" on page 121.
8. Under WS Security Properties, provide the following information if the WS-Security
policy for this consumer web service descriptor requires that SOAP message requests
include a UsernameToken, enter values for the following elds:
In this field...

Specify...

User Name

The user name to include with the UsernameToken.

Password

The password to include with the UsernameToken (must be

plain text).

Retype
Password

Re-enter the above password.

9. If the security policy (or policies) that will be used by this web service requires
its requests to be signed, requires an X.509 authentication token to be included, or
requires that SOAP message responses be encrypted, specify the following:
In this field...

Specify

Keystore Alias

Alias to the keystore that contains the private key used to:
Sign outbound SOAP requests
Include an X.509 authentication token for outbound SOAP
requests
Decrypt inbound SOAP responses

webMethods Integration Server Administrators Guide Version 9.10

323

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify
To verify messages from this consumer, the
Important:
web services provider must have a copy of the
corresponding public key.

Key Alias

Alias to the private key used to sign and/or include X.509

authentication token for outbound SOAP messages and/or
decrypt inbound SOAP responses. The key must be in the
keystore specied in Keystore Alias.

10. Under WS Security Properties, specify the provider's certicate le. This certicate
is used to encrypt the outbound SOAP request and/or verify the inbound SOAP
response.
In this field...

Specify

Partner's Certificate

The path and le name of the provider's certicate, which

contains its public key.

11. Under WS Security Properties, if the security policy (or policies) that will be used
by this web services consumer requires that responses be validated by a trusted
authority, specify the following:
In this field...

Specify

Partner's Certificate

Path and le name of the le containing the provider's

certicate.

Truststore Alias

The alias for the truststore that contains the list of CA

certicates that Integration Server uses to validate the trust
relationship.

12. Under WS Security Properties, congure how Integration Server handles timestamps in
the security headers.
In this field...

Specify...

Timestamp
Precision

Whether the timestamp is precise to the second or millisecond.

If you set the precision to milliseconds, Integration Server uses
the timestamp format yyyy-MM-dd'T'HH:mm:ss:SSS'Z'. If
you set the precision to seconds, Integration Server uses the
timestamp format yyyy-MM-dd'T'HH:mm:ss'Z'.
If you do not select a precision value, Integration
Server will use the value specied for the

webMethods Integration Server Administrators Guide Version 9.10

324

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
wa.server.ws.security.timestampPrecisionInMilliseconds
parameter.

Timestamp Time
to Live

The time-to-live value for the outbound message in seconds.

Integration Server uses the Timestamp Time to Live value to
set the expiry time in the Timestamp element of outbound
messages. The Timestamp Time to Live value must be an integer
greater than 0.
If you do not specify a time-to-live value, Integration
Server will use the value specied for the
wa.server.ws.security.timestampTimeToLive parameter.

Timestamp
Maximum Skew

The maximum number of seconds that the web services client

and host clocks can dier and still allow timestamp expiry
validation to succeed. Specify a positive integer or zero.
Integration Server uses the timestamp maximum skew value
only when you implement WS-Security via a WS-Policy.
Integration Server validates the inbound SOAP message only
when the creation timestamp of the message is less than the
sum of the timestamp maximum skew value and the current
system clock time.
If you do not specify a timestamp maximum skew value,
Integration Server will use the value specied for the
wa.server.ws.security.timestampMaximumSkew parameter.

For more information about timestamps in the WS-Security header, see "Timestamps
in the WS-Security Header" on page 359.
13. Under Kerberos Properties, provide the following Kerberos-related details that will be
used for all web service requests that use this endpoint alias.
Note:

These elds are available only for consumer endpoint aliases using HTTPS
transport type.

In this field...

Specify...

JAAS Context

The custom JAAS context used for Kerberos authentication.

In the following example, JAAS Context is KerberosClient:
KerberosClient {
com.sun.security.auth.module.Krb5LoginModule required
useKeyTab=true keyTab=alice.keytab;
};

webMethods Integration Server Administrators Guide Version 9.10

325

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
The is_jaas.cnf le distributed with Integration Server includes
a JAAS context named IS_KERBEROS_OUTBOUND that can
be used with inbound requests.

Principal

The name of the principal to use for Kerberos authentication.

Principal
Password

The password for the principal that is used to authenticate the

principal to the KDC. Specify the principal password if you
do not want to use the keytab le that contains the principals
and their passwords for authorization. The passwords may be
encrypted using dierent encryption algorithms. If the JAAS
login context contains useKeyTab=false, you must specify the
principal password.

Retype Principal
Password

The above principal password.

Service
Principal Name
Format

Select the format in which you want to specify the principal

name of the service that is registered with the principal
database.
Select...

To...

host-based

Represent the principal name using the service

name and the hostname, where hostname is the
host computer.
This is the default.

username

Service
Principal Name

Represent the principal name as a named user

dened in the LDAP or central user directory
used for authentication to the KDC.

The name of the principal for the service that the Kerberos
client wants to access. This can be obtained from the WSDL
document published by the provider of the Kerberos service.
Specify the Service Principal Name in the following format:
principal-name.instance-name@realm-name

14. Under Message Addressing Properties, provide the following addressing information
relating to the delivery of a message to a web service. The message addressing
properties dene the addressing information that can be aached to the SOAP
message.

webMethods Integration Server Administrators Guide Version 9.10

326

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...

Must
Understand

Whether the recipients (the actor or role to which the header is

targeted) are required to process the WS-Addressing headers.
Recipients that cannot process a mandatory WS-Addressing
header reject the message and return a SOAP fault.
Must Understand determines the mustUnderstand aribute of
the WS-Addressing headers.
Select...

To...

True

Indicate that processing the WS-Addressing

headers is required by the recipients.
If you select True for Must Understand and the
SOAP node receives a header that it does not
understand or cannot process, it returns a fault.

False

Indicate that processing the WS-Addressing

headers is optional. This is the default.

Note: In SOAP 1.1, the values of the mustUnderstand aribute

were 0 and 1 instead of True and False; however,
Integration Server processes both sets of values the same
way and performs any necessary conversions.
For more information about the mustUnderstand and
actor aributes in SOAP 1.1, see the Simple Object Access
Protocol (SOAP) 1.1 - W3C Note 08 May 2000 specication.
For more information about the mustUnderstand and
role aributes in SOAP 1.2, see the Simple Object Access
Protocol (SOAP) 1.2 specication.
Role

Target of the WS-Addressing headers in the SOAP message.

Role determines the value of the role aribute for the WSAddressing headers. The actor or role aribute species a URI
for the recipient of WS-Addressing header entries.
Note: In SOAP 1.1, the role aribute is named actor; however,
Integration Server processes both names the same and
performs any necessary conversions.
Select...

To...

webMethods Integration Server Administrators Guide Version 9.10

327

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
Ultimate
Receiver

Indicate that the recipient is the ultimate

destination of the SOAP message. This is the
default.

Next

Specify the following URI for the role aribute:

For SOAP 1.2: "hp://www.w3.org/2003/05/soapenvelope/role/next"
For SOAP 1.1: "hp://schemas.xmlsoap.org/soap/
actor/next"

None

Specify the following URI for the role aribute:

For SOAP 1.2: "hp://www.w3.org/2003/05/soapenvelope/role/none"
For SOAP 1.1: "hp://www.w3.org/2003/05/soapenvelope/role/none"

Other
To

Specify the target of the header. Typically, this

will be a URI.

URI of the destination of the SOAP message.

In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference to which the request
is addressed. You can specify more than one reference
parameter. Click the + icon to add more rows and the x icon
to delete the rows.

From

URI of the source of the SOAP message. Enter the URI in the
Address eld.
Optionally, in the Reference Parameters eld, specify any
additional parameters that are necessary to route the message
to the destination. You can also specify optional metadata
(such as WSDL or WS-Policy) about the service in the Metadata
Elements eld. You can specify more than one reference
parameter and metadata element. Click the + icon to add
more rows and the x icon to delete the rows.

ReplyTo

URI of the destination to which the web service sends a

response (reply) message. This property is optional.
If this value is not specied, the default values for this URI
depends on the WS-Addressing policy aached to the web

webMethods Integration Server Administrators Guide Version 9.10

328

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
service descriptor. For a consumer endpoint alias, it defaults
to:
hp://www.w3.org/2005/08/addressing/anonymous for Final
version of WS-Addressing.
hp://schemas.xmlsoap.org/ws/2004/08/addressing/role/
anonymous for Submission version of WS-Addressing.
In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference to which the response
message is addressed. Optionally, you can specify metadata
(such as WSDL or WS-Policy) about the service in the Metadata
Elements eld. You can also specify Extensible Elements, which
are elements other than those specied as part of the Metadata
and Reference Parameters.
You can specify more than one reference parameter, metadata
element, or extensible element. Click the + icon to add more
rows and the x icon to delete the rows.

FaultTo

URI to which the SOAP fault messages are to be routed. This

property is optional.
In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference to which the fault
message is addressed. Optionally, you can specify metadata
(such as WSDL or WS-Policy) about the service in the Metadata
Elements eld. You can also specify Extensible Elements, which
are elements other than those specied as part of the Metadata
and Reference Parameters. You can specify more than one
reference parameter, metadata element, or extensible element.
Click the + icon to add more rows and the x icon to delete
the rows.
You can specify more than one reference parameter, metadata
element, or extensible element. Click the + icon to add more
rows and the x icon to delete the rows.

15. Under Reliable Messaging Properties, check Enable to provide reliable messaging
information specic to the endpoint alias you are creating.
16. Provide the following reliable-messaging information to ensure reliable delivery of
the message between a reliable messaging source and destination.

webMethods Integration Server Administrators Guide Version 9.10

329

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...

Retransmission
Interval

The time interval (in milliseconds) for which a reliable

messaging source waits for an acknowledgement from the
reliable messaging destination before retransmiing the
SOAP message. The default is 6000 milliseconds.

Acknowledgement
Interval

The time interval (in milliseconds) for which the

reliable messaging destination waits before sending an
acknowledgement for a message sequence. Messages
of the same sequence received within the specied
acknowledgement interval are acknowledged in one
batch. If there are no other messages to be sent to the
acknowledgement endpoint within the time specied as the
acknowledgement interval, the acknowledgement is sent as a
stand-alone message.
The default is 3000 milliseconds.

Exponential
Backoff

Maximum
Retransmission
Count

Whether to use the exponential backo algorithm to adjust

the retransmission interval of unacknowledged messages.
Adjusting the time interval between retransmission aempts
ensures that a reliable messaging destination does not get
ooded with a large number of retransmied messages.
Select...

To...

true

Increase the successive retransmission

intervals exponentially, based on the specied
retransmission interval. For example, if the
specied retransmission interval is 2 seconds,
and the exponential backo value is set to
true, successive retransmission intervals
will be 2, 4, 8, 16, 32, and so on if messages
continue to be unacknowledged. This is the
default.

false

Use the same time interval specied in

the Retransmission Interval eld for all
retransmissions.

The number of times the reliable messaging source must

retransmit a message if an acknowledgement is not received
from the reliable messaging destination. To specify that there

webMethods Integration Server Administrators Guide Version 9.10

330

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
is no limit to the number of retransmission aempts, set the
value of Maximum Retransmission Count to -1. The default is 10.

17. Click Save Changes.

Creating an Endpoint Alias for Message Addressing for Use

with HTTP/S
When creating an HTTP/S web service endpoint alias for message addressing, the
information you need to supply falls into the following categories:
Web Service Endpoint Alias. Identies the endpoint name, description, and transport
type.
HTTP/S Transport Properties. Species the authentication details that Integration Server
uses to send responses. For HTTPS transport, also species the keystore alias and
key alias of the private key used for SSL communication with the receiver of the
SOAP response.
If the web service response must be routed through a proxy server, specify the proxy
server alias for the proxy server through which Integration Server routes the HTTP/S
message.
WS Security Properties. Provides information for the WS-Security header as
determined by the security policy for the web service.
Note:

WS-Security credentials such as private keys and public keys do not

always need to be provided in a web service endpoint alias. If this
information is not provided in the alias, Integration Server can obtain
the information from other locations. For more information about usage
and resolution order of certicates and keys for WS-Security, see the
Web Services Developers Guide.

Message Addressing Properties. Provides addressing information relating to the

delivery of the response message. This includes the reply endpoint where the replies
should be sent, the fault endpoint that species where the faults should be sent, and
optional metadata (such as WSDL or WS-Policy) about the service. This also includes
additional parameters, called Reference Parameters, that Integration Server uses to
route the message to the destination.
Note:

You cannot delete a message addressing endpoint alias if a web service

endpoint alias for provider web service descriptor is using the message
addressing endpoint alias as a part of its response map.

webMethods Integration Server Administrators Guide Version 9.10

331

Even Header
Configuring Endpoint Aliases for Web Services

To create a message addressing web service endpoint alias for use with HTTP/S
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > Web Services.
3. Click Create Web Service Endpoint Alias.
4. Under Web Service Endpoint Alias Properties, provide the following information:
In this field...

Specify...

Alias

A name for the message addressing web service endpoint

alias.
The alias name cannot include the following illegal characters:
# \ & @ ^ ! % * : $ . / \ \ ` ; , ~ + = ) ( | } { ] [ > < "

Description

A description for the endpoint alias.

Type

Message Addressing

Transport Type

Specify the transport protocol used to access the web service.

Select one of the following:
HTTP
HTTPS

5. If you are conguring the web service endpoint for transport-based authentication
such as HTTPS, specify all or a combination of the following optional elds under
TransportType Transport Properties:
In this field...

Specify...

Authentication
Type

Specify the type of authentication you want to use to

authenticate the consumer.
Select...

To...

Basic

Use basic authentication (user name and

password) to authenticate the consumer.

Digest

Use password digest to authenticate the

consumer.

webMethods Integration Server Administrators Guide Version 9.10

332

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
NTLM

Use NTLM authentication so that clients

that are already logged into a domain can be
authenticated using their existing credentials.

User Name

User name used to authenticate the provider at the HTTP or

HTTPS transport level on the host server.

Password

The password used to authenticate the provider on the host

server.

Retype
Password

Re-enter the above password.

Keystore Alias

Alias to the keystore that contains the private key used to

connect to the web service host securely.
This eld applies to the HTTPS transport type only.

Key Alias

Alias to the key in the keystore that contains the private key
used to connect to the web service host securely. The key must
be in the keystore specied in Keystore Alias.
This eld applies to the HTTPS transport type only.

6. If web service responses must be sent through a proxy server, in the Proxy Alias eld,
do one of the following to specify which proxy server Integration Server uses:
If you want Integration Server to use a particular proxy server, specify the alias
for that proxy server. Integration Server lists all the congured HTTP/S and
SOCKS proxy aliases in the Proxy Alias eld.
If you want Integration Server to use the default proxy server, leave this eld
blank.
For more information about how Integration Server uses proxy servers when
sending responses, see "How Integration Server Uses Proxy Servers" on page 121.
7. Under WS Security Properties, specify the certicate le of the receiver of the SOAP
response. This certicate is used to encrypt the outbound SOAP response and/or
verify the inbound SOAP response.
In this field...

Specify

Partner's Certificate

The path and le name of the certicate of the receiver of

the SOAP response, which contains its public key.

webMethods Integration Server Administrators Guide Version 9.10

333

Even Header
Configuring Endpoint Aliases for Web Services

8. Under WS Security Properties, specify the following if the security policy (or policies)
that will be used by this web service requires its responses to be signed, requires an
X.509 authentication token to be included, or requires that SOAP message responses
be encrypted:
In this field...

Specify

Keystore Alias

Alias to the keystore that contains the private key used to:
Sign outbound SOAP responses
Include an X.509 authentication token for outbound SOAP
responses
To verify response messages from this web service, the
Important:
receiver must have the corresponding public key.

Key Alias

Alias to the private key used to sign and/or include X.509

authentication token for outbound SOAP messages. The key
must be in the keystore specied in Keystore Alias.

9. Under WS Security Properties, congure how Integration Server handles timestamps in

the security headers.
In this field...

Specify...

Timestamp
Precision

Whether the timestamp is precise to the second or millisecond.

If you set the precision to milliseconds, Integration Server uses
the timestamp format yyyy-MM-dd'T'HH:mm:ss:SSS'Z'. If
you set the precision to seconds, Integration Server uses the
timestamp format yyyy-MM-dd'T'HH:mm:ss'Z'.
If you do not select a precision value, Integration
Server will use the value specied for the
wa.server.ws.security.timestampPrecisionInMilliseconds
parameter.

Timestamp Time
to Live

The time-to-live value for the outbound message in seconds.

Integration Server uses the Timestamp Time to Live value to
set the expiry time in the Timestamp element of outbound
messages. The Timestamp Time to Live value must be an integer
greater than 0.
If you do not specify a time-to-live value, Integration
Server will use the value specied for the
wa.server.ws.security.timestampTimeToLive parameter.

webMethods Integration Server Administrators Guide Version 9.10

334

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...

Timestamp
Maximum Skew

The maximum number of seconds that the web services client

and host clocks can dier and still allow timestamp expiry
validation to succeed. Specify a positive integer or zero.
Integration Server uses the timestamp maximum skew value
only when you implement WS-Security via a WS-Policy.
Integration Server validates the inbound SOAP message only
when the creation timestamp of the message is less than the
sum of the timestamp maximum skew value and the current
system clock time.
If you do not specify a timestamp maximum skew value,
Integration Server will use the value specied for the
wa.server.ws.security.timestampMaximumSkew parameter.

For more information about timestamps in the WS-Security header, see "Timestamps
in the WS-Security Header" on page 359.
10. Under Message Addressing Properties, provide the following addressing information
relating to the delivery of a SOAP response to the receiver. The message addressing
properties dene the addressing information that can be aached to the SOAP
message.
In this field...

Specify...

Must
Understand

Whether the recipients (the actor or role to which the header is

targeted) are required to process the WS-Addressing headers.
Recipients that cannot process a mandatory WS-Addressing
header reject the message and return a SOAP fault.
Must Understand determines the mustUnderstand aribute of
the WS-Addressing headers.
Select...

To...

True

Indicate that processing the WS-Addressing

headers is required by the recipients.
If you select True for Must Understand and the
SOAP node receives a header that it does not
understand or cannot process, it returns a fault.

False

Indicate that processing the WS-Addressing

headers is optional. This is the default.

Note: In SOAP 1.1, the values of the mustUnderstand aribute

were 0 and 1 instead of True and False; however,
webMethods Integration Server Administrators Guide Version 9.10

335

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
Integration Server processes both sets of values the same
way and performs any necessary conversions.
For more information about the mustUnderstand and
actor aributes in SOAP 1.1, see the Simple Object Access
Protocol (SOAP) 1.1 - W3C Note 08 May 2000.
For more information about the mustUnderstand and
role aributes in SOAP 1.2, see the Simple Object Access
Protocol (SOAP) 1.2 specication.

Role

Target of the WS-Addressing headers in the SOAP message.

Role determines the value of the role aribute for the WSAddressing headers. The actor or role aribute species a URI
for the recipient of WS-Addressing header entries.
Note: In SOAP 1.1, the role aribute is named actor; however,
Integration Server processes both names the same and
performs any necessary conversions.
Select...

To...

Ultimate
Receiver

Indicate that the recipient is the ultimate

destination of the SOAP message. This is the
default.

Next

Specify the following URI for the role aribute:

For SOAP 1.2: "hp://www.w3.org/2003/05/soapenvelope/role/next"
For SOAP 1.1: "hp://schemas.xmlsoap.org/soap/
actor/next"

None

Specify the following URI for the role aribute:

For SOAP 1.2: "hp://www.w3.org/2003/05/soapenvelope/role/none"
For SOAP 1.1: "hp://www.w3.org/2003/05/soapenvelope/role/none"

Other
From

Specify the target of the header. Typically, this

will be a URI.

URI of the source of the SOAP response.

webMethods Integration Server Administrators Guide Version 9.10

336

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference. Optionally, you can
specify metadata (such as WSDL or WS-Policy) about the
service in the Metadata Elements eld. You can also specify
Extensible Elements, which are elements other than those
specied as part of the Metadata and Reference Parameters. You
can specify more than one reference parameter, metadata
element, or extensible element. Click the + icon to add more
rows and the x icon to delete the rows.

ReplyTo

URI to which the response (reply) messages are to be routed.

This property is optional.
If this value is not specied, the default values for this URI
depends on the WS-Addressing policy aached to the web
service descriptor.
For the Final version of WS-Addressing, ReplyTo defaults to
hp://www.w3.org/2005/08/addressing/anonymous.
For the Submission version of WS-Addressing, ReplyTo
defaults to hp://schemas.xmlsoap.org/ws/2004/08/
addressing/role/anonymous.
In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference to which the response
message is addressed. Optionally, you can specify metadata
(such as WSDL or WS-Policy) about the service in the Metadata
Elements eld. You can also specify Extensible Elements, which
are elements other than those specied as part of the Metadata
and Reference Parameters.
You can specify more than one reference parameter, metadata
element, or extensible element. Click the + icon to add more
rows and the x icon to delete the rows.

FaultTo

URI to which the SOAP fault messages are to be routed. This

property is optional.
In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference to which the fault
message is addressed. Optionally, you can specify metadata
(such as WSDL or WS-Policy) about the service in the Metadata
Elements eld. You can also specify Extensible Elements, which
are elements other than those specied as part of the Metadata

webMethods Integration Server Administrators Guide Version 9.10

337

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
and Reference Parameters. You can specify more than one
reference parameter, metadata element, or extensible element.
Click the + icon to add more rows and the x icon to delete
the rows.
You can specify more than one reference parameter, metadata
element, or extensible element. Click the + icon to add more
rows and the x icon to delete the rows.

11. Click Save Changes.

Creating an Endpoint Alias for a Provider Web Service

Descriptor for Use with JMS
If a provider web service descriptor binder species the JMS transport, you must assign
a web service endpoint alias to the binder. For a web service descriptor that uses SOAP
over JMS, the provider web service endpoint alias provides the following information:
JMS message header information for the request message, such as delivery mode,
time to live, and the destination for replies. Integration Server uses this information
to populate the binding elements in the WSDL generated for the web service
descriptor.
The SOAP-JMS trigger that listens for SOAP over JMS messages for the web service
descriptor. The SOAP-JMS trigger also provides the JMS connection information
needed to create a connection on the JMS provider. Integration Server uses the
information provided by the SOAP-JMS trigger to construct most of the JMS URI
(the web service descriptor determines the targetService). The JMS URI appears in
the WSDL document as the value of the "location=" aribute for the address element
within the port element.
WS Security Properties that specify the information needed by the SOAP processor
to decrypt and verify the inbound SOAP request and/or encrypt and sign the
outbound SOAP response and the details for adding the timestamp information.
Note:

WS-Security credentials such as private keys and public keys do not

always need to be provided in a web service endpoint alias. If this
information is not provided in the alias, Integration Server can obtain
the information from other locations. For more information about usage
and resolution order of certicates and keys for WS-Security, see the
Web Services Developers Guide.

Message addressing properties that provides addressing information relating to the

delivery of a message to a web service. This includes the destination address of a
message or fault and the authentication credentials required to send a response to a
dierent address than the one from which the request was received.

webMethods Integration Server Administrators Guide Version 9.10

338

Odd Header
Configuring Endpoint Aliases for Web Services

Keep the following information in mind when creating a web service endpoint alias for a
JMS binder in a provider web service descriptor:
You can associate the web service endpoint alias with:
A SOAP-JMS trigger that already exists.
A WS endpoint trigger that you create at the same time you create the endpoint
alias.
If you use a SOAP-JMS trigger in the web service endpoint alias and subsequently
assign the alias to a JMS binder in a provider web service descriptor, the web service
descriptor has a dependency on the SOAP-JMS trigger. Consequently, at start up
or when reloading the package containing the web service descriptor, Integration
Server must load the SOAP-JMS trigger before loading the web service descriptor. If
the SOAP-JMS trigger and web service descriptor are not in the same package, you
need to create a package dependency for the package that contains the web service
descriptor on the package that contains the SOAP-JMS trigger.
If you rename the SOAP-JMS trigger assigned to an alias, you need to update the
alias to use the renamed trigger.
The following properties are optional.
Delivery Mode
Time to Live
Priority
Reply To Name
Reply To Type
If you do not specify values for one of the listed properties (or specify an invalid
value), Integration Server will not include information for the property in the WSDL
document generated for a provider web service descriptor that uses the web service
endpoint alias. The absence of the property from the WSDL document instructs the
web service consumer to use the default value for the property as indicated in the
Java Message Service standard.
To create a provider web service endpoint alias for use with JMS
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > Web Services.
3. Click Create Web Service Endpoint Alias.
4. Under Web Service Endpoint Alias Properties, provide the following information:
In this field...

Specify...

Alias

A name for the JMS provider web service endpoint alias.

webMethods Integration Server Administrators Guide Version 9.10

339

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
The alias name cannot include the following illegal characters:
# \ & @ ^ ! % * : $ . / \ \ ` ; , ~ + = ) ( | } { ] [ > < "

Description

A description for the endpoint alias.

Type

Provider

Transport Type

JMS

5. Under JMS Transport Properties, provide the following information:

In this field...

Specify...

JMS Trigger
Name

The name of the SOAP-JMS trigger used to

Receive JMS messages.
Supply JMS connection properties to any web service
descriptors using this web service endpoint alias.
If you want to use a WS endpoint trigger, select WS Endpoint
Trigger. For more information about WS endpoint triggers, see
"About WS Endpoint Triggers" on page 792.

Delivery Mode

Time to Live

The message delivery mode for the request message. This is

the delivery mode that web service clients must specify in the
JMS message that serves as the request message for the web
service.
Select...

To...

PERSISTENT

Indicate the request message should be

persistent. The message will not be lost
if the JMS provider fails.

NON_PERSISTENT

Indicate the request message is not

persistent. The message might be lost if
the JMS provider fails.

The number of milliseconds that can elapse before the request

message expires on the JMS provider. A value of 0 indicates
that the message does not expire.

webMethods Integration Server Administrators Guide Version 9.10

340

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...

Priority

Species the message priority. The JMS standard denes

priority levels from 0 to 9, with 0 as the lowest priority and 9
as the highest.

Reply To Name

Name or lookup name of the destination to which the web

service sends a response (reply) message. Specify a name if the
JMS connection alias used by the SOAP-JMS trigger connects
to the webMethods Broker natively. Specify a lookup name
if the JMS connection alias uses JNDI to retrieve a connection
factory that is then used to connect to the JMS provider.

Reply To Type

Type of destination to which the web service sends the

response (reply) message. Specify the destination type if the
following are true:
The web service descriptor to which the endpoint alias is
assigned use the In-Out message exchange paern.
The JMS connection alias specied by the SOAP-JMS
trigger connects to the webMethods Broker natively. On the
webMethods Broker, a queue and topic can have the same
name. You must specify Reply To Type to indicate to which
destination the reply will be sent.
Select...

To...

QUEUE

Indicate that the web service sends the

response message to a particular queue.

TOPIC

Indicate that the web service sends the

request message to a particular topic.

6. Under JMS WSDL Options, provide the following information:

Select...

To...

Include Connection Factory

Name

Include the connection factory name in the JMS

URI.

Include JNDI Parameters

Include the JNDI parameters in the JMS URI.

Note:

The JMS URI appears in the WSDL document as the location aribute
value for the address element contained within the port element.

webMethods Integration Server Administrators Guide Version 9.10

341

Even Header
Configuring Endpoint Aliases for Web Services

7. Under WS Security Properties, if the inbound SOAP request must be decrypted and/or
the outbound SOAP response must be signed, do the following:
In this field...

Specify...

Keystore Alias

Alias of the keystore containing the private key used to

decrypt the inbound SOAP request or sign the outbound
SOAP response.
The provider must have already given the consumer the
Important:
corresponding public key.

Key Alias

Alias of the private key used to decrypt the request or sign the
response. The key must be in the keystore specied in Keystore
Alias.

8. Under WS Security Properties, if the signing certicate chain of an inbound signed

SOAP message has to be veried, specify the following:
In this field...

Specify...

Truststore Alias

The alias for the truststore that contains the list of CA

certicates that Integration Server uses to validate the trust
relationship.

9. Under WS Security Properties, congure how Integration Server handles timestamps in

the security header.
In this field...

Specify...

Timestamp
Precision

Whether the timestamp is precise to the second or millisecond.

If you set the precision to milliseconds, Integration Server uses
the timestamp format yyyy-MM-dd'T'HH:mm:ss:SSS'Z'. If
you set the precision to seconds, Integration Server uses the
timestamp format yyyy-MM-dd'T'HH:mm:ss'Z'.
If you do not select a precision value, Integration
Server will use the value specied for the
wa.server.ws.security.timestampPrecisionInMilliseconds
parameter.

Timestamp Time
to Live

The time-to-live value for the outbound message in seconds.

Integration Server uses the time-to-live value to set the expiry
time in the Timestamp element of outbound messages. The
Timestamp Time to Live value must be an integer greater than 0.

webMethods Integration Server Administrators Guide Version 9.10

342

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
If you do not specify a Timestamp Time to Live value,
Integration Server will use the value specied for the
wa.server.ws.security.timestampTimeToLive parameter.
Note: The Timestamp Time to Live value should be greater than
the Time to Live value specied under JMS Transport
Properties.

Timestamp
Maximum Skew

The maximum number of seconds that the web services client

and host clocks can dier and still allow timestamp expiry
validation to succeed. Specify a positive integer or zero.
Integration Server uses the timestamp maximum skew value
only when you implement WS-Security via a WS-Policy.
Integration Server validates the inbound SOAP message only
when the creation timestamp of the message is less than the
sum of the timestamp maximum skew value and the current
system clock time.
If you do not specify a timestamp maximum skew value,
Integration Server will use the value specied for the
wa.server.ws.security.timestampMaximumSkew parameter.

10. Under Message Addressing Properties, provide the following addressing information
relating to the delivery of the message. The message addressing properties dene the
addressing information that can be aached to the SOAP message.
In this field...

Specify...

To

RI of the destination of the SOAP message.

In the Reference Parameters eld, specify
additional parameters, if any, that correspond to
<wsa:ReferenceParameters> properties of the endpoint
reference to which the message is addressed. Optionally,
you can specify metadata (such as WSDL or WS-Policy)
about the service in the Metadata Elements eld. You can
also specify Extensible Elements, which are elements other
than those specied as part of the Metadata and Reference
Parameters.
You can specify more than one reference parameter,
metadata element, or extensible element. Click the + icon
to add more rows and the x icon to delete the rows.

Response Map

Address to which the provider will send the reply or fault

message and the corresponding message addressing alias.

webMethods Integration Server Administrators Guide Version 9.10

343

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
Integration Server retrieves the authentication details
needed to send the response from the message addressing
alias mapped to the address.
In the Address eld, specify the URI to which the provider
will send the reply or the fault message.
From the Message Addressing Alias list, select the Message
Addressing endpoint alias from which Integration Server
will retrieve the authentication details. Integration Server
uses the authentication details to send the response to the
ReplyTo or FaultTo endpoints.
Click the + icon to add more rows and the x icon to delete
the rows.

11. Click Save Changes.

If you selected WS endpoint trigger for JMS Trigger Name, saving the alias creates the WS
endpoint trigger. Before the WS endpoint trigger is usable, you will need to specify a
destination and enable it. You can also change the values of some message processing
properties. For more information about editing a WS endpoint trigger, see "Editing WS
Endpoint Triggers" on page 793.
Note:

If a provider web service endpoint alias for use with JMS species a WS
endpoint trigger, deleting the alias also deletes the WS endpoint trigger.

Creating an Endpoint Alias for a Consumer Web Service

Descriptor for Use with JMS
A web service endpoint alias for use with a consumer web service descriptor that has a
JMS binder species how and where Integration Server sends a request message when
executing a web service descriptor.
When creating a consumer web service descriptor, Integration Server extracts the JMS
information from the WSDL document and saves it with the binder information in the
web service descriptor. However, as indicated in the SOAP over Java Message Service
standard, the only JMS information required in the WSDL is the lookup variant and
the destination name. Consequently, it is possible that some information necessary
to connect to the JMS provider is absent from the WSDL. Integration Server uses the
information in a JMS consumer web service endpoint alias to replace or supplement the
JMS information specied in the WSDL document.
When creating a consumer web service descriptor, the message addressing properties
dene the WS-addressing headers information that can be aached to the SOAP
message.

webMethods Integration Server Administrators Guide Version 9.10

344

Odd Header
Configuring Endpoint Aliases for Web Services

Keep the following points in mind when creating a web service endpoint alias for use
with a consumer web service descriptor with a SOAP over JMS binding:
A JMS consumer web service endpoint alias can specify one of the following options
to connect to a JMS provider:
JNDI provider alias and a connection factory.
JMS connection alias.
Only specify a JNDI provider alias and connection factory, or JMS connection alias,
if information for connecting to the JMS provider was not included in the WSDL
document used to create the consumer web service descriptor or if you want to
overwrite the connection information included in the WSDL document.
Note:

Using a JMS connection alias to connect to the JMS provider might

oer beer performance. Keep in mind that a JMS connection alias can
connect to the JMS provider by using JNDI to retrieve a connection
factory and then establishing a connection or by connecting natively to the
webMethods Broker.

If you want to use the client side queue with the web service descriptor to which the
alias is assigned, you must specify a JMS connection alias as the way to connect to
the JMS provider.
Information in the JMS consumer web service endpoint alias can supplement or
replace the JMS URI information obtained from a WSDL.
You can use the endpoint alias to provide information for the WS-Security header as
determined by the security policy for the web service. A web service security policy
can require that:
SOAP message requests include a UserName token.
SOAP message response be decrypted.
SOAP message requests to be signed.
X.509 authentication.
A Timestamp element be added to the security header.
Note:

WS-Security credentials such as private keys and public keys do not

always need to be provided in a web service endpoint alias. If this
information is not provided in the alias, Integration Server can obtain
the information from other locations. For more information about usage
and resolution order of certicates and keys for WS-Security, see the
Web Services Developers Guide.

To create a consumer web service endpoint alias for use with JMS
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > Web Services.

webMethods Integration Server Administrators Guide Version 9.10

345

Even Header
Configuring Endpoint Aliases for Web Services

3. Click Create Web Service Endpoint Alias.

4. Under Web Service Endpoint Alias Properties, provide the following information:
In this field...

Specify...

Alias

A name for the JMS consumer web service endpoint alias.

The alias name cannot include the following illegal characters:
# \ & @ ^ ! % * : $ . / \ \ ` ; , ~ + = ) ( | } { ] [ > < "

Description

A description for the endpoint alias.

Type

Consumer

Transport Type

JMS

Execute ACL

ACL that governs which user groups on your server can use
this web service endpoint alias. Select an ACL from the drop
down list. By default, only members of groups governed by the
Internal ACL can use this alias.

5. Under JMS Transport Properties, do the following if you want to connect to the JMS
provider using a connection factory:
In this field...

Specify...

Connect Using

JNDI Properties

JNDI Provider Alias

The alias for the JNDI provider that Integration Server

uses to look up administered objects. For information
about creating a JNDI provider alias, see "Creating a
JNDI Provider Alias" on page 271.

Connection Factory
Name

The lookup name for the connection factory to use to

create a connection to the JMS provider.
Note: You need to specify a connection factory only if
the WSDL document used to create the consumer
web service descriptor did not specify a connection
factory or you want to overwrite the connection
factory.

6. Under JMS Transport Properties, do the following if you want to connect to the JMS
provider using a JMS connection alias:

webMethods Integration Server Administrators Guide Version 9.10

346

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...

Connect Using

JMS Connection Alias

JMS Connection Alias

The name of the JMS connection alias that you want

Integration Server to use to connect to the JMS provider.
For information about creating a JMS connection alias,
see "Creating a JMS Connection Alias" on page 277.

7. Under WS Security Properties, provide the following information if the WS-Security

policy for this consumer web service descriptor requires that SOAP message requests
include a UsernameToken.
In this field...

Specify...

User Name

The user name to include with the UsernameToken.

Password

The password to include with the UsernameToken (must be

plain text).

Retype
Password

Re-enter the above password.

8. If the security policy (or policies) that will be used by this web service requires
its requests to be signed, requires an X.509 authentication token to be included, or
requires that SOAP message responses be encrypted, specify the following:
In this field...

Specify

Keystore Alias

Alias to the keystore that contains the private key used to:
Sign outbound SOAP requests
Include an X.509 authentication token for outbound SOAP
requests
Decrypt inbound SOAP responses
To verify messages from this consumer, the
Important:
web services provider must have a copy of the
corresponding public key.

Key Alias

Alias to the private key used to sign and/or include X.509

authentication token for outbound SOAP messages and/or
decrypt inbound SOAP responses. The key must be in the
keystore specied in Keystore Alias.

webMethods Integration Server Administrators Guide Version 9.10

347

Even Header
Configuring Endpoint Aliases for Web Services

9. Under WS Security Properties, specify the provider's certicate le. This certicate
is used to encrypt the outbound SOAP request and/or verify the inbound SOAP
response.
In this field...

Specify

Partner's Certificate

The path and le name of the provider's certicate, which

contains its public key.

10. Under WS Security Properties, if the security policy (or policies) that will be used by
this web services consumer requires that responses be veried by a trusted authority,
specify the following:
In this field...

Specify

Partner's Certificate

Path and le name of the le containing the provider's

certicate.

Truststore Alias

The alias for the truststore that contains the list of CA

certicates that Integration Server uses to validate the trust
relationship.

11. Under WS Security Properties, congure how Integration Server handles timestamps in
the security headers.
In this field...

Specify...

Timestamp
Precision

Whether the timestamp is precise to the second or millisecond.

If you set the precision to milliseconds, Integration Server uses
the timestamp format yyyy-MM-dd'T'HH:mm:ss:SSS'Z'. If
you set the precision to seconds, Integration Server uses the
timestamp format yyyy-MM-dd'T'HH:mm:ss'Z'.
If you do not select a precision value, Integration
Server will use the value specied for the
wa.server.ws.security.timestampPrecisionInMilliseconds
parameter.

Timestamp Time
to Live

The time-to-live value for the outbound message in seconds.

Integration Server uses the Timestamp Time to Live value to
set the expiry time in the Timestamp element of outbound
messages. The Timestamp Time to Live value must be an integer
greater than 0.

webMethods Integration Server Administrators Guide Version 9.10

348

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
If you do not specify a time-to-live value, Integration
Server will use the value specied for the
wa.server.ws.security.timestampTimeToLive parameter.

Timestamp
Maximum Skew

The maximum number of seconds that the web services client

and host clocks can dier and still allow timestamp expiry
validation to succeed. Specify a positive integer or zero.
Integration Server uses the timestamp maximum skew value
only when you implement WS-Security via a WS-Policy.
Integration Server validates the inbound SOAP message only
when the creation timestamp of the message is less than the
sum of the timestamp maximum skew value and the current
system clock time.
If you do not specify a timestamp maximum skew value,
Integration Server will use the value specied for the
wa.server.ws.security.timestampMaximumSkew parameter.

For more information about timestamps in the WS-Security header, see "Timestamps
in the WS-Security Header" on page 359.
12. Under Message Addressing Properties, provide the following addressing information
relating to the delivery of a message to a web service.
In this field...

Specify...

Must
Understand

Whether the recipients (the actor or role to which the header is

targeted) are required to process the WS-Addressing headers.
Recipients that cannot process a mandatory WS-Addressing
header reject the message and return a SOAP fault.
Must Understand determines the mustUnderstand aribute of
the WS-Addressing headers.
Select...

To...

True

Indicate that processing the WS-Addressing

headers is required by the recipients (the actor or
role to which the header is targeted).
If you select True for Must Understand and the
SOAP node receives a header that it does not
understand or cannot process, it returns a fault.

webMethods Integration Server Administrators Guide Version 9.10

349

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
False

Indicate that processing the WS-Addressing

headers is optional. This is the default.

Note: In SOAP 1.1, the values of the mustUnderstand aribute

were 0 and 1 instead of True and False; however,
Integration Server processes both sets of values the same
and performs any necessary conversions.
For more information about the mustUnderstand and
actor aributes in SOAP 1.1, see the Simple Object Access
Protocol (SOAP) 1.1 - W3C Note 08 May 2000.
For more information about the mustUnderstand and
role aributes in SOAP 1.2, see the Simple Object Access
Protocol (SOAP) 1.2 specication.
Role

Target of the WS-Addressing headers in the SOAP message.

Role determines the value of the role aribute for the WSAddressing headers. The actor or role aribute species a URI
for the recipient of WS-Addressing header entries.
Note: In SOAP 1.1, the role aribute is named actor; however,
Integration Server processes both names the same and
performs any necessary conversions.
Select...

To...

Ultimate
Receiver

Indicate that the recipient is the ultimate

destination of the SOAP message. This is the
default.

Next

Specify the following URI for the role aribute:

For SOAP 1.2: "hp://www.w3.org/2003/05/soapenvelope/role/next"
For SOAP 1.1: "hp://schemas.xmlsoap.org/soap/
actor/next"

None

Specify the following URI for the role aribute:

For SOAP 1.2: "hp://www.w3.org/2003/05/soapenvelope/role/none"
For SOAP 1.1: "hp://www.w3.org/2003/05/soapenvelope/role/none"

webMethods Integration Server Administrators Guide Version 9.10

350

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
Other

To

Specify the target of the header. Typically, this

will be a URI.

URI of the destination of the SOAP request.

In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference to which the request
is addressed. You can specify more than one reference
parameter. Click the + icon to add more rows and the x icon
to delete the rows.

From

URI of the source of the SOAP message.

In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference. Optionally, you can
specify metadata (such as WSDL or WS-Policy) about the
service in the Metadata Elements eld. You can also specify
Extensible Elements, which are elements other than those
specied as part of the Metadata and Reference Parameters. You
can specify more than one reference parameter, metadata
element, or extensible element. Click the + icon to add more
rows and the x icon to delete the rows.

ReplyTo

URI to which the response (reply) messages are to be routed.

This property is optional.
If this value is not specied, the default values for this URI
depends on the WS-Addressing policy aached to the web
service descriptor.
For the Final version of WS-Addressing, ReplyTo defaults to
hp://www.w3.org/2005/08/addressing/anonymous.
For the Submission version of WS-Addressing, ReplyTo
defaults to hp://schemas.xmlsoap.org/ws/2004/08/
addressing/role/anonymous.
In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference to which the response
message is addressed. Optionally, you can specify metadata
(such as WSDL or WS-Policy) about the service in the Metadata
Elements eld. You can also specify Extensible Elements, which
are elements other than those specied as part of the Metadata
and Reference Parameters.

webMethods Integration Server Administrators Guide Version 9.10

351

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
You can specify more than one reference parameter, metadata
element, or extensible element. Click the + icon to add more
rows and the x icon to delete the rows.

FaultTo

URI to which the SOAP fault messages are to be routed. This

property is optional.
In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference to which the fault
message is addressed. Optionally, you can specify metadata
(such as WSDL or WS-Policy) about the service in the Metadata
Elements eld. You can also specify Extensible Elements, which
are elements other than those specied as part of the Metadata
and Reference Parameters. You can specify more than one
reference parameter, metadata element, or extensible element.
Click the + icon to add more rows and the x icon to delete
the rows.
You can specify more than one reference parameter, metadata
element, or extensible element. Click the + icon to add more
rows and the x icon to delete the rows.

13. Click Save Changes.

Creating an Endpoint Alias for Message Addressing for Use

with JMS
A web service endpoint alias for message addressing for use with a web service
descriptor that has a JMS binder species the addressing information relating to the
delivery of a SOAP response to the receiver.
Keep the following points in mind when creating a web service endpoint alias for
message addressing for use with a web service descriptor with a SOAP over JMS
binding:
A JMS message addressing web service endpoint alias can specify one of the
following options to connect to a JMS provider:
JNDI provider alias and a connection factory.
JMS connection alias.
Only specify a JNDI provider alias and connection factory, or JMS connection alias,
if information for connecting to the JMS provider was not included in the WSDL

webMethods Integration Server Administrators Guide Version 9.10

352

Odd Header
Configuring Endpoint Aliases for Web Services

document used to create the consumer web service descriptor or if you want to
overwrite the connection information included in the WSDL document.
Note:

Using a JMS connection alias to connect to the JMS provider might

oer beer performance. Keep in mind that a JMS connection alias can
connect to the JMS provider by using JNDI to retrieve a connection
factory and then establishing a connection or by connecting natively to the
webMethods Broker.

You can use the endpoint alias to provide information for the WS-Security header as
determined by the security policy for the web service.
Note:

WS-Security credentials such as private keys and public keys do not

always need to be provided in a message addressing web service endpoint
alias. If this information is not provided in the alias, Integration Server can
obtain the information from other locations. For more information about
usage and resolution order of certicates and keys for WS-Security, see the
Web Services Developers Guide.

If you want to use the client side queue with the web service descriptor to which the
alias is assigned, you must specify a JMS connection alias as the way to connect to
the JMS provider.
Note:

You cannot delete a message addressing endpoint alias if a web service

endpoint alias for provider web service descriptor is using the message
addressing endpoint alias as a part of its response map.

To create a message addressing web service endpoint alias for use with JMS
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > Web Services.
3. Click Create Web Service Endpoint Alias.
4. Under Web Service Endpoint Alias Properties, provide the following information:
In this field...

Specify...

Alias

A name for the JMS message addressing web service endpoint

alias.
The alias name cannot include the following illegal characters:
# \ & @ ^ ! % * : $ . / \ \ ` ; , ~ + = ) ( | } { ] [ > < "

Description

A description for the endpoint alias.

Type

Message Addressing

webMethods Integration Server Administrators Guide Version 9.10

353

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...

Transport Type

JMS

5. Under JMS Transport Properties, do the following if you want to connect to the JMS
provider using a connection factory:
In this field...

Specify...

Connect Using

JNDI Properties

JNDI Provider Alias

The alias for the JNDI provider that Integration Server

uses to look up administered objects. For information
about creating a JNDI provider alias, see "Creating a
JNDI Provider Alias" on page 271.

Connection Factory
Name

The lookup name for the connection factory to use to

create a connection to the JMS provider.

6. Under JMS Transport Properties, do the following if you want to connect to the JMS
provider using a JMS connection alias:
In this field...

Specify...

Connect Using

JMS Connection Alias

JMS Connection Alias

The name of the JMS connection alias that you want

Integration Server to use to connect to the JMS provider.
For information about creating a JMS connection alias,
see "Creating a JMS Connection Alias" on page 277.

7. Under WS Security Properties, specify the certicate le of the receiver of the SOAP
response. This certicate is used to encrypt the outbound SOAP response.
In this field...

Specify

Partner's Certificate

The path and le name of the certicate le of the receiver

of the SOAP response, which contains its public key.

8. Under WS Security Properties, specify the following if the security policy (or policies)
that will be used by this web service requires its responses to be signed, requires an
X.509 authentication token to be included, or requires that SOAP message responses
be encrypted.

webMethods Integration Server Administrators Guide Version 9.10

354

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify

Keystore Alias

Alias to the keystore that contains the private key used to:
Sign outbound SOAP responses
Include an X.509 authentication token for outbound SOAP
responses
To verify response messages from this web service, the
Important:
receiver must have the corresponding public key.

Key Alias

Alias to the private key used to sign and/or include X.509

authentication token for outbound SOAP messages. The key
must be in the keystore specied in Keystore Alias.

9. Under WS Security Properties, congure how Integration Server handles timestamps in

the security headers.
In this field...

Specify...

Timestamp
Precision

Whether the timestamp is precise to the second or millisecond.

If you set the precision to milliseconds, Integration Server uses
the timestamp format yyyy-MM-dd'T'HH:mm:ss:SSS'Z'. If
you set the precision to seconds, Integration Server uses the
timestamp format yyyy-MM-dd'T'HH:mm:ss'Z'.
If you do not select a precision value, Integration
Server will use the value specied for the
wa.server.ws.security.timestampPrecisionInMilliseconds
parameter.

Timestamp Time
to Live

The time-to-live value for the outbound message in seconds.

Integration Server uses the Timestamp Time to Live value to
set the expiry time in the Timestamp element of outbound
messages. The Timestamp Time to Live value must be an integer
greater than 0.
If you do not specify a time-to-live value, Integration
Server will use the value specied for the
wa.server.ws.security.timestampTimeToLive parameter.

Timestamp
Maximum Skew

The maximum number of seconds that the web services client

and host clocks can dier and still allow timestamp expiry
validation to succeed. Specify a positive integer or zero.
Integration Server uses the timestamp maximum skew value
only when you implement WS-Security via a WS-Policy.

webMethods Integration Server Administrators Guide Version 9.10

355

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
Integration Server validates the inbound SOAP message only
when the creation timestamp of the message is less than the
sum of the timestamp maximum skew value and the current
system clock time.
If you do not specify a timestamp maximum skew value,
Integration Server will use the value specied for the
wa.server.ws.security.timestampMaximumSkew parameter.

For more information about timestamps in the WS-Security header, see "Timestamps
in the WS-Security Header" on page 359.
10. Under Message Addressing Properties, provide the following addressing information
relating to the delivery of a response SOAP message to the receiver. The message
addressing properties dene the addressing information that can be aached to the
SOAP message.
In this field...

Specify...

Must
Understand

Whether the recipients (the actor or role to which the header is

targeted) are required to process the WS-Addressing headers.
Recipients that cannot process a mandatory WS-Addressing
header reject the message and return a SOAP fault.
Must Understand determines the mustUnderstand aribute of
the WS-Addressing headers.
Select...

To...

True

Indicate that processing the WS-Addressing

headers is required by the recipients.
If you select True for Must Understand and the
SOAP node receives a header that it does not
understand or cannot process, it returns a fault.

False

Indicate that processing the WS-Addressing

headers is optional. This is the default.

Note: In SOAP 1.1, the values of the mustUnderstand aribute

were 0 and 1 instead of True and False; however,
Integration Server processes both sets of values the same
way and performs any necessary conversions.
For more information about the mustUnderstand and
actor aributes in SOAP 1.1, see the Simple Object Access
Protocol (SOAP) 1.1 - W3C Note 08 May 2000.

webMethods Integration Server Administrators Guide Version 9.10

356

Odd Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
For more information about the mustUnderstand and
role aributes in SOAP 1.2, see the Simple Object Access
Protocol (SOAP) 1.2 specication.

Role

Target of the WS-Addressing headers in the SOAP message.

Role determines the value of the role aribute for the WSAddressing headers. The actor or role aribute species a URI
for the recipient of WS-Addressing header entries.
Note: In SOAP 1.1, the role aribute is named actor; however,
Integration Server processes both names the same and
performs any necessary conversions.
Select...

To...

Ultimate
Receiver

Indicate that the recipient is the ultimate

destination of the SOAP message. This is the
default.

Next

Specify the following URI for the role aribute:

For SOAP 1.2: "hp://www.w3.org/2003/05/soapenvelope/role/next"
For SOAP 1.1: "hp://schemas.xmlsoap.org/soap/
actor/next"

None

Specify the following URI for the role aribute:

For SOAP 1.2: "hp://www.w3.org/2003/05/soapenvelope/role/none"
For SOAP 1.1: "hp://www.w3.org/2003/05/soapenvelope/role/none"

Other
From

Specify the target of the header. Typically, this

will be a URI.

URI of the source of the SOAP response.

In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference. Optionally, you can
specify metadata (such as WSDL or WS-Policy) about the
service in the Metadata Elements eld. You can also specify
Extensible Elements, which are elements other than those
specied as part of the Metadata and Reference Parameters. You

webMethods Integration Server Administrators Guide Version 9.10

357

Even Header
Configuring Endpoint Aliases for Web Services

In this field...

Specify...
can specify more than one reference parameter, metadata
element, or extensible element. Click the + icon to add more
rows and the x icon to delete the rows.

ReplyTo

URI to which the response (reply) messages are to be routed.

This property is optional.
If this value is not specied, the default values for this URI
depends on the WS-Addressing policy aached to the web
service descriptor.
For the Final version of WS-Addressing, ReplyTo defaults to
hp://www.w3.org/2005/08/addressing/anonymous.
For the Submission version of WS-Addressing, ReplyTo
defaults to hp://schemas.xmlsoap.org/ws/2004/08/
addressing/role/anonymous.
In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference to which the response
message is addressed. Optionally, you can specify metadata
(such as WSDL or WS-Policy) about the service in the Metadata
Elements eld. You can also specify Extensible Elements, which
are elements other than those specied as part of the Metadata
and Reference Parameters.
You can specify more than one reference parameter, metadata
element, or extensible element. Click the + icon to add more
rows and the x icon to delete the rows.

FaultTo

URI to which the SOAP fault messages are to be routed. This

property is optional.
In the Reference Parameters eld, specify additional parameters,
if any, that correspond to <wsa:ReferenceParameters>
properties of the endpoint reference to which the fault
message is addressed. Optionally, you can specify metadata
(such as WSDL or WS-Policy) about the service in the Metadata
Elements eld. You can also specify Extensible Elements, which
are elements other than those specied as part of the Metadata
and Reference Parameters. You can specify more than one
reference parameter, metadata element, or extensible element.
Click the + icon to add more rows and the x icon to delete
the rows.
You can specify more than one reference parameter, metadata
element, or extensible element. Click the + icon to add more
rows and the x icon to delete the rows.

webMethods Integration Server Administrators Guide Version 9.10

358

Odd Header
Configuring Endpoint Aliases for Web Services

11. Click Save Changes.

Timestamps in the WS-Security Header

The WS-Security header can contain Timestamp elements and tokens. Integration Server
uses the timestamp to specify or detect whether an outbound or inbound message
expires, specically:
For outbound messages, if the WS-Security policy aached to the web service
descriptor includes the <sp:IncludeTimestamp/> assertion, Integration Server adds
a Timestamp element, which includes the creation and expiry time, to the security
header.
For inbound messages, if the message has a Timestamp token, based on the
Timestamp token, Integration Server veries that the message has not arrived after
the expiration time.
In the web service endpoint alias, you can specify the precision of the message
timestamp, the message time to live, and whether to account for any dierence in the
clocks on the sending and receiving machines.

webMethods Integration Server Administrators Guide Version 9.10

359

Even Header

webMethods Integration Server Administrators Guide Version 9.10

360

Odd Header
Configuring Reliable Messaging in Integration Server

14 Configuring Reliable Messaging in Integration

Server

Overview of Reliable Messaging ...............................................................................................

362

Using Reliable Messaging in Integration Server ........................................................................

363

Configuring Reliable Messaging in Integration Server ...............................................................

365

Reliable Messaging Sequence Reports .....................................................................................

368

Closing a Sequence ...................................................................................................................

370

Terminating a Sequence ............................................................................................................

370

Sending an Acknowledgement Request ....................................................................................

371

webMethods Integration Server Administrators Guide Version 9.10

361

Even Header
Configuring Reliable Messaging in Integration Server

Overview of Reliable Messaging

Integration Server uses the Web Services Reliable Messaging (WS-ReliableMessaging)
protocol to reliably send SOAP messages between web service providers and
consumers. Reliable transmission of messages ensures that the SOAP messages are
delivered even if the destination endpoint is temporarily unavailable or if the network
connection fails.
The following steps describe what happens during exchange of SOAP messages where
reliable messaging is used:
1. The reliable messaging source sends a message or a series of messages that are
transmied across a communication link to a reliable messaging destination. Along
with the messages, the reliable messaging source also sends a request to the recipient
to acknowledge the messages.
2. When the reliable messaging destination receives the messages, it sends an
acknowledgement back to the reliable messaging source either individually for each
message or as a single acknowledgement for a series of messages.
3. If the messages are not delivered in the rst aempt, the reliable messaging source
retransmits the messages based on the reliable messaging conguration until the
message is delivered and the acknowledgement is received or the sequence has
timed out or is terminated.

Understanding Reliable Messaging Terminology

Before conguring reliable messaging in Integration Server, you may nd it helpful to
rst understand the following terminology:
Reliable messaging source. The web service endpoint that transmits the SOAP
messages to a reliable messaging destination. In the case of Integration Server,
a consumer web service descriptor sending a request or a provider web service
descriptor sending a response is the reliable messaging source.
Reliable messaging destination. The web service endpoint that receives SOAP messages
that were reliably transmied from a reliable messaging source. In the case of
Integration Server, a consumer web service descriptor receiving a response or
a provider web service descriptor receiving a request is the reliable messaging
destination.
Reliable messaging server.Integration Server acting as a web service provider in a
reliable messaging scenario.
Reliable messaging client.Integration Server acting as a web service consumer in a
reliable messaging scenario.

webMethods Integration Server Administrators Guide Version 9.10

362

Odd Header
Configuring Reliable Messaging in Integration Server

Message sequence. A message or a series of messages that have the same destination.
Grouping of messages to a message sequence makes it easy to track and manage the
transmission of messages.
Sequence key. User-dened key to identify a message sequence. A reliable messaging
client associates a sequence key to a message sequence based on the endpoint
URL to which the message sequence is directed. In cases where there are several
message sequences directed to the same endpoint URL, you can specify a custom
sequence key to identify each sequence. Each sequence is then uniquely identied
by the endpoint URL and the user-specied sequence key. The sequence key can
be provided as the input of the pub.soap.wsrm:createSequence service or as the input
parameter of the web service connector.
Client sequence Id. Unique identier that is generated by a reliable messaging client
and associated with a reliable messaging sequence. To ensure that a client can
identify the message as part of a particular sequence, the reliable messaging server
species the client sequence Id when it sends a SOAP response to the reliable
messaging client.
Server sequence Id. Unique identier that is generated by a reliable messaging
server and associated with a reliable messaging sequence. To ensure that a
server can identify the message as part of a particular sequence, the reliable
messaging client species the server sequence Id while sending a SOAP request
to the reliable messaging server. The server sequence Id of a message sequence is
returned as the output parameter of the pub.soap.wsrm:createSequence service or as
the reliableMessagingInfo/responseReliableMessagingProperties/serverSequenceId output
parameter of the web service connector.
Acknowledgement. Response from the reliable messaging destination to the reliable
messaging source indicating that the message has been successfully received by the
destination.

Using Reliable Messaging in Integration Server

Keep the following points in mind when you congure Integration Server to use reliable
messaging:
Integration Server supports WS-ReliableMessaging Version 1.1 only.
The namespace prex wsrm represents the URI http://docs.oasis-open.org/wsrx/wsrm/200702.
The namespace prex wsrmp represents the URI http://docs.oasis-open.org/
ws-rx/wsrmp/200702.
To use WS-ReliableMessaging, you aach a standard WS-Policy, which includes
reliable messaging assertions, to a web service descriptor. For more information
about dening your own policies, see Web Services Developers Guide. For instructions
about aaching a WS-Policy to a web service descriptor, see webMethods Service
Development Help.

webMethods Integration Server Administrators Guide Version 9.10

363

Even Header
Configuring Reliable Messaging in Integration Server

To use WS-ReliableMessaging, you can aach a pre-dened WS-Policy named

ReliableMessaging that Integration Server provides. This policy is available in the
following directory:
Integration Server_directory\instances\instance_name \cong\wss\policies
Integration Server uses a unique reliable messaging sequence key to track the
progress of a set of messages that are exchanged reliably between a web service
provider and consumer.
Integration Server supports only the In Order delivery assurance for reliable
messaging.
You use the Integration Server Administrator to congure reliable messaging for web
services. By default, Integration Server applies the reliable messaging conguration
dened on the Settings > Web Services > Reliable Messaging > Edit Configuration page to
all web service providers and consumers. If you want to override the server-level
reliable messaging conguration for a specic web service provider or consumer,
dene reliable messaging properties for the associated web service endpoint alias.
Integration Server provides pub.soap.wsrm built-in services to create and manage
reliable messaging sequences. For more information about these built-in services, see
webMethods Integration Server Built-In Services Reference.

Persistent Storage Support for Reliable Messaging Data

Integration Server provides persistent storage capability for reliable messaging
transactional data. Persistent storage support ensures that the messages that are being
exchanged between a reliable messaging source and a reliable messaging destination
are not lost in case of system or communication failures. When messages are exchanged
in distributed systems, errors can occur during the transmission of messages over
communication links or during the processing of messages in system components.
Under these conditions, Integration Server ensures that no messages are lost and that
messages can be eventually recovered after system failure.
Integration Server provides support for persistent storage of information related to
reliable messaging sequences, including the essential routing and delivery information.
Keep the following points in mind while conguring Integration Server to provide
persistent storage capability for reliable messaging:
The ISInternal functional alias (specied on the Settings > JDBC Pools screen) must
be congured to point to either the embedded IS Internal database or to the external
RDBMS that Integration Server must use for persistent storage.
If the Integration Servers used for reliable message exchanges are in a clustered
environment and are connected to the same database, all the Integration Servers
must have the same persistence conguration dened on the Settings > Web Services >
Reliable Messaging > Edit Configuration page.

webMethods Integration Server Administrators Guide Version 9.10

364

Odd Header
Configuring Reliable Messaging in Integration Server

Integration Server supports reliable messaging in a clustered environment only if

you congure Integration Server to provide persistent storage capability for reliable
messaging.
For the authentication details to be persisted across Integration Server restarts, you
must provide the authentication details for the consumer web service descriptor
in the associated consumer endpoint alias and not in the associated connector
signature.

Limitations When Using Reliable Messaging in Integration Server

Integration Server supports only WS-ReliableMessaging Version 1.1.
Integration Server does not support reliable messaging over JMS.
Because of interoperability issues with WS-Security and WS-ReliableMessaging
standards, Integration Server does not support reliable messaging if the aached
reliable messaging policy contains both WS-ReliableMessaging and WS-Security
policy assertions.
Integration Server does not support the following WS-ReliableMessaging assertions:
wsrmp:SequenceSTR
wsrmp:SequenceTransportSecurity

Configuring Reliable Messaging in Integration Server

Use Integration Server Administrator to congure reliable messaging for web services.
To configure reliable messaging properties
1. Open Integration Server Administrator.
2. In the Navigation panel, select Settings > Web Services.
3. Click Reliable Messaging.
4. Click Edit Reliable Messaging Configuration.
5. Under Reliable Messaging Properties, provide the following information:
In this field...

Specify...

Retransmission Interval

The time interval (in milliseconds) for which a reliable

messaging source waits for an acknowledgement from a
reliable messaging destination before retransmiing the
SOAP message. The default is 6000 milliseconds.

webMethods Integration Server Administrators Guide Version 9.10

365

Even Header
Configuring Reliable Messaging in Integration Server

In this field...

Specify...

Acknowledgement
Interval

The time interval (in milliseconds) for which a reliable

messaging destination waits before sending an
acknowledgement for a message sequence. Messages
of the same sequence received within the specied
acknowledgement interval are acknowledged in one
batch. If there are no other messages to be sent to the
acknowledgement endpoint within the time specied as
the acknowledgement interval, the acknowledgement is
sent as a stand-alone message.
The default is 3000 milliseconds.

Exponential Backoff

Inactivity Timeout

Whether to use the exponential backo algorithm to

adjust the retransmission interval of unacknowledged
messages. Adjusting the time interval between
retransmission aempts ensures that a reliable
messaging destination does not get ooded with a large
number of retransmied messages.
Select...

To...

true

Increase the successive retransmission

intervals exponentially, based on the
specied retransmission interval. For
example, if the specied retransmission
interval is 2 seconds, and the exponential
backo value is set to true, successive
retransmission intervals will be 2, 4, 8, 16,
32, and so on if messages continue to be
unacknowledged. This is the default.

false

Use the same time interval specied in

the Retransmission Interval eld for all
retransmissions.

The length of time for which a reliable messaging

source waits for an acknowledgement from a reliable
messaging destination before the source stops
retransmiing the SOAP message. Specify the unit of
measurement as seconds, minutes, hours, or days.
If the reliable messaging source does not receive
an acknowledgement within the inactivity timeout
specied, it marks the sequence as timed out. You
cannot use a sequence if it is timed out. To specify that

webMethods Integration Server Administrators Guide Version 9.10

366

Odd Header
Configuring Reliable Messaging in Integration Server

In this field...

Specify...
there is no inactivity timeout limit, set the value of
Inactivity Timeout to -1.
The default is 60 seconds.

Sequence Removal
Timeout

The length of time for which a reliable messaging

source waits after a sequence is terminated before
removing the sequence state from memory. Specify the
unit of measurement as seconds, minutes, hours, or
days. The default is 600 seconds.

In-Order Delivery
Assurance

Whether the messages in a sequence must be delivered

to a reliable messaging destination in the same order in
which they were sent by the reliable messaging source.
Select...

To...

True

Specify that the messages in a sequence

must be delivered to the destination in the
same order in which they were sent. This
is the default.

False

Not enforce the delivery of messages in

the same order in which were sent.

Maximum
Retransmission Count

The number of times a reliable messaging source must

retransmit a message if an acknowledgement is not
received from the reliable messaging destination.
To specify that there is no limit to the number of
retransmission aempts, set the value of Maximum
Retransmission Count to -1. The default is 10.

Storage Type

Species whether Integration Server uses the persistent

or non-persistent mode to store the reliable messaging
sequence information.
Select...

To...

NonPersistent

Use a non-persistent mode of storage of

reliable messaging sequence information.
When the Non-Persistent mode of storage is
used, Integration Server relies on the onheap memory for reliable messaging data
storage. When Integration Server restarts,
the reliable messaging information will

webMethods Integration Server Administrators Guide Version 9.10

367

Even Header
Configuring Reliable Messaging in Integration Server

In this field...

Specify...
be removed from memory. This is the
default.
Database

Housekeeping Interval

Use a persistent mode of storage of

reliable messaging information. When
the Database mode of storage is used,
Integration Server uses a database to store
the reliable messaging information. All
information related to reliable messaging
sequences, including the essential routing
and delivery information, is preserved
across Integration Server restarts.

The time interval (in seconds) in which Integration

Server sweeps the database to check for timed-out or
terminated sequences.
The messages are timed out or terminated depending
on the specied Inactivity Timeout and Sequence Removal
Timeout values. Integration Server sweeps the database
periodically based on the Housekeeping Interval and
identies and marks the messages that are timed out
and removes the terminated messages.
The default is 20 seconds.

6. Click Save Changes.

Reliable Messaging Sequence Reports

A sequence report provides information about the reliable message sequences that
Integration Server is processing or has completed processing. This report includes the
client and server sequences, that is, the reliable message sequences that Integration
Server as a reliable messaging client has sent or received and that Integration Server as a
reliable messaging server has received or sent.

Client and Server Sequences

Field

Description

User Sequence
Key

Unique key identifying a message sequence. The value of

User Sequence Key is the same as the value specied in the
sequenceKey input parameter of the pub.soap.wsrm:createSequence

webMethods Integration Server Administrators Guide Version 9.10

368

Odd Header
Configuring Reliable Messaging in Integration Server

Field

Description
service or as the reliableMessagingProperties/sequenceKey
parameter of the web service connector.

Client
Sequence Id

Unique identier that is generated by the reliable messaging

client and associated with a reliable messaging sequence.

Server
Sequence Id

Unique identier that is generated by the reliable messaging

server and associated with a reliable messaging sequence. This
Id is returned by Integration Server as the serverSequenceId
output parameter of the pub.soap.wsrm:createSequence service or
the reliableMessagingInfo/responseReliableMessagingProperties/
serverSequenceId output parameter of the web service connector.

To Address

The endpoint address with which the reliable messaging

sequence is established.

Status

Status of the message sequence.

Number of
Completed
Messages

Count of messages in the message sequence that have been

delivered and acknowledgement messages have been received.

Last Activated

Timestamp that species the time when the last message in the
sequence was transmied.

Acknowledgement
Request

Sends an acknowledgement request to the reliable messaging

server. For more information about sending a request for
acknowledgement, see "Sending an Acknowledgement Request"
on page 371.

Close

Closes the sequence. For more information about closing a

sequence, see "Closing a Sequence" on page 370.

Terminate

Terminates the sequence. For more information about

terminating a sequence, see "Terminating a Sequence" on page
370.

Viewing Reliable Messaging Sequence Reports

You can view details about message sequences in the Reliable Messaging screen in
Integration Server Administrator.

webMethods Integration Server Administrators Guide Version 9.10

369

Even Header
Configuring Reliable Messaging in Integration Server

To view the reliable messaging sequence report

1. Open Integration Server Administrator.
2. In the Navigation panel, select Settings > Web Services.
3. Click Reliable Messaging.
Integration Server displays the sequence reports under Client Sequences and Server
Sequences.

Closing a Sequence
You can close a message sequence if you do not want a reliable messaging client to send
any new messages using the specied sequence, other than those already accepted and
being processed by the reliable messaging server.
When a reliable messaging sequence is closed, the reliable messaging server will not
accept any new messages of the same sequence. However, the reliable messaging server
will continue to track the closed sequence and respond to acknowledgment requests for
messages in the closed sequence.
Only a reliable messaging client can close a message sequence. After a reliable
messaging sequence is closed, only a client can terminate the sequence. If there is no
activity related to the closed sequence over the specied inactivity timeout interval, the
reliable messaging client marks the sequence as timed out.
To close a sequence
1. Open Integration Server Administrator.
2. In the Navigation panel, select Settings > Web Services.
3. Click Reliable Messaging.
4. Under Client Sequences, locate the sequence that you want to close and click the Close
link.

Terminating a Sequence
You can terminate a reliable messaging sequence without waiting for all the messages
in the sequence to be acknowledged. Only a reliable messaging client can terminate
a message sequence. A terminate sequence request from a reliable messaging client
indicates that the sequence is complete and that it will not be sending any further
messages related to the sequence. You can, however, reuse the sequence key of the
message sequence only after the Sequence Removal Timeout period has elapsed.
To terminate a sequence
1. Open Integration Server Administrator.

webMethods Integration Server Administrators Guide Version 9.10

370

Odd Header
Configuring Reliable Messaging in Integration Server

2. In the Navigation panel, select Settings > Web Services.

3. Click Reliable Messaging.
4. Under Client Sequences, locate the sequence that you want to terminate and click the
Terminate link.

Sending an Acknowledgement Request

You can direct the reliable messaging client to request the reliable messaging server to
acknowledge a specic message sequence.
To send an acknowledgement request
1. Open Integration Server Administrator.
2. In the Navigation panel, select Settings > Web Services.
3. Click Reliable Messaging.
4. Under Client Sequences, locate the sequence for which you want to send an
acknowledgement request to the reliable messaging server. Under Acknowledgement
Request, click the Send link.

webMethods Integration Server Administrators Guide Version 9.10

371

Even Header

webMethods Integration Server Administrators Guide Version 9.10

372

Odd Header
Configuring Integration Server to Use Kerberos

15 Configuring Integration Server to Use Kerberos

Overview .....................................................................................................................................

374

About Kerberos ..........................................................................................................................

374

Prerequisites to Configuring Kerberos .......................................................................................

375

Limitations When Using Kerberos Authentication in Integration Server ....................................

375

Configuring Integration Server to Use Kerberos ........................................................................

376

JAAS Contexts for Kerberos ......................................................................................................

379

Troubleshooting Kerberos Configuration ....................................................................................

379

webMethods Integration Server Administrators Guide Version 9.10

373

Even Header
Configuring Integration Server to Use Kerberos

Overview
Kerberos is an authentication protocol that uses symmetric encryption and a trusted
third party system to validate the identity of clients. The Kerberos protocol provides
authentication over open and insecure networks in which communication between the
hosts can be intercepted.
You can use Integration Server to enable and congure Kerberos authentication for
service requests. Integration Server provides support for using Kerberos authentication
with the following types of requests:
Inbound and outbound HTTP and HTTPs requests at the transport level.
Inbound and outbound web service requests.

About Kerberos
Kerberos authentication system consists of the following:
A Kerberos client that needs to access and use Kerberos services.
A trusted third-party system, specically a key distribution center (KDC).
A server that hosts services that are accessible using Kerberos authentication.
Kerberos authentication is comprised of these phases:
1. Authentication phase. Client authenticates itself to the authentication service and
requests a long-term ticket granting ticket.
2. Service authorization phase. Client uses the ticket granting ticket to request a ticket for
the specic service it wants to invoke.
3. Service invocation phase. Client sends the request to invoke the target service,
including the service ticket obtained in the service authorization phase. If the server
hosting the requested service authenticates the service ticket, the server invokes the
requested service.

Kerberos Terminology
Before conguring Integration Server to use Kerberos authentication, you may nd it
helpful to rst understand the following terminology:
Key Distribution Center (KDC). The trusted third party system that provides
authentication and ticket granting services and hosts the principal database. That is,
the KDC consists of an authorization server, a ticket-granting server, and a database
that contains the principals and their keys.

webMethods Integration Server Administrators Guide Version 9.10

374

Odd Header
Configuring Integration Server to Use Kerberos

Realm. All the computers that are managed by the KDC and secondary KDCs, if any,
constitute the realm. That is, the realm includes all the nodes that share the same
Kerberos database.
Principal. A service or user that is known to the Kerberos system. Each Kerberos
principal is identied by its principal name. Principal names consist of three parts:
a service or user name, an instance name, and a realm name in the following form:
principal-name.instance-name@realm-name
Service principal name. The principal name of the service as registered with the
principal database.
Keytab file. The le consisting of a set of principals and their passwords. It can contain
the principal password encrypted using dierent encryption algorithms.
Kerberos configuration file. The le that contains conguration information such as
Kerberos realm, location of KDC, defaults for the current realm, and encryption
algorithms. Generally, this le is named "krb5.conf".
Subject. The user or service that is authenticated by the JAAS login context.

Prerequisites to Configuring Kerberos

Before you congure Integration Server to use Kerberos authentication, you must ensure
that:
A working key distribution center (KDC) is set up.
The KDC is congured as an LDAP directory, for authenticating incoming requests
with Kerberos tickets.
The KDC is congured as a user directory in Central Users or LDAP so Integration
Server can identify and authorize the user that is part of the Kerberos ticket
submied by the client. For more information about Kerberos authentication, see
"Kerberos Authentication" on page 450.
The Kerberos client is registered with the principal database of the KDC.
The service that you want to access is registered with the KDC.
A valid Kerberos conguration le is available.

Limitations When Using Kerberos Authentication in

Integration Server
Kerberos authentication in Integration Server currently supports only Kerberos login
module that is provided by com.sun.security.auth.module.Krb5LoginModule.

webMethods Integration Server Administrators Guide Version 9.10

375

Even Header
Configuring Integration Server to Use Kerberos

Integration Server might overwrite system properties such as

javax.security.auth.useSubjectCredsOnly if they are already present in the
client systems.
The keytab conguration is certied on JDK 1.7_45 version and above.

Configuring Integration Server to Use Kerberos

Use Integration Server Administrator to enable and congure Integration Server to use
Kerberos authentication for inbound and outbound service requests. Integration Server
passes this information to the Kerberos login module.
Keep the following information in mind when conguring Kerberos for Integration
Server:
Values specied for Realm and Key Distribution Center Host overwrite the default key
distribution center (KDC) and realm set in the KDC conguration le specied in the
Kerberos Configuration File. Do not specify values for Realm and Key Distribution Center
Host if you do not want to overwrite the default KDC and realm in the Kerberos
conguration le.
If you specify Key Distribution Center Host, you must also specify Realm, and vice versa.
To configure Kerberos authentication
1. Open Integration Server Administrator.
2. In the Navigation panel, select Security > Kerberos.
3. Click Edit Kerberos Settings.
4. On the Security > Kerberos > Edit page, under Kerberos Seings, provide the following
information:
In this field...

Specify...

Realm

The domain name of the Kerberos server, in all

uppercase leers. All the computers managed by the
KDC and secondary KDCs, if any, constitute the realm.
Example: KERBEROS.RNDLAB.LOC
This eld is optional.
Note: A value specied for Realm overwrites the realm set
in the KDC conguration le specied in Kerberos
Configuration File.

Key Distribution Center

Host

The host name of the machine on which the KDC

resides.

webMethods Integration Server Administrators Guide Version 9.10

376

Odd Header
Configuring Integration Server to Use Kerberos

In this field...

Specify...
Example: lab.kerberos.rndlab.loc
This eld is optional.
Note: A value specied for Key Distribution Center Host
overwrites the default key distribution center set
in the KDC conguration le specied in Kerberos
Configuration File.

Kerberos Configuration
File

The location of the Kerberos conguration le that

contains the Kerberos conguration information,
including the locations of KDCs, defaults for the realm
and for Kerberos applications, and the host names and
Kerberos realms mappings.

Use Subject Credentials

Only

Species whether Integration Server requires

a Kerberos V5 Generic Security Services (GSS)
mechanism to obtain the necessary credentials from
an existing subject set up by the JAAS authentication
module. Here, subject represents the user or service
being authenticated in the JAAS login context.
When the Use Subject Credentials Only check box is
selected, Integration Server requires a GSS mechanism
to obtain the credentials from an existing Subject.
Integration Server uses the Ticket Granting Ticket
(TGT) stored in the subject to establish a GSS security
context. The service ticket is also stored in the subject.
When the Use Subject Credentials Only check box is
selected, the JVM in which Integration Server runs
can use only the credentials found in the Subject in
the JAAS authentication module. The JVM cannot
use another underlying mechanism to obtain the
credentials.
When the Use Subject Credentials Only check box
is cleared, Integration Server does not require a GSS
mechanism to obtain credentials from an existing
Subject. Instead, the JVM in which Integration Server
runs can use another underlying mechanism of its
choice, such as a reading from a protected le on disk,
to obtain credentials for the Subject. The JVM rst
checks the Subject in the JAAS authentication module.
If the JVM does not nd the credentials in the JAAS
Subject, then the JVM uses an alternate credential
mechanism to obtain credentials.

webMethods Integration Server Administrators Guide Version 9.10

377

Even Header
Configuring Integration Server to Use Kerberos

In this field...

Specify...
The Use Subject Credentials Only check box must be
selected if you want to use Kerberos authentication for
service requests.

5. Click Save Changes.

Order of Precedence for Principal Name and Password

The Kerberos login module uses the principal name and password to authenticate the
principal to the key distribution center (KDC). However, you can specify principal name
and password in other locations.
You can specify the principal name in the is_jaas.cnf le, which is the JAAS login
conguration le, and the principal password in the keytab le. You must set
principal=client_principal_name and useKeyTab=true in the is_jaas.cnf le
to use the specic principal name and the corresponding password specied in the
keytab le.
Note:

If you use this mode to specify the principal, the use of the Kerberos login
module is restricted to that principal.

For inbound service requests, you can also specify the principal name and password
in the port conguration.
For outbound services requests, you can specify the principal name and password
in the pub.client:http service in the clientPrincipal and clientPassword elds in the auth
\kerberos document.
For inbound and outbound web service requests, you can also specify the principal
name and password in the web service endpoint alias.
For outbound web service requests, you can also specify the principal name and
password at run time in the web service connector using the clientPrincipal and
clientPassword in the auth\message\kerberosSeings document.
For service requests, Integration Server uses this order of precedence when determining
which principal name and password to use:
1. The principal name in the is_jaas.cnf le and the corresponding password specied
in the keytab le.
2. For inbound service requests, the principal name and password specied in the port
conguration, if present.
For outbound service requests, the principal name and password specied in the
pub.client:http service, if present.
For web service requests, Integration Server uses this order of precedence when
determining which principal name and password to use:

webMethods Integration Server Administrators Guide Version 9.10

378

Odd Header
Configuring Integration Server to Use Kerberos

1. The principal name in the is_jaas.cnf le and the corresponding password specied
in the keytab le.
2. For outbound web service requests, the principal name and password specied at
run time in the web service connector, if present.
3. For inbound and outbound web service requests, the principal name and password
specied in the web service endpoint alias, if present.

JAAS Contexts for Kerberos

The is_jaas.cnf le distributed with Integration Server includes two JAAS contexts for
use with Kerberos.
IS_KERBEROS_INBOUND for use with inbound requests.
IS_KERBEROS_OUTBOUND for use with outbound requests.
The JAAS conguration le for Integration Server is in the following location:
Integration Server_directory\instances\instance_name \cong\is_jaas.cnf
You can use the JAAS contexts supplied in is_jaas.cnf or add your own.

Troubleshooting Kerberos Configuration

I receive the following error when I execute the web service connector: org.apache.axis2.AxisFault:
Error in building kerberos token.
Possible reasons for this error are:
The format of the JAAS context is incorrect.
There are no Kerberos login modules congured for the specied principal name.
The absolute path of the keytab le specied in the JAAS context is incorrect.
The encryption algorithm in the keytab le is dierent from the one used by
KDC.
The JDK version you are using is lower than JDK 1.7_45. The keytab
conguration is certied on JDK 1.7_45 version and above.
I receive the following error when I execute the web service connector: Pre-authentication
information was invalid (24) KrbException: Identifier doesn't match expected value (906).
Possible causes for this error are:
The truststore or the keytab le is corrupt. In such cases, Software AG
recommends that you recreate these les and place them in a location that is not
frequently accessed.

webMethods Integration Server Administrators Guide Version 9.10

379

Even Header
Configuring Integration Server to Use Kerberos

Your system time and the time in the system that hosts the KDC are not the
same. The clocks in these two systems cannot be out of sync for by more than 300
seconds, which is the default clockskew.

webMethods Integration Server Administrators Guide Version 9.10

380

Odd Header
Setting Up HTTP URL Aliases

16 Setting Up HTTP URL Aliases

Overview .....................................................................................................................................

382

Creating an HTTP URL Alias .....................................................................................................

383

Enabling Partial Matching of URL Aliases .................................................................................

388

Displaying HTTP URL Aliases ...................................................................................................

389

Editing a URL Alias ....................................................................................................................

390

Deleting a URL Alias .................................................................................................................

390

Portability of URL Aliases and Possible Conflicts .....................................................................

391

webMethods Integration Server Administrators Guide Version 9.10

381

Even Header
Setting Up HTTP URL Aliases

Overview
An HTTP URL alias is an alias that you create to replace a portion of the URL to a
resource on Integration Server. The URL alias typically replaces the path portion of the
URL which identies the name and location of the resource. For example, when you
create a URL alias for a service, the alias replaces the invoke directive and the name and
location of the service on Integration Server. A client request for the service includes
the alias instead of the invoke directive and the service information. When Integration
Server receives the request, Integration Server invokes the service associated with the
alias.
You can associate a URL alias with items such as services, HTML pages, dynamic
server pages (DSP), an image le, web services, or a WmTomcat resource. In addition to
associating a URL alias with a single resource, you can also identify a dierent resource
for a URL alias based on the incoming port for the request. This makes it possible to
dene a single URL alias that resolves to dierent destinations based on the incoming
port of the HTTP request. In addition, you can also dene the "empty path" as an alias,
allowing the denition of a default destination for any incoming port.
URL aliases have several benets:
A URL alias may be easier to type than full URL path names.
If a resource has a URL alias, it can be easier to move resources on Integration Server.
An administrator updates the alias information to point to the new location; there is
no need to notify users of the change.
A URL alias is more secure than URL path names because users do not see directory,
service, or le names.
Note:

A URL alias can be used with HTTP or HTTPS ports only.

You can create a URL alias from Designer or Integration Server Administrator.
Create an alias from Integration Server Administrator if you want to:
Assign an alias to a resource other than a Flow, Java, C, Adapter, or XSLT service.
For example, from Integration Server Administrator, you can associate an alias with
a DSP, HTML, jpg, web service, or WmTomcat resource.
Create a URL alias for a REST resource.
Associate more than one URL alias with a particular resource.
Create an alias for the empty path.
Specify a port-specic destination for a particular URL alias.
If you want to create a single URL alias for a service, consider using Designer. When you
use Designer to create a URL alias, you do not need to specify the URL path. If Designer
was used to create the URL alias, you can move a service from one folder to another
without having to update the path name assigned to the alias. For more information

webMethods Integration Server Administrators Guide Version 9.10

382

Odd Header
Setting Up HTTP URL Aliases

about creating URL aliases for services in Designer, see webMethods Service Development
Help.

Creating an HTTP URL Alias

When you create a URL alias, you create an association between an alias and a resource
on Integration Server. Keep the following information in mind when creating a URL
alias:
You can create a URL alias for a request that comes through an HTTP or HTTPS port
only.
An alias name must be unique across Integration Server.
You can associate a single URL alias with multiple destinations by specifying port
mappings. A port mapping correlates the alias with a dierent URL alias based on
the port on which th request was received. For more information about creating port
mappings for a URL alias, see "Using Port Mappings with a URL Alias" on page
385.
You can create a URL alias for the empty path (/) for a hostname:port combination,
such as localhost:5555. By creating an empty path alias, you can specify a default
destinations for any incoming port. For more information about the empty path
alias, see "Using a URL Alias for the Empty Path" on page 387.
If you want to use URL alias with a REST resource you must enable partial matching
of URL aliases. For more information, see "Enabling Partial Matching of URL
Aliases" on page 388.
If you enabled or intend to enable partial matching of URL aliases, do not dene
an alias that begins with another alias. For more information, see "Enabling Partial
Matching of URL Aliases" on page 388.
You can create an HTTP URL alias for a service using Designer as well as Integration
Server. However, if you want to use the same URL alias for more than one service or
a service and other resources, you must create the URL alias using Integration Server
Administrator. For instructions on creating an HTTP URL alias from Designer, see
webMethods Service Development Help.
To create an HTTP URL alias
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > URL Aliases.
3. Click Create URL Alias.
4. Under URL Alias Properties, provide the following information:
For this parameter...

Specify...

Alias

A name for the alias.

webMethods Integration Server Administrators Guide Version 9.10

383

Even Header
Setting Up HTTP URL Aliases

For this parameter...

Specify...
The alias name cannot include a space, nor can it include
the following characters:
#%?<\
The alias name cannot begin with the string "hp://"
There is no length restriction for the alias.
Note: Do not specify an alias if you intend to use this URL
alias for the empty path.

Use as empty path

alias

Select this check box if you want to use this alias for the
empty path.
When you select the Use as empty path alias check box,
Integration Server changes the alias to <EMPTY>.

Default URL Path

The path to the resource on Integration Server. For details

on how to specify a URL path for the dierent types of
destinations, see "Specifying the URL Path" on page 385.
You must specify a Default URL Path eld if you do not
dene any port mappings for the URL alias.
If the URL alias includes port mappings, the Default URL
Path eld is optional. However, it might be useful to supply
a Default URL Path value so that a request received on a port
for which there is not a port mapping will fall through
to the default URL path. If a URL alias species a port
mapping but does not specify a Default URL Path value,
Integration Server uses the alias as the URL path.
The URL path cannot include a space or the following
characters: # % ? < \

Package

Name of the package with which you want to associate this

alias.

5. If you want to dene a dierent destination for the URL alias based on the incoming
port, create a port mapping. For information, see "Using Port Mappings with a URL
Alias" on page 385. do the following:
6. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

384

Odd Header
Setting Up HTTP URL Aliases

Specifying the URL Path

The URL path denes the resource to which the alias resolves. You specify a URL path
for the URL alias and/or for port mappings dened for a URL alias.
Following are examples of formats for the URL path for dierent resources:
If the resource is a service:
invoke/folder_name.subfolder_name /service_name
If the resource is a REST resource:
rest/folder_name/subfolder_name
If the resource is not a service or a REST resource:
package_name /le_name.ext
Note:

The URL path cannot include a space or the following characters:

#%?<\

Using Port Mappings with a URL Alias

For a URL alias, you can create one or more port mappings which associates a port with
a resource. Because the URL path can be dierent for each port, using port mappings
allows the use of a single URL alias with multiple destinations. You might want to dene
a dierent destination for each business partner.
When Integration Server receives a request that contains a URL alias, Integration Server
resolves the request destination by rst determining if there is a URL path associated
with the incoming port. If there is not a URL path mapped to the port number, then
Integration Server uses the default URL path for the alias as the request destination. Port
mappings are always evaluated rst.
For example, in the following URL alias named Order, when an HTTP request that
includes the alias Order is received on the port 6677, Integration Server invokes the
service processing.expedite:processOrder. For a HTTP request that uses the alias Order
that is received on any port besides 6677, Integration Server invokes the service
Order:processsOrder.

webMethods Integration Server Administrators Guide Version 9.10

385

Even Header
Setting Up HTTP URL Aliases

Adding a Port Mapping to a URL Alias

You can create multiple port mappings for a URL alias.IKeep the following points in
mind when dening a port mapping for a URL alias:
You can dene a port mapping for a URL alias crated in Integration Server
Administrator only. You cannot dene a port mapping for URL alias dened for a
service using Designer.
Incoming requests with the URL alias received on a port for which there is not a port
mapping resolve to the path specied in the Default URL Path eld. If the alias does
not specify a Default URL Path value, Integration Server uses the alias as the URL path.
To add a port mapping to a URL alias
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > URL Aliases.
3. In the HTTP URL Alias list, select the URL alias for which you want to dene port
mappings.
4. Under Port Mappings, in the New Port Number list, select the port for which you want
to specify an alternate destination. Integration Server lists all of the dened HTTP
and HTTPS ports.
5. In the New URL Path eld, specify the path to resource that you want to use as the
destination. The URL path cannot include a space or the following characters: # % ?
<\
For information about how to specify dierent resources, see "Specifying the URL
Path" on page 385.
6. Under Add Mapping, click

to add the port mapping to the alias.

7. Repeat steps 4 to 6 for each port for which you want to specify a dierent destination
than that in the Default URL Path eld.
8. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

386

Odd Header
Setting Up HTTP URL Aliases

Deleting a Port Mapping for a URL Alias

You can delete any of the port mappings added to a URL alias.
Note:

If you intend to delete all of the port mappings for a URL alias, make sure the
URL alias species a Default URL Path value.

To delete a port mapping for a URL alias

1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > URL Aliases.
3. In the HTTP URL Alias list, select the URL alias for which you want to delete a port
mapping.
4. Under Port Mappings, click
want to delete.

in the Delete column for the port mapping that you

5. Repeat the preceding step for each port mapping that you want to delete for an alias.
6. Click Save Changes.

Using a URL Alias for the Empty Path

You can create a URL alias for the empty path for any HTTP/S port. You can dene
one destination to be used by all HTTP/S ports. Or, by adding a port mapping for each
port, you can dene a dierent default destination for the empty path for any incoming
HTTP/S port. You can also dene port mappings for the empty path for particular ports
and a default destination for all other parts.
Integration Server considers either of the following to be an empty path:
host :port
host :port /
A URL alias for the empty path has a predened alias name of <EMPTY>. Each
Integration Server can have one <EMPTY> alias only.
Note:

Integration Server Administrator can be accessed with the URL request

host :port /WmRoot.

Creating a URL Alias for the Empty Path

You can create a new URL alias for use as the empty path alias or you can convert an
existing alias created in Integration Server Administrator to the empty path alias. Note
that a URL alias created for a service using Designer cannot be used as the empty path
alias.

webMethods Integration Server Administrators Guide Version 9.10

387

Even Header
Setting Up HTTP URL Aliases

To create a URL alias for the empty path

1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > URL Aliases.
3. Do one of the following:
In the HTTP URL Alias list, select the URL alias that you want to use as the
empty path alias. On the Settings > URL Alias >aliasName > Edit page, select the
Use as empty path alias check box. Integration Server changes the alias name to
<EMPTY>.
Click Create URL Alias. On the Settings > URL Alias > Create page, select the Use as
empty path alias check box. Integration Server changes the alias to <EMPTY>.
Specify the remaining conguration information for a URL alias. For more
information abut creating a URL alias, see "Creating an HTTP URL Alias" on
page 383.
4. Click Save Changes.

Enabling Partial Matching of URL Aliases

In some cases, URL requests include identiers for a particular resource. Because these
identiers vary for each instance of a resource, URL requests might not exactly match
any of the dened URL aliases for a particular resource. To enable you to dene URL
aliases for such resources, Integration Server can use partial matching to process URL
requests. A partial match occurs when a request URL matches or begins with only part of
a URL alias.
When partial matching is enabled and Integration Server receives a request URL, an
alias is considered a match if the entire alias matches all or the beginning of the request
URL, starting with the rst character of the request URL's path.
For example, if URL alias a2 has a URL path of rest/purchasing/invoice and Integration
Server receives the following request URL:
hp://MyHost:5555/a2/75909
The request URL matches the a2 alias and resolves to the path: hp://MyHost:5555/rest/
purchasing/invoice/75909.
Integration Server retains the trailing characters of the request URL. In this case,
Integration Server retains the /75909.
Note:

If you want to use URL alias with a REST resource you must enable partial
matching of URL aliases. For information about dening URL aliases for REST
resources, see REST Developers Guide.

If you enable partial matching of URL aliases, do not dene an alias that begins with
another alias. For example, do not dene an alias named a22 if an alias named a2 already

webMethods Integration Server Administrators Guide Version 9.10

388

Odd Header
Setting Up HTTP URL Aliases

exists. Integration Server evaluates a request URL in ascending alphabetical order. When
a URL alias starts with the same characters as another alias, Integration Server will not
match the longer alias. If you dene a2 and a22 as URL aliases, Integration Server will
never match a22 because Integration Server matches any request URL that includes the
a22 alias to the a2 alias instead.
To enable Integration Server to use partial matching of URL requests
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Extended.
3. Click Edit Extended Settings.
4. Add the following to the Extended Settings box:

watt.server.url.alias.partialMatching=true.

5. Click Save Changes.

6. Restart Integration Server.

Displaying HTTP URL Aliases

To display a list of all HTTP URL aliases dened on Integration Server, you must view
them from Integration Server Administrator.
To display a list of all URL aliases
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > URL Aliases.

About HTTP URL Alias Association

The Settings > URL Aliases page displays aliases that were created from Integration
Server Administrator and aliases that were created from Designer. The contents of the
Association column indicate the tool used to create the URL alias.
Value

Description

Package

Indicates the alias was created from Integration Server

Administrator.

service_name

Indicates the alias was created from Designer. When you

create an alias from Designer, you can view it from Designer
or Integration Server. In addition, you can move a service from
one folder to another without having to update the path name
assigned to the alias.

webMethods Integration Server Administrators Guide Version 9.10

389

Even Header
Setting Up HTTP URL Aliases

Value

Description

Server

Indicates that the alias was created in an earlier version of

Integration Server and was migrated to this Integration Server.
The alias works at this point, but the only change you can make
to it is to update the package association. Once you update the
package association, you can view and change the alias as you
would other HTTP URL aliases.

From Designer, you can display the HTTP URL alias assigned to an individual service.
Designer displays a service's alias only if the alias was created from Designer or
Developer.
Note:

When an HTTP URL alias is migrated from an earlier release of Integration

Server, the alias is displayed on the HTTP URL Alias List screen with "Server"
in the Association eld and nothing in the Package eld. The alias is functional
at this point, but the only change you can make to it is to update the package
association. Once you update the package association, you can view and
change the alias as you would other HTTP URL aliases.

Editing a URL Alias

You can use Integration Server Administrator to edit URL aliases created in Integration
Server Administrator only. You cannot edit URL aliases created in Designer.
To edit a URL alias
1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > URL Aliases.
3. In the HTTP URL Alias list, select the URL alias that you want to edit.
4. Make the changes to the URL alias.
5. Click Save Changes.

Deleting a URL Alias

You can use Integration Server Administrator to delete URL aliases created in
Integration Server Administrator or in Designer.
Note:

Integration Server Administrator automatically deletes all URL aliases

associated with a package when you delete or disable the package.

webMethods Integration Server Administrators Guide Version 9.10

390

Odd Header
Setting Up HTTP URL Aliases

To delete a URL alias

1. Open Integration Server Administrator if it is not already open.
2. In the Navigation panel, select Settings > URL Aliases.
3. Locate the row that contains the alias you want to delete, and click the

icon.

Integration Server prompts you to conrm that you want to delete the alias.
4. Click OK

Portability of URL Aliases and Possible Conflicts

From Designer, you can move a service from one folder to another and the alias will stay
with the service.
From Integration Server, when you use the Integration Server package replication
feature to copy a package from one Integration Server to another, any HTTP URL aliases
associated with the package stay with it. This is true whether the alias was created from
Integration Server or from Designer or Developer.
When you receive a package from another Integration Server, it is possible that an alias
associated with the new package has the same name as an HTTP URL alias already
dened on your Integration Server.
Integration Server maintains a registry of HTTP URL alias names, and displays the
contents of this list on the Settings > HTTP URL Alias screen. Integration Server builds
this list when it loads packages during server startup, and when an alias is added,
edited, or deleted. In cases where two packages are associated with the same alias name,
Integration Server uses the alias associated with the rst of the two packages to load.
When the second package is loaded, Integration Server ags its associated alias as a
duplicate, and does not add it to the registry.
In other words, Integration Server uses package load order to determine precedence.
WmRoot is always loaded rst. The order in which other packages are loaded depends
on other factors, such as package dependencies and operating system, and therefore
cannot be easily predicted.
For this reason, when you install a package that was published by another Integration
Server, check the details screen for the package (Packages > Management >
package_name ) for load warnings.

webMethods Integration Server Administrators Guide Version 9.10

391

Even Header

webMethods Integration Server Administrators Guide Version 9.10

392

Odd Header
Configuring Integration Server to Connect to an SFTP Server

17 Configuring Integration Server to Connect to an

SFTP Server

Overview of SFTP ......................................................................................................................

394

Creating an SFTP Server Alias .................................................................................................

394

Creating an SFTP User Alias ....................................................................................................

396

webMethods Integration Server Administrators Guide Version 9.10

393

Even Header
Configuring Integration Server to Connect to an SFTP Server

Overview of SFTP
The SSH File Transfer Protocol (SFTP) is a network protocol that is based on the Secure
Shell protocol (SSH). SFTP facilitates secure le access, le transfer, and le management
over any reliable data stream.
You can congure Integration Server to connect to an SFTP server to perform the
following tasks using the SFTP protocol:
Transfer les between Integration Server and the SFTP server. You can get a le from
the SFTP server and store it in the local machine or upload a le from your local
machine to the SFTP server.
Access les in the SFTP server. You can view the directories and les in the SFTP
server and also view their permissions and ownership information.
Manage directories or les in the SFTP server. You can create, rename, or delete les
or directories in the SFTP server. You can also change the permissions or ownership
of les in the SFTP server.
You can use Integration Server Administrator to dene the following SFTP aliases:
SFTP server alias. The SFTP server alias contains conguration parameters that
Integration Server uses to connect to an SFTP server.
SFTP user alias. The SFTP user alias contains client conguration parameters that
Integration Server uses to authenticate and function as an SFTP client.

Creating an SFTP Server Alias

An SFTP server alias is a named set of parameters that Integration Server uses to connect
to an SFTP server.
Important: You must create at least one SFTP server alias before creating an SFTP user
alias.
To create an SFTP server alias
1. Open Integration Server Administrator.
2. In the Navigation panel, select Settings > SFTP.
3. Click Create Server Alias.
4. Under SFTP Server Alias Properties, provide the following information:
For this parameter...

Specify...

Alias

A name for the SFTP server alias.

webMethods Integration Server Administrators Guide Version 9.10

394

Odd Header
Configuring Integration Server to Connect to an SFTP Server

For this parameter...

Specify...
An SFTP server alias name:
Can contain only underscores (_) and periods (.) as special
characters.
Cannot begin with the string "hp://".
Can be of a maximum length of 255 characters.

Host Name or IP
Address

The host name or IP address of the SFTP server.

Port Number

The port number of the SFTP server. The port number must
be within the range of 0 and 65535 (inclusive).

Host Key Location

The location of the public key of the SFTP server.

Integration Server validates the SFTP server using the public
key of the SFTP server.
The public key le must be present on the same
Important:
machine in which you have installed Integration
Server.
If you do not have the public key of the SFTP server, click
Get Host Key. Integration Server will retrieve the public
key for the host and port you specied and save it in a
temporary folder. Integration Server will then display the
path to the temporary folder in Host Key Location eld.

5. Click Save Changes.

Integration Server stores the SFTP server alias conguration including the host key
information in the Integration Server_directory/instances/instance_name /cong/sftp/
sftpServerAliases.cnf le.

Editing an SFTP Server Alias

You can edit only the Host Name or IP Address, Port Number, and Host Key Location
properties. You cannot leave the Host Name or IP Address and Port Number elds empty.
To edit an SFTP server alias
1. Open Integration Server Administrator.
2. In the Navigation panel, select Settings > SFTP.
3. In the SFTP Server List, click the name of the SFTP server alias that you want to edit.

webMethods Integration Server Administrators Guide Version 9.10

395

Even Header
Configuring Integration Server to Connect to an SFTP Server

4. In the properties screen for the selected alias, make the necessary modications.
5. Click Save Changes.

Creating an SFTP User Alias

An SFTP user alias is a named set of parameters that contains SFTP user account details
and client congurations that Integration Server uses to function as an SFTP client.
In many organizations, a system administrator provides the SFTP user account
information that you require to create an SFTP user alias.
You can have multiple SFTP user aliases for the same SFTP user account. Each SFTP user
alias name in an Integration Server must be unique.
Keep the following points in mind when conguring Integration Server to act as an SFTP
client:
Integration Server supports password authentication and public key authentication
for authenticating itself as the client to the SFTP server.
For both password and public key authentication, you must have an account on the
SFTP server that is set up for SFTP access.
For public key authentication, the SFTP server and Integration Server must have
access to their own private key and each other's public key.
Important: You must create at least one SFTP server alias before creating an SFTP user
alias.
To create an SFTP user alias
1. Open Integration Server Administrator.
2. In the Navigation panel, select Settings > SFTP.
3. Click User Alias Settings.
4. Click Create User Alias.
5. Under SFTP User Alias Properties, provide the following information:
For this parameter...

Specify...

Alias

A name for the alias.

An SFTP user alias name:
Can contain only underscores (_) and periods (.) as the
special characters.
Cannot begin with the string "hp://".

webMethods Integration Server Administrators Guide Version 9.10

396

Odd Header
Configuring Integration Server to Connect to an SFTP Server

For this parameter...

Specify...
Can be of a maximum length of 255 characters.

User Name

The user name for the SFTP user account.

Authentication
Type

The type of authentication that Integration Server uses to

authenticate itself to the SFTP server. Client authentication
can be either by password or by public and private keys.
Select...

To...

Password

Use password authentication.

Public Key

Authenticate Integration Server by using

public and private keys.
To use this authentication type, the
SFTP server and Integration Server
must each have access to their own
private key and each other's public key.
If you select public key authentication,
Integration Server saves the private key
le in the Integration Server_directory/
instances/instance_name /cong/sftp/
identities folder.

Password

If you are using password authentication, enter the

password for the specied user to connect to the SFTP
server.

Re-type Password

Re-enter the above password.

Private Key
Location

If you selected Public Key as the authentication type, enter

the location of the private key of the specied SFTP user.

PassPhrase

If you selected Public Key as the authentication type and if

the private key you specied requires a passphrase, enter
the passphrase for the private key le of the specied user.

Re-type
PassPhrase

Re-enter the above passphrase.

SFTP Server Alias

The alias of the SFTP server to which you want the specied
user to connect.

webMethods Integration Server Administrators Guide Version 9.10

397

Even Header
Configuring Integration Server to Connect to an SFTP Server

For this parameter...

Specify...

Preferred Key
Exchange
Algorithm

The algorithms that Integration Server presents to the SFTP

server for key exchange.

Maximum Retries

The number of times Integration Server aempts to connect

to the SFTP server. The maximum allowed value is 6. The
minimum allowed value is 1. The default is 6 retries.

Connection
Timeout (seconds)

The amount of time (measured in seconds) Integration

Server waits for a response from the SFTP server before
timing out and terminating the request. The default is 0,
which indicates that the session will never time out.

Session Timeout
(minutes)

The number of minutes you want Integration Server to wait

before terminating an idle session. The default is 10 minutes.

Compression

Whether or not to compress the data to reduce the amount

of data that is transmied. Integration Server supports
compression using the compression algorithm zlib.

You can specify the order in which Integration Server

presents the algorithms to the SFTP server by moving the
available algorithms up or down by clicking Up or Down.
The SFTP server has its own set of preferred algorithms
congured. At the time of key exchange, one of the
algorithms supported by both Integration Server and the
SFTP server will be chosen.

Note: You can use compression only if the SFTP server that
you are connecting to supports compression.

Compression
Level

Select...

To...

zlib

Compress the data that is transmied

between the SFTP server and Integration
Server.

None

Not compress the data.

The compression level to use if you selected the

compression algorithm zlib in the Compression eld. The
minimum allowed value is 1 (fast, less compression). The
maximum allowed value is 6 (slow, most compression). The
default is 6.

webMethods Integration Server Administrators Guide Version 9.10

398

Odd Header
Configuring Integration Server to Connect to an SFTP Server

For this parameter...

Specify...

Proxy Alias

The proxy alias through which the request is to be routed.

The proxy alias can be HTTP, HTTPS, or SOCKS. If a proxy
alias is not specied, Integration Server makes outbound
requests using each enabled proxy server alias until the
request is sent successfully or all proxy servers have
been tried. For more information about proxy aliases, see
"Creating a Proxy Server Alias" on page 123.

6. Click Save Changes.

Integration Server saves the user alias conguration in the
Integration Server_directory/instances/instance_name /cong/sftp/sftpUserAliases.cnf
le.

Editing an SFTP User Alias

You can edit all the elds except the alias name and the user name for the SFTP user
account.
To edit an SFTP user alias
1. Open Integration Server Administrator.
2. In the Navigation panel, select Settings > SFTP > User Alias Settings.
3. In the SFTP User List, click the name of the SFTP user alias that you want to edit.
Integration Server displays the properties screen for that alias.
4. In the properties screen for the selected alias, make the necessary modications.
5. Click Save Changes.

Testing the Connection to the SFTP Server

After you add an SFTP user alias, you can test the connection to ensure that Integration
Server can establish a connection with the SFTP server using the credentials and details
you specied for the alias.
To test the connection to an SFTP server
1. Open Integration Server Administrator.
2. In the Navigation panel, select Settings > SFTP > User Alias Settings.
Integration Server Administrator displays all the SFTP user alias denitions.
3. In the Test column for the alias that you want to test, click the

icon.

Integration Server Administrator displays a status line that indicates whether or not
the connection is successful.

webMethods Integration Server Administrators Guide Version 9.10

399

Even Header

webMethods Integration Server Administrators Guide Version 9.10

400

Odd Header
Securing Communications with the Server

18 Securing Communications with the Server

Overview .....................................................................................................................................

402

Anatomy of an Integration Server SSL Connection ...................................................................

402

Roadmap for Configuring SSL ...................................................................................................

404

Keystores and Truststores .........................................................................................................

407

Configuring Server-Side SSL Settings .......................................................................................

414

Controlling Server SSL Security Level by Port ..........................................................................

415

Storing SSL Information for the Integration Server JVM in a Secure Manner ...........................

415

Usage of CA Certificates: Technical Considerations .................................................................

417

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

418

Using SAML for Web Service Client Authentication ..................................................................

418

webMethods Integration Server Administrators Guide Version 9.10

401

Even Header
Securing Communications with the Server

Overview
An administrator can congure the Integration Server to use Secure Sockets Layer
(SSL) to provide secure communications with the server. This chapter explains how
SSL works with Integration Server, and the information that you need to congure SSL
authentication for the server side.
For information about how Integration Server authenticates clients, and conguring the
SSL client side, see "Authenticating Clients" on page 447.

Anatomy of an Integration Server SSL Connection

It is useful to conceptualize an Integration Server SSL connection in terms of an SSL
server and an SSL client. The request for an SSL connection originates from a client. The
client can be one of the following:
A partner application
An Internet resource
A web browser
An Integration Server
During the SSL handshake process, the entity acting as the SSL server responds to the
request for a connection by presenting its SSL credentials (an X.509 certicate) to the
requesting client. If those credentials are authenticated by the client, either:
An SSL connection is established and information can be exchanged between the
client and server.
- or The next phase of the authentication process occurs, and the server requests the SSL
credentials of the client. If the server veries those credentials (that is, the client's
identity), an SSL connection is established and information exchange can take place.

Integration Server and SSL Connection Type

The types of SSL connection referred to above are termed one-way and two-way SSL
authentication:
In a one-way SSL connection, an anonymous client authenticates the credentials of
a server in preparation for seing up a secure transaction. In most cases, the server
knows nothing about the client's identity because verication of its credentials is not
required. When desired, however the client can be authenticated by means such as
basic username/password.

webMethods Integration Server Administrators Guide Version 9.10

402

Odd Header
Securing Communications with the Server

This type of authentication typies connections where a browser establishes a

connection to an Internet server to perform a secure transaction (for example,
viewing a savings account, or buying items with a credit card). The client must
authenticate the server's credentials before initiating the transaction, but it is not
necessary (nor would it be practical) for the server to authenticate and keep a record
of every possible client (browser).
For Integration Server, this type of connection is typically one where a partner
application or resource needs to verify the authenticity of the Integration Server
without itself needing to be authenticated.
In a two-way SSL connection, both client and server must authenticate each
other's credentials before an SSL connection is established and information can be
exchanged.
Unlike a one-way SSL connection, both Integration Server and the partner
application or resource require access to each other's SSL certicates in order to
authenticate each other, establish an SSL connection, and transmit information.
Compared to a one-way connection, a two-way SSL connection provides a much
higher level of security.

Integration Server as an SSL Server

When an IS client or partner application submits a request to Integration Server via
HTTPS or FTPS, and a two-way SSL connection is established, the IS client acts as the
SSL client and the Integration Server acts as the SSL server.

Integration Server as an SSL Client

When an Integration Server service submits an HTTPS or FTPS request to an Internet
resource, the Integration Server is the SSL client and the Internet resource with which it
is communicating acts as the SSL server.

webMethods Integration Server Administrators Guide Version 9.10

403

Even Header
Securing Communications with the Server

Roadmap for Configuring SSL

The following table provides a high-level roadmap for conguring SSL on Integration
Server.
Task
Create
Integration
Server keys and
certicates

Activities
Generate a public key/private key
pair.
Generate a certicate signing
request (CSR) and send to the
certicate authority (CA) for
signing.
Receive validated certicate from
the CA.

Notes
Required for oneway and two-way
SSL connections.
Refer to the
documentation
for Java keytool or
your certicate
management tool.

Import signed certicate into a

keystore.
Create keystore
and truststore
for Integration
Server

Create a keystore and import the

signed certicate and private key.
Create a truststore and import the
certicate of the signing CA.
Store the keystore and truststore
in a secure IS certicates directory.
Create aliases for the keystore and
truststore.
If you use Oracle keytool
Important:
to create the keystore, you
cannot import an existing
private key. You can use

webMethods Integration Server Administrators Guide Version 9.10

Required for oneway and two-way

SSL connections.
Refer to the
following:
The documentation
for your certicate
management tool
"Creating Keystore
Aliases" on page
410

404

Odd Header
Securing Communications with the Server

Task

Activities

Notes
other tools such as OpenSSL
or Portecle.

Obtain
certicates
of partner
application or
resource
- and Create certicate
mapping

Add an HTTPS
or FTPS port
(if none are
dened)

Use the Integration Server

Administrator to save the
following:
Signed certicate of the partner
application.
Signed certicate of the CA for the
partner's SSL certicate.

If you want to allow only secure

connections to the server:
Ensure that the primary port uses
an HTTPS port.
Delete all other non-HTTPS ports.
Add additional HTTPS or FTPS
ports as required.

Required for
two-way SSL
connections.
Refer to the
following:
"Importing a
Certicate (Client
or CA Signing
Certicate) and
Mapping It to a
User" on page
452
Required for oneway and two-way
SSL connections.
Refer to
"Conguring Ports"
on page 155.

Creating Integration Server Keys and Certificates

Use a standard certicate management tool, such as OpenSSL or Portecle, to generate a
private/public key pair for Integration Server. Then, place the public key in a certicate
signing request (CSR).
After creating the CSR, send to the CA to sign the CSR. Request the certicate in DER
format. If you receive a certicate in PEM format (or any format other than DER), you
need to convert it to DER format.
The signing CA's certicate aests to the identity of the CA that signed the digital
certicate for the Integration Server. The CA should send this certicate to you when it
sends you the digital certicate for the Integration Server.
Once you receive your signed certicate from the CA, you need to import the certicate
into a keystore. You will then have an SSL certicate and private key to use with
Integration Server.

webMethods Integration Server Administrators Guide Version 9.10

405

Even Header
Securing Communications with the Server

In general, you will repeat the steps after creation of the key pair about every year or
two years, at the time you need to renew the certicate.
If certicates contain certicate extensions that you want Integration Server to
validate, set the wa.security.cert.wmChainVerier.enforceExtensionsChecks server
conguration property to true.
Note:

The above process is described in general terms. The procedures may vary
somewhat, depending upon the CA that you use.

Creating a Keystore and Truststore

Keystores and truststores are les that function as repositories for storage of keys and
certicates necessary for SSL authentication, encryption/decryption, and digital signing/
verication services. Keystores and truststores provide added layers of security and ease
of administration, compared to maintaining the keys and certicates in separate les.
For information about creating keystores and truststores, importing keys and certicates
into keystores and truststores, and other operations with these les, refer to the
documentation for your certicate management tool.
For information about using Integration Server with keystores and truststores and how
to create aliases for these les, see "Keystores and Truststores" on page 407.

Obtaining the Certificates and Keys of the Partner Application

If your Integration Server will run services that submit HTTPS or FTPS requests to
other resources on the Internet, the Integration Server will be acting as a client and will
receive certicates from these resources. In order for these transactions to work, your
Integration Server must have copies of their public keys and signing CA certicates.
Refer to "Authenticating Clients" on page 447 for information on importing client
certicates to Integration Server and seing up client authentication.

Configuring an HTTPS or FTPS Port

Integration Server requires an HTTPS or FTPS port for SSL connections.
If you want to allow only secure connections to the server, ensure that the primary port
uses an HTTPS port and delete all other non-HTTPS ports. Add as many additional
HTTPS or FTPS ports as you want. Make sure no other applications are listening on the
port you want to use.
You can further congure HTTPS and HTTPS diagnostic ports and the pub.client:http
service to use Java Secure Socket Extension (JSSE) for handling inbound and outbound
communications. JSSE is required to support TLS 1.1 or 1.2. When congured,
Integration Server uses the JSSE socket factory to create outbound socket connections.
For more information about conguring ports to use JSSE, see "Conguring Ports"

webMethods Integration Server Administrators Guide Version 9.10

406

Odd Header
Securing Communications with the Server

on page 155. For more information about seing JSSE in the pub.client:http service, see
webMethods Integration Server Built-In Services Reference.
Note:

When you congure a port to use JSSE and a client presents a certicate that
Integration Server does not trust, Integration Server rejects the request and it
will not fall back to use basic credentials (user name/password). If there is no
certicate mapping, Integration Server issues an invalid credentials error.

For HTTPS protocol, the standard port is 443.

For information about conguring an HTTPS or FTPS port, see "Conguring Ports" on
page 155.

Keystores and Truststores

Integration Server stores its private keys and SSL certicates in keystore les and the
trusted roots for the certicates in truststore les. Keystores and truststores are secure
les with industry-standard le formats.

Keystore File
Integration Server uses a special le called a keystore to store SSL certicates and keys.
A keystore le contains one or more pairs of a private key and signed certicate
for its corresponding public key. The keystore should be strongly protected with a
password, and stored (either on the le system or elsewhere) so that it is accessible only
to administrators.

Keystore File Formats

The default, certicate le format for an Integration Server keystore is JKS (Java
keystore), the proprietary keystore implementation provided by Oracle. You can also
use PKCS12, a commonly used, standardized, certicate le format that provides a high
degree of portability. Other keystore types can be made available by:
Loading additional security providers
Seing the wa.security.keyStore.supportedTypes property.

HSM-Based Keystores
Under certain conditions, Integration Server supports the use of keystore les stored on
a Hardware Security Module (HSM). Integration Server supports HSM-based keystores
for ports, but not for other components. You cannot use HSM-based keystores with
remote server aliases, outbound certicates, an internal server port, WS-Security, or
Integration Server public services.
Only nCipher hardware card modules are currently supported.

webMethods Integration Server Administrators Guide Version 9.10

407

Even Header
Securing Communications with the Server

Creating a Keystore
You can create and manage Integration Server keystores at the command line using
keytool, the Oracle Java certicate editor.
You can also use other standard tools such as OpenSSL and Portecle.
Note:

Software AG does not provide its own set of keystore utilities for creating or
managing keystore les.

Truststore File
Integration Server uses a truststore to store its trusted root certicates, which are the
public keys for the signing CAs. Although a truststore can contain the trusted roots
for entire certicate chains, there is no requirement for the organization of certicates
within an Integration Server truststore. It simply functions as a database containing all
the public keys for CAs within a specied trusted directory.

Truststore File Formats

The default format for a truststore is Java keystore (JKS). JKS is the proprietary keystore
implementation provided by Oracle. You can create and manage JKS truststores at the
command line using keytool, the Oracle Java certicate editor.

How Integration Server Uses a Keystore and Truststore

For an Integration Server component to be SSL authenticated, it must have a valid,
authorized X.509 certicate installed in a keystore le and the private key and signing
certicate for the certicate issuer (CA) installed in a truststore le. The following gure
illustrates these requirements and the relationship between the two les.

webMethods Integration Server Administrators Guide Version 9.10

408

Odd Header
Securing Communications with the Server

Example Truststore File and Keystore File Showing Relationship

As shown in the above gure, the same truststore le can contain multiple trusted
root certicates (public keys for the signing CAs). These trusted roots might be
associated with numerous keystore les. A keystore le can contain the key pairs for
multiple Integration Server components, and the entire certicate chain required for a
component's authentication.
With a certicate chain, it is necessary to validate each subsequent signature in the list
until a trusted CA certicate is reached. For Integration Server, you must include the
entire chain of certicates in a keystore and truststore. Also, any root CA certicates in
use by clients must be in an Integration Server truststore.

Protecting Keystore and Truststore Files

Keystore and truststore les exist within the le system of your operating system, and
since these are critically important les, you want to maintain them in a secure directory
path. If either of the these les cannot be located, Integration Server authentication will
be disabled and no connection with the server can be made. It is recommended that only
users serving as My webMethods or Integration Server administrators have access to
these certicate les.

Keystore, Truststore, and Key Aliases

To identify a particular keystore or truststore le, or private key within a keystore,
Integration Server uses aliases. This use of aliases is the same as that by Java keytool and

webMethods Integration Server Administrators Guide Version 9.10

409

Even Header
Securing Communications with the Server

other certicate management tools. The use of aliases simplies keystore and truststore
management, because you do not need to enter path information when specifying a
keystore, truststore, or private key in Integration Server Administrator or when using
Integration Server public services.
You can view, create, and edit keystore and truststore aliases from the Security > Keystore
panel in Integration Server Administrator.
Note:

Keystore and truststore aliases are not case-sensitive.

A key alias is a label for specic key within a keystore. Key aliases are created using
your third-party certicate management tool. Although you do not create key aliases
in Integration Server Administrator, you will need to identify which keys to use for
SSL authentication, signing, and decrypting, by selecting the appropriate key aliases in
Integration Server Administrator.

Default Keystore and Truststore Aliases

Integration Server creates default keystore and truststore aliases the rst time
Integration Server starts.
Important: Use these aliases only in development environments where testing
and debugging is performed. Do not use these aliases in a production
environment.
The following table lists the predened keystore and truststore aliases for Integration
Server.
Default Alias

Description

DEFAULT_IS_
KEYSTORE

The name of the default keystore alias for Integration Server. The
DEFAULT_IS_KEYSTORE points to the Software AG_directory/
common/conf/keystore.jks le.and the default password is
manage for all the entries.

DEFAULT_IS_
TRUSTSTORE

The name of the default truststore alias for Integration Server.

The DEFAULT_IS_TRUSTSTORE points to Software AG_directory/
common/conf/platform_truststore.jks le and the default
password is manage for all the entries.

You can edit and delete the default aliases. The certicate le format of the default
keystore and truststore is Java keystore (JKS). The provider for the default keystore and
truststore alias is the one shipped with the JVM.

Creating Keystore Aliases

The following procedures shows how to assign aliases to keystore les that you have
created with the Oracle Java keytool or with another third-party certicate tool.

webMethods Integration Server Administrators Guide Version 9.10

410

Odd Header
Securing Communications with the Server

To create an alias for a keystore file

1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Keystore.
3. Click Create Keystore Alias.
4. Enter the Keystore Properties seings as follows:
For this setting

Specify or select...

Alias

A text identier for the keystore le.

The keystore contains the private keys and certicates
(including the associated public keys) for an Integration
Server, partner application, or Integration Server component.

Description

Optional. A text description for the keystore alias.

Type

The certicate le format of the keystore le, which by

default is JKS for keystores. You can also use PKCS12 format
for a keystore.
Other keystore types can be made available by:
Loading additional security providers.
Seing the wa.security.keyStore.supportedTypes server
conguration parameter.

Provider

The provider that is used for the keystore or truststore type.

The default provider is the one shipped with the JVM, which
can be Oracle, IBM, or others.
Generally, you should specify a provider only if your HSM
device is not supported by the default provider.
You can congure a dierent provider to support keystore
types other than the default. Integration Server supports both
PKCS12 and JKS for keystores, but only supports JKS for
truststores.

Location

Path location of the keystore le on the server.

You can specify the full-path name, or a relative path in
relation to the Integration Server.

Password / Retype Password

Password for the saved keystore le associated with this

alias.

webMethods Integration Server Administrators Guide Version 9.10

411

Even Header
Securing Communications with the Server

For this setting

Specify or select...
If the keystore requires a password, the password must
have been dened at keystore creation time using a keystore
utility. Once you create the keystore alias, the keystore
password is automatically saved as an Integration Server
outbound password.
Make sure you have the keystore password available when
managing its corresponding keystore alias. If the keystore
does not require a password, leave the elds empty.

HSM-based
Keystore

Indicates whether the keystore le is stored on a Hardware

Security Module (HSM) device. Only nCipher hardware card
modules are currently supported.
If you select this option, no path is specied in the Location
eld.

5. Click Submit.
6. Enter the Key Aliases seings as follows:
For this setting...

Specify or select...

Password / Retype Password

Password for each alias found in the keystore.

Null

Indicates that no password is required for the alias.

Most aliases require a password. If Integration Server

needs to use this alias for any reason, you must provide its
password.

Select this for an alias in the keystore that is not secured with
a password.
7. Click Save Changes.

Creating Truststore Aliases

The following procedures shows how to assign aliases to truststore les.
To create an alias for a truststore file
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Keystore.
3. Click Create Truststore Alias.
4. Enter the Truststore Properties seings as follows:

webMethods Integration Server Administrators Guide Version 9.10

412

Odd Header
Securing Communications with the Server

For this setting

Specify or select...

Alias

A text identier for the truststore le.

The truststore contains the trusted CA certicates for an
Integration Server, partner application, or Integration Server
component.

Description

Optional. A text description for the truststore alias.

Type

The certicate le format of the truststore, which by default

is JKS.
Other truststore types can be made available by:
Loading additional security providers.
Seing the wa.security.trustStore.supportedTypes server
conguration property.

Provider

The provider that is used for the truststore type. The default
provider is the one shipped with the JVM, which can be
Oracle, IBM, or others.
Specify a provider only if your HSM device is not supported
by the default provider.
You can congure a dierent provider to support keystore
types other than the default (JKS); however, Software AG
does not provide support for their use.

Location

Path location of the truststore le on the server.

You can specify the full-path name, or a relative path in
relation to the Integration Server.

Password / Retype Password

Supplied password that is used to protect the contents of the

truststore.
This password must have been dened at truststore creation
time using a keystore utility. Once you create the truststore
alias, its password is automatically saved as an Integration
Server outbound password.
Make sure you have the truststore password available when
managing its corresponding truststore alias.

5. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

413

Even Header
Securing Communications with the Server

Configuring Server-Side SSL Settings

The conguration seings covered in this section deal with the Integration Server SSL
server side. Conguring SSL for Integration Serverclients entails mapping their X.509
certicates to Integration Server users. This information is covered in "Customizing
Authentication Using JAAS" on page 461.
Note:

The SSL certicate seings described in this section are also used for
Integration Server web services, and for built-in services used to secure
Integration Server XML documents. For more information, refer to the
Web Services Developers Guide and the webMethods Integration Server Built-In
Services Reference.

Before conguring SSL for Integration Server, you must have previously used your
certicate management tool to do the following:
Create at least one keystore, in JKS or PKCS12 format, containing an Integration
Server key pair to use for SSL and its corresponding key alias.
Create at least one truststore, in JKS format, containing the trusted root certicate of
the signing CA (and certicate chain, if necessary).
Create a keystore and a truststore alias.

Specifying the Integration Server SSL Authentication Credentials

The Integration Server SSL conguration seings are organized into several groups. You
can select a Keystore Alias and Key Alias for the following groups of seings:
SSL Key, which species the Integration Server private and public key pair to
use when presenting Integration Server's SSL credentials to a requesting partner
application, Internet resource, or web service.
This seing determines the Integration Server's SSL identity.
Signing Key, which species the private key with which to sign outgoing documents,
messages, and data streams from Integration Server.
Decryption Key, which species the private key to use for decrypting incoming
documents, messages, and data streams from external sources, where the
information was encrypted with the associated Integration Server public key.
For the Truststore, which species the location of the signing CA certicates for SSL
authentication, you specify its Truststore Alias.
To configure the server for SSL authentication
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Certificates.

webMethods Integration Server Administrators Guide Version 9.10

414

Odd Header
Securing Communications with the Server

3. Click Edit Certificates Settings.

Select a Keystore Alias and Key Alias for the SSL Key, Signing Key, and Decryption
Key.
Select a Truststore Alias for the Truststore.
Important: The seings on this screen are the default SSL values used to identify
the Integration Server, and specify the SSL keys to use with any
Integration Server document, web service, or built-in service. Do
not change these values without rst consulting with your system
administrator or security administrator.
4. Click Save Changes.

Controlling Server SSL Security Level by Port

You can congure your Integration Server to present dierent server certicates with
dierent ports. One reason to do this is so that dierent ports can provide dierent SSL
security levels. You determine the security level of a certicate during the certicate
signing process. You tell the certicate authority which class of certicate you need and
it creates a certicate with those aributes. Later, when you congure your ports, you
specify the certicate that has the security level you want to associate with that port.
See "Seing Up Aliases for Remote Integration Servers" on page 117 for instructions on
conguring your ports.

Storing SSL Information for the Integration Server JVM in a

Secure Manner
When using secure socket layers (SSL) with external servers, you need to congure JVM
parameters for creating SSL Context for the SSL handshake. You can set the keystore
location, truststore location, and password information using the javax.net.ssl properties
for the JVM. However, these properties take String values which can result in storing
password information in plain text somewhere on the le system. This represents a
security vulnerability.
To address this security issue, Integration Server provides a way to specify the keystore
and truststore locations and passwords in a way in which the passwords are not stored
in plain text. Specically, Integration Server provides server conguration parameters
for which you specify the keystore and truststore aliases to be used to establish the
default SSL context. At start up, Integration Server sets the javax.net.ssl properties by
obtaining the store locations and passwords from the aliases and then creates the default
SSL context.
The server conguration parameters are as follows:

webMethods Integration Server Administrators Guide Version 9.10

415

Even Header
Securing Communications with the Server

wa.server.ssl.keyStoreAlias - Name of the keystore alias for the Integration Server

keystore that contains the information needed to establish an SSL connection with
SSL-enabled servers.
wa.server.ssl.trustStoreAlias - Name of the truststore alias for the Integration Server
truststore that contains the information needed to establish an SSL connection with
SSL-enabled servers.
To store the SSL information for the JVM used by Integration Server in a secure manner
1. Create the keystore to use for creating the default SSL context.
Note:

Software AG does not provide its own set of utilities for creating or
managing keystore or truststore les.

2. If needed, create a truststore to use for creating the default SSL context.
3. Use Integration Server Administrator to create a keystore alias for the keystore
created in step 1.
For more information about creating a keystore alias, see "Creating Keystore Aliases"
on page 410.
4. If necessary use Integration Server Administratorto create a truststore alias for the
truststore created in step 2.
For more information about creating a truststore alias, see "Creating Truststore
Aliases" on page 412.
5. Use Integration Server Administrator to set the wa.server.ssl.keyStoreAlias
parameter value to be the keystore alias created in step 3.
6. If you are using a truststore, use Integration Server Administrator to set the
wa.server.ssl.trustStoreAlias parameter value to be the truststore alias created in
step 4.
7. Restart Integration Server.

Order of Precedence for the javax.net.ssl Properties

Integration Server can set the javax.net.ssl properties in the JVM can be set in various
ways. For example, you can modify the custom_wrapper.conf le such that Integration
Server sets the properties at start up. Additionally, you can use server conguration
parameters and a package start-up services to set the properties. Integration Server uses
the following precedence order to set the values of the javax.net.ssl properties in the
JVM.
1. Package start-up service.
2. The wa.server.ssl* server conguration parameters, specically
wa.server.ssl.keyStoreAlias

webMethods Integration Server Administrators Guide Version 9.10

416

Odd Header
Securing Communications with the Server

wa.server.ssl.trustStoreAlias
3. The wa.cong.systemProperties server conguration parameters.
4. custom_wrapper.conf

Usage of CA Certificates: Technical Considerations

Following are technical considerations for usage of CA certicates and trusted certicate
directories.

Handling Expired CA Certificates

At times, one or more CA certicates in a chain may pass their expiration dates. When
a web browser connects to the Internet resource having such an expired certicate,
it might still accept the connection. The web browser can accept the connection if it
can access a valid certicate for the CA with the expired certicate. Integration Server,
however, cannot connect to a resource with an expired signing certicate in the chain,
unless explicitly congured to do so.
In certain cases, you may want Integration Server to accept a connection when one or
more of its CA certicates are expired. In cases such as these, you may need to change a
server conguration property. For more information, refer to "Working with Extended
Conguration Seings" on page 130. Remember to restart the server after changing the
seing.
Note:

It is less secure to ignore the expired certicates than to deny the connection
because of expired certicates.

Customizing Usage of the Trusted Certificates Directory

Most of the time you will want to specify a trusted certicates directory; however,
there may be times when you do not want to. For example, you might want to trust
all certicate authorities on outbound requests and trust specic CAs on dierent
ports for incoming requests. For outbound requests (a certicate the server receives
from a server that it submits a request to), if you do not specify a directory, or specify
a directory that does not contain certicates for CAs, by default, the server trusts all
certicate authorities. The server conguration property that controls this behavior
(wa.security.cert.wmChainVerier.trustByDefault) is set to True by default. If this
property is set to False and no directory or an empty directory is specied, the server
will trust no certicates for outbound requests.
For inbound requests, you can specify a trusted certicates directory at the server
level (on the Security Certicates screen) or at the port level (on the Edit HTTPS Port
Conguration screen or the Edit FTPS Port Conguration screen). If you omit a trusted
authorities directory (or specify a directory that does not contain CA certicates) from
both the server level and the port level, the server will trust no certicate authorities. If

webMethods Integration Server Administrators Guide Version 9.10

417

Even Header
Securing Communications with the Server

you specify a trusted authorities directory at the server level and at the port level, the
server uses the directory specied at the port level for determining trust on connections
being made to that port. If you specify a trusted authorities directory at just the port
level, the server uses the port-level seing for requests being made to the port.
For S/MIME signature trust validation, if you do not specify a trusted certicates
directory or specify a directory that does not contain the certicates of trusted
CAs, by default the server trusts all signatures on S/MIME messages. However, if
wa.security.cert.wmChainVerier.trustByDefault is set to False and no directory or an
empty directory is specied, the server will trust no signatures on S/MIME messages.

WS-Security and Integration Server

Integration Server supports the WS-Security standard for use with web services. In
contrast to transport-based authentication frameworks such as HTTPS and FTPS, which
secure the endpoints of a connection against threats, WS-Security secures the message
transmission environment between endpoints. Authentication information, which is
included in the SOAP message header, can be saved in X.509 certicates, user name
tokens or SAML tokens, and may include the actual certicates or references.
The focus of this chapter is on the use of transport-based security with Integration
Server. However, when conguring an Integration Server web service for WS-Security,
you specify its SSL, signing, and decryption keys with Integration Server Administrator
the same as you would for seing up transport-based security (see "Specifying the
Integration Server SSL Authentication Credentials" on page 414). If you intend to use
WS-Security with your Integration Server-based web services, see webMethods Service
Development Help and the Oasis Standards documentation for WS-Security.

Using SAML for Web Service Client Authentication

If you want to use policies based on WS-SecurityPolicy for authentication and those
policies require SAML tokens, you must set up Integration Server so that it can process
the SAML tokens. Integration Server supports SAML tokens only in policies aached to
provider web service descriptors for inbound requests.
For an inbound request message received by a provider web service, Integration
Server must be able to validate the SAML token using the Java Authorization and
Authentication Service (JAAS) login modules of Integration Server.

Requirements for Using SAML for Authentication

The following table lists the requirements that must be met so that Integration Server
can process SAML tokens in policies based on WS-SecurityPolicy.

webMethods Integration Server Administrators Guide Version 9.10

418

Odd Header
Securing Communications with the Server

Requirement

Description

Security Token
Service (STS)
provider

Determine which STSs you want Integration Server to trust.

Clients can use any STS provider that generates SAML 1.0 or
2.0 tokens. The generated SAML token must:
Contain the client certicate if Integration Server is to
process Holder-of-Key (HOK) type SAML assertions.
Integration Server uses the client certicate to identify the
client and map the client to an Integration Server user.
Be signed by the STS.

Certificates for
each possible
issuer of SAML
assertions

Create a truststore that contains the public keys of each

STS. For more information about creating a truststore, see
"Creating a Keystore and Truststore" on page 406.

Identification of
trusted issuers

Identify trusted STSs to Integration Server. For instructions,

see "Identifying Trusted STSs to Integration Server " on page
419.

Client certificate
mapping

If Integration Server is to process Holder-of-Key (HOK)

type SAML assertions, which contain the public key of the
client, you must map the clients public key to an Integration
Server user. For more information about conguring client
certicates, see "Client Certicates" on page 450.

Identifying Trusted STSs to Integration Server

If you want to use policies based on WS-SecurityPolicy that include SAML tokens for
client authentication, you must set up Integration Server so that it can process the SAML
tokens. One of the requirements is to identify STSs you want Integration Server to trust.
For a full list of requirements, see "Requirements for Using SAML for Authentication" on
page 418.
To identify a trusted STS to Integration Server
1. In Integration Server Administrator, go to Security > SAML.
2. Click Add SAML Token Issuer.
3. Provide information in the following elds:

webMethods Integration Server Administrators Guide Version 9.10

419

Even Header
Securing Communications with the Server

For this parameter...

Specify...

Issuer Name

Name of a SAML token issuer from which Integration

Server should accept and process SAML assertions. This
value must match the value of the Issuer eld in the SAML
assertion.
Integration Server will reject SAML assertions from issuers
not congured on this screen and will log a message
similar to the following to the Server log:
2010-06-09 23:35:38 EDT [ISS.0012.0025E] Rejecting SAML
assertion from issuer "SAMPLE_STS" because issuer is not
configured on the Security > SAML screen.

Truststore Alias

A text identier for the truststore, which contains the

public keys of the SAML token issuer. Integration
Server populates the Truststore Alias list with the existing
truststore aliases.

Certificate Alias

A text identier for the certicate associated with the

truststore alias. Integration Server populates the Certificate
Alias list with the certicate aliases from the selected
truststore alias.

Clock Skew

Clock dierence between your Integration Server and the

SAML token issuer.

4. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

420

Odd Header
Controlling Access to Resources

19 Controlling Access to Resources

Overview .....................................................................................................................................

422

Controlling Access to Resources by Port ..................................................................................

422

Controlling the Use of Directives ...............................................................................................

433

Controlling Access to Resources with ACLs .............................................................................

435

webMethods Integration Server Administrators Guide Version 9.10

421

Even Header
Controlling Access to Resources

Overview
When the server receives a clients request to access a service, the server performs a
number of checks to make sure the client is allowed to access the service. The server
performs the following checks, in the order shown below. The client must pass all checks
to access the service:
1. Does the port allow connections from this clients IP address?
The server checks allow/deny lists of IP addresses that are allowed to connect to the
server through this port. If the port is an Enterprise Gateway external port and the
server is licensed for webMethods Enterprise Gateway, the server also checks the
Enterprise Gateway deny list. If the IP address is allowed, the server performs the
next test. Otherwise, the server rejects the request.
2. Is the requested service available from this port?
The server checks allow/deny lists of services that the server makes available for
execution from this port. If the service is available from this port, the server performs
the next test. Otherwise the server rejects the request. The server performs this test
for requests to execute services. It does not perform this test for requests for list, read,
or write access to services.
3. Is the requesting user allowed to access this service?
The server checks the user name associated with the request against the appropriate
access control list (ACL) associated with the service.
The server checks the user name against the List, Read, Write, or Execute ACL
associated with the service. If the user belongs to a group that is listed in the ACL,
the server accepts the request. Otherwise the server rejects the request.
You can congure these seings using the Integration Server Administrator.
To limit IP addresses that connect to a port see "Restricting IP Addresses that Can
Connect to a Port" on page 423 below.
To limit the services available from a port see "Restricting the Services or Web
Service Descriptors Available from a Port" on page 429.
To use access control lists to control which users can access an element see
"Controlling Access to Resources with ACLs" on page 435.

Controlling Access to Resources by Port

By default, the Integration Server provides an HTTP port at 5555 that allows all hosts
(identied by their IP addresses) to connect to it and allows access to all services through
that port (unless prohibited by an ACL). Although this port is ideal for initial Integration
Server installation and conguration, as well as many development environments,
for deployment, you should replace this port with ports that allow connections from

webMethods Integration Server Administrators Guide Version 9.10

422

Odd Header
Controlling Access to Resources

only specied IP addresses (those of your partners and users) and make only specied
services available.
Note:

By default, the Integration Server also provides a diagnostic port at 9999 that
allows all hosts to connect to the server. However, users can access only the
services dened with the Administrators ACL.

This section describes controlling access to resources at the port level. To control access
using Access Control Lists, see "Controlling Access to Resources with ACLs" on page
435.

Restricting IP Addresses that Can Connect to a Port

For any given port, you can specify IP access one of two ways:
Deny by Default. Set up the port to deny requests from all hosts except for ones you
explicitly allow. Use this approach if you want to deny most hosts and allow a few.
Allow by Default. Set up the port to allow requests from all hosts except for ones you
explicitly deny. Use this approach if you want to allow most hosts and deny a few.
You can specify these seings globally (for all ports) or individually (for one port).
Note:

If the port is an Enterprise Gateway external port and the server is licensed
for webMethods Enterprise Gateway, an IP address can be further restricted
by Enterprise Gateway rules. When a request from an IP address violates a
rule, the server adds the IP address to a deny list that Enterprise Gateway
maintains.

The following table shows where to nd information about assigning the dierent types
of IP access:
Type of access

Where to look for instructions

Controlling IP Access Globally

Deny by Default

"Allow Inbound Connections from Specied

Hosts (Deny All Others)" on page 424

Allow by Default

"Deny Inbound Connections from Specied

Hosts (Allow All Others)" on page 425

Controlling IP Access of Individual

Ports
Deny by Default

"Allow Inbound Requests from Specied

Hosts (Deny All Others)" on page 426

webMethods Integration Server Administrators Guide Version 9.10

423

Even Header
Controlling Access to Resources

Type of access

Where to look for instructions

Allow by Default

"Deny Inbound Requests from Specied

Hosts (Allow All Others)" on page 427

Note:

In Software AG Command Central, the ability to control the IP access to a port

is referred to as IP Access Restrictions.

Controlling IP Access to All Ports (Globally)

This section describes how to specify the global IP access seing for ports. The server
uses this seing to determine IP access for ports that do not have a custom IP access
seing. The default global seing is Allow by Default.
When you create a port, you can customize IP access for it, or you can specify that it
use the global IP access seing for the server. If you use the global IP access seing and
later change it, the server will use the new global seing for the port. For example, as
shipped, the server uses Allow by Default as the global IP access seing (with no hosts
explicitly denied). If you create a new port 6666 and do not customize IP access for it,
the server uses Allow by Default for port 6666. If you later change the global IP access
to Deny by Default, the server will then use Deny by Default for port 6666. If you later
customize IP access to port 6666, subsequent changes to the global seing will have no
eect on port 6666.
To customize IP access for individual ports, see "Allow Inbound Requests from Specied
Hosts (Deny All Others)" on page 426 and "Deny Inbound Requests from Specied
Hosts (Allow All Others)" on page 427.
Allow Inbound Connections from Specified Hosts (Deny All Others)
The following procedure describes how to change the global IP access seing to Deny by
Default and specify some hosts to allow.
With this seing in eect, the server denies most hosts and allows some.
Important: Before you switch your global seing to Deny by Default, make sure you
have at least one port that does not rely on the global seing and allows at
least one host. If you inadvertently lock all hosts out of the server, you can
correct the problem by manually updating the appropriate conguration le.
See "If You Inadvertently Deny IP Access to All Hosts" on page 428 for
instructions.
To allow inbound requests from only specified hosts
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Click Change Global IP Access Restrictions.
4. Click Change IP Access Mode to Deny by Default.

webMethods Integration Server Administrators Guide Version 9.10

424

Odd Header
Controlling Access to Resources

The server changes the access mode and displays a screen from which you can add
hosts to the Allow List. Notice that the server has already included the host name
and IP address of the machine from which you are using the Integration Server
Administrator so that you are not locked out of the server.
5. Click Add Hosts to Allow List.
6. Specify the host names (e.g., workstation5.webmethods.com) or IP addresses (e.g.
132.906.19.22 or 2001:db8:85a3:8d3:1319:8a2e:370:7348) of hosts from which
the server is to accept inbound requests. Separate your entries with commas, for
example: *.allowme.com, *.allowme2.com.
The host names or IP addresses can include upper and lower case alphabetic
characters, digits (0-9), hyphens (-), and periods (.) but cannot include spaces. For
IPv6, IP addresses can also include colons (:) and brackets ([]).
Note:

IP addresses are harder to spoof, and therefore more secure.

You can use the following paern-matching characters to identify several clients
with similar host names or IP addresses.
Char

Description

Example

Matches any number of characters

r*.webmethods.com

Matches any single character

workstation?.webmethods.com

7. Click Add Hosts.

Deny Inbound Connections from Specified Hosts (Allow All Others)
The following procedure describes how to change the global IP access seing to Allow
by Default and specify some hosts to deny.
With this seing in eect, the server allows most hosts and denies some.
To deny inbound requests from specified hosts
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Click Change Global IP Access Restrictions.
4. Click Change IP Access Mode to Allow by Default.
The server changes the access mode and displays a screen from which you can add
hosts to the Deny List.
5. Click Add Hosts to Deny List.
6. Specify the host names (e.g., workstation5.webmethods.com) or IP addresses (e.g.
132.906.19.22 or 2001:db8:85a3:8d3:1319:8a2e:370:7348) of hosts from which
webMethods Integration Server Administrators Guide Version 9.10

425

Even Header
Controlling Access to Resources

the server is to deny inbound requests). Separate your entries with commas, for
example: *.denyme.com, *.denyme2.com.
The host names or IP addresses can include upper and lower case alphabetic
characters, digits (0-9), hyphens (-), and periods (.) and cannot include spaces. For
IPv6, IP addresses can also include colons (:) and brackets ([]).
Note:

IP addresses are harder to spoof, and therefore more secure.

You can use the following paern-matching characters to identify several clients
with similar host names or IP addresses.
Char

Description

Example

Matches any number of

characters

r*.webmethods.com

Matches any single character

workstation?.webmethods.com

7. Click Add Hosts.

Allow Inbound Requests from Specified Hosts (Deny All Others)

The following procedure describes how to change the IP access seings for an individual
port to Allow by Default and deny some hosts.
With this seing in eect, the server denies most hosts and allows some through this
port.
Important: Before you switch your global seing to Deny by Default, make sure you
have at least one port that does not rely on the global seing and allows at
least one host. If you inadvertently lock all hosts out of the server, you can
correct the problem by manually updating the appropriate conguration le.
See "If You Inadvertently Deny IP Access to All Hosts" on page 428 for
instructions.
To allow inbound requests from only specified hosts
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Locate the port in the Port List and click the Allow or Deny link in the IP Access
column.
4. Click Change IP Access Mode to Deny by Default.
The server changes the access mode and displays a screen from which you can add
hosts to the Allow List. Notice that the server has already included the host name
and IP address of the machine from which you are using the Integration Server
Administrator so that you are not locked out of the server.

webMethods Integration Server Administrators Guide Version 9.10

426

Odd Header
Controlling Access to Resources

5. Click Add Hosts to Allow List.

6. Specify the host names or IP addresses of clients from which the server is to accept
inbound requests (e.g., workstation5.webmethods.com). Separate your entries with
commas, for example: *.allowme.com, *.allowme2.com.
The host names or IP addresses can include upper and lower case alphabetic
characters, digits (0-9), hyphens (-), and periods (.) and cannot include spaces. For
IPv6, IP addresses can also include colons (:) and brackets ([]).
You can use the following paern-matching characters to identify several clients
with similar host names or IP addresses.
Char

Description

Example

Matches any number of characters

r*.webmethods.com

Matches any single character

workstation?.webmethods.com

7. Click Add Hosts.

Deny Inbound Requests from Specified Hosts (Allow All Others)

The following procedure describes how to change the IP access seings for an individual
port to Deny by Default and allow some hosts.
With this seing in eect, the server allows most hosts and denies some through this
port.
To deny inbound requests from only specified hosts
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Locate the port in the Port List and click the Allow or Deny link in the IP Access
column.
4. Click Change IP Access Mode to Allow by Default.
5. Click Add Hosts to Deny List.
6. Specify the host names or IP addresses of hosts from which the server is to deny
inbound requests (e.g., workstation5.webmethods.com). Separate your entries with
commas, for example: *.denyme.com, *.denyme2.com.
The host names or IP addresses can include upper and lower case alphabetic
characters, digits (0-9), hyphens (-), and periods (.) and cannot include spaces. For
IPv6, IP addresses can also include colons (:) and brackets ([]).
You can use the following paern-matching characters to identify several clients
with similar host names or IP addresses.

webMethods Integration Server Administrators Guide Version 9.10

427

Even Header
Controlling Access to Resources

Char

Description

Example

Matches any number of

characters

r*.webmethods.com

Matches any single character

workstation?.webmethods.com

7. Click Add Hosts.

If You Inadvertently Deny IP Access to All Hosts

If you change one or more ports to the Deny by Default seing, it is possible that you
will prevent all hosts from gaining access to server ports.
Example 1: There are 5 ports dened. The ports are congured to use the global IP access
seing and do not have allow lists for specic hosts. If you change the global IP access
seing to Deny By Default, Integration Server will not allow any hosts through any
ports.
Example 2: Two ports, 5555 and 7667, are dened. IP access for each port is handled by
the individual port. Neither port has an allow list. If you change port 5555 to Deny by
Default, then change 7667 to Deny by Default, then Integration Server will not allow
hosts to connect through either port.
Use the following procedures to correct these problems.
Resetting the Global Setting IP Access Setting
To reset the global setting IP access setting
1. Shut down Integration Server.
2. Edit the server.cnf le and locate the wa.server.hostAllow parameter.
3. Update the parameter to specify the IP address of a host that you want to be able to
access Integration Server, as in this example:
wa.server.hostAllow=132.906.19.22
or
wa.server.hostAllow=2001:db8:85a3:8d3:1319:8a2e:370:7348
4. Save the le and restart Integration Server.
5. Navigate to the Security > Ports screen, click Change Global IP Access Restrictions and
change the seing as needed. Refer to "Controlling IP Access to All Ports (Globally)"
on page 424 for more information.

webMethods Integration Server Administrators Guide Version 9.10

428

Odd Header
Controlling Access to Resources

Resetting the IP Access Setting for an Individual Port

To reset the IP access setting for an individual port
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Ports.
3. Under Port List, locate the port for which you want to reset the IP access seing and
click on the port number.
4. In the View <port type> Details screen, identify the package that is associated with it.
For example, port 5555 is typically associated with the WmRoot package.
5. Shut down Integration Server.
6. Navigate to the Integration Server_directory /instances/instance_name /
packages/package_name /cong directory for that package and open the listeners.cnf
le.
7. Locate the hostAllow parameter and update it to specify the IP address of a host you
want to allow to use this port, as in the following example:
<array name="hostAllow" type="value" depth="1">
<value>132.906.19.22</value>
</array>

8. Save the le and restart Integration Server.

9. Navigate to the Security > Ports screen and update the IP access for each port as
needed. Refer to "Allow Inbound Requests from Specied Hosts (Deny All Others)"
on page 426 and "Deny Inbound Requests from Specied Hosts (Allow All
Others)" on page 427 for more information.

Restricting the Services or Web Service Descriptors Available from a

Port
You can limit the services or provider web service descriptors that clients can invoke
through a port by seing the access mode for the port. Integration Server provides two
types of port access:
Deny By Default. This is the default type for newly created ports. Use this type to deny
access to all services and provider web service descriptors except those you specify
in a list that is associated with the port.
You might use a Deny By Default port to restrict access so only the set of services
that a single application uses are accessible through the port. Set the port to Deny
By Default and specify the services for the application in the list associated with the
port. Then, clients using the application can only access the specic services for the
application. All ports, except 5555, are initially set to Deny By Default with a limited
list of services available.

webMethods Integration Server Administrators Guide Version 9.10

429

Even Header
Controlling Access to Resources

Allow By Default. Select this type if you intend to allow access to all services and
provider web service descriptors except those you explicitly deny in a list that is
associated with the port.
When Integration Server receives a service request through a port, Integration Server
veries that the service request is allowed through that port. If the service or web service
descriptor can be invoked through the port, Integration Server continues with service or
web service descriptor execution. If access is denied, Integration Server returns an access
denied message or status to the client.
Integration Server veries port access for the top-level service only. Integration Server
does not verify port access for any child service invoked by the top-level service. For
example, suppose that serviceA invokes serviceB. Additionally, suppose that port 5678 is
congured to deny by default. serviceA is on the allow list for the port, but serviceB is not.
When Integration Server receives a request for serviceA on port 5678, Integration Server
veries that serviceA can be invoked through the port. Integration Server does not verify
that serviceB can be invoked through the port.
Similarly, Integration Server veries port access for the provider web service descriptor
only. Integration Server does not verify port access for any operations or handler
services in the web service descriptor.
Note:

By default, the Integration Server provides an HTTP port at 5555 that allows
all service requests that come in on that port access (unless prohibited by an
ACL). Although this port is ideal for initial Integration Server installation and
conguration, as well as many development environments, for deployment,
you should replace this port with ports that limit access to services you intend
to make available to your partners and users.

Note:

Another way to control access to services through a port is to restrict

access to clients that present particular client certicates. See "Customizing
Authentication Using JAAS" on page 461 for more information.

Note:

In Software AG Command Central, the access mode functionality in which

you restrict the services and web service descriptors accessible through port is
referred to as URL Access.

Allow Access to Specified Services (Deny All Others)

When a port is congured to deny by default, Integration Server denies access to most
services and provider web service descriptors. Integration Server allows access to the
services and provider web service descriptors that you specify.
You can enter services, folders, or provider web service descriptors one at a time. You
can also allow all services and provider web service descriptors associated with a
specic Execute ACL. For example, to create a custom Administrator port, you can
expose all services or provider web service descriptors protected by the Administrators
ACL.

webMethods Integration Server Administrators Guide Version 9.10

430

Odd Header
Controlling Access to Resources

Important: When performing the following procedure, do not log into the server
through the port you want to change. The procedure involves temporarily
denying access to all services through the port. If you log on through the
port you want to change and then deny access to all services through it, you
will be locked out of the server. Instead, log on through a dierent existing
port or create a new port to log on through.
To allow access to specified services, folders, and provider web service descriptors
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu in the Navigation panel, click Ports.
3. Locate the port in the Port List and click the Allow or Deny link in the Access Mode
column.
4. Click Set Access Mode to Deny by Default. Integration Server changes the access mode
for the port.
5. Click Add Folders and Services to Allow List.
6. To enter the names of services, folders, or provider web service descriptors, on the
left side of the screen, under Enter one service or folder per line, type the fully qualied
name of the service, folder or provider web service descriptor for which you want to
allow access. Press ENTER after each entry.
Note:

If you specify a folder, Integration Server allows access to all of the services
and provider web service descriptors in the folder.

7. To specify services or provider web service descriptors by selecting from a list of

elements associated with an ACL, under Select a set of folders and services on the right
side of the screen, do the following:
a. In the Select an ACL list, select the ACL used as the execute ACL for the elements
for which you want to allow access.
Integration Server Administrator displays and selects all of the elements that use
the selected ACL as the execute ACL.
b. To add all of the selected items to the allow list on the left side of the screen, click
Append Selected.
Integration Server appends the selected entries to the existing list.
c. If you do not want to add all of the items to the allow list, deselect the ones you
do not want. To deselect multiple items, press the CTRL key while deselecting.
To add the remaining items to the list of allowed services for the port, click
Append Selected.
Integration Server appends the selected entries to the existing list.
8. Repeat the above steps until you have built the list of services, folders, and provider
web service descriptors you want to make available from this port.

webMethods Integration Server Administrators Guide Version 9.10

431

Even Header
Controlling Access to Resources

9. Click Save Additions.

10. Click Return to Ports to return to the Security > Ports > Edit Access Mode screen.

Deny Access to Specified Services (Allow All Others)

When a port is congured to allow by default, Integration Server allows access to most
services and provider web service descriptors. Integration Server denies access to
specic services and provider web service descriptors.
You can enter services, folders, or provider web service descriptors in the deny list one
at a time. You can also add multiple services and provider web service descriptors to the
deny list at one time by adding all of the items associated with a specic Execute ACL.
To deny access to specified services, folders, and provider web service descriptors
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu in the Navigation panel, click Ports.
3. Locate the port in the Port List and click the Allow or Deny link in the Access Mode
column.
4. Click Set Access Mode to Allow by Default. Integration Server changes the access mode
for the port.
5. Click Add Folders and Services to Deny List.
6. To enter the names of services, folders, or provider web service descriptors, on the
left side of the screen, under Enter one service or folder per line, type the fully qualied
name of the service, folder or provider web service descriptor for which you want to
deny access. Press ENTER after each entry.
Note:

If you specify a folder, Integration Server denies access to all of the services
and provider web service descriptors in the folder.

7. To specify services or provider web service descriptors by selecting from a list of

elements associated with an ACL, under Select a set of folders and services on the right
side, do the following:
a. In the Select an ACL list, select the ACL used as the execute ACL for the elements
for which you want to deny access.
Integration Server Administrator displays and selects all of the elements that use
the selected ACL as the execute ACL.
b. To add all of the selected items to the deny list on the left side of the screen, click
Append Selected.
Integration Server appends the selected entries to the existing list.
c. If you do not want to add all of the items to the deny list, deselect the ones you
do not want. To deselect multiple items, press the CTRL key while deselecting.

webMethods Integration Server Administrators Guide Version 9.10

432

Odd Header
Controlling Access to Resources

To add the remaining items to the list of denied services for the port, click Append
Selected.
Integration Server appends the selected entries to the existing list.
8. Repeat the above steps until you have built the list of services, folders, and provider
web service descriptors for which you want to deny access on this port.
9. Click Save Additions.
10. Click Return to Ports to return to the Security > Ports > Edit Access Mode screen.
Resetting a Port to the Default Access
When you reset a port to the default access, Integration Server changes IP access to the
port so that only standard services that are required to connect to and authenticate to the
server are available. Access to other services is denied.
To reset a port to the default
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu in the Navigation panel, click Ports.
3. Locate the port with which you want to work in the Port List and click Edit in the
Access Mode column.
4. Click Reset to Default Access Settings.
Integration Server changes the type to Deny By Default and creates a default list of
allowed services. These include the standard services required to connect to and
authenticate to the server.

Controlling the Use of Directives

A directive is a way to access or invoke resources. Integration Server supports these
directives:
Directive

Used to...

default

Route requests to the document handler the Integration

Server uses to process DSP pages.

invoke

Run services.

odata

Process incoming OData service requests.

rest

Perform service invocations submied as REST requests.

webMethods Integration Server Administrators Guide Version 9.10

433

Even Header
Controlling Access to Resources

Directive

Used to...

soap

Route requests to the Integration Server SOAP message

handler.
Note: The soap directive is deprecated.
The SOAP message handler routes messages to SOAP
processors provided in versions of Integration Server prior to
version 7.1.2. These processors have since been deprecated.
The SOAP message handler also provides support for web
services developed in Integration Server version 6.5.

web

Access JSP les.

ws

Invoke web services, specically, operations in provider web

service descriptors.

Note:

JSON requests can use the invoke and rest directives only.

Users specify directives as follows:

http://host :port /directive /interface /service_name

For example:
http://localhost:5555/invoke/wm.server/ping

By default, all Integration Server ports except the proxy port allow all the directives
listed above. The proxy port allows all directives except the web directive. However,
for security reasons, an organization typically allows only those directives that are
necessary to fulll its business requirements. You might allow all directives on ports that
are accessible only to users within your rewall, but you might want to restrict directives
on ports that are exposed to users outside the rewall. For example, if you want to
receive only SOAP requests on a particular port, from both internal and external users,
you could allow the soap directive but no other directives on that port. To restrict the
use of directives to certain ports only, you set the wa.server.allowDirective parameter
(see "wa.server." on page 879).
You can specify alternative names for the invoke, soap, and rest directives. For example,
by default, the invoke directive is specied on URLs as "invoke" (that is, hp://host :port /
invoke/folder /service_name ). You can identify an alternative word for users to specify as
the invoke directive. For example, you might want to allow users to specify the invoke
directive as "submit" (that is, hp://host :port /submit/folder /service_name ).
To specify an alternative word for the invoke directive, set the
wa.server.invokeDirective parameter (see "Server Conguration Parameters" on page
851).
To specify an alternative word for the soap directive, set the wa.server.SOAP.directive
parameter (see "Server Conguration Parameters" on page 851).

webMethods Integration Server Administrators Guide Version 9.10

434

Odd Header
Controlling Access to Resources

To specify an alternative word for the rest directive, set the wa.server.RESTDirective
parameter (see "Server Conguration Parameters" on page 851).

Controlling Access to Resources with ACLs

You can use Access Control Lists (ACLs) to control access to packages, folders, les,
services and other elements that reside on the Integration Server. Specically, you can
control access to:
Services clients can invoke. You can control which groups (and therefore which users)
can invoke a service. In addition to checking ACLs to determine whether a client can
invoke a service, the server performs a number of port level checks. See "Controlling
Access to Resources by Port" on page 422 for a description of these checks and
how you can congure the server to perform them.
Special tools such as the Integration Server Administrator, Designer, and replicator functions.
These special abilities are granted by the Administrator, Developer, and Replicator
ACLs that are provided with the Integration Server.
Elements that developers can see and use. You can ne tune control over which
developers have access to which packages, folders, and other elements. For example,
one development group might have access to create, update, and maintain one set
of services, while another development group has access to a dierent set. ACLs can
prevent one development group from accidentally updating or damaging the work
of another group.
Files the server can serve. The server can serve les (for example DSP and .htm les)
that reside in the pub directory for a package or a subdirectory of the pub directory.
You can control access to these les by assigning ACLs to them in .access les. See
"Assigning ACLs to Files the Server Can Serve" on page 445 for more information
about making les available.
This section describes how to control access to resources using ACLs. To control access
at the port level, see "Controlling Access to Resources by Port" on page 422.

About ACLs
ACLs control access to packages, folders, and other elements (such as services,
document types, and specications) at the group level. An ACL identies groups that
are allowed to access an element (Allowed Groups) and/or groups that are not allowed
to access an element (Denied Groups). When identifying Allowed Groups and Denied
Groups, you select from groups that you have previously dened.
There are four dierent kinds of access: List, Read, Write, and Execute.
List. Allows a user to see that an element exists. The element will be displayed on
screens in Designer and Integration Server Administrator. List access also allows you
to view an element's metadata.

webMethods Integration Server Administrators Guide Version 9.10

435

Even Header
Controlling Access to Resources

Read. Allows a user to view the main source of an element through Designer and
Integration Server Administrator.
Write. Allows a user to edit an element. This access also allows a user to delete or lock
an element or to assign an ACL to it.
Execute. Allows a user to execute a service. This access also gives the user access to
les the server serves, such as DSP and .htm les.
List, Read, and Write ACLs are used mostly during development time by developers,
and to some extent server administrators, who need access to create, edit, and
maintain services and other elements. Execute access is used extensively in production
environments.
When a user tries to access an element, the server checks the appropriate ACL (List,
Read, Write, or Execute) associated with the element.
You cannot assign an ACL to an element unless you are a member of that ACL. For
example, if you want to allow DevTeam1 to update the OrderForm service, you must
be a member of the DevTeam1 ACL. In other words, your user name must be a member
of a group that is listed in the DevTeam1 ACL. Similarly, when you change an ACL
assignment for an element, you must be a member of the existing ACL and a member of
the ACL to which you are assigning the element.
The following table summarizes what the dierent access types mean for the dierent
elements.
Type of access and allowed actions
Element

List

Read

Write

Execute

Package

See that the

package
exists. To
see what
the package
contains,
you must
have List

N/A

N/A

N/A

access to the
elements
themselves.
This access
is not
inherited
by other
elements in
the package.

webMethods Integration Server Administrators Guide Version 9.10

436

Odd Header
Controlling Access to Resources

Type of access and allowed actions

Element

List

Read

Write

Execute

Folder

See that the

folder exists.
Children
will inherit
List access
if they do
not have
a specic
access of
their own.

Has no
meaning
for the
folder itself.
Children
will inherit
Read access
if they do
not have
a specic
access of
their own.

Add an
element to
or delete
an element
from the
folder.
Change
the ACL
assignment
for the
folder.
Children
will inherit
Write access
if they do
not have
a specic
access of
their own.

Has no
meaning
for the
folder itself.
Children
will inherit
Execute
access if
they do
not have
a specic
access of
their own.

Services
(includes
Flow, Java,
C, XSLT,
Adapter
services,
and web
service
descriptor)

See that
the service
exists. In
Designer,
the service
will be listed
along with
non-source
information.

See the
service's
source in the
Designer.

Edit, lock,
unlock, and
delete the
service.
Change
the ACL
assignment
for the
service.

Execute the
service.

Specications,
Schemas,
Flat File
Schemas,
Document
Types,
Adapter
Notications,
Triggers

See that the

element
exists.

See that the

element
exists. For a
trigger, see
the dened
conditions.

Edit, lock,
unlock, and
delete the
element.
Change
the ACL
assignment
for the
element.

N/A

webMethods Integration Server Administrators Guide Version 9.10

437

Even Header
Controlling Access to Resources

Package Replication
For package replication, the publishing server makes sure that the user performing the
replication has replication access; that is, the user is a member of the Replicator ACL.
In addition, the publishing user must have List access to the package to see it from
the publishing screens of the Integration Server Administrator. This List ACL "travels
with" the package to the subscribing server. ACLs do not travel with other namespace
elements, such as folders, services, etc.
On the subscribing server, the user installing the package must have List access to see
it from the Install Inbound Releases screen. This means that the ACL must exist on the
subscribing server and the installing user must be a member of that ACL. The installing
user does not need Write access to the package.

Implicit and Explicit Protection

If the element is explicitly protected by an ACL, the server checks the designated ACL.
If the element is not explicitly protected by an ACL, the following happens:
For elements (other than les), if the parent folder is protected by an ACL, the
element inherits the folder's protection. If the folder has no explicit protection, the
element inherits the protection of the folder's parent.
For les, if the parent folder is protected by an ACL, the le inherits the folder's
protection. However, if the le resides in a subfolder that is not explicitly protected
by an ACL, the server assigns the Default ACL to the le. For more information
about les, refer to "Assigning ACLs to Files the Server Can Serve" on page 445.
Like-named folders in dierent packages share the same ACL. For example, if both the
Finance and Marketing packages contain a top-level folder named MonthEnd, both
versions of the folder are controlled by the same ACL, even though the folders have
dierent contents.
Note:

Top-level folders never inherit List access from the parent package.

Users that Belong to More than One Group

A user can be a member of one or more groups. The following table summarizes how
the server handles access for a user that is a member of a single group. Access can be any
of List, Read, Write, or Execute.
If a user is a member of a group that is:

Access to the package, folder, or other element

is:

Allowed

Allowed

Denied

Denied

webMethods Integration Server Administrators Guide Version 9.10

438

Odd Header
Controlling Access to Resources

If a user is a member of a group that is:

Access to the package, folder, or other element

is:

Not-specied

Denied

But what happens when the user is a member of more than one group? To determine
the access seing for a user that is member of more than one group, Integration Server
assigns dierent strengths to the seings. Specically, Denied overrides Allowed, and
Allowed overrides Not-specied.
For example, suppose user Smith is a member of three groups, and each group has a
dierent List access to the FY2013 package, as shown below.
Group

List access to FY2013 package

Accounting

Not-specied

Support

Denied

Corporate

Allowed

As a result of these seings, Smith is denied List access to the package because the
Denied seing of the Support group overrides the other seings.

Predefined ACLs
The server comes with the following predened ACLs. You cannot delete these ACLs.
Administrators. Allows only users in the Administrators group and users with the My
webMethods Administrators role access to a package, folder, or other element and
denies all other users.
Anonymous. Provides access to unauthenticated users (those that did not supply a
userid) and users with theMy webMethods Users role.
Default. Allows all authenticated users and users with the My webMethods Users
role access to a package, folder, or other element. When an element is not specically
assigned an ACL or does not inherit an ACL from containing folders, the server uses
the Default ACL. If the ACL assigned to an element is deleted, the server uses the
Default ACL. The Default ACL authorizes authenticated users only. Unauthenticated
users (those that did not specify a valid userid) are authorized by the Anonymous
ACL.
Developers. Allows only users in the Developers group and users with the My
webMethods Administrators role access to a package, folder, or other element and
denies all other users.
Internal. Allows only users in the Administrators and Developers groups and users
with the My webMethods Administrators role access to a package, folder, or other
webMethods Integration Server Administrators Guide Version 9.10

439

Even Header
Controlling Access to Resources

element and denies all other users. The server assigns this ACL to built-in utility
services shipped with the server, such as those in the WmRoot and WmPublic
packages. You should never need to assign this ACL to an element.
Replicators. Allows the Replicator user and users with the My webMethods
Administrators role replication privileges.
Note:

You might see an ACL that is specic for an adapter, for example the
wmPartnerUsers ACL. Refer to the documentation for the specic adapter for
more information about its ACL.

When Does the Server Perform ACL Checking?

The Integration Server checks ACLs when:
A client or a DSP invokes a service that resides on the Integration Server. A client can
be a browser user, another Integration Server, an IS client (using the IS client API), or
a custom HTTP client.
You are using Designer to access (list, create, update, see the source of, delete, or
change the ACL assignments of) an element.
You are using the IS\x11 Administrator and you try to list or change the ACL
assignment of an element.
By default, the Integration Server performs ACL checking against externally invoked
services only. Externally invoked services are those that are directly invoked by a client
or DSP. You can, however, congure a service to have its ACL checked even if it is
internally invoked, that is, invoked by another service running on the Integration Server.
To direct the server to check the execute ACL for a service even when the service is
invoked internally, use Designer to set the Enforce Execute ACL property to Always. See
webMethods Service Development Help for more information.

Creating ACLs
When creating an ACL, you select groups to use for the Allowed Groups and Denied
Groups from previously dened groups.
To create an ACL
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click ACLs.
3. Click Add and Remove ACLs.
4. Specify one ACL name per line. Press ENTER to separate the lines.
5. Click Create ACLs.

webMethods Integration Server Administrators Guide Version 9.10

440

Odd Header
Controlling Access to Resources

Allowing or Denying Group Access to ACLs

You can edit a new or predened ACL to allow certain groups to access this ACL and
deny permissions to other groups. You can allow and deny access to internally dened
groups as well as groups and roles dened externally in a central user directory or in
LDAP.
To allow group access to an ACL
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click ACLs.The server displays the
Access Control Lists screen.
Groups in the Allowed list are explicitly allowed to access the packages, folders,
services, or other elements associated with this ACL.
Groups in the Denied list are explicitly denied access to the packages, folders,
services, or other elements associated with this ACL.
3. In the Select ACL list under ACL Membership, select the ACL to which you want to
add groups.
4. Do one of the following:
If you want to allow a group or role access to this ACL, under the Allowed list,
click Add.
If you want to deny a group or role access to this ACL, under the Denied list, click
Add.
5. In the dialog box that appears, in the Provider list, select the location from which you
want to select a user group.
If an external user directory is not congured, the Provider list does not appear.
6. In the Role/Group Name list, do one of the following:
If you select Local, select the locally dened user group for which you want to
allow or deny access to the ACL.
If you select Central or LDAP, in the Search eld, enter search criteria for nding a
role or group. Click Go. Select the role or group for which you want to allow or
deny access to the ACL.
7. Click Save Changes.

Deleting ACLs
You can delete any ACL except the predened ACLs: Anonymous, Administrators,
Default, Developers, Internal, and Replicators. You can delete ACLs that are currently
assigned to packages, folder, or other elements. When a client aempts to access an
element that is assigned to a deleted ACL, the server denies access.

webMethods Integration Server Administrators Guide Version 9.10

441

Even Header
Controlling Access to Resources

When you delete an ACL that is assigned to a package, folder, service or other element,
the Integration Server retains the deleted ACL's name. As a result, when you view the
element's information, the server displays the name of the deleted ACL in the associated
ACL eld; however the server treats the ACL as an empty ACL and allows access to no
one.
For information about how to assign a dierent ACL to a package, folder, service, or
other element, see "Assigning ACLs to Folders, Services, and Other Elements" on page
443.
For information about how to assign a dierent ACL to le, that is, a DSP or .htm le
that the server serves, update the associated .access le to assign a dierent ACL to the
le. For more information about assigning ACLs to les, see "Assigning ACLs to Files
the Server Can Serve" on page 445.
To delete an ACL
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click ACLs.
3. Click Add and Remove ACLs.
4. In the Remove ACLs area of the screen, select the ACL or ACLs you want to remove.
5. Click Remove ACLs. The server issues a prompt to verify that you want to delete the
ACL.
6. Click OK to delete the ACL.

Default Settings and Inheritance

This section describes the default seings for newly created packages, folders, and
other elements and how a folder's ACL assignments aect the elements it contains. For
example, if you create a service and don't explicitly assign any ACLs to it, what does the
server use for that service's ACL assignments? In general, it works as follows:
When you create a package, the server assigns Default for the List ACL. (Packages do
not have Read, Write, or Execute ACLs). This means that any authenticated user can
see that the package exists.
When you create a top-level folder, that is, one that is not contained in another
folder, the server assigns Default for the List, Read, and Write ACLs, and Internal for
the Execute ACL to the folder. This means that any authenticated user can see that
the folder exists. The Read and Execute ACLs have no meaning for the folder itself.
They are there just for inheritance purposes. In other words, elements in the folder
will inherit those seings.
When you create a subfolder or other element (service, schema, specication,
document type, trigger, and other elements) the folder or other element inherits its
ACL seing from the parent folder.
This behavior is summarized in the following table:

webMethods Integration Server Administrators Guide Version 9.10

442

Odd Header
Controlling Access to Resources

ACL assigned by default

Element Type

List

Read

Write

Execute

Package

Default

N/A

N/A

N/A

Top-Level
Folder

Default

Default

Default

Internal

Subfolder

Inherit

Inherit

Inherit

Inherit

Other
Element

Inherit

Inherit

Inherit

Inherit

What Happens When You Change Existing ACL Assignments

If you assign a specic ACL to an element then later decide to remove the ACL
assignment (that is, change it to Inherited), the element will inherit the ACL of the
parent folder. The server displays (inherited) and the name of the ACL inherited from the
parent folder. If you remove an ACL assignment from a top-level folder, the server uses
Default. If you remove the List ACL assignment from a package, the server uses Default.
Important: The Default ACL identies the Everybody group as an Allowed group
and Anonymous as a denied group. This means that if an element has no
ACL specically assigned to it, then all users except unauthenticated ones
can access the element. To avoid inadvertent access to resources, assign an
appropriate replacement for the Default ACL.
If you change a folder's ACL assignment, it can change the ACL assignments of the
elements contained within. Specically, elements whose ACL assignment is Inherited will
change to the folder's new ACL assignment. Elements that already have a specic ACL
assignment will remain unchanged.

Assigning ACLs to Folders, Services, and Other Elements

You can use the Integration Server Administrator to assign an ACL to a folder, a
subfolder, or an individual service. Keep the following points in mind when assigning
ACLS using the Integration Server Administrator:
If you assign an ACL to a folder, all the children in the folder will inherit that
seing unless they already have an ACL explicitly set. For more information about
inheritance, see "Default Seings and Inheritance" on page 442.
You can only assign an ACL to an element if you are a member of that ACL. For
example, if you want to allow DevTeam1 to update the ProcessOrder service, you must

webMethods Integration Server Administrators Guide Version 9.10

443

Even Header
Controlling Access to Resources

be a member of the DevTeam1 ACL. That is, your user name must be a member of a
group listed in the DevTeam1 ACL.
If an element is locked by another user or system-locked, you cannot change the
ACL assigned to the element. You can only assign an ACL to an unlocked element or
an element locked by you.
Note:

Use Designer to assign ACLs to packages, specications, document types,

schemas, and triggers. For more information, see webMethods Service
Development Help.

Use the following procedure to assign a new or dierent ACL to a folder or service.
To assign an ACL to a folder or service
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. Click Browse Folders.
4. If the current screen does not list the folder or service to which you want to assign an
ACL, click the name of the parent folder until the server displays a screen that lists
the folder or service with which you want to work.
5. Click in the appropriate ACL eld (List, Read, Write, or Execute).
The server displays the ACL Information screen. Use the pull-down list to select the
ACL you want to assign to the folder or service and click Save Changes.

Removing an ACL from a Folder or Service

To remove an ACL from a folder or service
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. Click Browse Folders.
4. If the current screen does not list the folder or service to which you want to assign an
ACL, click the name of the parent folder until the server displays a screen that lists
the folder or service with which you want to work.
5. Click in the appropriate ACL eld (List, Read, Write, or Execute).
The server displays the ACL Information screen.
6. Select <Default> (inherited) from the pull-down menu of ACL names and click Save
Changes.

webMethods Integration Server Administrators Guide Version 9.10

444

Odd Header
Controlling Access to Resources

Assigning ACLs to Files the Server Can Serve

The server can serve les that reside in the pub directory for a package or a subdirectory
of the pub directory. For more information about how to serve les from the Integration
Server, see the webMethods Service Development Help.
You control access to les by placing an .access le in the directory that contains les you
want to protect. You can use an operating system tool of your choice to edit the .access
le.
Note:

The .access les control access to les the server serves, such as DSP and
HTML les. To control access to a service that a DSP or HTML le calls, you
must assign an ACL to the service itself. See "Assigning ACLs to Folders,
Services, and Other Elements" on page 443 for more information.

If the directory contains subdirectories, they will not inherit the protection, so you must
provide an .access le in each directory. For each le in the directory that you want to
protect, place a line in the .access le to identify the le and the ACL you want to use to
protect the le.
For example, assume you have a directory that contains three les (adminpage.dsp,
home.dsp, and index.htm). You want to protect the adminpage.dsp le with the
Administrators ACL so that only administrators can access this le. You want to protect
the home.dsp le with the Developers ACL so only developers can access this le. You
also want to assign the Default ACL to the index.htm le so all users can access it. To
accomplish this, you would place the following records in the .access le:
adminpage.dsp Administrators
home.dsp Developers
index.htm Default

Note:

In the above example, because you want all users to be able to access the
index.htm le, you could omit the index.htm Default from the .access le. The
server uses the Default ACL for les that are not identied in an .access le or
all les in a directory without an .access le.

Important: Integration Server loads .access les when a package is loaded; therefore,
if you want the changes you make to take eect immediately, reload the
package.

Rules for Using .access Files

When making entries in .access les, observe the following rules:
Specify the le name only, such as adminpage.dsp followed by the ACL name. If
you specify a relative path, the le will not be protected. For example, suppose le
home.dsp is in subdirectory docs in directory pub (pub\docs\home.dsp). If you add
the following entry to the .access le on directory pub, the le will not be protected:
docs\home.dsp Developers

webMethods Integration Server Administrators Guide Version 9.10

445

Even Header
Controlling Access to Resources

Instead, add the following entry to the .access le on directory pub\docs:

home.dsp Developers

The case in which you enter the name depends on how your le system handles
case. Suppose you have a le named index.dsp. If you use a case-insensitive system
such as Windows, you can enter the le name in any case. Therefore Index.dsp,
INDEX.DSP, and so on are all acceptable. However, if you use a case-sensitive system
such as UNIX, you must enter index.dsp.

Removing ACL Protection from a File

Use the following procedure to remove ACL protection from a le.
To remove ACL protection from a file
1. Shut down the server. For instructions, see "Shuing Down the Integration Server "
on page 65.
2. Edit the .access le and delete the line that species the le whose ACL protection
you want to remove.
3. Restart the server. For instructions, see "Restarting the Integration Server " on page
67.

webMethods Integration Server Administrators Guide Version 9.10

446

Odd Header
Authenticating Clients

20 Authenticating Clients
Overview .....................................................................................................................................

448

Basic Authentication ...................................................................................................................

448

Digest Authentication .................................................................................................................

449

Kerberos Authentication .............................................................................................................

450

Client Certificates .......................................................................................................................

450

Using Multiple Client Certificates ...............................................................................................

456

Client Authentication and Access Control ..................................................................................

458

Accessing Integration Server Data through My webMethods ....................................................

459

webMethods Integration Server Administrators Guide Version 9.10

447

Even Header
Authenticating Clients

Overview
This chapter explains the types of client authentication available for use with Integration
Server and details the authentication information required to congure the client
side. For information on conguring authentication for the server side, see "Securing
Communications with the Server" on page 401.
The chapter explains how to congure an Integration Server client for basic
authentication (user name and password) and SSL authentication. It also explains how
to use Integration Server with Windows authentication, and how to make Integration
Server data available to My webMethods applications.
Note:

By default, Integration Server authenticates clients that use basic, bearer,

SAML, or SSL authentication schemes. For all other authentication schemes,
you must create a custom JAAS login module for authenticating clients.
For information about writing custom JAAS login modules, see "Writing a
Custom JAAS Login Module for Integration Server " on page 465.

Basic Authentication
When the server uses basic authentication, it prompts the client for a user name and
password. If a user account is found for the supplied user name, the server authenticates
the user name by comparing the supplied password to the password in the user account.
If the password is correct, the server proceeds with the request. If the password is not
correct, the server rejects the request.
If the client does not supply a user name or password, the server uses the Default user
account for the client.
Client supplied
a user name/
password?

User Name found?

Password correct?

Request...

YES

YES

YES

proceeds

YES

YES

NO

is rejected

YES

NO

n/a

is rejected

NO

n/a

n/a

proceeds using
the Default user
account

webMethods Integration Server Administrators Guide Version 9.10

448

Odd Header
Authenticating Clients

Integration Server stores user names and passwords in the authentication cache. The
authentication cache is a caching layer in Integration Server that stores the user names
and passwords in hash format.
After the rst successful authentication of a user name and password (whether for
a local user or central user/LDAP), Integration Server stores the credentials in the
authentication cache for future reference. On subsequent authentication requests,
Integration Server checks to see if the credentials already exist in the authentication
cache. If the credentials already exist in the authentication cache, Integration Server does
not perform any additional validation of the credentials.
Note:

Once a user has changed the password and logged in successfully with
the new password, Integration Server removes the old password from the
authentication cache.

You control the authentication cache through the following server conguration
parameters:
watt.server.auth.cache.enabled. Enables and disables the authentication cache.
watt.server.auth.cache.timeout. Species the number of milliseconds that each cache
entry can remain idle before Integration Server removes it from the authentication
cache.
watt.server.auth.cache.capacity. Species the number of user name and password
combinations Integration Server stores in the authentication cache.
For more information about the server conguration parameters that control the
authentication cache, see "Server Conguration Parameters" on page 851. For more
information on seing up user accounts, see "Dening a User Account" on page 91.
You can also use externally dened user accounts. For more information on how to
use external directories and how basic authentication works when using external user
accounts, see "Conguring a Central User Directory or LDAP" on page 559.

Digest Authentication
Integration Server supports digest authentication by processing the digest authentication
credentials presented in HTTP headers. Integration Server also uses digest
authentication credentials passed in web service headers to authenticate web service
consumers that access an Integration Serverhosted web service. Integration Server can
also send digest authentication credentials while calling third-party web services.
The password digest is a hash of the nonce, the creation time, and the password.
When using digest authentication, when a client aempts to access Integration Server,
Integration Server requests the client to send a password digest by concatenating the
password with the nonce and the creation time. Upon receiving the password digest,
Integration Server veries the data and authenticates the client. If the password digest
sent by the client matches with the password digest created by the server, the server

webMethods Integration Server Administrators Guide Version 9.10

449

Even Header
Authenticating Clients

proceeds with the request. If the password digests does not match, the server rejects the
request.
To use digest authentication, you must congure the user for digest authentication while
creating the user in Integration Server Administrator. You must also congure ports to
use password digest for authentication of client requests. A port that is congured to use
password digest for authentication of client requests will process a request from a user
only if the user is congured to allow password digest for authentication.
For more information about conguring a user for digest authentication, see "Adding
User Accounts" on page 92.

Kerberos Authentication
Integration Server supports Kerberos authentication by processing the Kerberos tickets
in the HTTP headers of service requests using the Negotiate authentication scheme.
Integration Server also uses Kerberos authentication credentials passed in web service
headers to authenticate web service consumers that access an Integration Serverhosted
web service.
When Integration Server receives a Kerberos ticket, it contacts the KDC using the
congured principal name and principal password. If the Kerberos ticket is not valid,
Integration Server rejects the request.
If the Kerberos ticket is valid, Integration Server extracts the user associated with the
ticket and looks for that user in the local Integration Server user store, the Central Users,
or LDAP. Software AG recommends conguring the KDC as a user directory in Central
Users or LDAP so Integration Server can identify and authorize the user that is part of
the Kerberos ticket submied by the client.
For complete information about Kerberos authentication, see "Conguring Integration
Server to Use Kerberos" on page 373. For instructions on conguring the user directory,
see "Conguring a Central User Directory or LDAP" on page 559.

Client Certificates
In Integration Server, a client certicate is an X.509 digital certicate that identies a
client and is used for SSL authorization.

Checklist for Using Client Certificates

Task

Notes

Congure the server to use SSL.

For more information, see "Roadmap

for Conguring SSL" on page 404.

webMethods Integration Server Administrators Guide Version 9.10

450

Odd Header
Authenticating Clients

Task

Notes

Import the signing certicates (trusted

root certicate or certicate chain) for
the client.

The trusted root certicate or certicate

chain should be stored in the truststore
and is required to authenticate the
client.
For more information, see "Certicate
Mapping" on page 451.

Congure the port to request client

certicates.

For more information, see "Client

Certicates and Port Conguration" on
page 454.

Import client certicates and map to

specic user.

Place client certicates in separate les.

Place the les in a directory to which
Integration Server has access
For more information, see "Importing
a Certicate (Client or CA Signing
Certicate) and Mapping It to a User"
on page 452.

Certificate Mapping
The certicate mapping feature allows you to store client certicates on an Integration
Server and associate each of the certicates with a user account (for example, a certicate
may be used to identify the user FINANCE). When a client presents one of these
certicates, Integration Server logs the client in as the user "mapped" to the certicate.
My webMethods Server also allows you to associate a certicate and a user. If
central user management is congured in Integration Server, Integration Server will
automatically check the My webMethods Server database for certicate mappings when
it cannot locate the user in its local store. Refer to Administering My webMethods Server for
further details.
Important: Be careful when mapping a user to particular client certicate. Make sure
that the user's authorization level is an appropriate match.

Ports and Certificate Mappings

Integration Server automatically checks for a mapped user for certicates received at
HTTPS ports. For requests received at FTPS ports, Integration Server checks for mapped
users if the wa.ftpUseCertMap server conguration property is set to true. For more
information about how client authentication works for an FTPS port, see "FTPS Ports" on
page 455.

webMethods Integration Server Administrators Guide Version 9.10

451

Even Header
Authenticating Clients

If you are going to congure one or more ports to require client certicates, you must
import the client certicates you will accept and map them to the users that you want
the clients to log in as.
If you do not congure any ports to require client certicates, you might want to import
client certicates and map them to users so that clients presenting these certicates can
automatically log on as those users.

Importing a Certificate (Client or CA Signing Certificate) and Mapping It to a

User
You import client certicates and CA signing certicates through Integration Server
Administrator to keep them on le, map them to particular user accounts, and specify
how they are to be used.
Keep the following points in mind before importing and mapping certicates:
If you intend to make an SSL connection between Integration Server and an Internet
resource that will serve as a client, you also need to import a copy of the client's SSL
signing certicate (CA certicate).
Although Integration Server supports loading certicates for LDAP users,
Software AG recommends using central user management and then conguring
LDAP and certicates in My webMethods Server.
The steps for importing client certicates and CA signing certicates are the same, and
are described below.
To import a client certificate and map it to a user
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Certificates.
3. Click Configure Client Certificates.
4. In the Certificate Path eld, enter the path and le name of the le that contains the
certicate you want to import.
Note:

The certicate must be located on a path that is accessible to Integration

Server. That is, the certicate must be on the same machine as Integration
Server.

5. In the User eld, enter a user or click

to search for and select a user.

To search for a user in the User Name dialog box, do one of the following:
To select a local user, in the Provider list, select Local. Select the local user to which
you want to map the certicate.
If an external user directory is not congured, the Provider list does not appear.
To select a user from an external directory (LDAP or a central user directory), in
the Provider list, select the user directory that you want to search. In the Search

webMethods Integration Server Administrators Guide Version 9.10

452

Odd Header
Authenticating Clients

eld, enter the criteria that you want to user to nd a user. Click Go. Select the
user to which you want to map the certicate.
6. In the Usage list, select the purpose for which you want to import this certicate.
Select from one of these options:
SSL Authentication. Use the certicate to represent the client's authentication
credentials when making an SSL connection with Integration Server.
Verify. Use the certicate's public key to verify the authenticity of documents,
messages, or streams originating from the client and containing a digital
signature.
Encrypt. Use the certicate's public key to encrypt outgoing documents,
messages, or streams fromIntegration Server to the client.
Verify and Encrypt. Use the same certicate both to verify the authenticity of
documents, messages, or streams originating from the client and containing
a digital signature, and to encrypt outgoing documents, messages, or streams
fromIntegration Server to the client.
Message Authentication. Use the certicate to represent the client's authentication
credentials when making an SSL connection with Integration Server, when
using message-level rather than transport-level authentication (for example, with
web service messages whose SOAP message headers contain SSL certicate
information).
7. Click Import Certificate.

Changing a Certificate Mapping

You can change the user to which a certicate is mapped, and the purpose for which the
certicate is used.
To change a user mapped to a certificate
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Certificates.
3. Click Configure Client Certificates.
4. Under Current Certificates, in the Subject CN column, click the certicate for which you
want to change the mapping.
5. On the Security > Certificates > Client Certificates > Details screen, click Change Mapping.
6. In the User eld, enter the user to which you want to map the certicate or click
search for and select a user.

to

7. In the Usage list, select the appropriate usage.

8. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

453

Even Header
Authenticating Clients

Client Certificates and Port Configuration

Integration Server uses client certicates only for HTTPS or FTPS requests.
If a port is congured to request or require client certicates, Integration Server requests
the client's certicate during the SSL handshake process, after the client authenticates the
credentials presented by Integration Server. What happens next depends on how your
server is congured and whether the port is HTTPS or FTPS.

HTTPS Ports
The following table shows how the Integration Server handles client requests received at
an HTTPS port when dierent client authentication seings are in eect. These seings
are specied on the Client Authentication parameter when conguring or editing an
HTTPS port.
Parameter

Client Certificate Supplied

Username/

The server prompts the client for a user ID and password.

Password
Digest

Integration Server uses password digest for authentication of

all requests. If the client does not provide the authentication
information, Integration Server returns an HTTP WWWAuthenticate header with digest scheme to the client
requesting for authentication information. If the client
provides the required authentication information, Integration
Server veries and validates the request.
A port that is congured to use password digest for
authentication of client requests will process a request from
a user only if the user is congured to allow password digest
for authentication.

Request Client
Certificates

The server requests client certicates for all requests.

If the client does not provide a certicate, the server prompts
the client for a userid and password.
If the client provides a certicate:
The server checks whether the certicate exactly matches a
client certicate on le and is signed by a trusted authority.
If so, the client is logged in as the user to which the
certicate is mapped in Integration Server. If not, the client
request fails, unless central user management is congured.

webMethods Integration Server Administrators Guide Version 9.10

454

Odd Header
Authenticating Clients

Parameter

Client Certificate Supplied

If central user management is congured, the server checks
whether the certicate is mapped to a user in the central
user database. If so, the server logs the client on as that user.
If not, the client request fails.

Require Client
Certificates

The server requires client certicates for all requests.

The server behaves as described for Request Client Certificates,
except that the client must always provide a certicate.

FTPS Ports
The method Integration Server uses to handle client requests received at an FTPS port
depends on the various client authentication seings:
If wa.ftpUseCertMap is true, Integration Server handles client requests as follows:
Certificate

No Certificate

Username/
Password

Log in with username/

password supplied at
prompt.

Log in with
username/password
supplied at prompt.

Request
Certicates

If certicate is trusted and

matches a mapped user, log
in as that user.

Log in with
username/password
supplied at prompt.

If certicate is not trusted or

does not match a mapped
user, log in with user/
password supplied at
prompt.
Require
Certicates

If certicate is trusted and

matches a mapped user,
log in as that user. Ignore
user/password supplied at
prompt.

Reject the login

request.

If certicate is not trusted

or does not match mapped
user, ignore user/password
supplied at prompt and
reject the login request.

webMethods Integration Server Administrators Guide Version 9.10

455

Even Header
Authenticating Clients

If wa.ftpUseCertMap is false, Integration Server handles client requests as follows:

Certificate

No Certificate

Username/
Password

Log in with username/

password supplied at
prompt.

Log in with
username/password
supplied at prompt.

Request
Certicates

Accept certicate if it is
trusted, but ignore user
provided in certicate.
Instead, log in with user/
password supplied at
prompt.

Log in with
username/password
supplied at prompt.

Require
Certicates

Accept certicate if it is
trusted, but ignore user
provided in certicate.
Instead, log in with user/
password supplied at
prompt.

Reject the login

request.

Using Multiple Client Certificates

Integration Server can present a single client certicate to all servers or it can present
dierent client certicates to dierent SSL servers. In addition, the Integration Server
can present certicates provided for this purpose by other organizations. (Some
organizations prefer to provide certicates signed by their own CAs for clients to use,
rather than accept the client's certicate.) You control which certicate the Integration
Server presents to an SSL server by using remote server aliases or special public services.
You can set up the Integration Server to present client certicates from multiple
organizations. This involves obtaining the certicates, seing them up on the server,
and using remote aliases or special public services to control which certicate is being
presented.

Checklist for Presenting Multiple Client Certificates

Task

Notes

Obtain copy of each certicate you

want to use

You can use an existing certicate,

create one, or obtain a certicate from

webMethods Integration Server Administrators Guide Version 9.10

456

Odd Header
Authenticating Clients

Task

Notes
the SSL server with which Integration
Server will communicate.

Set up a remote alias

Although not required, using a remote

server alias is a convenient way of
directing particular certicates to
particular SSL servers.

Code your ow services

How you code your ow services

depends on whether or not you have
dened a remote server alias for the
remote server.

Importing Certificates
You must import certicates for the SSL servers with which Integration Server will
communicate so that two-way SSL authentication is possible.
Once you have imported the certicates, you can centralize them in a secure location
that is accessible to Integration Server; for example, in the Integration Server cong
directory.

Setting Up a Remote Server Alias

Using a remote server alias is a convenient method of presenting dierent certicates to
dierent SSL servers.
Begin by assigning a remote server alias to the SSL server that will be presented a
specic certicate (see the instructions for "Seing Up Aliases for Remote Integration
Servers" on page 117). This alias will control which certicate is presented to the remote
server.
If you do not use a remote server alias, you must use public services to control the client
certicate that the Integration Server will present. These services, listed below, are
described in more detail in the webMethods Integration Server Built-In Services Reference.
Service

Description

pub.security.keystore:setKeyAndChain

Species the key and associated certicate

chain to present.

pub.security:setKeyAndChainFromBytes

Species the key and associated certicate

chain to present, where the information is
located in byte arrays (rather than les).

webMethods Integration Server Administrators Guide Version 9.10

457

Even Header
Authenticating Clients

Service

Description

pub.security:clearKeyAndChain

With a set of services, use to revert the key

and certicate chain back to their defaults.

pub.security:clearKeyAndChainFromBytes

With a set of services, use to revert the key

and certicate chain back to their defaults,
where the key and certicate information is
located in byte arrays (rather than les).

Coding Your Flow Services

How you code your ow services depends on whether or not you have dened a remote
server alias for the SSL server you want to communicate with. If you are using a remote
server alias, the alias controls which certicate is presented. With a remote server alias
dened, you can use the pub.remote:invoke services in your ow services to run services on
the remote server.
If you have not dened a remote server alias, you must code your ow services to
handle switching from one certicate to another using Integration Server public services.
You can do so with the same public services specied in "Seing Up a Remote Server
Alias" on page 457.

Client Authentication and Access Control

Client authentication works with access control. After the server determines the user
name of a client, it can then determine whether the client should be granted access to the
requested resource. The server uses the client's group membership to control access to
the server resources.
The server authenticates when a
client attempts to...

The server controls access to the requested resource by

determining whether...

Invoke a service

The client is a member of a group listed among

the Allowed Groups or Denied Groups in the
Execute ACL that is associated with the service.

Access Integration Server

Administrator

The client is a member of the Administrators

Group, which indicates the client has
administrator privileges.

Connect to Integration
Server from Designer

The client is a member of the Developers

Group, which indicates the client has developer
privileges.

webMethods Integration Server Administrators Guide Version 9.10

458

Odd Header
Authenticating Clients

For more information, refer to "Securing Communications with the Server" on page 401.

Accessing Integration Server Data through My webMethods

A My webMethods Server (MWS) application, such as webMethods Monitor or
webMethods Optimize for Process, may require access to data originating from
Integration Server. Before the MWS application can access this data, MWS must establish
a connection with Integration Server. The connection takes place as follows:
A login request is initiated from MWS to Integration Server.
The login credentials of the MWS user are authenticated by Integration Server.
An Integration Server session is established.
In this situation, the user initiating the request does not need a set of Integration Server
credentials. The credentials stored in the MWS user database can be used to authenticate
this request. This capability is called Single Sign-On (SSO).
Important: For SSO to work, MWS Central User Management must already be
congured. For more information, see Administering My webMethods Server.
The underlying mechanisms for validating the login credentials of the MWS user include
the Java Authorization and Authentication Service (JAAS) and the OpenSAML 1.1
library. The OpenSAML library is used to authenticate the MWS user, by resolving a
SAML artifact representing the MWS user to Integration Server.

Configuring the MWS Single Sign-On Resource Setting

Although the workings of JAAS and the OpenSAML library in this context are
transparent, you need to congure MWS seings to support SSO:
Any MWS portlet that requires Integration Server data must have its Authentication
Method set to hybrid. For information about conguring this seing, see
Administering My webMethods Server.
The MWS Single Sign-On Resource seing must be congured to the correct URL.
To configure the MWS Single Sign-On Resource setting
1. In Integration Server, go to Settings > Resources.
2. Under Single Sign On with My webMethods Server, ensure that the following value
is entered for the MWS SAML Resolver URL seing:
https://mws-host :mws-port /services/SAML

webMethods Integration Server Administrators Guide Version 9.10

459

Even Header

webMethods Integration Server Administrators Guide Version 9.10

460

Odd Header
Customizing Authentication Using JAAS

21 Customizing Authentication Using JAAS

Overview .....................................................................................................................................

462

Using JAAS with Integration Server ..........................................................................................

462

JAAS Configuration File .............................................................................................................

462

Pluggable Authentication Modules (PAMs) ................................................................................

464

Writing a Custom JAAS Login Module for Integration Server ....................................................

465

JAAS Custom Login Module Example .......................................................................................

467

webMethods Integration Server Administrators Guide Version 9.10

461

Even Header
Customizing Authentication Using JAAS

Overview
This chapter explains how to set up a custom JAAS login module for use with
Integration Server authentication.

Using JAAS with Integration Server

The Java Authorization and Authentication Service (JAAS) provides a standards-based
mechanism for deploying custom login modules. Using JAAS, you can write your own
custom login module to take over the Integration Server authentication process.
By making use of the JAAS framework for extending Java code-based security, you can
customize Integration Server authentication so that multiple login modules can be called
during the authentication process. JAAS allows you to specify:
The order in which custom login modules are called.
Whether a login module is required or optional.
The points at which control can pass from a login module back to the controlling
application.
When implementing custom login modules using JAAS, you must:
Write the login module.
Congure your login module within the appropriate login context in the JAAS
conguration le.
Add the JAR le containing the login module to the Integration Server classpath.
Note:

A JAAS custom login module deals only with authentication of

Integration Server users. You cannot use the JAAS feature for Integration
Serverauthorization; Integration Server uses ACLs for authorization. For
more information, see "Securing Communications with the Server" on page
401.

JAAS Configuration File

The JAAS conguration le controls which login modules to use within a JVM.
Integration Server congures the JVM to use Integration Server_directory\instances
\instance_name \cong\is_jaas.cnf as the JAAS conguration le.
A set of JAAS login modules are grouped into what is termed a login context. Within
each login context, the login modules are specied with their full name, optional
parameters, and a designation of the actions to take based on their success or failure.

webMethods Integration Server Administrators Guide Version 9.10

462

Odd Header
Customizing Authentication Using JAAS

These designations are classied as REQUIRED, REQUISITE, SUFFICIENT, and

OPTIONAL. For the login to succeed, the complete login context must succeed.
The JAAS conguration le lists the:
Available login contexts.
Login modules that will execute.
Order in which the modules will execute.
Seings that determine which actions to take if a module fails.
Following is a portion of the default JAAS conguration le for Integration Server. It
shows the IS_Transport and WSS_Message_IS login contexts. The JAAS custom login
modules for Integration Server include:
Transport-level authentication, which is specied in the IS_Transport login context
(shaded gray in the code portion below).
Message-level authentication for web services, which is specied in the
WSS_Message_IS login context. Integration Server message-level authentication is
described in the Web Services Developers Guide.
Note:

The JAAS conguration le contains additional login contexts; only

IS_Transport and WSS_Message_IS (shown in the following code segments
from is_jaas.cnf) are discussed here.

IS_Transport { /* com.wm.app.b2b.server.auth.jaas.X509ValidatorModule
requisite; */ com.wm.app.b2b.server.auth.jaas.X509LoginModule
requisite; com.wm.app.b2b.server.auth.jaas.BasicLoginModule
requisite; com.wm.app.b2b.server.auth.jaas.SamlOSGiLoginModule
requisite; /* * The DefaultLoginModule contains logic that provide
special * default handling for Software AG products so please
leave * this module as the last module of this login context. */
com.wm.app.b2b.server.auth.jaas.DefaultLoginModule requisite;};
WSS_Message_IS { /* * Please do not rearrange the following SoftwareAG
* login modules; add your login modules before or after * these three
modules */ com.wm.app.b2b.server.auth.jaas.SamlAssertLoginModule
requisite; com.wm.app.b2b.server.auth.jaas.X509LoginModule requisite;
com.wm.app.b2b.server.auth.jaas.BasicLoginModule requisite;};

Pre-installed Login Modules

IS_Transport login context contains default login modules such as X509LoginModule,
BasicLoginModule, SamlOSGiLoginModule.
Each login module rst checks whether it has the required credentials. If the module
nds the credentials, it uses them. If the module does not nd the credentials, it returns
a value of "false."

webMethods Integration Server Administrators Guide Version 9.10

463

Even Header
Customizing Authentication Using JAAS

For example, the BasicLoginModule aempts to get the user name and password. If it
cannot locate either, it returns a value of "false," which causes this module to fail. The
modules listed within IS_Transport contain the "requisite" designation. That designation
means that for the overall login to succeed, one of the modules in the login context must
succeed.

X509ValidatorModule
In the above IS_Transport login context, the X509ValidatorModule is commented out
because it is optional functionality. When enabled, this module performs path validation
on the given X509Certicate chain, and you can congure it to perform certicate
revocation lists (CRLs) checking by adding the check_crl_status and crl_url parameters
as shown below:
IS_Transport
{
com.wm.app.b2b.server.auth.jaas.X509ValidatorModule requisite
check_crl_status=true
crl_url="file:///C:\\webMethods\\sec\\crl\\lh.crl";
com.wm.app.b2b.server.auth.jaas.X509LoginModule requisite;
com.wm.app.b2b.server.auth.jaas.BasicLoginModule requisite;
com.wm.app.b2b.server.auth.jaas.SamlOSGiLoginModule requisite;

The crl_url can point to a le url as shown above or it can point to a live CRL url (for
example, hp://myca.com/crl/lh.crl).
For certicate path validation, this module tries to use the truststore associated with
the port on which the request came in. If the port does not identify a truststore, then
this module uses Integration Server's default outbound truststore. You can override this
and provide your own Integration Server truststore alias using the "trustStore_alias"
property of the module as shown below:
com.wm.app.b2b.server.auth.jaas.X509ValidatorModule requisite
trustStore_alias="my trustStore";

Pluggable Authentication Modules (PAMs)

Implementing JAAS custom login modules supersedes the pluggable authentication
module (PAM) approach to customizing authentication used in previous versions
of Integration Server. Beginning with Integration Server version 8.0, customizing
authentication with PAMs is deprecated.
PAMs will continue to work in Integration Server version 8.0 and later as an extension to
the JAAS login modules BasicLoginModule and X509LoginModule:
If you registered a PAM for the "basic" authentication mechanism, it will be treated
as an extension to BasicLoginModule.
If you registered a PAM for the "X509" authentication mechanism, it will be treated
as an extension to X509LoginModule.

webMethods Integration Server Administrators Guide Version 9.10

464

Odd Header
Customizing Authentication Using JAAS

If a PAM is registered and the corresponding JAAS login module (BasicLoginModule or

X509LoginModule) is called, authentication is rst aempted on the credentials supplied
for that module. If that authentication is not successful, then the PAM is called and
another aempt to authenticate the user is made.
Important: Removing the line of code specifying the BasicLoginModule or
X509LoginModule in the JAAS conguration le will disable any registered
PAM for the corresponding authentication mechanism.
Note:

Information about customizing Integration Server client authentication with

PAMs, is available in webMethods Integration Server Administrators Guideversion
8.0.

Writing a Custom JAAS Login Module for Integration Server

The following sections describe in general terms how to write and deploy a custom
JAAS login module for Integration Server.

Extend SagAbstractLoginModule
Extend the com.softwareag.security.jaas.login.SagAbstractLoginModule
Implement the following abstract methods:
initConfiguration()
authenticate(com.softwareag.security.jaas.login.SagCredentials
sagcredentials)

Integration Server collects the credentials and populates them in the

com.softwareag.security.jaas.login.SagCredentials object. Integration Server then starts the
JAAS login on the appropriate login context (for example, ISTransport). The JAAS
framework looks in the conguration for the login modules associated with the login
context. Each login module is called in turn for initialization and login; this is handled
by the SagAbsractLoginModule, which delegates login module specic initialization and
login to the derived class. For example, when JAAS login is invoked in your module,
SagAbstractLoginModule invokes authenticate(sagcredentials) on your login
module by passing in the com.softwareag.security.jaas.login.SagCredentials.
Your login module's authenticate method should retrieve the credentials from the
SagCredentials object and perform the authentication (for more information, see the
Javadoc for the SagCredentials and SagAbstractLoginModule).
If authentication is successful, the module populates SagCredentials with the correct
username. If the current user name in the SagCredentials is not the one to be used, use
the sagcredentials.setUserName(string) method to update the user name.

webMethods Integration Server Administrators Guide Version 9.10

465

Even Header
Customizing Authentication Using JAAS

Implement Commit()
Depending on how the login context is congured, it is possible for more than one
module to succeed with a dierent user name. Integration Server does not have a default
mechanism to determine which course of action to take when multiple login modules
succeed with dierent user names. To circumvent these situations, Integration Server
login modules implement the following commit method:
public boolean commit() throws LoginException {
createUserPrincipal = "true";
super.commit();
return true;
}

Here, createUserPrincipal is a member variable in SagAbstractLoginModule. The

method super.commit() refers to the commit() method in SagAbstractLoginModule.
This commit() method retrieves the user name from the SagCredentials and creates a
SagUserPrincipal only if there are no SagUserPrincipal objects in the Subject.
Your login module should implement the commit() method as shown above.
If more than one login module in IS_Transport succeeds, only the rst module that
invoked commit() creates the principal. Thus, once you have implemented commit(),
you can arrange the order of the login modules in the JAAS conguration le to suit
your needs. If there are multiple principals in the Subject, Integration Server takes the
principal at index 0.
If JAAS is able to authenticate the user, JAAS returns a
javax.security.auth.Subject. Integration Server adds this JAAS subject into the
current session. You can retrieve the subject by making the following call:
com.wm.app.b2b.server.InvokeState.getCurrentSession().getCurrentJaasSubject()

Place the JAR File in the Integration Server Classpath

Compile the JAR le containing your login module and place it in the Integration Server
classpath. If you place the JAR le in any of your package's code\jars\static folders,
Integration Server will load the le into its static classpath. After Integration Server start
up, use the About page of Integration Server Administrator to check that the JAR le
containing your login module appears in the Integration Server classpath.

Modify the JAAS Configuration File

Open the JAAS conguration le, Integration Server_directory\instances
\instance_name \cong\is_jaas.cnf, and add a line of code under the IS_Transport
context that identies your login module.

webMethods Integration Server Administrators Guide Version 9.10

466

Odd Header
Customizing Authentication Using JAAS

JAAS Custom Login Module Example

The following sections explain the make up of a sample JAAS custom login module
with key portions of the code annotated and explained. The login module is purposely
simplied, as it is designed for explanatory purposes. It is hard coded to authenticate a
particular user.

JAAS Login Module for Integration Server: Sample Code

Following is the Java code for a simplied Integration Server JAAS login module. The
numbers refer to code portions that are described in the summary table following the
module.
package samples.login;

1.
import
import
import
import
import

javax.security.auth.login.LoginException;
com.softwareag.security.jaas.login.SagAbstractLoginModule;
com.softwareag.security.jaas.login.SagCredentials;
com.softwareag.security.jaas.principals.SagUserPrincipal;
com.wm.app.b2b.server.UserManager;

2.
public class TestLoginModule extends SagAbstractLoginModule {

3.
private String userId;

4.
public boolean abort() throws LoginException {
userId = null;
return true;
}

5.
public boolean commit() throws LoginException {
if(userId != null)
{
createUserPrincipal = "true";
super.commit();
return true;
} else {
return false;
}
}

6.

webMethods Integration Server Administrators Guide Version 9.10

467

Even Header
Customizing Authentication Using JAAS

protected void initConfiguration(){

this.userId = null;
}

7.
public boolean authenticate(SagCredentials userCreds) throws
LoginException
{
String username = userCreds.getUserName();
if(username == null || username.length()==0) {
return false;
}
if(userCreds.getPassword() == null) {
return false;
}
String password = new String(userCreds.getPassword());
if(password == null || password.length()==0) {
return false;
}
if(username.equals("bob") && password.equals("123") &&
UserManager.getUser(username) != null)
{
userId = username;
return true;
} else {
return false;
}
}
public boolean logout() throws LoginException {
userId = null;
return true;
}
}

JAAS Custom Login Module: Code Explanation

The following table summarizes the key code portions of a custom JAAS login module
in the above sample module.
Code
Portion

Description

1.

Imported classes; the rst is an Oracle Java class and next

three are the Software AG classes from the sin-common.jar in
Software AG_directory\common\lib.

2.

Identies the JAAS custom login module as an extension of

SagAbstractLoginModule.

3.

The user ID derived from authentication.

webMethods Integration Server Administrators Guide Version 9.10

468

Odd Header
Customizing Authentication Using JAAS

Code
Portion

Description

4.

If the login context's overall authentication fails, this method aborts

the login.
If the authentication aempt by the login module is successful, then
this method cleans up any state information that was originally
saved.

5.

This block of code shows the implementation of commit described in

"Implement Commit()" on page 466. The commit method returns
"true" if a SagUserPrincipal is created by this login module, and it
returns "false" if the login module should be ignored.

6.

Initializes the custom JAAS login module.

7.

Aempts to authenticate the user by retrieving the credentials from

the given com.softwareag.security.jaas.log.SagCredentials
object. During the commit phase, SagAbstractLoginModule creates
a principal using the user name identied in the SagCredentials
object. If the current user name in the SagCredentials object is not
the one to be used, use the sagcredentials.setUserName(string)
method to update it with the correct user name.
For simplication, the method species a hard-coded user name and
password.

JAAS Configuration File: Sample Module

Following is the line of code that you would add to the IS_Transport context of the
JAAS conguration le, Integration Server_directory\instances\instance_name \cong
\is_jaas.cnf, to identify the sample login module described in this section (with a
requisite designation).
IS_Transport
{
samples.login.TestModule requisite;
com.wm.app.b2b.server.auth.jaas.X509LoginModule requisite;
com.wm.app.b2b.server.auth.jaas.BasicLoginModule requisite;
com.wm.app.b2b.server.auth.jaas.SamlOSGiLoginModule requisite;
...
};

webMethods Integration Server Administrators Guide Version 9.10

469

Even Header

webMethods Integration Server Administrators Guide Version 9.10

470

Odd Header
Master Passwords and Outbound Passwords

22 Master Passwords and Outbound Passwords

Overview .....................................................................................................................................

472

Managing Outbound Passwords ................................................................................................

473

Backing Up Outbound Password and Master Password Files ..................................................

474

Changing the Master Password .................................................................................................

474

Changing the Expiration Interval for the Master Password .......................................................

475

About the configPassman.cnf File .............................................................................................

475

Working with Outbound Password Settings ...............................................................................

476

Working with Master Password Settings ...................................................................................

477

What to Do if You Lose or Forget Your Master Password .........................................................

479

When Problems Exist with the Master Password or Outbound Passwords at Startup ............... 480
E-mail Listeners and Package Replication ................................................................................

webMethods Integration Server Administrators Guide Version 9.10

483

471

Even Header
Master Passwords and Outbound Passwords

Overview
As part of its normal operations, the Integration Server may connect to applications
and subsystems such as remote Integration Servers, proxy servers, and databases. The
Integration Server, acting as a client, is required to supply a password, referred to as an
outbound password, to each of these systems before connecting to them. The Integration
Server uses the outbound passwords to identify itself or authenticate to the other systems.
When you congure the Integration Server to connect to an application or subsystem, for
example a database, you specify the password the Integration Server must send to the
database server in order to connect to it. Later, when an Integration Server user makes a
request that requires the database, the Integration Server sends the congured password
to the database server and connects to it.
Note:

Whenever you create a keystore or truststore alias, the keystore or truststore

password is automatically saved by Integration Server as an outbound
password. For more information, see "Keystore, Truststore, and Key Aliases"
on page 409.

To protect these outbound passwords, the Integration Server encrypts them. By default
it encrypts them using Password-Based Encryption (PBE) technology, also known as
PKCS5. This encryption method requires the use of an encryption key or master password
that you specify. The encrypted outbound passwords are stored in a le.
Note:

Flow services may also store and retrieve outbound passwords to access
secure resources, using the pub.security.outboundPasswords services. For
more information, see the webMethods Integration Server Built-In Services
Reference.

The master password is also encrypted, and by default, is stored in a le. However,
when the password is stored in a le, there is a chance that someone could access the
le and decrypt the password. Therefore, for greater security, you can congure the
Integration Server to prompt for the master password at server startup instead.
Note:

To protect the master password le (if you use one) and the outbound
passwords le, assign them operating system Administrator access.

As stated above, outbound passwords are used by the Integration Server to authenticate
to other entities. In contrast, inbound passwords are used by users and other servers to
authenticate to the Integration Server. Inbound passwords are stored as a one-way hash.
See "Managing Users and Groups" on page 89 for a discussion of seing up inbound
passwords.
The following sections describe how to manage outbound passwords.

webMethods Integration Server Administrators Guide Version 9.10

472

Odd Header
Master Passwords and Outbound Passwords

Managing Outbound Passwords

When you rst install the Integration Server, it is congured to use PBE to encrypt
outbound passwords, and has a master password of "manage" with an expiration
interval of 90 days.
You can change the master password and its expiration interval by using the Security
> Outbound Password screen of the Integration Server Administrator. You can also use
the Integration Server Administrator to reset the master password and all the stored
outbound passwords in the unlikely event the master password or outbound passwords
become lost or corrupted.
To change other seings, you must edit the congPassman.cnf le. Those seings are:
Encryption method for outbound passwords
Method the Integration Server uses to obtain the master password. The Integration
Server can store the master password in a le or prompt for it at server startup.
The following table lists the tasks you can perform and where to nd instructions:
To change...

See...

The master password.

"Changing the Master Password" on

page 474

The expiration interval of the master

password.

"Changing the Expiration Interval for

the Master Password" on page 475

The encryption method used for

outbound passwords.

"Working with Outbound Password

Seings" on page 476

The location of the outbound

password store.

"Working with Outbound Password

Seings" on page 476

The method used to obtain the

master password, that is, whether the
Integration Server prompts for the
master password at Integration Server
startup instead of storing it in a le.

"Working with Master Password

Seings" on page 477

The repeat limit for the master

password, that is, how soon a
previously used password can be
reused.

"Working with Master Password

Seings" on page 477

webMethods Integration Server Administrators Guide Version 9.10

473

Even Header
Master Passwords and Outbound Passwords

To change...

See...

The location of the master password

store.

"Working with Master Password

Seings" on page 477

All outbound passwords and the

master password.

"Reseing the Master Password and

Outbound Passwords" on page 482

Backing Up Outbound Password and Master Password Files

As you do with other important system les, you should regularly back up the les the
server uses to maintain outbound passwords and the master password. In the server
instances home directory (Integration Server_directory\instances\instance_name ), these
les are:
cong/txnPassStore.dat

Stores encrypted outbound passwords

cong/empw.dat

Stores encrypted master password

cong/congPassman.cnf

Species outbound password conguration seings

cong/passman.cnf

Non-editable version of congPassman.cnf

Always back up and restore these les together. If you change the name or location of
the outbound password store or the master password store, make sure your backup
procedure backs up the correct les.

Changing the Master Password

When you rst install the Integration Server, the master password is "manage."
For security purposes, you should change the master password immediately after
installation and again on a regular basis. You should also change it when there are
personnel changes.
The default expiration interval for a master password is 90 days. As the expiration date
nears, the Integration Server displays the password expiration status on the Integration
Server and sends warning messages to the server console stating that it is time to change
the master password. If the Integration Server is congured for e-mail notication, the
Integration Server will also send e-mail messages with this information to the congured
addresses.
Keep the following points in mind when changing the master password:

webMethods Integration Server Administrators Guide Version 9.10

474

Odd Header
Master Passwords and Outbound Passwords

To keep outbound passwords synchronized with the master password, the

Integration Server does not process requests to store and retrieve outbound
passwords while the master password is being changed. Therefore, if your system
has many aliases, consider performing the master password change during o peak
hours to prevent any decrease in performance.
If you have lost your master password, refer to "Determining Whether You Can
Restore the Passwords" on page 480.
To change the master password
1. Open the Integration Server Administrator.
2. In the Security menu of the Navigation panel, click Outbound Passwords.
3. Click Update Master Password.
4. Enter the current password, then enter and conrm the new password.
5. Click Change Password.

Changing the Expiration Interval for the Master Password

The default expiration interval for a master password is 90 days. You can see the current
expiration date by looking at the Security > Outbound Passwords screen.
The expiration interval is a recommended time between password changes. If you do not
change the master password by the expiration date, the Integration Server will continue
to operate using the existing password indenitely.
Although it is not recommended, you can specify an interval of 0. With this seing,
the password will not expire and no warnings will be sent to the Integration Server
Administrator or the server log.
To change the expiration interval for the master password
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click Outbound Passwords.
3. Click Update Expiration Interval.
4. Enter the new expiration interval in days and click Update. The maximum interval is
366 days.

About the configPassman.cnf File

The congPassman.cnf le contains additional conguration seings for outbound
password encryption that are not contained in the Integration Server Administrator. The
le consists of a number of properties, some of which are commented out in the default
conguration.

webMethods Integration Server Administrators Guide Version 9.10

475

Even Header
Master Passwords and Outbound Passwords

Important: The congPassman.cnf le has a companion le, passman.cnf. If you make

changes to congPassman.cnf le, the Integration Server will automatically
update passman.cnf to reect these changes when you initialize the
Integration Server. Never update passman.cnf directly.
As shipped, the congPassman.cnf le species that outbound passwords will be stored
in le cong/txnPassStore.dat and encrypted using Password-Based Encryption (PBE).
In addition, it species that the master password will be stored in le cong/empw.dat.
Properties that can be used to specify other seings are commented out.
If you want to change these optional seings, you must edit the congPassman.cnf le.
The le must always specify the following:
Encryption method for outbound passwords
Location of the le that contains the outbound passwords
Method the Integration Server uses to obtain the master password
The following sections describe the congPassman.cnf le in detail and how to change
outbound password and master password seings.

Working with Outbound Password Settings

This section describes how to use the congPassman.cnf le to change seings for
outbound passwords. See "Working with Master Password Seings" on page 477 for
instructions on using the congPassman.cnf le to change master password seings.
Important: Determine your strategy for outbound password and master password
behavior before you launch and congure your Integration Server the rst
time. If you change these seings after the Integration Server has been
congured, the master password and outbound passwords can become out
of sync.
If you are not already familiar with the congPassman.cnf le, read "About the
congPassman.cnf File" on page 475 above before proceeding.

Controlling Name and Location of Outbound Password File

The default le name and location for the outbound password le is in the server
instances home directory under cong/txnPassStore.dat. To change it, locate and
modify the following property:

This property must always be present and uncommented. If you want to change the
le name or location, change the highlighted area only. You can specify an absolute or

webMethods Integration Server Administrators Guide Version 9.10

476

Odd Header
Master Passwords and Outbound Passwords

relative path. In the path name, use the forward slash (/) only; the backward slash (\) is
not supported.

Controlling Encryption of Outbound Password File

The default encryption method for the outbound password le is Password-Based
Encryption (PBE). To change it, locate the following properties and uncomment a
dierent method. One and only one of these properties must always be uncommented:

Working with Master Password Settings

This section describes how to use the congPassman.cnf le to change seings for the
master password. See "Working with Outbound Password Seings" on page 476 for
instructions on using the congPassman.cnf le to change outbound password seings.
If you are not already familiar with the congPassman.cnf le, read"About the
congPassman.cnf File" on page 475 before proceeding.
Important: Determine your strategy for outbound password and master password
behavior before you launch and congure your Integration Server the rst
time. If you change these seings after the Integration Server has been
congured, the master password and outbound passwords can become out
of sync.
By default, the master password is stored in the le cong/empw.dat under the server
instances home directory, but if you prefer, you can congure Integration Server to
prompt for the master password at server initialization. The following sections describe
how to tell Integration Server which method to use.

Storing the Master Password in a File

To store the master password in a le, use the following properties:

webMethods Integration Server Administrators Guide Version 9.10

477

Even Header
Master Passwords and Outbound Passwords

Prompting for the Master Password at Server Initialization

To prompt for the master password at server initialization, use the following properties.
Use these properties only if you want Integration Server to prompt for the password at
server initialization (that is, you specied false for master.password.storeInFile. If you
do not want Integration Server to prompt for the password at server initialization, make
sure these two properties are commented out.

webMethods Integration Server Administrators Guide Version 9.10

478

Odd Header
Master Passwords and Outbound Passwords

You cannot congure Integration Server to prompt for the master password at server
initialization if:
Integration Server runs as a Windows service. Refer to "Running Integration Server
as a Windows Application vs. a Windows Service" on page 62 for more information.
Integration Server runs as a background application on UNIX.

What to Do if You Lose or Forget Your Master Password

If your Integration Server is congured to encrypt outbound passwords using PasswordBased Encryption (PBE), your Integration Server will have a master password, which is
the key used to encrypt outbound passwords. You need to enter the master password
whenever you want to change to a new encryption key. In addition, some installations
are congured so that Integration Server prompts for the master password when
Integration Server initializes; without the password, Integration Server will start up in
safe mode, which is described below.
Therefore, if you lose or forget your master password, you will need to restore it or reset
it, depending on the circumstances. For more information, see "Determining Whether
You Can Restore the Passwords" on page 480.

webMethods Integration Server Administrators Guide Version 9.10

479

Even Header
Master Passwords and Outbound Passwords

When Problems Exist with the Master Password or Outbound

Passwords at Startup
If Integration Server detects a problem with the master password or outbound
passwords at startup, the server places you in safe mode, which is a special mode from
which you can diagnose and correct problems.
When Integration Server is in safe mode, the server displays the Integration Server
Administrator, but Integration Server is not connected to any external resources.
When you are placed into safe mode because of problems with the master password or
outbound passwords, you will see the following message in the upper left corner of the
Server Statistics screen of the Integration Server Administrator:
SERVER IS RUNNING IN SAFE MODE. Master password sanity check failed -- invalid
master password provided.

Important: When you are in safe mode, do not congure or modify outbound
passwords unless they have been reset as part of the Reset All Outbound
Passwords task.
When there is a problem with these passwords, you can correct the problem by restoring
the passwords or reseing them. The method you choose depends on the problem with
the passwords. There are a number of reasons the Integration Server will automatically
go into safe mode.
Passwords are Corrupted or Out of Sync
It is possible that the master password le, outbound password le, or both are
corrupted. It is also possible that these les are out of sync with each other. The les are
out of synch when the key used to encrypt the contents of the outbound password le
is not the key in the master password le. In either case, refer to "Determining Whether
You Can Restore the Passwords" on page 480 for instructions.
You Entered the Wrong Master Password by Mistake
You might be in safe mode because you unintentionally entered the wrong master
password when prompted for it at server startup. If you think this is the case, shut down
Integration Server and restart it, this time specifying the correct master password when
prompted.
Platform Locale Has Changed
Any change to the OS locale or default encoding can render the outbound password and
master password les unreadable by Integration Server. For this reason, Software AG
recommends that you do not change platform locale after the Integration Server has
been installed and started.

Determining Whether You Can Restore the Passwords

You can restore passwords if either of the following is true:

webMethods Integration Server Administrators Guide Version 9.10

480

Odd Header
Master Passwords and Outbound Passwords

Your master password and outbound passwords are stored in les and you have
recent backups of both and the passman.cnf le.
Integration Server is congured to prompt for the master password, you have a
recent backup of the outbound password le and the passman.cnf le, and you
know the master password for that backup.
You must reset the passwords if any of the following is true:
Your master password and outbound passwords are stored in les and you do not
have recent backups the master password le, the outbound password le, and the
passman.cnf le.
Integration Server is congured to prompt for the master password and you do not
have recent backups of the outbound password le and the passman.cnf le.
Integration Server is congured to prompt for the master password and you have
lost or forgoen the master password.

Restoring the Master Password and Outbound Password Files

Before restoring these les, make sure you have read "Determining Whether You Can
Restore the Passwords" on page 480 to determine if you can restore or need to reset.
To restore the master password and outbound password files
1. Determine which les you need to restore.
If your master password is not stored in a le, that is, your Integration Server
prompts you for a master password at server startup, then you can restore just the
outbound password le and the passman.cnf le. Otherwise, you must restore the
master password le, the outbound password le, and the passman.cnf le from
backups.
2. Determine the name and location of the les.
The passman.cnf le is always cong/passman.cnf located under the server
instances home directory (Integration Server_directory\instances\instance_name ). By
default, the master password le is cong/empw.dat and the outbound password le
is in cong/txnPassStore.dat. If you are not sure of the location of these les on your
system, look at the le cong/congPassman.cnf. For information about using this
le, see "About the congPassman.cnf File" on page 475.
3. Shut down the Integration Server.
4. Copy the replacement les to appropriate directory.
5. Restart Integration Server.
Note:

Always back up and restore the master password le (if you use one), the
outbound password le, and the passman.cnf le together.

webMethods Integration Server Administrators Guide Version 9.10

481

Even Header
Master Passwords and Outbound Passwords

Resetting the Master Password and Outbound Passwords

Before reseing these passwords, make sure you have read "Determining Whether You
Can Restore the Passwords" on page 480 to determine if you really need to reset the
passwords or if you can restore them instead.
The reset procedure clears (blanks out) the stored outbound passwords and resets
the master password to "manage." In addition, you must manually re-enter the
appropriate passwords for all application and subsystem passwords on their respective
conguration screens in the Integration Server Administrator.
To reset stored outbound passwords and the master password
1. Start Integration Server if it is not already running. If your Integration Server is
congured to prompt you for a master password during server initialization, enter
any value.
Integration Server takes you into safe mode, which is the Integration Server
Administrator, but in a mode that is not connected to any external resources.
2. In the Security menu of the Navigation panel, click Outbound Passwords.
3. Click Update Master Password.
4. Click Reset All Outbound Passwords.
Integration Server displays a warning screen, to be sure you want to reset the
passwords.
5. Click Reset Passwords.
The Integration Server asks again if you are sure you want to reset the passwords.
6. Click OK.
This step clears the stored outbound passwords and changes the master password to
"manage."
7. From the Outbound Passwords screen, click Change Password and change the master
password to something other than "manage."
8. Restart Integration Server.
You will see error messages as the Integration Server aempts to connect to the
applications and subsystems for which the server no longer has passwords stored.
9. Go to the conguration screen for each application or subsystem and re-enter
the password required for Integration Server to connect to that application or
subsystem. Screens to check include those that dene remote server aliases, cluster
conguration, JDBC connection pools, e-mail listeners, LDAP servers, proxy servers,
Broker conguration, and WmDB.

webMethods Integration Server Administrators Guide Version 9.10

482

Odd Header
Master Passwords and Outbound Passwords

E-mail Listeners and Package Replication

When you export a package that is associated with a listener, information about that
listener is sent with the package. However, in the case of an e-mail listener, not all
the listener conguration information is sent to the destination Integration Server.
Specically, the outbound password that the e-mail listener uses to connect to the e-mail
Server is not sent. As a result, when the listener on the destination Integration Server
tries to connect to the e-mail server, the connection fails. Although the listener appears
on the list of ports, it will not be enabled. You will also see error messages on the server
console.
To enable the port, go to the Security > Ports > Edit E-mail Client Configuration Screen in the
Integration Server Administrator and update the Password eld to specify the password
needed to connect to the e-mail server.
If you export a package that is associated with an e-mail listener from a 6.5 Integration
Server to a pre-6.5 Integration Server, the e-mail listener will not be replicated at all. You
must manually recongure the listener on the pre-6.5 Integration Server after installing
the package there.

webMethods Integration Server Administrators Guide Version 9.10

483

Even Header

webMethods Integration Server Administrators Guide Version 9.10

484

Odd Header
Securing Integration Server with CSRF Guard

23 Securing Integration Server with CSRF Guard

What is CSRF? ..........................................................................................................................

486

How Does Integration Server Prevent CSRF Attacks? .............................................................

486

Understanding CSRF Guard Terminology .................................................................................

486

Configuring CSRF Guard in Integration Server .........................................................................

488

Limitations when Configuring CSRF Guard in Integration Server .............................................

490

webMethods Integration Server Administrators Guide Version 9.10

485

Even Header
Securing Integration Server with CSRF Guard

What is CSRF?
Cross-Site Request Forgery (CSRF) is one of the most common aacks on websites and
web applications. A CSRF aack occurs when a user inadvertently loads a webpage that
contains a malicious request. This webpage sends a malicious request to a website or
web application using the identity and privileges of the user to perform an undesired
action, such as changing congurations or invoking a service.
A web application is vulnerable to CSRF aacks if the application performs actions
based on inputs from authenticated users but does not require users to authorize specic
actions. That is, if you are authenticated to a web application by a cookie stored in your
web browser, you could unknowingly send a malicious HTTP or HTTPS request to the
application.

How Does Integration Server Prevent CSRF Attacks?

Integration Server uses the CSRF guard feature to prevent CSRF aacks. Integration
Server prevents CSRF aacks by creating one CSRF secure token per session when it
receives authorization requests from Integration Server Administrator or other client
applications. Integration Server adds this CSRF secure token to subsequent requests
until the session expires. The CSRF token expires when the session ends.
When you send a request, Integration Server veries the existence and validity of the
token in the request and compares it to the token in the session. If there is no token
in the request, or if the token in the request does not match the token in the session,
Integration Server terminates the request. Integration Server also logs the event as a
potential CSRF aack in the server log and the security audit log.
You use the Integration Server Administrator to enable or disable CSRF guard in
Integration Server.
Integration Server inserts and veries CSRF secure tokens for:
HTTP requests from a web browser for dynamic server pages (DSPs)
HTTP request for invoke or rest directives
Ajax XMLHpRequests

Understanding CSRF Guard Terminology

Before conguring CSRF guard in Integration Server, you may nd it helpful to rst
understand the following terminology used with reference to CSRF guard in Integration
Server:
Excluded User Agents.The user agent value is the string that corresponds to the UserAgent HTTP header in the HTTP request. Excluded user agents are user agents for
webMethods Integration Server Administrators Guide Version 9.10

486

Odd Header
Securing Integration Server with CSRF Guard

which Integration Server does not enforce CSRF guard. That is, Integration Server
will not check for CSRF tokens on requests from these excluded user agents.
You can specify the user agents as regular expressions. The asterisk (*) is the only
wildcard character allowed in the regular expression. To separate the entries, enter
one user agent per line. Press ENTER to separate the lines.
For example:
Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)
Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_0 like Mac OS X; en-us)
AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7A341
Safari/528.16
*Mozilla*

Landing Pages. The home pages of Integration Server packages are referred to as
landing pages. Integration Server will not check for CSRF secure tokens in the
landing pages, but the server will insert a token for that page. Integration Server
guards all further requests from these landing pages with CSRF secure tokens.
You cannot specify landing pages as regular expressions. To separate the entries,
enter one landing page per line. Press ENTER to separate the lines.
For example:
MyPackage /index.dsp
MyPackage /index.html

Unprotected URLs. The URLs for which Integration Server does not have to check
for CSRF secure tokens are referred to as unprotected URLs. Integration Server
requires that the requests coming from all URLs that are not specied in this eld
must contain CSRF secure tokens.
If you specify a DSP page as an unprotected URL, Integration Server will not insert
a CSRF secure token for that le. If you aempt to access a protected page from this
DSP page, Integration Server issues an error or redirects you to the home page of
Integration Server Administrator depending on your Denial Action conguration.
You can specify unprotected URLs as regular expressions. The asterisk (*) is the only
wildcard character allowed in the regular expression. To separate the entries, enter
one URL per line. Press ENTER to separate the lines.
The following table provides examples of URLs for Unprotected URLs text area.
In this example...

Integration Server does not check for CSRF secure token

in...

MyPackage/abc.dsp

The abc.dsp page in the MyPackage package.

MyPackage/*

All the pages in the MyPackage package.

invoke/
pub.math:addInts

A request invoking the pub.math:addInts service.

webMethods Integration Server Administrators Guide Version 9.10

487

Even Header
Securing Integration Server with CSRF Guard

In this example...

Integration Server does not check for CSRF secure token

in...

invoke/pub*

Requests invoking all services starting with pub.

invoke/*

Any invoke requests.

Denial Action. The action you want Integration Server to perform when it detects that
a request does not contain a CSRF secure token or contains an invalid CSRF secure
token. You can congure Integration Server to:
Redirect the user to the home page of Integration Server Administrator or to a
webpage that displays a warning that Integration Server has detected a CSRF
aack.
Issue an error and terminate the request.

Configuring CSRF Guard in Integration Server

Keep the following points in mind when you congure CSRF guard in Integration
Server:
When you enable or disable CSRF guard in Integration Server, you must refresh the
web browser for the changes to take eect.
Integration Server does not provide protection from CSRF aacks in the following
situations:
Requests from users with execute access to invoke services that have the
Anonymous ACL assigned to them.
Requests from Integration Server Administrator or a client application after an
Integration Server session has timed out. In such cases, Integration Server will
redirect the user or issue an error. You must refresh the web browser to continue.
Requests from user agents that are dierent from the user agent that was used
when creating the session.
To configure CSRF guard in Integration Server
1. Open Integration Server Administrator.
2. In the Navigation panel, select Security > CSRF Guard > Edit CSRF Guard Settings.
3. Select the Enabled check box to enable CSRF guard in Integration Server.
4. In the Excluded User Agents text area, enter the user agents for which CSRF guard is
not to be enforced.
The user agent value is the string that corresponds to the User-Agent HTTP header
in the HTTP request.

webMethods Integration Server Administrators Guide Version 9.10

488

Odd Header
Securing Integration Server with CSRF Guard

You can specify the user agents as regular expressions. The asterisk (*) is the only
wildcard character allowed in the regular expression. To separate the entries, enter
one user agent per line. Press ENTER to separate the lines.
5. In the Landing Pages text area, enter the list of landing pages for the packages in your
Integration Server. Integration Server will not check for CSRF secure tokens in the
landing pages, but the server will insert a token for that page. Integration Server
guards all further requests from these landing pages with CSRF secure tokens.
You cannot specify landing pages as regular expressions. To separate the entries,
enter one landing page per line. Press ENTER to separate the lines.
6. In the Unprotected URLs text area, enter the URLs for which Integration Server does
not have to check for CSRF secure tokens.
You can specify unprotected URLs as regular expressions. The asterisk (*) is the only
wildcard character allowed in the regular expression. To separate the entries, enter
one URL per line. Press ENTER to separate the lines.
Note:

Do not specify landing pages in the Unprotected URLs text area. If you
specify landing page URLs in both Landing Pages and Unprotected URLs text
areas, the landing page option will take precedence and Integration Server
will not check for CSRF secure tokens in those pages.

7. From the Denial Action options, select the action that you want Integration Server
to perform when it detects that a request does not contain a CSRF secure token or
contains an invalid CSRF secure token.
Select...

To...

Error

Issue an access denied error and terminate the request. This

is the default.
If you select Error, Integration Server issues the following error
when it detects that a request does not contain a CSRF secure
token or contains an invalid CSRF secure token:
Access Denied. Invalid CSRF secure token.

This error message suggests that Integration Server has

detected a CSRF aack.
Integration Server also issues this error message for the
following situations:
Integration Server session has expired.
The web browser is not refreshed after enabling CSRF guard.
Another user who is connected to the same Integration
Server restarted Integration Server.
In these cases, refresh the web browser to continue.

webMethods Integration Server Administrators Guide Version 9.10

489

Even Header
Securing Integration Server with CSRF Guard

Select...

To...

Redirect

Redirect the user as follows:

If the CSRF threat is detected when a user accesses a DSP
page in the Integration Server Administrator, redirect the
user to the home page of Integration Server Administrator.
If the CSRF threat is detected in a URL or client request that
includes an invoke or rest directive, redirect the user to a
webpage that displays a warning that Integration Server
has detected a CSRF aack. The user must click Continue to
execute the service.
Note: Integration Server redirects the user to this page
only if the client application accepts text/html as the
content type. If the client application does not accept
text/html, Integration Server returns an access denied
error.

8. Click Save Changes and refresh the web browser for the changes to take eect.

Limitations when Configuring CSRF Guard in Integration

Server
When you enable or disable CSRF guard in Integration Server, you must refresh the
web browser.
You cannot use the CSRF guard feature if your Integration Server runs as part of a
non-clustered group of Integration Servers in which the ISInternal functional alias on
each server points to the same database.
Integration Server does not insert CSRF secure tokens in custom DSP pages that use
JavaScript Location object, such as document.location and window.location.href. You
must update these pages manually.
You do not have to dene the JavaScript variables _csrfTokenNm_ , _csrfTokenVal_ ,
is_csrf_guard_enabled , and needToInsertToken . But, you must import
Integration Server_directory\instances\instance_name \packages\WmRoot\csrfguard.js to your DSP before using these variables.
Integration Server inserts CSRF secure tokens in the links in DSPs only if these links
point to a DSP. If these links do not point to a DSP, you must update these links
manually to include the CSRF secure tokens.
For example, if you have the following code in your DSP:
<a href="/invoke/wm.sap.Transaction/viewAs?type=xml</a>

You must replace it with the following code:

webMethods Integration Server Administrators Guide Version 9.10

490

Odd Header
Securing Integration Server with CSRF Guard

<a href="/invoke/wm.sap.Transaction/viewAs?type=xml&secureCSRFToken=
%value secureCSRFToken%"></a>

For more information about using CSRF guard in DSPs, see Dynamic Server Pages and
Output Templates Developers Guide.

webMethods Integration Server Administrators Guide Version 9.10

491

Even Header

webMethods Integration Server Administrators Guide Version 9.10

492

Odd Header
Configuring webMethods Enterprise Gateway

24 Configuring webMethods Enterprise Gateway

Overview .....................................................................................................................................

494

How Enterprise Gateway Works ................................................................................................

494

Version Interoperability Between Enterprise Gateway Server and Internal Server ....................

498

Advantages of Enterprise Gateway over Traditional Third-Party Proxy Servers ........................ 499
About Denial of Service Protection ............................................................................................

500

About Mobile Application Protection ..........................................................................................

501

About Mobile Data Synchronization ...........................................................................................

501

About SQL Injection Protection ..................................................................................................

502

About Antivirus Scan Filter ........................................................................................................

502

About Custom Filter ...................................................................................................................

503

Clustering in the Enterprise Gateway Configuration ..................................................................

504

Setting Up an Enterprise Gateway ............................................................................................

505

Configuring the Enterprise Gateway Ports ................................................................................

506

Connecting Your Internal Server to an Enterprise Gateway Server ...........................................

512

Viewing Connections to the Enterprise Gateway Registration Port ...........................................

516

Performing Client Authentication on Enterprise Gateway Server ..............................................

516

Working with Enterprise Gateway Rules ...................................................................................

517

Specifying Alert Options .............................................................................................................

525

Preventing Denial of Service Attacks ........................................................................................

527

Controlling Use of Mobile Applications ......................................................................................

529

Frequently Asked Questions about Enterprise Gateway ...........................................................

531

webMethods Integration Server Administrators Guide Version 9.10

493

Even Header
Configuring webMethods Enterprise Gateway

Overview
If your Integration Server sits behind an internal rewall and is not allowed to accept
communications from external clients through the DMZ, you can set up a webMethods
Enterprise Gateway to allow this server to process requests from external clients such as
mobile applications.
In an Enterprise Gateway conguration, the Integration Server that remains behind the
inner rewall is referred to as an Internal Server. You place another Integration Server,
called an Enterprise Gateway Server, in your DMZ. The Enterprise Gateway Server acts
as an intermediary between the external clients and your Internal Servers to protect
your Internal Servers and their applications, services, and data from malicious aacks.
Enterprise Gateway Server supports nearly all requests that a regular Integration Server
handles, including guaranteed delivery.
By default, all user validation and transaction processing is performed on the Internal
Server, but you can congure Enterprise Gateway Server to perform user validation.
You can also set up rules on Enterprise Gateway Server to lter requests before they are
passed to the Internal Server.
Important: To use Enterprise Gateway, you must have a webMethods Enterprise
Gateway license. The license for Enterprise Gateway allows only partial
Integration Server functionality. Install Enterprise Gateway on its own host
Integration Server. Do not install other products on an Integration Server
that hosts Enterprise Gateway.

How Enterprise Gateway Works

The following diagram illustrates how an external client request is handled in an
Enterprise Gateway conguration:

webMethods Integration Server Administrators Guide Version 9.10

494

Odd Header
Configuring webMethods Enterprise Gateway

External clients send requests to Enterprise Gateway Server (1). Enterprise Gateway
Server collects client information from each request and evaluates the request against
any Enterprise Gateway rules that have been dened. Enterprise Gateway Server then
passes requests that have not violated a rule to the Internal Server (2). The Internal
Server processes the requests and sends responses to Enterprise Gateway Server (3).
Enterprise Gateway Server then passes the responses back to the client (4).

Enterprise Gateway Ports

The Integration Server that functions as an Enterprise Gateway Server uses an Enterprise
Gatewayexternal port to listen for requests from external clients and an Enterprise
Gatewayregistration port through which it maintains its connection to the Internal Server.
For security purposes, the Internal Server initiates the outbound connections to the
registration port.
By limiting the connections to just those established by the Internal Server, the
Enterprise Gateway makes it more dicult for aackers to directly penetrate your
internal network, even if they subvert a system in the DMZ. However, like any other
security mechanism, it is not foolproof; the information still ows from the DMZ to the
internal network over the connection established from inside the rewall.
Important: To get the maximum benet from the Enterprise Gateway conguration,
Software AG highly recommends that you congure your inner rewall
to deny all inbound connections. With this conguration, you isolate the
Internal Server from the DMZ. This capability is the main advantage of using
an Enterprise Gateway Server over traditional third-party proxy servers.
The following diagram shows the location of the Enterprise Gateway external and
registration ports in the Enterprise Gateway conguration.

webMethods Integration Server Administrators Guide Version 9.10

495

Even Header
Configuring webMethods Enterprise Gateway

An Integration Server is not considered to be an Enterprise Gateway Server unless it has

an enabled Enterprise Gateway external port. By default, this port will be disabled and
all services, except for some basic services that Enterprise Gateway Server requires, will
be set to deny.
The Enterprise Gateway external and registration ports work as a pair. One port is not
functional without the other.
For instructions on seing up the Enterprise Gateway ports, see "Conguring the
Enterprise Gateway Ports" on page 506.

Enterprise Gateway Rules and Alerts

You can congure Enterprise Gateway rules to lter requests that Enterprise Gateway
Server sends to an Internal Server. You can also congure Enterprise Gateway Server to
send an alert when a request violates a rule.
When a rule is congured to send an alert and a violation occurs, Enterprise Gateway
Server logs the details in the server log and generates an alert. The alert message
contains detailed information that includes the IP address from which the request was
sent, user information, and the name of the rule lter that was met.

About Enterprise Gateway Rules

When a request violates a rule, Enterprise Gateway Server can deny the request, or it can
allow the request and send an alert about the violation. This behavior is controlled by
two types of Enterprise Gateway rules:

webMethods Integration Server Administrators Guide Version 9.10

496

Odd Header
Configuring webMethods Enterprise Gateway

Denial rules.Enterprise Gateway Server denies the request and sends an alert. The
server stops processing the request as soon as it detects a match to a lter and does
not consider other lters in the rule or any other rules for this request.
Alert rules.Enterprise Gateway Server sends an alert about the violation and then
continues processing the request. If a rule contains multiple lters, the server checks
each lter and sends an alert each time it detects a match. After processing the
rule, the server continues to the next rule. If there are no subsequent rules, or if the
request does not violate any denial rules, the server allows the request.
Enterprise Gateway Server applies rules in the order in which they are displayed on
the Enterprise GatewayRules screen. Because a violation of a denial rule causes Enterprise
Gateway Server to stop processing a request, it is important to prioritize the rules based
on the order in which you want them to be evaluated. The server processes denial rules
before alert rules.
You can congure an Enterprise Gateway rule to:
Deny a request and send an alert about the violation.
Allow a request and send an alert about the violation.
Apply to all request types or only to SOAP, REST, or INVOKE requests.
Apply to requests to use services or resources that have a particular name.
Contain one more lters. If a request matches the condition specied by a lter, the
request is in violation of the rule. For rules that contain multiple lters, if a request
matches any one lter, the rule is in violation. For example, you can lter requests
based on message size, the presence of an OAuth token, or the mobile application
and type of device from which the request was sent.
Contain no lters. Even if you do not specify lters in a rule, you can still use a rule
to apply to certain request types or to requests for specic resources. For example,
you can deny all SOAP requests.
For instructions on dening Enterprise Gateway rules, see "Working with Enterprise
Gateway Rules" on page 517.

About Enterprise Gateway Alerts

You can control the following aspects of alerts that Enterprise Gateway Server sends
when a request violates a rule:
Whether or not Enterprise Gateway Server issues an alert for a rule violation.
How often Enterprise Gateway Server issues the alert. The server can issue an alert
each time a rule is violated or at a specied time interval.
If you specify a time interval, Enterprise Gateway Server sends an alert when a
request rst violates the rule. If the violation occurs again within the specied time
interval, the server waits until the end of the time interval before sending any more
alerts for this request.

webMethods Integration Server Administrators Guide Version 9.10

497

Even Header
Configuring webMethods Enterprise Gateway

The method Enterprise Gateway Server uses to send the alert. The server can send
alerts by way of email or a ow service.
To send email alerts, the Integration Server acting as the Enterprise Gateway Server
must be congured to send emails. Check the seings on the Seings > Resources
screen under Email Notification. If your Enterprise Gateway Server is not congured
to send emails, see "Sending Messages About Critical Issues to E-mail Addresses" on
page 222.
To send alerts by way of a ow service, Enterprise Gateway Server can use the
pub.security.enterpriseGateway:alertSpec specication as the signature of the ow service.
For more information about the specication, see webMethods Integration Server BuiltIn Services Reference.
Whether a rule uses default alert options or its own customized alert options.
For instructions on conguring Enterprise Gateway alerts, see "Specifying Alert
Options" on page 525.

Version Interoperability Between Enterprise Gateway Server

and Internal Server
Prior to version 9.7, Enterprise Gateway Server and Internal Server had to be the same
version of Integration Server. However, beginning with version 9.7, this requirement
is removed. Enterprise Gateway Server can now operate with previous versions of
Integration Servers acting as Internal Servers. For example, Enterprise Gateway Server
version 9.7 can work with Integration Server versions 9.7, 9.6, and 9.5 SP1 as the Internal
Servers.
Interoperability between versions of Enterprise Gateway Server and Internal Server have
the following benets:
You can upgrade only the Integration Server acting as Enterprise Gateway Server
without having to upgrade the Integration Server acting as the Internal Server.
You can leverage the features that are available in the latest releases of the Enterprise
Gateway Server.
Keep the following information about Enterprise Gateway Server and Internal Server
version interoperability in mind:
The version of Enterprise Gateway Server must be equal to or higher than the
version of Integration Server acting as the Internal Server.
The version of Integration Server acting as the Internal Server must be 9.5 SP1 or
later.
You must obtain the correct webMethods Enterprise Gateway license from
Software AG for the version of Enterprise Gateway that you want to run.

webMethods Integration Server Administrators Guide Version 9.10

498

Odd Header
Configuring webMethods Enterprise Gateway

If installing Enterprise Gateway for the rst time, you must select the correct release
version of webMethods Enterprise Gateway that you want to run from the list
of available releases in the Software AG Installer regardless of the version of the
Integration Server acting as the Internal Server. For example, to install Enterprise
Gateway 9.7 you must select webMethods 9.7 as the Release version in Software AG
Installer.
You cannot upgrade Enterprise Gateway using the overinstallation procedure. To
upgrade Enterprise Gateway, you must rst install the Integration Server that you
want to host Enterprise Gateway and then, install the higher version of Enterprise
Gateway in the host Integration Server. For example, to upgrade Enterprise Gateway
9.6 that is hosted in Integration Server 9.6 to Enterprise Gateway 9.7, you must rst
install the host Integration Server 9.6. Then, you must run Software AG Installer
again to install Enterprise Gateway 9.7 on the new installation of Integration Server
9.6.
You must install Enterprise Gateway and Internal Server in dierent installation
directories and preferably, on dierent machines. Do not congure a single
Integration Server to be both an Enterprise Gateway Server and an Internal Server.
Enterprise Gateway xes are delivered as part of Integration Server xes.
If a version of Internal Server is not compatible with the Enterprise Gateway Server
that you are conguring, Integration Server logs an error message stating the same in
Enterprise Gateway Server as well as the Internal Server.
Internal Server and Enterprise Gateway Server must use the same type of client
authentication for the external port.
Integration Server 9.5 SP1 does not support using password digest for client
authentication. If your Enterprise Gateway Server is 9.6 or higher, you cannot use
digest authentication if your Internal Server is version 9.5 SP1.

Advantages of Enterprise Gateway over Traditional ThirdParty Proxy Servers

An Enterprise Gateway conguration oers a number of advantages over traditional
third-party proxy servers:
Enterprise Gateway uses persistent connections. These connections eliminate the
huge overhead of establishing SSL connections, while providing all the benets of
encryption.
With Enterprise Gateway, you can congure your inner rewall to deny all inbound
connections, isolating the Internal Server from the DMZ.
Enterprise Gateway requires no changes to the external client.
Enterprise Gateway rules can be dened to lter client requests.

webMethods Integration Server Administrators Guide Version 9.10

499

Even Header
Configuring webMethods Enterprise Gateway

An Integration Server acting as an Enterprise Gateway Server can handle both HTTP
and HTTPS requests. Typically, third-party proxy servers can handle only one or the
other.

About Denial of Service Protection

You can use Enterprise Gateway to prevent Denial of Service (DoS) aacks. One form
of DoS aack occurs when a client oods a server with many requests in an aempt to
interfere with server processing. Using Enterprise Gateway, you can limit the number of
requests that your Enterprise Gateway Server will accept within a specied time interval
and the number of requests that it can process concurrently. By specifying these limits,
you can protect your Enterprise Gateway Server and your Internal Server from DoS
aacks.
You can congure Enterprise Gateway Server to consider the total number of requests
from all IP addresses, or to consider the number of requests from individual IP
addresses. For example, you might want to limit the total number of requests received
to 10 requests in 10 seconds, and limit the number of requests coming from any single
IP address to 2 requests in 10 seconds. When the server detects that a limit has been
exceeded, the server sends an alert. Depending on your conguration, the server
can temporarily block requests from all clients, or deny requests from particular IP
addresses.
For instructions on conguring Enterprise Gateway Server to prevent DoS aacks, see
"Preventing Denial of Service Aacks" on page 527.

About Trusted IP Addresses

To ensure that requests from trusted servers are not denied, you can congure a
whitelist of IP addresses so that requests from these IP addresses are always allowed.
While specifying trusted IP addresses, keep the following points in mind:
Enterprise Gateway Server supports the inclusion of IPv4 and IPv6 addresses in the
trusted IP addresses lists.
You can specify a range of IP addresses using the classless inter-domain routing
(CIDR) notation. To specify an IP address range, enter the rst IP address in the
range followed by a forward slash (/) and a CIDR sux.
Example IPv4 address range:
192.168.100.0/22 represents the IPv4 addresses from 192.168.100.0 to
192.168.103.255
148.20.57.0/30 represents the IPv4 addresses from 148.20.57.0 to
148.20.57.3

Example IPv6 address range:

webMethods Integration Server Administrators Guide Version 9.10

500

Odd Header
Configuring webMethods Enterprise Gateway

f000::/1 represents the IPv6 addresses from f000:: to

ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff.
2001:db8::/48 represents the IPv6 addresses from 2001:db8:0:0:0:0:0:0to
2001:db8:0:ffff:ffff:ffff:ffff:ffff.

You can also specify a single IP address instead of an IP address range.

You can specify multiple IP addresses or CIDR ranges. Separate each IP address or
CIDR range with a comma (,).
For instructions on specifying trusted IP addresses, see "Preventing Denial of Service
Aacks" on page 527.

About Mobile Application Protection

You can use Enterprise Gateway to disable access for certain mobile application versions
on a predened set of mobile platforms. By disabling access to these versions, you
are ensuring that all users are using the latest versions of the applications and taking
advantage of the latest security and functional updates.
To use Enterprise Gateway application protection, you dene mobile application
lters in Enterprise Gateway rules. These lters check requests for application name,
application version, and the type of device from which the request was sent. The mobile
application provides this information in the request header. If a mobile application
sends a request that matches a lter condition, Enterprise Gateway Server performs the
congured action of denying the request or sending an alert about it. For instructions
on conguring Enterprise Gateway Server to control mobile application use, see
"Controlling Use of Mobile Applications" on page 529.

About Mobile Data Synchronization

You can use the webMethods Mobile Support feature of Enterprise Gateway to
synchronize data between mobile devices and backend applications. This feature
consists of the following:
An Integration Server package called WmMobileSupport, which contains the
elements a business integration developer needs to create the server-side business
logic of a data synchronization solution. This package is used with the Internal
Server installed behind the rewall.
A library called the Mobile Support Client, which contains APIs a mobile application
developer needs to initiate data synchronization requests. This library resides on the
system where mobile applications are developed.
For more information about using this feature to synchronize data between mobile
devices and a backend application, see Developing Data Synchronization Solutions with
webMethods Mobile Support.

webMethods Integration Server Administrators Guide Version 9.10

501

Even Header
Configuring webMethods Enterprise Gateway

About SQL Injection Protection

You can use the SQL injection protection lter of Enterprise Gateway to block requests
that could possibly cause an SQL injection aack. When this lter is enabled in
Enterprise Gateway, Integration Server checks each request message for specic paerns
of characters or keywords that are associated with potential SQL injection aacks. If
a match is found in the request parameters or payload, Integration Server blocks the
request from further processing.
Integration Server processes the incoming payload at Enterprise Gateway and if the
incoming request contains characters that are not permied for a database, based on
how the rule is congured, Integration Server either denies the request and sends an
alert about the violation or allows the request and sends an alert about the violation.
Integration Server provides two types of lters that you can enable to prevent SQL
injection aacks:
Database-Specific SQL Injection Protection. If enabled, Integration Server will check
the incoming payload based on the specied database and GET or POST request
parameters. If no parameter is specied, all input parameters will be checked for
possible SQL injection aack. Integration Server adheres to the ESAPI (OWASP
Enterprise Security API) standards while validating the parameters.
Parameters are applicable only for HTTP queries and HTTP form data, in which
there are name value pairs.
For example, in the HTTP query string, http://localhost:1111/invoke/
myjdbc.db:addUser?userid=' or '1'='1' --, the parameter is userid.
Standard SQL Injection Protection. If enabled, Integration Server will block XML and
SOAP payload messages that contain quotation mark ('), number sign (#), or double
hyphen (--) in the message.
For example, in the following XML payload, the Text elements (Title, Artist, and
Country) contain invalid characters, ', #, and -- respectively.
<CATALOG>
<CD>
<TITLE>Albu'm name</TITLE>
<ARTIST>John# Smith</ARTIST>
<COUNTRY>USA--</COUNTRY>
<YEAR>2014</YEAR>
</CD>
</CATALOG>

About Antivirus Scan Filter

You can use the antivirus scan lter to congure Enterprise Gateway to interact with
an Internet Content Adaptation Protocol (ICAP)-compliant server. An ICAP server is
capable of hosting multiple services that you can use to implement features such as virus
scanning or content ltering. Using the antivirus scan lter, Enterprise Gateway Server
webMethods Integration Server Administrators Guide Version 9.10

502

Odd Header
Configuring webMethods Enterprise Gateway

can leverage the ICAP protocol to scan all incoming HTTP requests and payloads for
viruses.
Note:

The antivirus scan lter feature is certied on c-icap server, which is an

implementation of an ICAP server, and can be integrated with all ICAPcompliant virus scanning applications.

If the antivirus scan lter is enabled as part of an Enterprise Gateway rule, Enterprise
Gateway Server validates all incoming payloads by using the capabilities of the ICAP
server in the following steps:
1. Enterprise Gateway Server forwards the request to the ICAP sever.
2. The ICAP server scans the request using the registered ICAP service.
3. If the ICAP server detects any malicious content in the request, depending on how
the Enterprise Gateway rule is congured, Enterprise Gateway Server denies the
request or allows the request and sends an alert about the violation of the rule.
Before enabling the antivirus scan lter, ensure that the following prerequisites are met:
An ICAP-compliant server must be installed and congured in the DMZ and the
Enterprise Gateway Server must be able to access the ICAP-compliant server.
The ICAP-compliant sever must have an ICAP service registered and the service
must be accessible using the following format:
icap://<icap_server>:<icap_port>/serviceName

Enterprise Gateway Server must be congured to send emails so that Integration

Server can send alerts in case of any conguration or connectivity issues with the
ICAP server. The email alerts are sent to the e-mail address of the administrator
specied in the Internal Email eld on the Seings > Resources screen.

About Custom Filter

You can use the custom lter to invoke a service that is available on the Enterprise
Gateway Server.
You can use this capability to customize and invoke services in the Enterprise Gateway
Server to perform actions such as custom authentication of external clients in the DMZ,
logging or auditing in the DMZ, or implementation of custom rules for processing
various payloads.
Using the custom service implementation, you can extract the HTTP headers and
payload from a request and act on it as per your business requirements. Upon
processing the headers, you can choose to forward the request to the internal server or
deny the request and return an error message to the user.
You can also use the pub.flow:setResponseHeaders and pub.flow:setResponseCode services to
add custom headers to the response and to set customized response codes.

webMethods Integration Server Administrators Guide Version 9.10

503

Even Header
Configuring webMethods Enterprise Gateway

Keep the following points in mind when creating an Enterprise Gateway rule with the
custom lter:
Integration Server processes the incoming payload at Enterprise Gateway only if the
custom logic in the service requires it to be processed.
Use the pub.security.enterprisegateway:customFilterSpec specication as the signature of the
custom service. For more details about the specication, see webMethods Integration
Server Built-In Services Reference.
The custom lter is the last lter that the Enterprise Gateway Server will check while
processing an Enterprise Gateway rule.
An Enterprise Gateway rule that contains the custom lter that is enabled must be
a denial rule. Enterprise Gateway Server automatically converts an alert rule into a
denial rule when you enable the custom lter.

Clustering in the Enterprise Gateway Configuration

You can have multiple Enterprise Gateway Servers and use a third-party product to load
balance them. In addition, you can cluster your Internal Servers to improve availability,
reliability, and scalability. For more information about Integration Server clustering, see
webMethods Integration Server Clustering Guide.
The following diagram illustrates a supported conguration. Keep the following points
in mind when working with clustered Internal Servers:
Each Internal Server must connect to each Enterprise Gateway Server.
Do not create a cluster of Enterprise Gateway Servers or include them as members of
a cluster of regular Integration Servers.

webMethods Integration Server Administrators Guide Version 9.10

504

Odd Header
Configuring webMethods Enterprise Gateway

Setting Up an Enterprise Gateway

This section describes the high-level steps for seing up the Enterprise Gateway. The
following checklist summarizes these steps:
Done?

Task

Notes

Install an Integration
Server in your DMZ
to be your Enterprise
Gateway Server

When you identify an Integration Server to

be an Enterprise Gateway Server, keep in
mind that any external client on the Internet
can access this server. Therefore, be very
security conscious about the services you make
available and the users you dene.
Do not perform development work on this
server and do not set up users or groups on it.
Do not congure a single Integration
Important:
Server to be both an Enterprise Gateway
Server and an Internal Server. This
conguration is not supported, and
unpredictable results will occur.

Disable the Developer

and Replicator users

You will not need these users on an Enterprise

Gateway Server. Disabling these users
prevents someone from gaining access to your
Enterprise Gateway Server through them. For
more information, see "Disabling and Enabling
Users" on page 98.

Congure the
Enterprise Gateway
external port

For instructions, see "Conguring the

Enterprise Gateway Ports" on page 506.

Congure the
Enterprise Gateway
registration port

For instructions, see "Conguring the

Enterprise Gateway Ports" on page 506.

Note:If you plan to use an HTTPS port, you must

store a server certicate, a server private
key, and a CA certicate on this server. For
instructions, see "Securing Communications
with the Server" on page 401.

If you are going to set up an encrypted

connection between the Internal Server and
Enterprise Gateway Server, you can optionally
store a certicate for the Internal Servers

webMethods Integration Server Administrators Guide Version 9.10

505

Even Header
Configuring webMethods Enterprise Gateway

Done?

Task

Notes
administrator user on Enterprise Gateway
Server. For more information, see "Importing
a Certicate (Client or CA Signing Certicate)
and Mapping It to a User" on page 452.
Optional (but strongly recommended). Set up IP
address ltering on the registration port so
that only the Internal Server can connect to
Enterprise Gateway Server. This step provides
an additional layer of protection to supplement
the IP address ltering performed by your
rewall and the user authentication.
Note:Even if your external rewall lters out
connections to the Enterprise Gateway
registration port, IP address ltering is a
good idea because it will stop insiders from
connecting to Enterprise Gateway Server.
For more information, see "Restricting IP
Addresses that Can Connect to a Port" on page
423.

Connect your Internal

Server to Enterprise
Gateway Server

For instructions, see "Connecting Your Internal

Server to an Enterprise Gateway Server " on
page 512.

Configuring the Enterprise Gateway Ports

The Enterprise Gateway external and registration ports work as a pair. One port is
not functional without the other. Use this procedure to congure these ports on an
Enterprise Gateway Server.
To configure the Enterprise Gateway ports
1. Open the Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel, on the Security menu, click Ports.
3. On the Security > Ports screen, click Add Port.
4. Under Type of Port to Configure, select Enterprise GatewayServer.
5. Click Submit.

webMethods Integration Server Administrators Guide Version 9.10

506

Odd Header
Configuring webMethods Enterprise Gateway

6. On the Edit Enterprise Gateway Server Configuration screen, under Enterprise

Gateway External Port, enter the following information:
For this parameter...

Specify...

Enable

Whether to enable or disable this port. If you choose to

disable the port, you can enable it later on the Ports screen.

Protocol

The protocol to use for this port (HTTP or HTTPS). If you

select HTTPS, additional security and credential boxes will
be displayed at the boom of the screen.

Port

The number you want to use for the external port. Use
a number that is not already in use. This is the port that
clients will connect to through your outer rewall.

Alias

An alias for the port. An alias must be between 1 and

255 characters in length and include one or more of the
following: leers (a -z, A-Z), numbers (0-9), underscore (_),
period (.), and hyphen (-).

Description

A description of the port.

Package Name

The package to associate with this port. You must specify

the same package name for both external and registration
ports. Typically, you will not need to work with packages
on an Enterprise Gateway Server. Therefore, you can leave
the default seing.

Bind Address
(optional)

The IP address to which to bind this port. Specify a bind

address if your machine has multiple IP addresses and you
want the port to use this specic address. If you do not
specify a bind address, the server picks one for you.

Backlog

The number of requests that can remain in the queue for

an enabled port before Enterprise Gateway Server begins
rejecting requests. The default is 200. The maximum value
is 65535.
Note: This parameter does not apply to disabled ports.
Enterprise Gateway Server refuses requests sent to
disabled ports.

Keep Alive Timeout

How long to wait before closing an idle connection to a

client. The default is 20000 ms.

webMethods Integration Server Administrators Guide Version 9.10

507

Even Header
Configuring webMethods Enterprise Gateway

For this parameter...

Specify...

Threadpool

Whether to create a private thread pool for this port or use

the common thread pool.
To have the server use the common server thread pool for
this port, select Disable.
To have the server create a private thread pool for this
port so that it does not need to compete with other server
functions for threads, select Enable.
If Threadpool is enabled, specify these additional
parameters:
Threadpool Min
Minimum number of threads Enterprise Gateway Server
maintains in this thread pool. When the server starts, the
thread pool initially contains this minimum number of
threads. The server adds threads to the pool as needed
until it reaches the maximum allowed. The default is 1.
Threadpool Max
Maximum number of threads the server maintains in
this thread pool. If this maximum number is reached, the
server waits until services complete and return threads to
the pool before running more services. The default is 5.
Threadpool Priority
Priority with which the JVM treats threads from this
thread pool. The larger the number, the higher the priority.
The default is 5.
Use caution when seing the thread pool priority,
Important:
as this seing can aect server performance and
throughput.
When you view details for the port later, the server
displays the total number of private threadpool threads
currently in use for the port.

7. Under Enterprise Gateway Registration Port, enter the following information:

For this parameter...

Specify...

Enable

Whether to enable or disable this port. If you choose to

disable the port, you can enable it later on the Ports screen.

webMethods Integration Server Administrators Guide Version 9.10

508

Odd Header
Configuring webMethods Enterprise Gateway

For this parameter...

Specify...

Protocol

The protocol to use for this port (HTTP or HTTPS). If you

select HTTPS, additional security and credential boxes will
be displayed at the boom of the screen.

Port

The number you want to use for the registration port. Use
a number that is not already in use.
It is best not to use a standard port such as 80 (the standard
port for HTTP) or 443 (the standard port for HTTPS)
because the external rewall will allow access to those
ports from the outside world.

Alias

An alias for the port. An alias must be between 1 and

255 characters in length and include one or more of the
following: leers (a -z, A-Z), numbers (0-9), underscore (_),
period (.), and hyphen (-).

Description

A description of the port.

Package Name

The package to associate with this port. You must specify

the same package name for both external and registration
ports. Typically, you will not need to work with packages
on an Enterprise Gateway Server. Therefore, you can leave
the default seing.

Bind Address
(optional)

The IP address to which to bind this port. Specify a bind

address if your machine has multiple IP addresses and you
want the port to use this specic address. If you do not
specify a bind address, the server picks one for you.

8. For both external port and registration port, specify the type of client authentication
to perform in the Security Configuration panel.
For external ports, this seing determines the type of authentication to perform for
requests coming from the external client through the port. For registration ports, this
seing determines the type of authentication to perform when the Internal Server
establishes a persistent connection to Enterprise Gateway Server. Seings specied
for registration ports control whether Enterprise Gateway Server will ask the Internal
Server to present a certicate. See "Authenticating Clients" on page 447 for more
information about how clients are authenticated.
Note:

In a default Enterprise Gateway conguration, Enterprise Gateway

Server does not perform client authentication. Rather, the server obtains
authentication information (user/password or certicates) from the
external client and passes this information to the Internal Server for
authentication. However, you can have Enterprise Gateway Server

webMethods Integration Server Administrators Guide Version 9.10

509

Even Header
Configuring webMethods Enterprise Gateway

perform client authentication as well. For details, see "Performing Client

Authentication on Enterprise Gateway Server " on page 516.
Select one of the following options:
Option

Description

Username/Password

Enterprise Gateway Server will not request client

certicates.
For external ports, the server will look for user and
password information in the header of requests coming
from an external client.
For registration ports, the server will look for user and
password information from the Internal Server.

Digest

Enterprise Gateway Server will use password digest

authentication.
For external ports, the server will look for password digest
information in the header of requests coming from an
external client.

Request Client
Certificates

Enterprise Gateway Server will request client certicates.

For external ports, the server will request client
certicates for requests that come through this port. If the
client does not present a certicate, the request proceeds
using the user and password information contained in the
request header.
For registration ports, the server will request a client
certicate from the Internal Server. If the Internal Server
does not present a certicate, the request proceeds using
the user and password information.

Require Client
Certificates

Enterprise Gateway Server will require client certicates.

For external ports, Enterprise Gateway Server requires
client certicates for all requests that come through this
port. If the client does not supply a certicate, the request
fails.
Use the same authentication mode here as you
Important:
use for the Internal Server. For example, suppose
you specify authentication mode Required on
the Internal Server. Specifying Required on the
Enterprise Gateway external port ensures that the

webMethods Integration Server Administrators Guide Version 9.10

510

Odd Header
Configuring webMethods Enterprise Gateway

Option

Description
request passed to the Internal Server includes a
certicate.
For registration ports, Enterprise Gateway Server requires
a client certicate from the Internal Server. If the Internal
Server does not supply a client certicate, the request
fails. In addition, if the certicate is not mapped to a user
with Administrator privileges on Enterprise Gateway
Server, the request fails.

Use JSSE

If this port should support TLS 1.1 or TLS 1.2, click Yes
to create the port using the Java Secure Socket Extension
(JSSE) socket factory. If you set this value to No, the port
supports only SSL 3.0 and TLS 1.0. The default is No.
Note: This eld is available only if you selected HTTPS in the
Protocol eld.

9. If you selected HTTPS in the Protocol eld for either the external port or the
registration port, optionally enter the following information under Listener Specific
Credentials:
Note:

Use these seings only if you want to use a dierent set of credentials from
the ones specied on the Certicates screen.

For this parameter...

Specify...

Keystore Alias

The keystore alias created for the keystore containing the

certicate that Enterprise Gateway Server is to present to
requests coming in through this port.

Key Alias

The alias for a specic key in the specied keystore.

Truststore Alias

The alias for the truststore le that contains the trusted root
certicates associated with the CA signing authority.

10. Click Save Changes.

Deleting Enterprise Gateway External and Registration Ports

When you rst set up the Enterprise Gateway external and registration ports, you
associated each port with a package. If you delete one of the ports, Enterprise Gateway
Server deletes the other port for you.

webMethods Integration Server Administrators Guide Version 9.10

511

Even Header
Configuring webMethods Enterprise Gateway

You delete ports on the Integration Server AdministratorPorts screen. For details, see
"Conguring Ports" on page 155.

Connecting Your Internal Server to an Enterprise Gateway

Server
This procedure describes how to connect your Internal Server to an Enterprise Gateway
Server.
To connect the Internal Server to the Enterprise Gateway Server
1. Open the Integration Server Administrator on the Integration Server acting as the
Internal Server.
2. In the Navigation panel of the screen, on the Security menu, click Ports.
3. On the Security > Ports screen, click Add Port.
4. Under Type of Port to Configure, select Internal Server.
5. Click Submit.
6. On the Edit Internal Server Configuration screen, under Internal Server, enter the
following information:
For this parameter...

Specify...

Enable

Whether to enable or disable this port. If you choose to

disable the port, you can enable it later on the Ports screen.

Protocol

The protocol to use for this port (HTTP or HTTPS). If you

select HTTPS, additional security and credential boxes will
be displayed at the boom of the screen.

Package Name

The package to associate with the port. Typically, you will

not need to work with packages on an Internal Server.
Therefore, you can leave the default seing.

Alias

An alias for the port. An alias must be between 1 and

255 characters in length and include one or more of the
following: leers (a -z, A-Z), numbers (0-9), underscore (_),
period (.), and hyphen (-).

Description

A description of the port.

Max Connections

The number of connections maintained between Enterprise

Gateway Server and the Internal Server. The default is 5.

webMethods Integration Server Administrators Guide Version 9.10

512

Odd Header
Configuring webMethods Enterprise Gateway

For this parameter...

Specify...
Note: For best performance, set the Max Connections seing
on the listener to be slightly less than the Maximum
Threads of the Server Threadpool seing on the
Seings > Resources page. If you have more than one
listener dened on the Internal Server, the sum of
their Max Connection seings should be slightly less
than the Maximum Threads of the Server Threadpool
seing. Do not set Max Connections to be equal to the
Internal Servers threadpool. Instead, reserve enough
threads to handle the execution of scheduled services,
triggers, and users that connect directly to the Internal
Server.

Threadpool

Whether to create a private thread pool for this port or use

the common thread pool.
To have the server use the common server thread pool for
this port, select Disable.
To have the server create a private thread pool for this
port so that it does not need to compete with other server
functions for threads, select Enable.
If Threadpool is enabled, specify these additional
parameters:
Threadpool Min
Minimum number of threads the server maintains in
this thread pool. When the server starts, the thread pool
initially contains this minimum number of threads. The
server adds threads to the pool as needed until it reaches
the maximum allowed. The default is 1.
Threadpool Max
Maximum number of threads the server maintains in
this thread pool. If this maximum number is reached, the
server waits until services complete and return threads to
the pool before running more services. The default is 5.
Threadpool Priority
Priority with which the JVM treats threads from this thread
pool. The larger the number, the higher the priority. The
default is 5.
Use caution when seing the thread pool priority,
Important:
as this seing can aect server performance and
throughput.

webMethods Integration Server Administrators Guide Version 9.10

513

Even Header
Configuring webMethods Enterprise Gateway

For this parameter...

Specify...
When you view details for the port later, the server
displays the total number of private threadpool threads
currently in use for the port.

7. Under Enterprise GatewayServer, enter the following information:

For this parameter...

Specify...

Host

The host name or IP address of the machine on which

Enterprise Gateway Server is running.

Port

The port number of the registration port on Enterprise

Gateway Server.

8. If you selected HTTPS in the Protocol box, optionally enter the following information
under Registration Credentials. Note that the registration credentials specied here
must match the seings on the Enterprise Gateway registration port:
For this parameter...

Specify...

User Name

The name of the user on Enterprise Gateway Server that

the Internal Server should connect as.

Password

The password of the user on Enterprise Gateway Server

that the Internal Server should connect as.

Use JSSE

If this port should support TLS 1.1 or TLS 1.2, click Yes
to create the port using the Java Secure Socket Extension
(JSSE) socket factory. If you set this value to No, the port
supports only SSL 3.0 and TLS 1.0. The default is No.
Note: This eld is available only if you selected HTTPS in the
Protocol eld.

Keystore Alias

The keystore alias created for the keystore containing

the certicate that the Internal Server sends to Enterprise
Gateway Server for client authentication. The Internal
Server sends this certicate when it makes its initial
registration connection to Enterprise Gateway Server. The
Internal Server sends this certicate only if asked to by
Enterprise Gateway Server.

webMethods Integration Server Administrators Guide Version 9.10

514

Odd Header
Configuring webMethods Enterprise Gateway

For this parameter...

Specify...
Specify a value here only if you want to present a dierent
server certicate from the one specied on the Certicates
screen.

Key Alias

The key alias created for the key pair and associated
certicate, in the previously specied keystore.

Truststore Alias

The alias for the truststore le that contains the trusted root
certicates associated with the CA signing authority.

9. Under External Client Security, in the Client Authentication list, specify the type of client
authentication the Internal Server performs against external clients. External clients
pass their authentication information to Enterprise Gateway Server, which in turn
passes it to the Internal Server.
Option

Description

Username/Password

The Internal Server will not request client certicates from

external clients. Instead it will look for user and password
information in the request header.

Digest

The Internal Server will look for password digest

information in the request header.

Request Client
Certificates

The Internal Server will request client certicates for

requests from external clients. If the external client does not
present a certicate, the request proceeds using the user
and password information contained in the request header.

Require Client
Certificates

The Internal Server requires client certicates for requests

from external clients. If the external client does not supply
a certicate, the request fails.

Important: Use the same authentication mode here as you use for the Enterprise
Gateway external port. For example, specifying Require Client Certificates
for both the Internal Server and the Enterprise Gateway external
port ensures that the request passed to the Internal Server includes a
certicate.
For more information about processing client certicates, see "Authenticating
Clients" on page 447.
10. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

515

Even Header
Configuring webMethods Enterprise Gateway

Viewing Connections to the Enterprise Gateway Registration

Port
You can view a list of the Internal Server connections for a single Enterprise Gateway
registration port.
To view the connections to an Enterprise Gateway registration port
1. Open the Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel of the screen, on the Security menu, click Ports.
3. On the Security > Ports screen, click the port number of an Enterprise Gateway
registration port.
4. On the Security > Ports > View Enterprise Gateway Server Details screen, click
Display Connections toEnterprise GatewayRegistration Port.
Integration Server Administrator displays the Security > Ports > Enterprise Gateway
Registration Port Connections screen. The Enterprise Gateway Registration Port
Connections: portNumber table lists the Internal Server connections to the Enterprise
Gateway registration port at the specied portNumber . For each connection
Integration Server Administrator displays the following information:
Field

Description

Host

IP address of the Internal Server connected to

the Enterprise Gateway registration port.

Port

The local port number of the socket created for

the remote Internal Server connection.

Connected (Number of
Connections)

Indicates whether or not the Internal Server

is connected to the Enterprise Gateway
registration port.

Performing Client Authentication on Enterprise Gateway

Server
In a default Enterprise Gateway conguration, external clients send requests to
Enterprise Gateway Server, which in turn forwards authentication information (user/
password or certicates) about these clients to the Internal Server. The Internal Server

webMethods Integration Server Administrators Guide Version 9.10

516

Odd Header
Configuring webMethods Enterprise Gateway

performs the authentication. This is the recommended conguration because certicates

are safer when stored on the Internal Server, behind two rewalls.
However, if you want Enterprise Gateway Server to perform client authentication in
addition to the authentication performed on the Internal Server, you can do so.
To enable client authentication on Enterprise Gateway Server
1. In the Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server, navigate to the Settings > Extended screen and set the
wa.server.revInvoke.proxyMapUserCerts system property to true.
2. If Enterprise Gateway Server is congured to request or require certicates, then for
each external client to which you want to allow access, Enterprise Gateway Server
must contain a copy of the clients public certicate mapped to a user. For more
information about mapping certicates, see "Importing a Certicate (Client or CA
Signing Certicate) and Mapping It to a User" on page 452.
If, instead, Enterprise Gateway Server is congured to request certicates or perform
authentication using user name and password, then Enterprise Gateway Server must
contain a user name for that client.
Make sure that the external clients imported certicate or user name is the same on
both the Enterprise Gateway Server and the Internal Server.
3. Set the client authentication mode of the Enterprise Gateway external port to Require
Client Certificates:
a. Navigate to the Security > Ports screen.
b. Find the row for the Enterprise Gateway external port. Click the port number,
and then click Edit HTTP Port Configuration.
c. In the Enterprise GatewayExternal Port area of the Edit Enterprise Gateway
Server Conguration screen, in the Client Authentication box, select Require Client
Certificates.
Note:

Client authentication is supported only by the HTTPS protocol. If you

do not see the Client Authentication box, change the external port protocol
to HTTPS.

d. Click Save Changes.

Working with Enterprise Gateway Rules

An Enterprise Gateway rule consists of one or more lters that determine which requests
are allowed to pass through Enterprise Gateway Server to the Internal Server.

Creating an Enterprise Gateway Rule

Keep the following points in mind when creating an Enterprise Gateway rule:

webMethods Integration Server Administrators Guide Version 9.10

517

Even Header
Configuring webMethods Enterprise Gateway

If you want to send email alerts, the Integration Server acting as the Enterprise
Gateway Server must be congured to send email alerts. For more information, see
"Sending Messages About Critical Issues to E-mail Addresses" on page 222.
Be careful to prioritize rules in the order in which you want them to be evaluated.
This is particularly important in the case of denial rules because a violation of
a denial rule causes Enterprise Gateway Server to stop processing a request,
sometimes before the entire rule has been evaluated.
You can create a rule that contains no lters. You might use such a rule to deny
all requests of a certain request type, or to send alerts about requests that use a
particular resource.
When a new rule is created, Enterprise Gateway Server applies the default alert
options to the rule. To customize the alert options for a rule, see "Specifying RuleSpecic Alert Options" on page 526.
Enterprise Gateway rules are categorized into denial and alert rules. When you
create a new rule, it is added to the end of the list of rules in the appropriate category
on the Security > Enterprise Gateway Rules page.
To create an Enterprise Gateway rule
1. Open Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel, select Security >Enterprise GatewayRules.
3. On the Enterprise Gateway Rules screen, click Create Rule.
4. In the Rule Name box, enter a name for the rule.
Valid rule names:
Must be unique.
Must not be null.
Must not contain spaces.
Must not contain these special characters:
? ~ ` ! @ # $ % ^ & * ( ) - + = { } | [ ] \\ : \" ; ' < > , /
5. In the Description box, enter a brief description for the rule.
6. If you want to enable the rule immediately, select the Enable check box. Enterprise
Gateway Server applies a rule to requests only if the rule is enabled. You can enable
the rule later on the Enterprise Gateway Rules page.
7. From the Request Type list, select the type of request to which you want to apply the
Enterprise Gateway rule. Select ALL if you want to apply this rule to all requests.
Select SOAP, REST, or INVOKE to apply this rule to SOAP, REST, or INVOKE requests,
respectively.
8. To lter a request based on the resource being requested, specify a string in the
Resource Path box in the format folder_name/service_name . You can specify multiple
webMethods Integration Server Administrators Guide Version 9.10

518

Odd Header
Configuring webMethods Enterprise Gateway

paths, one to a line, and you can specify an asterisk (*) wildcard character. This box
is available only if you selected a request type from the Request Type list.
Following are some examples of resource paths for INVOKE, web service, and REST
requests.

Figure 6. Example INVOKE request

Figure 7. Example web service request

Figure 8. Example REST request

webMethods Integration Server Administrators Guide Version 9.10

519

Even Header
Configuring webMethods Enterprise Gateway

9. In the Action box, select one of the following:

Select...

To...

Deny Request
and Alert

Deny the request if it violates the rule. Enterprise Gateway

Server sends an alert based on the congured alert options.

Alert

Allow the request and send an alert based on the congured

alert options.

10. In the Error Message box, enter a custom message that you want Enterprise Gateway
Server to send to the client if a request violates an Enterprise Gateway deny rule. The
server sends this message as a status message for an HTTP 403 status code, in the
format HTTP 403 custom error message .
11. Under OAuth Filter, select the Require OAuth Credentials check box if you want
Enterprise Gateway Server to check for an OAuth token in the authorization header
of the request. Select the Enable check box to enable this lter now, or enable this
lter later by editing the rule on the Edit Rule screen.
12. Under Message Size Filter, in the Maximum Message Size box, enter the maximum
size allowed for HTTP and HTTPS requests, in megabytes. If the request is larger
than the size specied in this limit, the request will violate the rule and Enterprise
Gateway Server will perform the congured action. Select the Enable check box to
enable this lter now, or enable this lter later by editing the rule on the Edit Rule
screen.
13. Under Mobile Application Protection Filter, specify one or more conditions that describe
requests based on the device type from which the request was sent and the version
of mobile application that sent the request. If a request meets a condition, the rule
is violated and Enterprise Gateway Server will perform the congured action. For
example, you can specify that you will not allow requests from out-of-date versions
of the ABC application sent from a ZZZ smart phone. Select the Enable check box to
enable this lter now, or enable this lter later by editing the rule on the Edit Rule
screen.
14. Under SQL Injection Protection Filter, select one or both of the following:

webMethods Integration Server Administrators Guide Version 9.10

520

Odd Header
Configuring webMethods Enterprise Gateway

Select...

To...

DatabaseSpecific SQL
Injection
Protection

Block incoming requests that contain paerns recognized as

potential SQL injection aacks for specic databases.
From the Database list, select the database against which
specic parameters needs to be checked.
Under Parameters, specify one or more GET or POST request
parameters that could be present in the incoming requests.
Parameters can contain only alphanumeric characters, dollar
sign ($), and underscore (_).

Standard
SQL Injection
Protection
Note:

Block XML or SOAP payload messages that contain quotation

mark ('), number sign (#), or double hyphen (--) anywhere
within the message.

Even though you can select both the lters, selecting multiple options
may increase the message processing time because each lter requires a
separate inspection of the request message.

Select the Enable check box to enable this lter now, or enable this lter later by
editing the rule on the Edit Rule screen.
15. Under Antivirus Scan Filter, enter the following information if you want Enterprise
Gateway Server to scan the incoming payload for viruses:
For this
parameter...

Specify...

Antivirus ICAP
Engine Name

A name for the ICAP server.

ICAP Host
Name or IP
Address

The host name or IP address of the machine on which the

ICAP server is running.

ICAP Port
Number

The port number on which the ICAP server is listening.

ICAP Service
Name

The name of the service exposed by the ICAP server that you
can use to scan your payload for viruses.

Select the Enable check box to enable this lter now, or enable this lter later by
editing the rule on the Edit Rule screen.

webMethods Integration Server Administrators Guide Version 9.10

521

Even Header
Configuring webMethods Enterprise Gateway

16. Under Custom Filter, click the Browse buon adjacent to the Invoke Service eld if you
want to invoke a service that is available on the Enterprise Gateway Server. From
the Package Name list, select the package that contains the service that you want to
invoke. Enterprise Gateway Server populates the Service Name list with the names of
the services that have the pub.security.enterprisegateway:customFilterSpec specication as its
signature in the selected package. Select the service that you want to invoke.
In the Run As User box, click
to select the user name you want Enterprise Gateway
Server to use to run the service. The default is Administrator.
You can select a user from the local or central directory. Enterprise Gateway Server
runs the service as if the user you specify is the authenticated user that invoked the
service. If the service is governed by an ACL, be sure to specify a user that is allowed
to invoke the service.
Important: If the custom lter is enabled, the Enterprise Gateway rule that contains
the custom lter must be a denial rule. Enterprise Gateway Server
automatically converts an alert rule into a denial rule when you enable
the custom lter.
Select the Enable check box to enable this lter now, or enable this lter later by
editing the rule on the Edit Rule screen.
17. Click Save Changes.
Enterprise Gateway Server displays the rule on the Enterprise Gateway Rules page
under Denial Rules or Alert Rules depending on the action you selected when you
created the rule.

Enabling an Enterprise Gateway Rule

Enterprise Gateway Server applies a rule to requests only if the rule is enabled. You can
enable a rule when you create it, or you can enable the rule later by using this procedure.
To enable an Enterprise Gateway rule
1. Open Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel, select Security >Enterprise GatewayRules.
3. On the Enterprise Gateway Rules screen, click No in the Enabled column for the rule
you want to enable.
4. Click OK in response to the prompt asking to enable the rule.
When the rule is enabled, the server displays the
column.

webMethods Integration Server Administrators Guide Version 9.10

icon and Yes in the Enabled

522

Odd Header
Configuring webMethods Enterprise Gateway

Disabling an Enterprise Gateway Rule

If you do not want to apply a specic Enterprise Gateway rule to requests, but you do
not want to delete the rule, you can disable it.
Note:

Disabling a rule has no eect on its priority order on the Enterprise Gateway
Rules screen.

To disable an Enterprise Gateway rule

1. Open Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel, select Security >Enterprise GatewayRules.
3. On the Enterprise Gateway Rules screen, click Yes in the Enabled column for the rule
you want to disable.
4. Click OK in response to the prompt asking to disable the rule.
When the rule is disabled, the server displays No in the Enabled column.

Editing an Enterprise Gateway Rule

While editing an Enterprise Gateway rule, you can modify all properties of the rule
except its name. If you change a denial rule to an alert rule or vice versa, Enterprise
Gateway Server adds the rule to the boom of the corresponding denial or alert list,
thereby assigning the lowest priority to that rule in that category. To change the rules
priority, see "Changing the Priority of an Enterprise Gateway Rule" on page 524.
To edit an Enterprise Gateway rule
1. Open Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel, select Security >Enterprise GatewayRules.
3. On the Enterprise Gateway Rules screen, in the rules list, click the name of the rule
that you want to edit.
4. In the properties screen for the selected rule, make the necessary modications.
5. Click Save Changes.

Copying an Enterprise Gateway Rule

You can create a new Enterprise Gateway rule by copying an existing rule. When you
copy a rule, the lter seings, alert options, and other properties, except for rule name,
are copied.

webMethods Integration Server Administrators Guide Version 9.10

523

Even Header
Configuring webMethods Enterprise Gateway

To copy an Enterprise Gateway rule

1. Open Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel, select Security >Enterprise GatewayRules.
3. On the Enterprise Gateway Rules screen, click
want to copy.

in the Copy column for the rule you

The server appends _copy to the rule name and displays the properties page of the
rule.
4. View or modify the rule properties and lters as necessary. For more information,
see "Creating an Enterprise Gateway Rule" on page 517.
5. Click Save Changes.

Changing the Priority of an Enterprise Gateway Rule

Enterprise Gateway Server applies the Enterprise Gateway rules in the order in which
they are displayed on the Enterprise Gateway Rules screen. If a request meets a lter
condition in a denial rule, for example, the server denies the request and does not
proceed to the next lter in the rule or to another rule. You can change the priority of the
rules to ensure that they are applied in their intended order.
To change the priority of an Enterprise Gateway rule
1. Open Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel, select Security >Enterprise GatewayRules.
3. On the Enterprise Gateway Rules screen, in the Priority column for the rule you want
to move, do one of the following:
To...

Click this button...

Move the rule up in the list

Move the rule down in the list

Deleting an Enterprise Gateway Rule

When you no longer need an Enterprise Gateway rule, you can delete it.

webMethods Integration Server Administrators Guide Version 9.10

524

Odd Header
Configuring webMethods Enterprise Gateway

To delete an Enterprise Gateway rule

1. Open Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel, select Security >Enterprise GatewayRules.
3. On the Enterprise Gateway Rules screen, click the
corresponds to the rule you want to delete.

icon in the row that

4. Click Delete. When you are prompted to conrm that you want to delete the rule,
click OK.

Specifying Alert Options

You can specify default alert options that apply to all rules. You can also specify rulespecic alert options.

Specifying Default Alert Options

By default, if an Enterprise Gateway rule does not specify an alert type, Enterprise
Gateway Server does not send an alert when a request violates the rule. If you want to
issue an alert even when no alert type is specied for the rule, you can congure default
alert options.
Note:

In order to send email alerts about rule violations, the Integration Server
acting as the Enterprise Gateway Server must be congured to send emails.
Check the seings on the Seings > Resources screen under Email Notification. If
your Enterprise Gateway Server is not congured to send emails, see "Sending
Messages About Critical Issues to E-mail Addresses" on page 222.

To specify the default alert options

1. Open Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel, select Security >Enterprise GatewayRules.
3. In the Navigation panel on the Enterprise Gateway Rules screen, select Default Alert
Options and then click Edit Default Alert Options.
4. From the Alert Type list, select one of the following options:
Select...

To...

None

Not send any alerts. This is the default.

Email

Send email alerts.

webMethods Integration Server Administrators Guide Version 9.10

525

Even Header
Configuring webMethods Enterprise Gateway

Select...

To...

Flow Service

Invoke a ow service to alert you of a rule violation.

5. In the Send Alert box, do one of the following:

If you want Enterprise Gateway Server to send alerts every time a request
violates a rule, select On rule violation.
If you want Enterprise Gateway Server to send alerts at specied intervals, select
Every and then enter the time interval (in minutes). When a request violates the
rule, the server sends an alert. If the violation occurs again within the specied
time interval, the server waits until the end of the time interval before sending
the alert. For example, suppose you specify the time interval as 1 minute. At
10:00, a request violates the rule and the server sends an alert. Ten seconds later,
another request violates the rule. Ten seconds later, yet another request violates
the rule. The server waits until 10:01 to send a summary of alerts that were
generated in the time interval.
6. If you selected email as the alert type, enter the email addresses to which you want
to send the alerts in the Email Addresses box. You can enter multiple email addresses.
Separate addresses with semicolons (;).
7. If you selected ow service as the alert type, do the following:
a. In the folder.subfolder:service box, enter the fully qualied service name of the ow
service you want Enterprise Gateway Server to execute.
Note:

Use the pub.security.enterpriseGateway:alertSpec specication as the signature

of the ow service. For more details about the specication, see
webMethods Integration Server Built-In Services Reference.

b. In the Run As User box, enter the user name you want Enterprise Gateway Server
to use when running the service. Click to search for and select the user. You
can select a user from the local or central directory.
Enterprise Gateway Server runs the service as if the user you specify is the
authenticated user that invoked the service. If the service is governed by an ACL,
be sure to specify a user that is allowed to invoke the service.
8. Click Save Changes.

Specifying Rule-Specific Alert Options

The default rule alert options are applied at a global level across all rules. You can also
specify rule-specic alert options if you want a rule to have its own alert options.
To specify rule-specific alert options
1. Open Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.

webMethods Integration Server Administrators Guide Version 9.10

526

Odd Header
Configuring webMethods Enterprise Gateway

2. In the Navigation panel, select Security >Enterprise GatewayRules.

3. On the Enterprise Gateway Rules screen, in the list of rules, the Alert Options column
shows whether the rule has the default alert options or customized alert options.
Click Default or Custom to open the Edit Alert Options page.
4. Edit the alert options as required. For instructions on conguring alert options, see
"Specifying Default Alert Options" on page 525.
5. Click Save Changes.

Preventing Denial of Service Attacks

You can congure Enterprise Gateway Server to limit the number of requests the server
will accept and the number the server will process concurrently. By doing so, you can
protect both Enterprise Gateway Server and your Internal Server from Denial of Service
aacks that use a ood of incoming requests to interfere with server processing.
You can congure whether Enterprise Gateway Server sets limits on requests globally,
by IP address, or both.
However, to ensure that requests from trusted servers are not denied, you can specify a
list of trusted IP addresses. Requests from these trusted IP addresses are always allowed.
For more information about trusted IP address ranges, see "About Trusted IP Addresses"
on page 500.

Limiting Requests Globally

Use this procedure to limit the total number of requests Enterprise Gateway Server
will accept and the number it will process concurrently. When you select the global
option, the server considers all incoming requests, regardless of originating IP address.
If you have congured a list of trusted IP addresses, requests from those IP addresses
are not counted toward the request limit. When the number of requests exceeds the
congured limit, the server blocks all requests at all Enterprise Gateway external ports
for a period of time you specify. However, Enterprise Gateway Server will continue to
accept requests from trusted IP addresses even after the congured limit is reached.
If you want to limit the number of requests Enterprise Gateway Server will accept from
individual IP addresses, see "Limiting Requests by IP Address" on page 528.
If you specify both the global and IP address options, Enterprise Gateway Server
performs the global processing rst.
To limit requests globally
1. Open Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel, select Security >Enterprise GatewayRules.

webMethods Integration Server Administrators Guide Version 9.10

527

Even Header
Configuring webMethods Enterprise Gateway

3. In the Navigation panel on the Enterprise Gateway Rules screen, click Denial of
Service Options and then click Configure Global Denial of Service.
4. Select the Enable check box.
5. In the Maximum Requests box, enter the maximum number of requests you want
Enterprise Gateway Server to accept in a given time interval. Then, enter the time
interval, in seconds.
6. In the Maximum Requests in Progress box, enter the maximum number of requests that
can be in progress at the same time.
7. In the Block Interval box, enter the number of minutes Enterprise Gateway Server is to
block requests on every Enterprise Gateway external port.
8. In the Error Message box, enter a custom message to send to the client, if desired,
when a request is denied.
9. In the Trusted IP Address Range box, enter the trusted IPv4 or IPv6 addresses so that
requests from these IP addresses are always allowed. You can specify multiple IP
addresses or IP address ranges separated by commas (,). For more information about
trusted IP address ranges, see "About Trusted IP Addresses" on page 500.
10. Click Save Changes.

Limiting Requests by IP Address

Use this procedure to limit the number of requests Enterprise Gateway Server will
accept, or process concurrently, from any single IP address.
If the number of requests from an IP address exceeds the congured limit, Enterprise
Gateway Server blocks requests from that IP address at all Enterprise Gateway external
ports permanently, or for a period of time you specify. However, Enterprise Gateway
Server will continue to accept requests from trusted IP addresses even after the
congured limit is reached.
If you want to limit the total number of requests Enterprise Gateway Server will accept,
regardless of IP address, see "Limiting Requests Globally" on page 527.
If you specify both global and IP address options, Enterprise Gateway Server performs
the global processing rst.
To limit requests by IP address
1. Open Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel, select Security >Enterprise GatewayRules.
3. In the Navigation panel on the Enterprise Gateway Rules screen, click Denial of
Service Options and then click Configure Denial of Service by IP Address.
4. Select the Enable check box.

webMethods Integration Server Administrators Guide Version 9.10

528

Odd Header
Configuring webMethods Enterprise Gateway

5. In the Maximum Requests box, enter the maximum number of requests that Enterprise
Gateway Server can accept from a specic IP address in a given time interval. Then,
enter the time interval, in seconds.
6. In the Maximum Requests in Progress box, enter the maximum number of requests that
Enterprise Gateway Server can process concurrently from any single IP address.
7. In the When Limit Exceeds box, specify an action to take when the number of requests
from a non-trusted IP address exceeds the specied limits.
To permanently deny future requests from the IP address, select Add to Deny
List. Enterprise Gateway Server adds the IP address to the Enterprise Gateway
deny list. As a result, requests from this IP address will be denied at every
Enterprise Gateway external port. The IP address remains in the deny list until
an administrator deletes it from the list.
Note:

The Enterprise Gateway deny list takes precedence over the port-level
allow/deny list for the Enterprise Gateway external port.

To temporarily block requests from this IP address, select Block. In the Block
Interval box, specify the number of minutes you want requests to be blocked. To
block requests, Enterprise Gateway Server adds the IP address to the Enterprise
Gateway deny list. As a result, the server denies requests from this IP address on
every Enterprise Gateway external port for the congured time period.
8. In the Error Message box, enter a custom message to send to the client, if desired,
when a request is denied.
9. In the Trusted IP Address Range box, enter IP addresses or range of trusted IPv4 or
IPv6 addresses so that requests from these IP addresses are always allowed. You
can specify multiple IP addresses or IP address ranges separated by commas (,).
For more information about specifying trusted IP addresses, see "About Trusted IP
Addresses" on page 500.
10. Click Save Changes.

Controlling Use of Mobile Applications

You can regulate requests from mobile applications by only allowing requests from
certain versions of an application and from certain device types. By doing so, you ensure
that all users are using the latest versions of mobile applications and taking advantage of
the latest security and functional updates.
To control mobile application use, rst you dene a list of device types and a list of
mobile applications you want to regulate. Then, you select from these values when you
set up a mobile application lter in an Enterprise Gateway rule. The mobile application
must provide the device type, application name, and application version in the request
header in the following header elds:
Mobile-Device-Type
Mobile-Application-Name
webMethods Integration Server Administrators Guide Version 9.10

529

Even Header
Configuring webMethods Enterprise Gateway

Mobile-Application-Version
Note:

If a request includes a device type or application name that is not congured

in an Enterprise Gateway rule, Enterprise Gateway Server will allow the
request. Likewise, if a request species a version in an invalid format, the
server will allow the request. A request violates a rule only when the request
matches the condition specied in the lter.

To control mobile applications

1. Open Integration Server Administrator on the Integration Server acting as the
Enterprise Gateway Server.
2. In the Navigation panel, select Security >Enterprise GatewayRules.
3. In the Navigation panel on the Enterprise Gateway Rules screen, select Mobile
Application Protection Options.
4. Click Edit Device Types and enter the names of mobile devices, one per line, that you
want to restrict. After you have entered the device types, click Save Changes.
5. Click Edit Mobile Applications and enter the names of mobile applications, one per line,
that you want to restrict. After you have entered the device types, click Save Changes.
6. Click Return toEnterprise GatewayRules.
7. On the Enterprise Gateway Rules screen, either select Create Rule to create a new rule
or select an existing rule from the list.
8. On the Create Rule screen or the Edit Rule screen, scroll down to the Mobile
Application Protection Filter portion of the screen.
9. Select a device type, a mobile application name, a condition, and an application
version.
Specify the version in this format:
major-version .[minor-version .[sub-minor-version .[patch ]]]
For example, to disallow requests from old versions (pre-3.0) of the BigApp mobile
application sent from the XYZ mobile device, specify the following:
Field

Value

Device Type

XYZ

Mobile Application

BigApp

Condition

<

Mobile Application Version

3.0

webMethods Integration Server Administrators Guide Version 9.10

530

Odd Header
Configuring webMethods Enterprise Gateway

To allow requests from all 3.0 versions (3, 3.0, 3.0.0, 3.0.0.0) of the BigApp mobile
application sent from the XYZ mobile device, specify the following:
Field

Value

Device Type

XYZ

Mobile Application

BigApp

Condition

Mobile Application Version

3.0

10. To add another condition, click Add and repeat the previous step.
11. Click Save Changes.

Frequently Asked Questions about Enterprise Gateway

This section provides answers to some frequently asked questions about Enterprise
Gateway.
If I dene the Enterprise Gateway external port to use HTTPS, do I need to dene the
Enterprise Gateway registration port to be an HTTPS port too?
No. The external port and the registration port operate independently.
How many connections should I register between Enterprise Gateway Server and the Internal
Server?
That depends on the expected load and the size of the transactions. A connection
between Enterprise Gateway Server and the Internal Server is available except when
a request is being wrien to the Internal Server or a response is being returned from
the Internal Server. In other words, Enterprise Gateway connection utilization is
I/O bound. Therefore, if you expect large, simultaneous transactions, increase the
number of registered connections accordingly.
If the Internal Server runs out of registration connections, it will issue the following
error message:
number requests waiting for a registration connection.

Each connection consumes a thread, either from the Internal Servers common
thread pool or from the internal listeners private thread pool, if one is dened. The
consumed thread can only be used to process requests from Enterprise Gateway
Server.

webMethods Integration Server Administrators Guide Version 9.10

531

Even Header
Configuring webMethods Enterprise Gateway

If you have dened a private thread pool for the internal registration listener, the
number of connections you can specify in the Max Connections box is limited to the
maximum number of threads allowed in the private thread pool for this listener.
If you have multiple internal registration listeners, each with its own private thread
pool, the same rule applies for each internal registration listener.
If you have not dened a private thread pool for an internal registration listener, a
reasonable limit for the Max Connections box is 75% of the number of server threads
specied in Server Thread Pool Max Threads box on the Seings > Resources page.
If you have multiple internal registration listeners and none of them have private
thread pools, the sum of all connections specied in the Max Connections boxes for
these listeners should not exceed 75% of the number of server threads specied in
Server Thread Pool Max Threads.
A thread will remain open unless it is closed by a rewall, a network glitch, or an
exception.
Is there persistence with Enterprise Gateway Server?
No. Enterprise Gateway Server is just a network hop for the incoming request.
I want to authenticate the SSL credentials of external clients. Where do I set up
certicates?
The following table shows where to set up certicates for the default Enterprise
Gateway conguration, in which the Internal Server performs client authentication.
If you want to perform client authentication on Enterprise Gateway Server as well,
see "Performing Client Authentication on Enterprise Gateway Server " on page
516.
Enterprise Gateway Server

Internal Server

Enterprise Gateway External Port

Set up a keystore that contains the
server certicate and private key for
Enterprise Gateway Server.
Set up a truststore that contains the
certicates of certicate authorities
trusted by Enterprise Gateway Server.

Set up a truststore that contains the

certicates of certicate authorities
trusted by the Internal Server.

Enterprise Gateway Server will make

sure that certicates sent by external
clients are signed by CAs in this
truststore.

The Internal Server will make sure

that certicates sent by external
clients (through Enterprise Gateway
Server) are signed by CAs in this
truststore.

This truststore must be the same as the

truststore on the Internal Server.

webMethods Integration Server Administrators Guide Version 9.10

532

Odd Header
Configuring webMethods Enterprise Gateway

Enterprise Gateway Server

Internal Server
This truststore must be the same
as the truststore for the Enterprise
Gateway external port.

(Optional) Import public certicates of

external users and map them to users
on Enterprise Gateway Server.

Import public certicates of external

users and map them to users on the
Internal Server.

Do this only if you want to perform

client authentication on Enterprise
Gateway Server in addition to the
Internal Server.

If you choose to perform client

authentication on both Enterprise
Gateway Server and the Internal
Server, make sure the certicate
mappings are the same on both
servers.

If you choose to perform client

authentication on both Enterprise
Gateway Server and the Internal
Server, make sure the certicate
mappings are the same on both
servers.
Enterprise Gateway Registration Port
(HTTPS)
Import the Internal Servers public
certicate and map it to a user that has
administrator privileges.

Set up a keystore that contains the

Internal Servers certicate and
private key.

Make sure the Internal Servers CA

certicate is present in the truststore of
the registration port

Make sure the registration ports

CA certicate is present in the
Internal Servers truststore.

Can I use Enterprise Gateway Server as my outbound proxy server as well?

No. The only requests that go through Enterprise Gateway Server are inbound
requests from the external client destined for the Internal Server and responses to
those requests from the Internal Server back to the external client. Any unsolicited
requests from the Internal Server go directly to the external client.
What authentication mode should I use for Enterprise Gateway Server and the
Internal Server?
Authentication mode is the method a server uses to authenticate client requests. In
a default Enterprise Gateway conguration, Enterprise Gateway Server receives
authentication information from the external client and passes it to the Internal
Server, which performs the authentication.
Be sure to specify the same authentication mode for the Internal Server and for the
Enterprise Gateway external port. For example, if the Internal Servers authentication
webMethods Integration Server Administrators Guide Version 9.10

533

Even Header
Configuring webMethods Enterprise Gateway

mode is Required, the external port must also be Required so that Enterprise Gateway
Server always passes the external clients certicate to the Internal Server.
In contrast, the authentication mode of the Enterprise Gateway registration port does
not need to match the authentication mode of the Internal Server or the Enterprise
Gateway external port.
If you want to perform client authentication on Enterprise Gateway Server, see
"Performing Client Authentication on Enterprise Gateway Server " on page 516.
Does Enterprise Gateway support the FTP protocol?
No, support is limited to HTTP and HTTPS only.
Are the SOCK and SSLSOCK protocols supported?
No, these were proprietary protocols used in older releases. Starting with the 7.1
release, SOCK and SSLSOCK have been replaced by HTTP and HTTPS.
Is it possible to lter requests on Enterprise Gateway Server?
Yes. You can use Enterprise Gateway rules to lter requests based on a number
of factors, including request size, request type, and the name of resource being
invoked.

webMethods Integration Server Administrators Guide Version 9.10

534

Odd Header
Configuring OAuth

25 Configuring OAuth
What Is OAuth? ..........................................................................................................................

536

Using OAuth with Integration Server .........................................................................................

537

Authorization Grant Types Supported by Integration Server .....................................................

538

The Integration Server OAuth Services .....................................................................................

542

Important Considerations for Using OAuth Features .................................................................

543

Configuring the Authorization Server .........................................................................................

543

About Using Integration Server as the Resource Server ...........................................................

557

webMethods Integration Server Administrators Guide Version 9.10

535

Even Header
Configuring OAuth

What Is OAuth?
The OAuth 2.0 Authorization Framework (OAuth) facilitates the sharing of private
resources (data or services) with a third-party client application (client). In an OAuth
session, private resources are stored on a resource server and the owner of the resources,
or resource owner, grants the client application permission to access them. The resource
owner is typically a person; however, in some cases it could be an application. When a
resource owner grants permission, the OAuth authorization server issues an access token to
the client application. When the client application passes the access token to the resource
server, the resource server communicates with the authorization server to validate the
token and, if valid, provides access to the resources.
The following example illustrates the roles involved with an OAuth session. In the
example, Bob is the resource owner who wants to access and print his photos stored
on the PhotoStorage website (the resource server) using the PhotoPrint service (the
client application). PhotoPrint supplies Bob with an application that runs on his device
(phone, laptop, etc). Bob uses that application to initiate the process. PhotoPrint sends
a request to the PhotoStorage authorization server. The authorization server requests
authorization from Bob and issues a token to PhotoPrint. PhotoPrint can then access
Bob's photos on PhotoStorage.

An in-depth description of OAuth is beyond the scope of this guide but is available
elsewhere. For information about the OAuth protocol, see the OAuth 2.0 Authorization
Framework.

webMethods Integration Server Administrators Guide Version 9.10

536

Odd Header
Configuring OAuth

Using OAuth with Integration Server

Integration Server can be an OAuth client, an authorization server, or a resource
server. Integration Server Administrator provides an OAuth conguration feature that
developers can use to create and manage these roles. To enable the OAuth features, your
Integration Server must be equipped with a license from Software AG. For information
about licensing, see "Important Considerations for Using OAuth Features" on page
543.

Integration Server as an OAuth Client

When Integration Server is an OAuth client application, you use the
pub.client.oauth:executeRequest service to access resources from providers such as Facebook,
Google, Twier, or Integration Server. For information about accessing resources using
the pub.client.outh:executeRequest service, see webMethods Integration Server Built-In Services
Reference.

Integration Server as an Authorization Server

When Integration Server acts as an authorization server, it receives authorization
requests from client applications. Client applications initiate the request by invoking
the pub.oauth:authorize service. The authorization server handles the interactions between
the client application, resource server, and resource owner for approval of the request.
For information about conguring Integration Server as an authorization server, see
"Conguring the Authorization Server" on page 543.
When Integration Server acts as an authorization server, it issues access tokens as bearer
tokens. A bearer token is an access token that allows any party in possession of the
access token (Bearer) to use the token. The authorization server retains the information
about the bearer tokens it issues, including the user information. When the client
presents a bearer token to the resource server, the resource server sends the token to the
authorization server to ensure that the token is valid and that the requested service is
within the scope for which the access token was issued. A scope is the denition of the
folders and services (resources) that the client can access on behalf of a resource owner.
If the user is authorized to access the folders and services, the resource server executes
the request. If the user does not have privileges to access the resources, the resource
server rejects the request. For information about user privileges, see "Managing Users
and Groups" on page 89.

Integration Server as a Resource Server

When Integration Server acts as a resource server, it receives requests from client
applications that include an access token. The resource server asks the authorization
server to validate the access token and user. If the token is valid and the user has

webMethods Integration Server Administrators Guide Version 9.10

537

Even Header
Configuring OAuth

privileges to access the folders and services, the resource server executes the request.
The resource server and the authorization server might be the same Integration Server
instance or might be dierent Integration Server instances. For information about using
Integration Server as a resource server, see "About Using Integration Server as the
Resource Server" on page 557.

Authorization Grant Types Supported by Integration Server

The ow of authorization requests and responses between the resource owner, client
application, authorization server, and resource server depends on the authorization
grant type dened by the OAuth session. Integration Server supports the following
authorization grant types:
Authorization code grant
Implicit grant

Authorization Code Grant

The authorization code grant type is used to authenticate and provide access to clients
that have credentials on the authorization server. This grant type requires the client to
authenticate to the authorization server before obtaining an access token.
You use the authorization code grant type to authenticate and provide access to
condential clients. A condential client is a client that supplies a client ID and client
secret to the authorization server in order to obtain an access token. Condential clients
correspond to an account on the authorization server. If a client does not have the proper
credentials (client ID and secret) for the user account, the authorization server does not
grant the client an access token. To specify a condential client in Integration Server
Administrator, set Type to Confidential. For more information, see "Registering Clients" on
page 546.
When using the authorization code grant type, the authorization server can issue
a refresh token to the client application along with the access token. A refresh token
enables clients to get a new access token without requesting additional approval from
the resource owner. When the access token expires, the client application can use the
pub.oauth:refreshAccessToken service to pass the refresh token to the authorization server to
request a new access token.
The following diagram illustrates how the Integration Server authorization server
participates in the authorization code grant process.

webMethods Integration Server Administrators Guide Version 9.10

538

Odd Header
Configuring OAuth

Authorization Code Grant Flow

Stage

Description

The client application initiates the process by calling the pub.oauth:authorize

service to request access to the resource owners data.

The pub.oauth:authorize service validates the request. If valid, the service

responds with an HTML page that informs the resource owner that
the client application is requesting access within a specied scope. The
resource owner uses the HTML page to approve or deny the request.

webMethods Integration Server Administrators Guide Version 9.10

539

Even Header
Configuring OAuth

Stage

Description

When the resource owner approves the request, the approval page
invokes an internal service on Integration Server. If the resource owner
denies the request, an error is returned.

Integration Server generates an authorization code for the client

application. The server uses HTTP redirection to instruct the resource
owner's browser to transmit the authorization code to the redirection URI
provided by the client application.

The service at the client applications redirection URI passes the

authorization code to the pub.oauth:getAccessToken service on Integration
Server to exchange the authorization code for an access token.

Integration Server issues an access token to the client application. If set to

do so, the authorization server also issues a refresh token to the client.

The client application uses the access token to execute a service on the
resource server.

The resource server checks with the authorization server to make sure
the requested service is within the scope for which the access token was
issued and whether the client is authorized to access the folders and
services in the scope.

Implicit Grant
The implicit grant type is used to authenticate browser-based applications and
mobile applications. This grant type is less secure than the authorization code grant
because it does not require the client to authenticate with the authorization server. In
addition, the implicit grant type passes the access token through the resource owner's
browser, exposing it to theft by malicious applications on the resource owner's device.
The following diagram illustrates how the Integration Server authorization server
participates in the implicit grant process.
You use the implicit grant type to authenticate and provide access to public clients.
A public client is a client that uses only a client ID for identication, with no other
credentials. Public clients are typically implemented in a browser using a scripting
language such as JavaScript. Because the authorization server does not require any other
credentials, the authorization server grants any client with a valid client ID an access
token. To specify a public (implicit) client in Integration Server Administrator, set Type
to Public. For more information, see "Registering Clients" on page 546.

webMethods Integration Server Administrators Guide Version 9.10

540

Odd Header
Configuring OAuth

Implicit Grant Flow

Stage

Description

The client application initiates the process by calling the pub.oauth:authorize

service to request access to the resource owners data.

The pub.oauth:authorize service validates the request. If valid, the service

responds with an HTML page that informs the owner that the client
application is requesting access within a specied scope. The resource
owner uses a form on the HTML page to approve or deny the request.

When the resource owner approves the request, the approval page
invokes an internal service on Integration Server. If the resource owner
denies the request, an error is returned.

webMethods Integration Server Administrators Guide Version 9.10

541

Even Header
Configuring OAuth

Stage

Description

Integration Server redirects the resource owner's browser to the client

application's redirection endpoint, appending the access token as a
fragment on the redirection URI.

The resource owners browser holds the access token in memory until the
client application retrieves the access token.

The client application uses the access token to execute a service on the
resource server.

The resource server checks with authorization server to make sure the
requested service is within the scope for which the access token was
issued and whether the client is authorized to access the folders and
services in the scope.

The Integration Server OAuth Services

The following table lists services that you use to authorize a client application to access a
resource server.
Service

Description

pub.oauth:authorize

Initiates an authorization request from the client

application to the Integration Server authorization
server.

pub.oauth:getAccessToken

Requests an access token from the authorization server.

The request includes the authorization code sent to the
redirection URI by the authorization server.
The authorization server validates the request and
generates an access token and refresh token (optional).
The tokens, along with the client identier, expiration
time, and scope are stored in the authorization server's
cache.

pub.oauth:refreshAccessToken

Sends a request to the authorization server to refresh

the access token.

For more information about using the Integration Server OAuth services, see webMethods
Integration Server Built-In Services Reference.

webMethods Integration Server Administrators Guide Version 9.10

542

Odd Header
Configuring OAuth

Important Considerations for Using OAuth Features

Keep the following points in mind when using OAuth features:
If you are using webMethods Enterprise Gateway to process requests from external
clients, keep in mind that OAuth conguration seings in Integration Server
Administrator (Security > OAuth) are only available on Integration Servers that do not
act as an Enterprise Gateway Server. The Internal Server that sits behind the rewall
processes all OAuth requests. For more information about webMethods Enterprise
Gateway, see "Conguring webMethods Enterprise Gateway " on page 493.
In order for Integration Server to log OAuth activity, the Security logger must be
enabled and congured to log the following security areas: Authentication and
Authorization. For detailed instructions on enabling the security logger and selecting
security areas to audit, see the webMethods Audit Logging Guide.

Configuring the Authorization Server

Before you can begin to use OAuth in your Integration Server environment, you
need to specify seings for the authorization server. When the authorization server is
congured, you can start registering clients and managing your OAuth scopes.
Conguring OAuth consists of the following basic stages:
Stage 1

Congure OAuth seings.

During this stage, you congure the OAuth seings on Integration
Server. Integration Server is congured to use certain OAuth
seings by default. For information about conguring these
seings to reect those for your system, see "Conguring OAuth
Seings" on page 544.

Stage 2

Dene clients.
During this stage, you dene the clients that are authorized to
access the authorization server. For information about registering,
modifying, and deleting clients, see "Dening Clients" on page
546.

Stage 3

Dene scopes.
During this stage, you dene the scopes available for the clients
to access. For information about adding, modifying, and deleting
scopes, see "Dening Scopes" on page 550.

Stage 4

Associate scopes to clients and vice versa.

webMethods Integration Server Administrators Guide Version 9.10

543

Even Header
Configuring OAuth

During this stage, you associate scopes to clients and vice versa.
When you associate scopes and clients, you authorize the scopes
that each client can access. For information about adding,
removing, and viewing the associations between scopes and
clients, see " Associating Scopes and Clients" on page 552.
Stage 5

If you want to keep specic client applications from accessing

resources after the authorization server has granted an access
token, you can do either of the following:
Delete the active access and refresh tokens granted for that client
application. For information about viewing and deleting tokens,
see "Viewing and Deleting Tokens" on page 556.
Disable the client application. For information about disabling
client applications, see "Enabling and Disabling Clients" on page
549.

Configuring OAuth Settings

The OAuth global seings for the authorization server control whether HTTPS
is required for OAuth communications. You can also specify global values for
authorization code and access token expiration intervals. The expiration intervals can be
set globally or congured for each individual client.
To configure the OAuth settings
1. Open Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigational Panel, click OAuth.
3. Click Edit OAuth Global Settings.
4. Complete the elds as follows:
Field

Description

Require HTTPS

Indicates whether the authorization server

should require an HTTPS connection to authorize
requests.
If enabled (the default), Integration Server requires
that the authorization server uses HTTPS to invoke
the pub.oauth services. If disabled, Integration
Server allows client applications to use HTTP to
access the pub.oauth services.
Note: If Require HTTPS is enabled and the client
application accesses any of the pub.oauth

webMethods Integration Server Administrators Guide Version 9.10

544

Odd Header
Configuring OAuth

Field

Description
services over HTTP, Integration Server issues
an HTTP 500 error response to the client and
writes a service exception to the error log.
You can disable Require HTTPS to simplify
Important:
development, but you should use HTTPS in
production in accordance with the OAuth
Framework. If you do not require HTTPS, the
authorization server transmits access tokens
in clear text, making them vulnerable to theft.

Authorization code expiration

interval

Species the length of time (in seconds) that the

authorization code issued by the authorization
server is valid.
Valid values are between 1 and 2147483647. The
default value is 600.

Access token expiration

interval

Authorization server

Species the length of time (in seconds) that access

tokens issued by the authorization server are valid.
Select...

To...

Never Expires

Indicate that the access token

never expires

Expires in and
enter the number
of seconds. The
maximum value
is 2147483647.
The default is
3600.

Specify the length of time

that the access token is valid

If you are conguring Integration Server as a

resource server, this indicates a local or remote
Integration Server to use as the authorization
server. If you have not already dened an alias for
the authorization server, click the link to go to the
Remote Servers screen.
If the resource server is the same Integration
Server as the authorization server, set to local.

webMethods Integration Server Administrators Guide Version 9.10

545

Even Header
Configuring OAuth

Field

Description
If you are conguring Integration Server as the
authorization server only, Integration Server
ignores the value of this eld.
The list displays the congured remote server
aliases that are available for use. For information
about creating a remote server alias, see "Seing
Up Aliases for Remote Integration Servers" on
page 117.

5. Click Save Changes.

Defining Clients
Before a client application (client) can request access to a protected resource, you must
use the Integration Server Administrator to register the client with the authorization
server.

Registering Clients
Complete the following steps to register a client with the authorization server.
To register a client
1. Open Integration Server Administrator of the Integration Server dened as the
authorization server if it is not already open.
2. In the Security menu of the Navigational Panel, click OAuth.
3. Click Client Registration.
4. Click Register Client.
5. Under Client Configuration, complete the elds as follows:
Field

Description

Name

Species the name of the client.

The name cannot contain the following characters:
&()\;,/":'<>
Note: You cannot create clients with the same Name
and Version combination.

Version

Species the version number of the client.

webMethods Integration Server Administrators Guide Version 9.10

546

Odd Header
Configuring OAuth

Field

Description
The version cannot contain the following
characters:
&()\;,/":'<>
Note: You cannot create clients with the same Name
and Version combination.

Type

Species the type of the client according to its

ability to communicate with the authorization
server.
Specify...

When...

Confidential

The client is capable of maintaining

secure client authentications. When
you select client type as Confidential,
Integration Server generates a
client secret. This client secret will
be required by Integration Server
when the client makes requests
to the OAuth services. Specify
Confidential when the OAuth session
uses the authorization code grant
type. For more information, see
"Authorization Code Grant" on page
538.

Public

The client is not capable of

maintaining secure client
authentications. Specify Public when
the OAuth session uses the implicit
grant type. For more information,
see "Implicit Grant" on page 540.

Description

Optional. Species a description of the client.

Redirect URIs

Species the URIs that the authorization server will

use to redirect the resource owner's browser during
the grant process.
You can add more than one URI at a time by
specifying multiple lines, one URI to a line. Press
the Enter key to separate lines.

webMethods Integration Server Administrators Guide Version 9.10

547

Even Header
Configuring OAuth

6. Under Token, specify the following information:

Field

Description

Expiration Interval

Species the length of time (in seconds) that the access

token is valid.

Refresh Count

Select...

To...

Use OAuth
Global Setting

Use the seing specied in the Access

token expiration interval eld on the
OAuth screen. This seing is shown in
angle brackets. For more information
about the Access token expiration interval
eld, see "Conguring OAuth Seings"
on page 544.

Never Expires

Indicate that the access token never

expires.

Expires in

Specify a specic time interval. Enter

the number of seconds that the access
token is valid in the eld provided.
The maximum value is 2147483647.
The default is 3600.

Species the number of times the access token can be

refreshed.
Note: Tokens can only be refreshed when using the
authorization code grant ow.
Select...

To...

Unlimited

Refresh the access token an unlimited

number of times.

Limit

Specify the number of times

Integration Server can refresh the
access token.
If you specify any value greater than
0, Integration Server will issue a
refresh token to enable the access
token to be refreshed the specied
number of times. When the access

webMethods Integration Server Administrators Guide Version 9.10

548

Odd Header
Configuring OAuth

Field

Description
token expires, the client can use the
pub.oauth:refreshAccessToken service to
submit a token refresh request to the
authorization server.
If you specify 0 or leave the Limit eld
empty, Integration Server does not
issue a refresh token.
The maximum value is 2147483647.
The default is 0.

7. Click Save Changes.

Integration Server generates a client ID. If you specied Confidential in the Type eld,
Integration Server also generates a client secret. Integration Server requires the client
ID, client secret, or both when the client invokes the OAuth services.
Note:

When a condential client is registered, a corresponding Integration Server

user account is created. The user name is the client ID and the password is
the client secret. If an existing client is changed from condential to public
or vice versa, the corresponding user account is created or deleted.

Enabling and Disabling Clients

If you want to temporarily disable access to resources for all the access tokens issued
to a registered client, you can disable that client. When you disable a client, Integration
Server denies access to resources hosted on a resource server.
Complete the following steps to enable or disable a registered client.
To enable or disable a client
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigational Panel, click OAuth.
3. Click Client Registration.
4. Under the Active column of the Registered Clients list, select one of the following:
Click...

To...

No

Enable a client.

Yes

Disable a client.

5. When prompted to conrm that you want to enable or disable the registered client,
click OK.

webMethods Integration Server Administrators Guide Version 9.10

549

Even Header
Configuring OAuth

Editing Clients
Complete the following steps to edit a registered client.
To edit a client
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigational Panel, click OAuth.
3. Click Client Registration.
4. Under Registered Clients, click the Application Name or Client ID for the client that you
want to edit.
5. Update the information for the client.
Note:

You cannot edit the data displayed in the ID or Secret columns.

6. Click Save Changes.

Deleting Clients
Complete the following steps to delete a registered client.
Important: When you delete a client, Integration Server also deletes all the access and
refresh tokens for the client.
To delete a client
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigational Panel, click OAuth.
3. Click Client Registration.
4. Locate the client in the Registered Clients list, and click the
column.

icon in the Delete

5. When prompted to conrm that you want to delete the registered client, click OK.

Defining Scopes
A scope indicates the resources the client can access on behalf of a resource owner. A
scope consists of a name and one or more Integration Server folders, services, or both.
If access is granted for a scope, then access is granted for all folders and services in that
scope. You map the scope to a registered client to indicate the namespace resources the
client can access on Integration Server. For more information about mapping scopes to
clients, refer to " Associating Scopes and Clients" on page 552.
When a request is made to the authorization server, Integration Server veries that the
scope is dened for a client. The client is allowed to access only the namespace resources

webMethods Integration Server Administrators Guide Version 9.10

550

Odd Header
Configuring OAuth

that are specied for the scope. If the requested scope is not dened, Integration Server
returns an error indicating that the scope is invalid.

Adding a Scope
Complete the following steps to add a scope. The scope denes the services and folders
that the clients are authorized to access.
To add a scope
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigational Panel, click OAuth.
3. Click Scope Management.
4. Click Add Scope.
5. Under Scope Configuration, specify the following information:
Field

Description

Name

Species a unique name for the scope. The scope name

must consist of ASCII character codes in the range
of 33 - 126, and cannot contain any of the following
characters:
&()\;,/":'<>

Folders and services

Species the list of folders and individual services that

the client can access on behalf of the resource owner.
You can add more than one folder or service at a time
by specifying multiple lines, one folder or service to a
line. Press Enter to separate lines.
Note: Integration Server validates the entries. If you enter
a folder or service that does not exist, Integration
Server does not add the scope.

6. Click Save Changes.

Editing Scopes
Complete the following steps to edit a scope.
To edit a scope
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigational Panel, click OAuth.

webMethods Integration Server Administrators Guide Version 9.10

551

Even Header
Configuring OAuth

3. Click Scope Management.

4. Under Scope Configuration, click the Name for the scope that you want to edit.
5. Update the information for the scope.
Note:

You cannot change the Name eld for a scope.

6. Click Save Changes.

Deleting Scopes
Complete the following steps to delete a scope.
Note:

You cannot delete a scope that is used by a client. To see whether a scope is
in use by a client, see "Viewing Associations Between Clients and Scopes" on
page 555.

To delete a scope
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigational Panel, click OAuth.
3. Click Scope Management.
4. Locate the scope in the Defined Scopes list, and click the

icon in the Delete column.

5. When prompted to conrm that you want to delete the scope, click OK.

Associating Scopes and Clients

You manage the scope and client associations on the Associate Scopes to Clients page.
The Associate Scopes to Clients page is divided into two areas:
You can associate scopes to clients in the Scopes area (on the left). Use the Scopes
area to make associations when you want to associate multiple clients to a single
scope. This oers the advantage of adding or removing several associated clients for
the scope at one time.
You can associate clients to scopes in the Clients area (on the right). Use the Clients
area to make associations when you want to associate multiple scopes to a single
client. This oers the advantage of adding or removing several associated scopes for
the client at one time.
Note:

You must dene scopes and clients before you can associate them. For more
information about registering clients, see "Dening Clients" on page 546.
For more information about adding scopes, see "Dening Scopes" on page
550.

webMethods Integration Server Administrators Guide Version 9.10

552

Odd Header
Configuring OAuth

Adding Associations Between Clients and Scopes

Use the following procedure to add associations between scopes and clients.
To add associations between scopes and clients
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigational Panel, click OAuth.
3. Click Scope Management.
4. Click Associate Scopes to Clients.
5. For each association, do one of the following:
If you want associate
one or more...

Perform the following steps...

Clients to a
particular scope

a. Under Scopes, in the Select Scope list, select the scope

to which you want to add an association to one or more
clients.
The Scopes area of the Associate Scopes to Clients
screen (on the left) contains two lists. Clients associated
with Scope is a list of clients currently associated to the
selected scope. Remaining Clients is a list of clients not
currently in the selected scope.
b. In the Remaining Clients list, select (highlight) the client
or clients that you want to add to the scope.
To select additional clients without deselecting
currently selected clients, press the Ctrl key while you
click the clients you want to select. To deselect a client,
press Ctrl while you click the currently selected entry.
c. After you have selected all the clients you want to
add to the scope, click
.
Integration Server moves the selected clients to the
Clients associated with Scope list.

Scopes to a
particular client

a. Under Clients, in the Select Client list, select the client to

which you want to add an association to one or more
scopes.
The Clients area of the Associate Scopes to Clients screen
(on the right) contains two lists. Scopes in this Client is a
list of scopes currently associated to the selected client.
Remaining Scopes is a list of clients not currently in the
selected scope.

webMethods Integration Server Administrators Guide Version 9.10

553

Even Header
Configuring OAuth

If you want associate

one or more...

Perform the following steps...

b. In the Remaining Scopes list, select (highlight) the scope
or scopes that you want to add to the client.
To select additional scopes without deselecting
currently selected scopes, press Ctrl while you click the
scopes you want to select. To deselect a scope, press Ctrl
while you click the currently selected entry.
c. After you have selected all the scopes you want to
add to the client, click
.
Integration Server moves the selected scopes to the
Scopes in this Client list.

6. Click Save Changes.

Removing Client and Scope Associations

Use the following procedure to remove client and scope associations.
Note:

Removing associations between scopes and clients does not delete the clients
or scopes from the system, nor does it aect access tokens that have already
been issued. For more information about deleting clients, see "Deleting
Clients" on page 550. For more information about deleting scopes, see
"Deleting Scopes" on page 552.

To remove client and scope associations

1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigational Panel, click OAuth.
3. Click Scope Management.
4. Click Associate Scopes to Clients.
5. For each association, do one of the following:
If you want remove an
association of one or
more...

Perform the following steps...

Clients from a
particular scope

a. Under Scopes, in the Select Scope list, select the scope

for which you want to remove an association from one
or more clients.
b. In the Clients associated with Scope list, select (highlight)
the client or clients that you want to remove from the
scope.

webMethods Integration Server Administrators Guide Version 9.10

554

Odd Header
Configuring OAuth

If you want remove an

association of one or
more...

Perform the following steps...

To select additional clients without deselecting

currently selected clients, press Ctrl while you click the
clients you want to select. To deselect a client, press Ctrl
while you click the currently selected entry.
c. After you have selected all the clients
you want to remove from the scope, click
. Integration Server
moves the selected clients to the Remaining Clients list.
Scopes from a
particular client

a. Under Clients, in the Select Client list, select the client for
which you want to remove an association from one or
more scopes.
b. In the Scopes in this Client list, select (highlight) the scope
or scopes that you want to remove from the client.
To select additional scopes without deselecting
currently selected scopes, press Ctrl while you click the
scopes you want to select. To deselect a scope, press Ctrl
while you click the currently selected entry.
c. After you have selected all the scopes
you want to remove from the client, click
. Integration Server
moves the selected scopes to the Remaining Scopes list.

6. Click Save Changes.

Viewing Associations Between Clients and Scopes

Use the following procedure to view associations between scopes and clients.
To view the associations between clients and scopes
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigational Panel, click OAuth.
3. Click Scope Management.
4. Click Associate Scopes to Clients.
5. Do one of the following:

webMethods Integration Server Administrators Guide Version 9.10

555

Even Header
Configuring OAuth

If you want view the...

Perform the following steps...

Clients associated
with a particular
scope

Under Scopes, in the Select Scope list, select the scope for
which you want to view associated clients.

Scopes associated
with a particular
client

Under Clients, in the Select Client list, select the client for
which you want to view associated scopes.

Viewing and Deleting Tokens

Use the Tokens screen to view and remove the active tokens issued by the authorization
server. Client applications use these tokens to access the resources on Integration Server
(the resource server). When you delete the tokens, the client application can no longer
access the resources owned by the resource owners.

Viewing Tokens
Use the following procedure to view the active tokens issued by the authorization
server.
To view tokens
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigational Panel, click OAuth.
3. Click Tokens. Under Tokens, the Integration Server Administrator lists the active and
expired access tokens issued by Integration Server.

Deleting Tokens
You can use the Tokens screen to delete all active tokens. When you delete the token
from the list of active tokens, Integration Server deletes both the access token and the
refresh token. Keep the following points in mind when deleting tokens:
After you delete a token, other resource owners using the same client application can
continue to do so. To keep a particular client application from accessing resources,
you can disable or delete the client application. For more information about deleting
client applications, see "Deleting Clients" on page 550.
Once a token is deleted, Integration Server rejects any requests from clients using
that access or refresh token.
To delete tokens
1. Open the Integration Server Administrator if it is not already open.

webMethods Integration Server Administrators Guide Version 9.10

556

Odd Header
Configuring OAuth

2. In the Security menu of the Navigational Panel, click OAuth.

3. Click Tokens.
4. Locate the token in the Tokens list and click the

icon in the Delete column.

5. When prompted to conrm that you want to delete the token, click OK.

Customizing the Approval Page

The approval page is an HTML page the authorization server sends to the resource
owner after a client submits a request for access to their private resources. The resource
owner uses the page to accept or deny the request.
OAuth approval default page

You can customize the title, logo, heading, and footer of the approval page using
the wa.server.oauth.approvalpage properties. For information about using these
properties, see "Server Conguration Parameters" on page 851.

About Using Integration Server as the Resource Server

When a client has requested access to a protected resource and has received an access
token, the client can then present the access token to the resource server. If Integration
webMethods Integration Server Administrators Guide Version 9.10

557

Even Header
Configuring OAuth

Server is the resource server, clients can present the access token using the authorization
request header eld. Clients can send the access token in the Authorization request
header eld using the Bearer authentication scheme to submit the access token. For
example:
GET /invoke/folder/svc HTTP/1.1
Host: your-company.com:5555
Authorization: Bearer access_token_id

If you are using the pub.client:http service, you can send the token using the auth header
eld. For information about using this service, see webMethods Integration Server Built-In
Services Reference.
For more information about the Bearer authentication scheme, refer to the OAuth 2.0
Authorization Framework Bearer Token Usage specication.

webMethods Integration Server Administrators Guide Version 9.10

558

Odd Header
Configuring a Central User Directory or LDAP

26 Configuring a Central User Directory or LDAP

Before You Begin .......................................................................................................................

560

Overview of How Integration Server Works with Externally Defined Users and Groups ............ 560
Configuring Central User Management .....................................................................................

562

Overview of Using LDAP ...........................................................................................................

564

Configuring the Server to Use LDAP .........................................................................................

565

Considerations for User Accounts and Groups .........................................................................

572

About Granting Administrator Privileges to External Users .......................................................

573

Granting Developer Privileges to External Users ......................................................................

575

Granting Access to Services and Files to External Users .........................................................

576

webMethods Integration Server Administrators Guide Version 9.10

559

Even Header
Configuring a Central User Directory or LDAP

Before You Begin

This chapter describes how Integration Server uses an external directory to authenticate
clients, rather than using internally-dened user and group information. For
information about using internally-dened users and groups, refer to "Managing Users
and Groups" on page 89. You can set up Integration Server to access information from an
external directory if your site uses one of the following external directories for user and
group information:
Central user management
Lightweight Directory Access Protocol (LDAP)
You can congure Integration Server for central user management by connecting
Integration Server to a My webMethods Server user database. You can also congure
LDAP directories and other type of directories to be used with central user management.
However, you can only use one external directory at a time, a central user directory or
LDAP.
Important: If you are using My webMethods Server in your environment, Software AG
recommends that you congure Integration Server to work with a central
user management directory. If you want to use an LDAP server and you
are using My webMethods Server, it is recommended that you congure
LDAP using My webMethods Server. Congure Integration Server to work
with the LDAP server directly only when you are not using My webMethods
Server.
Before you continue reading this chapter, you may nd it helpful to rst understand
how Integration Server uses user and group information. Read the following sections if
you have not already done so.
"Managing Users and Groups" on page 89
"Adding an Administrator User" on page 94
"Adding a Developer User" on page 95
"Controlling Access to Resources with ACLs" on page 435
"Basic Authentication" on page 448

Overview of How Integration Server Works with Externally

Defined Users and Groups
The following sections provide information about how and when Integration Server
interacts with users and groups dened in a central user directory or in LDAP,
specically:

webMethods Integration Server Administrators Guide Version 9.10

560

Odd Header
Configuring a Central User Directory or LDAP

How externally dened users and groups can be used in Integration Server.
When Integration Server accesses information about externally dened users and
groups.
How Integration Server authenticates users who belong to externally dened groups
or roles.

How the Server Uses Externally Defined Users and Groups

The server can use externally dened information for the same purposes it uses
internally-dened user and group information:
To authenticate clients using user names and passwords
To control who can congure and manage Integration Server
To control who can create, modify, and delete services using Software AG Designer
To control access to services and les that are available in Integration Server
Externally dened information does not replace ACLs. To control access to services and
les, you still need to set up the ACLs that identify the groups that are allowed and
denied access to specic services and les. However, you can assign externally dened
groups to an ACL.
When you congure the server to use central user management or LDAP directory,
externally dened users and groups are not displayed on the Security > User Management
page. However, if an external group has been mapped to an Integration Server ACL, the
group will be displayed on the Security > Access Control Lists page.
Note:

If the name of an externally dened user group contains an apostrophe (),

Integration Server will not display the group on the Security > Access Control
Lists page.

When the Server Accesses Externally Defined Information

Integration Server obtains externally dened information in the following circumstances:
To authenticate clients
To determine if an ACL allows or denies an action
Note:

Client requests that require Integration Serverto access a central user directory
or an LDAP directory may take longer to complete than those that do not.

How Integration Server Authenticates Externally Defined Clients

When Integration Server authenticates a client using user names and passwords,
Integration Server rst aempts to nd the user name and password internally. If

webMethods Integration Server Administrators Guide Version 9.10

561

Even Header
Configuring a Central User Directory or LDAP

Integration Server nds an internally-dened user account for the supplied user name,
Integration Serverauthenticates the client using the internally-dened information. If
the supplied password is correct, Integration Server proceeds with the request. If the
supplied password is not correct, Integration Server rejects the request.
If Integration Server cannot nd an internally-dened user account for the supplied user
name, Integration Server accesses the external directory (either a central user directory
or LDAP) to obtain user name and password information for the client. If Integration
Server nds an externally dened user account, Integration Serverauthenticates the
client using the externally dened information. For example, if a user account is dened
in the My webMethods Server user directory, Integration Server authenticates the client
using the information dened in the My webMethods Server database. If the supplied
password is correct, the server proceeds with the request. If the supplied password is
not correct, the server rejects the request.
Note:

If the passwords are contained in an external authentication system other

than Central Users or LDAP, for example Kerberos, you must create your
own pluggable module to obtain this information. See "Customizing
Authentication Using JAAS" on page 461 for information about seing up a
pluggable module.

If the server cannot nd either an internally or externally dened user account for the
user, the server rejects the request.
If the user does not supply a user name or password, the server uses the internallydened Default user account.
Note:

A user can be dened locally for a specic instance of Integration Serverand

in an external directory service available to the Integration Server instance.
When a user who is dened in both places logs into the Integration Server
Administrator, Integration Server authenticates the user with the privileges
dened locally. If the user was dened with dierent privileges in the external
directory service, those privileges are ignored. This occurs because Integration
Server checks its local user list rst. If the suppled user name exists and the
password is correct, Integration Server does not check the external directory
for the user account.If a user is dened locally and in an external directory
service, make sure that the user has the same privileges locally and externally.

Configuring Central User Management

Central user management involves using a single location to store and manage
information about users of webMethods products. You can use Integration Server
Administrator to grant users in a central directory access to Integration Server
functionality and services. For example, you can assign a My webMethods Server role or
group to an ACL.
If a user will access Integration Server or Trading Networks through My webMethods
interfaces, create the users in My webMethods Server and then use Integration Server

webMethods Integration Server Administrators Guide Version 9.10

562

Odd Header
Configuring a Central User Directory or LDAP

Administrator to give them access to the necessary areas. If such users are already
dened in an external directory such as LDAP, you can congure My webMethods
Server to work with the external directory. When congured this way, authentication
and authorization requests are still made by the Integration Server; however, the server
creates the connection to the external directory using the directory seings dened by
the My webMethods Server database.
Users dened in a central location, such as the My webMethods Server user directory,
are sometimes referred to as central users.

Requirements for Central User Management

For Integration Server to use central user management, the following are required:
My webMethods Server must be installed and congured to use an external
database. Additionally, My webMethods Server must have been started at least once
to enable My webMethods Server clustering.
Integration Server must have a JDBC connection pool that points to the My
webMethods Server database component, and the CentralUsers function in
Integration Server must point to that connection pool.
If you installed My webMethods Server in the same installation directory as Integration
Server, the Software AG Installer created the connection pool from the My webMethods
Server database parameters you supplied and pointed the CentralUsers function at that
pool. The connection pool is named CentralUsersPool. If you installed My webMethods
Server in a dierent installation directory from Integration Server, however, you
must create the connection pool and point the CentralUsers function at that pool. For
instructions, see Installing Software AG Products.
If you later want to stop using central user management, follow the same instructions in
Installing Software AG Products, but in the Associated Pool Alias list, click None, and then
restart Integration Server.
Note:

Integration Server updates the Anonymous ACL automatically to include the

My webMethods Users Role from My webMethods Server.

Considerations for My webMethods Server Query Roles

Integration Server can slow or terminate unexpectedly when handling service
invocations if Integration Server has to evaluate all roles dened in My webMethods
Server, including LDAP query and database query roles. You might encounter this issue
when invoking Integration Server services using WS Client Connectors from a CAF
application, especially if the following conditions are true:
When there are LDAP query and database query roles dened in My webMethods
Server.
Common Users is enabled in Integration Server.

webMethods Integration Server Administrators Guide Version 9.10

563

Even Header
Configuring a Central User Directory or LDAP

The services have ACLs assigned to them.

Evaluation of these roles depend on external query execution and might impact
Integration Server performance.
You can control whether Integration Server evaluates LDAP or database query roles in
the server using the wa.cds.skip.role.types extended seing. If LDAP or database query
roles are not used for any ACL management in Integration Server with Common Users
enabled, you might consider disabling the query roles evaluation function.
For more information about using the wa.cds.skip.role.types extended seing, see
"Server Conguration Parameters" on page 851.

Overview of Using LDAP

If your site uses Lightweight Directory Access Protocol (LDAP) for user and group
information, you can congure the Integration Server to obtain user and group
information from the external directory. You can congure Integration Server to use
more than one LDAP directory at a time, allowing Integration Server to work with
dierent LDAP directories for users in dierent locations or dierent organizations. In
addition, you can maintain multiple LDAP directories so that one directory serves as a
backup for another.
Important: If you want to use an LDAP server to store user information and you are
using My webMethods Server, it is recommended that you congure LDAP
using My webMethods Server. Congure Integration Server to work with
LDAP server directly only when you are not using My webMethods Server.
LDAP protocols are designed to facilitate sharing information about resources on a
network. Typically, they are used to store prole information (login ID, password, etc.).
You can also use them to store additional information. Integration Server uses LDAP for
performing external authentication.
Using your existing LDAP information allows you to take advantage of a central
repository of user and group information. System administrators can add and remove
users from the central location. Users do not need to remember a separate password for
webMethods applications; they can use the same user names and passwords that they
use for other applications. Remember to use your LDAP tools to administer users or
groups stored in an external directory.

About LDAP and Caching

For LDAP, after accessing user information, the Integration Server caches it to improve
performance. If the information remains in the cache for one hour without being
accessed, or if the cache space is needed for a more recent request, the Integration Server
deletes the information from the cache.

webMethods Integration Server Administrators Guide Version 9.10

564

Odd Header
Configuring a Central User Directory or LDAP

If the server receives subsequent requests that require the information it has in cache,
the Integration Server uses the cached information rather than accessing the external
directory.

Configuring the Server to Use LDAP

To congure the server to use LDAP, you need to:
Instruct Integration Server to use the LDAP protocol
Dene one or more congured LDAP servers that the Integration Server is to use for
these users
If an LDAP provider is SSL-enabled, you can set the wa.server.ssl.trustStoreAlias
property to point to the trusstore alias that contains the certicates required to
establish a secure connection with the LDAP sever.
Software AG recommends that you use central user management instead of conguring
Integration Server to use one more LDAP directories for external user management.
For more information about central user management, see"Conguring Central User
Management" on page 562 and Administering My webMethods Server.
To specify LDAP as the external provider
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
3. Click LDAP Configuration.
4. Click Edit LDAP Configuration.
5. Next to Provider, select LDAP.
Integration Server issues a prompt to verify that you want to change the seing.
Click OK. If your Integration Server is congured to central user management, you
must disable it before you can congure LDAP. For information about disabling
central user management, see "Conguring Central User Management" on page
562.
6. Enter the following information:
For this field...

Specify...

Cache Size (Number of

Users)

The maximum number of LDAP users Integration

Server can keep in memory in the user cache. The
default is 10.
Once the limit is reached, Integration Server selects
users for removal from the cache based on how long

webMethods Integration Server Administrators Guide Version 9.10

565

Even Header
Configuring a Central User Directory or LDAP

For this field...

Specify...
they have been idle. As a result, activity can extend the
time a user remains in the cache.
As a general rule, specify a cache size equivalent to
5-10% of the number of users in your LDAP system.
However, if only a few sessions are ever logged on
simultaneously, set the cache size to be the same as the
number of simultaneous sessions.

Credential Time-to-Live
(Minutes)

The number of minutes an LDAP user's credentials

(userid and password) can remain in the credential
cache before being purged. The default is 60 minutes.
When a user rst aempts to log in, Integration
Server creates a user object and checks the user's
credentials against the LDAP directory. Integration
Server stores the credentials so that subsequent
requests to authenticate will be made against the
cached credentials, not the LDAP directory.
For security reasons, you can control the length of
time these cached credentials are valid. The credentials
are secure because they are stored using a one-way
hashing function, and cannot be recovered from the
cache. If a user aempts to log in with credentials that
do not match the cached version, Integration Server
ushes the cache and checks the credentials against
the LDAP directory. If the credentials are valid, the
Integration Server caches them; otherwise, the cache
remains empty.
For normal secure environments, a time-to-live value
between one hour and one day is adequate. For higher
security environments, a time-to-live of between one
and ve minutes may be more appropriate.
The Time-to-Live is absolute; therefore, activity will
not cause the credentials to remain in cache longer.

7. Click Save Configuration.

To nish conguring Integration Server to use an LDAP directory, continue to the
procedure "Dening an LDAP Directory to Integration Server " on page 567.

webMethods Integration Server Administrators Guide Version 9.10

566

Odd Header
Configuring a Central User Directory or LDAP

Defining an LDAP Directory to Integration Server

To define an LDAP directory to Integration Server
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
3. Click LDAP Configuration.
4. Click Add LDAP Directory.
5. On the Settings > LDAP Directory > Add screen, enter the following information:
For this parameter

Specify...

Directory URL

The complete URL of the LDAP server. The URL has

the format protocol ://hostname :portnumber where
The protocol is LDAP for standard connections or
LDAPS for secure connections.
The host is the host name or IP address of the LDAP
server. The port is the port on which the server is
running. The port is optional. If omied, the port
defaults to 389 for LDAP, or 636 for LDAPS.
For example, specifying the URL ldaps://
ldapserv1:700 would create a secure connection to
the LDAP server running on the non-standard port 700
on the host called ldapserv1.
If you specify ldaps, Integration Server aempts to
make a secure connection to the directory server using
an SSL socket. If the directory server is congured
to use SSL, it will have a server certicate in place
to identify itself to clients. This certicate must be
signed by an authority to prove its validity (i.e. the
server certicate is signed by a CA). By default, the
Integration Server will only trust certicates signed
by a signing authority whose CA certicate is in the
Integration Server's trusted CAs directory. Refer to
"Securing Communications with the Server" on page
401 for instructions on conguring the trusted CAs
directory and nding the CA certicate.

Principal

The user ID the Integration Server should supply to

connect to the LDAP server, for example, o=webm.com
or dc=webm,dc=com.

webMethods Integration Server Administrators Guide Version 9.10

567

Even Header
Configuring a Central User Directory or LDAP

For this parameter

Specify...
This user should not be the Administrator account, but
a user that has permission to query groups and group
membership. If your LDAP server allows anonymous
access, leave this eld blank.

Credentials

The password the Integration Server should supply

to connect to the LDAP server, that is, the Principal's
password. The Integration Server encrypts this
password according to the seings specied on the
Outbound Passwords screen. For more information, see
"Securing Communications with the Server" on page
401.

Connection Timeout
(seconds)

The number of seconds the Integration Server will wait

while trying to connect to the LDAP server. After this
time has passed, the Integration Server will try the
next congured LDAP server on the list. The default
is 5 seconds. Increase this number if your network
has latency problems. If most requests will be from
batch processes, you can increase this number to be 30
seconds or more.

Minimum Connection
Pool Size

The minimum number of connections allowed in

the pool that the Integration Server maintains for
connecting to the LDAP server. When the Integration
Server starts, the connection pool initially contains
this minimum number of connections. The Integration
Server adds connections to the pool as needed until it
reaches the maximum allowed, which is specied in
the Maximum Connection Pool eld. The default is 0.

Maximum Connection
Pool Size

The maximum number of connections allowed in

the pool that the Integration Server maintains for
connecting to the LDAP server. When the Integration
Server starts, the connection pool initially contains a
minimum number of connections, which are specied
in the Minimum Connection Pool eld. The Integration
Server adds connections to the pool as needed until it
reaches the maximum allowed. The default is 10.

Synthesize DN

Builds a distinguished name by adding a prex and

sux to the user name.
The Synthesize DN method can be faster than the
Query DN method (see below) because it does

webMethods Integration Server Administrators Guide Version 9.10

568

Odd Header
Configuring a Central User Directory or LDAP

For this parameter

Specify...
not perform a query against the LDAP directory.
However, if your LDAP system does not contain all
users in a single at structure, use the Query DN
method instead.
DN Prefix
A string that species the beginning of a DN you want
to pass to the LDAP server.
DN Suffix
A string that species the end of a DN you want to
pass to the LDAP server.
For example, if the prex is "cn=" and the sux is
",ou=Users" and a user logs in specifying "bob", the
Integration Server builds the DN cn=bob,ou=Users
and sends it to the LDAP server for authentication.
Note: Be sure to specify all the characters required
to form a proper DN. For instance, if you omit
the comma from the sux above, that is, you
specify "ou=Users" instead of ",ou=Users", the
Integration Server will build the invalid DN
(cn=bobou=Users).

Query DN

Builds a query that searches a specied root directory

for the user.
Use this method instead of the Synthesize DN method
(see above) if your LDAP directory has a complex
structure.
UID Property
A property that identies an LDAP userid, such as
"cn" or "uid".
User Root DN
Enter the full distinguished name. For example, if
you specify ou=users,dc=webMethods,dc=com,
the Integration Server will issue a query that starts
searching in the root directory ou=users for a
common name that matches the name the user logged
in with.

Default Group

An Integration Server group with which the user is

associated. The user is allowed to access services that
members of this Integration Server group can access.

webMethods Integration Server Administrators Guide Version 9.10

569

Even Header
Configuring a Central User Directory or LDAP

For this parameter

Specify...
This access is controlled by the ACLs with which the
group is associated.
If you also specify a value in the Group Member Attribute
eld, the user has the same access as members of
the Integration Server group and members of LDAP
groups that have been mapped to an Integration
Server ACL.
Do not specify Anonymous as the default
Important:
group if any user in this group needs to have
administrator privileges. The default ACL denies
the Anonymous group and will not allow access
the root page. Choose the appropriate group in
the Default Group eld to ensure that the required
ACLs get assigned to your group.
You must specify a value in the Group Member
Important:
Attribute eld, the Default Group eld, or both.

Group Member Attribute

The name of the aribute in a group's directory entry

that identies each member of the group. This value
is usually "member" or "uniqueMember", but can vary
depending on the schema of the LDAP directory.
Integration Server uses this information during ACL
checking to see if the user aempting to log in belongs
to an LDAP group that has been mapped to an ACL.
If no value is specied here, Integration Server does
not check for membership in an LDAP group. As a
result, the user's ability to access Integration Server
services is controlled by the Integration Server group
specied in the Default Group eld.
Note: You must specify a value in the Group Member
Attribute eld, the Default Group eld, or both.

Group ID Property

A property that identies an LDAP group, such as CN.

Group Root DN

The full distinguished name.

For example, if you specify

ou=groups,webMethods,dc=com,Integration Server

will issue a query that will display all the LDAP

groups.

webMethods Integration Server Administrators Guide Version 9.10

570

Odd Header
Configuring a Central User Directory or LDAP

For this parameter

Specify...
Note: You must specify values in the Group ID Property
and Group Root DN elds.

6. Click Save Changes.

The LDAP Directory List displays the added the LDAP directory.
7. Click Move Up/Move Down to order the directories in the list based on their priority.
Note:

If you dene multiple LDAP servers, Integration Server will search the
LDAP directories in the order in which they are displayed on the Security >
User Management > LDAP Configuration screen. If Integration Server does not
nd the user in the rst LDAP directory, it will search in order through the
list.

Mapping an LDAP User's Access to ACLs

As with Integration Server groups, you can associate LDAP groups with ACLs to control
access to Integration Server resources. Associating an LDAP group with an ACL is
referred to as mapping. ACL mapping to LDAP groups can be done directly through the
Security > ACLs page. For more information about allowing groups access to ACLs, refer
to "Allowing or Denying Group Access to ACLs" on page 441.

Stopping Use of an LDAP as an External Directory

If you no longer want to use LDAP as an external directory, you can update the
conguration to remove the external directory conguration seings.
To stop using a LDAP as an external directory
1. Open the Integration Server Administrator if it is not already open.
2. In the Security menu of the Navigation panel, click User Management.
3. Click Edit LDAP Configuration.
4. Click Local in the Provider eld.
5. Click Save Configuration.
6. Click OK.
7. Restart your Integration Server.

webMethods Integration Server Administrators Guide Version 9.10

571

Even Header
Configuring a Central User Directory or LDAP

Considerations for User Accounts and Groups

This section provides information about user accounts and groups that you should
consider if you are using an external directory for user and group information.
You should keep internal and external user accounts and group names unique.It might
get confusing if you have an external user account that has the same user name
as an internal user account or an external group with the same group name as an
internal group. For more information, see "About Keeping Internal and External
User Accounts and Group Names Unique" on page 572.
You cannot use the Integration Server Administrator to manage (i.e., create, edit, or delete)
Central Users.You must use My webMethods Server to administer Central Users and
Directories. Refer to Administering My webMethods Server for more information.
You cannot use the Integration Server Administrator to manage (i.e., create, edit, or delete)
LDAP user and group information. To make changes to LDAP directories, follow your
site's standard directory update procedures.
You can perform package replication without using the predefined Replicator account.You can
use a dierent account for package replication as long as the subscription requester
species an account that is a member of a group that is assigned to the Replicators
ACL. For more information, see "About User Groups and Package Replication" on
page 573.

About Keeping Internal and External User Accounts and Group

Names Unique
Software AG recommends that you keep user names and group names unique between
internal and external user accounts and groups. Having an external user account that
has the same user name as an internal user account, or an external group with the same
group name as an internal group might get confusing. If you do have identically named
user names or group names, the server always uses the internally-dened information.
To avoid confusion, Software AG recommends that you do not set up user accounts
or groups internally if you are using an external directory. The exceptions are
the predened user accounts Default, Administrator, Developer, Replicator, and
the predened groups Everybody, Administrators, Developers, Replicators, and
Anonymous. You cannot delete these user accounts and groups; therefore, make sure the
internal accounts and groups have the correct denitions.

webMethods Integration Server Administrators Guide Version 9.10

572

Odd Header
Configuring a Central User Directory or LDAP

An exception to the above diagram is that all internally-dened users are members of
the internally-dened Everybody group.

About User Groups and Package Replication

Although Integration Server is distributed with a predened Replicator account, you
can use a dierent account for package replication. As long as the subscription requester
species an account that is a member of a group that is assigned to the Replicators ACL,
that user can perform replication.
When publishing a package to another server, the publishing server uses the account
specied by the subscription requester. For example, if the subscription requester (either
the publisher or the subscriber) specied account DEPT01, the publisher will log into the
subscriber server as DEPT01. DEPT01 must be a member of a group that is assigned to
the Replicators ACL on the subscriber server.
Refer to "Copying Packages from One Server to Another" on page 600 for more
information about package replication.

About Granting Administrator Privileges to External Users

The Administrators ACL controls who has administrator privileges. Because you
cannot assign externally dened users to internally-dened groups, you cannot grant
externally dened users administrator privileges by assigning them to the internallydened Administrators group. Instead, you need to set up an externally dened group
for administrators. Then, add the externally dened group of administrators to the
Administrators ACL.
To make a group of central users IS Administrators, you will need to add their group or
role to the following ACLs:
Administrators ACL
Default ACL
Developers ACL
Internal ACL

webMethods Integration Server Administrators Guide Version 9.10

573

Even Header
Configuring a Central User Directory or LDAP

Replicators ACL
Anonymous ACL (if their role/group is not part of this already)
Note:

If you congured Integration Server to use central user management, the

Anonymous ACL automatically includes the My webMethods users role.

Granting Administrator Privileges to an Externally Defined User

To grant administrator privileges to an externally defined user
1. Set up an externally dened user account for the user if one does not already exist.
2. Set up an externally dened administrators group if one does not already exist.
Important: Do not name the externally dened group "Administrators". The name of
the group must not be the same name as any internally-dened group.
3. Make the externally dened user a member of the externally dened administrators
group (ISAdmins in the picture above).
4. Update the Administrators ACL to include the externally dened administrators
group in the Allowed list.
Refer to "Allowing or Denying Group Access to ACLs" on page 441 for information
on how to include externally dened administrators to the Allowed list.

webMethods Integration Server Administrators Guide Version 9.10

574

Odd Header
Configuring a Central User Directory or LDAP

Granting Developer Privileges to External Users

The Developers ACL controls who can connect to the Integration Server from
Software AG Designer to create, modify, and delete services that reside on the server.
Because you cannot assign externally dened users to internally-dened groups, you
cannot grant externally dened users developer privileges by assigning them to the
internally-dened Developers group. Instead, you need to set up an externally dened
group for Designer. Then, add the externally dened group to the Developers ACL.

To grant developer privileges to an externally defined user

1. Set up an externally dened user account for the user if one does not already exist.
2. Set up an externally dened developers group if one does not already exist.
Important: Do not name the externally dened group "Developers". The name of the
group must not be the same name as any internally-dened group.
3. Make the externally dened user a member of the externally dened developers
group (ISDevs in the picture above).
4. Update the Developers ACL to include the externally dened developers group in
the Allowed list.
Refer to "Allowing or Denying Group Access to ACLs" on page 441 for information
on how to include externally dened developers to the Allowed list.

webMethods Integration Server Administrators Guide Version 9.10

575

Even Header
Configuring a Central User Directory or LDAP

Granting Access to Services and Files to External Users

You create ACLs that control access to services and les and assign them to the specic
services and les that you want to protect.
To grant access to a service or le, the server rst uses internally-dened information
to determine whether the client is a member of allowed or denied groups listed in the
ACL. If the server cannot nd the information internally, it obtains externally dened
information to determine if the ACL allows or denies access.
If you want to allow an externally dened user access to a service or le, update the ACL
that protects the service or le to identify the external user's group or role as an Allowed
group in the ACL. Similarly, if you want to explicitly deny an externally dened user
access to a service or le, update the ACL that protects the service or le to identify the
external user's group or role as a Denied group in the ACL.

webMethods Integration Server Administrators Guide Version 9.10

576

Odd Header
Configuring a Central User Directory or LDAP

webMethods Integration Server Administrators Guide Version 9.10

577

Even Header

webMethods Integration Server Administrators Guide Version 9.10

578

Odd Header
Managing Packages

27 Managing Packages
Using Packages .........................................................................................................................

580

How the Server Stores Package Information ............................................................................

585

Finding Information about Your Packages .................................................................................

587

Working with Packages ..............................................................................................................

595

Copying Packages from One Server to Another .......................................................................

600

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

626

Hot Deployment of Packages ....................................................................................................

627

webMethods Integration Server Administrators Guide Version 9.10

579

Even Header
Managing Packages

Using Packages
A package contains a set of services and related les, such as specications, document
types, and DSPs. When you add a service, specication, document type, or DSP to the
webMethods Integration Server, you must add it to a package. Use a package to group
services and related les.
By placing related les in a package, you can easily manage all the services and les
in the package as a unit. For example, you can make them all available, disable them,
refresh them, or delete them with one action. Additionally, if you have more than one
Integration Server installed, you can use package management features to copy some or
all services and les in a package to another server.
You can group your services using any package structure you choose, though most
organizations group services into packages by function or application. For example, you
might put all purchasing-related services in a package called PurchaseOrderMgt and
all time-reporting services into TimeCards.
Important: Every service on the server must belong to a package. Before you can make
a service available for execution, you must load the package to which it
belongs.
Access to a package and its contents is controlled through Access Control Lists (ACLs).
Using ACLs, you control who can display a package from the Integration Server
Administrator and Designer, who can edit the contents of a package, and who can
execute services contained in the package. For more information about protecting
packages, see "Controlling Access to Resources with ACLs" on page 435.
You can associate a package with a specic port so that when you replicate the package,
it continues to use a port with the same number on the new server. See "About Ports" on
page 156 for more information about associating a package with a port.

Predefined Packages
The following packages are predened and installed by default on each Integration
Server instance. They are also included in the package repository.
Package

Description

Default

Integration Server looks in this package if a user accesses the

server without specifying a package name (for example, by
using the URL hp://localhost:5555). You can also use it to
store elements you create without rst creating a package.
Note: Integration Server searches the pub directory in the
Default package for an index.dsp or index.html le. As
shipped, the pub directory contains an index.html le

webMethods Integration Server Administrators Guide Version 9.10

580

Odd Header
Managing Packages

Package

Description
that points the user to an index.dsp le in the WmRoot
package. This index.dsp le loads the Integration Server
Administrator. To prevent a user from inadvertently
accessing the Integration Server Administrator, you
can edit the index.html le in Default/pub and change
it to point to an innocuous page. To prevent a user
from seeing or accessing all DSP les on Integration
Server, you can use the wa.server.displayDirectories
server conguration parameter. See "Stage 7: Seing Up
Security" on page 847 for more information.

WmPublic

This package contains services that you can call from

your client applications and services. See the webMethods
Integration Server Built-In Services Reference for more
information.

WmRoot

This package provides core Integration Server functionality

and auxiliary les.
Do not alter or delete this package.
Important:

WmTomcat

Deprecated - The WmTomcat package is deprecated as of

Integration Server 9.10. Existing web applications based on
the WmTomcat package can be migrated to webMethods
Application Platform.
This package contains the Tomcat servlet container and
JSP Engine developed by the Apache Software Foundation
(hp://www.apache.org/). Using this engine, developers
can deploy and execute JavaServer Pages, Java servlets,
and their supporting les within the Integration Server
environment or incorporate web applications into new or
existing webMethods packages.
Note: The WmTomcat package is installed by default, but is
no longer enabled by default. The WmTomcat must be
disabled if you want to use webMethods Application
Platform with this Integration Server.

WmART

This package supports webMethods 6 or later adapters.

Although the WmArt package is installed by default, if
Important:
you are not fully licensed to use this package, it will be
hidden from view, and you will not be able to build or
run custom adapters, or use any transaction services.

webMethods Integration Server Administrators Guide Version 9.10

581

Even Header
Managing Packages

Package

Description

WmVCS

Deprecated - The WmTomcat package is deprecated as of

Integration Server 9.9. Use the local service development
feature (Local Version Control Integration) to check package
elements and their supporting les into and out of a version
control system (VCS) directly from Designer.
This package contains services that enable you to use the
VCS Integration feature to store Integration Server elements
in a version control system (VCS). See the Conguring the
VCS Integration Feature for information about conguring
the VCS Integration feature. For information about using
Designer with a source control system, see webMethods Service
Development Help.

WmXSLT

This package contains services that you use to transform

XML data from one format or structure to another. See the
webMethods Integration Server Built-In Services Reference and
webMethods Service Development Help for more information.

The packages in the table below provide services that enable you or other webMethods
products to perform certain tasks.
This package...

Contains services that...

For more information...

WmARTExtDC
WmISExtDC
WmTNExtDC

Infrastructure Data Collector

uses to discover and monitor
adapters installed on Integration
Server, Integration Server itself,
and Trading Networks Server,
respectively.

Administering
webMethods Optimize

WmAssetPublisher

Integration Server uses to extract

and publish metadata about its
services to CentraSite Metadata.

webMethods BPM
and CAF Workspace
Metadata Help

WmCloud

Integration Server uses to share

services with webMethods
Integration Cloud.

Conguring
On-Premise
Integration Servers
for webMethods
Cloud

WmDesigner

Support business processes

modeled in Software AG Designer.

Software AG
Designer Online Help

webMethods Integration Server Administrators Guide Version 9.10

582

Odd Header
Managing Packages

This package...

Contains services that...

For more information...

WmFlatFile

Flow services or the File Polling

processing service can call to
initially accept and consume
inbound at les.

webMethods
Integration Server
Built-In Services
Reference

WmMobileSupport

Contains services that support data

synchronization solutions between
mobile devices and backend
applications.

Developing Data
Synchronization
Solutions with
webMethods Mobile
Support

WmOptimize

Support business processes

monitored using webMethods
Optimize.

Optimize
documentation

WmPRT

Support business processes

executed using the webMethods
Process Engine.

Administering
webMethods Process
Engine

WmTaskClient

Support tasks developed using the

webMethods Task Engine.

webMethods Task
Engine Users Guide

WmWin32

You can use for Integrated

Windows authentication on
Integration Server.

"Using NTLM
Authentication
and Integrated
Windows
Authentication with
Integration Server "
on page 981

This package is deprecated in

Note:
Integration Server 7.1

If you want to streamline Integration Server (for example, because you are using it only
to host adapters), you can disable many of the packages described in above.
Important: Do not disable, delete, or alter the following packages: Default, WmPublic,
WmRoot.
You can disable the following packages:
Package
WmART

Restriction
Do not disable this package unless you are also going
Important:
to disable WmARTExtDC, or WmARTExtDC will not
load.

webMethods Integration Server Administrators Guide Version 9.10

583

Even Header
Managing Packages

Package

Restriction

WmAssetPublisher

None.

WmARTExtDC
WmISExtDC
WmTNExtDC

Do not disable the WmISExtDC package unless

Important:
you are also going to disable WmTNExtDC and
WmARTExtDC, or those packages will not load.

WmFlatFile

None.

WmPRT
WmDesigner
WmTaskClient

None.

WmMobileSupport

Before disabling the WmMobileSupport package, suspend all

mobile sync components that are enabled.

WmOptimize

None.

WmTomcat

None.

WmVCS

None.

WmXSLT

None.

For instructions on disabling a package, see "Disabling a Package" on page 598.

The Package Repository

The Software AG_directory\IntegrationServer\packages directory serves as a repository
for packages that you can install on any Integration Server instance. The repository
includes predened packages and many other packages that you can use to perform
certain tasks. For information about how to install or update packages from the package
repository, see "Installing and Updating Packages on a Server Instance" on page 78.

Sample Package
The WmSamples package contains sample services. You can nd the WmSamples
package in the certied samples area of the Knowledge Base on the Empower Product
Support Website.

webMethods Integration Server Administrators Guide Version 9.10

584

Odd Header
Managing Packages

How the Server Stores Package Information

The server physically stores package information in the
Integration Server_directory\instances\instance_name \packages directory. The server
creates a new subdirectory for each package. The name of the subdirectory is the name
of the package. For example, if a package is named TimeCards, the server creates the
Integration Server_directory\instances\instance_name \packages\TimeCards directory to
hold the les for the package.
When you create a new package, the server creates the following subdirectories to hold
all the les associated with the package:

The code subdirectory holds the Java and C/C++ services that belong to this
package. Within the code subdirectory are the classes, jars, static, source, and lib
subdirectories:
The classes subdirectory is for Java classes for the Java and C/C++ services.
The jars subdirectory is for Java classes that are packaged together in jar les.
The static subdirectory is also for Java classes that are packaged together in jar
les. Place the jar les in this location when you want to make them available to
other packages in the Integration Server and also to packages in other Integration
Server systems.
When you place jar les in the static subdirectory, then at startup the Integration
Server automatically loads these les to the server classpath. Also, the jar les are
available to other packages even when the immediate package is disabled.

webMethods Integration Server Administrators Guide Version 9.10

585

Even Header
Managing Packages

Note:

The Integration Server does not automatically create the static

subdirectory when you create a new package. This subdirectory is user
dened.

The source subdirectory is for the source of Java services.

The libs subdirectory (not shown here) holds DLLs or specialized libraries that the
Java and C/C++ services use.
Note:

The Integration Server does not automatically create the libs directory
because the directory's existence prevents you from reloading a
package without restarting the server. You cannot reload a package that
uses shared libraries; you must restart the server.

For ease of administration, place services that use shared libraries in the same
package.
The config subdirectory might hold following les:
listeners.cnf. This le contains information about what ports you have dened
for the package and what services you can access through each port. For more
information about conguring ports and allowing access to services through a
port, see "Conguring Ports" on page 155.
urlalias.cnf. This le contains denitions for HTTP URL aliases associated with
services in the package. If there are no aliases, the le does not exist. Do not
manually update a urlalias.cnf le. For more information about HTTP URL
aliases, see "Seing Up HTTP URL Aliases" on page 381.
The ns subdirectory holds ow services, specications, document types, schemas,
triggers, adapter notications, adapter documents, adapter services, adapter
connectors, and code fragments for Java services.
The pub subdirectory holds web documents for the package. For instructions on how
to access the web documents for a package, see "Displaying Documentation for a
Package" on page 594.
The doc subdirectory holds documentation for the package.
The resources subdirectory holds resource bundles <bundle.properties >, such as
application data (not user data), which is kept separate from the Integration Server
application. The following items represent typical resources inside a bundle:
Icons
Window positions
Dialog box denitions
Program text
Menus
You can easily modify and update various aspects of the Integration Server
without reinstalling the entire application. A Japanese language pack for the
webMethods Integration Server Administrators Guide Version 9.10

586

Odd Header
Managing Packages

Integration Server is an example of a resource bundle that contains language and

image les for the Japanese version of the server.
The templates subdirectory holds output templates that are associated with this
package.
The web subdirectory holds JSPs that are associated with this package.

Manifest File
Each package has a manifest le. It contains:
Indication of whether the package is enabled or disabled. The server does not load disabled
packages at server initialization and you cannot access elements that reside in
disabled packages.
List of startup, shutdown, and replication services, if any, for the package. For more
information about startup, shutdown, and replication services and how to identify
them, see "Running Services When Packages Are Loaded, Unloaded, or Replicated"
on page 638.
Package description. A brief description of the package.
Version information. Package version and build number. Also included is the JVM
version under which the package was published.
Patches applied. A list of patches that have been applied to the package. These are
names or numbers that are meaningful to your installation, possibly obtained from
your problem tracking system.
Package dependencies, if any, for the package. For a specic package, the developer can
identify other packages that the server should load before it loads the elements in
a particular package. In other words, the developer can identify when one package
depends on another. For information, see "Displaying Information about a Package"
on page 592 and webMethods Service Development Help.
Target package name. Name of the package.
Publishing server. The Integration Server that published the package. If the package
has not been published, this eld contains None.
The manifest for a package is in the manifest.v3 le in the top directory for the package.

Finding Information about Your Packages

The server displays a variety of information about your packages. The section describes
the information that is available and the procedures to use to display the information.

webMethods Integration Server Administrators Guide Version 9.10

587

Even Header
Managing Packages

Information

Refer to page:

List of all of the packages that reside on

your server

"Viewing the Packages that Reside

on Your Server" on page 589

List of specied packages that reside on

your server

"Viewing the Packages that Reside

on Your Server" on page 589

Status of whether the server successfully

loaded the package or not

"Determining Whether the Server

Successfully Loaded the Package" on
page 590

Status of whether the package is enabled

or disabled

"Determining Whether the Package

Is Enabled or Disabled" on page
591

Version number of the package

"Displaying Information about a

Package" on page 592

Number of elements in a package that

the server successfully loaded into
memory

"Displaying Information about a

Package" on page 592

Name of Access Control List (ACL) that

controls which users can list the package

"Displaying Information about a

Package" on page 592

List of elements in a package that the

server failed to load into memory

"Displaying Information about a

Package" on page 592

List of load errors for the package

"Displaying Information about a

Package" on page 592

List of startup, shutdown, and

replication services in a package

"Displaying Information about a

Package" on page 592

List of packages on which a package

depends

"Displaying Information about a

Package" on page 592

List of servers that subscribe to this

package

"Displaying Information about a

Package" on page 592

Documentation for the package

"Displaying Documentation for a

Package" on page 594

webMethods Integration Server Administrators Guide Version 9.10

588

Odd Header
Managing Packages

To display a list of HTTP URL aliases associated with a package, use the Settings > HTTP
URL Aliases screen. For more information about HTTP URL aliases, see "Seing Up HTTP
URL Aliases" on page 381.

Viewing the Packages that Reside on Your Server

The main package management screen of the Integration Server Administrator lists all
packages that reside on your server. It also displays whether the server successfully
loaded the package and whether the package is enabled.
Note:

The server displays only packages to which you have List access.

To view the packages that reside on the server

1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.

Filtering the List of Packages

By default, the main package management screen lists all the packages that reside on
your server. You can use the lter to limit the packages to be displayed, making the list
shorter and more manageable. You can manage the Packages List in the following ways:
Filter the default list of packages by specifying a full or partial package name, and
then including or excluding packages that match the specied criteria.
Narrow down a list by ltering the results again.
Tip:

Click Show All Packages to disable ltering and restore the default list of all
packages on the server.

To filter the package list

1. In the Packages menu of the Navigation panel, click Management. The Packages List
will display all the packages on your server.
2. Click Filter Packages. The ltering options will appear above the Packages List.
Note:

When Filter Packages is enabled, any changes to the Integration Server

(such as new packages, etc.) will not be reected in the Packages List. When
you click Show All Packages and return to normal mode, the list will be
updated.

3. Select some or all of the following options:

Option

Description

Filter criteria

The string you want to submit to the lter. By default,

packages with names that match the string are included in

webMethods Integration Server Administrators Guide Version 9.10

589

Even Header
Managing Packages

Option

Description
the results. Filter criteria can be literals or a combination
of literal and wild-card characters. The * (asterisk) and
? (question mark) are the only supported wild-card
characters. Leaving the lter criteria blank includes all
packages.
The package names in the Filter criteria eld are caseImportant:
sensitive. For example, if you enter wma*, the lter
will ignore any packages beginning with WmA.

Include Enabled
Include Disabled
Include Both

Specify whether to include only packages that are enabled

(those with Yes in the Enabled column of the Packages List),
only those that are disabled (No is in the Enabled column),
or to include both enabled and disabled packages.

Filter on result

Enable this option when you have already ltered the list
and you want to re-lter the results, rather than the default
list.

Exclude from result

Enable this option to display the packages that do not

match the Filter criteria, rather than the packages that do
match.

4. Click Submit. Only the packages which match the lter options will be displayed.

Refining the Filtered Package List

To filter packages from an already filtered Package List
1. Filter the Packages List as described in "Filtering the List of Packages" on page 589.
The packages which match the lter will be displayed.
2. Enable the Filter on result mode. This limits the search to just the currently displayed
list of packages, rather than the default list of all the packages on the server.
Note:

You can also enable the Exclude from result option to display the packages
that do not match the Filter criteria, rather than the packages that do
match.

3. Enter the new lter criteria and click Submit. Repeat as many times as necessary,
being sure to enable the Filter on result mode each time.

Determining Whether the Server Successfully Loaded the Package

The server displays a status in the Loaded? column of the Packages screen.

webMethods Integration Server Administrators Guide Version 9.10

590

Odd Header
Managing Packages

Status

Indicates that...

Yes

The server successfully loaded all elements associated with

the package. The elements in the package are available. The
server also displays this status if the package is empty.

Partial

No

The server did not load one or more of the elements

associated with the package. The elements that the server
successfully loaded are available. For instructions on how
to determine which elements the server did not successfully
load and why, see "Displaying Information about a Package"
on page 592.
The server did not load any of the elements associated
with the package. None of the elements are available. For
instructions on how to determine why the server could
not load the elements, see "Displaying Information about a
Package" on page 592.

When the server is started, it automatically loads into memory all elements that are in
enabled packages. If a package is disabled at startup, the server loads the elements into
memory when the package is enabled. You can manually reload a package if necessary.
For instructions on reloading a package, see "Reloading a Package" on page 597.

Determining Whether the Package Is Enabled or Disabled

The server displays a status in the Enabled column of the Packages screen. The status
indicates whether the package is enabled or disabled. A package must be enabled before
the server allows clients access to the services in the package.
Status

Yes

Indicates that...
The package is enabled and clients can access the elements in
the package.

No

The package is disabled and clients cannot access the

elements in the package.

Warnings

Some of the elements in the package encountered warnings,

but were loaded and are available for use. To learn which
elements caused warnings, look at the Load Warnings list at
the boom of the screen.

webMethods Integration Server Administrators Guide Version 9.10

591

Even Header
Managing Packages

For instructions on enabling and disabling packages, see "Enabling a Package" on page
598 and "Disabling a Package" on page 598.

Displaying Information about a Package

You can display information about any package installed on Integration Server.
To display information about a package
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. In the Package List area of the screen, click on the name of the package for which you
want to display information.
4. The server displays the Packages > Management >PackageName screen. For a detailed
description of these elds, see "Package Information" on page 592.

Package Information
Integration Server maintains the following information about each installed package.
Field

Description

Package Name

Name of the package.

Version

Version number of the package.

Build

A number that a developer assigns to a package each time

it is regenerated. For example, a developer might generate
version 1.0 of the Ordering package 10 times and assign build
numbers 1,2,3,...10. These build numbers are generally used
to identify the generations of a package in a development
environment.

Minimum Version
of JVM

Minimum version of the Java Virtual Machine (JVM)

required to run this package.

Package List ACL

The Access Control List assigned to the package. Users

associated with this ACL can see the package listed on the
Integration Server Administrator or Designer. To see the
folders and elements contained in the package, a user must
have List access to the folders and elements themselves.

Patches Included

A list of patches that have been applied to this release of the

package. These are numbers that are meaningful to your

webMethods Integration Server Administrators Guide Version 9.10

592

Odd Header
Managing Packages

Field

Description
installation, possibly obtained from your problem tracking
system.

Description

A description of the package and its intended use.

Publisher

The name of the company, organization, or server that

published the package.
Note: By default, the Integration Server automatically enters
the publishing server name in this eld only when you
create a package release.

Created on

Date, time, and year in which the package was created.

Note: By default, the Integration Server automatically enters
the date, time, and year in this eld only when you
create a package release.

Elements Loaded

Number of elements that the server successfully loaded. To

view the elements that the server has successfully loaded,
click the Browse services in < PackageName> link.

Elements Not
Loaded

Number of elements that the server failed to load. If the

server failed to load one or more elements, the Load Errors
section of the screen lists the elements that it could not load,
along with the reason.

Startup Services

List of the services that you or another administrator have

identied as startup services. For more information about
startup services, refer to "Running Services When Packages
Are Loaded, Unloaded, or Replicated" on page 638.

Shutdown
Services

List of the services that you or another administrator have

identied as shutdown services. For more information about
shutdown services, see "Running Services When Packages
Are Loaded, Unloaded, or Replicated" on page 638.

Replication
Services

List of the services that you or another administrator have

identied as replication services. For more information about
replication services, see "Running Services When Packages
Are Loaded, Unloaded, or Replicated" on page 638.

webMethods Integration Server Administrators Guide Version 9.10

593

Even Header
Managing Packages

Field

Description

Packages on
which this package
depends

List of the packages the server must load before it loads this
package. For more information about package dependencies,
see webMethods Service Development Help.

Packages that
depend on this
package

List of packages that depend on this package. If you disable

the package, these packages will be aected.

Subscribers

List of other Integration Servers that subscribe to this

package. For information on how to copy packages from one
server to another, how to subscribe to packages, and how to
publish packages to another server, see "Copying Packages
from One Server to Another" on page 600.

Load Errors

Displays a list of elements that generated errors and could

not be loaded onto the server when the package was
installed. When some elements do not load, the load status
for the package becomes Partial.

Load Warnings

Displays a list of elements that generated warnings when

the package was installed. The server was able to load the
packages, despite the warnings. When package elements
are loaded with warnings, the load status for the package
becomes Warnings.

Patch History

A list of patches or partial packages that have been applied to

this release of the package.

Displaying Information about Services and Folders in a Package

You can browse a list of services or folders in a package. See "Finding Information about
Services and Folders" on page 634.

Displaying Documentation for a Package

You can document the function of a package and its elements in web documents that
the Integration Server will serve. Place the web documents in the pub subdirectory for a
package.
Be sure to create an index.html le that holds the home page for the package and
contains links to the other web documents for the package.

webMethods Integration Server Administrators Guide Version 9.10

594

Odd Header
Managing Packages

To access the home page for a package

1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel click Management.
3. Click the home

icon for the package.

Accessing a Web Document for a Package

To access any web document for a package
1. Make sure the package is enabled. (See "Determining Whether the Package Is
Enabled or Disabled" on page 591 for instructions.)
2. Enter the URL for the web document. The URLs for the web documents have the
following format:
hp://host :port /PackageName /Docname
where:
host :port

is the server name and port address of the Integration

Server

PackageName

is the name of the package in which the web document

resides. If you do not specify a package name, the server
looks in the Pub directory of the Default package.

DocName

is the name of the web document. If you do not specify

a document name, the server displays the index.dsp
or index.html le in the Pub directory of the specied
package.

Working with Packages

You can perform the following tasks that act on all the les in a package as a unit:
Use this
function:

When you want to:

Refer to page:

Create

Create a new package. Developers

create packages using Designer. See
webMethods Service Development Help for
more information.

"Creating a
Package" on page
596

webMethods Integration Server Administrators Guide Version 9.10

595

Even Header
Managing Packages

Use this
function:

When you want to:

Refer to page:

Activate

Use a package that you manually moved

into the Server/packages directory
without having to restart the server.

"Activating a
Package" on page
597

Reload

Reload the services in the package into

memory without having to restart the
server.

"Reloading a
Package" on page
597

Enable

Enable a package that you previously

disabled.

"Enabling a
Package" on page
598

Disable

Disable access to a package without

deleting it.

"Disabling a
Package" on page
598

Delete

Delete all services and related les in a

package.

"Deleting a
Package" on page
599

Recover

Recover the services and related les

from a package that you previously
deleted.

"Recovering a
Package" on page
599

Archive

Make a working copy of a package

without making it generally available to
others through a release. You might use
this copy as a backup.

"Archiving a
Package" on page
600

Copy

Copy a package from one server to

another.

"Archiving a
Package" on page
600

Note:

You can also manage packages by using a set of built-in services. See the
webMethods Integration Server Built-In Services Reference for more information.

Creating a Package
When a developer wants to create a new grouping for services and related les,
the developer creates a package. This creates an empty container into which your
developers can store services and related les. When a developer creates a package, the
server builds the directory structure of the package as described in "How the Server
webMethods Integration Server Administrators Guide Version 9.10

596

Odd Header
Managing Packages

Stores Package Information" on page 585. For instructions on creating a package, see
webMethods Service Development Help.

Activating a Package
There may be times when a package is installed on your server but is not active. When
a package is active, it is ocially recognize by the server and displayed in the Package
List on the Package Management screen. When a package is inactive, it exists in the
Packages directory, but is not ocially recognized by the server.
Possible reasons for a package being inactive are:
You manually installed the package while the server was running.
Another server published the package to your server, but the package requires a
version of the JVM that is higher than the version on your server. A subscribing
server will not activate a package under these circumstances.
The package you installed has dependencies on another package that either does not
exist on your server or is disabled. If the package is disabled, the server installed the
package but did not activate it. You can activate the package when the dependencies
are satised.
The package will not be available until either you restart the server or you activate the
package.
To activate a package
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. Click Activate Inactive Packages.
4. In the Inactive Packages area, select the package you want to activate from the pulldown menu and click Activate Package.

Reloading a Package
If the server is running when a developer changes a Java service or ow service, you
must reload the package in which the service is contained for the changes to take eect.
Reloading the package invokes the VM class loader to reload the package's Java services
and reloads the ow services into memory. Developers can also reload a package from
Designer.
To reload a package
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. Click the reload icon

in the Reload column for the package.

webMethods Integration Server Administrators Guide Version 9.10

597

Even Header
Managing Packages

4. The green check mark icon in the Loaded? column indicates whether the server
loaded the package successfully. For more information, see "Determining Whether
the Server Successfully Loaded the Package" on page 590.

Enabling a Package
To allow clients access to the elements in a package, you must ensure the package is
enabled. Before the server can access an element in a package, the package must be
enabled and the element must be loaded. By default, packages are enabled.
When you enable a disabled package, the server loads the elements in the package into
memory.
To enable a package
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. Click No in the Enabled column for the package you want to enable. The server issues
a prompt to verify that you want to enable the package. Click OK to enable the
package. When the package is enabled, the server displays a
icon and Yes in the
Enabled column.

Disabling a Package
When you want to temporarily prohibit access to the elements in a package, disable the
package. When you disable a package, Integration Server unloads all of its elements
from memory. Be aware that if you disable a package while one or more services in the
package are executing, those services will most likely fail. Integration Server does not
wait for in-progress services to nish before disabling a package.
Important: Never disable the WmRoot package. Integration Server uses the services in
this package.
To disable a package
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel click the Management link.
3. Click the green check mark on in the Enabled column for the package you want to
disable. The server issues a prompt to verify that you want to disable the package.
Click OK to disable the package. When the package is disabled, the server displays
No in the Enabled column.
Note:

The server retains the access status of a package (enabled or disabled)

across server restarts. When you start the server, the server does not load
elements in disabled packages.

webMethods Integration Server Administrators Guide Version 9.10

598

Odd Header
Managing Packages

Deleting a Package
When you no longer need the services and les in a package, you can delete the package.
When you delete a package, all the elements of the package (services, specications,
document types) become unavailable.
When you delete a package, you can optionally select to save a copy
of the package. If you save a copy, the server copies the package to the
Integration Server_directory\instances\instance_name \replicate\salvage directory
before deleting the package from the Integration Server_directory\instances
\instance_name \packages directory. If needed, you can recover the package at a later
time. For instructions on recovering a deleted package, see "Recovering a Package" on
page 599.
Important: Never delete the WmRoot package. The Integration Server uses the services
in this package.
When you delete a package from the command prompt, you have the option of deleting
a single package or a list of packages. For more information about deleting a package
from the command prompt, see "Deleting Packages from a Server Instance" on page 79.
To delete a package
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel click Management.
3. If you want to save a copy of the package so you can recover it later if necessary,
check the
icon in the row that corresponds to the package you want to delete.
4. If you do not want to save a copy, click the
package you want to delete.

icon in the row that corresponds to the

5. Click Delete. The server asks you to conrm you want to delete the package. Click
OK.

Recovering a Package
If you deleted a package from a server instance using the Safe delete option and you need
the package again, you can recover the package.
Note:

If you did not use the Safe delete option, it is still possible to restore the
package from the webMethods Integration Server package repository. If the
package exists in the repository, you can perform a package update from the
command prompt. For instructions on updating packages from the command
prompt, see "Installing and Updating Packages on a Server Instance" on page
78.

webMethods Integration Server Administrators Guide Version 9.10

599

Even Header
Managing Packages

To recover a package after using Safe Delete

1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel click Management.
3. Click Recover Packages.
4. In the Recover Packages area, select the package you want to recover from the pull
down.
5. If you want the Integration Server to automatically activate the package when it is
recovered, select the Activate Upon Recovery check box.
6. Click Recover.

Archiving a Package
There may be times when you want to make a copy of a package without making it
generally available. For example, you might want to back it up or send it to someone
with whom you do not have a publisher/subscriber relationship.
Note:

An alternative way of creating a backup is using the pub.packages:backupPackage

service. However, when you use the backupPackage service, the package
metadata of the backed up package is the same as the original package. For
example, the creation timestamp will reect the creation timestamp of the
original package. For more information, see the webMethods Integration Server
Built-In Services Reference.

To archive a package
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. Locate the package you want to archive in the Package List, and click the

icon.

The server displays a screen from which you specify the les you want to archive,
the type of archive (full or patch), and version information. See "Specifying File and
Version Information for a Release or Archive" on page 613 for instructions on
specifying this information.
Note:

You can also archive a package automatically after installing the package.
For more information, see "About Installing Packages Published by
Another Server" on page 624.

Copying Packages from One Server to Another

Use package replication to copy (publish) packages from one Integration Server to
another. If you have a clustered environment, this feature is useful to quickly replicate
webMethods Integration Server Administrators Guide Version 9.10

600

Odd Header
Managing Packages

new and updated packages across all servers in the cluster. It is also a convenient way to
distribute a package from one server to another anywhere on the web.
Note:

Using Software AG Designer, you can copy a package and its contents to
another Integration Server by performing a copy or a drag-and-drop action.
Copying packages using Designer provides a quick way to test a set of
services and their supporting les, for example, in a remote environment. This
method is useful in single development environments where change control
is not crucial. In a production environment, however, using the package
replication function is recommended.

Note:

If you want to make a copy of package, for example to make a backup,

without sending it to another server, see "Archiving a Package" on page
600.

Overview of Package Replication

During replication, a single Integration Server sends (publishes) a specied package to
one or more recipient servers. The server on which the package originates is referred to
as the publisher, and the recipients are referred to as subscribers.

Subscribing servers receive the package in their inbound directory

(Integration Server_directory\instances\instance_name \replicate\inbound). To activate
the new package, an administrator on the subscribing server must install the package
after it arrives. (This procedure is explained in "About Installing Packages Published by
Another Server" on page 624.)

webMethods Integration Server Administrators Guide Version 9.10

601

Even Header
Managing Packages

Either a publisher or a subscriber can request a subscription. A publisher can send

(push) the package and the subscriber can request (pull) the package.
Before you send a package to another server, you must create a release. When you create
a release, the server creates a distribution le that contains the package and information
about the package, and makes the package available to subscribers.
You can have multiple releases for a given package. For example, you might have
separate releases for versions 1.0, 1.1, and 1.2 of a given package. Or, you might use
dierent releases to separate packages for dierent audiences. Each release must have a
unique name.
Important: If you have multiple releases of a given package and one or more subscribers
have specied the automatic pull feature, those subscribers will receive all
releases of a package when a new release of it becomes available. For more
information about the automatic pull feature, see "The Subscribing Server"
on page 617.
A release can contain the complete package (a full release) or just patches to the package
(a patch release). Typically you will publish a full release when you have made major
changes to the package and use patches just to correct problems with a package.
With a full release, the new package entirely replaces the old package on the subscriber's
server. With a patch release, the les in the patch release replace the versions of those
les in the target package; all other les in the target package remain intact.
In addition to specifying a full or patch release, you can select all les to go in the release
or just some.
The following diagram illustrates how a patch release replaces les:

webMethods Integration Server Administrators Guide Version 9.10

602

Odd Header
Managing Packages

The following diagram illustrates the results if you selected a single service for
replication and specied a full release instead.

webMethods Integration Server Administrators Guide Version 9.10

603

Even Header
Managing Packages

Most often you will select all les and specify a full release, or select some les and
specify a patch release. There might be times however when you want to select just some
les and specify a full release. For example, there might be les in a package, such as
internal documentation les, that a developer does not want released to others. Selecting
all les except the extraneous ones and specifying a full release results in a package that
contains just the desired les.
There might be other times when you want to replace some les, leave others intact, and
delete others. To achieve this greater level of control, you can perform a patch release
and specify les to copy and les to delete. Files that you do not specify for copying
or deletion remain intact. In the following example, we want to leave Service A intact,
replace Service B, and delete Service C from the target package.

The following shows what you must specify on the Specify Files for the Release screen to
accomplish this task:

webMethods Integration Server Administrators Guide Version 9.10

604

Odd Header
Managing Packages

The Integration Server keeps track of package versions, Integration Server versions, and
JVM versions so that during package installation the subscribing server can make sure
the package being installed is compatible with the subscribing server's environment. The
type of version checking performed depends on whether the release is a full or patch
release.
Note:

If patch releases have been applied to a package, the developer can see the
patch history when viewing the package from Designer. However, when the
publisher publishes a full release of the package, the patch history is removed.

Version Checking
When the administrator on the subscribing server installs the package, the subscribing
server performs some version checking:

webMethods Integration Server Administrators Guide Version 9.10

605

Even Header
Managing Packages

Target server verifies that...

Target JVM Version

The target server is running the same or a later version of the

JVM, as specied during release creation. If this requirement
is not met, the subscribing server issues a warning and
installs the package but does not activate it. See "Activating
a Package" on page 597 for instructions on activating a
package.

Package Version

For a full release

For a patch release

The version of the package

on the target server
is earlier than or the
same as the package
being installed. If this
requirement is not met,
package installation fails.

The version of the package

on the target server exactly
matches the version required
by the release (as specied
during release creation). If
this requirement is not met,
package installation fails.

For example, if you create

a new release and specify
that it contains Version
2.0 of the wmExample
package, the wmExample
package on the target
system must be release 2.0
or earlier.

For example, if you create

a new release that contains
a patch for wmExample
package version 2.0, and
you specify that the target
package must be version 2.0,
package installation will fail
if the target package is not
version 2.0.

This restriction prevents

you from inadvertently
installing an old version
of a package over a newer
one.

This restriction gives you

greater control over how and
where patches are applied.
This is useful because
patches are typically release
dependent.

Who Can Subscribe?

Any Integration Server can subscribe to a package on another server if both servers
allow it from a security perspective. Security for package replication is accomplished a
number of ways:
Userid and password. In order to send a package to a subscriber, the publisher must
login to the subscriber by specifying a userid and password that exist on the
subscriber.

webMethods Integration Server Administrators Guide Version 9.10

606

Odd Header
Managing Packages

ACLs. The userid the publisher uses to log on to the subscriber must be a member of
a group that is assigned to the Replicators ACL or higher on the subscriber.
SSL.You can specify that the servers involved in package replication connect to each
other using SSL.
The publisher maintains a list of subscribing servers for each package.
Subscriptions can be added by the publisher or the subscriber:
Publisher. The administrator of a publishing server can use the publisher functions to
add (or remove) subscribers to any package that originates on the publishing server
(i.e., one to which you do not subscribe).
Subscriber. The administrator of a remote Integration Server (the subscriber) can
submit a subscription request to the publisher. When the publisher receives this
request, it automatically adds that server to the subscription list for the requested
package as long as authentication was successful. Subscribers can also issue
cancellation requests (i.e., cancel their subscriptions) for packages to which they
subscribe.

Guidelines for Using Package Replication

Keep the following guidelines in mind when using the package replication facility:
Publishers and participating subscribers must use Integration Server Version 2.0 or
later. For the for Automatic Pull feature to work, they must be running Version 4.0 or
later. If you are running version 4.0 or later of the Integration Server and publish to
an earlier release of the Integration Server, the subscriber cannot perform a manual
or automatic pull of a package. Instead, the subscriber must wait for the publisher to
send the package
Any Integration Server can publish a package.
Any Integration Server can subscribe to a package on another Integration Server.
An Integration Server can be both a publisher of packages and a subscriber of
other packages; however, it cannot be both a publisher and a subscriber of the same
package.
After seing up a subscription, i f you delete the user account with which the
subscription was set up (the account on the subscribing server that the publishing
server uses to log on), the publisher will not be able to log into the subscribing server
to send this package.
Be careful when replicating a package that is associated with a port; the new port
might decrease security on the target system. For example, suppose you replicate a
package that is associated with an HTTP port at 5556. The replication process creates
an HTTP port at 5556 on the target server. If the target server normally uses only
HTTPS ports because of their greater security, then the new port presents a possible
security hole on that server.

webMethods Integration Server Administrators Guide Version 9.10

607

Even Header
Managing Packages

The Publishing Server

This section describes the tasks you perform when your server is participating in
package replication as the publishing server:
Task:

Refer to page:

Displaying the list of subscribers

for a package

"Displaying Subscribers for a Specic

Package" on page 608

Specifying subscribers for a

package

"Adding Subscribers from a Publishing

Server" on page 609

Updating subscriber information

"Updating Subscriber Information" on page

610

Removing subscribers for a

package

"Removing Subscribers for a Package" on

page 611

Publishing a package to
subscribing servers

"Publishing a Package" on page 612

Specifying File and Version

Information for a Release or
Archive

"Specifying File and Version Information for

a Release or Archive" on page 613

Displaying Subscribers for a Specific Package

Use this procedure to display the list of subscribers for a specic package on your server.
To display the subscribers for a single package
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. Click the name of the package for which you want to view subscribers.
The server lists the subscribers to the package in the Subscribers eld.

Displaying Subscribers for all Packages

Use this procedure to display the list of subscribers for all packages on your server.
To display the subscribers for all packages
1. Open the Integration Server Administrator if it is not already open.

webMethods Integration Server Administrators Guide Version 9.10

608

Odd Header
Managing Packages

2. In the Packages menu of the Navigation panel, click Publishing.

The server displays a list of all packages, their subscribers, and releases.

Adding Subscribers from a Publishing Server

When you add a subscriber, you are identifying the Integration Servers that are to
receive a package. You can have a dierent list of subscribers for each package on your
server.
Specify the subscribers (recipients) of the package. (You only need to execute this task
the rst time you publish the package; from then on, you can simply modify or reuse the
initial list.)
Keep the following points in mind when adding a subscriber from a publishing server:
To specify the automatic pull feature, you must create the subscription from the
subscriber.
The subscribing server must be running at the time you add the subscriber.
Note:

To request a subscription from a subscribing server, see "Subscribing to a

Package from a Subscribing Server" on page 619.

To add a subscriber
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Publishing.
3. Click Add Subscribers.
4. Select the package for which you want to identify subscribers from the drop down
list in the Package eld.
5. To identify a subscribing server, enter information in the following elds:
Field

Description

Host Name

Name of the machine on which the subscribing server is

running.

Host Port

Port number on which the subscribing server listens for this

package to be published.

Transport

Method the publishing server uses to send the package to

the subscribing server. Select HTTP or HTTPS. HTTP is the
default.

webMethods Integration Server Administrators Guide Version 9.10

609

Even Header
Managing Packages

Field

Description
Note: If you want the publisher to use SSL when sending the
package to the subscriber, you must specify HTTPS
here.
When the publisher connects to the subscriber, the
publisher uses the server's default Outbound SSL Certificates
as specied on the publisher's Security > Certificates screen.

Remote User Name

User the publishing server uses to log into the subscriber

server. This user must be a member of a group that is
assigned to the Replicators ACL on the subscribing server.

Remote Password

Password of the user that the publishing server uses to log

into the subscribing server.

Notification E-mail

E-mail address of the administrator to notify when the

publishing server releases a package.

6. Click Add Subscriber. The server adds the subscriber to the list in the Subscribers eld.
Repeat this step for each server you want to identify as a subscriber to the package.

Updating Subscriber Information

Use this procedure to update information about a subscriber, such as the package name.
To update subscriber information
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of in the Navigation panel, click Publishing.
3. Click Update and Remove Subscribers.
4. Locate this subscriber in the information list and click Edit in the Update column.
5. To change subscriber information, enter information in the appropriate elds below:
Field

Description

Packages

Packages to which the subscriber subscribes. You can

change the subscription to be for another package. You can
only select a package to which your server does not already
subscribe because you cannot both publish and subscribe to
the same package.

webMethods Integration Server Administrators Guide Version 9.10

610

Odd Header
Managing Packages

Field

Description

Host Name

Name of the machine on which the subscribing server is

running.

Host Port

Port number on which the subscribing server listens for

this package to be published. The number you specify must
correspond to a port that already exists and is enabled on
the subscribing server. In addition, the publishing server
must have replicator access or higher.

Transport

Method the publishing server uses to send the package to

the subscribing server. Select HTTP or HTTPS. HTTP is the
default. The transport type must match the type dened for
the host port on the subscribing server.
Note: If you want the publisher to use SSL when sending the
package to the subscriber, you must specify HTTPS
here.
When the publisher connects to the subscriber, the
publisher uses the server's default Outbound SSL Certificates
as specied on the publisher's Security > Certificates screen.

Remote User Name

User the publishing server uses to log into the subscriber

server. This user must be a member of a group that is
assigned to the Replicators ACL on the subscribing server.

Remote Password

Password of the user that the publishing server uses to log

into the subscribing server.

Notification Email

E-mail address of the administrator to notify when the

publishing server releases a package.

6. Click Submit Changes. The server adds the subscriber to the list in the Subscribers
eld. The server updates the information on both the subscribing and publishing
servers.

Removing Subscribers for a Package

Use this procedure to remove a subscriber from a package that you publish.
Note:

If a subscriber removes a subscription initiated by the publisher, the

subscribing server removes the subscription from its subscriptions list, but the
subscription is not immediately removed from the publisher's list. Instead, the
next time the publishing server tries to send the package to the subscriber, the

webMethods Integration Server Administrators Guide Version 9.10

611

Even Header
Managing Packages

publisher is notied of the removal and then deletes the subscription from the
publisher's list.
To remove subscribers
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of in the Navigation panel, click Publishing.
3. Click Remove Subscribers.
4. Locate the package for which you want to remove subscribers and check the box in
the Delete eld.
Note:

If the subscriber is running when you remove it from the subscriber

list, the publisher tells the subscriber it has been removed. However,
if the subscriber is not running, the subscriber will not know the
subscription has been canceled. In this case, you should manually delete
the subscription from the subscriber server later when it is available.

Publishing a Package
Publishing a package to other Integration Servers involves two tasks:
Creating a release. To publish a package, your server creates a distribution le that
contains the information for the package.
When you create the distribution le, you select what information to include in the
le.
You can select all les to send, or just some. In addition, you can request a full release
or a patch release. With a full release, the new package entirely replaces the old
package on the subscriber's server. With a patch release, the les in the patch release
replace the versions of those les in the target package; all other les in the target
package remain intact. See "Overview of Package Replication" on page 601 for
more information about how full and patch releases dier.
After you indicate the les to include in the release, the server places all the
selected les into a single, compressed le (a zip le). It places the zip le in the
Integration Server_directory\instances\instance_name \replicate\outbound directory.
If the outbound directory already contains a zip le for this package, the server
overwrites the existing le.
Sending the release. After you create the release, you can send it to the subscribing
servers.
A subscribing server receives the zip le containing the release in its inbound
directory (Integration Server_directory\instances\instance_name \replicate\inbound).
If a zip le for the package already exists in a subscribing server's inbound directory,
the server overwrites it. The zip le remains in the inbound directory on the
subscribing server until the administrator of that server installs the package.

webMethods Integration Server Administrators Guide Version 9.10

612

Odd Header
Managing Packages

A developer can set up the package to execute a service when you create the release.
When you begin to create the release, this service executes before the list of les
to be zipped is displayed. You can use this service to write state and conguration
information for the package to a le. This le will be included with the other zipped
les included in the release. For instructions on seing up replication services, see
webMethods Service Development Help.
Important: Before you can publish a package, you must specify the subscribers. For
instructions, refer to "Adding Subscribers from a Publishing Server" on page
609.
Creating a Release
Use the following procedure to create a release for a package.
To create a release
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Publishing.
3. Click Create and Delete Releases.
4. Locate the package for which you want to create a release, and click Create Release for
PackageName.
5. The server displays a screen from which you specify the les you want to include
in the release, the type of release (full or patch), and version information. See
"Specifying File and Version Information for a Release or Archive" on page 613 for
instructions on specifying this information.
Sending a Release
Use the following procedure to send a package release.
To send the release
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel click Publishing.
3. Locate the release of the package you want to send under Available Releases, and click
Send Release.

Specifying File and Version Information for a Release or Archive

When you archive a package or create a release, the server displays a screen from which
you can specify the les you want to archive or release, the type of archive or release
(full or patch), and version information.
Note:

You can also use the wa.server.createPackage.ignorePaern conguration

parameter to specify the paerns of le names for the les that you do not

webMethods Integration Server Administrators Guide Version 9.10

613

Even Header
Managing Packages

want Integration Server to include when publishing packages. For more

information about this parameter, see "Server Conguration Parameters" on
page 851.
Refer to "Archiving a Package" on page 600 for detailed instructions on how to
archive a package. Also, refer to "Publishing a Package" on page 612 for detailed
instructions on how to create and send a release.
To specify file and version information for a released or archived package
1. Identify the les that you want to include in the release/archive.
If you want to include:

Do this:

All les

In the Files to include section, select All files.

Most, but not all,

of the les

In the Files available inpackage , section, select the les you do

NOT want to include in the archive or release.
In the Files to includesection, select allexceptselected files.
If the developer added package dependencies or startup,
shutdown, or replication services to the package since the
last archive or release was created, be sure to include the
manifest.v3 le. Otherwise these services will not be available
in the resultant package. See "Running Services When
Packages Are Loaded, Unloaded, or Replicated" on page
638 for more information about startup, shutdown, and
replication services.

Only a few of the

les

In the Files available inpackage section, select the les you want
to include in the archive or release.
In the Files to include section, select Selected files.
If the developer added package dependencies or startup,
shutdown, or replication services to the package since the
last archive or release was created, be sure to include the
manifest.v3 le. Otherwise these services will not be available
in the resultant package. See "Running Services When
Packages Are Loaded, Unloaded, or Replicated" on page
638 for more information about startup, shutdown, and
replication services.

Files with a similar

path name

In the Files to include section, select Files specified by filter and

enter a valid lter, for example *.java or *.class.
or

webMethods Integration Server Administrators Guide Version 9.10

614

Odd Header
Managing Packages

If you want to include:

Do this:
To include all les except those with a similar name, in the
Files to include section, click All except files specified bylter and
enter a valid lter, for example *.bak.
If the developer added package dependencies or startup,
shutdown, or replication services to the package since the
last archive or release was created, be sure to include the
manifest.v3 le. Otherwise these services will not be available
in the resultant package. See "Running Services When
Packages Are Loaded, Unloaded, or Replicated" on page
638 for more information about startup, shutdown, and
replication services.
You can specify the following special character to perform
paern matching.
Char

Description

Example

Matches any
number of
characters

*.java

2. Identify les you want to delete from the target package by entering one le name
per line. Separate each entry with a semicolon (;). When the subscribing server
installs the package, these les will be deleted from the target package.
3. Specify package version information and description:
Field

Description

Archive/Release Type

Full: All les in the package are wrien to the archive or

release
Patch: Selected les in the package are wrien to the archive
or release. When the administrator on the target server
installs a patch archive or release, the les contained in the
patch archive or release replace the versions of those les
in the target package; all other les in the target package
remain intact.
If the developer added package dependencies or startup,
shutdown, or replication services to the package since
the last archive or release was created, be sure to include
the manifest.v3 le. Otherwise these services will not be
available in the resultant package. See "Running Services
When Packages Are Loaded, Unloaded, or Replicated" on

webMethods Integration Server Administrators Guide Version 9.10

615

Even Header
Managing Packages

Field

Description
page 638 for more information about startup, shutdown,
and replication services.

Archive/Release Name

A name you assign to the archive or release, for example

Beta Release of WmExample Package.

Brief Description

A description you assign to the archive or release, for

example Dec release with patches to correct OrderProcess
problem.

Version

The version number you assign to the package you are

archiving or releasing. This version might not be the same
as the version of the package itself. When a developer rst
creates a package, the version number is set to 1.0.
For more information about the checking the Integration
Server performs, see "Version Checking" on page 605.

Build Number

A number that a developer assigns to a package each time

it is regenerated. For example, a developer might generate
version 1.0 of the WmExample package 10 times, assigning
build number 1,2,3...10.

Patches Included

A list of patches that have been applied to this release of the

package. These are numbers that are meaningful to your
installation, possibly obtained from your problem tracking
system.

4. Specify subscriber seings:

Field

What It Means:

webMethods
Integration Server

Version of the webMethods server that must be running on

the target server.
For more information about the version checking performed
by the subscribing server, see "Version Checking" on page
605.

Minimum Version of
JVM

Minimum version of the Java Virtual Machine (JVM) that

the target Integration Server should be running when using
this package. When the administrator installs the package,
the server checks the version of the JVM it is running. If it is
running a dierent version, the server installs the package
but does not activate it.

webMethods Integration Server Administrators Guide Version 9.10

616

Odd Header
Managing Packages

Field

What It Means:
For more information about the version checking performed
by the subscribing server, see "Version Checking" on page
605.

5. Specify version of target package (for patch releases only).

6. This is the version of the package the target server must be running. When the
administrator installs the patch on the target server, the server checks to make sure
the version of the target package is the same as the one specied here. If the target
package is a dierent version, the server does not install the package. This restriction
gives you greater control over how and where patches are applied. This is useful
because patches are typically release dependent.

The Subscribing Server

This section describes the tasks the subscribing server performs when participating in
package replication as the subscribing server.
Subscribers can retrieve packages manually or automatically. To retrieve a package
manually, an administrator on the subscribing server views a list of available
subscriptions and retrieves the desired package. When automatic pull is in eect, the
subscribing server automatically pulls a package from the publisher when a new release
becomes available.
For a package to be retrieved automatically, the subscriber must specify the automatic
pull feature when seing up the subscription. When a new release becomes available,
the publishing server sends a service-invocation e-mail to a designated e-mail server.
The service-invocation e-mail contains a call to a service that runs on the subscribing
server to retrieve packages. The subscribing server periodically checks the e-mail
server through an e-mail port on the subscribing server. When it receives and processes
the service-invocation e-mail, the subscribing server automatically pulls the package
from the publisher and places it in the Inbound directory. The administrator on the
subscribing server can then install the package.
Task:

Refer to page:

Displaying packages to which your

server subscribes

"Displaying Packages to Which Your

Server Subscribes" on page 618

Manually Pulling a Package

"Manually Pulling a Package" on

page 618

Subscribing to a package from another

server

"Subscribing to a Package from a

Subscribing Server" on page 619

webMethods Integration Server Administrators Guide Version 9.10

617

Even Header
Managing Packages

Task:

Refer to page:

Updating subscription information

"Updating Subscriber Information"

on page 610

Canceling a subscription to a package on

another server

"Canceling a Subscription" on page

624

Installing a package that was published

from another server

"About Installing Packages Published

by Another Server" on page 624

Displaying Packages to Which Your Server Subscribes

You can view the subscriptions your server has to packages on other servers.
To display the packages to which your server subscribes
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel click Subscribing.
3. The server displays a list of your available subscriptions, organized by publisher,
package, and release.
4. The server automatically updates this information when you (the subscriber) add,
update, or remove a subscription; however, to see changes made by the publishers,
you must click Update All Subscription Details.

Manually Pulling a Package

You can manually pull subscriptions to the inbound directory of your server.
To pull a package to which have already subscribed
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Subscribing.
3. The server displays a list of your available subscriptions, organized by publisher,
package, and release.
4. Find the release of the package you want to pull and in the Retrieve eld, click the
retrieval method you want to use.
Field

What It Means:

Via Service Invocation

The publishing server sends the release using HTTP or

HTTPS.

Via FTP Download

The publishing server sends the release using FTP.

webMethods Integration Server Administrators Guide Version 9.10

618

Odd Header
Managing Packages

Field

What It Means:
When you select FTP, the server prompts you for
information required to use FTP:
Release Name: Name assigned to the release, for example Beta
Release of WmExample Package.
Remote Server Alias:Name of the machine on which the
publishing server resides.
Remote Server FTP Port: FTP port on the publishing server
through which the publisher will send the package.
Remote User Name:User that the subscriber uses to log into the
publishing server.
Remote Password:Password of the user that the subscribing
server uses to log into the subscribing server.

5. Install the package. For instructions, see "About Installing Packages Published by
Another Server" on page 624.

Subscribing to a Package from a Subscribing Server

When you subscribe to a package from the subscribing server, your server sends a
subscription request to the publishing server. The publishing server adds your server to
the subscription list for the package.
The remote server must have an alias dened on the local server. If the remote server
does not already have an alias dened, you can dene one ahead of time by going to the
Settings menu of the Navigation panel and clicking Remote Servers or you can dene one
while creating the subscription.
When requesting a subscription, the subscriber must provide the following two-way
connection information to the publisher:
Method the subscriber will use to connect to the publisher to make the subscription request.
The subscriber must supply a valid userid and password it can use to log on to the
publishing server. You set up this and other connection information using a remote
server alias for the publisher.
Method the publisher will use to connect to the subscriber when sending it a package. The
subscriber must supply a valid userid and password that the publisher can use
to log on to the subscribing server. This userid must be a member of a group that
is assigned to the Replicators ACL. In addition, the subscriber must supply other
connection information, such as listening port.
Requesting a Subscription to a Package from Another Server
The following procedures describe how to request a subscription.

webMethods Integration Server Administrators Guide Version 9.10

619

Even Header
Managing Packages

Note:

The publishing server must be running at the time you add the subscription

To request a subscription to a package from another server

1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Subscribing.
3. Click Subscribe to Remote Package.
4. Type the name of the package in the Package eld. Be sure to type the name exactly
as it is specied on the publishing server, using the same combination of upper- and
lowercase characters.
5. Enter the information in the following elds to set up your request:
Field

Description

Publisher Alias

Alias assigned to the publisher. The alias denition tells the

subscriber how to connect to the publishing server to register for
a subscription. The alias contains connection information such
as host name or IP address. If you have not already dened an
alias for this publisher, click the link to go to the Remote Servers
screen. From this screen you can set up an alias for the publisher.
See "Seing Up Aliases for Remote Integration Servers" on page
117 for more information.

Local Port

Port number on which the subscriber listens for the publisher to

send the package. This seing determines whether the publisher
uses HTTP or HTTPS.
If you want the publisher to use SSL when sending the
Important:
package to the subscriber, you must specify an HTTPS
port here.

Local Password

Password for the local user name.

Notification Email

E-mail address to notify when the publishing server releases a

package or a package is delivered.

Automatic Pull

Species whether the subscribing server is to automatically pull

the package from the publisher when a new release becomes
available.
If you select Yes, you must also specify the e-mail address of a
user on an e-mail server to which the publishing server should
send a service-invocation e-mail.

webMethods Integration Server Administrators Guide Version 9.10

620

Odd Header
Managing Packages

Field

Description
The subscribing server, through an e-mail port, periodically
checks this e-mail address for a service-invocation e-mail. When
the subscribing server processes the e-mail, it pulls the package.
The service invocation e-mail contains a call to a service that
runs on the subscribing server and loads the package to the
subscribing server's Inbound directory.
For automatic pull to work, you must set up an e-mail port to
listen at the automatic pull address (described below).
For information about seing up an e-mail port, see "Adding an
E-Mail Port" on page 189.

Automatic Pull
Email

E-mail address to which the publishing server is to send a

service-invocation e-mail when a new release of the package
becomes available.
Use a dierent e-mail address for the notication and serviceinvocation e-mails. For example, send notication e-mails to
[email protected] and service
invocation e-mails to [email protected].
For automatic pull to work, you must set up an e-mail port to
listen at this address.
For information about seing up an e-mail port, see "Adding an
E-Mail Port" on page 189.

6. Click Start Subscription.

Important: If you request a subscription to a package that does not exist on the
specied server, or if that server does not own the package (i.e., it is a
subscriber of the package), you will receive an error message, and the
publishing server does not process your subscription.

Updating Your Subscription Information

Use this procedure to update information about your subscription, such as the user
name or password on the subscribing server.
To update your subscription information
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of in the Navigation panel, click Subscribing.
3. Click Update and Unsubscribe from Remote Package.
4. Click Edit in the Update column for the package you want to update.

webMethods Integration Server Administrators Guide Version 9.10

621

Even Header
Managing Packages

5. To change subscription information, enter information in the appropriate elds

below:
Field

Description

Package

Package for which you want to change subscription information.

You can change the package to another package if you do not
already subscribe to or publish the new package. This restriction
exists because you cannot both subscribe to and publish the
same package.

Publisher Alias

Alias assigned to the publisher. The alias denition tells the

subscriber how to connect to the publishing server to register
for a subscription. The alias contains connection information
such as host name or IP address. If you have not already dened
an alias for this publisher, click the link to go to the Remote
Servers screen. From this screen you can set up an alias for
the publisher. See "Seing Up Aliases for Remote Integration
Servers" on page 117 for more information.

Local Port

Port number on which the subscriber listens for the publisher to

send the package. This seing determines whether the publisher
uses HTTP or HTTPS.
If you want the publisher to use SSL when sending the
Important:
package to the subscriber, you must specify an HTTPS
port here.
Note: When the publisher connects to the subscriber, the
publisher uses its default certicate (specied on its
Security Seings screen). Make sure the port you specify
here can accept that certicate.

Local User Name

User as which the publisher will log into the subscriber.

This user must belong to a user group that is assigned to the
Replicators ACL. If you delete the user or change its association
with the Replicators ACL, the publisher cannot send this
package to the subscriber.

Local Password

Password for the local user name.

Notification E-mail

E-mail address to notify when the publishing server releases a

package or a package is delivered.

webMethods Integration Server Administrators Guide Version 9.10

622

Odd Header
Managing Packages

Field

Description

Automatic Pull

Species whether the subscribing server is to automatically pull

the package from the publisher when a new release becomes
available.
If you already have automatic pull congured and want to turn
it o, select No. Then go to the Automatic Pull E-mail eld and
delete the e-mail address there.
If you want to congure your server for Automatic Pull, select
Yes. You must also specify the e-mail address of a user on an
e-mail server to which the publishing server should send a
service-invocation e-mail.
The subscribing server, through an e-mail port, periodically
checks this e-mail address for a service-invocation e-mail. When
the subscribing server processes the e-mail, it pulls the package.
The service invocation-e-mail contains a call to a service that
runs on the subscribing server and loads the package to the
subscribing server's Inbound directory.
For automatic pull to work, you must set up an e-mail port to
listen at the automatic pull address (described below).
For information about seing up an e-mail port, see "Adding an
E-Mail Port" on page 189.

Automatic Pull Email

E-mail address to which the publishing server is to send a

service-invocation e-mail when a new release of the package
becomes available.
Use a dierent e-mail address for the notication and serviceinvocation e-mails. For example, send notication e-mails to
[email protected] and service
invocation e-mails to [email protected].
For automatic pull to work, you must set up an e-mail port to
listen at this address.
For information about seing up an e-mail port, see "Adding an
E-Mail Port" on page 189.

Note:

The publishing server must be running at the time you add the
subscription.

6. Click Submit Changes.

The server updates the information on both the subscribing and publishing servers.

webMethods Integration Server Administrators Guide Version 9.10

623

Even Header
Managing Packages

Canceling a Subscription
When you cancel a subscription, the server sends your cancellation notice to the
publishing server. The publishing server removes your server from the subscription
list for the specied package. If the publisher is not running when you cancel your
subscription, the next time the publisher tries to send the package to your server, the
publisher is informed of the cancellation and automatically deletes the subscription from
its list of subscribers.
Note:

If a subscriber removes a subscription initiated by the publisher, the

subscribing server removes the subscription from its subscriptions list, but the
subscription is not immediately removed from the publisher's list. Instead, the
next time the publishing server tries to send the package to the subscriber, the
publisher is notied of the removal and then deletes the subscription from the
publisher's list.

To cancel your subscription to a package on another server

1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Subscribing.
3. Click Update and Unsubscribe from Remote Package.
4. Locate the package for which you want to cancel the subscription and click the
icon.

About Installing Packages Published by Another Server

When another server publishes a package to your server, you need to install the
published package. You can also perform the following tasks on a package:
Recover a package. If you install a package that has the same name as an
existing package on your server, your server copies the original package to
Integration Server_directory\instances\instance_name \replicate\salvage before it
installs the new one. This lets you easily revert to the previous version if you are
dissatised with the new package. For information about reverting to the earlier
version, refer to "Recovering a Package" on page 599.
Activate a package. You can select whether you want the server to immediately
activate the package after it installs it. If Integration Server does not activate a
package upon installation, Integration Server copies the package to the packages
directory, but it is not available for clients to use. To make this package available for
clients, you must manually activate it. For more information, refer to "Activating a
Package" on page 597.
Archive a package. You can also archive the package automatically
after installing the package. If you choose to archive the package
automatically, Integration Server moves the package from the
Integration Server_directory\instances\instance_name \replicate\inbound directory to
the Integration Server_directory\instances\instance_name \replicate\archive directory.
webMethods Integration Server Administrators Guide Version 9.10

624

Odd Header
Managing Packages

If you do not want to archive a package automatically after installation, you can
archive it later. For more information, see "Archiving a Package" on page 600.
Installing a Package Published by Another Server
When installing a package published by another server, keep the following points in
mind:
A package coming from the publisher already has a List ACL associated with it,
specically, the List ACL that was assigned to the package on the publishing server.
The installing user does not need to be a member of that ACL to install the package;
however, users on the subscribing server must be members of the package's List
ACL in order to display the package on Integration Server Administrator screens.
Important: Be sure the server where you are installing the package has an ACL
with the same name as package's List ACL. If the List ACL does not
exist, no users will be able to display the package on Integration Server
Administrator screens.
If the package you are installing has dependencies on another package that does not
exist on your server, the server will install the package but will not enable it. You will
not be able to enable the installed package until the dependencies are satised.
If the package you are installing is associated with an e-mail listener, the server will
install the package but will not enable the listener. This is because the password
required for the Integration Server to connect to the e-mail server was not sent with
other conguration information about the listener. To enable the listener, go to the
Security > Ports > Edit E-mail Client Configuration Screen and update the Password eld to
specify the password needed to connect to the e-mail server.
When you install a package from another Integration Server, it is possible that an
HTTP URL alias associated with the new package has the same name as an HTTP
URL alias already dened on your Integration Server. If Integration Server detects
a duplicate alias name, it will display load warnings on the Packages > Management >
package_name screen. For more information about duplicate HTTP URL aliases, refer
to "Portability of URL Aliases and Possible Conicts" on page 391.
When you install a package from another Integration Server, it is possible that a port
alias for a port in the new package has the same alias as a port already dened on
your Integration Server. A port alias must be unique across the Integration Server. If
Integration Server detects a duplicate port alias, it will display load warnings on the
Packages > Management > package_name screen. Additionally, Integration Server will
not create the port and will write the following warning to the server.log:
[ISS.0070.0030W] Duplicate alias duplicateAlias encountered creating protocol listener
on port portNumber
Note:

If you want the port to be created when the package is loaded delete the
existing port with that alias, create a new port that has the same properties
as the just deleted port, and then reload the package containing the port

webMethods Integration Server Administrators Guide Version 9.10

625

Even Header
Managing Packages

with the duplicate alias. Integration Server creates the port when the
package is reloaded.
When you install a package released from a version of Integration Server prior to
version 9.5, Integration Server creates an alias for each port associated with the
package. For more information about the port alias created by Integration Server, see
"About the Port Alias" on page 158.
Important: Make sure that packages you install come from a legitimate source, such
as a replication from another server. If you are not sure, check with the
developers in your organization to verify that an authorized person updated
the package. Unknown packages might contain code that could damage
your server.
To install a package that was published from another server
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. Click Install Inbound Releases.
4. Select the package you want to install from the Release file name drop down list.
5. If you want Integration Server to make the package available immediately following
installation, select the Activate upon installation check box in the Option eld.
6. If you want Integration Server to archive the package automatically after installation,
select the Archive upon installation check box. This check box is selected by default.
7. Click Install Release.
Integration Server installs the package and displays a message to that eect.

Using a Package Class Loader

By default, when a service in a package needs to load a class into storage, the package's
class loader defers the search for the class to its parent class loader, which is always the
Integration Server class loader. However, there may be times when you want Integration
Server to use the package's class loader instead. For example, you might want to use a
newer version of a class that exists in the package directory, rather than the version the
Integration Server class loader will access.
For the package class loader to have access to class you want to load, the jar les
containing the class you want load must exist in this directory:
Integration Server_directory\instances\instance_name \packages\packageName \code\jars
directory.

webMethods Integration Server Administrators Guide Version 9.10

626

Odd Header
Managing Packages

To configure Integration Server to use a package class loader

1. Navigate to the Integration Server_directory \instances\instance_name \packages
\packageName directory, where packageName is the name of the package that has the
jar les that you want to load.
2. Add the following property to the manifest.v3 le:
<value name='classloader'>package</value>

3. Reload the package.

4. For more information about how Integration Server loads classes, refer to "How the
Server Loads Java Classes" on page 40.

Hot Deployment of Packages

Hot deployment of packages is the process of seamlessly upgrading custom packages
in Integration Server in a production environment while ensuring that the Integration
Server assets are available for processing without any noticeable downtime. Integration
Server supports hot deployment of packages using Integration Server Administrator as
well as Deployer.
When you deploy a new version of a package, Integration Server unloads the existing
package information from memory and loads new versions of the package and its
contents into its memory. While the package is being upgraded, it is possible that some
assets might be unavailable for some time and this could cause serious issues such as
denial of service or disrupt the in-ight tasks. Hot deployment of packages ensures that
the packages are available at all times, thus, ensuring that there is no downtime, which is
crucial in a production environment.
Traditionally, to upgrade the packages in an Integration Server cluster without shuing
down the entire cluster, a rolling quiesce and upgrade process is used. During the
rolling upgrade of a cluster, each Integration Server in the cluster is individually
quiesced, upgraded, and restarted while the other servers in the cluster continue to
process the requests. The limitation with this approach is that while Integration Server
is quiesced, all the external ports are disabled and Integration Servers will not be in
a state to process requests or execute services. Hot deployment of packages makes it
easier to deploy packages without having to quiesce each Integration Server. In case
of hot deployment, only the assets that are part of or dependent on the packages being
deployed are aected and not the entire server. However, quiesce mode in Integration
Server is essential to perform tasks such as installing xes and performing other
maintenance tasks.

How Hot Deployment Works

When you congure Integration Server to perform hot deployment of packages,
Integration Server employs a block and wait approach. That is, Integration Server
waits for the in-ight tasks that are related to the packages that are being deployed to

webMethods Integration Server Administrators Guide Version 9.10

627

Even Header
Managing Packages

complete before unloading the existing package information from memory. At the same
time, when the hot deployment of packages starts, Integration Server blocks access to the
assets that belong to or have dependency on the packages that are being deployed.
Integration Server ensures that there are no failures in the processing of assets by taking
the following steps:
Wait for all in-ight tasks that are dependent on the packages being deployed to
complete. You can specify the period of time for which Integration Server must
wait for the in-ight tasks to complete before aempting to deploy packages. If the
tasks are not done within the specied timeout period, the hot deployment fails.
Integration Server also provides the option to recover the original packages in case
hot deployment fails, thus ensuring there is no downtime.
Block the execution of assets that belong to or have dependency on the packages that
are being deployed. That is, if a service that is being invoked belongs to a package
that is geing deployed, Integration Server will block the service invocation till
the package is upgraded. When determining the assets that have dependency,
Integration Server will consider only those assets for which you have explicitly
specied the package dependencies.

Determining Package Dependencies during Hot Deployment

To ensure that there is no disruption of in-ight tasks, it is important that you set the
package dependencies correctly. During hot deployment of packages, Integration
Server employs the block and wait approach on all assets in the packages that are being
deployed as well as all its dependents. If you do not set the dependencies, Integration
Server might go ahead with the invocation of an asset, and if the asset is being upgraded
at that time, the invocation could fail with an error.
For example, if you have not explicitly specied FinanceUtil as a dependent package
of the Finance package, Integration Server will not wait for the completion of the
execution of an asset in FinanceUtil package before deploying the Finance package.
This could result in the hot deployment of the package failing. Integration Server will
wait for the completion of the execution of an asset in FinanceUtil package before
hot deploying the Finance package only if you explicitly specify FinanceUtil as
a dependent package of the Finance package. For more information about package
dependencies, see webMethods Service Development Help.

Limitations When Hot Deploying the Packages

There might be a delay in response from those assets that are aected by the hot
deployment of packages because Integration Server blocks the execution of assets
that belong to or have dependency on the packages that are being deployed.
While employing the block and wait approach, if there is a long running task,
Integration Server waits for the task to complete before aempting hot deployment.
If the tasks are not done within the specied timeout period, the hot deployment
fails. To make sure that the hot deployment is done successfully, you must congure

webMethods Integration Server Administrators Guide Version 9.10

628

Odd Header
Managing Packages

the hot deployment timeout value to a value more than the time taken for the task to
complete.
All ports are associated with packages. During hot deployment, when Integration
Server unloads the existing package information from memory, the ports that are
associated with these packages are disabled. These ports will be enabled when the
packages are activated successfully. Therefore, if you are hot deploying a package
that has a port associated with it, access to services using those ports will be aected
while the package is reloaded and activated.

Configuring the Hot Deployment Settings

While performing hot deployment of packages, keep the following points in mind:
Hot deployment can be enabled for the upgrading of custom packages only.
You cannot perform hot deployment for specic assets in a package. The unit of
upgrade is a package. During hot deployment, Integration Server upgrades all the
assets in a package and in case of any errors, Integration Server reverts the packages
to the previous version.
To perform hot deployment of packages, you do not have to quiesce or restart
Integration Server nodes.
If any of the assets in the package that is being deployed is being processed,
Integration Server waits for the processing to complete or for a specied timeout
period, whichever is earlier, before aempting to deploy the package.
If there are any long running tasks that you want to complete before deploying the
packages, make sure that you congure the hot deployment timeout value to a value
more than the time taken for the task to complete.
Integration Server ensures that processes such as HTTP/HTTPS/FTP/FTPS requests,
scheduler tasks, le polling requests, emails, Messaging/JMS requests, and web
service requests continue uninterrupted while performing hot deployment of
packages.
In case the deployment of a new version of package fails, Integration Server provides
the auto recover option using which you can recover the earlier version of the
package.
When you install a package for the rst time in Integration Server, if there is any
error in hot deployment, Integration Server will not be able to automatically recover
the package because a working copy of the package does not exist.
You can use the pub.packages.hotdeployment:cancel service to cancel a hot deployment
operation. For more information, see webMethods Integration Server Built-In Services
Reference.
Hot deployment is not cluster aware. Hot deployment of packages may not happen
at the same time on all the server nodes in a cluster. Also, info and debug messages
related to hot deployment in one server node will not be shared across the cluster
nodes.

webMethods Integration Server Administrators Guide Version 9.10

629

Even Header
Managing Packages

In case of scheduled user tasks, Integration Server assesses the dependency of

packages that are being deployed and permits the completion of any scheduled user
tasks that are already running, and suspends any scheduled user tasks that have not
yet started till hot deployment is complete.
To configure the hot deployment settings
1. In Integration Server Administrator, click Settings > Hot Deployment > Edit Hot
Deployment Settings.
2. Select Yes to enable hot deployment of packages.
3. In the Timeout eld, specify the maximum time in seconds Integration Server should
wait for the in-ight processing to continue before aempting to hot deploy the
packages. The default is 60 seconds.
4. Select Yes for the Auto Recover option, if you want Integration Server to revert to
the previous version of the package in case the deployment of a new version of
the package fails. When you select Yes for the Auto Recover option, Integration
Server copies the original package to the Integration Server_directory \instances
\instance_name \replicate\salvage directory before it deploys the new version. Thus,
in case of any error during hot deployment, Integration Server recovers and reverts
to the original package.
5. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

630

Odd Header
Managing Services

28 Managing Services
About Services ...........................................................................................................................

632

Fully Qualified Service Names ...................................................................................................

632

Finding Information about Services and Folders .......................................................................

634

Manually Adding a Service to the Server ..................................................................................

636

Testing Services .........................................................................................................................

636

Canceling and Killing Threads Associated with a Service .........................................................

637

Running Services When Packages Are Loaded, Unloaded, or Replicated ...............................

638

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

640

Managing Global Variables ........................................................................................................

640

webMethods Integration Server Administrators Guide Version 9.10

631

Even Header
Managing Services

About Services
A service is a server-resident unit of functionality that clients can invoke. A service
might be an entire application or used as part of a larger application. There are several
types of services: ow services (including web service connectors), adapter services, Java
services, and C/C++ services.
You can create all ow services using Software AG Designer. You can create database
ow services from the Integration Server Administrator as well. You can also use
Designer to create adapter services, Java services, or use your own development
environment to create Java and C/C++ services. For more information about the types of
services and how to create them, see webMethods Service Development Help.
You can designate one or more services in a package as a startup, shutdown, or
replication service. A startup service is a service that the server automatically executes
when a package is loaded. A shutdown service is a service that the server automatically
executes when a package is unloaded. A replication service is a service that the server
automatically executes when a package is replicated.
To improve the performance of services, you can have the server cache the service
results. Then, when the server receives subsequent requests for the service, it returns
the cached results rather than executing the service. For more information, see "Caching
Service Results" on page 665.
You can use the scheduling function of Integration Server to schedule services to execute
at times you specify. For more information on scheduling services, see "Scheduling
Services" on page 643.

Fully Qualified Service Names

The fully qualied service name is comprised of two parts: a folder identier and the
service name. The folder identier consists of one or more folder names. The service name
is a single name of the service.
Use a folder to group related services together. When a folder contains other folders,
the nested folders are called subfolders. For example, if you have several services that
involve nancial information, you might create a folder named "Finance" to hold the
services. Within the nancial services, there might be services that are for personal
nances. You might create a subfolder named "Personal" to hold those services.
Use any name for the service name. For example, if one of the nancial services obtains
stock quotes, you might name the service, "StockQuote."
To specify a fully qualied service name, identify the folder portion, then a colon (:),
then the service name:
folder :service

webMethods Integration Server Administrators Guide Version 9.10

632

Odd Header
Managing Services

For example, if the "StockQuote" service is in the "Finance" folder, the fully qualied
service name is:
Finance:StockQuote
If the folder portion identies more than one folder, separate each folder name with a
period.
folder .subfolder1 .subfolder2 :service
For example, if the "HomeLoan" service is in the "Personal" folder, which is contained in
the "Finance" folder, the fully qualied service name is:
Finance.Personal:HomeLoan
The fully qualied name of each service must be unique within the server. In addition, the
fully qualied name of a service cannot be the same as the fully qualied name of any
specication or document type that resides on the server.
Note:

The watt.server.illegalNSChars seing in the server.cnf le (which is

located in the IntegrationServer_directory \instances\instance_name \cong
directory) denes the characters that you cannot use when naming folders
and services. To view or change this seing, use the Settings > Extended screen
from the Integration Server Administrator as described in page "Working
with Extended Conguration Seings" on page 130.

Package Names and Service Names

The relationship between the package name and the folder name can cause confusion.
The name of the package to which a service belongs has no bearing on the names of
the services and folders it contains. Nor does it aect how it is referenced by a client
application. For example, if you move a service called "Personnel:GetDeptNames"
from a package called "Admin" to a package called "EmployeeData" you will not aect
client applications that reference that service; it will still be referenced by the name
"Personnel:GetDepNames."
Because the fully qualied name of each service must be unique within the server, you
cannot have two identically named services in two dierent packages on the same
server.

HTTP URL Aliases for Services

You can create aliases for the HTTP URLs that users specify to invoke services. Aliases
are easier to type than full URL path names, make it easier to move resources on
Integration Server, and are more secure than URL path names, which allow users to see
directory and le names.
You can create an HTTP URL alias from Designer or Integration Server. For more
information, see "Seing Up HTTP URL Aliases" on page 381.

webMethods Integration Server Administrators Guide Version 9.10

633

Even Header
Managing Services

Finding Information about Services and Folders

This section describes how to list the services (and folders) on your server and display
information about a specic service.

Listing Folders and Services

The Folders and Services screens of the Integration Server Administrator list the services
that reside on your server and the folders with which they are associated.
To list folders and services
1. Open the Integration Server Administrator if it is not already open.
2. From the Packages menu in the Navigation panel, click Management.
3. Click Browse Folders.
4. To view the contents of a folder, click the folder name. The server displays another
Folder List screen. For the selected folder, the server displays the subfolders followed
by the services.
You can continue to click on folder names to view subfolders and services in selected
folders.
Note:

The server will only display folders and elements to which you have List
access.

Displaying Information about a Service

The Packages > Management > WmPublic > Services > service screen displays a variety of
information about a selected service or specication.
To display information about a service
1. Open the Integration Server Administrator if it is not already open.
2. From the Packages menu in the Navigation panel, click Management.
3. From the Package List, click the package whose services you want to view.
4. Click Browse Services in packagename .
5. Click the name of the service or specication for which you want to display
information. For a description of the information that Integration Server
Administrator displays for a service, see "Service Information" on page 635.

webMethods Integration Server Administrators Guide Version 9.10

634

Odd Header
Managing Services

Service Information
Integration Server Administrator displays the following information for a service.
Section

Description

General Info

Identies
The folder in which the service is contained and the service
name.
The name of the package with which the service is
associated.
The type of service: Flow, Java, or C/C++.
Whether or not the service is stateless.

Universal Name

The name that will be used to qualify the name of this

service. It consists of the namespace name and the local
name.
By convention, a URI is generally used as the namespace
name (e.g., hp://www.gsx.com/gl). This assures that the
universal name is globally unique.
The local name uniquely identies the service within the
collection encompassed by namespace name. Most sites use
the unqualied portion of the service name as the local name
You may use any sequence of characters or digits for the
namespace name and the local name.

Java-Specific
Parameters

For a Java service, identies the Java class name and method
name for the service.

Access Control

Identies the ACLs assigned to the service or specication.

For information about ACLs, services, and specications, see
"Controlling Access to Resources with ACLs" on page 435.

Cache Control

Identies whether the server is to save the results of

executing this service in cache. For information, see "Caching
Service Results" on page 665.

Data Formatting

Identies the name of a binding service that parses incoming

XML for the service, the output template associated with the
service (if any), and the type of the output template (HTML

webMethods Integration Server Administrators Guide Version 9.10

635

Even Header
Managing Services

Section

Description
or XML). For information about output templates, refer to the
Dynamic Server Pages and Output Templates Developer's Guide.

Manually Adding a Service to the Server

If you have Java or C/C++ services that were not created using Designer or Developer,
you must manually add them to the server using the jcode utility. For more information,
see information about building Java services with your own IDE in webMethods Service
Development Help.

Testing Services
You can use Integration Server Administrator to test the operation of a service. This
allows you to quickly and easily verify the operation of a service and test it with specialcase input values.
Note:

Integration Server Administrator provides a limited testing environment as

you can only specify input values for variables of type String. Designer oers
a more robust environment for testing services.

To test a service
1. Open the Integration Server Administrator if it is not already open.
2. From the Packages menu in the Navigation panel, click Management.
3. From the Package List, click the package whose service you want to test.
4. Click Browse Services in packagename.
5. Click on the name of the service you want to test.
6. To test the service, click Test servicename.
The server displays the Test ServiceName screen.
7. If you want to test the service with input values, ll in the required input
information in the Assign Input Values section of the screen and click Test with inputs.
If you want to test the service without specifying input values, click Test (without
inputs).

webMethods Integration Server Administrators Guide Version 9.10

636

Odd Header
Managing Services

Canceling and Killing Threads Associated with a Service

If you suspect that a ow service or Java service is unresponsive because it is waiting
for an external resource or is in an innite loop, you can stop execution of one or more
threads associated with the service. You have two options:
Cancel the thread. When you cancel a thread, Integration Server frees up resources
that are held by the thread. For example, if a thread is holding a JDBC connection,
Integration Server closes and releases the connection and returns it to the JDBC
connection pool.
Kill the thread. When you kill a thread, Integration Server aempts to free up
resources, but if it cannot, it continues and terminates the thread. Integration Server
replenishes the pool with a new thread.
Integration Server requires you to try canceling a thread before it will allow you to kill a
thread. Once you successfully cancel a thread, you no longer have the option of killing it.
You can cancel or kill threads for user-wrien Java or ow services only; you cannot
cancel or kill threads for Integration Server system services.
Important: You cannot cancel or kill threads for DB stored procedures when Integration
Server is congured to use the 10g or 11g Oracle driver.
When you cancel or kill a thread, Integration Server returns a thread to the global,
trigger, or scheduler thread pool, depending on the function being performed.
Integration Server identies which threads you can cancel or kill by agging them on the
System Threads screen as follows:
Threads that can be canceled are marked with a
Threads that can be killed are marked with an

in the Cancel column.

in the Kill column.

Important: The ability to cancel or kill service threads is controlled by the

wa.server.threadKill.enabled property. If you want to be able to cancel
or kill threads, this property must be set to true, which is the default
seing.
Caution: Use care when canceling or killing threads. Canceling a thread might not
free up resources being held by the service. Killing a thread might put
your resources in an unstable state.

Canceling or Killing a Thread

To cancel or kill a thread associated with a service
1. Open Integration Server Administrator if it is not already open.

webMethods Integration Server Administrators Guide Version 9.10

637

Even Header
Managing Services

2. From the Server menu in the Navigation panel, click Statistics.

3. In the System Threads eld, in the Current column, click the number of current
threads.
Integration Server displays the System Threads screen.
4. To make it easier to locate threads that can be canceled, select the Show threads that
can be canceled or killed at the top of the list check box.
Integration Server dynamically updates the display to show threads that can be
canceled ( in the Cancel column) or killed ( in the Killed column) at the top of the
screen.
5. To display information about a thread, in the Name column for that thread, click the
thread name.
The server displays a dump of that thread. Using the information provided in the
thread dump, determine whether you want to cancel the thread.
To return to the System Threads screen, click Return to System Threads.
6. In the row for the thread you want to cancel, click the

in the Cancel column.

Integration Server prompts you to conrm your action.

If the cancel is
successful...

Integration Server removes the thread from the display.

If the cancel is not

successful...

Integration Server updates the display to show an

the Kill column.
If you want to kill the thread, click the

in

Integration Server prompts you to conrm your action.

If Integration Server is able to kill the thread, it removes
the thread from the display.
If Integration Server is not able to kill the thread, the
thread remains in the display.

Running Services When Packages Are Loaded, Unloaded, or

Replicated
To have the server automatically execute a prescribed set of operations each time
the server loads or unloads a package from memory or replicates a package, you can
identify startup, shutdown, and replication services. This section provides an overview
of startup, shutdown, and replication services.

webMethods Integration Server Administrators Guide Version 9.10

638

Odd Header
Managing Services

To identify these services you must use Designer. For instructions, see webMethods
Service Development Help.

What Is a Startup Service?

A startup service is one that the server automatically executes when it loads a package.
The server loads a package:
At server initialization (if the package is enabled)
When someone uses the Integration Server Administrator to reload a package
When someone uses the Integration Server Administrator to enable a package
Startup services are useful for generating initialization les or assessing and preparing
(e.g., seing up or cleaning up) the environment before the server loads a package.
However, you can use a startup service for any purpose. For example, you might want
to execute a time-consuming service at startup so that its cached result is immediately
available to client applications.

What Is a Shutdown Service?

A shutdown service is one that the server automatically executes when it unloads a
package from memory. If a package is in memory, the server unloads the package:
At server shutdown or restart
When someone uses the Integration Server Administrator to disable the package
Before the server removes the package from memory when someone uses the
Integration Server Administrator to reload a package
Shutdown services are useful for executing cleanup tasks such as closing les and
purging temporary data. You could also use them to capture work-in-progress or state
information before a package unloads.

What Is a Replication Service?

A replication service is one that the server automatically executes when it prepares to
release or archive a package. The service executes when the administrator clicks the
Create Release link on the Packages > Publishing > Create and Delete Releases screen or the
Archive icon
on the Packages > Management screen.
Replication services provide a way for a package to persist state or conguration
information so that this is available when the package is activated on the remote server.

webMethods Integration Server Administrators Guide Version 9.10

639

Even Header
Managing Services

Guidelines for Using Startup, Shutdown, and Replication Services

Keep the following guidelines in mind when using startup, shutdown, and replication
services.
When you create a startup or shutdown service, you must register that service in the
package with which it will be used. When you create a replication service, you can
register any valid service from any loaded package on the server, including the
current package itself.
Because services in a package are not made available to clients until that package's
startup services nish executing, you should avoid implementing startup services
that access busy remote servers. They will delay the availability of other services in
that package.
You may assign one or more startup services to a package; however, you cannot
specify the order in which they will execute. If you have a series of operations that
must execute in a specic order, encode the entire sequence within a single service or
have a startup service invoke others.
See webMethods Service Development Help for instructions.

Running Services in Response to Specific Events

The Event Manager runs on the server, monitoring it for events. An event is a specic
action that the Event Manager recognizes and an event handler can react to. An event
handler is a service a developer writes to perform an action when a specic event occurs.
The Event Manager recognizes a number of dierent events. For example, an alarm event
occurs when the webMethods Integration Server throws an exception regarding the
status or health of the server. The server generates alarm events when a user cannot log
on to the server, a port cannot be started, a user is denied access to a port, and so on.
Developers control the Event Manager through Designer. The server saves information
for event types and event subscriptions in the eventcfg.bin le. This le is generated
the rst time you start an Integration Server and is located in the following directory:
IntegrationServer_directory \instances\instance_name \cong. There is no need for you to
work with this le directly; however, if you are clustering Integration Servers, you need
to copy this le from one server to another to duplicate event subscriptions on all servers
in the cluster. For more information about using the Event Manager, see webMethods
Service Development Help.

Managing Global Variables

Global variables are key/value pairs that you can use in ow services. At design time,
instead of hard coding the values for variables, you can instruct Integration Server to use
global variables.

webMethods Integration Server Administrators Guide Version 9.10

640

Odd Header
Managing Services

To use global variable substitution in ow services, when assigning a value to a pipeline

variable, you must specify the global variable as the value. You must also indicate that
Integration Server should perform variable substitution. Then, at run time Integration
Server substitutes the variables in the ow service with the values assigned to the
respective global variables.
For example, you can dene global variables for input parameters, such as serverhost or
serverport , of pub.client* services. At design time, instruct Integration Server to use global
variables dened for serverhost or serverport as the value of the corresponding variables
in the pipeline. Then, at run time, Integration Server will substitute the variables in the
ow service with the values assigned to serverhost or serverport global variables.
Using global variables makes it easy to change the value assigned to a pipeline variable.
Instead of changing each mapping or ow service, you can change the value assigned to
a variable by changing a single global variable.
For more information about global variable substitution, see webMethods Service
Development Help.

Creating a Global Variable

You can dene global variables using Integration Server Administrator. Integration
Server saves the global variable denitions in Integration Server_directory\instances
\instance_name \cong\globalVariables.cnf.
When you create global variables, keep the following points in mind:
Global variables can only be used to specify values for variables of type String, String
List, and String Table.
Global variable names:
Cannot include any special characters except period (.) and underscore (_).
Can be of a maximum length of 255 characters.
Are case-sensitive.
Must be unique on the Integration Server.
If the global variable you are creating is a password, Integration Server encrypts and
saves it using OPE (outbound password encryption).
When editing a global variable, you can modify only the Value eld.
Global variables must be identical on all Integration Servers in a cluster.
You can deploy global variables by using webMethods Deployer. For information
about using Deployer, see the webMethods Deployer Users Guide.
You can use global variable substitution when debugging a service.
To create a global variable
1. Open Integration Server Administrator.

webMethods Integration Server Administrators Guide Version 9.10

641

Even Header
Managing Services

2. In the Navigation panel, select Settings > Global Variables.

3. Click Add Global Variable.
4. Under Global Variable provide the following information:
For this
parameter...

Specify...

Is Password?

Whether the global variable you are dening is a password.

If the Is Password check box is selected, the text that you enter
in the Value eld is entered as a password, with asterisks
indicating the input instead of characters. Integration Server
encrypts and saves the text that you enter in the Value eld as
an outbound password.

Key

A name for the global variable. Integration Server uses this key
to refer to the global variable while performing global variable
substitution.

Value

Value for the global variable.

5. Click Save Changes.

Deleting Global Variables

You can delete global variable denitions from Integration Server using Integration
Server Administrator. If you delete a global variable that is used by a ow service, while
executing the ow service, Integration Server will throw an exception and stop the
service execution.
To delete a global variable
1. Open Integration Server Administrator.
2. In the Navigation panel, select Settings > Global Variables.
3. Locate the row that contains the key/value pair that you want to delete, and click the
icon.
Integration Server prompts you to conrm that you want to delete the global
variable.
4. Click OK.

webMethods Integration Server Administrators Guide Version 9.10

642

Odd Header
Scheduling Services

29 Scheduling Services
Overview .....................................................................................................................................

644

Scheduling a User Task .............................................................................................................

644

Viewing Scheduled User Tasks .................................................................................................

649

Updating Scheduled User Tasks ................................................................................................

651

Suspending User Tasks .............................................................................................................

651

Resuming Suspended User Tasks .............................................................................................

652

Canceling a Scheduled User Task .............................................................................................

654

Viewing the Scheduled System Tasks .......................................................................................

654

Simple Repeating Option ...........................................................................................................

654

Complex Repeating Option ........................................................................................................

656

Target Node Options ..................................................................................................................

660

How Transitioning to or from Daylight Savings Time Affects Scheduled Tasks .........................

webMethods Integration Server Administrators Guide Version 9.10

662

643

Even Header
Scheduling Services

Overview
Use the server's scheduling function to schedule services to execute at times you specify.
Services that you schedule are referred to as user tasks. You can:
Create user tasks that Integration Server executes:
A single time
Repeatedly at a simple interval, for example hourly every day
Repeatedly at a complex interval, for example every other Tuesday in June
View a list of scheduled tasks.
Update scheduling options for existing user tasks.
Cancel a scheduled user task before Integration Server completes all scheduled
executions.
Temporarily suspend a task's execution.
Create user tasks that run on one, any, or all Integration Servers connected to the
same database.
Specify an action Integration Server is to take if a task has missed its scheduled
execution time.
Note:

In addition to using Integration Server Administrator to schedule tasks,

you can also perform scheduling by using a set of built-in services. See
the webMethods Integration Server Built-In Services Reference for more
information.

Tasks Provided by Integration Server

Integration Server provides user tasks that you can modify. For example, Integration
Server supplies the Message History Sweeper task if you congured a document
history database for exactly-once processing. This task removes expired entries from the
document history database. Even though Integration Server scheduled this task, you can
modify how often the service runs.
In addition to the scheduled user tasks that you set up, Integration Server schedules
system tasks that it performs for normal system operation. You can view, but not update
or cancel, most scheduled system tasks.

Scheduling a User Task

Use the following procedure to schedule a user task.

webMethods Integration Server Administrators Guide Version 9.10

644

Odd Header
Scheduling Services

To schedule a user task

1. Open the Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Scheduler.
3. Click Create a Scheduled Task.
4. Set the Service Information parameters as follows:
For this parameter

Specify...

Description

A description of the task.

folder.subfolder:service

The fully qualied service name of the service you

want Integration Server to execute.
Click Assign Inputs to enter new input values or
modify existing values for the service you want
Integration Server to execute.
Before assigning input values, note that:
You can only assign values for top-level input
parameters of data type String.
Assigning input values using Assign Inputs
overwrites any input values assigned to a service
using the built-in services in thepub.schedulerfolder.
For information about specifying service names, see
"Fully Qualied Service Names" on page 632.

Run As User

The user name you want the server to use when

running the service. Click
to search for and select
your user. A user can be selected from the local or
central directory.
Integration Server runs the service as if the user you
specify is the authenticated user that invoked the
service. If the service is governed by an ACL, be sure
to specify a user that is allowed to invoke the service.

Target Node

Whether you want the task to run on other

Integration Servers connected to the same database:
Select Any server if the task needs to run on only one
server connected to the database, and it does not
maer which one.

webMethods Integration Server Administrators Guide Version 9.10

645

Even Header
Scheduling Services

For this parameter

Specify...
For clustered servers only. Select All servers if the
task needs to run on all Integration Servers in the
cluster.
Select the name from the list of Integration Servers
connected to the database if the task needs to run on
only a specic server.
The default is the current Integration Server.
For more information about the Target Node options,
see "Target Node Options" on page 660.

5. Select an action to perform If the Task Is Overdue.

This parameter...

Specifies that Integration Server should...

Run
immediately

Run the task immediately, no maer how late the task is.

Skip and run at

next scheduled
time

Skip this execution of the task, and run it again at the next
scheduled run time. This option is not available for tasks that
run just once.

Suspend

Place the task in a suspended state until an administrator

resumes or cancels the task.

Integration Server periodically checks the status of scheduled tasks. If it nds a task
that should have started but has not, Integration Server runs the task immediately,
unless you have specied a special action to take for late tasks. Integration Server
performs this "late action" if the task has missed its scheduled start time by a number
of minutes you specify in the if more than xxx minutes late eld.
Note:

The maximum number of minutes that the if more than xxx minutes late eld
can accept is 35000.

For tasks that are late but do not exceed the specied period, Integration Server runs
the task immediately.
6. Select Run Once, Repeating, or Complex Repeating to indicate when and how often you
want Integration Server to execute the service.
Select...

To...

Run Once

Schedule a task to run just once. Specify the following:

webMethods Integration Server Administrators Guide Version 9.10

646

Odd Header
Scheduling Services

Select...

To...
Date. The date on which you want Integration Server
to execute the service.
Enter the date using the format YYYY/MM/DD. For
example, if you want the server to execute the service
on March 11, 2010, specify 2010/03/11.
Time. The time at which you want Integration Server
to execute the service.
Enter the time using the format HH:MM:SS (using a
24-hour clock). For example, if you want Integration
Server to execute the service at 1:00:00 a.m., specify
1:00:00; if you want Integration Server to execute the
service at 1:00:00 p.m., specify 13:00:00.

Repeating

Schedule simple repeating tasks, for example once a

day at a specic time. Specify the following
Start Date and Start Time. The date and time of the rst
execution.
For Start Date, use the format YYYY/MM/DD. For Start
Time, use the format HH:MM:SS (using a 24-hour
clock).
For example, if you want the service executions
to start on May 3, 2010 at 1:00:00 p.m., specify
2010/05/03 for Start Date and 13:00:00 for Start Time.
End Date and End Time. The date and time of the last
execution.
For End Date, use the format YYYY/MM/DD. For the
End Time, use the format HH:MM:SS (using a 24-hour
clock).
For example, if you want the service executions to
stop on June 4, 2010 at 2:00:00 a.m., specify 2010/06/04
for End Date and 02:00:00 for End Time. Omiing End
Date indicates that you want this service to execute
for an indenite period of time. If you omit End Time,
Integration Server uses the current time.
Interval. Execution interval.
Enter the number of seconds that you want
Integration Server to wait between executions of the
service.

webMethods Integration Server Administrators Guide Version 9.10

647

Even Header
Scheduling Services

Select...

To...
Repeat after completion. Whether to wait for the
previous execution of the service to complete before
starting the next.
For example, suppose the GetData service is
scheduled to run every minute, but sometimes takes
longer than that to complete. By default, Integration
Server will start the next execution even though the
previous one has not yet completed.
If you check the Repeat after completion box, Integration
Server will wait for the service to complete before
running the next execution of the service. Executions
that could not run while the service was executing are
delayed.
For more information about using the Repeating
option, see "Simple Repeating Option" on page 654.

Complex Repeating

Schedule a task that repeats at a more complex interval,

for example, every other day, or twice a month. Specify
the following:
Start Date and Start Time. The date and time of the rst
execution.
For Start Date, use the format YYYY/MM/DD. For Start
Time, use the format HH:MM:SS (using a 24-hour
clock).
For example, if you want the service executions
to start on May 3, 2010 at 1:00:00 p.m., specify
2010/05/03 for Start Date and 13:00:00 for Start Time.
If you omit the Start Date, the rst execution occurs on
the rst date as indicated by the Run Mask parameters.
If you omit Start Time, the server uses the current time.
End Date and End Time. The date and time of the last
execution.
For End Date, use the format YYYY/MM/DD. For the
End Time, use the format HH:MM:SS (using a 24-hour
clock).
For example, if you want the service executions to stop
on June 4, 2010 at 2:00:00 a.m., specify 2010/06/04 for
End Date and 02:00:00 for End Time. Omiing End Date
indicates that you want this service to execute for an

webMethods Integration Server Administrators Guide Version 9.10

648

Odd Header
Scheduling Services

Select...

To...
indenite period of time. If you omit End Time, the
server uses the current time.
Run Mask. Specic months, dates (1-31), days of the
week (Sunday-Monday), hours, minutes, and seconds
when you want a task to run. You can select one or
more items from each category. To select multiple
items, press the Ctrl key while making your selections.
If you do not select any items from a category,
Integration Server assumes all items for the selection.
Repeat after completion. Whether to wait for the
previous execution of a service to complete before
starting the next.
For example, suppose the GetData service is
scheduled to run every minute, but sometimes takes
longer than that to complete. By default, Integration
Server will start the next execution even though the
previous one has not yet completed.
If you check the Repeat after completion box, the server
will wait for the service to complete before running
the next execution of the service. Executions that could
not run while the service was running are delayed.
For more information about using the Complex
Repeating options see "Complex Repeating Option" on
page 656.

Note:

Integration Server does not skip or repeat the scheduled tasks because of
transitions to and from Daylight Saving Time. For more information about
how Integration Server handles transitioning to and from Daylight Saving
Time, see "How Transitioning to or from Daylight Savings Time Aects
Scheduled Tasks" on page 662.

7. Click Save Tasks.

Viewing Scheduled User Tasks

Note:

If your Integration Server runs as part of a group of servers connected to the

same database, all tasks will be visible from the Server > Scheduler screens of all
Integration Servers connected to the database.

webMethods Integration Server Administrators Guide Version 9.10

649

Even Header
Scheduling Services

To view scheduled user tasks

1. Open the Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Scheduler.
The Server Scheduler screen displays the list of scheduled user tasks. Integration
Server automatically deletes the expired scheduled user tasks from the Server
Scheduler screen. If you do not want Integration Server to delete the expired tasks
until the next server restart, set the wa.server.scheduler.deleteCompletedTasks
parameter to false. For more information about this parameter, see "Server
Conguration Parameters" on page 851.

Filtering the List of Scheduled Tasks

By default, the Server > Scheduler screen lists all the user-dened tasks that are scheduled
to run. You can use the lter to limit the tasks to be displayed, making the list shorter
and more manageable.
To filter the list of scheduled tasks
1. In the Server menu of the Navigation panel, click Scheduler. The list of user-dened
tasks will be displayed.
2. Click Filter Services. The ltering options will appear above the list of user tasks.
Note:

When Filter Services is enabled, any changes to the Integration Server (such
as new tasks, etc.) will not be reected in the list of scheduled tasks. When
you click Show All Services and return to normal mode, the list will be
updated.

3. Select some or all of the following options:

Option

Description

Service Name

The string you want to submit to the lter. Filter

criteria can be literals or a combination of literal
and wild-card characters. The "*" (asterisk) and
"?" (question mark) are the only supported wild-card
characters. Leaving the lter criteria blank includes all
services.
The service names in the Service Name eld are casesensitive. For example, if you enter "Wm*", the lter
will ignore any services beginning with "wm".

Status Is Active

Controls whether only active services are displayed. If

not checked, services with all statuses are displayed.

webMethods Integration Server Administrators Guide Version 9.10

650

Odd Header
Scheduling Services

Option

Description

Hide Remote Tasks

Controls whether only tasks that run on the current

server are displayed. This also includes tasks scheduled
to run on the server when the Target Node is set to run
on All servers in the cluster or Any server connected to
the database. Tasks scheduled to run only on other
servers are not displayed.

Updating Scheduled User Tasks

Note:

If your Integration Server is part of a cluster and you are updating the
characteristics of a task that has been scheduled to run on all Integration
Servers in the cluster, you must make the changes to the parent task. For more
information about scheduled tasks that run on all servers in a cluster, see
"Target Node Options" on page 660.

To update a scheduled user task

1. Open the Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Scheduler.
3. Click the service name for the user task you want to update.
4. Update the scheduling options for the selected user task. For information about the
options you can specify, see "Scheduling a User Task" on page 644.
5. Click Update Tasks.

Suspending User Tasks

You can suspend a single user task or all the scheduled user tasks in an Integration
Server.

Suspending a Single User Task

When you suspend a user task, it remains scheduled, but does not execute until you
resume its execution. If a task expires while suspended, the server marks it Expired.
Note:

If your Integration Server is part of a cluster and you are suspending a task
that has been scheduled to run on all Integration Servers in the cluster, you
can suspend the child tasks individually or you can suspend all the tasks at
once by suspending the parent task. For more information about scheduled

webMethods Integration Server Administrators Guide Version 9.10

651

Even Header
Scheduling Services

tasks that run on all servers in a cluster, see "Target Node Options" on page
660.
To suspend a scheduled user task
1. Open the Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Scheduler.
3. Locate the task in the Services list, and click the
icon in the Status column to
suspend the task. The server displays a screen to conrm you want to suspend the
task. Click OK. The server replaces the
icon with Suspended to indicate that the
task is now suspended.

Suspending All User Tasks

Suspending the tasks aects only the scheduled user tasks and not system tasks.
When you suspend all the scheduled user tasks in an Integration Server:
Integration Server will not initiate any scheduled user tasks. However, you can
schedule new tasks and perform other task-specic actions.
The scheduled user tasks that are currently running will continue to execute.
The suspend action will not aect the system tasks and they will continue to run.
To suspend all scheduled user tasks
1. Open Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Scheduler.
3. Click Pause Scheduler. Integration Server displays a message prompting you to
conrm that you want to suspend the tasks. Click OK.
Integration Server will initiate the scheduled user tasks only after you have resumed
the tasks.

Resuming Suspended User Tasks

You can resume all scheduled executions of a user task that you have suspended. You
can also resume the execution of all the scheduled user tasks in an Integration Server.

Resuming a Suspended User Task

Perform the following procedure to resume all scheduled executions of a task that has
been suspended.
Note:

If your Integration Server is part of a cluster and you are resuming a task that
has been scheduled to run on all Integration Servers in the cluster, you can

webMethods Integration Server Administrators Guide Version 9.10

652

Odd Header
Scheduling Services

resume the child tasks individually or you can resume all the tasks at once by
resuming the parent task. For more information about scheduled tasks that
run on all servers in a cluster, see "Target Node Options" on page 660.
To resume execution of a suspended user task
1. Open the Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Scheduler.
3. Locate the task in the Services list, and click Suspended in the Active column to
activate the task. The server displays a screen to conrm you want to resume the
task. Click OK.
The server replaces Suspended with the Active
available to execute again.

icon to indicate that the task is

Resuming All Suspended User Tasks

When you resume the execution of all the scheduled user tasks in an Integration Server:
Integration Server will start initiating the scheduled user tasks again.
If any of the scheduled user tasks that were running when the tasks were suspended
are still running, they will continue to execute.
Individual tasks that you have suspended by clicking the
icon in the Status
column will remain suspended until you specically activate it.
To resume all scheduled user tasks
1. Open Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Scheduler.
3. Click Resume Scheduler. Integration Server displays a message prompting you to
conrm that you want to resume the initiation of tasks. Click OK.
Integration Server will proceed to initiate the scheduled user tasks.
Important: If a task misses its scheduled execution time because the execution of
tasks was suspended at that time, the next execution of the task depends
on the value of the If the Task Is Overdue seing. Based on this seing,
Integration Server will start the task as soon as you resume the initiation
of tasks, skip this execution of the task, or suspend the task and wait for
administrator action. For more information, see "Scheduling a User Task"
on page 644.

webMethods Integration Server Administrators Guide Version 9.10

653

Even Header
Scheduling Services

Canceling a Scheduled User Task

When you cancel a scheduled task, the server permanently removes it from the database
that holds the job queue.
Note:

If your server is part of a cluster and you are canceling a task that has been
scheduled to run on all servers in the cluster, you can cancel the child tasks
individually or you can cancel all the tasks at once by canceling the parent
task. For more information about scheduled tasks that run on all servers in a
cluster, see "Target Node Options" on page 660.

To cancel a scheduled user task

1. Open the Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Scheduler.
3. Click the
icon in the Remove column for the user task you want to cancel. The
server issues a prompt to verify that you want to cancel the user task. Click OK.

Viewing the Scheduled System Tasks

Integration Server needs to perform system tasks periodically, such as expiring sessions.
Integration Server schedules these tasks automatically.
To view the scheduled system tasks
1. Open the Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Scheduler.
3. Click View system tasks.
The server displays the View System Tasks screen. It lists the names of each scheduled
task, the next date and time the server is to execute the task, and how often (Interval)
the server is to execute the task.
Note:

The View System Tasks screen shows the tasks for local server only; if you
are running a group of servers connected to the same database, you will
not see the system tasks for other servers connected to the database.

Simple Repeating Option

When you use the simple repeating option, the service repeats based on a time interval
you specify.

webMethods Integration Server Administrators Guide Version 9.10

654

Odd Header
Scheduling Services

Setting

Indicates...

Start Date

The date on which you want the server to execute the service
for the rst time. Use the format YYYY/MM/DD to specify
the date. If you leave this eld blank, the server starts the task
on the current day

Start Time

The time at which you want the server to begin executing the
service. Use the format HH:MM:SS to specify the time (using
a 24-hour clock). If you leave this eld blank, the server starts
the task immediately.

End Date

The date on which you want the server to execute the service
for the last time. Use the format YYYY/MM/DD to specify
the date. If you leave this eld blank, the server executes the
service for an indenite period of time or until you cancel the
scheduled user task.

End Time

The time on the last date at which you want the server to
execute the service. Use the format HH:MM:SS to specify the
time (using a 24-hour clock). If you leave this eld blank, the
server uses the current time.

Repeating/ Repeat
after Completion

Whether Integration Server should wait for the previous

execution of a service to complete before starting the next.
For example, suppose the GetData service is scheduled to
run every minute, but sometimes takes longer than that to
complete. By default, the server will start the next execution
even though the previous one has not yet completed. If you
check the Repeat after completion box, Integration Server will
wait for the service to complete before running the next
execution of the service. Executions that could not run while
the service was executing are delayed.

Interval

Time interval, in seconds, at which you want the service to

execute. For example, if you want the server to execute the
service every 24 hours, specify 86400 seconds for the interval.

The following example shows how to use the Simple Repeating option seings:
If you want the service to execute...

For this setting:

Specify...

Every hour on July 1st in the year

2010.

Start Date

2010/07/01

webMethods Integration Server Administrators Guide Version 9.10

655

Even Header
Scheduling Services

If you want the service to execute...

For this setting:

Specify...

Start Time

00:00:00

End Date

2010/07/01

End Time

00:00:00

Interval

3600

Complex Repeating Option

With the Complex Repeating option, the service repeats based on complex intervals that
you specify. This option oers the greatest exibility for specifying when you want a
service to execute.
Specify any combination of the following seings to indicate when and how often you
want the service to execute:
Setting

Indicates...

Start Date

The date on which you want the server to execute the service
for the rst time. Use the format YYYY/MM/DD to specify
the date. If you leave this eld blank, the server executes the
task at the rst date specied by the remaining seings.

Start Time

The time at which you want the server to begin executing the
service. Use the format HH:MM:SS to specify the time (using
a 24-hour clock). If you leave this eld blank, the server uses
the current time.

End Date

The date on which you want the server to execute the service
for the last time. Use the format YYYY/MM/DD to specify
the date. If you leave this eld blank, the server executes the
service for an indenite period of time or until you cancel the
scheduled user task.

End Time

The time on the last date at which you want the server to
execute the service. Use the format HH:MM:SS to specify the
time (using a 24-hour clock). If you leave this eld blank, the
server uses the current time.

webMethods Integration Server Administrators Guide Version 9.10

656

Odd Header
Scheduling Services

Setting

Indicates...

Repeating/ Repeat
after Completion

Whether Integration Server should wait for the previous

execution of a service to complete before starting the next.
Note: Integration Server does not count half-nished service
executions as completed tasks. If a task fails before
completing, Integration Server considers that task as
overdue. The next execution of the task depends on
whatever action is set for the If the Task is Overdue option.
For more information, see "Scheduling a User Task" on
page 644
If you want Integration Server to wait for a service to
complete execution before it starts the next scheduled
execution of the service, check this box.
For example, suppose the GetData service is scheduled to
run every minute, but sometimes takes longer than that
to complete. By default, the Integration Server will start
the next execution even though the previous one has not
yet completed. If you check the Repeat after completion box,
Integration Server will wait for the service to complete before
running the next execution of the service. Executions that
could not run while the service was executing are delayed.

Run Mask

Specic months, days (1-31), days (Sunday-Saturday), hours,

and minutes you want the service to run.
You can select one or more items from each category. To
select multiple items, press the Ctrl key while making your
selections. If you do not select any items from a category,
Integration Server assumes all items for the selection. For
example, if you do not specify a month, Integration Server
assumes you want the service to execute every month. If you
do not select any items for any of the seings, the Integration
Server assumes you want the service to execute every month,
every day, all week days, every hour, and every minute; in
other words, the service runs every minute from the time you
add the task.

Integration Server combines all your selections to determine when to execute the service.
The following shows examples of how to use the Complex option seings:

webMethods Integration Server Administrators Guide Version 9.10

657

Even Header
Scheduling Services

If you want the service to execute...

For this setting:

Specify...

The 28th day of every month at

midnight for the year 2010.

Start Date

2010/01/01

Start Time

00:00:00

End Date

2010/12/31

End Time

00:00:00

Months

no selection

Month Days

28

Week Days

no selection

Hours

Minutes

Start Date

leave blank

Start Time

leave blank

End Date

leave blank

End Time

leave blank

Months

January, February,
March

Month Days

no selection

Week Days

Monday

Hours

14

Every Monday in the months

of January, February, and
March at 2:30 p.m. for an
indenite period of time.

webMethods Integration Server Administrators Guide Version 9.10

658

Odd Header
Scheduling Services

If you want the service to execute...

Every hour of every Tuesday of

the month of June, 2010.

Every minute of every hour of

every Tuesday of the month of
June, 2010.

For this setting:

Specify...

Minutes

30

Start Date

2010/06/01

Start Time

00:00:00 (or leave blank)

End Date

2010/06/30

End Time

00:00:00 (or leave blank)

Months

June

Month Days

no selection

Week Days

Tuesday

Hours

no selection

Minutes

Start Date

2010/06/01

Start Time

00:00:00 (or leave blank)

End Date

2010/06/30

End Time

00:00:00 (or leave blank)

Months

June

Month Days

no selection

Week Days

Tuesday

Hours

no selection

Minutes

no selection

webMethods Integration Server Administrators Guide Version 9.10

659

Even Header
Scheduling Services

Target Node Options

If you are running a group of servers connected to the same database (clustered or nonclustered), you can control on which server a task runs. You can specify that a task run
on the current server, another specic server, all servers in a cluster, or any servers
connected to the database:
Setting

Indicates...

<specic_server >

The task runs only on the server you specify.

Any server

The task runs on any server connected to the database. Use

this option if the task only needs to run on one server and
it doesn't maer which one. For example, in a clustered
environment, if all servers in the cluster share a single
database for a parts inventory application, and a particular
function needs to run on that database once a day, any server
in the cluster can perform that function. The Any server option
is the default seing when clustering is enabled.
Note: The Any server option does not specify an order in which
servers are used to execute tasks. In other words, no
load balancing is performed. Instead, an instance of
the scheduler runs on each server connected to the
database. Periodically, each instance checks the database
in which information about scheduled jobs is stored.
The rst scheduler instance to nd a task that is due
to start runs it, then marks the task as complete in the
database where information about scheduled jobs is
stored. The scheduler instances running on the other
servers connected to the database then know not to run
the task. This behavior will not change if you install a
third-party load balancer.

All servers

For clustered Integration Servers only. If you select All

servers, the task runs on all servers in the cluster. For
example, suppose you run an application on each server in
the cluster, and each server maintains its own database for
that application. If you need to run a cleanup task against
all the databases every day, then from one server you can
schedule a task to run every day on all the servers in the
cluster.
When you schedule a task to run on all servers in the cluster,
the server divides the task into a main or parent task, and
a child task for each server in the cluster. See "Tasks in a

webMethods Integration Server Administrators Guide Version 9.10

660

Odd Header
Scheduling Services

Setting

Indicates...
Clustered Environment" on page 661 below for more
information about these tasks.

Tasks in a Clustered Environment

When you schedule a task to run on all servers in the cluster, the server divides the task
into a main or parent task, and a child task for each server in the cluster.
You might see dierent statuses among the parent and child tasks. For example, you
might have a situation where the parent status is Active, one child status is Active,
and the other child status is Suspended. In general, the status of the parent task will
be Active if at least one child task is active or running, Suspended if all child tasks are
suspended, or Expired, if all child tasks are expired.
Although you can perform some actions (activate, suspend) individually on the child
tasks, if you want to change the characteristics of a task, you must do so through the
parent task.
To keep the parent and child tasks in synch, Integration Server automatically updates
child tasks when you:
Change the parent task. For example, if you change the end date of the parent task,
Integration Server will automatically change the end date in the associated child
tasks.
Add or delete a cluster node. For example, if you add another Integration Server to
your cluster, Integration Server automatically creates a child task for that node at
Integration Server startup.
Delete a child task. For example, if you delete a child task for a cluster node that still
exists, Integration Server will automatically recreate the child task at Integration
Server startup, or when you update the parent task.
The following picture shows how Integration Server Administrator displays parent and
child tasks on the Server > Scheduler screen.

webMethods Integration Server Administrators Guide Version 9.10

661

Even Header
Scheduling Services

Tasks in a Clustered Environment

Note:

When using the Scheduler in a cluster of Integration Servers, you can ensure
that repeating and complex tasks run at the desired times by synchronizing
the system clocks of all the servers.

How Transitioning to or from Daylight Savings Time Affects

Scheduled Tasks
The scheduled tasks in Integration Server are not skipped or repeated because of
transitions to and from Daylight Saving Time (DST).
When transitioning to DST, the system clock time is advanced by one hour.
However, Integration Server will not skip the scheduled tasks that were scheduled to
be run during the hour that is skipped because of transitioning to DST. If a task was
scheduled to run in the hour that was skipped, Integration Server will run the task
in the ensuing hour. For example, if you have scheduled a task to run at 1:30:00 a.m.
and if system clock time transitions to DST at 1:00:00 a.m., Integration Server will
process the task at 2:30:00 a.m. system clock time.
When transitioning from DST, the system clock time is set back one hour. However,
if Integration Server has already executed a task in the hour before the change from
DST to standard time, Integration Server does not repeat that task again when the
hour is repeated because of transitioning from DST. For example, if a task is executed
at 1:30:00 a.m. and if the system clock time transitions to DST at 2:00:00 a.m., which
sets the clock back to 1:00:00 am, Integration Server does not process the task again at
1:30:00 a.m.
The simple and complex repeating tasks are unaected by the transitions to and
from DST. Integration Server processes the repeating tasks at the specied intervals.

webMethods Integration Server Administrators Guide Version 9.10

662

Odd Header
Scheduling Services

That is, if a task is scheduled to run every hour, Integration Server will execute the
task at hourly intervals regardless of the system clock time.

webMethods Integration Server Administrators Guide Version 9.10

663

Even Header

webMethods Integration Server Administrators Guide Version 9.10

664

Odd Header
Caching Service Results

30 Caching Service Results

What Is Caching? .......................................................................................................................

666

When Are Cached Results Returned? ......................................................................................

666

Resetting the Cache ..................................................................................................................

668

Monitoring Service Cache Usage ..............................................................................................

669

Changing the Service Results Cache to Return a Value Instead of a Reference ......................

webMethods Integration Server Administrators Guide Version 9.10

669

665

Even Header
Caching Service Results

What Is Caching?
Caching is an optimization feature that can improve the performance of services.
You indicate the services for which you want to use caching from Software AG Designer.
When you enable caching for a service, Integration Server saves the entire contents of the
pipeline after invoking the service in a local cache for the period of time that you specify.
The pipeline includes the output elds explicitly dened in the cached service, as well
as any output elds produced by earlier services in the ow. When Integration Server
receives subsequent requests for a service with the same set of input values, Integration
Server returns the cached result to the client instead of invoking the service again.
Caching can signicantly improve response time of services. For example, services
that retrieve information from busy data sources such as high-trac commercial web
servers could benet from caching. Integration Server can cache the results for all types
of services: ows, Java services, and C/C++ services.
The goal for caching is to strike the right balance between data concurrency and memory
usage. To gauge the eectiveness of your cache, you can monitor its performance by
viewing service statistics from the Integration Server Administrator and adjust your
caching values accordingly.
You set the controls for caching a service from Designer. For more information on
conguring a service's use of cache, see webMethods Service Development Help.

When Are Cached Results Returned?

When you enable caching for a service in Software AG Designer, Integration Server
handles the cached results dierently, depending on whether the service has input
parameters. It is recommended that a cached service has input parameters.
When a cached service has input parameters, at run time Integration Server scopes the
pipeline down to only the declared input parameters of the service. Integration Server
compares the scoped-down inputs to the previously stored copy of the inputs. If a
cached entry exists with input parameters that have the same values, Integration Server
returns the cached results from the previous service invocation.
Note:

If a cached entry with input parameter values that are identical to the current
invocation does not exist in the cache, Integration Server executes the service
and stores the results in the cache.

webMethods Integration Server Administrators Guide Version 9.10

666

Odd Header
Caching Service Results

Pipeline Inputs Are Compared to the Cached Copy at Run Time

When a cached service does not have input parameters (for example, a date/time service)
and previous results do not exist in the cache, at run time Integration Server executes the
service and stores the results. When the service executes again, Integration Server uses
the cached copy. In other words, Integration Server does not use the run-time pipeline
for the current service invocation; you will always receive cached results until the cache
expires.
Note:

When returning cached results for a service, by default, Integration Server

returns a referenced to the cached results instead of the actual value of the
cached results. If a subsequent step in the service modies the returned
result, Integration Server changes the cached value as well, which aects
all references to the cached value. If any other service uses the cached
results, those services will begin using the updated cache value. To congure
Integration Server to return the actual value instead of a reference, you need
to modify the service results cache. For information about modifying the
service results cache to return values instead or references, see "Changing
the Service Results Cache to Return a Value Instead of a Reference" on page
669.

Important: If a cached service input signature includes a Document Reference or

Document Reference List variable and the referenced document type
changes or is modied, you must reset the service cache. If you do not reset
it, Integration Server uses the old cached input parameters at run time until
webMethods Integration Server Administrators Guide Version 9.10

667

Even Header
Caching Service Results

such time as the cached results expire. You can reset the cache from Designer
or Integration Server Administrator. For more information about reseing
service cache from Integration Server Administrator, see "Reseing the
Cache" on page 668.

Resetting the Cache

You can reset the cache for all services or you can reset the cache for a specic service.
Note:

Integration Server resets the cache for a service automatically whenever any
edits are made to the service. However, if the input signature includes a
document reference variable and the referenced document type changes, you
must reset the service cache. If you do not reset it, Integration Server uses the
old cached input parameters at run time until such time as the cached results
expire.

Resetting the Cache for All Services

When Integration Server resets the cache for all services, it removes all cached service
results for all services from memory.
To reset the cache for all services
1. Open the Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Service Usage.
3. Click Reset Server Cache to reset the caches of all the listed services.

Resetting the Cache for a Specific Service

When Integration Server resets the cache for a service, it removes the cached service
results for that service from memory.
To reset the cache for a specific service
1. Open the Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Service Usage.
3. Select the name of the service for which you want to reset the cache. An information
screen for that service appears.
4. Click Reset Service Cache.

webMethods Integration Server Administrators Guide Version 9.10

668

Odd Header
Caching Service Results

Monitoring Service Cache Usage

Use the following procedure to monitor the performance of the service cache.
To monitor the performance of your cache
1. Open the Integration Server Administrator if it is not already open.
2. In the Server menu of the Navigation panel, click Service Usage.
The Service Usage screen displays the current results of cache control seings for each
cache-controlled service. By default Integration Server Administrator displays the
services in alphabetical order.
Tip:

Select the Show running services on top check box to display all the currently
running services in the Integration Server together at the top of the screen.
Currently running services are identied by a number in brackets at the
right of the service name. The number identies how many instances of
the service, if any, are currently running.

Changing the Service Results Cache to Return a Value

Instead of a Reference
When returning cached results for a service, by default, Integration Server returns a
referenced to the cached results instead of the actual value of the cached results. If a
subsequent step in the service modies the returned result, Integration Server changes
the cached value as well, which aects all references to the cached value. If any other
service uses the cached results, those services will begin using the updated cache value.
You can address this issue in one of the following ways:
Make sure ow services do not modify cached service results.
Change the ServiceResults cache to return the actual cached value instead of just the
reference to the cached value.
The following procedure explains how to change the ServiceResults cache to return a
value instead of a reference to a value.
To change the ServiceResults cache to return a value instead of a reference
1. Open the following le in a text editor:
Integration Server_directory/instances/instance_name /cong/Caching/SoftwateAG-ISServices.xml
2. In the cache element, add the following aributes:
copyOnWrite=true

webMethods Integration Server Administrators Guide Version 9.10

669

Even Header
Caching Service Results

copyOnRead=true

For example:
<cache
name="ServiceResults"
eternal="true"
maxEntriesLocalHeap="1000"
maxEntriesLocalDisk="1000"
copyOnWrite=true
copyOnRead=true
cacheLoaderTimeoutMillis="30000">
<persistence strategy="none"/> </cache>

3. Save your changes.

4. Restart Integration Server.

webMethods Integration Server Administrators Guide Version 9.10

670

Odd Header
Configuring Guaranteed Delivery

31 Configuring Guaranteed Delivery

About Guaranteed Delivery ........................................................................................................

672

Configuring the Server for Guaranteed Delivery .......................................................................

673

Administering Guaranteed Delivery ...........................................................................................

677

webMethods Integration Server Administrators Guide Version 9.10

671

Even Header
Configuring Guaranteed Delivery

About Guaranteed Delivery

Use the guaranteed delivery capabilities of Integration Server to ensure guaranteed onetime execution of services.
Integration Server guaranteed delivery capabilities ensure that the following occur
despite transient failures:
Requests to execute services from clients are delivered to the server
Services are executed once, and only once
Responses from the execution of the services are delivered to the client
The webMethods guaranteed delivery capabilities protect against transient failures that
might occur on the network, in the client, or on the server. A transient failure is a failure
that can correct itself during a specied period of time. If a request cannot be delivered
to the server due to a transient failure, the request is resubmied; if the problem has
corrected itself, the request is successfully delivered on a subsequent aempt. You
determine what constitutes a transient error by specifying a time-to-live (TTL) period
for a guaranteed delivery transaction and, optionally, the number of times a transaction
should be retried.
Because an Integration Server can act as either a server or a client in a guaranteed
delivery transaction, the guaranteed delivery capabilities of the server handle both
inbound transactions and outbound transactions. When a client invokes a service on a
server, the server is acting as a server. If a service uses guaranteed delivery to invoke a
service on another Integration Server, the server that invokes the service is the client.

Note:

The Integration Servers that participate in a guaranteed-delivery transaction

must both be running the same version of Integration Server software.

The guaranteed delivery capabilities allow you to build robust, transaction-based client
applications without having to embed complex error handling code to respond to
transient failures.
Important: Use the guaranteed delivery capabilities with stateless (i.e., atomic)
transactions because state information cannot be maintained from one

webMethods Integration Server Administrators Guide Version 9.10

672

Odd Header
Configuring Guaranteed Delivery

request to the next. As a result, guaranteed delivery capabilities cannot be

used with multi-request conversational services.
For more information about guaranteed delivery, refer to the Guaranteed Delivery
Developers Guide.

Configuring the Server for Guaranteed Delivery

Integration Server uses various conguration seings for guaranteed delivery
transactions. Most of the seings have defaults. In general, you will want to use the
defaults. You can change these seing by using the Settings > Extended screen of the
Integration Server Administrator as described in "Working with Extended Conguration
Seings" on page 130.
For guaranteed delivery to work, the ISInternal functional alias (specied on the Settings
> JDBC Pools screen) must be congured to point to either the embedded IS Internal
database or to an external RDBMS. For information about connecting Integration Server
to database components, see Installing Software AG Products.
For information about using guaranteed delivery with server clustering, refer to the
webMethods Integration Server Clustering Guide.

Settings Shared by Both Inbound and Outbound Transactions

The following seings apply to both inbound and outbound guaranteed delivery
transactions.
watt.server.txMail
Use the wa.server.txMail seing to specify the e-mail address of an administrator to
notify when guaranteed delivery capabilities are disabled due to error (for example,
if the server encounters a disk full condition). An example of using this seing is
[email protected].
There is no default for this seing.
watt.server.smtpServer
Use the wa.server.smtpServer seing to specify the domain name
(e.g., purple.webmethods.com) or IP address (e.g. 132.196.19.22 or
2001:db8:85a3:8d3:1319:8a2e:370:7348) of the SMTP server you want the Integration
Server to use when sending an e-mail message about an error during guaranteed
delivery. An example of using this seing is wa.server.smtpServer=132.196.19.22 or
wa.server.smtpServer=2001:db8:85a3:8d3:1319:8a2e:370:7348
There is no default for this seing.
When an administrator receives an e-mail notication of an error, the administrator
should correct the problem, then use Integration Server Administrator to re-initialize
guaranteed delivery capabilities. For instructions on how to re-initialize guaranteed
delivery, refer to "Reinitializing Guaranteed Delivery" on page 678.

webMethods Integration Server Administrators Guide Version 9.10

673

Even Header
Configuring Guaranteed Delivery

watt.tx.vm.id
Use the wa.tx.vm.id seing to specify an Integration Server ID. Use this parameter
when multiple Integration Servers are running on the same host machine and they all
use guaranteed delivery. By specifying a unique ID for each Integration Server, you
prevent the creation of duplicate guaranteed delivery transaction IDs. The value must be
an integer from 0 through 2147483647.
The default is 0.

Settings for Inbound Transactions

For inbound transactions, the server maintains a job store of transactions and the status
of each. Periodically, the server sweeps the job store to remove expired transactions; that
is, to remove transactions that have an elapsed time-to-live (TTL) period. For inbound
requests, the client must specify the TTL for a transaction.
In addition to the job store, the server maintains an audit-trail log of all operations it
performs for inbound transactions.
The following table identies the inbound transaction seings that you can congure.
You can configure:

Using this setting

How often the server sweeps the job

store to remove expired transactions

wa.server.tx.sweepTime

How the server updates the status

of PENDING transactions when a
heuristic failure occurs

wa.server.tx.heuristicFailRetry

watt.server.tx.sweepTime
Use the wa.server.tx.sweepTime seing to specify the number of seconds between
sweeps (clean up) of the job store of inbound transactions. The server sweeps the job
store to remove expired transactions.
The default is: 60 seconds
watt.server.tx.heuristicFailRetry
Use the wa.server.tx.heuristicFailRetry seing to indicate whether the server is to reexecute services for transactions in the job store that are PENDING when the server
is restarted after a failure. If a transaction is PENDING, the service began but did not
complete execution when the server failed.
Because the server cannot determine the exact status of a service request, the server
considers the guaranteed transaction to have encountered a heuristic failure. You
can congure the server to respond to heuristic failures as appropriate. The default
wa.tx.heuristicFailRetry seing causes the server to execute a service at least one time
at the risk of re-executing it a subsequent time after a heuristic failure. Alternatively, you

webMethods Integration Server Administrators Guide Version 9.10

674

Odd Header
Configuring Guaranteed Delivery

can recongure the seing to guarantee that a service is executed at most one time at the
risk of not executing a service due to a heuristic failure.
If the wa.tx.heuristicFailRetry seing is true, the server resets the transaction status
from PENDING to NEW, and the server will retry the service. When the seing is true,
a request to execute a service can only fail if the transaction expires before the server
executes the service. (The client species the seings that indicate when a transaction
expires.)
If the wa.tx.heuristicFailRetry seing is false, the server resets the transaction status
from PENDING to FAIL to indicate the heuristic failure; the server does not retry the
service. When the seing is false, a request to execute a service can fail due to a heuristic
failure or due to the transaction expiring.
The default is: true

Settings for Outbound Transactions

You can disable the use of guaranteed delivery for outbound transactions. However,
if you allow guaranteed delivery for outbound transactions, the server maintains a
separate job store for the transactions. Similar to the inbound job store, the server keeps
the status of each transaction in the outbound job store. If a service request fails, the
server waits a specied amount of time before resubmiing the request. The server
periodically processes the job store to identify transactions that it needs to submit.
The server maintains a thread pool to service pending outbound requests. You can
congure how many client threads the server should maintain in the thread pool.
The server also maintains a separate audit-trail log of all operations it performs for
outbound transactions.
The following table identies the outbound transaction seings that you can congure.
You can configure:

Using this setting

Whether you want to disable guaranteed

delivery for outbound transactions.

wa.tx.disabled

The default TTL value for outbound

transactions.

wa.tx.defaultTTLMins

How long the server should wait before

resubmiing failed requests.

wa.tx.retryBacko

How often the server processes the job

store to identify transactions that it needs
to submit.

wa.tx.sweepTime

webMethods Integration Server Administrators Guide Version 9.10

675

Even Header
Configuring Guaranteed Delivery

You can configure:

Using this setting

How many client threads the server should

maintain in the thread pool that it uses to
service pending requests.

wa.tx.jobThreads

watt.tx.disabled
Use the wa.tx.disabled seing to specify that you want to disable the use of guaranteed
delivery for outbound requests. By default, the server allows the use of guaranteed
delivery for outbound transactions. The default is "false." If an unexpected exceptional
conditional is encountered, guaranteed delivery may be disabled by the server. In this
case, the wa.tx.disabled property will be set to "true".
The default is: false.
watt.tx.defaultTTLMins
Use the wa.tx.defaultTTLMins seing to specify the default time-to-live (TTL) value for
outbound guaranteed delivery transactions. Specify the number of minutes you want
the server to maintain outbound transactions in the job store when a service initiating an
outbound transaction does not specify a TTL value.
The default is: 30.
watt.tx.retryBackoff
Use the wa.tx.retryBacko seing to specify the number of seconds to wait after a
service request failure before the Job Manager resubmits the request to execute the
service to the Integration Server.
The default is: 60.
watt.tx.sweepTime
Use the wa.tx.sweepTime seing to specify the number of seconds between sweeps
of the job store of outbound transactions. The server sweeps the job store to identify
transactions that it needs to submit.
The default is: 60.
watt.tx.jobThreads
Use the wa.tx.jobThreads seing to specify the number of client threads you want to
make available in a thread pool to service pending requests.
The default is: 5.

Specifying an E-Mail Address and SMTP Server for Error Messages

When you congure guaranteed delivery, you must specify the e-mail address to which
Integration Server can issue an error message if guaranteed delivery becomes disabled.
In addition, you must specify the domain name or IP address of the SMTP server you
want to handle these e-mail messages. For instructions on specifying the e-mail address
and SMTP server, refer to "Sending Messages About Critical Issues to E-mail Addresses"
on page 222.

webMethods Integration Server Administrators Guide Version 9.10

676

Odd Header
Configuring Guaranteed Delivery

Using Guaranteed Delivery with Multiple Servers that Share an

ISInternal Database
If you use multiple Integration Servers that are not in an Integration Server cluster, but
the servers are congured with their ISInternal functional alias pointing to the same
database, you need to congure each Integration Server correctly process guaranteed
delivery jobs.
For each server sharing the ISInternal database, set the wa.server.db.share.ISInternal
server property to true, which lets the server know that it is sharing the database and
that it needs to coordinate with other servers.
Additionally, although the servers are not in an Integration Server cluster, they are
sharing the Guaranteed Delivery tables. As a result, you need to congure the following
clustering server properties identically for all servers:
wa.server.tx.cluster.lockTimeoutMillis
wa.server.tx.cluster.lockBreakSecs
wa.server.tx.cluster.jobPendingWait
To view or change server property seings, use the Settings > Extended screen from the
Integration Server Administrator as described in "Working with Extended Conguration
Seings" on page 130. For information about server properties, see the "Server
Conguration Parameters" on page 851.
Important: After changing these server properties, you must restart Integration Server
for the changes to take eect.

Administering Guaranteed Delivery

When you initialize the server, it initializes guaranteed delivery capabilities. You can
use the Integration Server Administrator to shut down, re-initialize, and test guaranteed
delivery.

Shutting Down Guaranteed Delivery

You can shut down and re-enable guaranteed delivery capabilities without having to
shut down the server.
You might want to shut down guaranteed delivery to perform some administration
functions, such as correcting conguration errors or starting a new audit-trail log. (To
start a new audit-trail log, move or rename the existing log; the server automatically
starts a new log if one does not already exist.)

webMethods Integration Server Administrators Guide Version 9.10

677

Even Header
Configuring Guaranteed Delivery

To shut down guaranteed delivery

1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. In the list of packages, click WmPublic.
4. Click Browse Services in WmPublic.
5. In the list of services, click pub.tx:shutdown.
6. Click Test shutdown. The server displays the test screen for the service.
7. Click Test (without inputs). The server disables the guaranteed delivery capabilities for
inbound transactions.

Reinitializing Guaranteed Delivery

Reinitialize guaranteed delivery if it becomes disabled. The procedures for reinitializing
guaranteed delivery are dierent for inbound transactions and outbound transactions.

Reinitializing Guaranteed Delivery for Inbound Transactions

If you shut down the guaranteed delivery capabilities to correct a conguration problem
or to make an administrative change, you can re-initialize guaranteed delivery using the
Integration Server Administrator.
You can also use this procedure to reinitialize guaranteed delivery if it becomes disabled
due to an error (for example, because of a disk full condition or if the job store database
becomes inaccessible). Reinitialize guaranteed delivery after you correct the problem.
To reinitialize guaranteed delivery for inbound transactions
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. In the list of packages, click WmPublic.
4. Click Browse Services in WmPublic.
5. In the list of services, click pub.tx:init.
6. Click Test init. The server displays the test screen for the service.
7. Click Test (without inputs). The server reinitializes the guaranteed delivery capabilities
for inbound transactions.

Reinitializing Guaranteed Delivery for Outbound Transactions

If guaranteed delivery capabilities for outbound transactions become disabled due to an
error (for example, because of a disk full condition or if the job store database becomes

webMethods Integration Server Administrators Guide Version 9.10

678

Odd Header
Configuring Guaranteed Delivery

inaccessible), use this procedure to reinitialize guaranteed delivery after you correct the
problem.
To reinitialize guaranteed delivery for outbound transactions
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. In the list of packages, click WmPublic.
4. Click Browse Services in WmPublic.
5. In the list of services, click pub.tx:resetOutbound.
6. Click Test resetOutbound. The server displays the test screen for the service.
7. Click Test (without inputs). The server reinitializes the guaranteed delivery capabilities
for outbound transactions.

webMethods Integration Server Administrators Guide Version 9.10

679

Even Header

webMethods Integration Server Administrators Guide Version 9.10

680

Odd Header
Configuring Ehcache on Integration Server

32 Configuring Ehcache on Integration Server

What is Ehcache? ......................................................................................................................

682

Caching Configurations ..............................................................................................................

682

Understanding Caches and Cache Managers ...........................................................................

687

Cache Manager Configuration Files ..........................................................................................

688

Installing, Viewing, and Changing the Terracotta License .........................................................

690

Configuring an On-Heap Cache ................................................................................................

691

Configuring a BigMemory Cache ...............................................................................................

693

Configuring a Distributed Cache ................................................................................................

696

Making a Cache Searchable ......................................................................................................

705

Working with Cache Managers ..................................................................................................

708

Working with Caches .................................................................................................................

715

Logging Ehcache Activity ...........................................................................................................

729

webMethods Integration Server Administrators Guide Version 9.10

681

Even Header
Configuring Ehcache on Integration Server

What is Ehcache?
Ehcache is a standards-based caching API that is used by Integration Server. Caching
enables an application to fetch frequently used data from memory (or other nearby
resource) rather than having to retrieve it from a database or other back-end system each
time the data is needed.
Ehcache is designed to support multiple deployment congurations, including those
that enable you to create very large in-memory caches and share caches across multiple
Integration Servers.
Integration Server, and Software AG components that run on Integration Server,
use Ehcache to cache data associated with many of their own internal operations.
Additionally, Integration Server provides a set of public services (in the pub.cache folder
in the WmPublic package) that developers can use to add caching capabilities to the
solutions that they build. For example, a service that frequently reads data from a sales
catalog might cache all or part of that catalog to avoid having to query the database each
time it needs information about a catalog item. Because accessing data from memory
is as much as 1,000 times faster than retrieving it from a database, developers can
dramatically improve the performance of a service by caching the data that it uses.
This chapter provides a broad overview of the caching capabilities provided by
Ehcache. For a more detailed explanation of these features, see the Ehcache product
documentation for 2.8 at hp://ehcache.org/documentation.

Caching Configurations
A cache on Integration Server occupies a portion of the heap in the Java Virtual Machine
(JVM). This portion of a cache is referred to as on-heap cache. You can optionally extend a
cache beyond the heap to the following locations, commonly referred to as tiers:
Local Disk Storage
BigMemory (Terracoa license required)
Terracoa Server Array (Terracoa license required)
The way in which a cache is divided between on-heap memory and the other tiers is
determined by conguration properties that you specify when you create the cache.
The tiered approach enables you to extend a cache beyond the size constraints imposed
by the heap. Additionally, when you extend a cache to the Terracoa Server Array, the
cache can be simultaneously shared by multiple Integration Servers.
Developers who develop services that use Ehcache do not need to know whether
the cache they are using resides only on the heap or whether it extends to one of the
other tiers. They simply need to code their service to use a particular cache. Whether
that cache extends to disk, BigMemory, or a Terracoa Server Array is determined by
conguration properties that are assigned to the cache itself. Consequently, developers

webMethods Integration Server Administrators Guide Version 9.10

682

Odd Header
Configuring Ehcache on Integration Server

do not need to change their code when the caching requirements for their applications
change.

On-Heap Cache
On-heap cache is the portion of a cache that resides within the heap of the JVM where
the Integration Server is running.

On heap-cache is fast, but because it resides within the heap space, it is subject to
the garbage collection process. For large caches, the garbage collection process can
cause lengthy interruptions during the execution of a service. If the heap is large, the
interruption might be multiple seconds.
Note:

The amount of memory that you can use for on-heap caching depends on
the amount of memory you can allocate to the JVM heap. This limit varies
according to the JVM, the machine, and the operating system that you are
using.

Out of the box, Integration Server supports the use of on-heap caches. You do not need
an additional license to create and use an on-heap cache.
For more information about using an on-heap cache with Integration Server, see
"Conguring an On-Heap Cache" on page 691.

Local Disk Store

You can optionally associate a local disk store with a cache. A local disk store is a
designated directory to which Integration Server writes objects that are placed in cache.
You can congure a cache to use a local disk store in one of two ways:

webMethods Integration Server Administrators Guide Version 9.10

683

Even Header
Configuring Ehcache on Integration Server

You can use it to extend the on-heap cache so that cached objects overow to the
local disk store when the on-heap cache becomes full.
-- OR -You can use it to persist all cached objects to disk so that cached objects are retained
when the Integration Server is restarted or the cache manager is reinitialized.
Note:

Note:

Persisting a cache to the local disk store does not guarantee that elements
in cache will be successfully recovered when a Integration Server or a
cache manager restarts. If Integration Server or a cache manager is not
shut down gracefully, the disk store might not be in a state from which
the elements can be recovered. If you require guaranteed persistence of a
cache, you must use a Terracoa Server Array.
You can only use a local disk store with a local cache. A local cache is any
Ehcache-based cache that resides wholly on the machine where Integration
Server is running and does not extend to the Terracoa Server Array.

BigMemory
BigMemory enables you to extend a cache beyond the local JVM heap. When you
congure a cache to use BigMemory, a portion of the cache resides within the heap and
a portion resides o heap. The o-heap portion of the cache resides within the JVM
process memory, but outside of the JVM heap.

webMethods Integration Server Administrators Guide Version 9.10

684

Odd Header
Configuring Ehcache on Integration Server

Because a BigMemory cache resides o heap, it is not subject to the JVM garbage
collection process and, consequently, it performs more predictably and consistently. For
large caches, BigMemory generally delivers beer performance than a heap-based cache.
Moreover, from an administrative point of view, caches that use BigMemory are easier
to manage, because they do not need to be tuned for garbage collection.
Using BigMemory, you can create much larger caches than with on-heap memory
alone. Unlike on-heap caches, which are constrained by the limitations on heap size,
BigMemory enables you to use up to a terabyte of memory for caching.
To use BigMemory, your Integration Server must be equipped with a Terracoa license
from Software AG.
For more information about conguring a cache to use BigMemory, see "Conguring a
BigMemory Cache" on page 693.

Terracotta Server Array

A Terracoa Server Array enables you to create distributed caches. A distributed cache can
be shared by multiple Integration Servers. Clustered Integration Servers, for example,
use a distributed cache to hold data that all the Integration Servers in the cluster need to
share.

webMethods Integration Server Administrators Guide Version 9.10

685

Even Header
Configuring Ehcache on Integration Server

When you create a distributed cache, a complete copy of the cache resides on a
Terracoa Server Array. A Terracoa Server Array consists of one or more Terracoa
Servers. It can cache vast amounts of data (e.g., multiple terabytes). The data in the cache
is spread across the Terracoa Servers using a technique called striping. A Terracoa
client on the Integration Server manages the interaction between the Integration Server
and the cache on the Terracoa Server Array.
The Integration Servers that share a cache connect to the Terracoa Server Array to
put data into the cache and retrieve data from it. Each Integration Server keeps a small
portion of the cache locally, which serves as a hot set of recently used data and
reduces trips to the Terracoa Server Array.
To use a distributed cache, your Integration Server must be equipped with a Terracoa
license from Software AG.
For more information about using a distributed cache with Integration Server, see
"Conguring a Distributed Cache" on page 696.

webMethods Integration Server Administrators Guide Version 9.10

686

Odd Header
Configuring Ehcache on Integration Server

Understanding Caches and Cache Managers

With Ehcache, a cache holds elements that are represented as key-value pairs. The key
and its value are both Java objects. Keep the following points in mind about key-value
pairs in a cache:
A key can be of any type of Java object except an IS document.
A value can be of any type of Java object.
If you are caching data to BigMemory or a Terracoa Server Array, or you write the
cache to the local disk store, the objects must be serializable.
An element that is placed in cache is identied by its key. For example, when Integration
Server caches a session object, it uses the session ID as the key. Similarly, when
developers create services that put objects into a cache, they select an appropriate
identier to use as the key to retrieve the objects from cache. For example, an application
that caches customer objects might derive its key from the customer account number.
A cache has an associated cache manager. A cache manager serves as a container for
grouping a set of caches into one management unit that you can start and shut down
together.
The caches that you associate with a cache manager can have dierent characteristics
and congurations. For example, cache manager XYZ might include one cache that
resides entirely on the heap and another that extends to BigMemory.
Although there are many properties that you can congure on a cache-by-cache basis,
there are certain properties that you assign at the cache manager level. These include:
The location of the local disk store. All of the caches associated with a cache manager use
the same disk store location. If you want two caches to use dierent local disk stores,
then you must create those caches in dierent cache managers.
The location of theTerracotta Server Array. All of the distributed caches associated with a
cache manager use the same Terracoa Server Array. If you want two caches to use
two dierent Terracoa Server Arrays, then you must create those caches in dierent
cache managers.
The cache managers that you create on an Integration Server are referred to as public
cache managers. Public cache managers (and the caches that they contain) can be used by
ow services that your developers build.
For more information about creating and conguring public cache managers and caches,
see "Working with Cache Managers" on page 708 and "Working with Caches" on
page 715.

webMethods Integration Server Administrators Guide Version 9.10

687

Even Header
Configuring Ehcache on Integration Server

System Caches
Integration Server and other Software AG products use Ehcache in many of their own
internal processes. The caches that they use are called system caches and they belong to
system cache managers.
System cache managers are identied by names that begin with the following characters:
SoftwareAG.

For example,
SoftwareAG.IS.Core

When you use the Integration Server Administrator to display the list of cache managers
that exist on Integration Server, it displays system cache managers and public (userdened) cache managers in separate lists.
For a list of the system caches used by Integration Server, see Using Terracoa with
webMethods Products. This document includes a description of the system caches
that Integration Server and other Software AG components use and provides sizing
information for them.

Cache Manager Configuration Files

Every cache manager has an associated XML le that species the conguration
parameters for the cache manager and its caches. (In Ehcache documentation, this le is
often referred to as the ehcache conguration le or the ehcache.xml le.)
Integration Server maintains the conguration les for all cache managers (both system
cache managers and public cache managers) in the following directory:
Integration Server_directory\instances\instance_name \cong\Caching
When you create a new cache manager using the Integration Server Administrator,
Integration Server creates a conguration le for the cache manager and saves the le
in Integration Server_directory\instances\instance_name \cong\Caching directory.
Integration Server gives the conguration le the same name as the cache manager,
except that it uses dashes (-) instead of any periods that appear in the name. For example
the conguration le for a cache manager named my.cache.manager would be given
the name my-cache-manager.xml.
When you start Integration Server, it looks for conguration les in the
Integration Server_directory\instances\instance_name \cong\Caching directory. When it
nds a valid conguration le, it initializes the cache manager that is dened by the le
and starts the caches that belong to the cache manager.
If Integration Server is not able to initialize a cache manager during its startup process,
(if, for example, the cache manager conguration le is invalid or the le denes a type
of cache that you are not licensed to use), it reports the error in the server log.

webMethods Integration Server Administrators Guide Version 9.10

688

Odd Header
Configuring Ehcache on Integration Server

Note:

It is possible for developers to use the Ehcache API to create cache managers
and caches without adding a corresponding conguration le to the
Integration Server_directory\instances\instance_name \cong\Caching
directory. However, this practice is not recommended on Integration
Server. A cache manager whose conguration le is not present in the
Integration Server_directory\instances\instance_name \cong\Caching
directory will not be registered properly on Integration Server and cannot be
administered using the Integration Server Administrator.

Specifying the Parameters for a Cache

You create caches and edit their parameters using the Integration Server Administrator.
When you create a cache, Integration Server Administrator adds the cache to the
appropriate cache manager conguration le. When you edit the parameters of a
cache, Integration Server Administrator updates the parameters in the cache manager
conguration le accordingly.
Important: While it is possible to modify the parameters for a cache by manually editing
a cache manager conguration le, doing this is not recommended. You
should always use Integration Server Administrator to edit the parameters
of a cache manager or a cache. The only time you should manually edit
the conguration le is to set parameters that are not exposed in the
Integration Server Administrator user interface (which is rarely necessary).
For additional precautions about editing a conguration le, see "Manually
Editing a Cache Manager Conguration File" on page 713.

Dynamic vs. Non-Dynamic Cache Parameters

A cache has both dynamic and non-dynamic parameters. When you change a dynamic
parameter using Integration Server Administrator, the change is applied to the cache
immediately. You do not need to restart the Integration Server or reinitialize the cache
manager to put the change into eect. When you change a non-dynamic parameter,
the change does not take eect until you reinitialize the cache manager as described in
"Reinitializing a Cache Manager" on page 711.
The parameter descriptions in "Creating a Cache" on page 715 indicate which
parameters are dynamic and which are not.
Note:

Apart from being dynamic or non-dynamic, the parameters for a distributed

cache are also cache-wide or client-specic. For details about these qualities, see
"Cache-Wide and Client-Specic Parameters for a Distributed Cache" on page
701.

webMethods Integration Server Administrators Guide Version 9.10

689

Even Header
Configuring Ehcache on Integration Server

Installing, Viewing, and Changing the TerracottaLicense

The licensing requirements for Terracoa components depend on the type of component
you want to use. To use local, on-heap cache, you do not need an additional Terracoa
license. The basic license installed with your Integration Server provides this capability.
However, to create a cache that uses BigMemory or the Terracoa Server Array, you
must have the appropriate Terracoa and Integration Server licenses.
The following table describes the licensing requirements for each Terracoa component.
If you want to use...
Local cache

You must have...

An Integration Server license. This license
is installed with your Integration Server
installation.
Note: An additional Terracoa license is not
required for this component.

BigMemory cache

An Integration Server license. This license

le is installed with your Integration Server
installation.
A Terracoa license for BigMemory. You add this
license to the host machine where Integration
Server is running.

Distributed cache

An Integration Server license for distributed

cache. This license is installed with your
Integration Server installation.
A Terracoa license for the Terracoa Server
Array. You add this license to each Integration
Server that shares the distributed cache.

Clustering

An Integration Server license for clustering. This

license is installed with your Integration Server
installation.
A Terracoa license for the Terracoa Server
Array. You add this license to each Integration
Server in the cluster.

webMethods Integration Server Administrators Guide Version 9.10

690

Odd Header
Configuring Ehcache on Integration Server

Determining if You Have a Terracotta License

If you are not sure whether you have a Terracoa license, you can view licensed
components for your installation from the Settings > Licensing screen in the Integration
Server Administrator. If you have a Terracoa license installed, it is listed here. You can
click Licensing Details to view the Terracoa components for which you are licensed. If
you do not have a Terracoa license, you can obtain one from Software AG.

Adding a Terracotta License

The Terracoa license is a le named terracoa-license.key. It contains the license
information for all of your Terracoa components. You add this le to Integration Server
by placing it into the Software AG_directory\common\conf directory of the machine
on which Integration Server runs. The Integration Server Administrator checks this
directory for licenses and displays the information on the Licensing screen.
If the license le is located in a dierent directory, you can add it to Integration Server
using the Integration Server Administrator.
To add a Terracotta license key using Integration Server Administrator
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Licensing.
3. Click Licensing Details.
4. Click Edit Licensing Detail.
5. In the TerracottaLicense Fileeld, enter the fully qualied le name for the license key
le you obtained from Software AG.
6. Click Save Changes. Integration Server Administrator updates the TerracottaLicense
File eld to reect the le name that you entered.
7. Restart Integration Server.
Note:

You must restart the Integration Server after adding, removing, or changing a
Terracoa license.

Configuring an On-Heap Cache

Perform the following general steps to create an on-heap cache. An on-heap cache is
maintained entirely within the JVM heap. On-heap caches are fast, but they are subject
to the JVM garbage collection process. For more information about on-heap caches, see
"On-Heap Cache" on page 683.

webMethods Integration Server Administrators Guide Version 9.10

691

Even Header
Configuring Ehcache on Integration Server

Step

Description

Review the points listed in "Considerations for Conguring OnHeap Cache" on page 692.

Decide how much memory you need for the cache and adjust
the heap size of your JVM if necessary. For information about
changing the heap size used by Integration Server, see "Changing
the JVM Heap Size Used by Integration Server " on page 133.

If the cache manager to which you want to add the cache does
not already exist, create it. For information about creating a cache
manager, see "Creating a Cache Manager" on page 708.

Create the cache using the procedure in "Creating a Cache"

on page 715. When you create the cache, be sure to do the
following:
Complete the parameters in the Cache Configuration and Cache
Configuration Advanced Settings sections.
Do not enable the Distributed option in Distributed Cache
Configuration section.
Do not enable the Overflow to Off-heap option in BigMemory
section.

To make the cache available for use, enable the cache as

described in "Enabling a Cache" on page 728.

Considerations for Configuring On-Heap Cache

When you create an on-heap cache, keep the following points in mind:
The heap space is shared by all processes running in the JVM. When you add an onheap cache to Integration Server, you may need to increase the size of the heap to
ensure that it is large enough to satisfy the heap requirements of the new cache and
other consumers of the heap. These include:
Other on-heap caches that exist on the Integration Server (including system
caches).
All classes, class variables and instance variables used by Integration Server and
the services and triggers that are deployed on it.
OSGI processes that are running in the same JVM as Integration Server (such as
the webMethods Event Server).

webMethods Integration Server Administrators Guide Version 9.10

692

Odd Header
Configuring Ehcache on Integration Server

For sizing information about the system caches that Integration Server and other
Software AG products use, see Using Terracoa with webMethods Products on the
Software AG documentation website.
To estimate the amount of the heap that a cache will consume, multiply the size of
objects that you want to cache by the number of those objects that you want to keep
in cache.
objectSizeInBytes * numObjectsToCache = heapConsumedByCache
Very large on-heap caches (which require a large heap size) increase the time it takes
for the JVM to perform a full garbage collection. When a full garbage collection
occurs, all threads in the JVM are paused, which can cause noticeable delays in
response times.
When sizing an on-heap cache, you must weigh the benets of keeping a large
amount of data in memory against the periodic interruptions that this imposes
on the Integration Server. For additional information about the eect of garbage
collection on a cache, see Ehcache product documentation for 2.8 at hp://
ehcache.org/documentation.
If garbage collection becomes a signicant problem with the size of your on-heap
cache, consider maintaining a smaller on-heap cache and enabling Overflow to Disk
or Overflow to Off-Heap (BigMemory license required) to extend the cache without
increasing its on-heap requirements.
Make sure your machine is equipped with sucient memory to support the heap
requirements of your JVM and the memory requirements of other applications that
run on the machine. Insucient memory will cause paging.
If you enable the Overflow to Disk or Persist to Disk option, your cache must contain
only serializable keys and values. If a service aempts to put a non-serializable object
into a cache that overows or is persisted to disk, the service will receive a runtime
exception.

Configuring a BigMemory Cache

Perform the following general steps to create a BigMemory cache. A BigMemory cache
occupies both on-heap and o-heap memory. (For this reason, it is sometimes referred
to as an o-heap cache.) When you congure a BigMemory cache, you specify the number
of elements that you want the Integration Server to maintain on-heap. You also specify
how much o-heap memory the cache can use. A BigMemory cache is fast and can be
very large. The o-heap portion of the cache is not subject to JVM garbage collection. For
more information about BigMemory caches, see " BigMemory " on page 684.
To create a cache that uses BigMemory, perform the following general steps:

webMethods Integration Server Administrators Guide Version 9.10

693

Even Header
Configuring Ehcache on Integration Server

Step

Description

Verify that the Integration Server is equipped with a license to

use BigMemory and check how much BigMemory the license
authorizes. For procedures, see "Installing, Viewing, and
Changing the Terracoa License" on page 690.

If you have not done so already, allocate direct memory to

Integration Server using the procedure in "Allocating Direct
Memory Space to Integration Server " on page 694.

Review the points listed in "Considerations for Conguring

BigMemoryCache" on page 695.

Decide how much memory you need for the on-heap portion
of the cache and adjust the Java heap size if necessary. For
information about changing the heap size used by Integration
Server, see "Changing the JVM Heap Size Used by Integration
Server " on page 133.

If the cache manager to which you want to add the cache does
not already exist, create it. For information about creating a cache
manager, see "Creating a Cache Manager" on page 708.

Create the cache using the procedure in "Creating a Cache"

on page 715. When you create the cache, be sure to do the
following:
In the Maximum Elements in Memory eld, specify the number
of elements that you want to maintain in on-heap memory.
(To avoid performance issues, always set Maximum Elements in
Memory to a value greater than 100 elements.)
Enable Overflow to Off-Heap and, in the Max Off-Heap eld, specify
the amount of o-heap memory that you want to allocate to this
cache.

To make the cache available for use, enable the cache as

described in "Enabling a Cache" on page 728.

Allocating Direct Memory Space to Integration Server

To use BigMemory with Integration Server, you must allocate direct memory space to the
JVM in which Integration Server is running.

webMethods Integration Server Administrators Guide Version 9.10

694

Odd Header
Configuring Ehcache on Integration Server

The amount of direct memory space that is given to Integration Server is determined
by the wrapper.java.additional.n=-XX:MaxDirectMemorySize property in
the custom_wrapper.conf le. By default, the wrapper.java.additional.n=XX:MaxDirectMemorySize property is not set when Integration Server is installed.
When you use BigMemory, you must set the wrapper.java.additional.n=XX:MaxDirectMemorySize property to the amount of memory that you need to hold
your o-heap caches.
To allocate direct memory space to Integration Server
1. On the machine where Integration Server is installed, navigate to the following
folder:
Software AG_directory\proles\IS_instance_name \conguration
2. In a text editor, open custom_wrapper.conf.
3. Add a the wrapper.java.additional.n=-XX:MaxDirectMemorySize property to
specify the amount of BigMemory required to accommodate all of your caches that
use BigMemory. (This amount is limited by your Terracoa license, the amount of
physical memory on your system, and how much of that memory is needed by the
operating system and other applications running on the machine.)
For example, if you determine that you need 500 megabytes of BigMemory
and you are running Integration Server under Windows, you would add the
wrapper.java.additional property in the custom_wrapper.conf le to look like
this:
wrapper.java.additional.n =-XX:MaxDirectMemorySize=500M

Where n is the next unused sequential number for the wrapper.java.additional

properties in the le.
Note:

You can express the value of this parameter using 'm' or 'M' for megabytes
or using 'g' or 'G' for gigabytes.

4. Save and close custom_wrapper.conf.

5. Restart Integration Server.

Considerations for Configuring BigMemoryCache

When you create a cache that uses BigMemory, keep the following points in mind:
A BigMemory cache accepts only serializable keys and values. If a service aempts
to put a non-serializable object into the cache at run time, the service will receive an
exception.
Allocate at least 100 elements to the on-heap portion of cache. Smaller on-heap cache
sizes do not perform eciently. Integration Server will log a warning message if a
BigMemory cache is initialized with fewer than 100 elements allocated to the onheap portion of the cache.

webMethods Integration Server Administrators Guide Version 9.10

695

Even Header
Configuring Ehcache on Integration Server

Allocate at least 128 megabytes to the o-heap portion of the cache.

Be aware that not all of the direct memory that you allocate to the JVM is available
for o-heap caches. You must reserve 32 megabytes for non-cache use by
BigMemory. (In other words, the amount of memory available for o-heap caching is
MaxDirectMemorySize minus 32M.)
Before you specify the o-heap memory for the new cache, check how much
BigMemory is already allocated by o-heap caches that exist on the Integration
Server. The o-heap memory that you specify for this cache must t within whatever
direct memory remains (minus the 32 megabytes of that memory is reserved for noncache use, as mentioned above).
To determine how much BigMemory is already used by existing caches, examine the
BigMemory column on the Settings > Caching > CacheManagerName page for each cache
manager.
Integration Server allocates the o-heap portion of a cache (the amount of memory
specied in the Maximum Off-Heap) when it instantiates the cache. If it cannot obtain
the amount of memory specied in Maximum Off-Heap, the Integration Server writes
an error message to the server log, places a stack trace in the error log, and does not
enable the cache.
The o-heap memory that you allocate to a cache actually includes a copy of the
elements that reside in on-heap cache. Keep this point in mind when you specify
the Maximum Off-Heap parameter for the cache. For example, if you set Maximum OffHeap to 128 MB and your elements are approximately 1 KB each, your cache will
be able to hold about 128,000 elements in o-heap memory. However, this number
includes copies of the on-heap elements. If the size of your on-heap cache is 2,000
elements, then the o-heap cache will hold copies of those 2,000 elements, plus
126,000 additional elements.
If you enable the Overflow to Disk option and you want to limit the number of
elements that can be wrien to disk using the Maximum Entries Local Disk parameter,
set Maximum Entries Local Disk to a value that is greater than the number of elements
that the amount of memory in Maximum Off-Heap can hold. For example, if Maximum
Off-Heap will hold about 128,000 elements and you want to allow an additional 50,000
elements to overow to disk, set Maximum Entries Local Disk to 178,000 elements.
For other considerations relating to BigMemory caches, see the BigMemory Go
product documentation for 4.1 at www.terracoa.org/documentation.

Configuring a Distributed Cache

Perform the following general steps to create a distributed cache. A distributed cache
resides on a Terracoa Server Array and can be shared with other Integration Servers.
Integration Server keeps a portion of the distributed cache in its on-heap memory so
that it does not have to access the Terracoa Server Array every time it needs to fetch
data from the cache. When you congure a distributed cache, you specify the number of
elements that you want the Integration Server to maintain locally in the on-heap portion

webMethods Integration Server Administrators Guide Version 9.10

696

Odd Header
Configuring Ehcache on Integration Server

of the cache. For more information about distributed caches, see " Terracoa Server
Array " on page 685.
Step

Description

If you have not already installed and congured your Terracoa

Server Array, do this rst. For procedures, see the product
documentation for the Terracoa Server Array.
Note: The Terracoa Server Array must be running a version
of Terracoa that is compatible with the Terracoa
client libraries installed on your Integration Server. To
check which versions of the Terracoa Server Array
are compatible with your Integration Server, see the
Terracoa Compatibility with other Software AG Products
on the Software AG documentation website at hp://
documentation.softwareag.com.

If you have not done so already, edit the tc-cong le on the

Terracoa Server Array and add the parameters that Integration
Server requires. For procedures, see "Conguring tc-cong.xml
on the Terracoa Server Array " on page 699.

Review the points listed in "Considerations for Conguring a

Distributed Cache" on page 700.

Verify that Integration Server is equipped with a license to use a

Terracoa Server Array. For procedures, see "Installing, Viewing,
and Changing the Terracoa License" on page 690.

Decide how much memory you will use for the on-heap portion
of the cache on Integration Server and adjust the Java heap size
if necessary. For information about changing the heap size used
by Integration Server, see "Changing the JVM Heap Size Used by
Integration Server " on page 133.
Note: The size of the on-heap portion of a distributed cache must
be the same on all Integration Servers that use the cache.

If the cache manager to which you want to add the cache does
not already exist, create it. For information about creating a cache
manager, see "Creating a Cache Manager" on page 708.
Note: Be sure that the cache manager that you are using is
congured to use the Terracoa Server Array.

webMethods Integration Server Administrators Guide Version 9.10

697

Even Header
Configuring Ehcache on Integration Server

Step

Description

Create the cache using the procedure in "Creating a Cache"

on page 715. When you create the cache, be sure to do the
following:
Enable the Distributed seing in the Distributed Cache
Conguration section of the page.
In the Maximum Elements in Memory eld, specify the number of
elements that you want to maintain in the on-heap memory at
the Integration Server.
In the Maximum Entries in Cache eld, specify the maximum size
(in number of elements) to which this cache can grow on the
Terracoa Server Array.
Note: Although Integration Server permits you to set Maximum
Elements in Memory and Maximum Entries in Cache to 0,
which indicates that the number of elements is restricted
only by the availability of resources, Software AG
strongly recommends that you always specify an upper
limit in these elds. Unlimited caches grow indenitely
and can cause performance problems or system failures
if they exhaust the available resources on the machine.

Verify that the parameters for the cache are set as you want them
and enable the cache as described in "Enabling a Cache" on page
728.
If this is the rst Integration Server on which you have created
the distributed cache, the Integration Server creates the
distributed cache on the Terracoa Server Array during this step.

If other Integration Servers will use this distributed cache, repeat

steps 4 through 8 on each of them.
Note: Instead of manually specifying the new cache on each
of the other Integration Servers in step 7, you can
optionally create the cache by copying the cache manager
conguration le from this Integration Server to the others.
You can do this by 1) using webMethods Deployer to
deploy the cache manager from this Integration Server
to the others or 2) manually copying the cache manager
conguration le from this Integration Server to the others.
For information about using webMethods Deployer, see
the webMethods Deployer Users Guide. For information
about copying a cache manager conguration le to

webMethods Integration Server Administrators Guide Version 9.10

698

Odd Header
Configuring Ehcache on Integration Server

Step

Description
another Integration Server, see "Adding a Cache Manager
Conguration File to Integration Server " on page 712.

Configuring tc-config.xml on the Terracotta Server Array

Integration Server requires that you set properties in the tc-cong.xml le to congure
the Terracoa Server Array. After you set the required properties and start Integration
Server, Integration Server downloads tc-cong.xml to obtain the information necessary
to connect to the Terracoa Server Array.
You specify the host servers for clustering or caching conguration with the Terracotta
Server ArrayURLs parameter in Integration Server Administrator. When you start public
cache managers that utilize distributed caches or a clustered Integration Server using
distributed system caches, Integration Server uses the Terracotta Server Array URLs
parameter to download tc-cong.xml from the rst specied Terracoa Server Array
server to which it is able to connect. Using the seings in tc-cong.xml, Integration
Server connects to the Terracoa Server Array to begin using distributed caches. For
more information about seing the Terracotta Server Array URLs parameter, see "Working
with Cache Managers" on page 708 (for distributed caches) or the webMethods
Integration Server Clustering Guide (for Integration Server using Terracoa for clustering).
Congure the seings in tc-cong.xml after you install the Terracoa Server Array,
but before you start either the distributed cache on Integration Server or a clustered
Integration Server that uses distributed system caches.
To configure the parameters in tc-config.xml
1. On the Terracoa Server Array host server, open tc-cong.xml with a text editor.
Note:

By default, a Terracoa server expects to nd the tc-cong le in the

TerracoaHome /server/bin folder. If tc-cong.xml does not already exist on
the Terracoa Server Array host server you must create it.

2. Specify the following element contents:

Note:

The following parameters are required for Integration Server clusters using
distributed system caches. You must specify the values for the element
contents exactly as shown.

a. In the tc-properties element, specify the property aributes as follows:

<tc-properties>
<property name="ehcache.storageStrategy.dcv2.perElementTTITTL.enabled"
value="true"/>
</tc-properties>

The ehcache.storageStrategy.dcv2.perElementTTITTL.enabled property

determines whether the Terracoa server supports per element time-to-live and

webMethods Integration Server Administrators Guide Version 9.10

699

Even Header
Configuring Ehcache on Integration Server

time-to-idle expiration. A true value, which is required for Integration Servers in

a cluster, indicates that expiration is per element.
b. In the clients element, specify the content of the logs child element as follows:
<clients>
<logs>%(com.softwareag.tc.client.logs.directory)</logs>
</clients>

This element denes the directory to which Integration Server writes log entries.
For more information about logging, see "Logging Ehcache Activity" on page
729.
3. When you are nished making your changes, save and close the le.
Note:

For more information about conguring Terracoa Server Array see the
Terracoa product documentation. The Using Terracoa with webMethods
Products contains a sample tc-cong.xml le.

Considerations for Configuring a Distributed Cache

Keep the following points in mind when conguring a distributed cache.
A distributed cache accepts only serializable keys and values. If a service aempts
to put a non-serializable object into the cache at run time, the service will receive an
exception.
A distributed cache uses the disk store on the Terracoa Server Array, not on the
Integration Server. You cannot congure the portion of distributed cache that
resides on the Integration Server to overow or persist to disk. When you create a
distributed cache using Integration Server Administrator, the Overflow to Disk or Disk
Persistent seings are disabled.
An Integration Server references a cache on the Terracoa Server Array using
a fully qualied cache name. The fully qualied name of a cache consists of the
name of the cache manager and the name of the cache. For example, the fully
qualied name of a cache called OrderDetails in a cache manager called Orders
is Orders.OrderDetails. If you have multiple Integration Servers that share a
distributed cache, be sure that they all use the same fully qualied name for the
cache.
To create a distributed cache that will be shared by multiple Integration Servers,
you rst create and enable the cache on one of the Integration Servers. This step
registers the distributed cache on the Integration Server and also creates the cache on
the Terracoa Server Array. Then you add the distributed cache to each additional
Integration Server that will use the cache. When you enable the distributed cache on
these Integration Servers, they will see that the cache already exists on the Terracoa
Server Array and will begin using it.
Certain parameters for a distributed cache are cache-wide, meaning that when you
change the parameter on one Integration Server, it aects all Integration Servers that

webMethods Integration Server Administrators Guide Version 9.10

700

Odd Header
Configuring Ehcache on Integration Server

use the cache. For information about which parameters are cache-wide, see "CacheWide and Client-Specic Parameters for a Distributed Cache" on page 701.

Cache-Wide and Client-Specific Parameters for a Distributed Cache

A distributed cache has both cache-wide parameters and client-specic parameters.

Cache-Wide Parameters
The cache-wide parameter seings for a distributed cache are maintained on the
Terracoa Server Array and aect all of the Integration Servers that use the cache. When
you change a cache-wide parameter seing on one Integration Server, the change is
applied to all Integration Servers that use the cache.
The following table identies the cache-wide parameters and indicates whether they
aect the cache on the Terracoa Server Array, the local portion of the cache on the
Integration Servers, or both. As noted in the table, all cache-wide parameter seings are
dynamic, meaning that changes you make to them take eect immediately. You do not
need to reinitialize the cache manager or restart the Terracoa Server Array to put the
changes into eect.
Cache-Wide Parameter

Applies to...

Dynamic?

Max Elements in Memory

All Integration Servers that use the cache.

Does not aect the size of the cache on the
Terracoa Server Array itself.

Yes

Eternal

The cache on the TSA and all Integration

Servers that use the cache.

Yes

Time to Live

The cache on the TSA and all Integration

Servers that use the cache.

Yes

Do not change this value if the cache

Important:
manager is shut down. Doing so will
cause Integration Server to issue an
exception and the cache manager will
not start. To change this parameter,
rst start the cache manager by
following the procedure in "Starting a
Cache Manager" on page 710.
Time to Idle

The cache on the TSA and all Integration

Servers that use the cache.

Yes

Do not change this value if the cache

Important:
manager is shut down. Doing so will

webMethods Integration Server Administrators Guide Version 9.10

701

Even Header
Configuring Ehcache on Integration Server

Cache-Wide Parameter

Applies to...

Dynamic?

cause Integration Server to issue an

exception and the cache manager will
not start. To change this parameter,
rst start the cache manager by
following the procedure in "Starting a
Cache Manager" on page 710.
Maximum Entries in
Cache

The cache on the TSA. Does not aect the

cache on the Integration Servers.

Yes

Do not change this value if the cache

Important:
manager is shut down. Doing so will
cause Integration Server to issue an
exception and the cache manager will
not start. To change this parameter,
rst start the cache manager by
following the procedure in "Starting a
Cache Manager" on page 710.

Client-Specific Parameters
Client-specic parameters aect the way in which a given Integration Server interacts
with a distributed cache. When you change a client-specic parameter, the new seing
aects only the Integration Server on which you make the change.
As noted in the following table, some client-specic parameters are dynamic and others
are non-dynamic. Except where noted, non-dynamic parameters require that you shut
down the cache manager (as described in "Shuing Down a Cache Manager" on page
709). After you make your changes, reinitialize the cache manager (as described
in "Reinitializing a Cache Manager" on page 711) to put the change into eect. For
additional information about the following parameters, see the parameter descriptions
in "Creating a Cache" on page 715.
Client-Specific Parameter

Dynamic?

Clear on Flush

No

Copy on Read

No

Do not change this value if the cache manager

Important:
is shut down. Doing so will cause Integration
Server to issue an exception and the cache
manager will not start. To change this
parameter, follow the procedure in "Modifying

webMethods Integration Server Administrators Guide Version 9.10

702

Odd Header
Configuring Ehcache on Integration Server

Client-Specific Parameter

Dynamic?

Seings for a Distributed Cache" on page

727.
Copy on Write

No

Synchronous Writes

No

Consistency

No

Do not change this value if the cache manager

Important:
is shut down. Doing so will cause Integration
Server to issue an exception and the cache
manager will not start. To change this
parameter, follow the procedure in "Modifying
Seings for a Distributed Cache" on page
727.
Memory Store Eviction Policy

Yes

Enable High Availability

No

Timeout

Yes

Timeout Behavior

Yes

Immediate Timeout When Disconnected

Yes

Maximum Entries Local Disk

Yes

Note:

Technically speaking, the three parameters related to high availability

(Timeout, Timeout Behavior, and Immediate Timeout When Disconnected) behave
dynamically only when the Enable High Availability option is enabled.
However, on Integration Server, Enable High Availability is always enabled
for a distributed cache and thus, these three parameters always behave
dynamically.

The Rejoin Behavior of a Distributed Cache

The Rejoin parameter enables a cache manager to automatically reconnect to a Terracoa
Server Array from which it has become disconnected. This option eliminates the need
to manually reinitialize a cache manager to re-establish a broken connection to the
Terracoa Server Array.

webMethods Integration Server Administrators Guide Version 9.10

703

Even Header
Configuring Ehcache on Integration Server

Integration Server automatically enables the Rejoin parameter for all cache managers
whose Terracotta Server ArrayURLs parameter is set. You cannot disable the Rejoin seing
for such cache managers.
Note:

When a cache manager rejoins a Terracoa Server Array, it joins the array as
though it were a new client. This means that Integration Server clears any data
that it currently holds locally for the cache and resynchronizes its on-heap
store with data from the distributed cache on the Terracoa Server Array.

Note:

If your Integration Server becomes disconnected from the Terracoa Server

Array frequently, you might encounter OutOfMemory errors. These errors
can occur because certain class denitions are reloaded each time the
Integration Server rejoins the Terracoa Server Array. If many rejoins occur
in a short period of time, disused class denitions can ll the permanent
generation space on the heap before they can be garbage collected. For
information about this error condition and how you can adjust the size of the
permanent generation area to avoid it, see Avoiding OOME from Multiple
Rejoins in the Terracoa product documentation.

For more information about the rejoin feature of a distributed cache, see Rejoin in the
BigMemory Max product documentation for 4.1 at www.terracoa.org/documentation.
For more information about the Rejoin parameter on Integration Server, see "Creating a
Cache Manager" on page 708.

The Nonstop Behavior of a Distributed Cache

The Enable High Availability parameter places a distributed cache in nonstop mode. Nonstop
mode enables the Integration Server to take a prescribed action if an operation on the
distributed cache does not complete within a specied timeout period (for example,
if the Terracoa Server Array is unresponsive because it is busy or if the network
connection is down).
When you create a distributed cache with the Integration Server Administrator, it
automatically enables the Enable High Availability parameter. You cannot disable this
option.
Because distributed caches on Integration Server operate in nonstop mode, you
must congure the following parameters when you create a distributed cache. These
parameters specify how long you want Integration Server to wait for a response from
the Terracoa Server Array, and which steps you want it to take when a cache operation
takes longer than the specied time.
Parameter

Description

Timeout

Species the amount of time (in milliseconds) that must elapse

before Integration Server determines that it cannot reach the

webMethods Integration Server Administrators Guide Version 9.10

704

Odd Header
Configuring Ehcache on Integration Server

Parameter

Description
Terracoa Server Array and performs the time-out measure
specied in Timeout Behavior.

Timeout
Behavior

Species which of the following steps you want Integration

Server to take in order to complete a cache operation when the
Terracoa Server Array does not respond within the amount of
time specied in Timeout.
exception - Return a NonStopCacheException.
noop - Return a null for get operations. Ignore operations that
modify elements in the cache (for example, put, replace, and
remove operations).
localReads - Return elements that reside in the local cache in
response to get operations. Ignore operations that modify
elements in the cache (for example, put, replace, and
remove operations).

Immediate
Timeout When
Disconnected

Species whether Integration Server should automatically time

out all subsequent operations for this cache when Integration
Server recognizes that it has become disconnected from the
Terracoa Server Array.
If the Immediate Timeout When Disconnected option is enabled when
Integration Server becomes disconnected, Integration Server
immediately times out all subsequent operations on the cache and
performs the time-out measure specied in Timeout Behavior. This
option stops Integration Server from waiting for every operation
to timeout when it is in the disconnected state. The Integration
Server will begin processing cache operations normally again after
it successfully rejoins the Terracoa Server Array.

For more information about the nonstop features of a distributed cache, see the
BigMemory Max product documentation for 4.1 at www.terracoa.org/documentation.
For more information about seing these parameters on Integration Server, see "Creating
a Cache" on page 715.

Making a Cache Searchable

Integration Server uses the Ehcache search API to build indexes that you can use to
look up data in a cache. You can search against predened indexes of keys, values, or
aributes extracted from values.

webMethods Integration Server Administrators Guide Version 9.10

705

Even Header
Configuring Ehcache on Integration Server

Some keys and values are directly searchable and can simply be added to the search
index as aributes. However, you cannot search some keys or values directly. These
require that you rst extract the searchable aributes.
Once you make a cache searchable, you can use the pub.cache:search service to search the
cache. The service returns the search result as an object array. The search results can
include:
Element keys
Element values
Predened aribute values extracted from element values
Aggregator results, which are results of aggregator functions such as Average,
Count, Max, Min, and Sum.

Defining Attributes
When making a cache searchable, you can also dene the aributes to use in searches.
Aributes are extracted from keys or values during searches. You can extract aributes
from keys or values using the following methods:
Extract by Expression. Specify expressions based on which aributes are extracted
from keys or values. For example,
key.name, value.age

Extract by Class. Provide the extractor class and optionally, the properties
for the extractor class. The properties are specied as key/value pairs
separated by commas (,). The extractor must be an implementation of
net.sf.ehcache.search.attribute.AttributeExtractor. For more information
about aribute extractors, see Ehcache product documentation for 2.8 at hp://
ehcache.org/documentation.
A jar le containing the extractor must be placed in the
Integration Server_directory\instances\instance_name \lib\jars\custom directory or
the Integration Server_directory\instances\instance_name \packages\packageName
\code\jars directory.
For a sample extractor, see "Extracting Aributes by Class" on page 707.
Keep the following points in mind when making a cache searchable:
You cannot congure a system cache to be searchable.
You cannot make a cache that already contains data searchable.
For more information about making a cache searchable, see "Creating a Cache" on page
715.

webMethods Integration Server Administrators Guide Version 9.10

706

Odd Header
Configuring Ehcache on Integration Server

Extracting Attributes by Class

To extract aributes by class, the extractor must be an implementation of
net.sf.ehcache.search.attribute.AttributeExtractor. For more information
about aribute extractors, see Ehcache product documentation for 2.8 at hp://
ehcache.org/documentation.
You must create an extractor similar to the sample given below and
create a jar le containing this extractor. This jar le must be placed in the
Integration Server_directory\instances\instance_name \lib\jars\custom directory or the
Integration Server_directory\instances\instance_name \packages\packageName \code
\jars directory.
The following sample shows how to extract an aribute that has a document as the
element value in the key/value pair:
package com.softwareag.cache.sample;
import com.wm.data.IData;
import com.wm.data.IDataCursor;
import com.wm.data.IDataUtil;
import java.io.PrintStream;
import java.util.Properties;
import net.sf.ehcache.Element;
import net.sf.ehcache.search.attribute.AttributeExtractor;
import net.sf.ehcache.search.attribute.AttributeExtractorException;
public class IDataAttributeExtractor
implements AttributeExtractor
{
public IDataAttributeExtractor(Properties prop)
{
System.out.println(prop);
}
public Object attributeFor(Element element, String attributeName)
throws AttributeExtractorException
{
IDataCursor iData = ((IData)element.getValue()).getCursor();
String value = null;
if (("categoryName".equals(attributeName)) || ("categoryId".
equals(attributeName)))
{
IDataCursor category = IDataUtil.getIData(iData, "productCategory").
getCursor();
value = IDataUtil.getString(category, attributeName);
}
else
{
value = (String)IDataUtil.get(iData, attributeName);
}
System.out.println("Extracting...................." + attributeName +
"....." + value);
return value;
}
}

webMethods Integration Server Administrators Guide Version 9.10

707

Even Header
Configuring Ehcache on Integration Server

Working with Cache Managers

The procedures in this section describe how to create, view, edit, start, shutdown,
reload, and delete cache managers.

Creating a Cache Manager

Use the following procedure to create a cache manager.
To create a cache manager
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Caching.
3. Click Add Cache Manager.
4. In the Add Cache Manager screen, in the Name eld, enter a name for the cache
manager.
Valid cache manager names:
Must not be null.
Must not contain these characters: ? [ ] / \ = + < > : ; " , * | ^ @
Must not start with a period (.) or end with a space.
Must not begin with the characters SoftwareAG.
Must not be a device name in any operating system.
5. If this cache manager will include distributed caches, congure the Terracotta Server
ArrayURLs eld to specify the Terracoa Server Array on which the caches reside. In
this eld, enter a comma-separated list of addresses (in host :port format), one for
each server in the Terracoa Server Array. You can add multiple URLs by using this
format: host1:port,host2:port,...
Note:

When you specify the Terracotta Server ArrayURLs eld, the Rejoin check
box is automatically selected. Rejoin indicates that the Integration Server
will automatically reconnect to the Terracoa Server Array upon geing
disconnected. You cannot disable this option. For more information about
the Rejoin option, see "The Rejoin Behavior of a Distributed Cache" on page
703.

6. Click Save Changes.

When adding a cache manager, Integration Server veries that the supplied
Terracoa Server Array URLs are valid. Integration Server veries that the provided
URLs accept a connection. If the URLs are not valid, then Integration Server throws
an IOException and does not create the cache manager.

webMethods Integration Server Administrators Guide Version 9.10

708

Odd Header
Configuring Ehcache on Integration Server

Note:

Integration Server does not start the cache manager automatically after
creating it. You must start the cache manager by clicking the Start link.
For information about starting a cache manager see "Starting a Cache
Manager" on page 710.

Viewing or Modifying a Cache Manager

Use the following procedure to view or modify a cache manager conguration.
Note:

The modication steps in this procedure apply to public cache managers only.
You cannot modify the parameters associated with a system cache manager.

To view or modify a cache manager

1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Caching.
3. If you intend to update the Terracotta Server ArrayURLs for this cache manager, shut
down the cache manager before you proceed. You cannot modify this parameter
seing while the cache manager is running. For procedures, see "Shuing Down a
Cache Manager" on page 709.
4. In the cache managers list, click the cache manager that you want to view or modify.
5. If you want to modify the cache manager, click Edit Cache Manager Configuration
(public cache managers only).
6. Modify the cache manager conguration.
7. Click Save Changes.
8. Reload the cache manager to put the changes into eect. For procedures, see
"Reloading a Cache Manager" on page 710.

Shutting Down a Cache Manager

When a cache manager is no longer required, you can shut it down to free up resources.
If the cache manager is not connected to a Terracoa Server Array, the caches are cleared
when the cache manager is shut down. In such instances, the data in the cache is lost if
the cache is not persistent.
If the cache manager is connected to a Terracoa Server Array, the distributed caches
associated with the cache manager will not be available to services running on the local
Integration Server. However, these caches still exist on the Terracoa Server Array and
other Integration Servers can continue to use them.
Note:

This procedure applies to public cache managers only. You cannot shut down
a system cache manager.

webMethods Integration Server Administrators Guide Version 9.10

709

Even Header
Configuring Ehcache on Integration Server

To shut down a cache manager

1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Caching.
3. Under Public Cache Managers, click the Shutdown link for the cache manager that you
want to shut down.
4. When prompted to conrm that you want to shut down the cache manager, click OK.

Starting a Cache Manager

Use the following procedure to start a cache manager. All cache managers are
automatically started when Integration Server starts. However, Integration Server does
not start a cache manager after you create it. You must use this procedure to start a new
cache manager. You can also use this procedure to start a cache manager after it has been
shut down.
Note:

This procedure applies to public cache managers only. You cannot manually
start a system cache manager.

Integration Server uses the conguration from the cache manager conguration le
when starting the cache manager for the rst time. When you restart a cache manager,
Integration Server uses the conguration information that is cached in the memory.
Note:

When you start a cache manager, the caches within it are enabled
automatically.

To start a cache manager

1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Caching.
3. In the Public Cache Managers list, click the Start link for the cache manager that you
want to start.
4. When prompted to conrm that you want to start the cache manager, click OK.

Reloading a Cache Manager

Use the following procedure to reload a cache manager without restarting Integration
Server. When reloading a cache manager, keep the following points in mind:
To reload a cache manager, the cache manager must be running.
When you reload a cache manager, its local caches are deleted and recreated. If a
cache is not persistent, the data in it is lost.
If the cache manager is connected to a Terracoa Server Array, the distributed caches
associated with the cache manager will not be available to the services running on
webMethods Integration Server Administrators Guide Version 9.10

710

Odd Header
Configuring Ehcache on Integration Server

this Integration Server during the reload process. However, once the cache manager
is reloaded, these caches, and their data, will be available again.
Note:

When you reload a cache manager, the caches within it are enabled
automatically.

Note:

This procedure applies to public cache managers only. You cannot reload a
system cache manager.

To reload a cache manager

1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Caching.
3. Under Public Cache Managers, click the reload icon
want to reload.

for the cache manager that you

4. When prompted to conrm that you want to reload the cache manager, click OK.

Deleting a Cache Manager

Use the following procedure to delete a cache manager.
When you delete a cache manager, Integration Server deletes all of the caches associated
with the cache manager and their contents.
If the cache manager contains distributed caches, those caches are no longer available to
this Integration Server. However, the caches are not deleted from the Terracoa Server
Array and they remain available to other Integration Servers that are connected to the
Terracoa Server Array.
Note:

This procedure applies to public cache managers only. You cannot delete a
system cache manager.

To delete a cache manager

1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Caching.
3. Under Public Cache Managers, click the delete icon
want to delete.

for the cache manager that you

4. When prompted to conrm that you want to delete the cache manager, click OK.

Reinitializing a Cache Manager

When you make certain kinds of changes to a cache manager or its caches, you must
reinitialize the cache manager to put the changes into eect. You can reinitialize a cache
manager in any of the following ways:

webMethods Integration Server Administrators Guide Version 9.10

711

Even Header
Configuring Ehcache on Integration Server

Restarting the Integration Server.

Starting the cache manager (if it is not already running). For procedures, see
"Starting a Cache Manager" on page 710.
Reloading the cache manager (if it is already running). For procedures, see
"Reloading a Cache Manager" on page 710.
Note:

As an alternative to reloading the cache manager, you can stop the cache
manager and restart it. These steps are equivalent to doing a reload. For
procedures, see "Shuing Down a Cache Manager" on page 709and
"Starting a Cache Manager" on page 710.

Adding a Cache Manager Configuration File to Integration Server

If you have an existing cache manager conguration le (for example, one that you
created manually or one that you copied from another Integration Server), you can add
it to your Integration Server using the following procedure.
If you are adding a conguration le that you created manually (rather than copying
a conguration le from another Integration Server), verify that the le satises the
following conditions before you perform this procedure:
The name of the le ends with the extension .xml.
The name of the le does not begin with the characters SoftwareAG.
The <ehcache> element includes the name aribute. The name aribute species
the name of the cache manager (the name under which the cache manager will
be registered in Integration Server). Make sure the name does not begin with the
characters SoftwareAG. Make sure the name is unique among cache managers on
the Integration Server to which you are copying the le.
Example:<ehcache name="MyCacheManager">
The rejoin aribute is set to true if the cache manager is congured to use a
Terracoa Server Array. In other words, if the <terracoaCong> element is present
and its url aribute is specied, make sure the rejoin aribute is also specied and
that it is set to true.
Example:<terracottaConfig url="srv3A:9510,srv3B:9510" rejoin="true">
All distributed caches that are dened in the conguration le include the <nonstop>
element. Integration Server requires all distributed caches to run in nonstop mode.
Example:
<cache
name="JLSCache01"
eternal="true"
maxElementsInMemory="5000"
overflowToDisk="false"
copyOnWrite="true"
copyOnRead="true">
<terracotta> <nonstop></nonstop> </terracotta>

webMethods Integration Server Administrators Guide Version 9.10

712

Odd Header
Configuring Ehcache on Integration Server

</cache>

Note:

If you have created your own conguration le, be aware that Integration
Server Administrator does not preserve comments when it updates a
conguration le. If your conguration le includes comments, those
comments will be discarded the rst time someone edits it using Integration
Server Administrator.

To manually add a cache manager to an Integration Server

1. Copy your conguration le to the Integration Server_directory \instances
\instance_name \cong\Caching directory.
2. Restart Integration Server to initialize the cache manager.
Note:

If the le that you copied to Integration Server in step 1 replaced the

conguration le for a cache manager that is already registered on
Integration Server, you can reload the cache manager using Integration
Server Administrator instead of restarting the Integration Server. (If the
cache manager is currently shut down, start it rst and then reload it.) For
procedures, see "Reloading a Cache Manager" on page 710.

3. Open Integration Server Administrator and go to Settings > Caching to verify that
Integration Server was able to add your cache manager successfully.
If the cache manager is not listed on the Settings > Caching page or if it is not
functioning properly, consult the server log or the Ehcache log to see whether
errors occurred during the initialization process. For information about viewing the
Ehcache log, see "Logging Ehcache Activity" on page 729. If there are problems
with the conguration le (for example, if Integration Server could not parse the le
or the le contains a duplicate cache manager name), Integration Server records an
error message in the server log and writes a full stack trace to the error log.

Manually Editing a Cache Manager Configuration File

If you are familiar with the structure of an Ehcache conguration le, you can use the
following procedure to modify the parameters in a cache manager conguration le.
You might do this, for example, to add or edit certain cache parameters that are not
shown in Integration Server Administrator.
Note:

Generally speaking, you should use the Integration Server Administrator to

modify a cache manager or a cache. Edit the conguration le manually only
when you need to edit parameters that are not exposed in the Integration
Server Administrator user interface.

Be aware that when you view a conguration le that was generated by Integration
Server Administrator, the le will not contain entries for parameters that use their
default seings. Integration Server Administrator only writes required parameters
to the conguration le and parameters whose values are dierent than their default
values. For example, if you create a new cache using Integration Server Administrator

webMethods Integration Server Administrators Guide Version 9.10

713

Even Header
Configuring Ehcache on Integration Server

and you leave the Disk Expiry Thread Interval at its default seing, the Integration Server
Administrator does not include the <DiskExpiryThreadIntervalSeconds> element in the
conguration le. It includes this element only if you change Disk Expiry Thread Interval
from its default seing.
To manually edit a cache manager configuration file
1. Go to the Integration Server_directory \instances\instance_name \cong\Caching
directory and locate the conguration le that you want to edit.
2. As a precaution, make a backup copy of the conguration le before you proceed.
Note:

Because Integration Server aempts to generate cache managers from

the XML les it nds in the Integration Server_directory\instances
\instance_name \cong\Caching directory, either store your backup copy
in another directory or change its name so that it does not have an .xml
le extension.

3. Open the conguration le in a text editor and modify it as needed. When editing
the le, keep the following points in mind:
Integration Server requires all cache managers that connect to a Terracoa Server
Array to run with rejoin enabled. If the rejoin=true aribute is present in the
<terracoaCong> element, do not remove it.
Integration Server requires all distributed caches to run in nonstop mode. Never
remove the <nonstop> option from a distributed cache denition.
Integration Server does not preserve comments in its cache manager
conguration les. If you add comments to the conguration le while you are
editing it, be aware that those comments will be discarded the rst time that
someone edits the conguration le using Integration Server Administrator.
For information about the parameters in a cache manager conguration le, see
Ehcache product documentation for 2.8 at hp://ehcache.org/documentation.
4. After you save the conguration le, use one of the following techniques to
reinitialize the cache manager whose conguration le you edited.
Restart Integration Server.
Start the cache manager (if it is not already running) and then immediately
reload it (to force it to read the updated conguration le from disk). For
procedures, see "Starting a Cache Manager" on page 710 and "Reloading a
Cache Manager" on page 710.
Reload the cache manager (if it is already running). For procedures, see
"Reloading a Cache Manager" on page 710.
5. Use Integration Server Administrator to view the cache manager and its caches. If
you need procedures for this step, see "Viewing or Modifying a Cache Manager" on
page 709or "Viewing or Modifying Cache Seings" on page 726.

webMethods Integration Server Administrators Guide Version 9.10

714

Odd Header
Configuring Ehcache on Integration Server

If the cache manager or the cache is not listed in the Integration Server Administrator
or if it is not functioning properly, consult the server log or the Ehcache log to see
whether errors occurred during the initialization process. For information about
viewing the Ehcache log, see "Logging Ehcache Activity" on page 729. If there
are problems with the conguration le (for example, if Integration Server cannot
parse the le or the le contains a duplicate cache manager name), Integration Server
records an error message in the server log and writes a full stack trace to the error
log.
6. If you modied any of the cache-wide parameters for a distributed cache (which are
the Maximum Elements in Memory, Eternal, Time to Live, Time to Idle, Maximum Entries in
Cache, and Logging parameters), perform the following steps to put your changes into
eect:
a. In Integration Server Administrator, click Caching in the Settings menu of the
Navigation panel.
b. Click the cache manager containing the cache that you modied.
c. Under Cache List, click the cache that you modied.
d. Click Save Changes.
This step puts the cache-wide seings into eect on this Integration Server and
all other Integration Servers that use the distributed cache.

Working with Caches

The procedures in this section describe how to create, edit, clear, disable, enable, and
delete a cache.

Creating a Cache
Use the following procedure to create a cache.
Note:

You cannot add a cache to a system cache manager.

You must complete the following before you create a cache:

The cache manager to which you want to add the cache must already exist. If you
need to create the cache manager, see "Creating a Cache Manager" on page 708.
If you are creating a distributed cache, your Integration Server must have a license
to use a Terracoa Server Array. In addition, the cache manager to which you
want to add the cache must be congured to use a Terracoa Server Array. For
more information about licenses, see "Installing, Viewing, and Changing the
Terracoa License" on page 690.
If you want to create an o-heap cache (a cache that uses BigMemory), your
Integration Server must have a license to use BigMemory. For more information

webMethods Integration Server Administrators Guide Version 9.10

715

Even Header
Configuring Ehcache on Integration Server

about licenses, see "Installing, Viewing, and Changing the Terracoa License" on
page 690.
If you are creating a cache for the rst time, review the following sections before you
begin.
If you want to
create...

See the following topic...

An on-heap
cache

"Conguring an On-Heap Cache" on page 691.

An o-heap
cache

"Conguring a BigMemory Cache" on page 693.

A distributed
cache

"Conguring a Distributed Cache" on page 696.

Note:

The parameter descriptions in the following procedure indicate whether a

parameter is dynamic or non-dynamic. If the parameter applies to a distributed
cache, the description also indicates whether it is cache-wide or client-specic.
For more information about dynamic and non-dynamic parameters, see
"Dynamic vs. Non-Dynamic Cache Parameters" on page 689. For more
information about cache-wide and client-specic parameters, see "Cache-Wide
and Client-Specic Parameters for a Distributed Cache" on page 701.

To create a cache
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Caching.
3. Under Public Cache Managers, click the cache manager to which you want to add a
cache.
4. Click Add Cache.
5. Under Cache Configuration, specify the following information.
Field

Description

Cache Name

Name for the cache. A valid cache name:

Must be unique within a cache manager.
Must not be null.
Must not contain these characters:
?[]/\=+<>:;,*|^@

webMethods Integration Server Administrators Guide Version 9.10

716

Odd Header
Configuring Ehcache on Integration Server

Field

Description
Note: You cannot modify the name of a cache once the
cache is created.

Maximum Elements in
Memory

Total number of elements that this cache can keep in

on-heap memory. A value of 0 sets no limit. However,
specifying no limit can aect performance. Therefore,
Software AG recommends seing this eld to a value
greater than 0.
Note: When you are using o-heap memory (BigMemory),
Software AG recommends seing this eld to
at least 100 elements to minimize performance
degradation.
This parameter is: Dynamic. Cache-wide.

Eternal

Optional. When selected, indicates that the elements in

this cache will never expire once they are put into the
cache. If selected, values in Time to Live and Time to Idle are
ignored.
This check box is cleared by default.
This parameter is: Dynamic. Cache-wide.

Time to Live

Optional. Maximum amount of time (in seconds) that an

element can remain in the cache regardless of whether
it is accessed or not. A value of 0 indicates that elements
in this cache do not have a time-to-live expiration. The
default value is 0.
This eld is ignored when Eternal is selected.
Note: If you set both Time to Live and Time to Idle to 0,
elements in the cache will never expire. Seing both
of these elds to 0 is equivalent to selecting the
Eternal check box.
If you need to modify this eld after creating the
Important:
cache as part of a distributed cache, do not change
this value if the cache manager is shut down.
Doing so will cause Integration Server to issue an
exception and the cache manager will not start. To
change this parameter, rst start the cache manager
by following the procedure in "Starting a Cache
Manager" on page 710.

webMethods Integration Server Administrators Guide Version 9.10

717

Even Header
Configuring Ehcache on Integration Server

Field

Description
This parameter is: Dynamic. Cache-wide.

Time to Idle

Optional. Maximum amount of time (in seconds) that an

element can remain in the cache without being accessed.
A value of 0 indicates that elements in this cache do not
have a time-to-idle expiration. The default value is 0.
This eld is ignored when Eternal is selected.
Note: If you set both Time to Live and Time to Idle to 0,
elements in the cache will never expire. Seing both
of these elds to 0 is equivalent to selecting the
Eternal check box.
If you need to modify this eld after creating the
Important:
cache as part of a distributed cache, do not change
this value if the cache manager is shut down.
Doing so will cause Integration Server to issue an
exception and the cache manager will not start. To
change this parameter, rst start the cache manager
by following the procedure in "Starting a Cache
Manager" on page 710.
This parameter is: Dynamic. Cache-wide.

Overflow to Disk

Optional. When selected, indicates that Integration

Server writes elements to disk when the memory-based
portion of on-heap and o-heap cache is lled.
If you select this check box, make sure that the key/value
pairs used for elements in the cache are Java serializable.
Not doing so would result in an exception while using
the cache during the execution of public Integration
Server services.
This check box applies to local caches only and is cleared
by default. It is disabled for distributed caches when the
Persist to Disk check box is selected.
This parameter is: Non-dynamic. Not applicable to
distributed cache.

Persist to Disk

Optional. When selected, indicates that Integration

Server maintains a copy of the entire cache on disk so
that the state of the cache is preserved when Integration
Server is shut down or the cache manager is reinitialized.

webMethods Integration Server Administrators Guide Version 9.10

718

Odd Header
Configuring Ehcache on Integration Server

Field

Description
If you select this check box, make sure that the key/value
pairs used for elements in the cache are Java serializable.
Not doing so would result in an exception while using
the cache during the execution of public Integration
Server services.
Note: Caches that have Persist to Disk enabled cannot be
changed to any other form of persistence once the
cache manager is started.
This check box applies to local caches only and is cleared
by default. It is disabled for distributed caches when the
Overflow to Disk check box is selected.
This parameter is: Non-dynamic. Not applicable to
distributed cache.

Maximum Entries
Local Disk

Optional. Maximum number of elements that can be

maintained in this cache, on-heap, o-heap, and on-disk
combined. For example, if you have an on-heap cache
of 5000 elements and you want to allow a maximum of
1000 additional elements to overow to disk, set Maximum
Entries Local Disk to 6000.
A value of 0 sets no limit. However, specifying no limit
can aect performance and can lead to errors if the disk
runs out of space. Therefore, Software AG recommends
seing this eld to a value greater than 0.
Note: This eld applies to only to local caches and is
enabled only when the Overflow to Disk check box is
selected.
This parameter is: Dynamic. Client-specic.

6. If you are creating a distributed cache, select the Distributed check box and then
congure the following elds under Distributed Cache Configuration:
Note:

You can only select the Distributed check box if 1) Your Integration Server
has the licenses necessary to create a distributed cache, and 2) The
Terracotta Server ArrayURLs eld is congured in the cache manager to
which you are adding the cache. For more information about licenses, see
"Installing, Viewing, and Changing the Terracoa License" on page 690.

webMethods Integration Server Administrators Guide Version 9.10

719

Even Header
Configuring Ehcache on Integration Server

Field

Description

Consistency

Model to use to ensure consistency of elements across all

caches in the cluster. Select one of the following:
strong guarantees the consistency of elements across
the cluster at all times by immediately synchronizing
updates to an element across the cluster. This is the
default.
eventual guarantees eventual consistency of elements
across the cluster. With this seing, updates to an
element are not immediately synchronized across the
cluster.
Do not change this value if the cache manager is
Important:
shut down. Doing so will cause Integration Server
to issue an exception and the cache manager will
not start. To change this parameter, follow the
procedure in "Modifying Seings for a Distributed
Cache" on page 727.
This parameter is: Non-dynamic. Client-specic.

Maximum Entries in
Cache

The maximum size (in number of elements) to which this

cache can grow on the Terracoa Server Array.
Do not change this value if the cache manager is
Important:
shut down. Doing so will cause Integration Server
to issue an exception and the cache manager will
not start. To change this parameter, follow the
procedure in "Modifying Seings for a Distributed
Cache" on page 727.
This parameter is: Dynamic. Cache-wide.

Enable High
Availability

When selected, indicates that you want to enable nonstop

behavior for the distributed cache. Nonstop behavior
allows Integration Server to take a prescribed action if
an operation on the distributed cache does not complete
within a specied timeout period (for example, if the
Terracoa Server Array is unresponsive because it is
busy or if the network connection is down). For more
information about nonstop behavior, see "The Nonstop
Behavior of a Distributed Cache" on page 704.

webMethods Integration Server Administrators Guide Version 9.10

720

Odd Header
Configuring Ehcache on Integration Server

Field

Description
Note: Integration Server automatically selects this check
box for a distributed cache. You cannot clear this
check box.

Timeout

Optional. Amount of time (in milliseconds) that must

elapse before Integration Server determines that it cannot
reach the Terracoa Server Array and performs the timeout measure specied in Timeout Behavior. The default
value is 30000.
This parameter is: Dynamic. Client-specic.

Timeout Behavior

Step you want Integration Server to take in order to

complete a cache operation when the Terracoa Server
Array does not respond within the amount of time
specied in Timeout. Select one of the following:
exception - Returns a NonStopCacheException. This is
the default.
noop - Returns a null for get operations. Ignores
operations that modify elements in the cache (for
example, put, replace, and remove operations).
localReads - Returns elements that reside in the
local cache in response to get operations. Ignores
operations that modify elements in the cache (for
example, put, replace, and remove operations).
This parameter is: Dynamic. Client-specic.

Immediate Timeout
When Disconnected

Optional. When selected, indicates that Integration Server

should automatically time out all subsequent operations
for this cache if Integration Server becomes disconnected
from the Terracoa Server Array.
If you select this check box when Integration Server
is disconnected, Integration Server will immediately
time out all subsequent operations on the cache instead
of waiting for the timeout period specied in Timeout.
Integration Server will begin processing cache operations
normally again when it successfully rejoins the Terracoa
Server Array.
This check box is cleared by default.
This parameter is: Dynamic. Client-specic.

webMethods Integration Server Administrators Guide Version 9.10

721

Even Header
Configuring Ehcache on Integration Server

Field

Description

Synchronous Writes

Optional. When selected, indicates that synchronous

writes to the Terracoa Server Array are allowed.
Selecting this check box maximizes data integrity by
requiring Integration Servert o wait for a transaction
received acknowledgment from a server in the
Terracoa Server Array before considering the write
operation to have completed. However, enabling
synchronous writes can signicantly degrade the
performance of distributed caches. Conversely,
clearing this check box improves performance but may
compromise the integrity of the data.
This check box is only available when Consistency is set to
strong. It is cleared by default.
This parameter is: Non-dynamic. Client-specic.

7. If you are creating a local cache and you want the cache to overow to BigMemory,
select the Overflow to Off-heap check box and then congure the following eld under
BigMemory:
Note:

You can only select the Overflow to Off-heap check box if your Integration
Server is licensed to use BigMemory. For more information about licenses,
see "Installing, Viewing, and Changing the Terracoa License" on page
690. For more information about things to consider when creating a
BigMemory cache, see "Conguring a BigMemory Cache" on page 693.

Field

Description

Maximum Off-heap

Maximum amount of o-heap memory that this cache

can use. Add one of the following suxes to the amount
to indicate the unit of measure:
k or K for kilobytes
m or M for megabytes
g or G for gigabytes
t or T for terabytes
For example, 2g allocates 2 gigabytes to o-heap
memory. The minimum amount you can allocate is 1
megabyte. There is no maximum.
This eld applies to local caches only and is available
only if Overflow to Off-heap is selected.

webMethods Integration Server Administrators Guide Version 9.10

722

Odd Header
Configuring Ehcache on Integration Server

Field

Description
This parameter is: Non-dynamic. Not applicable to
distributed cache.

8. Congure the following elds under Cache Configuration Advanced Settings:

Field

Description

Disk Expiry Thread

Interval

Optional. Amount of time (in seconds) that Integration

Server waits before checking for and removing expired
elements based on the values set for Time to Live and Time
to Idle. The default value is 120 seconds.
This eld applies to local caches only and is enabled
only when the Overflow to Disk check box is selected. It is
disabled for distributed caches.
This parameter is: Non-dynamic. Not applicable to
distributed cache.

Disk Spool Buffer Size

Optional. Size (in megabytes) allocated on the disk store

for the spool buer that this cache uses to improve the
performance of write operations. The default size is 30
megabytes.
Consider increasing the value of this eld to improve
disk store performance, or decreasing the value if you
start to receive OutOfMemory errors.
This eld applies to local caches only and is enabled
only when the Overflow to Disk check box is selected. It is
disabled for distributed caches.
This parameter is: Non-dynamic. Not applicable to
distributed cache.

Clear on Flush

Optional. When selected, indicates that memory should

be cleared when a ush operation is performed on the
cache.
This check box is selected by default.
This parameter is: Non-dynamic. Client-specic.

Copy on Read

Optional. When selected, indicates that a copy of the

element is returned when the element is read from the
cache. Any changes you make to the element aect only
the copy. When you put the copy of the element back

webMethods Integration Server Administrators Guide Version 9.10

723

Even Header
Configuring Ehcache on Integration Server

Field

Description
into the cache, the changes become visible to other users
of the cache.
When this check box is cleared, the element is not copied.
Any changes you make to the element aect the element
directly, through its reference, even if a put operation
has not been performed to replace the element in the
cache.
This check box is cleared by default.
This parameter is: Non-dynamic. Client-specic.
Note: Selecting this check box provides a degree of safety
against certain logic errors in your application.
However, each get operation on the cache causes
a copy of the element to be created. This can
aect performance, especially for large elements.
Alternatively, consider structuring your application
code so that cache gets are isolated, and references to
cached objects are not retained by the application.
Do not change this value if the cache manager is
Important:
shut down. Doing so will cause Integration Server
to issue an exception and the cache manager will
not start. To change this parameter, follow the
procedure in "Modifying Seings for a Distributed
Cache" on page 727.

Copy on Write

Optional. When selected, indicates that a copy of the

element is placed in the cache during a put operation.
Any subsequent changes you make to the element aect
only the copy. When you put the copy of the element
back into the cache, the changes become visible to other
users of the cache.
When this check box is cleared, put operations pass the
element by reference. If you retain a reference to the
element after it is put into the cache, any changes you
make to the element will also modify the element in the
cache, even if you do not do a subsequent put operation.
This check box is cleared by default.
This parameter is: Non-dynamic. Client-specic.
Note: Selecting this check box provides a degree of safety
against certain logic errors in your application.
However, each put operation on the cache

webMethods Integration Server Administrators Guide Version 9.10

724

Odd Header
Configuring Ehcache on Integration Server

Field

Description
causes a copy of the element to be created. This can
aect performance, especially for large elements.
Alternatively, consider structuring your application
code so that cache put operations are isolated, and
references to cached objects are not retained by the
application.

Memory Store Eviction

Policy

Optional. Policy used to remove elements from the

memory store when the value in Maximum Elements in
Memory is reached. Select one of the following:
LRU (Least Recently Used). This is the default.
LFU (Least Frequently Used)
FIFO (First In First Out). This seing is not available for
distributed caches.
This parameter is: Dynamic. Client-specic.

Logging

Optional. When selected, indicates that basic distributedmap logging messages are saved to the Terracoa logs.
This check box is cleared by default.
Note: When this check box is selected for a distributed
cache, logging events are recorded on the Terracoa
Server Array. For more information about logging,
see "Logging Ehcache Activity" on page 729.
This parameter is: Non-dynamic. Client-specic.

9. To make the cache searchable, select the Searchable check box and congure the
following eld under Search Configuration:
Field

Description

Allow Automatic
Indexing

Optional. When you select either Key, Value, or both,

Integration Server automatically indexes the searchable
keys and values. If you are not planning to include the
keys and values in your query, do not enable automatic
indexing.
Note: If you select automatic indexing, you cannot have a
mix of search types for keys or values.
This parameter is: Non-dynamic. Cache-wide.

webMethods Integration Server Administrators Guide Version 9.10

725

Even Header
Configuring Ehcache on Integration Server

10. Under Search Attributes, dene one or more aributes that will be used in searches by
conguring the following elds:
Field

Description

Attribute

Name of the aribute.

Extract Method

The method to use to extract the search aributes from keys or

values. Select one of the following:
Expression to specify expressions based on which aributes
are extracted from keys or values. Enter the expression in the
Class/Expression eld. For example, key.name, value.age.
Class to provide the extractor class and, optionally, the
properties for the extractor class. Enter the extractor class in
the Class/Expression eld. In the Properties eld, specify the
properties as key/value pairs separated by commas (,).
The extractor must be an implementation of

net.sf.ehcache.search.attribute.AttributeExtractor.

For more information about aribute extractors, see

"Dening Aributes" on page 706 and Ehcache product
documentation for 2.8 at hp://ehcache.org/documentation.
Add/Remove

Click
to add or
searches.

to delete search aributes to use in

11. Click Save Changes. Integration Server creates the cache and places it in the disabled
state.
12. When you are ready to put the cache into use, enable it using the procedure in
"Enabling a Cache" on page 728.

Viewing or Modifying Cache Settings

Use the following procedure to view cache seings or modify the cache-wide seings
for an existing cache. You can modify client-specic seings by manually editing the
cache manager conguration le. For more information, see "Manually Editing a Cache
Manager Conguration File" on page 713.
Note:

This procedure describes how to modify a cache that is not distributed.

For information about modifying cache seings for a distributed cache, see
"Modifying Seings for a Distributed Cache" on page 727.

Note:

Be aware that many of the parameters associated with a system cache are
system-dened and cannot be edited in Integration Server Administrator.
When you edit a system cache, you can see all of its parameters, but you

webMethods Integration Server Administrators Guide Version 9.10

726

Odd Header
Configuring Ehcache on Integration Server

can edit only certain seings. If you are editing a system cache for another
webMethods product, such as Trading Networks, consult the product
documentation for guidelines.
To view or modify cache settings
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Caching.
3. Click the cache manager containing the cache that you want to view or modify.
4. Under Cache List, click the cache you want to view or modify.
5. View cache seings or modify the cache-wide seings as necessary.
For more information about the caches seings, see "Creating a Cache" on page
715.
6. If you have made changes to the cache seings, click Save Changes to save them.

Modifying Settings for a Distributed Cache

Use the following procedure to modify seings for distributed caches.
To modify settings for a distributed cache
1. Shut down the cache manager on all clients. For more information, see "Shuing
Down a Cache Manager" on page 709.
2. Use the Terracoa Management Console to delete the oine data. For more
information about the Terracoa Management Console, see Ehcache product
documentation for 2.8 at hp://ehcache.org/documentation.
3. Modify the necessary seings in the cache manager conguration le. For more
information, see "Manually Editing a Cache Manager Conguration File" on page
713.
4. Restart the cache manager. For more information, see "Starting a Cache Manager" on
page 710.

Disabling a Cache
You can disable a cache to troubleshoot a load or performance issue, for example.
Any get operations performed against a disabled cache return null, and any put
operations are discarded. Existing cache elements remain in the cache and can be used
again when the cache is enabled (assuming the cache manager has not been initialized in
the meantime).
If the cache is distributed, the cache is disabled only on the Integration Server where the
disable operation is performed. The cache still resides on the Terracoa Server Array and
remains accessible to other Integration Servers connected to the Terracoa Server Array.

webMethods Integration Server Administrators Guide Version 9.10

727

Even Header
Configuring Ehcache on Integration Server

Note:

You can only disable a cache that belongs to a public cache manager.

To disable a cache
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Caching.
3. Under Public Cache Managers, click the cache manager associated with the cache you
want to disable.
4. Under Cache List, click the Yes link in the Enabled column next to the cache you want
to disable.
5. When prompted to conrm that you want to disable the cache, click OK.

Enabling a Cache
A cache becomes enabled automatically when the cache manager it belongs to is started
or reloaded. Put and get operations can be performed against an enabled cache.
When you enable a disabled cache, all the elements stored previously in the cache are
again available (assuming the cache manager has not been initialized in the meantime).
Note:

To enable a disabled cache, the cache manager must be running. You cannot
enable a cache while its cache manager is shut down.

Note:

You can only enable a cache that belongs to a public cache manager.

To enable a cache
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Caching.
3. Under Public Cache Managers, click the cache manager associated with the cache you
want to enable.
4. Under Cache List, click the No link in the Enabled column next to the cache you want
to enable.
5. When prompted to conrm that you want to enable the cache, click OK.

Clearing a Cache
When you clear a cache, you remove all elements from that cache.
If the cache is distributed, this procedure removes all elements from that cache on the
Terracoa Server Array.
Note:

You can only clear a cache that belongs to a public cache manager.

webMethods Integration Server Administrators Guide Version 9.10

728

Odd Header
Configuring Ehcache on Integration Server

To clear a cache
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Caching.
3. Under Public Cache Managers, click the cache manager associated with the cache you
want to clear.
4. Under Cache List, click the clear icon

next to the cache that you want to clear.

5. When prompted to conrm that you want to clear the cache, click OK.
Note:

If the clear operation encounters any previously acquired locks on

elements, the operation will wait until all the locks are released. As
a result, if the locks are not released, the clear operation may wait
indenitely to complete.

Deleting a Cache
Deleting a cache removes the cache from the cache manager. If the cache is local, the
existing elements in the cache are discarded.
If the cache is distributed, the cache is no longer available to the Integration Server from
which it is deleted. The cache remains available on other Integration Servers connected
to the Terracoa Server Array.
Note:

You can only delete a cache that belongs to a public cache manager.

To delete a cache
1. Open Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Caching.
3. Under Public Cache Managers, click the cache manager associated with the cache that
you want to delete.
4. Under Cache List, click the delete icon

next to the cache that you want to delete.

5. When prompted to conrm that you want to delete the cache, click OK.

Logging Ehcache Activity

Ehcache uses Simple Logging Facade for Java (SLF4J) and its log4J facility to log
information about Ehcache activities on Integration Server. Ehcache also creates
additional log les when cache managers connect to the Terracoa Server Array.

webMethods Integration Server Administrators Guide Version 9.10

729

Even Header
Configuring Ehcache on Integration Server

Logging Ehcache Caching Services

Ehcache logs its messages to the console. Integration Server redirects the Ehcache log
messages to the ehcache.log le located in the Integration Server_directory\instances
\instance_name \logs directory.
Ehcache logging has a default conguration, but you can change it by modifying the
tc.dev.log4j.properties le. This le is located in the Integration Server_directory directory.
The logging level is set to Warn. When the logging level is set to Warn, it includes all the
Fatal, Error, and Warn messages that are logged by Ehcache.
Note:

For details about log4J, refer to Apache logging services at hp://

logging.apache.org/log4j/1.2/index.html.

Logging Cache Manager Activity in the Terracotta Server Array

Ehcache creates additional log les on the server containing log data you can provide to
Software AG Global Support for troubleshooting assistance. Ehcache creates these log
les in the following situations:
When an Integration Server in a cluster starts up and connects to the Terracoa
Server Array.
When a public cache manager containing distributed caches reloads or starts up.
You specify where you want Ehcache to put the log les by seing the
wa.server.cachemanager.logsDirectory property on Integration Server. The default
value for this property is Integration Server_directory\instances\instance_name \logs
\tc-client-logs. For information about how to edit this property, see "Working with
Extended Conguration Seings" on page 130.
Note:

During start up Integration Server copies the value of the

wa.server.cachemanager.logsDirectory property into the
com.softwareag.tc.client.logs.directory property. When you congured the
tc-cong.xml le for the Terracoa Server Array, you dened this property
for the <client><logs> seing. For information about conguring the tccong.xml le, see "Conguring tc-cong.xml on the Terracoa Server Array "
on page 699.

webMethods Integration Server Administrators Guide Version 9.10

730

Odd Header
Configuring the Enhanced XML Parser

33 Configuring the Enhanced XML Parser

What Is the Enhanced XML Parser? .........................................................................................

732

How Does the Enhanced XML Parser Work? ...........................................................................

732

When Is the Enhanced XML Parser Used? ...............................................................................

734

Configuring the Enhanced XML Parser .....................................................................................

735

Setting the Partition Size ...........................................................................................................

738

Viewing Peak Usage Statistics ..................................................................................................

739

webMethods Integration Server Administrators Guide Version 9.10

731

Even Header
Configuring the Enhanced XML Parser

What Is the Enhanced XML Parser?

The enhanced XML parser is an XML parser within Integration Server that leverages
Ehcache during the parsing process. Depending on memory availability, the enhanced
XML parser will use Ehcacheto move already parsed portions of the document to a
local disk store or o-heap cache (BigMemory). By migrating data, the enhanced XML
parser frees up heap space for other documents or other system processes. The ability to
move data to a local disk store or BigMemory enables the parser to parse multiple XML
documents, including multiple large XML documents, without monopolizing the JVM
heap.
The enhanced XML parser produces a DOM tree, specically a tree of
org.w3c.dom.Node objects, that is read-only. The DOM tree is a special representation of
an XML document that can be consumed by any program that uses the standard DOM
API. Integration Server built-in services that took a node produced by the legacy XML
parser as input have been updated to take a DOM node as well. Integration Server also
includes services for using the enhanced XML parser to create a DOM node from an
XML document.
In contrast, the legacy XML parser parses an XML (or HTML) document by creating a
collection of nodes that remain in the heap during the entire parsing process. The legacy
parser produces a tree of com.wm.lang.xml.Node objects, which is a tree of nodes that is
similar in structure to a DOM object.
Because the legacy XML parser maintains all of the nodes on the heap while parsing,
large documents or multiple documents being parsed at once result in a large number
of objects on the heap. This can degrade performance during garbage collection.
Additionally, if the legacy XML parser exceeds the amount of available heap while
parsing, the Java virtual machine (JVM) throws an OutOfMemoryError. To handle large
documents with the legacy XML parser, you can increase the heap size or use services
like the queryXMLNode service or the nodeIterator services in pub.xmlto limit the portions of
the node maintained in the heap. The enhanced XML parser handles large documents,
multiple documents, and multiple large documents more eciently by providing
memory management without the use of other services.
Note:

While the legacy XML parser can create a node from an XML document or an
HTML document, the enhanced XML parser parses XML documents only.

For more information about Ehcache and BigMemory, see "Conguring Ehcache on
Integration Server " on page 681.

How Does the Enhanced XML Parser Work?

The enhanced XML parser parses a document by serializing it into partitions that reside
on the JVM heap. As the number of partitions and the amount of heap space required
to parse the document increases, the parser uses Ehcache to move partitions to a local

webMethods Integration Server Administrators Guide Version 9.10

732

Odd Header
Configuring the Enhanced XML Parser

disk store or o-heap cache (BigMemory). Integration Server retrieves the partitions as
needed to fulll subsequent processing requests.
The enhanced xml parser uses heap allocation limits to determine when to migrate
partitions to a local disk store or BigMemory. The heap allocation limits enable the
enhanced XML parser to throle its use of heap. This reduces the chances of unstable
behavior when the Integration Server operates at peak capacity. You can set limits for:
The total heap space used by any single parsed document.
The total heap space used by all parsed documents combined.
The total amount of BigMemory used by all parsed documents
Following is an overview of how the enhanced XML parser parses an XML document:
1. The enhanced XML parser receives a request to parse a document. To begin parsing
a document, the enhanced XML parser creates six partitions of the same size in the
heap. The size of the partitions is determined by the partitionSize value passed to
the service or the default partition size congured for the enhanced XML parser. For
more information about the partition size, see "Seing the Partition Size" on page
738.
However, if there is not sucient heap space to create six partitions, the enhanced
XML parser delays parsing the document until sucient heap space becomes
available. There might not be sucient heap space if the amount of heap space
currently used for parsed documents is at or near the limit specied by the Maximum
heap allocation for all documents combined eld.
2. The enhanced XML parser serializes the XML document into the partitions on the
heap, creating more partitions of the same size as needed.
3. During parsing, if the total heap space required to parse the document meets the
limit specied by the Maximum heap allocation for any single document eld or the limit
specied by Maximum heap allocation for all documents combined, one of the following
occurs:
If caching is not enabled, meaning that the parser does not use Ehcache to help
manage memory, the JVM may throw an OutOfMemoryError. The enhanced
XML parser will not nish parsing the document, and the service from which the
parser was called will fail.
If caching is enabled, but BigMemory is not, the enhanced XML parser uses
Ehcache to move some partitions from the heap to a local disk store.
If caching is enabled and BigMemory is enabled, the enhanced XML parser
uses Ehcache to move some partitions from the heap to BigMemory. If the
amount of BigMemory used by the enhanced XML parser exceeds the limit set
by the MaximumBigMemoryallocation eld, the enhanced XML parser throws an
UnxepectedCachingException.
In rare circumstances, the enhanced XML parser might throw the following exceptions:

webMethods Integration Server Administrators Guide Version 9.10

733

Even Header
Configuring the Enhanced XML Parser

If the aggregate aribute value length for any single XML element
exceeds 65535 characters, the enhanced XML parser throws an
ImplementationLimitCachingException.
If the partition size is relatively small and an individual XML element
contains a very large number of aributes or the aggregate length of the
aribute values for an element is very long, Integration Server might throw a
PartitionSizeCachingException. To resolve this issue, increase the partition size. For
more information about the partition size, see "Seing the Partition Size" on page
738.

When Is the Enhanced XML Parser Used?

Integration Server uses the enhanced XML parser to parse an XML document only when
the enhanced parser is specically engaged. The enhanced XML parser can be engaged
in one of the following three ways:
By invoking pub.xml:loadEnhancedXMLNode.
By invoking pub.xml:xmlStringToEnhancedXMLNode.
By an HTTP/S POST request with a Content-Type of text/xml or application/xml that
posts a request to a target service and one of the following is true:
The request species xmlFormat=enhanced.
The request does not specify an xmlFormat value but the target service has a
Default xmlFormat property value of enhanced.
The request does not specify an xmlFormat value, the Default xmlFormat property
on the target service is blank, and wa.server.hp.xmlFormat is set to enhanced.
For more information about xmlFormat in HTTP requests and the Default xmlFormat
property, see webMethods Service Development Help.
Any services or applications that used the legacy XML parser will continue to do so.
For the enhanced XML parser to be used in an existing service or application, you must
change the service or application to call the enhanced XML parser using one of the
methods listed above.
Note:

For existing services or applications, Software AG does not

recommend engaging the enhanced XML parser by changing the
wa.server.hp.xmlFormat parameter to enhanced. This is a global parameter
that aects the entire Integration Server. Changing the default xmlFormat
for all of Integration Server instead of changing the xmlFormat on service or
application basis might cause existing services and applications to fail.

webMethods Integration Server Administrators Guide Version 9.10

734

Odd Header
Configuring the Enhanced XML Parser

What Services Consume an Enhanced Node?

Most existing WmPublic built-in services that took a node produced by the legacy XML
parser as input (specically a node of type com.lang.wm.xml.Node) can also take a node
produced by the enhanced XML parser. This includes the following services:
pub.xml:xmlNodeToDocument
pub.xml:queryXMLNode
pub.xml:getXMLNodeIterator
pub.xml:freeXMLNode
The exception is the pub.schema:validate service. This service cannot be used to validate a
node produced by the enhanced XML parser.

Configuring the Enhanced XML Parser

When you congure the enhanced XML parser, you indicate the memory usage limits
for the parser and whether or not partitions will overow to a local disk store or
BigMemory when the usage limits are met.
Keep the following information in mind when conguring the enhanced XML parser.
To take advantage of the memory management provided by the enhanced XML
parser, you must enable caching. When caching is enabled, the enhanced XML
parser uses Ehcache to limit the amount of heap used for parsing. When caching is
not enabled, the enhanced XML parser behaves in much the same way as the legacy
XML parser.
If only caching is enabled, the enhanced XML parser uses Ehcache to move partitions
to a local disk store when heap allocation limits are met.
If caching is enabled and BigMemory is enabled, the enhanced XML parser uses
Ehcache to move partitions to BigMemory when heap allocation limits are met.
To use BigMemory with the enhanced XML parser, caching must be enabled.
Additionally, the Integration Server must be equipped with a license to use
BigMemory. To verify that the Integration Server has a BigMemory license and to
check how much BigMemory the license authorizes, see "Installing, Viewing, and
Changing the Terracoa License" on page 690.
To configure the enhanced XML parser
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Enhanced XML Parsing.
3. If you want the enhanced XML parser to use Ehcache for memory management,
under Caching, make sure the Enabled property is set to Yes. If Enabled is not set to

webMethods Integration Server Administrators Guide Version 9.10

735

Even Header
Configuring the Enhanced XML Parser

Yes, click No to change the value. Integration Server Administrator prompts you to
conrm enabling the Caching feature. Click OK.
4. If you want the enhanced XML parser to make use of BigMemory (o-heap cache),
under BigMemoryCaching, make sure the Enabled property is set to Yes. If Enabled
is not set to Yes, click No to change the value. Integration Server Administrator
prompts you to conrm enabling the BigMemory caching feature. Click OK.
Note:

To use BigMemory with the enhanced XML parser, you must enable
caching as well.

5. At the top of the Settings > Enhanced XML Parsing page, click Edit Enhanced XML Parsing
Settings.
6. Under Enhanced Parser Settings, in the Default partition size eld, specify the default
size of the partitions on the heap where the enhanced XML parser stores parsed
document information. Add one of the following suxes to indicate a unit of
measure:
k or K for kilobytes
m or M for megabytes
The default is 20k.
Note:

Integration Server uses the default partition size when parsing XML
documents received by services that specify an xmlFormat of enhanced.
For more information about xmlFormat, see webMethods Service
Development Help. The pub.xml:loadEnhancedXMLNode service and the
pub.xml:xmlStringToEnhancedXMLNode service use the default partition size if
the services do not specify a value for the partitionSize input parameter.

7. Under Caching, specify the following information:

For this field...

Specify...

Maximum heap
allocation for
all documents
combined

Maximum amount of on-heap space that the enhanced XML

parser can allocate to process documents concurrently. Add
one of the following suxes to the amount to indicate a unit
of measure:
k or K for kilobytes
m or M for megabytes
g or G for gigabytes
% to indicate a percentage of the heap space
The default is 40% of the heap space available to the JVM.
Note: If you do not specify a sux, Integration Server uses
bytes as the unit of measure.

webMethods Integration Server Administrators Guide Version 9.10

736

Odd Header
Configuring the Enhanced XML Parser

For this field...

Specify...
When the total heap used by parsed documents exceeds
the Maximum heap allocation for all documents combined
value, the enhanced XML parser will not begin parsing
more documents until heap space becomes available.
Additionally, the enhanced XML parser moves some
partitions to BigMemory (if BigMemory caching is enabled)
or a local disk store (if BigMemory caching is not enabled).
Do not set Maximum heap allocation for all documents
Important:
combined to be 100% of the heap. A value of 100%
indicates that there is no limit to the amount of
heap the enhanced XML parser can use. If enough
documents are parsed simultaneously, the JVM may
throw an OutOfMemoryError.

Maximum heap
allocation for any
single document

Maximum amount of on-heap space that the enhanced XML

parser can allocate to process a single document. Add one
of the following suxes to the amount to indicate a unit of
measure:
k or K for kilobytes
m or M for megabytes
g or G for gigabytes
% to indicate a percentage of the heap space available to the
JVM
The default is 20% of the heap space.
Note: If you do not specify a sux, Integration Server uses
bytes as the unit of measure.
When the total heap used by a single parsed document
exceeds the Maximum heap allocation for any single document
value, the enhanced XML parser moves some partitions to
BigMemory (if BigMemory caching is enabled) or a local
disk store (if BigMemory caching is not enabled).
Do not set Maximum heap allocation for any single
Important:
document to be 100% of the heap. A value of 100%
indicates that there is no limit to the amount of
heap the enhanced XML parser can use. If enough
documents are parsed simultaneously, the JVM may
throw an OutOfMemoryError.

webMethods Integration Server Administrators Guide Version 9.10

737

Even Header
Configuring the Enhanced XML Parser

8. Under BigMemoryCaching, in the MaximumBigMemoryallocation eld, specify the

maximum amount of BigMemory that can be allocated to parsing documents with the
enhanced XML parser.
k or K for kilobytes
m or M for megabytes
g or G for gigabytes
The default is 200m.
Note:

If you do not specify a sux, Integration Server uses bytes as the unit of
measure.

When the partitions in BigMemory exceed the limit set by the

MaximumBigMemoryallocation value, the enhanced XML parser throws an
UnxepectedCachingException.
9. Click Save Changes.
Changes do not take eect immediately. Changes will take eect when there are no
references to any of the parsed documents produced by the enhanced xml parser.

Setting the Partition Size

When the enhanced XML parser parses a document, it places the content into
xed-size partitions. While the parser determines the size of the partitions, you
can provide guidance to the parser by specifying the partition size. You can only
specify partition size when using the pub.xml:loadEnhancedXMLNode service or the
pub.xml.xmlStringtoEnhancedMLNode service. Both services have an input parameter named
partitionSize . Keep the following points in mind when seing a partition size:
The partitionSize is a hint for the enhanced XML parser so that it can estimate the
amount of heap space needed to parse the document. Often, it not possible to
determine the size of an inbound XML document before parsing.
As a general rule, Software AG recommends a partitionSize that is 1/2 the size of the
unparsed XML document.
A partitionSize that is considerably larger than 1/2 the size of the unparsed XML
document causes the enhanced XML parser to consume more heap space than
necessary but might also improve throughput. However, this can impact the
overall performance of Integration Server.
A partitionSize that is considerably smaller than 1/2 the size of the unparsed XML
document causes the enhanced XML parser to create a large number of partitions
to parse the document. While this might use less heap space, it may reduce the
throughput of the parser.

webMethods Integration Server Administrators Guide Version 9.10

738

Odd Header
Configuring the Enhanced XML Parser

A partitionSize that is three times smaller or three times larger than 1/2 the size of
the unparsed XML document will likely have lile impact on the performance.
At run time, the enhanced XML parser overrides a partitionSize that consumes all of
the available heap space.
At run time, if the partitionSize results in an initial heap allocation that exceeds the
single document limit set in the Maximum heap allocation for any single document eld
the limit for all documents set in the Maximum heap allocation for all documents combined
eld, the enhanced XML parser reduces the partition size automatically.
If you do not specify partitionSize , the enhanced XML parser uses the default
specied in the Default partition size eld on the Settings > Enhanced XML Parsing page in
Integration Server Administrator.
When the enhanced XML parser is called via an HTTP POST request, the enhanced XML
parser uses the default partition size specied by the Default partition size eld on the
Settings > Enhanced XML Parsing page in Integration Server Administrator.

Viewing Peak Usage Statistics

Integration Server tracks peak memory usage statics for the enhanced XML parser. The
statistics cover the time period from when the Integration Server was last started to the
current time. Integration Server resets the statistics during start up.
To view usage statistics for the enhanced XML parser
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Enhanced XML Parsing.
Under Peak Usage Statistics, Integration Server Administrator displays the following
information:
Field

Description

Peak heap allocation for all

documents combined

The maximum amount of heap used by the

enhanced XML parser for parsing multiple
documents at one time.

Peak heap allocation for any

single document

Maximum amount of heap used by the

enhanced XML parser for parsing one
document.

PeakBigMemoryuse

Maximum amount of BigMemory used by the

enhanced XML parser at one time.

webMethods Integration Server Administrators Guide Version 9.10

739

Even Header

webMethods Integration Server Administrators Guide Version 9.10

740

Odd Header
Locking Administration and Best Practices

34 Locking Administration and Best Practices

Introduction .................................................................................................................................

742

Choosing Local Server Locking or VCS Integration Locking .....................................................

742

Disabling and Re-enabling Locking ...........................................................................................

742

Best Practices ............................................................................................................................

744

webMethods Integration Server Administrators Guide Version 9.10

741

Even Header
Locking Administration and Best Practices

Introduction
This chapter contains information intended for the server administrator and users who
regularly replicate and publish packages as part of the production process.

Choosing Local Server Locking or VCS Integration Locking

You can congure the webMethods Integration Server to support either of the following
two forms of locking:
Local locking, applied within the Integration Server le system.
Locking resulting from integration with a third-party version control system (VCS)
repository; in this case, elements are locked and unlocked as you check them out of
and in to the VCS repository.
The locking administration tasks described in this chapter refer to local locking on the
Integration Server. If your server environment does not make use of a version control
system, congure the Integration Server for local locking as described in the following
sections.
You can use the local service development feature in Designer to work with a third
party version control system. For more information about local service development, see
thewebMethods Service Development Help
If you want to use the Version Control System Integration feature to work with a
third-party version control system, see Conguring the VCS Integration Feature in the
Software AG_directory\_documentation directory of your webMethods installation. This
guide provides information about how to implement and administer le locking with
the Version Control System Integration feature.
Important: The WmVCS package, which provides the functionality for using the VCS
Integration Feature, is deprecated as of Integration Server version 9.9.
Software AG recommends that you use the local service development feature
(Local Version Control Integration) to check package elements and their
supporting les into and out of a version control system (VCS) directly from
Designer.

Disabling and Re-enabling Locking

There may be times in which you do not want to implement locking on the Integration
Server. If you are a server administrator, you can disable and re-enable locking
by editing the conguration parameters in Integration Server_directory\instances
\instance_name \cong\server.cnf.
Before you disable or re-enable locking, complete the following:

webMethods Integration Server Administrators Guide Version 9.10

742

Odd Header
Locking Administration and Best Practices

Make sure that all users have completed development on the server and unlocked all
elements.
Close all Designer sessions. After you change the extended seings in the following
procedure, users will need to open a new Designer session.

Disabling Locking
To disable locking, you edit the extending seings using the Integration Server
Administrator or manually edit server.cnf. The following procedure describes the
Integration Server Administrator procedure.
Important: Make sure that you only use this method of changing the seings. Later, if
you change the seings by editing server.cnf, conicts can occur.
To disable locking on the Integration Server
1. Complete the tasks in "Disabling and Re-enabling Locking" on page 742.
2. In the Integration Server Administrator, under Settings, click Extended.
3. Click Edit Extended Settings.
4. In the Extended Seings box, type a key and value according to the following table.
If you want to...

Type this...

Disable user locking and show no locks

wa.server.ns.lockingMode=none

Disable user locking but show system

locks

wa.server.ns.lockingMode=system

5. Click Save Changes. The information is saved to Integration Server_directory \instances

\instance_name \cong\server.cnf.
6. Restart the Integration Server. The updated seings are now in eect.

Re-Enabling Locking
To re-enable locking, you use the Integration Server Administrator or manually edit
server.cnf. The following procedure describes the Integration Server Administrator
procedure.
Important: Make sure that you only use this method of changing the seings. Later, if
you change the seings by editing server.cnf, conicts can occur.

webMethods Integration Server Administrators Guide Version 9.10

743

Even Header
Locking Administration and Best Practices

To re-enable locking on the Integration Server

1. Complete the tasks in "Disabling and Re-enabling Locking" on page 742.
2. In the Integration Server Administrator, under Settings, click Extended.
3. Click Edit Extended Settings.
4. In the Extended Seings box, set the value of wa.server.ns.lockingMode to full.
5. Click Save Changes. The information is saved to Integration Server_directory \instances
\instance_name \cong\server.cnf.
6. Restart the Integration Server for the changes to take eect.

Best Practices
Remote Server Configuration
It is not recommended that you use Cooperative Development functionality in an
Integration Server cluster. Locking information for elements could be inadvertently
shared with another Integration Server in the cluster. Use a standalone Integration
Server not a cluster, while developing to eliminate these Cooperative Development
problems.

Server User Names

When logging on to the Integration Server, use a distinct user name. Locking is
based on your user name, so it is important that each user log on to the server with a
unique user name (not Administrator or Developer).

Package Replication and Publishing

Always back up your packages every day or night using package replication and
publishing. Because locking information does not travel with packages (or partial
packages) when they are replicated, it is recommended that you apply a version to
each package according to date. Do not replace or overwrite packages; delete the old
package entirely and then install the new package.
Note:

If you do replace or overwrite packages, webMethods Integration Server

takes the intersection of elements in the Navigation panel. It will also move
the existing package to the replicate\salvage folder of the server instance.

When you replicate and publish a package, the locking information is not preserved.
This is expected behavior and is part of the feature's design. You can, however,
preserve system locks (read-only le aributes).

webMethods Integration Server Administrators Guide Version 9.10

744

Odd Header
Locking Administration and Best Practices

Before you publish a package, keep in mind that user locks are not preserved.
When you salvage a deleted package, lock information is not preserved. Before
you salvage or delete a package, make sure that all locks are removed from the
destination package.
It is not recommended that you use system or user locking on packages that are
frequently replicated and/or partially replicated. For example, when sending
frequently updated packages to partners.

Package and Folder Organization

Use a single package or folder per developer or per Java/C service.

Source Code
If there has been a signicant change to the source code, always reload the package
to reect the latest system locks.

Upgrading webMethods Integration Server

When you upgrade the webMethods Integration Server to a new version, you lose all
lock information. Therefore, before upgrading, make sure that all locks are removed
and all changes are saved.

webMethods Integration Server Administrators Guide Version 9.10

745

Even Header

webMethods Integration Server Administrators Guide Version 9.10

746

Odd Header
Managing webMethods Messaging Triggers

35 Managing webMethods Messaging Triggers

Introduction .................................................................................................................................

748

Managing Document Retrieval ...................................................................................................

748

Managing Document Processing ...............................................................................................

757

Limiting Server Threads for webMethods Messaging Triggers ..................................................

766

Cluster Synchronization for webMethods Messaging Trigger Management ..............................

768

Modifying webMethods Messaging Trigger Properties ..............................................................

770

Managing Trigger Service Retries and Shutdown Requests .....................................................

772

Delaying Polling Requests for webMethods Messaging Triggers ..............................................

774

Serial Triggers Migrated to Integration Server 9.9 or Later from 9.8 or Earlier ..........................

777

webMethods Integration Server Administrators Guide Version 9.10

747

Even Header
Managing webMethods Messaging Triggers

Introduction
In a publish-and-subscribe solution, the retrieval and ow of documents through
Integration Server consumes resources, primarily server threads and memory. The
rate at which Integration Server can retrieve and process documents is determined by
the availability of these resources. However, server resources also need to be available
to perform other functions. Integration Server Administrator provides controls for
managing resources consumed by document retrieval and document processing. You
can use these controls to balance the resource demands for document retrieval and
processing with the server resources needed to perform other work.
Specically, you can use the controls provided by Integration Server Administrator to:
Increase or decrease the number of server threads used to retrieve documents from
the Broker.
Decrease the capacity of webMethods messaging trigger queues.
Suspend document retrieval for one or more webMethods messaging triggers.
Increase or decrease the number of server threads used to process documents.
Decrease the number of threads that Integration Server can use to process documents
for concurrent webMethods messaging triggers simultaneously.
Suspend document processing for one or more webMethods messaging triggers.
Change the congured trigger queue capacity, rell level, or execution threads for a
specic webMethods messaging trigger.
Additionally, the Integration Server Administrator provides a cluster synchronization
feature that you can use to propagate selected changes to other Integration Servers in a
cluster automatically.
These controls can be useful in a production environment to free up server threads
and memory to accommodate an unexpected server load (such as a sudden inux of
HTTP requests) or in anticipation of a high usage time. You can also use the controls
during the capacity planning stage of your project to determine the congured values
for webMethods messaging triggers and server thread usage.
The following sections contain more information about managing document retrieval
and document processing using the provided controls.
Note:

Prior to Integration Server version 9.5 SP1, webMethods messaging triggers

were called Broker/local triggers.

Managing Document Retrieval

Within the publish-and-subscribe model, document retrieval is the process in which
Integration Server uses a server thread to fetch more documents from the messaging
webMethods Integration Server Administrators Guide Version 9.10

748

Odd Header
Managing webMethods Messaging Triggers

provider. Document retrieval requires a server thread with which to request and
retrieve documents from the messaging provider. Document retrieval also requires
memory because Integration Server keeps temporary copies of the documents it is
retrieving in memory. Integration Server releases the temporary copies from memory
after successfully processing the document.
Integration Server provides controls that you can use to manage the server resources
used for document retrieval. Specically, you can use the controls to:
Manage the rate of document retrieval and the amount of memory used during
document retrieval by adjusting trigger queue capacity.
Suspend or resume document retrieval for one or more webMethods messaging
triggers.
Limit the number of server threads used for retrieving documents from Broker.
These controls can be used during development, capacity planning, or at run time. The
following sections provide more information about these controls.
You can also congure the frequency with which Integration Server polls each trigger
client queue on the Broker for new documents. For more information, see "Delaying
Polling Requests for webMethods Messaging Triggers" on page 774.

Increasing or Decreasing Threads for Document Retrieval from

webMethods Broker
During production and capacity planning, you can increase or decrease the number
of threads used to retrieve documents from the Broker. By default, Integration Server
can use up to 100% of the server thread pool to retrieve documents from Broker. Each
webMethods messaging trigger uses a separate server thread to retrieve documents from
the Broker. For example, if the maximum size of the server thread pool is 80 threads, and
the server can use 100% of the server thread pool to retrieve documents, then up to 80
triggers can request more documents at one time.
You can limit the maximum number of threads used for document retrieval by
specifying the percentage of the server thread pool that can be used to retrieve
documents. The Integration Server uses the specied percentage to calculate the number
of server threads that can be used to retrieve documents from the Broker.
For example, suppose that the maximum size of the server thread pool is 80 threads.
If you specify a maximum document retrieval threads percentage of 10%, then the
Integration Server can use only 8 threads to retrieve documents from Broker at one
time. Because Integration Server uses a separate thread to retrieve documents for
each webMethods messaging trigger, this means that Integration Server can retrieve
documents for only 8 triggers that receive documents from the Broker at one time.
Reducing the percentage of the server thread pool used for document retrieval from
the Broker can slow the rate of document retrieval because fewer triggers can retrieve
documents simultaneously. It also ensures the availability of server threads for

webMethods Integration Server Administrators Guide Version 9.10

749

Even Header
Managing webMethods Messaging Triggers

other tasks, such as answering HTTP requests, retrieving documents from Universal
Messaging, or processing documents.
Increasing the percentage of the server thread pool available for retrieving documents
from Broker can increase the arrival rate of documents because it allows more triggers to
retrieve documents from the Broker at one time.
For more information about seing the number of server threads for document retrieval,
see "Limiting Server Threads for webMethods Messaging Triggers" on page 766.
Note:

Threads alloed for document retrieval only impact webMethods messaging

triggers that receiving documents from Broker. The threads you specify for
document retrieval will not include threads used to retrieve documents from
Universal Messaging

When to Increase or Decrease Threads for Retrieving Documents from

webMethods Broker
Your knowledge of your integration solution is the best tool for determining when to
increase and decrease thread usage for retrieving documents from Broker. For example,
if you know that Integration Server regularly receives a high number of HTTP requests
during a certain time period, you might want to decrease thread usage for retrieving
documents right before the HTTP requests usually begin, then increase threads for
retrieving documents after the frequency of HTTP requests slows down. Alternatively,
if you know that Integration Server receives a high volume of incoming documents at
the same time each day, you might want to increase the number of threads available for
retrieving documents during that time period.
You can also determine when to increase or decrease threads for retrieving documents
from Broker by monitoring the number of available server threads. To assist with this,
you can establish a warning threshold that instructs Integration Server to alert you
when the percentage of available threads drops below a specied level. Specically,
Integration Server creates a journal log entry stating "Available Thread Warning
Threshold Exceeded." When you receive this message in the journal log, you can
decrease threads for document retrieval to make server threads available to perform
other functions. For more information about seing an available threads warning
threshold, see "Managing the Server Thread Pool" on page 110.
Another method of determining when to alter the number of server threads alloed for
retrieving documents from Broker is to monitor the current number of threads retrieving
documents from the Broker. Integration Server Administrator displays this value in the
Current Threads eld under Document Retrieval on the Settings > Messaging >webMethods
Messaging TriggerManagement page. The Current Threads eld under Document Retrieval does
not include threads used to retrieve documents from Universal Messaging.
Note:

Other ways to control the resources used for retrieving documents are:
adjusting trigger queue capacity and suspending/resuming document
retrieval for webMethods messaging triggers. For more information about
adjusting trigger queue capacity, see "Decreasing the Capacity of Trigger
Queues" on page 751. For more information about suspending (or

webMethods Integration Server Administrators Guide Version 9.10

750

Odd Header
Managing webMethods Messaging Triggers

resuming) document processing, see "Suspending and Resuming Document

Retrieval" on page 753.

Decreasing the Capacity of Trigger Queues

You can impact the amount of memory used for document retrieval by adjusting the
capacity of all the webMethods messaging triggers that retrieve documents from the
Broker or Universal Messaging. The capacity determines the maximum number of
documents that the trigger queues on Integration Server can contain.
You can use the Queue Capacity Throttle provided in Integration Server Administrator to
decrease the capacity of all the trigger queues for webMethods messaging triggers that
receive documents from a messaging provider. The throle also reduces the rell levels
of all webMethods messaging triggers that receive documents from the Broker. The
rell level species the number of documents that remain in the trigger queue before
Integration Server requests more documents. The Queue Capacity Throttle reduces the
capacity and rell levels for all the trigger queues by the same percentage. For example,
if you set the Queue Capacity Throttle to 50% of maximum, a trigger queue with a capacity
of 10 and a rell level of 4 will have an adjusted capacity of 5 and an adjusted rell level
of 2.
Note:

webMethods messaging triggers that receive documents from Universal

Messaging do not have a rell level.

By decreasing the capacity and rell levels, you can:

Reduce the amount of memory needed to retrieve documents from the messaging
provider.
Reduced capacity and rell levels mean that Integration Server retrieves fewer
documents for a webMethods messaging trigger at one time. Because Integration
Server retrieves fewer documents, Integration Server uses less memory when
retrieving documents.
Reduce the memory needed to store the documents while they await processing.
Note:

Decreasing the capacity might increase the frequency with which

Integration Server retrieves documents because Integration Server might
empty the trigger queues to the adjusted rell level more quickly.

Decreasing the Capacity and Refill Level for webMethods Messaging Triggers
Use the following procedure to use the Queue Capacity Throttle to decrease the capacity
and rell levels for the queues of all webMethods messaging triggers.
Note:

The Queue Capacity Throttle does not aect the rell level of webMethods
messaging triggers that receive documents from Universal Messaging because
these triggers do not have a rell level.

webMethods Integration Server Administrators Guide Version 9.10

751

Even Header
Managing webMethods Messaging Triggers

To decrease the capacity and refill level of trigger queues

1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Click webMethods Messaging TriggerManagement, and then click Edit GlobalwebMethods
Messaging TriggerControls.
4. Under Document Retrieval, in the Queue Capacity Throttle eld, select the percentage of
congured capacity at which you want all trigger queues to operate. The Integration
Server automatically adjusts the rell levels by the same percentage.
5. If you want to apply the queue capacity throle change to all the servers in a cluster,
select the Apply Change Across Cluster check box.
This check box appears only if the current Integration Server belongs to a properly
congured cluster and is congured to synchronize webMethods messaging trigger
changes across the cluster. For more information about conguring an Integration
Server to synchronize trigger management changes across a cluster, see "Cluster
Synchronization for webMethods Messaging Trigger Management" on page 768.
6. Click Save Changes.
Notes:
The Queue Capacity Throle only aects the rell level of webMethods messaging
triggers that receive documents from Broker. webMethods messaging triggers that
receive documents from Universal Messaging do not have a rell level.
The Queue Capacity Throttle seing is maintained across server restarts and package
reloads.
If the percentage by which you reduce capacity does not resolve to a whole number,
Integration Server rounds up or rounds down to the nearest whole number.
However, if rounding down would reduce the value to 0, Integration Server rounds
up to 1. For example, if you set the Queue Capacity Throttle to 10% of maximum, a
trigger queue with a capacity of 15 and rell level of 4 will have an adjusted capacity
of 2 and an adjusted rell level of 1 (Integration Server rounds the calculated
adjusted capacity of 1.5 up to 2 and rounds the calculated adjusted rell level of 0.4
up to 1).
When you reduce the Queue Capacity Throttle and save your changes, Integration
Server does not immediately reduce the number of documents in a trigger queue.
Instead, Integration Server continues to process documents in the trigger queue
until it reaches the adjusted rell level. Then, Integration Server retrieves enough
documents to ll the trigger queue to the adjusted capacity. For example, if you set
Queue Capacity Throttle to 50%, a trigger queue with a capacity of 8 and a rell level of
2 will have an adjusted capacity of 4 and an adjusted rell level of 1. The Integration
Server processes documents in the trigger queue until it reaches the adjusted rell
level of only 1 document. Then, Integration Server retrieves up to 3 documents to
increase the number of documents in the queue to 4 (the adjusted capacity).

webMethods Integration Server Administrators Guide Version 9.10

752

Odd Header
Managing webMethods Messaging Triggers

If you reduce the capacity to a low percentage for an extended period of time, the
document might expire on the messaging provider. For each publishable document
type, you can specify a Time to live property. This property species how long a
document can remain on the messaging provider before the messaging provider
discards it. For more information about publishable document types, see webMethods
Service Development Help.
If you use the Queue Capacity Throttle as part of your capacity planning process and
you determine that the congured values for trigger capacity and rell level need to
change, you can use the Integration Server Administrator or Software AG Designer
to set the new capacity and rell level values for each webMethods messaging
trigger. For more information about seing the capacity and rell level for a trigger,
see "Modifying webMethods Messaging Trigger Properties" on page 770.

Suspending and Resuming Document Retrieval

You can reduce the amount of server resources that document retrieval consumes by
suspending document retrieval for one or more webMethods messaging triggers. Using
the Integration Server Administrator, you can:
Suspend or resume document retrieval for all webMethods messaging triggers.
Suspend or resume document retrieval for specic webMethods messaging triggers.
The following sections provide more information about these options.

About Suspending and Resuming Document Retrieval for All Triggers

When you suspend document retrieval for all the webMethods messaging triggers on
an Integration Server, the Integration Server stops retrieving documents from the Broker
and Universal Messaging. Integration Server resources, such as threads and memory,
that would have been used for document retrieval are available for other tasks.
Suspending document retrieval for all webMethods messaging triggers is a quick way
to free up server resources. This can be especially helpful in a situation in which the
Integration Server is functioning under heavy load and additional resources are needed
immediately.
Suspending or resuming document retrieval can be a temporary or permanent change.
(Integration Server considers a document retrieval change to be permanent if you
selected the Apply Change Permanently check box when you made the change.) If the
change is temporary, Integration Server reverts to the permanent document retrieval
state when Integration Server restarts or you reload a package. When you reload a
package, Integration Server reverts only the webMethods messaging triggers contained
in that package to the permanent document retrieval state. For example, suppose that
you temporarily suspend document retrieval for all webMethods messaging triggers. If
you reload the package OrderProcessing, Integration Server resumes document retrieval
for the webMethods messaging triggers in the OrderProcessing package only.

webMethods Integration Server Administrators Guide Version 9.10

753

Even Header
Managing webMethods Messaging Triggers

Tip:

On the Settings > Messaging >webMethods Messaging TriggerManagement page,

under Document Retrieval, Integration Server Administrator indicates a
temporary document retrieval change by displaying an asterisk (*) next to the
trigger status in the Active column.

You can gradually resume document retrieval by seing the Queue Capacity Throttle to a
low percentage, such as 10%, and then resuming document retrieval for all webMethods
messaging triggers. Integration Server resumes document retrieval at the adjusted
capacity for all webMethods messaging triggers. You can also gradually resume
document retrieval by selectively resuming individual triggers. For example, you might
want to rst resume document retrieval for those triggers that are part of a critical or
high priority process.
Suspending or Resuming Document Retrieval for All webMethods Messaging Triggers
Use the following procedure to suspend or resume document retrieval for webMethods
messaging triggers.
To suspend or resume document retrieval for all webMethods messaging triggers
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Click webMethods Messaging TriggerManagement.
4. Under IndividualwebMethods Messaging TriggerControls, in the Active column located
under Document Retrieval, click edit all.
5. In the Retrieval State list, do the following:
Select...

To...

Active

Resume document retrieval for all webMethods messaging

triggers.

Suspended

Suspend document retrieval for all webMethods messaging

triggers.

6. If you want the state change to be permanent and maintained after Integration
Server restarts or after a package reload, select the Apply Change Permanently check
box. If you do not select this check box, Integration Server considers the change to be
temporary.
7. If you want to apply the document retrieval change to all the servers in a cluster,
select the Apply Change Across Cluster check box.
This check box appears only if the current Integration Server belongs is congured
to synchronize trigger changes across the cluster. For more information about
conguring an Integration Server to synchronize trigger management changes

webMethods Integration Server Administrators Guide Version 9.10

754

Odd Header
Managing webMethods Messaging Triggers

across a cluster, see "Cluster Synchronization for webMethods Messaging Trigger

Management" on page 768.
8. Click Save Changes.
Notes:
Integration Server does not suspend (or resume) document retrieval if the
webMethods messaging trigger is locked or disabled.
If Integration Server cannot suspend (or resume) document retrieval on the local
Integration Server, cluster synchronization cannot occur.
Integration Server does not suspend (or resume) document retrieval for webMethods
messaging triggers that have been excluded from trigger management changes using
the wa.server.trigger.managementUI.excludeList. For more information about this
property, see "Server Conguration Parameters" on page 851.
Suspending document retrieval aects document retrieval from the messaging
provider only (Broker and Universal Messaging). webMethods messaging trigger
will continue to receive locally published documents. Additionally, webMethods
messaging triggers will continue to receive documents delivered to the default client.
When you suspend document retrieval, Integration Server will not retrieve more
documents from the messaging provider (Broker or Universal Messaging). Any
server threads currently retrieving or processing documents for a webMethods
messaging trigger will execute to completion.
When you suspend document retrieval, documents to which this trigger subscribes
will collect on the messaging provider. Documents remain on the messaging
provider until document retrieval resumes for the trigger or the documents expire.
When you resume document retrieval, Integration Server resumes document
retrieval for webMethods messaging triggers at the percentage specied by the
Queue Capacity Throttle.
If you do not resume document retrieval before Integration Server restarts, the
trigger package reloads, or the trigger properties are modied, the messaging
provider discards any volatile documents that it is holding for the trigger.

About Suspending and Resuming Document Retrieval for a Specific Trigger

Sometimes, instead of suspending or resuming document retrieval for all webMethods
messaging triggers, you might want to suspend or resume document retrieval for
specic webMethods messaging triggers. Following are some situations in which you
might want to suspend or resume document retrieval for specic triggers.
When a back-end system needs maintenance or is becoming unresponsive, you
might want to suspend document retrieval for triggers that interact with the backend system. By suspending document retrieval, documents that would normally
accumulate on Integration Server awaiting processing remain on the messaging
provider. This keeps memory and other server resources available for other

webMethods Integration Server Administrators Guide Version 9.10

755

Even Header
Managing webMethods Messaging Triggers

activities. When the back-end system becomes available, you can resume document
retrieval for the associated triggers.
After suspending document retrieval for all triggers, you might resume document
retrieval for specic triggers. If Integration Server is functioning under an unusually
heavy load, you might rst suspend retrieval for all triggers and then gradually
resume retrieval, starting with the triggers involved in key processes.
If Integration Server suspends document retrieval for a serial trigger because the
associated trigger service ends in error, you need to resume document retrieval for
that trigger. For more information about conguring a serial trigger to suspend
retrieval and processing automatically after an error, see webMethods Service
Development Help.
Suspending or Resuming Document Retrieval for a webMethods Messaging Trigger
The following procedure explains how to suspend or resume document retrieval for an
individual webMethods messaging trigger.
To suspend or resume document retrieval for a webMethods messaging trigger
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Click webMethods Messaging TriggerManagement.
4. Under IndividualwebMethods Messaging TriggerControls, locate the row containing the
trigger for which you want to suspend document retrieval.
5. In the Active column located under Document Retrieval, click Yes or No. (The Active
column displays "Yes" if document retrieval is active for the trigger; "No" if
document retrieval is suspended. An asterisk (*) appears next to the status if the
document retrieval state is temporary.)
6. In the Retrieval State list, do the following:
Select...

To...

Active

Resume document retrieval for this trigger.

Suspended

Suspend document retrieval for this trigger.

7. If you want the state change to be permanent and maintained after Integration
Server restarts, select the Apply Change Permanently check box. If you do not select this
check box, Integration Server considers the change to be temporary.
8. If you want to apply the document retrieval change for this trigger to all the servers
in a cluster, select the Apply Change Across Cluster check box.
This check box appears only if the current Integration Server belongs to a properly
congured cluster and is congured to synchronize trigger changes across the
cluster. For more information about conguring an Integration Server to synchronize
webMethods Integration Server Administrators Guide Version 9.10

756

Odd Header
Managing webMethods Messaging Triggers

trigger management changes across a cluster, see "Cluster Synchronization for

webMethods Messaging Trigger Management" on page 768.
9. Click Save Changes.
Notes:
Integration Server will not suspend or resume document retrieval for the specied
webMethods messaging trigger if the trigger is locked by a user.
If Integration Server cannot suspend (or resume) document retrieval locally, cluster
synchronization cannot occur.
When you resume document retrieval, Integration Server resumes retrieval for the
webMethods messaging trigger at the percentage specied by the Queue Capacity
Throttle.
In a ow service, you can suspend or resume document retrieval for
individual triggers by invoking the pub.trigger:suspendRetrieval service or the
pub.trigger:resumeRetrievalservice, respectively. For more information about these
services, see the webMethods Integration Server Built-In Services Reference.
In a Java service, you can suspend or resume document retrieval by calling
com.wm.app.b2b.server.dispatcher.trigger.TriggerFacade.setRetrievalSuspended().
For more information about this method, see the webMethods Integration Server Java
API Reference for the com.wm.app.b2b.server.dispatcher.trigger.TriggerFacade class.
You can lter the list of displayed triggers using the
wa.server.trigger.managementUI.excludeList property. For more information about
this property, see "Server Conguration Parameters" on page 851.

Managing Document Processing

Within the publish-and-subscribe model, document processing is the process of evaluating
documents against trigger conditions and executing the appropriate trigger services
to act on those documents. Document processing requires a server thread with which
to evaluate the document and execute the trigger service. It also requires memory in
which to keep a copy of the document during document evaluation and trigger service
execution.
Integration Server provides various controls that you can use to manage the rate of and
resource demands for document processing. Specically, you can:
Limit the number of server threads used by webMethods messaging triggers for
processing documents.
Manage the number of server threads that can be used to process documents for a
webMethods messaging trigger concurrently.
Suspend or resume document processing for one or more webMethods messaging
triggers.

webMethods Integration Server Administrators Guide Version 9.10

757

Even Header
Managing webMethods Messaging Triggers

These controls can be used as part of your capacity planning or used during production.
The following sections provide more information about these controls.

Increasing or Decreasing Threads for Processing Documents

Received by webMethods Messaging Triggers
During production and capacity planning, you can increase or decrease the number of
threads that can be used to simultaneously process documents received by webMethods
messaging triggers. The number of threads available for processing documents helps
determine the rate at which Integration Server processes documents. By default,
Integration Server can use up to 100% of the server thread pool to process documents
(execute triggers). Each time Integration Server processes a document, Integration Server
uses a server thread. For example, if the maximum size of the server thread pool is
80 threads, and Integration Server can use 100% of the server thread pool to execute
triggers, then up to 80 triggers can execute at the same time. That is, Integration Server
can process up to 80 documents simultaneously.
You can control the number of server threads available for document processing (trigger
execution) by specifying the maximum percentage of the server thread pool that can
be used to process documents. Integration Server uses the percentage to calculate the
number of server threads that can be used for trigger execution (document processing).
For example, suppose that the maximum size of the server thread pool is 80 threads.
If you set 10% as the maximum percentage of document processing threads, then
Integration Server can use up to 8 threads simultaneously to execute webMethods
messaging triggers.
By reducing the number of server threads used for processing documents, you can
make server threads and memory available to perform other tasks, such as executing
HTTP requests and retrieving documents. Alternatively, you can increase the number
of threads for document processing to allow the server to process more documents
simultaneously. This can also allow the server to drain the trigger queues more quickly
and request additional documents more frequently.
Document processing for serial and concurrent triggers combined cannot exceed the
value determined by the maximum document processing threads percentage. If you
reduce the percentage of document processing server threads, and concurrent triggers
continue to consume the maximum execution threads possible (according to their
congured seings), serial triggers must wait longer for server threads to become
available. This is especially likely if Integration Server contains concurrent triggers that
execute long-running services.
For more information about seing the number of server threads for document
processing, see "Limiting Server Threads for webMethods Messaging Triggers" on page
766.
Tip:

If you decrease the percentage of threads that can be used for document
processing, consider decreasing the Execution Threads Throttle to prevent
concurrent triggers from monopolizing available server threads.

webMethods Integration Server Administrators Guide Version 9.10

758

Odd Header
Managing webMethods Messaging Triggers

When to Increase or Decrease Threads for Processing Documents

Your knowledge of your integration solution is the best tool for determining when to
adjust thread usage for document processing (trigger execution). For example, suppose
that a batch process that occurs at the same time each day results in a spike in document
publishing. You might want to increase threads for document processing right before the
batch process starts to make server threads available to process documents.
Alternatively, if you observe memory constraints or other resource issues, you can
decrease the number of threads for document processing. Document processing
consumes memory because Integration Server keeps the document in memory while the
server thread evaluates the document and executes the trigger service.
Note:

You can also determine when to modify the number of threads allowed
for document processing by monitoring thread usage. You can do this by
viewing the thread usage information displayed on the Server > Statistics page.
However, you can also establish a warning threshold that instructs Integration
Server to alert you when the number of available threads drops below a
particular level. Specically, Integration Server creates a journal log entry
stating "Available Threads Warning Threshold Usage Exceeded." When
Integration Server writes this journal log entry, you might want to decrease
threads for document processing to allow more threads to be used for other
functions. For more information about seing an available threads warning
threshold, see"Managing the Server Thread Pool" on page 110.

Another way to determine when to alter the number of server threads alloed for
processing documents is to monitor the current number of threads that are processing
documents for triggers. Integration Server Administrator displays this value in the
Current Threads eld located under Document Processing on the Settings > Messaging
>webMethods Messaging TriggerManagement page.
Note:

Other ways to control the resources used for document processing are:
adjusting execution threads for concurrent triggers and suspending or
resuming document processing for triggers. For more information about
adjusting trigger queue capacity, see "Decreasing Document Processing for
Concurrent Triggers" on page 759. For more information about suspending
(or resuming) document processing, see "Suspending and Resuming
Document Processing" on page 761.

Decreasing Document Processing for Concurrent Triggers

You can reduce the amount of server resources consumed by document processing by
decreasing the rate of processing for concurrent triggers. Specically, you can reduce the
maximum number of threads that can process documents for a concurrent trigger at one
time.
Integration Server Administrator provides an Execution Threads Throttle that you can
use to reduce the execution threads for all concurrent triggers by the same percentage.
webMethods Integration Server Administrators Guide Version 9.10

759

Even Header
Managing webMethods Messaging Triggers

For example, if you set the Execution Threads Throttle to 50% of maximum, Integration
Server reduces the maximum execution threads for all concurrent triggers by half.
A concurrent trigger with a maximum execution threads value of 6, has an adjusted
maximum execution threads value of 3.
By decreasing parallel processing for concurrent triggers, you can:
Free up server threads and memory to perform other functions, such as answering
HTTP requests or retrieving documents.
Prevent concurrent triggers from monopolizing the threads alloed for document
processing. The number of server threads that Integration Server dispatches to
process documents for serial and concurrent triggers cannot exceed the value
established by the maximum execution threads percentage. If you reduce the
number of threads allowed for document processing, and concurrent triggers
continue to consume the maximum execution threads possible (according to their
congured seings), serial triggers must wait longer for server threads to become
available. This is especially likely if Integration Server contains concurrent triggers
that execute long-running services.
Note:

The Execution Threads Throttle only aects webMethods messaging triggers.

Decreasing Execution Threads for Concurrent webMethods Messaging

Triggers
To decrease execution threads for concurrent webMethods messaging triggers
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Click webMethods Messaging TriggerManagement, and then click Edit GlobalwebMethods
Messaging TriggerControls.
4. Under Document Processing, in the Execution Threads Throttle eld, select the
percentage of the congured maximum execution threads value at which you want
to the server to function. Integration Server applies this percentage to the maximum
execution threads value for all concurrent webMethods messaging triggers.
5. If you want to apply the Execution Threads Throttle change to all the servers in a
cluster, select the Apply Change Across Cluster check box.
This check box appears only if the current Integration Server belongs to a properly
congured cluster and is congured to synchronize trigger changes across the
cluster. For more information about conguring an Integration Server to synchronize
trigger management changes across a cluster, see "Cluster Synchronization for
webMethods Messaging Trigger Management" on page 768.
6. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

760

Odd Header
Managing webMethods Messaging Triggers

Notes:
The Execution Threads Throttle value is maintained across server restarts and package
reloads.
Serial triggers always process one document at a time. The Execution Threads Throttle
property does not aect serial triggers.
If the percentage by which you reduce trigger execution threads does not resolve
to a whole number, Integration Server rounds up or rounds down to the nearest
whole number. However, if rounding down would set the value to 0, Integration
Server rounds up to 1. For example, if you reduce Execution Threads Throttle to 10%
of maximum, a concurrent trigger with a maximum execution threads value of 12
would have an adjusted value of 1 (Integration Server rounds 1.2 down to 1). A
concurrent trigger with a maximum execution threads value of 4 would have an
adjusted value of 1 (Integration Server rounds 0.4 up to 1).
When you reduce the Execution Threads Throttle and save your changes, Integration
Server does not terminate threads currently executing concurrent triggers to
meet the adjusted maximum. Integration Server allows server threads processing
documents for concurrent triggers to execute to completion. Integration Server
waits until the number of threads executing for a concurrent trigger is less than the
adjusted maximum before dispatching another server thread to process a document
for that trigger.
If you suspend document processing (trigger execution) and do not suspend
document retrieval, Integration Server will ll all the trigger queues to capacity. Full
trigger queues consume more memory than empty trigger queues.
You can also reduce the number of concurrent execution threads for a trigger by
reducing the capacity of a trigger queue below the maximum number of concurrent
execution threads for the trigger. The maximum number of dispatched threads for
a trigger cannot exceed the trigger queue's capacity. For more information about
reducing trigger queue capacity, see "Decreasing the Capacity of Trigger Queues" on
page 751.
If you use the Execution Threads Throttle as part of your capacity planning process
and you determine that the congured values for Maximum execution threads need to
change, you can use the Integration Server Administrator or Software AG Designer
to set the new maximum execution threads values for each concurrent trigger. For
more information about seing trigger properties, see "Modifying webMethods
Messaging Trigger Properties" on page 770.

Suspending and Resuming Document Processing

You can reduce the amount of server resources that document processing consumes
by suspending document processing for one or more webMethods messaging triggers.
Using the Integration Server Administrator, you can:
Suspend or resume document processing for all webMethods messaging triggers.

webMethods Integration Server Administrators Guide Version 9.10

761

Even Header
Managing webMethods Messaging Triggers

Suspend or resume document processing for specic webMethods messaging

triggers.
The following sections provide more information about these options.

About Suspending and Resuming Document Processing for all Triggers

When you suspend document processing for all webMethods messaging triggers,
Integration Server stops dispatching server threads to process documents received
by webMethods messaging triggers. Server resources, such as threads and memory,
that might have been used for document processing will be available for other tasks.
Document processing remains suspended until you specically resume it.
Suspending document processing for all webMethods messaging triggers is a quick way
to make server resources available. This can be especially helpful in a situation in which
Integration Server is functioning under heavy load and additional resources need to be
available immediately.
Suspending or resuming document processing can be a temporary or permanent
change. (Integration Server considers a document processing change to be permanent
if you selected the Apply Change Permanently check box when you made the change.)
If the change is temporary, Integration Server reverts to the permanent document
processing state when Integration Server restarts or you reload a package. When
you reload a package, Integration Server reverts only the triggers contained in that
package to the permanent document processing state. For example, suppose that you
temporarily suspend document processing for all triggers. If you reload the package
OrderProcessing, Integration Server resumes document processing for the triggers in the
OrderProcessing package only.
Tip:

On the Settings > Messaging >webMethods Messaging TriggerManagement page,

under Document Processing, Integration Server Administrator indicates a
temporary document processing change by displaying an asterisk (*) next to
the trigger status in the Active column.

When you are ready to resume document processing, you might want to resume it
gradually. For example, you might set the Execution Threads Throttle to a low percentage,
resume document processing for all triggers, and then gradually move the Execution
Threads Throttle up to 100%. Alternatively, you might selectively resume individual
triggers. For example, you might want to resume document processing for those triggers
that are part of a critical or high priority process.
Suspending or Resuming Document Processing for All webMethods Messaging Triggers
Use the following procedure to suspend or resume document processing for all
webMethods messaging triggers.
To suspend or resume document processing for all webMethods messaging triggers
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.

webMethods Integration Server Administrators Guide Version 9.10

762

Odd Header
Managing webMethods Messaging Triggers

3. Click webMethods Messaging TriggerManagement.

4. Under IndividualwebMethods Messaging TriggerControls, in the Active column located
under Document Processing, click edit all.
5. In the Processing State list, do the following:
Select...

To...

Active

Resume document processing for all of the webMethods

messaging triggers.

Suspended

Suspend document processing for all of the webMethods

messaging triggers.

6. If you want the state change to be permanent and maintained after Integration
Server restarts, select the Apply Change Permanently check box. If you do not select this
check box, the Integration Server considers the change to be temporary.
7. If you want to apply the document processing change to all the servers in a cluster,
select the Apply Change Across Cluster check box.
This check box appears only if the current Integration Server belongs to a properly
congured cluster and is congured to synchronize trigger changes across the
cluster. For more information about conguring an Integration Server to synchronize
trigger management changes across a cluster, see "Cluster Synchronization for
webMethods Messaging Trigger Management" on page 768.
8. Click Save Changes.
Notes:
Integration Server will not suspend or resume document processing for a locked or
disabled trigger.
If Integration Server cannot suspend (or resume) document processing locally,
cluster synchronization cannot occur.
Integration Server does not suspend (or resume) document processing for
webMethods messaging triggers that have been excluded from trigger management
changes using the wa.server.trigger.managementUI.excludeList. For more
information about this property, see "Server Conguration Parameters" on page
851
Suspending or resuming document processing aects all documents in the trigger's
queue on Integration Server, including documents retrieved from the messaging
provider and from local publishing.
When you suspend document processing, Integration Server will not dispatch any
more server threads to process documents. Any server threads currently processing

webMethods Integration Server Administrators Guide Version 9.10

763

Even Header
Managing webMethods Messaging Triggers

documents for triggers will execute to completion. This includes documents that are
being retried.
When you suspend document processing but do not suspend document retrieval,
documents will collect in trigger queues until the trigger queues are at maximum
capacity or document processing resumes. If Integration Server restarts before
document processing resumes, volatile documents are discarded.
When you resume document processing, Integration Server resumes document
processing for webMethods messaging trigger that at the percentage specied by the
Execution Threads Throttle.

About Suspending and Resuming Document Processing for Specific Triggers

Sometimes, instead of suspending or resuming document processing for all
webMethods messaging triggers, you might want to suspend or resume processing for a
specic trigger. Following are examples of situations where you might want to suspend
document processing for specic triggers.
When a back-end system becomes unresponsive or requires maintenance, you
might want to suspend document processing for triggers that interact with that
back-end system. If the back-end system is not available because of maintenance or
failure, trigger services that interact with the system would probably not execute
successfully. Suspending document processing for the associated triggers allows for
more eective resource utilization because you keep resources that would have been
used for unsuccessful document processing available for other tasks.
After suspending document processing for all triggers, you might resume document
processing for specic triggers. If Integration Server is operating under a heavy
load, you might rst suspend all document processing and then gradually resume
document processing, starting with the triggers involved in critical processes.
If Integration Server suspends document processing for a serial trigger because the
associated trigger service ends in error, you need to resume document processing
for the trigger. For more information about conguring a serial trigger to suspend
retrieval and processing automatically after an error, see webMethods Service
Development Help.
Suspending or Resuming Document Processing for a Specific webMethods Messaging Trigger
Use the following procedure to suspend or resume document processing for an
individual webMethods messaging trigger.
To suspend or resume document processing for a webMethods messaging trigger
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Click webMethods Messaging TriggerManagement.
4. Under IndividualwebMethods Messaging TriggerControls, locate the row containing the
trigger for which you want to suspend document processing.

webMethods Integration Server Administrators Guide Version 9.10

764

Odd Header
Managing webMethods Messaging Triggers

5. In the Active column located under Document Processing, click Yes or No. (The Active
column displays "Yes" if document processing is active for the trigger; "No" if
document processing is suspended. An asterisk (*) appears next to the status if the
document processing state is temporary.)
6. In the Processing State list, do the following:
Select...

To...

Active

Resume document processing for this webMethods messaging

trigger.

Suspended

Suspend document processing for this webMethods

messaging trigger.

7. If you want the state change to be permanent and maintained after the Integration
Server restarts, select the Apply Change Permanently check box. If you do not select this
check box, the Integration Server considers the change to be temporary.
8. If you want to apply the document processing change for this trigger to all the
servers in a cluster, select the Apply Change Across Cluster check box.
This check box appears only if the current Integration Server belongs to a properly
congured cluster and is congured to synchronize trigger changes across the
cluster. For more information about conguring an Integration Server to synchronize
trigger management changes across a cluster, see "Cluster Synchronization for
webMethods Messaging Trigger Management" on page 768.
9. Click Save Changes.
Notes:
Integration Server will not suspend or resume document processing for the specied
webMethods messaging trigger if the trigger is locked by a user.
If Integration Server cannot suspend (or resume) document processing locally,
cluster synchronization cannot occur.
When you resume document processing, the Execution Threads Throttle determines the
maximum number of documents that can be processed in parallel.
In a ow service, you can suspend or resume document processing for an individual
webMethods messaging trigger by invoking the pub.trigger:suspendProcessing service or
the pub.trigger:resumeProcessing service, respectively. For more information about these
services, see the webMethods Integration Server Built-In Services Reference.
In a Java service, you can suspend or resume document retrieval by calling
com.wm.app.b2b.server.dispatcher.trigger.TriggerFacade.setProcessingSuspended().
For more information about this method, see the webMethods Integration Server Java
API Reference for the com.wm.app.b2b.server.dispatcher.trigger.TriggerFacade class.

webMethods Integration Server Administrators Guide Version 9.10

765

Even Header
Managing webMethods Messaging Triggers

You can lter the list of displayed triggers using the

wa.server.trigger.managementUI.excludeList property. For more information about
this property, see "Server Conguration Parameters" on page 851.

Limiting Server Threads for webMethods Messaging Triggers

Integration Server provides parameters that you can use to limit how many threads
in the server thread pool retrieve and process documents for webMethods messaging
triggers. You can specify what percentage of the server thread pool can be used to
retrieve documents from the messaging provider. You can also specify the percentage of
the server thread pool that can be used to process documents received by triggers.
For example, suppose that the server thread pool can contain up to 80 threads. If you
specify that the maximum threads for document retrieval is 50% of the server thread
pool, then Integration Server can use up to 40 threads for retrieving documents from the
messaging provider.
Limiting the number of server threads that can retrieve and process documents from
the messaging provider keeps server threads available to perform other server functions
such as responding to hp requests or server administration. These parameters help to
ensure that retrieving and processing documents from the messaging provider will not
monopolize the entire server thread pool.
Note:

When Integration Server uses a thread for document retrieval, the thread
retrieves documents for one trigger from the messaging provider. The thread
does not retrieve documents for all triggers. A thread used for document
processing addresses one document in a trigger queue. (Document processing
includes determining which trigger condition the document satises and
executing the associated service.)

Setting the Maximum Number of Server Threads for webMethods

Messaging Triggers
Keep the following points in mind when specifying the number of threads for retrieving
and processing documents for a webMethods messaging trigger:
The Document Retrieval maximum threads percentage impacts webMethods
messaging trigger that retrieve documents from Broker only.
The Document Processing maximum threads percentage impacts all webMethods
messaging triggers.
To set the maximum number of server threads for webMethods messaging triggers
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.

webMethods Integration Server Administrators Guide Version 9.10

766

Odd Header
Managing webMethods Messaging Triggers

3. Click webMethods Messaging TriggerManagement, and then click Edit GlobalwebMethods

Messaging TriggerControls.
4. Under Document Retrieval, in the Maximum Threads eld, type the maximum
percentage of the server thread pool that can be used to retrieve documents from the
Broker. You must enter a value greater than zero. The default is 100%.
If the Maximum Threads eld under Document Retrieval displays "(Broker Not
Congured)", then this Integration Server is not congured to connect to a Broker.
5. Under Document Processing, in the Maximum Threads eld, type the maximum
percentage of the server thread pool that can be used to process documents received
by webMethods messaging triggers. You must enter a value greater than zero. The
default is 100%.
6. Click Save Changes.
Notes:
Integration Server uses the percentages you entered to calculate the number of
threads that can be devoted to retrieving and processing documents. If the number
of threads does not evaluate to a whole number, Integration Server rounds up or
down to the nearest whole number.
For document retrieval, if the current number of server threads retrieving documents
is greater than the new value set by the Maximum Threads percentage, Integration
Server will not dispatch more threads for retrieving documents from the Broker.
Threads currently retrieving documents will execute to completion. Integration
Server will dispatch new threads for retrieving documents from the Broker only
when the current number of document retrieval threads is less than the maximum
allowed document retrieval threads.
For document processing, if the current number of server threads processing
documents (executing triggers) is greater than the thread value determined by the
Maximum Threads percentage, Integration Server will not dispatch more threads
for document processing. Threads currently processing documents will execute to
completion. Integration Server will dispatch new threads for trigger execution only
when the current number of document processing threads is less than the maximum
allowed document processing threads.
The current number of threads and maximum alloed threads for retrieving
documents from the Broker is displayed in the Current Threads eld under Document
Retrieval on the Settings > Messaging >webMethods Messaging TriggerManagement page.
The current number of threads and maximum alloed threads for processing
documents is displayed in the Current Threads eld under Document Processing on
the Settings > Messaging >webMethods Messaging TriggerManagement page.

webMethods Integration Server Administrators Guide Version 9.10

767

Even Header
Managing webMethods Messaging Triggers

Cluster Synchronization for webMethods Messaging Trigger

Management
If the Integration Server is a member of a cluster, changes that you make for document
retrieval, document processing, and for trigger properties can be propagated to other
servers in the cluster automatically. Propagating the changes to other servers in
the cluster prevents you from needing to make identical changes on all the servers
manually. It can also prevent the other servers from absorbing the resource demands
that would have been directed to the rst server.
Note:

Trigger management changes made using the pub.trigger services can also be
applied across a cluster.

Configuring Cluster Synchronization

Integration Server propagates trigger management changes to other members of a
cluster by performing a remote invoke. For cluster synchronization to succeed, you need
to complete the following tasks:
Congure the cluster. Integration Server can propagate trigger management changes
to other servers only if all the servers are members of a properly congured cluster.
For more information about conguring a cluster, see the webMethods Integration
Server Clustering Guide.
Set up remote server aliases for the servers in the cluster. For more information about
seing up aliases for remote servers, see Seing Up Aliases for Remote Integration
Servers.
Update the wa.server.cluster.aliasList property with a comma-separated list of
the remote server alias names. Integration Server uses this list when executing the
remote invokes that update the other cluster nodes.
Note:

Integration Servers that belong to the cluster but are not in this list will not
be updated during cluster synchronization.

When cluster synchronization property wa.server.cluster.aliasList is properly

congured, the Apply Change Across Cluster check box will be visible when performing
trigger management tasks.

Cluster Synchronization at Run Time

At run time, Integration Server uses remote invokes to update the other members of
a cluster with trigger management changes. If a remote invoke to a server fails or that
server is not available at the time of the remote invoke, the cluster will be out of sync.

webMethods Integration Server Administrators Guide Version 9.10

768

Odd Header
Managing webMethods Messaging Triggers

Integration Server executing the remote invoke displays the following journal log
messages to indicate the status of the cluster synchronization aempt.
If synchronization...

Expect this log message...

Succeeds

Integration Server Administrator displays the message:

Settings changed successfully.

Succeeds for
some servers,
but fails for
others

Integration Server Administrator displays the message:

[ISS.0085.9203] Errors occurred while updating remote
aliases (x of y updates failed). See server logs for
more details.

The server log displays the message for each member of the
cluster that was not successfully updated:
[ISS.0098.0107E] Error occurred during cluster invoke:
Alias = remoteAliasName ; Service = serviceName ;
Exception = exceptionName

You can use the Integration Server Administrator to view and

change cluster synchronization status for triggers.
Fails because
the local update
failed

Integration Server Administrator displays the message:

[ISS.0085.9204] Local update failed: Exception
providing reason for failure. (Note:
The cluster synchronization will not run until
all local errors are resolved.)

If the trigger management change cannot be completed on

the local Integration Server, cluster synchronization cannot
occur. For example, if you suspend document retrieval for all
triggers and one trigger is currently locked, the Integration
Server can suspend document retrieval for every trigger
except the locked one. Because document retrieval could
not be completed locally, the Integration Server cannot
synchronize the change with the rest of the cluster.
Fails because it is
not congured

The server log displays the following message:

[ISS.0033.0156W] Cluster invoke did not complete
successfully. Cluster Synchronization feature is not
configured.

For more information about conguring cluster

synchronization for triggers, see "Conguring Cluster
Synchronization" on page 768.

webMethods Integration Server Administrators Guide Version 9.10

769

Even Header
Managing webMethods Messaging Triggers

Monitoring Cluster Synchronization

Integration Server Administrator provides a cluster view that you can use to see the
trigger synchronization status across all the servers in the cluster. For each server listed
in the wa.server.cluster.aliastList property, the cluster view indicates whether the other
servers in the cluster (and its triggers) are in sync with current server. The cluster view is
located on the Settings > Messaging >webMethods Messaging TriggerManagement> Cluster View
page.
Note:

The Cluster View page appears only if the current Integration Server belongs
to a properly congured cluster and the server is congured to synchronize
trigger changes across the cluster.

If a webMethods messaging trigger is not synchronized, the cluster view displays an

error message that indicates how the trigger is out of sync with the trigger on the current
server. For example, if document processing for a trigger is suspended locally, but
active on another server in the cluster, the error message next to trigger name states
"Processing State mismatch [local=suspended; remote=active]".
Integration Server considers a trigger on a remote server to be out of sync with the local
trigger of the same name if either of the following is true:
The triggers have dierent values for trigger queue capacity, rell level, or
maximum execution threads.
The triggers have dierent document retrieval or document processing states.
Note:

To log on to a remote server in the cluster, click the server alias in the
Remote Server Alias column. When connecting, the remote server prompts
you for user and password information. If you are connecting to the
remote server via HTTPS and the HTTPS port requires certicates, you
need to import a trusted certicate into the browser so that it can be
presented at connection time. If the trusted certicates are not imported
into the browser, when you try to connect to the remote server, you will
receive a message informing you that the page is not available. For more
information about client authentication and certicates, seeAuthenticating
Clients.

Modifying webMethods Messaging Trigger Properties

During capacity planning or production, you might decide that the congured trigger
properties need to be reset. For example, you might determine that Integration Server
performs document retrieval more smoothly for some triggers when the triggers' queue
capacity operates at 80% of its congured value. Using Integration Server Administrator,
you can reset the congured capacity for those triggers. In fact, any trigger property
that aects thread or memory usage for document retrieval or document processing can

webMethods Integration Server Administrators Guide Version 9.10

770

Odd Header
Managing webMethods Messaging Triggers

be set using Integration Server Administrator. These properties include trigger queue
capacity, rell level, and maximum execution threads.
The ability to change the capacity and rell level for a webMethods messaging trigger
is limited to webMethods messaging trigger that receive documents from the Broker.
The capacity for triggers that receive documents from Universal Messaging can be
changed only at design time and not at run time. To set the capacity for a webMethods
messaging trigger that receives documents from Universal Messaging, edit the trigger
in Designer.Furthermore, webMethods messaging triggers that receive documents from
Universal Messaging do not have a rell level.
To modify webMethods messaging trigger properties
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Click webMethods Messaging TriggerManagement.
4. Under IndividualwebMethods Messaging TriggerControls, click the name of the trigger for
which you want to edit properties.
5. Click Edit Trigger Properties.
6. Under Properties, do one or more of the following:
For this
property...

Specify...

Queue Capacity

The maximum number of documents that the trigger queue

can contain.
Note: The ability to change the queue capacity at run time via
Integration Server Administrator applies to webMethods
messaging triggers that receive documents from
Broker only. To set the capacity for a webMethods
messaging trigger that receives documents from
Universal Messaging, edit the trigger in Designer.

Queue Refill
Level

The number of unprocessed documents that must remain in

this trigger queue before Integration Server retrieves more
documents for the queue from the Broker. The Queue Refill
Level value must be less than or equal to the Queue Capacity
value.
Note: The Queue Refill Level applies to webMethods messaging
triggers that receive documents from Broker only. The
rell level does not apply to webMethods messaging
trigger that receive documents from Universal
Messaging. The Queue Refill Level eld displays N/A

webMethods Integration Server Administrators Guide Version 9.10

771

Even Header
Managing webMethods Messaging Triggers

For this
property...

Specify...
for triggers that receive documents from Universal
Messaging.

Max Execution
Threads

The maximum number of documents that Integration Server

can process concurrently. You can only specify a maximum
execution threads value for concurrent triggers. This eld
displays N/A for serial triggers.

For more information and guidelines for seing trigger queue capacity, rell level,
and maximum execution threads, see the webMethods Service Development Help
7. If you want to apply the property changes for this trigger to all the servers in a
cluster, select the Apply Change Across Cluster check box.
This check box appears only if the current Integration Server belongs to a properly
congured cluster and is congured to synchronize trigger changes across the
cluster. For more information about conguring an Integration Server to synchronize
trigger management changes across a cluster, see "Cluster Synchronization for
webMethods Messaging Trigger Management" on page 768.
8. Click Save Changes.
Note:

You can lter the list of displayed triggers using the

wa.server.trigger.managementUI.excludeList property. For more
information about this property, see "Server Conguration Parameters" on
page 851.

Managing Trigger Service Retries and Shutdown Requests

While Integration Server retries a trigger service, Integration Server ignores requests to
shut down the server until the trigger service executes successfully or all retry aempts
are made. This allows Integration Server to process a document to completion before
shuing down.
Sometimes, however, you might want Integration Server to shut down without
completing all retries for trigger services. Integration Server provides a
server parameter that you can use to indicate that a request to shut down the
Integration Server should interrupt the retry process for trigger services. The
wa.server.trigger.interruptRetryOnShutdown parameter can be set to one of the
following:
Set to...

To...

false

Indicate that Integration Server should not interrupt the

trigger service retry process to respond to a shutdown

webMethods Integration Server Administrators Guide Version 9.10

772

Odd Header
Managing webMethods Messaging Triggers

Set to...

To...
request. Integration Server shuts down only after it makes all
the retry aempts or the trigger service executes successfully.
This is the default value.
If wa.server.trigger.interruptRetryOnShutdown is set
Important:
to "false" and a trigger is set to retry until successful, a
trigger service can enter into an innite retry situation.
If the transient error condition that causes the retry is
not resolved, Integration Server continually re-executes
the service at the specied retry interval. Because
you cannot disable a trigger during trigger service
execution and you cannot shut down the server during
trigger service execution, an innite retry situation can
cause Integration Server to become unresponsive to a
shutdown request. To escape an innite retry situation,
set the wa.server.trigger.interruptRetryOnShutdown
to "true". The change takes eect immediately.

true

Indicate that Integration Server should interrupt the

trigger service retry process if a shutdown request occurs.
Specically, after the shutdown request occurs, Integration
Server waits for the current service retry to complete. If the
trigger service needs to be retried again (the service ends
because of an ISRuntimeException), Integration Server stops
the retry process and shuts down. Upon restart, the transport
(the Broker, Universal Messaging, or, for a local publish, the
transient store) redelivers the document to the trigger for
processing.
Note: If the trigger service retry process is interrupted
and the transport redelivers the document to the
trigger, the transport increases the redelivery count
for the document. If the trigger is congured to detect
duplicates but does not use a document history
database or a document resolver service to perform
duplicate detection, Integration Server considers the
redelivered document to be "In Doubt" and will not
process the document.

Note:

When you change the value of the

wa.server.trigger.interruptRetryOnShutdown parameter, the change takes
eect immediately.

webMethods Integration Server Administrators Guide Version 9.10

773

Even Header
Managing webMethods Messaging Triggers

Delaying Polling Requests for webMethods Messaging

Triggers
You can conserve Integration Server and Broker resources used for retrieving documents
by delaying polling requests when a webMethods messaging trigger is inactive. When
a polling delay is in use, Integration Server waits the length of the polling delay before
requesting more messages from the Broker. You can congure the polling delay to
gradually increase as the trigger continues to be inactive.
Note:

A webMethods messaging trigger is considered to be inactive if it did not

receive any documents in its last request to the messaging provider.

During a polling delay, the webMethods messaging trigger will not retrieve any new
documents. However, the webMethods messaging trigger will not use messaging
provider resources during the delay nor will the webMethods messaging trigger be
using Integration Server resources to poll the messaging provider.
To use a polling delay, you need to specify the following:
The length of the delay that should elapse before the trigger polls
for more messages for the webMethods messaging trigger. The
wa.server.control.triggerInputControl.delays parameter determines the length
of the delay. If you want to use a gradually increasing delay, you indicate
the incremental delays by specifying a comma-separated list of integers. The
wa.server.control.triggerInputControl.delays parameter is measured in
milliseconds and has a default value of: 500, 1000, 1500, 5000
The time interval at which Integration Server introduces the polling delay for an
inactive webMethods messaging trigger trigger. If the trigger remains inactive,
the same time interval helps determines when Integration Server increases
the delay between polling requests. The time interval is determined by the
wa.server.control.triggerInputControl.delayIncrementInterval parameter. This
parameter is measured in milliseconds and has a default value or 1000.
Integration Server uses the following formula to determine the polling delay for
retrieving documents from the Broker for a webMethods messaging trigger:
inactiveTime /interval = delay
Where:
inactiveTime is the number of milliseconds that the webMethods messaging trigger
has been inactive. That is, the inactiveTime is the number of milliseconds that have
elapsed since Integration Server last polled the Broker and the Broker had no
messages for the trigger.
interval is the value of the
wa.server.control.triggerInputControl.delayIncrementInterval.

webMethods Integration Server Administrators Guide Version 9.10

774

Odd Header
Managing webMethods Messaging Triggers

delay is the result of the division rounded down to the nearest integer and
corresponds to an index position in the comma-separated list of delay lengths
specied for wa.server.control.triggerInputControl.delays.
Note:

If an exception occurs when parsing the supplied values

for wa.server.control.triggerInputControl.delays or
wa.server.control.triggerInputControl.delayIncrementInterval, Integration
Server resets both conguration parameters to the default values.

How Integration Server Delays a Polling Request for a webMethods

Messaging Trigger
The following table explains how Integration Server polls the Broker for documents
when a webMethods messaging trigger is inactive. The table uses an example that relies
on the default values for the related server conguration parameters, specically:
wa.server.control.triggerInputControl.delayIncrementInterval = 10000
wa.server.control.triggerInputControl.delays = 500,1000,1500,5000
Stage

Description

The webMethods messaging trigger becomes inactive.

Integration Server considers a webMethods messaging trigger to
be inactive if the trigger did not receive any documents in the last
request to the Broker.

Integration Server begins to delay polling requests using the

formula inactiveTime /interval = delay to determine the length of
the polling delay. Using the defaults for the server parameters as
stated above,
Integration Server determines the length of the polling delay
using this equation:
0/1000 = 0
The delay at the zero index position of the
wa.server.control.triggerInputControl.delays property is 500.
Integration Server will wait 500 milliseconds and then poll the
Broker for more documents.

If the polling request does not return any documents for the
webMethods messaging trigger, Integration Server determines
the length of the polling delay using this equation:
500/10000 = 0.05

webMethods Integration Server Administrators Guide Version 9.10

775

Even Header
Managing webMethods Messaging Triggers

Stage

Description
Integration Server rounds the calculated delay of 0.05
down to 0. The delay at the zero index position of the
wa.server.control.triggerInputControl.delays property is 500.
Integration Server will wait 500 milliseconds and then poll the
Broker for more documents.

If the trigger remains inactive Integration Server continues

to determine the polling delay using the formula
inactiveTime /interval = delay where the inactiveTime increases by
500 milliseconds each time.

When the trigger has been inactive for 10000 milliseconds,

Integration Server determines the length of the polling delay
using this equation:
10000/10000 = 1
The delay at the rst index position of the
wa.server.control.triggerInputControl.delays property is 1000.
Integration Server will wait 1000 milliseconds and then poll the
Broker for more documents.

If the trigger remains inactive Integration Server continues

to determine the polling delay using the formula
inactiveTime /interval = delay where the inactiveTime increases by
1000 milliseconds each time.
Note: Integration Server rounds the calculated delay down to
the nearest integer. For example, when the trigger has
been inactive for 15000 milliseconds, the length of the
polling delay would be determined by this equation:
15000/10000 = 1.5. Integration Server rounds this down to 1
and uses the polling delay in the second index position of
the wa.server.control.triggerInputControl.delays property
which is 1000 milliseconds.

When the trigger has been inactive for 20000 milliseconds,

Integration Server determines the length of the polling delay
using this equation:
20000/10000 = 2
The delay at the second index position of the
wa.server.control.triggerInputControl.delays property is 1500.
Integration Server will wait 1500 milliseconds and then poll the
Broker for more documents.

webMethods Integration Server Administrators Guide Version 9.10

776

Odd Header
Managing webMethods Messaging Triggers

Stage

Description

If the trigger remains inactive Integration Server continues

to determine the polling delay using the formula
inactiveTime /interval = delay where the inactiveTime increases by
1500 milliseconds each time.

When the trigger has been inactive for 30000 milliseconds,

Integration Server determines the length of the polling delay
using this equation:
30000/10000 = 3
The delay at the third index position of the
wa.server.control.triggerInputControl.delays property is 5000.
Integration Server will wait 5000 milliseconds and then poll the
Broker for more documents.

10

If the trigger remains inactive Integration Server continues

to determine the polling delay using the formula
inactiveTime /interval = delay where the inactiveTime increases by
5000 milliseconds each time.
Because 5000 is the largest value specied in the array for
wa.server.control.triggerInputControl.delays, the polling delay
will never be more than 5000 milliseconds. Integration Server
uses this polling delay until the trigger becomes active.
Note: The last value in
wa.server.control.triggerInputControl.delays is the
longest lag between the Broker placing the document in the
client queue on the Broker and Integration Server retrieving
the document.

11

When a polling request to the Broker returns one or more

documents, Integration Server considers the trigger to be active
and stops using a polling delay.

Serial Triggers Migrated to Integration Server 9.9 or Later

from 9.8 or Earlier
Prior to Integration Server 9.9, when using Universal Messaging as the messaging
provider, a webMethods messaging trigger with serial processing corresponded
to a shared named object on Universal Messaging. As of Integration Server 9.9, a
webMethods messaging trigger with serial processing corresponds to a priority
named object on Universal Messaging. All webMethods messaging triggers created
webMethods Integration Server Administrators Guide Version 9.10

777

Even Header
Managing webMethods Messaging Triggers

on Integration Server 9.9 or later will correspond to a priority named object. However,
migrated serial triggers will still correspond to a shared named object. The trigger and
named object will be out of sync. To synchronize the migrated serial trigger and the
named object, you must do one of the following:
If you are using a fresh install of Universal Messaging 9.9 or later (that is, the
Universal Messaging server was not migrated), when you start Integration Server,
synchronize the publishable document types with the provider using Designer or
the built-in service pub.publish:syncToProvider. Synchronizing the publishable document
types causes Integration Server to reload the webMethods messaging triggers.
Integration Servercreates a priority named object for each serial trigger.
If you are using an installation of Universal Messaging 9.9 or later that was migrated
from an earlier version, you must delete and recreate the named object. For more
information about deleting and recreating a named object associated with a trigger,
see "Synchronizing the webMethods Messaging Trigger and Named Object on
Universal Messaging " on page 778.

Synchronizing the webMethods Messaging Trigger and Named

Object on Universal Messaging
A webMethods messaging trigger and the associated named object on Universal
Messaging can get out of sync. For example, when you change the processing mode
for a webMethods messaging trigger a webMethods messaging trigger that uses a
Universal Messaging connection alias that shares a client prex, Integration Serverdoes
not delete and recreate the named object that corresponds to the trigger on Universal
Messaging. As a result, the trigger on Integration Server is out of sync with the named
object on Universal Messaging. To synchronize the webMethods messaging trigger and
the associated named object, you must delete and recreate the named object.
Note:

A webMethods messaging trigger with a serial processing mode corresponds

to a priority named object on Universal Messaging. A webMethods messaging
trigger with a concurrent processing mode corresponds to a shared named
object on Universal Messaging.

To synchronize the webMethods messaging trigger and the named object on Universal Messaging
Do one of the following:
If the webMethods messaging trigger resides on the only Integration Server
connected to Universal Messaging and the Shared Client Prefix property for the
Universal Messagingconnection alias is set to No, start the trigger to delete and
recreate the corresponding named object. You can start a trigger by disabling and
then enabling the Universal Messagingconnection alias used by the trigger.
Note:

Integration Server starts triggers upon server restart.

If more than one Integration Server connects to Universal Messaging or the

Shared Client Prefix property for the Universal Messaging connection alias is set

webMethods Integration Server Administrators Guide Version 9.10

778

Odd Header
Managing webMethods Messaging Triggers

to Yes, you must use Universal Messaging Enterprise Manager to delete the
named object. Make sure to delete the named object when the named object is
fully drained and no new documents will be sent to it. You many need to quiesce
document publishers before deleting the named object. Then create the named
object for the trigger by disabling and then enabling the Universal Messaging
connection alias used by the trigger.

webMethods Integration Server Administrators Guide Version 9.10

779

Even Header

webMethods Integration Server Administrators Guide Version 9.10

780

Odd Header
Managing JMS Triggers

36 Managing JMS Triggers

Introduction .................................................................................................................................

782

Enabling, Disabling, and Suspending JMS Triggers ..................................................................

782

Controlling Thread Usage for JMS Triggers ..............................................................................

785

Configuring Integration Server Session Reuse ..........................................................................

788

Configuring JMS Session Reuse ...............................................................................................

789

Delaying Polling Requests for Concurrent JMS Triggers ..........................................................

789

About WS Endpoint Triggers .....................................................................................................

792

webMethods Integration Server Administrators Guide Version 9.10

781

Even Header
Managing JMS Triggers

Introduction
Integration Server and Integration Server Administrator provide ways for managing
JMS triggers and the resources used by JMS triggers. Specically, you can use the
controls provided by Integration Server Administrator to:
Increase or decrease the maximum number of server threads used for JMS triggers.
Change the maximum execution threads for concurrent JMS triggers.
Enable, disable, or suspend one ore more JMS triggers.
Delay the frequency with which a JMS trigger polls for more messages.
The following sections provide more information about managing JMS triggers.
Note:

Unless otherwise specied, the term JMS triggers encompasses SOAP-JMS

triggers.

Enabling, Disabling, and Suspending JMS Triggers

You can manage JMS triggers and the amount of resources they consume by changing
the state of a JMS trigger. A JMS trigger can have one of the following states:
Trigger State

Description

Enabled

The JMS trigger is running and connected to the JMS

provider. Integration Server retrieves and processes messages
for the JMS trigger.

Disabled

The JMS trigger is stopped. Integration Server neither

retrieves nor processes messages for the JMS trigger. The JMS
trigger remains in this state until you enable the trigger.

Suspended

The JMS trigger is running and connected to the JMS

provider. Integration Server has stopped message retrieval,
but continues processing any messages it has already
retrieved. Integration Server enables the JMS trigger
automatically upon server restart or when the package
containing the JMS trigger reloads.

Using the Integration Server Administrator, you can:

Enable, disable, or suspend all JMS triggers.

webMethods Integration Server Administrators Guide Version 9.10

782

Odd Header
Managing JMS Triggers

Enable, disable, or suspend all the JMS triggers of a specic type (standard or SOAPJMS).
Enable, disable, or suspend specic JMS triggers.
You might want to change the state of all JMS triggers at once as a quick way of
freeing up server resources. This can be especially helpful in a situation in which
Integration Server is functioning under heavy load and additional resources are needed
immediately.
You might want to change the state for a specic JMS trigger in the following situations:
When a back-end system needs maintenance or is becoming unresponsive, you
might want to suspend JMS triggers that interact with the back-end system. When
the back-end system becomes available, you can enable the JMS triggers.
After suspending or disabling all JMS triggers, you might enable specic JMS
triggers. For example, if the server is functioning under an unusually heavy load,
you might rst suspend all JMS triggers and then gradually enable JMS triggers,
starting with the JMS triggers involved in key processes.
After Integration Server suspends a serial JMS trigger automatically because a fatal
error occurred during message processing. For information about conguring a JMS
trigger for fatal error handling, see webMethods Service Development Help.
After creating a WS endpoint trigger by creating a provider web service endpoint
alias for JMS.
Important: If you disable or suspend a SOAP-JMS trigger that acts as a listener for one
or more provider web service descriptors, Integration Server will not retrieve
any messages for those web service descriptors.
The following procedure explains how to use Integration Server Administrator to
change the state of all or individual JMS triggers.
To enable, disable, or suspend JMS triggers
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Click JMS Trigger Management.
4. If you want to change the state of all JMS triggers, do the following:
a. Under Individual JMS Trigger Controls, in the Enabled column, click edit all.
b. On the Settings > Messaging > JMS Trigger Management > Edit Triggers State screen, in
the New State list, select the state that you want to apply to all JMS triggers.
c. In the JMS Trigger Type list, select one of the following:

webMethods Integration Server Administrators Guide Version 9.10

783

Even Header
Managing JMS Triggers

Select...

To...

Standard

Apply the state change to standard JMS triggers only.

SOAP

Apply the state change to SOAP-JMS triggers only,

including WS endpoint triggers.

All

Apply the state change to all JMS triggers.

5. If you want to change the state of a specic JMS trigger, do the following:
a. Under Individual JMS Trigger Controls, in the row for the JMS trigger that you
want to enable, disable, or suspend, click the text in the Enabled column
b. On the Settings > Messaging > JMS Trigger Management > Edit Triggers State screen, in
the New State list, select the state that you want to apply to this JMS trigger.
6. Click Save Changes.
Notes:
If you want to disable a JMS trigger, rst suspend the JMS trigger and wait for all
the processing threads complete. Then, disable the JMS trigger. You can view the
number of threads currently used by a JMS trigger on the Settings > Messaging > JMS
Trigger Management screen.
When you disable a JMS trigger, Integration Server does the following:
If the JMS trigger is waiting before making a retry aempt, Integration Server
interrupts processing for the JMS trigger.
If the JMS trigger is currently processing messages, Integration Server waits
a specied amount of time before forcing the JMS trigger to stop processing
messages. If it does not complete in the alloed time, Integration Server stops
the message consumer used to receive messages for the JMS trigger and closes
the JMS session. At this point the server thread for the JMS trigger continues to
run to completion. However, the JMS trigger will not be able to acknowledge the
message when processing completes. If the delivery mode of the message is set to
persistent, this can lead to duplicate messages.
The time Integration Server waits between the request to disable
the JMS trigger and forcing the trigger to stop is specied by the
wa.server.jms.trigger.stopRequestTimeout property.
Because administered objects, like destinations, are congured outside of Integration
Server, disabling a JMS trigger has no impact on the subscription.
If a JMS trigger is processing messages at the time it is suspended, the JMS trigger
will complete processing of those messages. The JMS trigger also acknowledges the
messages to the JMS provider.

webMethods Integration Server Administrators Guide Version 9.10

784

Odd Header
Managing JMS Triggers

You can use built-in services to enable, disable, and suspend one or more triggers.
For information about the pub.trigger:disableJMSTriggers, pub.trigger:enableJMSTriggers, and
pub.trigger:suspendJMSTriggers services, see the webMethods Integration Server Built-In
Services Reference.

Configuring Integration Server to Enable JMS Triggers Automatically

after a Consumer Error
Integration Server disables a JMS trigger if there is a problem in the connection to
the JMS provider. Integration Server might also disable a JMS trigger if the message
consumer used by the trigger encounters an unexpected error that is not caused by a
problem in the connection to the JMS provider. These problems include:
Network latency between Integration Server and the JMS provider
A wide area network separating Integration Server and the JMS provider
The arrival of a large JMS message
Other network-related issues
You can congure Integration Server to automatically aempt to re-enable a JMS
trigger that becomes disabled when the message consumer encounters an error that
is not caused by a problem in the connection to the JMS provider. To do this, set the
wa.server.jms.trigger.retryOnConsumerError to true. Set the property to false to
instruct Integration Server to leave the JMS trigger disabled. The default is true.

Controlling Thread Usage for JMS Triggers

You can use Integration Server Administrator to limit the number of server threads
that JMS triggers can use. By default, Integration Server can consume up to 100% of the
server thread pool for JMS triggers. However, server resources also need to be available
to perform other functions.

Viewing Thread Usage for JMS Triggers

Integration Server Administrator displays the number of server threads currently used
by each JMS trigger on Integration Server.
To view thread usage for JMS triggers
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Click JMS Trigger Management.
Under Individual Standard JMS Trigger Controls, in the Current Threads column,
Integration Server Administrator displays the number of server threads currently

webMethods Integration Server Administrators Guide Version 9.10

785

Even Header
Managing JMS Triggers

used to receive and process messages for each JMS trigger. The Current Threads
column displays Not Connected if Integration Server is not connected to a JMS
provider.

Throttling Thread Usage for JMS Triggers

Integration Server provides controls that you can use to throle the server thread usage
by JMS triggers. You can use the controls to:
Set the percentage of the server thread pool that Integration Server can use for
receiving and processing all JMS triggers.
Reduce maximum execution threads by the same percentage across all concurrent
JMS triggers. This also decreases the rate at which concurrent JMS triggers process
messages.
To throttle thread usage for JMS triggers
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Click JMS Trigger Management.
4. Click Edit JMS Global Trigger Controls.
5. In the Thread Pool Throttle eld, type the maximum percentage of the server thread
pool that can be used for JMS triggers. This includes threads used to retrieve
messages from the JMS provider and threads used to process messages. You must
enter a value greater than zero.
6. In the Individual Trigger Processing Throttle eld, select the value, as a percentage of
the congured maximum execution threads value, at which you want to the server
to function. Integration Server applies this percentage to the maximum execution
threads value for all concurrent JMS triggers.
This value applies to concurrent JMS triggers only.
7. Click Save Changes.
Notes:
If the Thread Pool Throttle percentage does not evaluate to a whole number when
applied to the size of the server thread pool, Integration Server rounds up or down
to the nearest whole number.
Serial JMS triggers always process one message at a time. For a serial trigger,
Integration Server uses the same thread for receiving and processing a message. The
Individual Trigger Processing Throttle does not aect serial JMS triggers.
Concurrent JMS triggers use a pool of consumers to receive and process messages.
Each consumer will use a thread from the server thread pool to receive and process a
message. A concurrent JMS trigger dedicates an additional thread per connection to
managing the pool of consumers. For example, a concurrent JMS trigger congured

webMethods Integration Server Administrators Guide Version 9.10

786

Odd Header
Managing JMS Triggers

to use one connection to the JMS provider and congured to process up to 10

messages at a time can use a maximum of 11 server threads. As another example,
a concurrent JMS trigger congured to use 2 connections to the JMS provider and
congured to process up to 10 messages at a time can use a maximum of 12 threads.
For more information about using multiple connections for a concurrent JMS trigger,
see "Allowing Multiple Connections for a JMS Connection Alias" on page 288.
For a concurrent JMS trigger congured to use multiple connections to the
webMethods Broker, the trigger's maximum execution threads will never be less
than the number of connections specied in the trigger's Connection count property.
This is true even when reducing the Individual Trigger Processing Throttle.
If the percentage by which you reduce concurrent JMS trigger execution threads
does not resolve to a whole number for a JMS trigger, Integration Server rounds
up or rounds down to the nearest whole number. However, if rounding down
would set the value to 0, the Integration Server rounds up to 1. For example, if you
reduce Individual Trigger Processing Throttle to 10% of maximum, a concurrent JMS
trigger with a maximum execution threads value of 12 would have an adjusted
value of 1 (Integration Server rounds 1.2 down to 1). A concurrent JMS trigger
with a maximum execution threads value of 4 would have an adjusted value of 1
(Integration Server rounds 0.4 up to 1).
When you reduce the Individual Trigger Processing Throttle and save your changes,
Integration Server does not meet the adjusted maximum by terminating any threads
currently executing concurrent JMS triggers. Integration Server allows server
threads processing messages for concurrent JMS triggers to execute to completion.
Integration Server waits until the number of threads executing for a concurrent JMS
trigger is less than the adjusted maximum before dispatching another server thread
for that JMS trigger.

Establishing a Threshold for Using Multiple Threads with a

Concurrent JMS Trigger
By default, concurrent JMS triggers begin using multiple server threads when there is
more than one message to process. Integration Server increases the number of server
threads used by the trigger until the JMS trigger uses the maximum number of threads
that it can to retrieve and process messages. The maximum number of threads that a JMS
trigger can use is determined by the Max execution threads property value set for the JMS
trigger.
To limit the number of threads used by concurrent JMS triggers, you can establish a
threshold that determines when the JMS trigger becomes multithreaded. A threshold
can be benecial when a concurrent JMS trigger requires additional processing resources
at specic times during the day due to an inux of messages, but for the majority of
the day the JMS trigger receives relatively few messages. When the rate if incoming
messages is low, the JMS trigger may need only a single thread to process messages
eciently.
The threshold is based on the consecutive number of successful requests for more
messages that the JMS trigger makes to the JMS provider. When a threshold is in
webMethods Integration Server Administrators Guide Version 9.10

787

Even Header
Managing JMS Triggers

use, a concurrent JMS trigger initially uses a single thread to retrieve and process
messages. When the number of successful consecutive requests for more messages
is equal to the specied threshold, the JMS trigger becomes multithreaded. The
maximum number of threads Integration Server can use for the JMS trigger is equal
to the value of the Max execution threads property plus one. (When a concurrent JMS
trigger is multithreaded, Integration Server dedicates a server thread to managing
the message consumer pool for the trigger.) The concurrent JMS trigger remains
multithreaded until the message consumers created by the threads time out. The
wa.server.jms.trigger.pooledConsumer.timeout property value determines when a
message consumer times out. When a consumer times out, the JMS trigger releases
the associated server thread. Eventually, when no messages are being received, the
concurrent JMS trigger returns to using a single thread.
To use a threshold to determine when a JMS trigger transitions
from being single threaded to multithreaded, set the
wa.server.jms.trigger.concurrent.consecutiveMessageThreshold server property to a
positive integer greater than 0 (zero). This property indicates the consecutive number
of successful requests for more messages from the JMS provider that the concurrent
JMS trigger must make before the trigger becomes multithreaded. For example, when
this property is set to 1000, a concurrent JMS trigger becomes multithreaded it makes
1000 consecutive successful requests for more messages from the JMS provider. The
default for this property is 0, which indicates that the use of a threshold for making a
concurrent JMS trigger multithreaded is disabled. When use of a threshold is disabled,
the concurrent JMS trigger will always be multithreaded when more than one message is
available for processing.
Note:

The threshold for determining when a concurrent JMS trigger becomes

multithreaded applies to all of the concurrent JMS triggers on the Integration
Server. This includes standard JMS triggers, SOAP-JMS triggers, and WSEndpoint triggers. It is not congurable on a per JMS trigger basis.

Configuring Integration Server Session Reuse

You can improve system performance by reusing the same Integration Server session
each time a JMS trigger invokes a service. When you reuse Integration Server sessions,
you reduce amount of overhead Integration Server requires for each service invocation.
Integration Server supports the re-use of Integration Server sessions for both transacted
and non-transacted JMS triggers and SOAP-JMS triggers.
You can set JMS triggers to reuse the same Integration Server session for each service
invocation by seing the wa.server.jms.trigger.reuseSession server conguration
parameter to true. By default, this parameter is set to false. For more information about
wa.server.jms.trigger.reuseSession, see "Server Conguration Parameters" on page
851.

webMethods Integration Server Administrators Guide Version 9.10

788

Odd Header
Managing JMS Triggers

Note:

Each service invocation on the reused session uses the same session ID. You
cannot reuse sessions with packages that require a unique session ID, such as
the SAP Adapter.

Configuring JMS Session Reuse

You can reduce overhead on JMS providers by reusing JMS sessions across
multiple transactions. Non-transacted JMS and SOAP-JMS triggers reuse JMS
sessions automatically after receiving and processing messages. To congure
this same behavior with transacted JMS triggers and SOAP-JMS triggers, set the
wa.server.jms.trigger.reuseJmsTxSession server conguration parameter to true.
If your JMS provider does not allow the reuse of transacted JMS sessions, set this
parameter to false. By default this parameter is set to true. For more information about
the wa.server.jms.trigger.reuseJmsTxSession server conguration parameter, see
"Server Conguration Parameters" on page 851.

Delaying Polling Requests for Concurrent JMS Triggers

You can reduce the resources that a concurrent JMS trigger uses for message polling by
delaying polling requests when the JMS trigger is inactive. If the polling delay feature
is enabled, an inactive concurrent JMS trigger waits the specied length of the polling
delay before polling the JMS provider for more messages. You can congure Integration
Server to gradually increase the delay between poling requests while the JMS trigger
remains inactive.
Note:

A concurrent JMS trigger is considered to be inactive if none of the message

consumers associated with the JMS trigger received messages in the last
round of requests to the JMS provider.

During a polling delay, the JMS trigger will not receive any messages. However, the JMS
trigger does not use resources from the JMS provider during the delay. If requests for
more messages are expensive for your chosen JMS provider, you might want to use a
polling delay to decrease the demands made by an inactive concurrent JMS trigger on
the JMS provider.
Conguring Integration Server to delay polling requests has minimal impact on the time
required to shut down Integration Server. As part of shut down, Integration Server shuts
down each JMS trigger. Integration Server can interrupt the extended delay to begin
shuing down the JMS trigger.
To use a polling delay, you need to specify the following:
The length of the delay that should elapse before the polling interval begins.
The wa.server.jms.trigger.extendedDelay.delays parameter determines the
length of the delay. If you want to use a gradually increasing delay, you indicate
the incremental delays by specifying a comma-separated list of integers. The

webMethods Integration Server Administrators Guide Version 9.10

789

Even Header
Managing JMS Triggers

wa.server.jms.trigger.extendedDelay.delays parameter is measured in milliseconds

and has a default value of: 0, 1000, 2000, 3000
The time interval at which Integration Server introduces the polling delay
for an inactive concurrent JMS trigger. If the JMS trigger remains inactive,
the same time interval determines when Integration Server increases the
delay between polling requests. The time interval is determined by the
wa.server.jms.trigger.extendedDelay.delayIncrementInterval parameter. This
parameter is measured in millisecond and has a default value or 0 which indicates
that Integration Server does not introduce a delay between polling requests for
inactive concurrent JMS triggers.

How JMS Trigger Delays a Polling Request

The following table explains how a concurrent JMS trigger polls for messages when
Integration Server is congured to delay polling requests for inactive concurrent JMS
triggers.
Stage

Description

The concurrent JMS trigger becomes inactive.

Integration Server considers a concurrent JMS trigger to be
inactive if none of the message consumers associated with the
JMS trigger received messages in the last round of requests to the
JMS provider.

If the
wa.server.jms.trigger.extendedDelay.delayIncrementInterval
parameter is greater than or equal to 1, the polling delay feature
is enabled. The JMS trigger begins to delay polling requests
by the amount of time specied by the rst integer in the
wa.server.jms.trigger.extendedDelay.delays parameter.
For example, suppose that
wa.server.jms.trigger.extendedDelay.delays = 1000, 2000, 3000.
When the JMS trigger becomes inactive, the JMS trigger
1. Waits 1000 milliseconds
2. Polls the JMS provider for more messages
When the
wa.server.jms.trigger.extendedDelay.delayIncrementInterval
parameter is set to 0, the polling delay feature is disabled.
Integration Server will not introduce a delay between polling
requests.

After the interval specied by

wa.server.jms.trigger.extendedDelay.delayIncrementInterval

webMethods Integration Server Administrators Guide Version 9.10

790

Odd Header
Managing JMS Triggers

Stage

Description
elapses, the JMS trigger begins to delay polling requests
by the amount of time specied by the second integer in
wa.server.jms.trigger.extendedDelay.delays.
For example, suppose that
wa.server.jms.trigger.extendedDelay.delayIncrementInterval,
which is measured in milliseconds, is set to 5000. The JMS trigger
polls for new messages at the frequency described in Stage
2 for 5000 milliseconds. After 5000 milliseconds elapse, the
JMS trigger begins using the second extended delay value. If
wa.server.jms.trigger.extendedDelay.delays = 1000, 2000, 3000,
the JMS trigger now waits 2000 millisecond before polling the
JMS provider for more messages.

After the interval specied by

wa.server.jms.trigger.extendedDelay.delayIncrementInterval
elapses, the JMS trigger begins to delay polling request
by the amount of time specied by the third integer in
wa.server.jms.trigger.extendedDelay.delays.
For example, suppose that
wa.server.jms.trigger.extendedDelay.delayIncrementInterval,
which is measured in milliseconds, is set to 5000. The JMS
trigger polls for new messages at the frequency described in
Stage 3 for 5000 milliseconds. After 5000 milliseconds elapse,
the JMS trigger begins using the third extended delay value. If
wa.server.jms.trigger.extendedDelay.delays = 1000, 2000, 3000,
the JMS trigger now waits 3000 milliseconds before polling the
JMS provider for more messages.

Each time the interval specied by

wa.server.jms.trigger.extendedDelay.delayIncrementInterval
elapses, the JMS trigger uses the next value in
wa.server.jms.trigger.extendedDelay.delays to
change the length of time between polling requests.
When the JMS trigger reaches the last value in
wa.server.jms.trigger.extendedDelay.delays, the JMS trigger
uses the specied polling delay until the JMS trigger retrieves a
message from the JMS provider.

When a polling request to the JMS provide returns one or more

messages, Integration Server considers the JMS trigger to be
active and stops using a polling delay.

webMethods Integration Server Administrators Guide Version 9.10

791

Even Header
Managing JMS Triggers

Examples of Extended Polling Delay Configuration

To further illustrate how you might congure an extended polling delay for concurrent
JMS triggers, consider the following examples.
Example 1
Suppose that the server conguration parameters for an extended polling delay
and concurrent JMS trigger polling interval are set as follows. Keep in mind that the
parameters are measured in milliseconds.
wa.server.jms.trigger.extendedDelay.delays = 100, 200, 1000
wa.server.jms.trigger.extendedDelay.delayIncrmentInterval = 5000
As soon as the JMS trigger becomes inactive, the JMS trigger waits the polling delay of
100 milliseconds and then polls the JMS provider for more messages. The JMS trigger
continues polling, waiting the 100 milliseconds specied by the extended delay between
polling requests. If 5000 milliseconds elapse and the JMS trigger remains inactive, the
JMS trigger begins using a 200 millisecond delay between polling requests. After 5000
more milliseconds, if the JMS trigger remains inactive, the JMS trigger begins to use
an extended delay of 1000 milliseconds. The JMS trigger continues to use the 1000
millisecond extended delay until a polling request returns one or more messages.
Example 2
When Integration Server is congured to use an extended polling delay for concurrent
JMS triggers, the rst delay takes place as soon as the JMS trigger becomes inactive. If
you want the JMS trigger to use an extended delay only after the interval specied by
wa.server.jms.trigger.extendedDelay.delayIncrementInterval elapses, use 0 as the rst
value in wa.server.jms.trigger.extendedDelay.delays.
Suppose that the server conguration parameters for an extended polling delay
and concurrent JMS trigger polling interval are set as follows. Keep in mind that the
parameters are measured in milliseconds.
wa.server.jms.trigger.extendedDelay.delays = 0, 10000
wa.server.jms.trigger.extendedDelay.delayIncrmentInterval = 3600000
After the JMS trigger has been inactive for an hour (3600000 milliseconds), the JMS
trigger waits the polling delay of 10000 milliseconds and then polls the JMS provider
for more messages. If the polling request does not return any messages, the JMS trigger
waits 10000 milliseconds and then polls the JMS provider for more messages. The JMS
trigger continues polling in this way until a polling request returns a message.

About WS Endpoint Triggers

A WS (Web Service) endpoint trigger is a SOAP-JMS trigger with limited conguration
options. A WS endpoint trigger is associated with a provider web service endpoint

webMethods Integration Server Administrators Guide Version 9.10

792

Odd Header
Managing JMS Triggers

alias and acts as a listener for any provider web service descriptors to which the alias
is assigned. Typically, WS endpoint triggers are used with virtual services deployed to
webMethods Mediator.
Keep the following points in mind when working with WS endpoint triggers:
Integration Server uses the following naming convention when creating a WS
endpoint trigger: WS Endpoint Trigger: aliasName where aliasName is the provider
web service endpoint alias name.
Integration Server saves WS endpoint triggers to the following conguration
le: Integration Server_directory/instances/instance_name /cong/endpoints/
providerJMS.cnf.
The existence of the WS endpoint trigger is tied to the provider web service endpoint
alias. If you select WS Endpoint Trigger as the JMS trigger to use with a provider web
service endpoint alias, Integration Server creates the WS endpoint trigger a part of
creating the alias. If you delete the alias, Integration Server deletes the WS endpoint
trigger as well.
At the time it creates the WS endpoint trigger, Integration Server sets some default
properties, such as serial processing and the JMS connection alias. You can use
Integration Server Administrator to change the default values.
Note:

While WS endpoint triggers are SOAP-JMS triggers, WS endpoint triggers

have a subset of the properties and features of a SOAP-JMS trigger. For
example, exactly-once processing, fatal error handling, and transient error
handling are available for SOAP-JMS triggers only.

When Integration Server creates a WS endpoint trigger, Integration Server assigns a

placeholder destination. The destination name uses the format: wseQueue_aliasName
where aliasName is the provider web service endpoint alias name. Unless a queue
with this name exists, you must specify the actual destination to which the WS
endpoint trigger subscribes.
When Integration Server creates a WS endpoint trigger, Integration Server leaves the
WS endpoint trigger in a disabled state. You must enable the trigger for it to receive
messages from the JMS provider. For more information about enabling JMS triggers,
see "Enabling, Disabling, and Suspending JMS Triggers" on page 782.
You can only edit the WS endpoint trigger using Integration Server Administrator.
You cannot use Designer to edit a WS endpoint trigger.
Integration Server sets the execution user to Administrator for all WS endpoint
triggers.

Editing WS Endpoint Triggers

When Integration Server creates a WS endpoint trigger as part of creating a provider
web service endpoint alias, Integration Server uses default values for some of the

webMethods Integration Server Administrators Guide Version 9.10

793

Even Header
Managing JMS Triggers

trigger properties and placeholders for other properties. You can use Integration Server
Administrator to change the default and placeholder values.
Keep the following guidelines in mind when editing a WS endpoint trigger:
The JMS connection alias you want Integration Server to use to obtain connections
to and receive messages from the JMS provider must already exist. Although a JMS
connection alias does not need to be enabled at the time you assign it to the WS
endpoint trigger, the JMS connection alias must be enabled for the WS endpoint
trigger to execute at run time.
The transaction type of the JMS connection alias determines whether or not the WS
endpoint trigger is transacted (that is, it receives and processes messages as part of a
transaction)
The destination to which the WS endpoint trigger subscribes must be a queue.
Only concurrent triggers can have a Max Execution Threads value greater than one.
To specify a Connection Count value greater than one, the following must be true:
The specied JMS connection alias must be congured to create a new
connection for each JMS trigger that uses that connection alias. For more
information, see "Allowing Multiple Connections for a JMS Connection Alias" on
page 288.
The WS endpoint trigger must be congured for concurrent processing.
To edit a WS endpoint trigger
1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Click JMS Trigger Management.
4. Under Individual SOAP JMS Trigger Controls, select the WS endpoint trigger that you
want to edit.
5. On the Settings > Messaging > JMS Trigger Management > Detail > triggerName screen, click
Edit Trigger.
6. In the JMS Connection Alias list, select the JMS connection alias that you want the WS
endpoint trigger to use to receive messages from the JMS provider.
7. In the Destination Name eld, type the name of the queue from which the WS
endpoint trigger will receive messages.
8. Next to Processing Mode, select one of the following:
Select...

To...

Serial

Specify that Integration Server processes messages received

by the trigger one after the other.

webMethods Integration Server Administrators Guide Version 9.10

794

Odd Header
Managing JMS Triggers

Select...

To...

Concurrent

Specify that Integration Server processes multiple messages

for this trigger at one time.

9. If you selected concurrent processing, in the Max execution threads eld, specify the
maximum number of messages that Integration Server can process concurrently.
10. If you selected concurrent processing, in the Connection Count eld, specify
the number of connections you want the WS endpoint trigger to make to the
webMethods Broker.
Note:

The Connection Count value must be less than or equal to the Max Execution
Threads value.

11. Click Save Changes.

webMethods Integration Server Administrators Guide Version 9.10

795

Even Header

webMethods Integration Server Administrators Guide Version 9.10

796

Odd Header
Using a Document History Database with Exactly-Once Processing

37 Using a Document History Database with ExactlyOnce Processing

Overview .....................................................................................................................................

798

Removing Expired Entries from the Document History Database .............................................

798

Viewing Exactly-Once Processing Statistics ..............................................................................

799

Clearing Exactly-Once Processing Statistics .............................................................................

799

webMethods Integration Server Administrators Guide Version 9.10

797

Even Header
Using a Document History Database with Exactly-Once Processing

Overview
The document history database maintains a record of guaranteed documents processed
by webMethods messaging triggers and persistent messages processed by JMS triggers.
The database keeps a document history only for triggers that specify that document
history should be used as part of duplicate detection. Integration Server adds entries
to the document history database when a trigger service begins executing and when it
executes to completion (whether it ends in success or failure).
For more information about exactly-once processing for webMethods messaging triggers
or JMS triggers, see webMethods Service Development Help.

Removing Expired Entries from the Document History

Database
To keep the size of the document history database manageable, Integration Server
periodically removes expired rows from the database. The value of the trigger's History
time to live property determines how long the document history database maintains an
entry for a processed document or message.
Integration Server provides a scheduled service to remove expired entries from the
database. By default, the Message History Sweeper task executes every 10 minutes. You
can change the frequency with which the service executes. For information about editing
scheduled services, see "Scheduling Services" on page 643.
Note:

The wa.server.idr.reaperInterval property determines the initial execution

frequency for the Message History Sweeper task. After you dene a JDBC
connection pool for Integration Server to use to communicate with the
document history database, change the execution interval by editing the
scheduled service.

You can also clear all expired entries from the database at any time. For more
information, see "Clearing Expired Entries from the Document History Database" on
page 798.

Clearing Expired Entries from the Document History Database

If you do not want to wait for the next scheduled execution of the Message History
Sweeper task to remove expired entries, you can use Integration Server Administrator to
remove all of the expired entries.
To clear expired entries from the document history database
1. Open Integration Server Administrator.

webMethods Integration Server Administrators Guide Version 9.10

798

Odd Header
Using a Document History Database with Exactly-Once Processing

2. From the Settings menu in the Navigation panel, click Resources.

3. Click Exactly Once Statistics.
4. Click Remove Expired Document History Entries.

Viewing Exactly-Once Processing Statistics

You can use Integration Server Administrator to view a history of the In Doubt or
Duplicate messages received by JMS triggers. Integration Server Administrator displays
the name, UUID (universally unique identier), and status for the Duplicate or In Doubt
messages received by triggers for which exactly-once processing is congured.
Integration Server saves exactly-once statistics in memory. When Integration Server
restarts, the statistics will be removed from memory.
To view exactly-once processing statistics
1. Start webMethods Integration Server and open the Integration Server Administrator.
2. Under the Settings menu in the navigation area, click Resources.
3. Click Exactly-Once Statistics.

Clearing Exactly-Once Processing Statistics

You can use Integration Server Administrator to delete statistics for In Doubt documents
and Duplicate documents.
To clear exactly-once processing statistics
1. Start webMethods Integration Server and open the Integration Server Administrator.
2. Under the Settings menu in the navigation area, click Resources.
3. Click Exactly-Once Statistics.
4. Click Clear All Duplicate or In Doubt Document Statistics.

webMethods Integration Server Administrators Guide Version 9.10

799

Even Header

webMethods Integration Server Administrators Guide Version 9.10

800

Odd Header
Using Integration Server to Manage XA Transactions

38 Using Integration Server to Manage XA

Transactions

Overview of XA Transaction Management ................................................................................

802

Configuring XA Options in Integration Server ............................................................................

807

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

810

webMethods Integration Server Administrators Guide Version 9.10

801

Even Header
Using Integration Server to Manage XA Transactions

Overview of XA Transaction Management

A transaction is a logical unit of work, composed of many dierent processes, that either
entirely succeeds or has no eect at all.
Because the work being performed within a transaction can occur on many dierent
platforms and can involve many dierent resources from dierent vendors, the X/Open
organization developed the distributed transaction process (DTP) model and the XA
interface.
The DTP model denes communication among the following:
Resources such as databases.
Resource managers such as database servers. Resource managers provide access to
shared resources.
A transaction manager. The transaction manager coordinates and controls all
transactions for resources through their resource managers. Integration Server
contains a transaction manager sub-system that coordinates and controls database
transactions that are initiated by the webMethods Adapter for JDBC or the
webMethods Adapter for JMS.
The XA interface describes the protocol for transaction coordination, commitment, and
recovery between resource and a transaction manager. Integration Server supports the
XA protocol; it manages transactions using the transaction protocol called two-phase
commit, or 2PC.
In the rst phase of 2PC, Integration Server (specically, the transaction manager) asks
the resources that are participating in a transaction whether they are prepared to commit
the transaction. In the second phase, one of the following occurs:
All the resources respond that they are prepared to commit. Integration Server
instructs the resources to commit the transaction.
One or more resources respond that they are not prepared to commit. Integration
Server instructs all resources to roll back their preparations for commiing the
transaction.

How the Integration Server Persists the State of a Transaction

At the beginning of a transaction, Integration Server creates a unique transaction
ID called an XID. The Integration Server stores the XID and the global state of the
transaction in a persistent store called the XA recovery store. At the beginning of each
subsequent action taken for the transaction, Integration Server stores the global state
of the transaction and the state of each resource that is participating in the transaction
in the XA recovery store. If Integration Server ends abnormally, Integration Server can
retrieve the state information from the XA recovery store and try to resolve uncompleted
transactions, if there are any.

webMethods Integration Server Administrators Guide Version 9.10

802

Odd Header
Using Integration Server to Manage XA Transactions

For Integration Server to store state information, the following conditions must be met:
The transaction involves multiple resources and all the resources are XA-enabled
(that is, the resources support the JTA and XA standards and keep persistent records
of transactions that have been prepared or heuristically commied).
The transaction is dened as an XA transaction. For example, if the transaction
involves the webMethods Adapter for JDBC, the transaction would be dened as an
XA transaction on the adapter's connections to the resources.
Note:

As with most features that improve reliability and recoverability, this

feature may increase the overhead associated with processing XA
transactions.

How the Integration Server Resolves Uncompleted Transactions

If Integration Server ends abnormally while transactions are in progress, those
transactions are uncompleted. When Integration Server restarts, it retrieves a list
of uncompleted transactions from the XA recovery store. Based on the last status
Integration Server logged for the transactions on the list, Integration Server tries to
resolve each transaction, as follows:
If...

Integration Server does this...

The resources had begun the commit

process and at least one resource had
commied the transaction

Tries to get the other resources to

commit

The resources had nished preparing

to commit the transaction but had not
begun the commit process

Tells the resources to roll back all

preparations for the commit

The resources had begun the commit

process but no resource had commied
the transaction

Tells the resources to roll back all

preparations for the commit

The resources had begun but not

completed rolling back the transaction

Tells the resources to roll back all

preparations for the commit

Integration Server had not yet asked the

resources whether they are prepared to
commit the transaction

Forgets the transaction and erases its

XID from the XA recovery store

webMethods Integration Server Administrators Guide Version 9.10

803

Even Header
Using Integration Server to Manage XA Transactions

If...

Integration Server does this...

The resources had completed

commiing or rolling back the
transaction

Forgets the transaction and erases its

XID from the XA recovery store

If an error occurs while Integration Server is trying to resolve an uncompleted

transaction, Integration Server waits a period of time that you specify and then tries
again. Integration Server continues trying to resolve the uncompleted transaction
until a maximum recovery time that you specify expires. For more information about
conguring these values, see "Conguring XA Server Parameters" on page 809.
New XA transactions continue unimpeded during Integration Server's aempts at
resolution.
Integration Server cannot resolve all uncompleted transactions. For example, Integration
Server cannot resolve a transaction in these cases:
A resource administrator forced a commit or rollback of a transaction on a resource
after Integration Server ended abnormally.
The transaction includes a 1PC (one-phase commit) resource, and Integration Server
stores statuses only for transactions whose participating resources are all XAenabled.
Integration Server cannot connect to the resource after repeated aempts within the
specied maximum recovery time (for example, because the transaction involves the
webMethods Adapter for JDBC and the adapter's connection to the resource does not
exist or has been changed).
In such cases, you will have to resolve the uncompleted transaction manually.

About Unresolved XA Transactions

Integration Server displays the XA transactions that need to be manually resolved on the
Settings > Resources > XA Manual Recovery screen. Integration Server lists the unresolved
transaction in a table and displays the following information about each unresolved
transaction.
Column

Description

XID

Unique XID for the transaction. Integration Server created the

XID at the beginning of the transaction and wrote it to the XA
recovery store; Integration Server also provided the XID to the
participating resources, which also stored the information.

Global 2PC
State

Global state of the transaction before Integration Server ended.

If a state maps to a global state in the javax.transaction.Status

webMethods Integration Server Administrators Guide Version 9.10

804

Odd Header
Using Integration Server to Manage XA Transactions

Column

Description
interface described in the JTA standard, that mapping is shown
below.
State

Description

TR_PREPARE_BEGIN

STATUS_PREPARING

TR_PREPARE_RESOURCE
TR_PREPARE_RESOURCE_END
TR_PREPARE_END

STATUS_PREPARED

TR_COMMIT_BEGIN

STATUS_COMMITTING

TR_COMMIT_RESOURCE
TR_COMMIT_RESOURCE_END
TR_ROLLBACK_BEGIN

STATUS_ROLLING_BACK

TR_ROLLBACK_RESOURCE
TR_ROLLBACK_RESOURCE_END
TR_ROLLBACK_END

STATUS_ROLLED_BACK

TR_ROLLBACK_ONLY

MARKED_ROLLBACK

TR_FORGET_RESOURCE
TR_FORGET_RESOURCE_END
TR_COMPLETED
TR_RECOVERY

Integration Server is
trying to resolve the
transaction.

TR_UNDEFINED

STATUS_UNKNOWN

webMethods Integration Server Administrators Guide Version 9.10

805

Even Header
Using Integration Server to Manage XA Transactions

Column

Description

Error
Message

Error message that Integration Server wrote to the server log

before storing the global state of the transaction in the XA
recovery store.

Recovery
Action
Attempted

Action that Integration Server took to try to resolve the

transaction. If Global 2PC State is TR_COMMIT_BEGIN,
Integration Server tried to commit the transaction. If the global
state is any other value, Integration Server tried to roll back the
transaction.

Note:

Refresh the page at intervals to make sure all uncompleted transactions are
listed. Suppose Integration Server tries to resolve an uncompleted transaction
but cannot; the transaction will not be listed while Integration Server is trying
to resolve it, but if you refresh the page later, the transaction will appear on
the list.

Details for an Unresolved XA Transaction

For each unresolved XA transaction, you can view detailed information, such as the
participating resources, the state of the transaction on each resource, and the inferred
status of the transaction on the resource. When you click the XID for an unresolved
transaction on the Settings > Resources > XA Manual Recovery screen, the Integration Server
Administrator displays the following information for each resource involved in the
transaction:
Column

Description

XA
Resource

Fully qualied name of the resource.

XID Exists?

Indicates whether the transaction's XID exists on the resource.

This...

Indicates...

Yes

That the XID exists on the resource.

No

That the XID does not exist.

Unknown

That the Integration Server could not

determine whether the XID exists on the
resource.

webMethods Integration Server Administrators Guide Version 9.10

806

Odd Header
Using Integration Server to Manage XA Transactions

Column

Description

State

Current state of the transaction on the resource. The values are the
same as those in the Global 2PC State list. For a list of global 2PC
states, see the table in "About Unresolved XA Transactions" on
page 804.

Inferred
Status

Assumed status of the transaction on the resource, based on the

values of XID exists and State. Based on the possible combinations,
statuses are as follows:
XID Exists?

State

Inferred Status

Yes

Any

Prepared, or
heuristic action
was taken

No

TR_ROLLBACK_
RESOURCE_END

Rolled back

No

TR_FORGET_
RESOURCE_END

Forgoen

No

Anything other than

TR_ROLLBACK_
RESOURCE_END or
TR_FORGET_
RESOURCE_END

Commied

For information about manually resolving transactions, see "Manually Resolving a

Transaction" on page 810.

Configuring XA Options in Integration Server

Using Integration Server, you can congure the following options for XA:
Enabling or disabling XA transaction recovery.
The location and initial size of the XA recovery store.
Server parameters that determine:
The length of time that Integration Server waits between aempts to resolve a
transaction.
The maximum time allowed to resolve a transaction.

webMethods Integration Server Administrators Guide Version 9.10

807

Even Header
Using Integration Server to Manage XA Transactions

Whether a transaction should continue if Integration Server cannot store the

status of a transaction and its participating resources in the XA recovery store
(for example, because the store is corrupted).
The following sections provide more information about seing these options.

Enabling or Disabling XA Transaction Recovery

You can enable or disable XA transaction recovery. When you disable XA transaction
recovery, Integration Server does not aempt to recover incomplete transactions
automatically. Additionally, you cannot use Integration Server Administrator to recover
incomplete transactions manually.
If you are willing to exchange reliability and recovery of XA transactions in return for
possible improved processing performance, you might want to disable XA transaction
recovery. By default, Integration Server enables XA transaction recovery.
To enable or disable XA transaction recovery
1. Open the Integration Server Administrator if it is not already open
2. In Integration Server Administrator, go to Settings > Resources and click XA Manual
Recovery.
3. Do one of the following:
If XA transaction recovery is currently enabled and you want to disable it,
click Disable XA Transaction Recovery. Integration Server Administrator hides the
Unresolved XA Transaction table.
If XA transaction recovery is currently disabled and you want to enable it, click
Enable XA Transaction Recovery. Integration Server Administrator displays the
Unresolved XA Transaction table.
Tip:

You can also use the wa.server.jca.transaction.writeRecoveryRecord

server parameter to enable or disable XA transaction recovery.
For more information about seing server parameters, see "Server
Conguration Parameters" on page 851.

Configuring the XA Recovery Store

The XA recovery store is a persistent store that contains the XID and global sate of a
transaction. You can specify the location of the XA recovery store and the initial size of
the le at start up.
To configure the XA recovery store
1. Go to Settings > Resources and click Store Settings. In the XA Recovery Store section,
Integration Server Administrator shows the current seings for the location of the
XA recovery store and its initial size.

webMethods Integration Server Administrators Guide Version 9.10

808

Odd Header
Using Integration Server to Manage XA Transactions

2. Click Edit XA Recovery Store Settings.

3. In the Store Location eld, type the relative or absolute path to the directory in the le
system in which to store the XA recovery store le. The default location is:
Integration Server_directory\instances\instance_name \XAStore
Important: Make sure that you have write access to the specied directory and that
the directory does not contain any characters considered illegal by your
operating system.
4. In the Initial Store Size (MB) eld, type the initial size for the XA recovery store le, in
megabytes. The default is 10MB.
Note:

Make sure that there is enough free disk space on the Integration Server
machine to accommodate the initial sizes of the default document store,
the trigger document store, and the XA recovery store.

5. Click Save Changes.

When you next restart Integration Server, it will create a new XA recovery store le
in the new location and start writing to it. Integration Server will also use the new
initial size for the le.

Configuring XA Server Parameters

Integration Server provides the following server parameters for XA transactions and XA
transaction recovery.
watt.server.transaction.recovery.sleepInterval
If an error occurs while Integration Server is trying to resolve an uncompleted
transaction, species the period of time Integration Server waits between resolution
aempts.
watt.server.transaction.recovery.abandonTimeout
Species the maximum recovery time for resolving the transaction. Integration Server
continues trying to resolve the transaction until the maximum recovery time expires.
watt.server.jca.transaction.rollbackOnWriteFailure
Species whether Integration Server should continue with a transaction or roll it back if
Integration Server cannot store the status of a transaction and its participating resources
in the XA recovery store (for example, because the store is corrupted). Seing the
parameter to false involves some risk; if Integration Server ends abnormally, no statuses
will have been saved to the XA recovery store, and Integration Server will not be able to
resolve the uncompleted transaction or give you the chance to resolve it manually.
For more information about these and other server parameters, see "Server
Conguration Parameters" on page 851.

webMethods Integration Server Administrators Guide Version 9.10

809

Even Header
Using Integration Server to Manage XA Transactions

Manually Resolving a Transaction

If Integration Server cannot resolve a transaction, you can try to resolve it manually. To
successfully resolve a transaction manually, you must be familiar with the participating
resources and must act in a way that leaves the transaction in a consistent state. For
example, if only one of the participating resources commied the transaction, you can
try to get the other participating resources to commit as well.
When you manually resolve a transaction, resolution is not itself a transaction; that is,
each participating resource and the action you perform on it does not participate in a
new 2PC transaction. You must therefore make sure your actions result in a consistent
state for the participating resources.
To manually resolve an XA transaction
1. Open the Integration Server Administrator if it is not already open
2. In Integration Server Administrator, go to Settings > Resources and click XA Manual
Recovery. Integration Server Administrator displays all of the unresolved XA
transactions. For a description of the information displayed for each unresolved
transaction, see "About Unresolved XA Transactions" on page 804.
Note:

Refresh the page at intervals to make sure all uncompleted transactions

are listed. Suppose Integration Server tries to resolve an uncompleted
transaction but cannot; the transaction will not be listed while Integration
Server is trying to resolve it, but if you refresh the page later, the
transaction will appear on the list.

3. In the XID column, click the XID for the transaction that you want to resolve. The
Integration Server Administrator displays detailed information about the resources
involved in the transaction. For a description of the information displayed for each
participating resource, see "Details for an Unresolved XA Transaction" on page
806.
4. If you want to delete the transaction, click the Delete Transaction link. Deleting the
transaction removes the transaction from the XA recovery store.
You might want to simply delete a transaction if you do not want to resolve a
transaction using Integration Server Administrator (for example, because you want
to resolve the transaction by working with the resources directly).
5. If you want to resolve the transaction using Integration Server Administrator, select
one of the following in the Desired Action column.
If you want to...

Select...

You want to commit the transaction on

the resource

Commit

webMethods Integration Server Administrators Guide Version 9.10

810

Odd Header
Using Integration Server to Manage XA Transactions

If you want to...

Select...

You want to roll back the transaction

on the resource

Roll back

The resource administrator

heuristically commied or rolled back
the transaction, so you want to erase
the XID from the resource

Forget

The resource administrator has already

taken the correct action on the resource
so you need take none, or the resource
is down for an extended period

Do nothing

Note:

The Desired Action column lists the possible actions for each resource, based
on the combination of the values for State and XID for the resource, and
selects the most logical action by default.

6. Click Perform Action. Integration Server Administrator returns to the XA Manual

Recovery screen and removes the transaction from the list of unresolved transactions.
Integration Server might receive and display an error from a resource. Errors can
occur for these reasons:
The resource was not connected to Integration Server, probably because the
resource was down.
The resource has no knowledge of the transaction, possibly because it lost the
2PC transaction information.
The resource threw an exception.
The transaction involved a webMethods adapter, and Integration Server cannot
locate the resource because someone deleted or changed the adapter connection
node that pointed to the resource from Software AG Designer.
You might have to force the transaction to a consistent state using the tools available
on the resource itself.

webMethods Integration Server Administrators Guide Version 9.10

811

Even Header

webMethods Integration Server Administrators Guide Version 9.10

812

Odd Header
Content Handlers

39 Content Handlers
How the Server Uses Content Handlers ...................................................................................

814

How the Server Chooses a Content Handler for an HTTP Request .........................................

814

How the Server Chooses a Content Handler for an FTP Request ............................................

814

Content Handlers for HTTP and FTP Requests ........................................................................

814

About Content Handlers for HTTP Responses ..........................................................................

819

About Content Handlers for FTP Responses ............................................................................

820

webMethods Integration Server Administrators Guide Version 9.10

813

Even Header
Content Handlers

How the Server Uses Content Handlers

When a client submits an HTTP or FTP request, Integration Server uses a content
handler to parse the contents of the request and pass them to the target service.
Integration Server also uses a content handler when building the HTTP or FTP response.

How the Server Chooses a Content Handler for an HTTP

Request
To determine which content handler to use for an incoming HTTP request, Integration
Server looks at the Content-Type header eld in the request header, and then uses the
content handler registered for it. For example, if the request header species ContentType=text/html, Integration Server looks for a content handler that has been registered
as the text/html content handler.

How the Server Chooses a Content Handler for an FTP

Request
To determine which content handler to use for an incoming FTP request, the FTP
listening port on Integration Server chooses the content handler based on the le
extension of the request. The Integration Server_directory/instances/instance_name /lib/
mime.types le contains the mappings of le extension to content type.
You can edit the mappings in the lib/mime.types le from Integration Server
Administrator by selecting Settings > Resources > Mime types. For more information about
editing the mappings of the lib/mime.types le, see webMethods Service Development Help.

Content Handlers for HTTP and FTP Requests

The following section lists the content handler Integration Server will use for incoming
HTTP and FTP requests based on the registered content type.
Integration Server uses the
content handler...

When the content

type is...

To parse...

ContentHandler_CGI

text/html and
wa.server.default
ContentHandler is
set to false

CGI content and unformaed

text.

webMethods Integration Server Administrators Guide Version 9.10

This content handler does the

following:

814

Odd Header
Content Handlers

Integration Server uses the

content handler...

When the content

type is...

To parse...
Decodes an incoming input
stream and converts the
content to key/value pairs.
If the key already exists, the
value is added to a list in the
pipeline with the key key +list .
Writes the key/value pair to an
HTML table.

ContentHandler_Default

application/xwww-formurlencoded

Name/value pairs obtained

from web forms.

text/html and
wa.server.default
ContentHandler is
set to true

Input stream from an HTTP

request or a document from an
FTP request.
This content handler does the
following:
For HTTP requests, it passes
the contents of the input
stream from the HTTP request
to the service specied in the
submit method in an input
stream named contentStream .
For FTP requests, it passes
the contents of the document
from the FTP request to the
service specied in the submit
method in an input stream
named contentStream .
For HTTP and FTP, it writes
a key/value pair to an HTML
table.

ContentHandler_FlatFile

application/xwmatle

Flat le content.
This content handler does the
following:
Passes the contents of the at
le to the service specied in

webMethods Integration Server Administrators Guide Version 9.10

815

Even Header
Content Handlers

Integration Server uses the

content handler...

When the content

type is...

To parse...
the submit method in an input
stream named data .
Returns data in an input
stream or a ByteArray called
return .
For information about using
this content-type header, see
Flat File Schema Developers Guide

ContentHandler_IDAT

application/xwmidatabin

Input stream from an HTTP

request or a document from an
FTP request.
This content handler does the
following:
Converts the input stream or
document to an iData object.
Converts the data to an XML
representation of IData.

ContentHandler_JSON

application/json

JSON content.
Integration Server supports
Note:
the application/json content
type only with the invoke and
rest directives.
The behavior of this
content handler is based
on the seing for the
wa.server.hp.jsonFormat
parameter.
When set to parsed, parses
JSON content into pipeline
variables automatically. You
can then use JSON to compose
pipelines and execute existing
services without calling
pub.json:jsonStreamToDocument.
When set to stream, adds
the request body to the
pipeline as jsonStream . The

webMethods Integration Server Administrators Guide Version 9.10

816

Odd Header
Content Handlers

Integration Server uses the

content handler...

When the content

type is...

To parse...
pub.json:jsonStreamToDocument
service converts the jsonStream
into a document (IData object)
so you can use the elements
from jsonStream in a ow
service.
When set to bytes, passes
the incoming stream of JSON
content as a byte array named
jsonBytes .
For detailed
Note:
information about the
wa.server.hp.jsonFormat
parameter, see "Server
Conguration Parameters"
on page 851. For more
information about the
pub.json:jsonStreamToDocument
service, see webMethods
Integration Server Built-In
Services Reference.

ContentHandler_Multipart

multipart/
related

Objects that are part of related

body parts. For example,
an HTML web page with
its related ../_graphics/
is_administrators_guide_graphics/
graphics les.
This content handler does the
following:
Passes the input stream to
the pipeline with the key
contentStream .
Writes a key/value pair to an
HTML table.

ContentHandler_RPC

application/xwmrpc

Input stream from an HTTP

request or a document from an
FTP request.
This content handler does the
following:

webMethods Integration Server Administrators Guide Version 9.10

817

Even Header
Content Handlers

Integration Server uses the

content handler...

When the content

type is...

To parse...
Converts the data from an
input stream to a key/ value
pair.
Writes the values as RPC
encoded to the data stream.

ContentHandler_RPC2

application/xwmrpc2

Input stream from an HTTP

request or a document from an
FTP request.
This content handler does the
following:
Creates an iData object from
the input stream or document.
Writes the values as RPC
encoded to the data stream.

ContentHandler_SOAP

text/xml

Input stream from an HTTP

request or a document from an
FTP request.
This content handler does the
following:
Adds a SOAP request message
to the pipeline with the key
soapRequestData .
Adds a SOAP response to
the pipeline with the key
soapResponseData .

ContentHandler_XML

application/soap

SOAP messages.

application/soap
+xml

SOAP 1.2 messages serialized as

XML.

text/xml

XML

application/xml

XML

webMethods Integration Server Administrators Guide Version 9.10

818

Odd Header
Content Handlers

Notes:
Other webMethods products and customer applications can register dierent
content handlers for any of these Content-Type headers, which might change the
behavior of Integration Server when Integration Server receives messages of that
type. For example, Trading Networks registers its own XML content handler for text/
xml. When this happens, Integration Server will use the Trading Networks content
handler to process incoming XML messages.
If the Content-Type header eld species a content type for which no content
handler has been registered, Integration Server uses the default content handler
(ContentHandler_Default), which treats the content as text/html.
If an FTP or FTPS port receives a le that does not have an extension, Integration
Server uses the default content handler (ContentHandler_Default), which treats the
content as text/html.

About Content Handlers for HTTP Responses

Note:

If a response has already been created by the pub.flow:setResponse2 service,

Integration Server does not use a content handler for the response.

Integration Server does the following to select a content handler for an HTTP response:
1. Looks at the Content-Type header eld in the response header, and then uses the
contentHandler registered for that content type. This eld has a value only if the
application assigns one using the pub.flow:setResponseHeader service.
If the Content-Type header eld in the response header species an unsupported
content type, Integration Server uses text/html.
2. If content type is not specied in the response header, Integration Server looks at the
Accept header eld in the request header to determine content type, and then uses
the content handler registered for that content type.
3. If there is no Accept header eld in the request header, or if there is no content
handler for the content-type specied by the Accept header eld, Integration Server
uses the content handler that was used for the request.

Accept Header Field

The Accept header eld species which content type or types the client will accept in the
response. The Accept header eld can specify multiple acceptable content types, either
by listing them (application/json, text/html, text/xml, and so on), or by using wildcards
(text/*).

webMethods Integration Server Administrators Guide Version 9.10

819

Even Header
Content Handlers

By default, if the Accept header species a content type using a wildcard, Integration
Server will select the rst content handler registered for that major type (text,
application, multipart), as follows:
This Accept Header field...

Results in this content handler

text/*

XML

application/*

CGI

multipart/*

Multipart

To control which content handler Integration Server will use when a wildcard is
specied in the Accept header, you must use the wa.server.content.type.mappings
server conguration parameter. The syntax for this parameter is:
wa.server.content.type.mappings=<wildcard1 > <content-type1 >,<wildcard2 > <contenttype2 >,<wildcardN > <content-typeN >
For example, to associate text/* with text/xml and multipart/* with multipart/
related, specify the parameter as follows:
wa.server.content.type.mappings=text/* text/xml,multipart/* multipart/related
The Accept header might contain multiple content types with parameters indicating an
order of preference. Integration Server will aempt to respond with the "most preferred"
content type as dened by RFC 2616, section 14.
Integration Server supports the Accept header eld in HTTP request headers if the
wa.server.hp.useAcceptHeader conguration parameter is set to true. The default
seing for this parameter is true.

About Content Handlers for FTP Responses

Note:

If a response has already been created by the pub.flow:setResponse2 service,

Integration Server does not use a content handler for the response.

When creating a response, Integration Server uses the content handler registered for the
content type in the lib/mime.types le.
The Integration Server_directory/instances/instance_name /lib/mime.types le contains
the mappings of le extension to content type. You can edit the mappings with
Integration Server Administrator by selecting Settings > Resources > Mime types. For
more information about editing the mappings of the lib/mime.types le, see webMethods
Service Development Help.

webMethods Integration Server Administrators Guide Version 9.10

820

Odd Header
Quiescing the Server for Maintenance

40 Quiescing the Server for Maintenance

Overview .....................................................................................................................................

822

Specifying the Quiesce Port ......................................................................................................

825

Quiescing Integration Server .....................................................................................................

825

Exiting Quiesce Mode ................................................................................................................

829

Deploying Quiesce Mode Configuration ....................................................................................

829

webMethods Integration Server Administrators Guide Version 9.10

821

Even Header
Quiescing the Server for Maintenance

Overview
Quiescing an Integration Server temporarily disables access to the server so you can
perform maintenance tasks while the server is not connected to any external resources.
In quiesce mode, any requests that are already in progress are permied to nish, but
any new inbound requests to the server are blocked. Outbound connection aempts,
such as connections to JDBC pools or connections through LDAP or a central user
directory, remain open.

What Happens when Integration Server Enters Quiesce Mode?

When Integration Server enters quiesce mode, the server disables or suspends the
following assets and activities:
Ports.Integration Server disables all ports except the diagnostic port and the port
used to enter and exit quiesce mode.
For details about specifying a port to use for quiescing the server, see "Specifying the
Quiesce Port" on page 825.
JMS messaging.Integration Server disables all JMS connection aliases and suspends
all JMS triggers including SOAP-JMS triggers and web service endpoint triggers.
This prevents the retrieval and processing of new messages. Any trigger services
that are running aempt to execute to completion. For more information about how
Integration Server suspends JMS triggers, see "Conguring Integration Server to
Enable JMS Triggers Automatically after a Consumer Error" on page 785.
webMethodsmessaging.Integration Server disables all webMethods messaging
connection aliases that specify Universal Messaging as the messaging provider.
Integration Server also suspends document retrieval and document processing for
webMethods messaging triggers, which includes webMethods messaging triggers
that receive documents from Universal Messaging, Broker, or locally published
documents from the Integration Server. Any trigger services that are running
aempt to execute to completion. For more information about how Integration
Server suspends document retrieval for webMethods messaging triggers, see
"Suspending and Resuming Document Retrieval" on page 753. For more information
about how Integration Server suspends document processing for webMethods
messaging triggers, see "Suspending and Resuming Document Processing" on page
761.
Packages.Integration Server disables all packages except WmRoot and WmPublic.
The server unloads the packages and their resources, completes the packages
shutdown services, and disables the packages in memory.
When you switch a server from active mode to quiesce mode, you can specify the
number of minutes the server should wait before disabling packages. If services
are running, this wait time gives the services a chance to complete before the
server disables the package in which they reside, or the packages in which their

webMethods Integration Server Administrators Guide Version 9.10

822

Odd Header
Quiescing the Server for Maintenance

dependent services reside. If you do not specify a wait time, Integration Server
disables packages immediately.
Scheduled user tasks.Integration Server pauses the scheduler, permits the completion
of any scheduled user tasks that are already running, and suspends any scheduled
user tasks that have not yet started. If a running user task does not complete
before its dependent services are disabled, the task will end in error because of the
unresolved dependencies.
Guaranteed delivery.Integration Server shuts down the inbound and outbound
guaranteed delivery Job Managers and stops both inbound and outbound
guaranteed delivery of documents. For outbound delivery, the server sets the wa
property wa.tx.disabled to True to disable the use of guaranteed delivery for
outbound requests.
Note:

Because the server forcefully shuts down the inbound and outbound Job
Managers when entering quiesce mode, in-process transactions may fail.
Avoid submiing any transactions for processing as the server enters
quiesce mode.

If you want to receive inbound guaranteed delivery requests while the

server is in quiesce mode, you must rst make sure the wa property
wa.server.tx.heuristicFailRetry is set to True. Then, start the inbound Job Manager
using the service pub.tx:init. The server will re-execute the services for transactions
in the job store that are in PENDING status.
If you want to submit outbound transactions while the server is in quiesce mode,
you must rst set the wa property wa.tx.disabled to False. Then, start the
outbound Job Manager using the service pub.tx:resetOutbound.
Clustering.Integration Server shuts down all cache managers in the
Integration Server_directory\instances\instance_name \cong\Caching directory and
exits the cluster.
The following activities continue when the server is in quiesce mode:
Active tasks.Integration Server completes user tasks that were started before
Integration Server entered quiesce mode. Integration Server continues to process
scheduled system tasks while in quiesce mode.
Audit logging. The server continues to write audit logging records to the database
while in quiesce mode.
Enterprise Gateway. If the Integration Server acting as the Internal Server is quiesced,
the server disconnects any existing connections to the Enterprise Gateway Server
and completes user tasks that were started before the server entered quiesce mode.
If the Integration Server acting as the Enterprise Gateway Server is quiesced, the
servers external and registration ports are disabled, any existing connections to the
Internal Server are disconnected, and any requests made by the Internal Server to the
Enterprise Gateway Server will time out.
In an Enterprise Gateway scenario, you can avoid unnecessary connection aempts
between the two servers by doing one of the following:

webMethods Integration Server Administrators Guide Version 9.10

823

Even Header
Quiescing the Server for Maintenance

Quiesce the Enterprise Gateway Server and the Internal Server at the same time.
Disable the Enterprise Gateway registration port on the server that is not being
put into quiesce mode.
For more information about webMethods Enterprise Gateway, see "Conguring
webMethods Enterprise Gateway " on page 493.

What Tasks Can You Perform in Quiesce Mode?

While Integration Server is in quiesce mode, you can:
Create, modify, and deploy packages.
Change server seings.
Change the state of ports, JMS connection aliases, webMethods messaging
connection aliases, packages, and scheduled user tasks.
Change clustering conguration such as modifying the Terracoa Server Array
URLs.
Install xes and perform other maintenance tasks.
Debug services.

What Happens when Integration Server Exits Quiesce Mode?

When Integration Server exits quiesce mode, the server:
Retains state changes made to any assets during the quiesce session. For example,
if you enabled a package that was disabled before the server entered quiesce mode,
the package remains enabled when the server exits quiesce mode. If you created a
package and then disabled it, the package remains disabled when the server exits
quiesce mode.
Restores the state of any unchanged assets to their state before the server entered
quiesce mode. For example, if a scheduled user task was suspended before the server
was quiesced, the task remains suspended when the server exits quiesce mode.
Resumes the task scheduler.
Resumes clustering activities.
If Integration Server encounters any errors that prevent it from joining the cluster
when exiting quiesce mode, Integration Server does not re-enter quiesce mode.
Instead, Integration Server runs as an unclustered, stand-alone server. Integration
Server logs any errors that occurred while aempting to join the cluster in the report
that appears in Integration Server Administrator after exiting quiesce mode. Use
the report and error logs to help correct the underlying conguration errors. Then,
to rejoin the cluster, either restart Integration Server or enter and then exit quiesce
mode.

webMethods Integration Server Administrators Guide Version 9.10

824

Odd Header
Quiescing the Server for Maintenance

Starts the guaranteed delivery inbound and outbound Job Managers, if you did
not start them while the server was in quiesce mode. The server also sets the wa
property wa.tx.disabled to False and resumes inbound and outbound guaranteed
delivery of documents.

Specifying the Quiesce Port

Before you can start or restart an Integration Server in quiesce mode for the rst time,
you must specify the port through which the server will enter and exit quiesce mode.
This port and the diagnostic port are the only ports that remain enabled when a server
enters quiesce mode. You cannot disable the quiesce port or the diagnostic port when the
server is in quiesce mode.
Note:

The quiesce port must reside in either the WmRoot or the WmPublic package.
The port must also be enabled and have allow or allow+ privilege. If
the quiesce port is not specied, is suspended or disabled, or does not have
allow or allow+ privileges, Integration Server will not be able to enter
quiesce mode.

To specify the quiesce port

1. Open the Integration Server Administrator if it is not already open.
2. In the Settings menu of the Navigation panel, click Quiesce.
3. From the Select New Quiesce Port list, select the port you want Integration Server to
use as the quiesce port.
Note:

This list does not include the diagnostic port or any HTTP/HTTPS
ports created for Internal Servers in a webMethods Enterprise Gateway
conguration.

4. Click Save Changes.

Quiescing Integration Server

You can quiesce Integration Server by starting the server in quiesce mode from the
command prompt, by switching a server from active mode to quiesce mode from
Integration Server Administrator, or by restarting a server in quiesce mode from
Integration Server Administrator.
Additionally, an Integration Server that is a member of a cluster can be congured to
enter quiesce mode if any errors prevent the server from joining the cluster at start up.
To do this, when conguring a cluster, set the Action on Startup Error to Enter Quiesce Mode
on a Stand-AloneIntegration Server. For more information about entering quiesce mode
automatically when Integration Server cannot connect to the cluster at start up, see the
webMethods Integration Server Clustering Guide.

webMethods Integration Server Administrators Guide Version 9.10

825

Even Header
Quiescing the Server for Maintenance

Note:

Before you can start an Integration Server in quiesce mode for the rst time,
you must specify the port through which the server will enter and exit quiesce
mode. For more information, see Specifying the Quiesce Port.

Starting the Server in Quiesce Mode from the Command Prompt

You can start the server in quiesce mode by seing the -quiesce switch in
custom_wrapper.conf. For information about other startup command switches, see
"Starting and Stopping the Server" on page 53.
Note:

If Integration Server is installed as a Windows service, you cannot start the

server in quiesce mode. This is because the command-line parameters were
set when the server was registered as a Windows service. In this case, you
must rst start the server in active mode, and then restart the server in quiesce
mode, from Integration Server Administrator.

To start the server in quiesce mode from the command prompt

1. In a text editor, open the custom_wrapper.conf le from the following directory:
Software AG_directory\proles\IS_instance_name\conguration
where instance_name is the name of the Integration Server instance.
2. Add the following property to custom_wrapper.conf:
wrapper.app.parameter.n=-quiesce

where n is the next unused sequential number for wrapper.app.parameter.n

properties in the le.
3. In the custom_wrapper.conf, update the wrapper.app.parameter.2 property to
reect the total number of wrapper.app.parameter properties that you added in
the previous steps.
For example, if wrapper.app.parameter.2 is set to 4 (the default) and
you add one wrapper.app.parameter property, you would increase the
value of wrapper.app.parameter.2 by one. After making your edits, the
wrapper.app.parameter.2 would appear as follows:
wrapper.app.parameter.2=5

For more information about the wrapper.app.parameter property, see Software AG

Infrastructure Administrator's Guide.
4. At a command prompt, type the following command to switch to the servers home
directory:
cdSoftware AG_directory\profiles\IS_instance_name \bin

Note:

The startup.bat/sh and shutdown.bat/sh scripts contained in the

Integration Server_directory\instances\instance_name\bin directory are
deprecated. Software AG recommends the use of the scripts contained

webMethods Integration Server Administrators Guide Version 9.10

826

Odd Header
Quiescing the Server for Maintenance

in the Software AG_directory\proles\IS_instance_name\bin directory.

If you will manage Integration Server through Command Central,
you must use the scripts located in the Software AG_directory\proles
\IS_instance_name\bin directory.
5. Type the following command to start the server:
For Windows:

startup.bat

For UNIX:

startup.sh

When you open the Integration Server Administrator, a message displays to indicate
that the server is running in quiesce mode.
Note:

If the server cannot disable or suspend an asset or activity as it enters

quiesce mode, the server displays a warning message and continues the
quiesce process. If the condition stated in the warning interferes with a
maintenance task you intend to perform, resolve the issue stated in the
warning and then restart the server in quiesce mode.

Quiescing an Active Server from Integration Server Administrator

You can switch an active Integration Server to quiesce mode using the Integration Server
Administrator.
To quiesce an active server from Integration Server Administrator
1. Open the Integration Server Administrator if it is not already open.
2. In the upper right corner of any Integration Server Administrator screen, click Enter
Quiesce Mode.
Note:

The Enter Quiesce Mode link is available only when Integration Server is in
active mode.

3. When you are prompted to conrm that you want the server to switch to quiesce
mode, do the following:
a. If services are running and you want them to complete before the server starts
disabling packages, specify the number of minutes the server should wait. The
default is 0, which means the server will disable packages immediately.
b. Click OK.
4. If you are running Integration Server Administrator from a port other than the
quiesce port, stop Integration Server Administrator and start it using the quiesce
port.

webMethods Integration Server Administrators Guide Version 9.10

827

Even Header
Quiescing the Server for Maintenance

Integration Server displays a message at the top of all pages in the Integration Server
Administrator indicating that the server is running in quiesce mode.
Note:

If the server cannot disable or suspend an asset or activity as it enters

quiesce mode, the server displays a warning message and continues the
quiesce process. If the condition stated in the warning interferes with a
maintenance task you intend to perform, resolve the issue stated in the
warning and then restart the server in quiesce mode.

Restarting a Server in Quiesce Mode from Integration Server

Administrator
You can restart an active or quiesced Integration Server in quiesce mode from the
Integration Server Administrator.
To restart a server in quiesce mode from Integration Server Administrator
1. Open the Integration Server Administrator if it is not already open.
2. In the upper right corner of any Integration Server Administrator screen, click Shut
Down and Restart.
3. On the Shut Down and Restart screen, select whether you want the server to wait
before restarting or to restart immediately:
After all client sessions end. Specify the number of minutes you want the server to
wait before restarting. The server begins monitoring user activity and automatically
restarts in quiesce mode when all non-administrator sessions complete, or when the
time you specify elapses, whichever comes rst.
Immediately. The server and all active sessions terminate immediately. The server then
restarts in quiesce mode.
4. Click Restart in Quiesce Mode.
5. When you are prompted to conrm that you want to restart the server, click OK.
6. If you are running Integration Server Administrator from a port other than the
quiesce port, stop Integration Server Administrator and start it using the quiesce
port.
Integration Server displays a message at the top of all pages in the Integration Server
Administrator indicating that the server is running in quiesce mode.
Note:

If the server cannot disable or suspend an asset or activity as it enters

quiesce mode, the server displays a warning message and continues the
quiesce process. If the condition stated in the warning interferes with a
maintenance task you intend to perform, resolve the issue stated in the
warning and then restart the server in quiesce mode.

webMethods Integration Server Administrators Guide Version 9.10

828

Odd Header
Quiescing the Server for Maintenance

Exiting Quiesce Mode

When an Integration Server is running in quiesce mode, you can use the Integration
Server Administrator to exit quiesce mode and resume normal operation.
To exit quiesce mode
1. Open the Integration Server Administrator if it is not already open.
2. In the upper right corner of any Integration Server Administrator screen, click Exit
Quiesce Mode.
Note:

The Exit Quiesce Mode link is available only when Integration Server is in
quiesce mode.

3. When you are prompted to conrm that you want the server to exit quiesce mode,
click OK.
After exiting quiesce mode, Integration Server Administrator displays a report that
indicates the state of various operations at the time the server exited quiesce mode.

Deploying Quiesce Mode Configuration

When you specify a quiesce port, Integration Server maintains the port
alias in the quiesce conguration le (quiesce.cnf). This le resides in the
Integration Server_directory\instances\instance_name \cong directory. The quiesce.cnf
le is a deployable asset.
When you use webMethods Deployer to deploy the quiesce.cnf le to another
Integration Server, keep the following points in mind:
The quiesce port you want to deploy must reside in either the WmRoot or the
WmPublic package. Because all other packages are disabled when a server enters
quiesce mode, the target server will not be able to enter quiesce mode if the quiesce
port resides in a package other than WmRoot or WmPublic.
Packages that are installed with Integration Server, such as WmRoot and WmPublic,
are not deployable assets. Deployer identies these packages as unresolved
dependencies when you include the quiesce.cnf le as part of the deployment set.
Click Ignore to bypass dependency checking for this situation.
If no quiesce port is specied on the target server, the target server uses the port
specied in quiesce.cnf. Either ensure that this port exists on the target server or add
the port to the list of deployable assets. The port should be of type HTTP or HTTPS.
You can substitute the quiesce port alias value during the mapping step in Deployer.
For details about deploying assets using Deployer, see webMethods Deployer Users Guide.

webMethods Integration Server Administrators Guide Version 9.10

829

Even Header

webMethods Integration Server Administrators Guide Version 9.10

830

Odd Header
Diagnosing the Integration Server

41 Diagnosing the Integration Server

Introduction .................................................................................................................................

832

Configuring the Diagnostic Port .................................................................................................

832

Using the Diagnostic Utility ........................................................................................................

833

Starting the Integration Server in Safe Mode ............................................................................

836

When the Server Automatically Places You in Safe Mode ........................................................

837

Generating Thread Dumps ........................................................................................................

838

webMethods Integration Server Administrators Guide Version 9.10

831

Even Header
Diagnosing the Integration Server

Introduction
This chapter contains information for the server administrator who troubleshoots the
Integration Server or maintains diagnostic data from the server. Diagnostic data is
the congurational, operational, and logging information from the Integration Server.
This information is useful in situations where the server becomes unresponsive and
unrecoverable.
To facilitate the troubleshooting process, the Integration Server provides the following
features:
Diagnostic port. A special port that uses a dedicated thread pool.
Diagnostic utility. A special service that extracts important diagnostic data from the
Integration Server.
Safe mode switch. A method of starting the Integration Server in which the server does
not connect to any external resource.
Thread dump. A facility to generate a log containing information about currently
running threads and processes within Java Virtual Machine (JVM), to help diagnose
issues with Integration Server.

Configuring the Diagnostic Port

The diagnostic port is a special port that uses threads from a dedicated thread pool to
process requests submied via HTTP. It behaves like a typical HTTP port, except that
the server uses the diagnostic thread pool instead of the server thread pool.
By maintaining a separate thread pool, this port improves the troubleshooting capability
when the server becomes unresponsive. For example, when the server reaches its
maximum number of threads, you cannot open the Integration Server Administrator.
This prevents you from accessing information that might help you determine why the
threads are not available. It also prevents you from freeing up other server resources.
Using the threads from the diagnostic thread pool, the diagnostic port enables you to
open the Integration Server Administrator.
When you install the Integration Server, it automatically creates the diagnostic port at
9999. If another port is running at 9999, the server will disable the diagnostic port when
you start the Integration Server. To enable the diagnostic port, you must edit the port
number. For instructions about how to edit port congurations, see "Editing a Port" on
page 210. Only one diagnostic port can exist on each Integration Server.

Diagnostic Thread Pool Configuration

Through the Integration Server Administrator, you can congure the number of threads
in the diagnostic thread pool. The server adds threads to the pool as needed until it

webMethods Integration Server Administrators Guide Version 9.10

832

Odd Header
Diagnosing the Integration Server

reaches the maximum allowed. If the server reaches the maximum number, it waits until
processes complete and returns threads to the pool before beginning more processes.
You can also set the thread priority for the diagnostic thread pool. The diagnostic
thread priority determines the order of execution when the JVM receives requests from
dierent threads. The larger the number, the higher the priority. When the JVM receives
requests from dierent threads, it will run the thread with the higher priority. Therefore,
by assigning a higher priority to the threads in the diagnostic thread pool, you can take
advantage of the dedicated thread pool and improve access to the Integration Server
Administrator.
For more information about how to congure the diagnostic thread pool, see "Working
with Extended Conguration Seings" on page 130.

Diagnostic Port Access

Only users in the Administrators group can access the server through the
diagnostic port. You can access the Integration Server Administrator via
hp://<hostname> :<diagnostic port> where hostname is the machine that hosts the
Integration Server and diagnostic port is the diagnostic port number. After prompting
you for a username and password, the server displays the Integration Server
Administrator. Because you can access the diagnostic port only through HTTP, data and
passwords will be passed clear=unencrypted.
The diagnostic port allows access only to services dened with the Administrators ACL.
Software AG recommends that you do not change the default access seings.
Note:

Software AG strongly recommends that you discourage any external user

access to the diagnostic port and utility. LDAP users should not access the
diagnostic port.

Using the Diagnostic Utility

You use the diagnostic utility to collect conguration, operation, and logging data from
the Integration Server. You can also use the diagnostic utility to view the list of xes
applied to the installed packages and Integration Server. The diagnostic utility is an
Integration Server service called wm.server.admin:getDiagnosticData. It is accessible
only by members of the Administrators group. Although you run the utility via the
diagnostic port to troubleshoot, it can also be used with any HTTP or HTTPS port
to collect diagnostic data periodically. You can access the service through the Get
Diagnostics buon in Integration Server Administrator.
The diagnostic utility creates a temporary
diagnostics_hostname _port _yyyyMMddHHmmss .zip le in the
Integration Server_directory\instances\instance_name \logs directory and writes to
the .zip le as it collects information. It also contains a cong\PackagesAndUpdates.txt
le, which lists the packages and package updates for the Integration Server.

webMethods Integration Server Administrators Guide Version 9.10

833

Even Header
Diagnosing the Integration Server

If there are problems creating the .zip le, such as insucient space in the le system, it
will return a text le. In the text le, the conguration and operation data are separated
into distinct sections for easier reading. Unlike the .zip le, the text le does not contain
logging data.
The .zip le contains a le in the cong directory called PackagesAndUpdates.txt. This
le lists the packages and package updates for the Integration Server.

Diagnostic Utility Performance

The diagnostic utility can execute slowly when logging large amounts of data from
the Integration Server. To increase performance, you can set limits to the amount
of data the diagnostic tool returns by specifying a maxLogSize value or seing the
wa.server.diagnostic.logperiod parameter.
The maxLogSize parameter of the wm.server.admin:getDiagnosticData service sets
the size limit for log les wrien to the diagnostic_data.zip le. If a log le exceeds the
specied maxLogSize, the diagnostic utility omits it from the .zip le but records it in a
diagnosticwarning.txt le. This le lists all of the log les that exceed the maxLogSize
value. It is located in the logs directory of the .zip le.
Note:

You can use the maxLogSize parameter only when running the diagnostic
utility from a browser. You cannot limit the log size when you run the
diagnostic utility from Integration Server Administrator. For more
information, see "Running the Diagnostic Utility Service" on page 835.

Use the wa.server.diagnostic.logperiod parameter to specify the log period. By

default, it is set to 6 hours. When this property is set to 0, the utility does not return
any log les. It returns only the conguration and run-time data les.The logging
information the utility returns depends on how you store the logs. If you save the logs to
a database, the diagnostic utility will return the exact number of log entries that match
the specied number of hours. If you save the logs to the le system, it will return not
only the period within the specied number of hours but the entire log for that day.
For instructions about how to set server conguration parameters, see "Working with
Extended Conguration Seings" on page 130.

Running the Diagnostic Utility from Integration Server Administrator

Complete the following procedure to run the diagnostic utility from Integration Server
Administrator.
To run the diagnostic utility from Integration Server Administrator
1. Open Integration Server Administrator if it is not already open.
2. Click About in the upper right-hand part of the screen.
3. In the Software area, click Get Diagnostics.
4. You can choose to perform one of the following:

webMethods Integration Server Administrators Guide Version 9.10

834

Odd Header
Diagnosing the Integration Server

a. Open the diagnostic data le.

b. Save the diagnostic data le to the client le system.
c.

Cancel and exit this operation.

Note:

If you save or open the diagnostic data le, it opens or saves the le to
the client system. Integration Server automatically saves a copy to the
Integration Server_directory\instances\instance_name \logs directory of the
host machine where Integration Server is running.

Running the Diagnostic Utility Service

Complete the following procedure to run the diagnostic utility without using Integration
Server Administrator. For example, you would use this method if you wanted to use the
maxLogSize parameter to limit the size of the .zip le.
To run the diagnostic utility without using Integration Server Administrator
1. Start your web browser.
2. Type the following URL:
http://<hostname >:<port >/invoke/wm.server.admin/getDiagnosticData

where <hostname > is the IP address or name of the machine and <port > is the port
number where the Integration Server is running.
Note:

You can limit the byte size of the log les included in the .zip le by
adding the maxLogSize parameter to the URL as follows:
http://<hostname >:<port >/invoke/wm.server.admin/getDiagnosticData?maxLogSize
=number_of_bytes

3. Log on to the Integration Server with a username and password that has
administrator privileges.
4. You can choose to perform one of the following:
a. Open the diagnostic data le.
b. Save the diagnostic data le to the le system.
c.

Cancel and exit this operation.

Note:

If you save or open the diagnostic data le, it opens or saves the le to
the client system. Integration Server automatically saves a copy to the
Integration Server_directory\instances\instance_name \logs directory of the
host machine where Integration Server is running.

webMethods Integration Server Administrators Guide Version 9.10

835

Even Header
Diagnosing the Integration Server

Starting the Integration Server in Safe Mode

If Integration Server is having trouble starting because it or one of its packages cannot
connect to an external resource, you can stop Integration Server and then start it in safe
mode. When you start Integration Server in safe mode, it does not connect to any external
resources, including databases. As a result, when Integration Server is in safe mode, it
writes audit logging data associated with the IS Core Audit and Process Audit functions
to at les on the Integration Server instead of to an external database. In addition, when
in safe mode, Integration Server loads only the WmRoot package; all other packages
are inactive. When you restart Integration Server after you diagnose and correct the
problem, Integration Server resumes audit logging for IS Core Audit and Process Audit
functions to the external database and loads all enabled packages.
Important: Use safe mode for diagnostic or troubleshooting purposes only. Do not run
any regular Integration Server tasks or Designer while in safe mode. It will
return unpredictable results.
If Integration Server could not connect to a Broker or database, check the appropriate
connection parameters and modify them as necessary. For instructions, see the
webMethods Audit Logging Guide.
If a package such as Trading Networks Server or the webMethods SAP Adapter could
not connect to an external resource, open Integration Server Administrator and go to the
Packages > Management > Activate Inactive Packages page. In the Inactive Packages list, select
the package and click Activate Package. Integration Server puts the package into the state
it would have been in if you had started Integration Server normally. For example, if the
package would have been enabled, Integration Server loads and enables it. Check and
modify the connection parameters using the instructions in the appropriate guide.

Starting Integration Server in Safe Mode

To start the Integration Server in safe mode
1. Stop the Java process associated with the Integration Server (for example, in
Windows Task Manager).
2. In a text editor, open the custom_wrapper.conf le from the following directory:
Software AG_directory\proles\IS_instance_name\conguration
where instance_name is the name of the Integration Server instance.
Note:

The startup.bat/sh and shutdown.bat/sh scripts contained in the

Integration Server_directory\instances\instance_name\bin directory are
deprecated. Software AG recommends the use of the scripts contained
in the Software AG_directory\proles\IS_instance_name\bin directory.
If you will manage Integration Server through Command Central,

webMethods Integration Server Administrators Guide Version 9.10

836

Odd Header
Diagnosing the Integration Server

you must use the scripts located in the Software AG_directory\proles

\IS_instance_name\bin directory.
3. Add the following property to custom_wrapper.conf:
wrapper.app.parameter.n=-safeboot

where n is the next unused sequential number for wrapper.app.parameter

properties in the le.
Note:

You can add other switches when you start Integration Server in safe
mode. For information about other switches, see "Starting a Server Instance
from the Command Prompt" on page 55.

4. In the custom_wrapper.conf, update the wrapper.app.parameter.2 property to

reect the total number of wrapper.app.parameter properties that you added in
the previous steps.
For example, if wrapper.app.parameter.2 is set to 4 (the default) and
you add one wrapper.app.parameter property, you would increase the
value of wrapper.app.parameter.2 by one. After making your edits, the
wrapper.app.parameter.2 would appear as follows:
wrapper.app.parameter.2=5

For more information about the wrapper.app.parameter property, see Software AG

Infrastructure Administrator's Guide.
5. At the command prompt, navigate to the following directory.
Software AG_directory\proles\IS_instance_name \bin
6. Enter one of the following commands to start the server.
System

Command

Windows

startup.bat

UNIX

startup.sh

When you open the Integration Server Administrator, it will display a message
indicating that the server is running in safe mode.

When the Server Automatically Places You in Safe Mode

If the Integration Server detects a problem with the master password or outbound
passwords at startup, it will automatically place you in safe mode. You will see the
following message in the upper left corner of the Server Statistics screen of the
Integration Server Administrator:
SERVER IS RUNNING IN SAFE MODE. Master password sanity check failed -- invalid

webMethods Integration Server Administrators Guide Version 9.10

837

Even Header
Diagnosing the Integration Server

master password provided.

These problems can be caused by a corrupted master password le, a corrupted

outbound password le, or by simply mis-typing the master password when you
are prompted for it. If you suspect you have mis-typed the password, shut down the
server and restart it, this time entering the correct password. If this does not correct
the problem, refer to "When Problems Exist with the Master Password or Outbound
Passwords at Startup" on page 480 for instructions.

Generating Thread Dumps

If Integration Server or a subsystem becomes slow or unresponsive, or users are unable
to log into Integration Server, you can generate thread dumps to help you diagnose the
problem. A thread dump can help you locate thread contention issues that can cause
thread blocks or deadlocks.
You can generate thread dumps of the following:
The JVM in which the Integration Server is running
Individual threads running on Integration Server
Based on the information you obtain from these thread dumps, you might be able to
correct the problem.
If you detect a problem with a thread that is associated with a user-wrien Java service
or a ow service, you have the option of canceling or killing the thread.
When you cancel a thread, Integration Server frees up resources that are held by
the thread and returns the thread to the thread pool. If Integration Server cannot
cancel the thread, it gives you the option of killing the thread. When you kill a thread,
Integration Server terminates the thread and adds a new one to the thread pool. For
more information about canceling and killing service threads, see "Canceling and Killing
Threads Associated with a Service" on page 637.
The following example describe how you might use the JVM thread dump and
individual thread dumps to diagnose and x problems.
Scenario 1: A Service Is Running Longer than Expected
1. A Flow service has been running for a very long time. You suspect the service is in
an innite loop, or is waiting for external resources that are not available.
2. You log in through the Integration Server primary port and navigate to the
Statistics > System Threads screen.
3. On the System Threads screen you see threads that are associated with the service
in question. You look at individual dumps of those threads.
4. Using the information provided in the dumps, you determine that the threads are
experiencing contention issues.

webMethods Integration Server Administrators Guide Version 9.10

838

Odd Header
Diagnosing the Integration Server

Scenario 1: A Service Is Running Longer than Expected

5. You cancel the threads. This action allows the service to complete.
Scenario 2: The Server Is Unresponsive, Users Cannot Log In Through the Primary Port
1. Integration Server is unresponsive and no one can log in through the primary
port.
2. You log in through the diagnostic port and navigate to the Statistics > System
Threads screen.
3. On the System Threads screen you see multiple threads for the same service. You
look at individual dumps of those threads.
4. Based on the information provided in the dumps, you try canceling the threads.
The problem persists.
5. You try killing the threads. The problem persists.
6. You perform a JVM dump.
7. Using the information provided in the JVM dump, you determine the cause of the
problem and are able to resolve it.
The following procedures show how to generate dumps for individual threads and for
the JVM.

Generating a Dump of an Individual Thread

To view information about an individual thread
1. Open the Integration Server Administrator if it is not already open.
2. From the Server menu in the Navigation panel, click Statistics.
3. In the System Threads eld, in the Current column, click the number of current
threads.
The System Threads screen displays. This screen contains a list of all the threads that
are currently running on the server.
4. To view a dump of a particular thread, in the Name column for that thread, click the
thread name.
The server displays a dump of that thread.

webMethods Integration Server Administrators Guide Version 9.10

839

Even Header
Diagnosing the Integration Server

Generating a Dump of the JVM

To generate a JVM thread dump
1. Open the Integration Server Administrator if it is not already open.
2. From the Server menu in the Navigation panel, click Statistics.
3. Under Usage, click the Current number of System Threads.
The Server > Statistics > System Threads page is displayed.
The System Threads table lists thread names and displays information about them.
4. Click Generate JVM Thread Dump.
The Server > Statistics > System Threads > Thread Dump page is displayed, showing the
dump.
5. Click Return to System Threads to return to the System Threads page.
6. For information about server recovery when a hardware or software problem forces
you to do a server restart, see "Starting and Stopping the Server" on page 53.

webMethods Integration Server Administrators Guide Version 9.10

840

Odd Header
Integration Server Deployment Checklist

A Integration Server Deployment Checklist

Introduction .................................................................................................................................

842

Stage 1: Installation ...................................................................................................................

842

Stage 2: Basic Configuration .....................................................................................................

843

Stage 3: Setting Up Users, Groups, and ACLs .........................................................................

844

Stage 4: Publishing Packages ...................................................................................................

845

Stage 5: Installing Run-Time Classes ........................................................................................

846

Stage 6: Preparing Clients for Communication with the Server ................................................

847

Stage 7: Setting Up Security .....................................................................................................

847

Stage 8: Startup and Test ..........................................................................................................

849

Stage 9: Archive Sources ..........................................................................................................

850

webMethods Integration Server Administrators Guide Version 9.10

841

Even Header
Integration Server Deployment Checklist

Introduction
This appendix contains a useful checklist for seing up your webMethods Integration
Server. It describes the steps to perform to put an Integration Server into production.
The process is comprised of several stages. You should complete one stage before
advancing to the next.

Stage 1: Installation
Complete the following steps to install, run, and test the Integration Server.
Step

Action

1.

Install the Integration Server.

Done?

For instructions, see Installing Software AG Products.

Note: You can install the Integration Server as either a Windows
application or a Windows service. After installation, if
you want, you can switch from a Windows application
to a Window service, or vice versa. For instructions, see
"Running Integration Server as a Windows Application vs.
a Windows Service" on page 62.
2.

Change default passwords.

Use the Integration Server Administrator to assign new
passwords to the following user accounts:
The "Administrator" user account.
The "Developer" user account.
The "Central" user account.
The "Replicator" user account.
For instructions on how to change passwords, refer to "Adding
an Administrator User" on page 94.
Use the Integration Server Administrator to assign a new master
password for the Integration Server to use when encrypting
outbound passwords before storing them. For instructions on
changing the master password, refer to "Changing the Master
Password" on page 474.

3.

Determine a strategy for outbound passwords and the master password.

webMethods Integration Server Administrators Guide Version 9.10

842

Odd Header
Integration Server Deployment Checklist

Step

Action

Done?

Before you launch and congure your Integration Server the

rst time, determine how you want the Integration Server to
handle the outbound passwords and master password with
respect to where they are stored, how they are encrypted, and
how often they must be changed. If you change these seings
after the Integration Server has been congured, the master
password and outbound passwords can become out of sync.
See "Securing Communications with the Server" on page 401 for
more information.
4.

Determine whether to use a JDK or JRE and specify the Java location.
If you intend to use Designer and/or Developer to develop and
compile Java services on Integration Server, specify the location
of the JDK. If you will not be using this installation of Integration
Server to compile Java services, you can specify the location of a
JRE or a JDK. For information about specifying the Java location,
see "Securing Communications with the Server" on page 401.

Stage 2: Basic Configuration

Use the Integration Server Administrator to congure the way in which the server
will send outbound requests, accept inbound requests, expire sessions, and issue error
messages.
Step

Action

1.

Set up the ports.

Done?

Use the Ports screen to specify the ports on which the server will
listen for requests.
If you will receive HTTP and/or HTTPS requests on multiple
ports, you may want to disable all but one port (the one you will
use to interact with the Integration Server Administrator) until
the server is ready for production.
For instructions on how to set up and disable ports, see "Seing
Up Aliases for Remote Integration Servers" on page 117.
2.

Specify the proxy servers.

Use the Proxy Servers screen to specify the proxy server(s) (if any)
through which this server will issue outbound requests.

webMethods Integration Server Administrators Guide Version 9.10

843

Even Header
Integration Server Deployment Checklist

Step

Action

Done?

Specify which URLs (if any) can bypass the proxy server.
For instructions on how to specify proxy servers and bypass lists,
see "Seing Up Aliases for Remote Integration Servers" on page
117.
3.

Configure session timeouts.

Use the Resources screen to set the timeout value you want the
server to use.
For instructions, see "Managing Server Sessions" on page 112.

4.

Specify the error message recipients and an SMTP server.

Use the Logging screen to specify the e-mail address where you
want the server to send error messages when an exception (a
critical server error or a binding failure) occurs and the name of
the SMTP server to use for this purpose.
For instructions, see "Conguring Where the Integration Server
Writes Logging, Status, and Other Information" on page 129.

5.

Set up logging.
For instructions, see the webMethods Audit Logging Guide and
"Seing Up the Server Log" on page 215.

Stage 3: Setting Up Users, Groups, and ACLs

Use the Integration Server Administrator to identify user accounts, groups, and access
control lists (ACLs) to provide appropriate levels of access to the services that will run
on this server.
Step

Action

1.

Identify service security requirements.

Done?

Services are implicitly blocked from access by anyone other

than Administrators and Developers. Determine what level of
access is required, whether limited to one group of users, all
authenticated users, or even unauthenticated users, and apply
the appropriate ACL to the service.
2.

Create user IDs and groups or configure an external directory.

webMethods Integration Server Administrators Guide Version 9.10

844

Odd Header
Integration Server Deployment Checklist

Step

Action

Done?

If you have secure services, identify users and/or client

applications that are authorized to access those services and
create groups that contain the authorized members.
If your site uses an external directory (LDAP or central user
management), you can congure the server to access the user
and group information from the external directory.
For instructions for creating user IDs, see "Adding User
Accounts" on page 92. For instruction for creating groups, see
"Adding Groups" on page 101. For instructions for using an
external directory, see "Conguring a Central User Directory or
LDAP" on page 559.
3.

Create ACLs.
Create the ACLs needed to meet your services' security
requirements and assign the groups you have created to these
ACLs. For instructions, see "Creating ACLs" on page 440.

4.

Identify backup administrators.

Select one or two users who can act as a backup administrator
when the primary administrator is unavailable. Use the Users and
Groups screen to add these users to the Administrators group.
For instructions on how to grant a user administrator privileges,
see "Adding an Administrator User" on page 94.

Stage 4: Publishing Packages

Install and congure the packages that will run on this server.
Step

Action

1.

Install services on the server.

Done?

Use one of the following methods to publish your services to the

production server:
Method 1. Use the Packages > Publishing screen to replicate the
packages from the development server to the production server.
For instructions, see "Copying Packages from One Server to
Another" on page 600.

webMethods Integration Server Administrators Guide Version 9.10

845

Even Header
Integration Server Deployment Checklist

Step

Action

Done?

Method 2. Use the Integration Server Administrator of the

publishing server to create a zip le containing each package you
want to publish; then:
1. Copy the zip le to following directory on the target server:
Integration Server_directory\instances
\instance_name \replicate\inbound
2. Use the Packages > Management screen to install each package.
2.

Configure the services on the server.

Ensure that each service is enabled. Then, congure the following
operating parameters for each:
ACL assignment
For instructions, see "Assigning ACLs to Folders, Services, and
Other Elements" on page 443.
Caching parameters
For instructions, see webMethods Service Development Help.
Output Template Assignment
For instructions, see webMethods Service Development Help and the
Dynamic Server Pages and Output Templates Developers Guide.

Stage 5: Installing Run-Time Classes

If your services use run-time classes beyond those provided by Java or the Integration
Server (e.g., CORBA or MQ Series classes), install those classes on the server.
Step

Action

1.

Install run-time classes.

Done?

Obtain the zip or jar le from the vendor, and then copy the zip
or jar le to a device or directory that your Integration Server can
access.
2.

Update the classpath.

Update the classpath statement in the wrapper.java.additional
property of the custom_wrapper.conf le so that it points to
the directory in which you have installed the run-time classes.

webMethods Integration Server Administrators Guide Version 9.10

846

Odd Header
Integration Server Deployment Checklist

Step

Action

Done?

For more information, see "Passing Java System Properties to

Integration Server " on page 64.

Stage 6: Preparing Clients for Communication with the

Server
If you have applications (for example, Java or C/C++ programs) that you want to
be Integration Server clients, you must prepare the clients for communication with
Integration Server.
Step

Action

1.

The Integration Server client.jar le contains classes that clients

need to communicate with Integration Server. If you have clients
on the same machine as Integration Server or Designer, set the
classpath on the machine to include the wm-isclient.jar le. The
wm-isclient.jar le is located in the common\lib directory, so set
the classpath to %CLASSPATH%;Software AG_directory\common
\lib\wm-isclient.jar.

2.

If you have clients on machines that do not also host either

Integration Server or Designer, do the following for each machine:

Done?

1. Navigate to the Software AG_directory\common\lib directory

and copy the wm-isclient.jar le to any directory on the client
machine.
2. If you want the client to use SSL to communicate with Integration
Server, navigate to the Software AG_directory\common\lib\ext
directory and copy the enoolkit.jar le to any directory on the
client machine.
3. Set the classpath on the client machine to include the wmisclient.jar le and, if applicable, the enoolkit.jar le. For
example, if you put the wm-isclient.jar le and the enoolkit.jar
le in the c:\myapp directory, you would set the classpath to
%CLASSPATH%;c:\myapp\client.jar;c:\myapp\enoolkit.jar.

Stage 7: Setting Up Security

Take the following steps to ensure that the security measures you want to use are in
place.

webMethods Integration Server Administrators Guide Version 9.10

847

Even Header
Integration Server Deployment Checklist

Step

Action

1.

Check passwords.

Done?

Verify that the passwords for the Administrator and Replicator

accounts and the master password for outbound password
encryption have been changed from the default values assigned by
webMethods Integration Server.
2.

Edit the index.html file to prevent access to Integration Server

Administrator.
If you want to prevent a user from inadvertently accessing the
Integration Server Administrator, edit the following le:
Integration Server_directory\instances\instance_name \packages
\Default\pub\index.html
Change the SRC in the <frame src="/WmRoot/index.dsp"\> tag to
some innocuous page you have created (perhaps one that displays
an error message with alternate links).
You can prevent users from seeing all DSP les on Integration
Server by using the wa.server.displayDirectories server
conguration parameter.
Note that if you edit the index.html le, you will not be able
to invoke the Integration Server Administrator in the standard
way (i.e., simply connecting to the Integration Server's listening
port). Instead, you will need to type the Integration Server
Administrator's complete URL as shown below:
http://Server:Port /WmRoot/index.dsp

where:
Server is the name of the Integration Server, and
Port is the port on which it listens for HTTP requests.
3.

Check user accounts.

Verify that all user accounts have passwords as required.

4.

Check ACL assignments.

Verify that all secure services have correct ACL assignments.

5.

Check proxy server settings.

Verify that proxy server seings and bypass list are correct.

webMethods Integration Server Administrators Guide Version 9.10

848

Odd Header
Integration Server Deployment Checklist

Step

Action

Done?

6.

Restrict access.
Congure allow/deny lists to restrict inbound requests as
necessary.

7.

Install and configure digital certificates.

8.

Configure HTTP routing systems.

If your server sits behind a routing, load-balancing, or URLltering system, consult with the administrator of that system to
ensure that it will pass inbound requests to the Integration Server.

9.

Ensure security of operating system.

The security of your Integration Server depends on the security
of your operating system. Therefore, make sure your operating
system is properly congured, that all security patches have been
applied, and that unnecessary network services, such as telnet or
mail, have been removed.

Stage 8: Startup and Test

Start the server and test services to ensure that they operate as expected.
Step

Action

Done?

1.

Verify that ports are enabled.

If you disabled the ports to prevent access to the server during the
setup phase, use the Ports screen to enable them now.
Tip:

2.

After you enable a port, ping it to verify that it is operational.

Restart the server.

Use the Integration Server Administrator to restart the server to
ensure all seings that you have made are in eect.
For instructions, see "Restarting the Integration Server " on page
67.

3.

Test services.

webMethods Integration Server Administrators Guide Version 9.10

849

Even Header
Integration Server Deployment Checklist

Step

Action

Done?

Perform tests to ensure that user/client applications can access the

server successfully.
Note: During this test you may also want to verify that your
current license will accommodate the expected concurrency
demands on this server. Contact Software AG to increase
number of licensed sessions if necessary.
4.

Go Live!

Stage 9: Archive Sources

Archive a master copy of the packages on the server and the source les that were used
to build them.
Step

Action

1.

Copy the contents of the server\packages directory to another

device for backup and archival purposes.

2.

Archive a copy of all the source les that went into producing the
services deployed on this server.

webMethods Integration Server Administrators Guide Version 9.10

Done?

850

Odd Header
Server Configuration Parameters

B Server Configuration Parameters

Introduction .................................................................................................................................

852

watt.art. .......................................................................................................................................

852

watt.broker. .................................................................................................................................

853

watt.brokerCoder. .......................................................................................................................

853

watt.cachedirective. ....................................................................................................................

854

watt.cds. .....................................................................................................................................

854

watt.config. .................................................................................................................................

855

watt.core. ....................................................................................................................................

855

watt.debug. .................................................................................................................................

860

watt.debug2. ...............................................................................................................................

862

watt.infradc. ................................................................................................................................

862

watt.net. ......................................................................................................................................

863

watt.security. ...............................................................................................................................

874

watt.server. .................................................................................................................................

879

watt.ssl. .......................................................................................................................................

973

watt.ssh. .....................................................................................................................................

974

watt.wm.tnextdc. .........................................................................................................................

975

watt.tx. ........................................................................................................................................

975

watt.xslt. ......................................................................................................................................

976

webMethods Integration Server Administrators Guide Version 9.10

851

Even Header
Server Configuration Parameters

Introduction
This appendix contains a description of the parameters you can specify
in the server conguration le (server.cnf), which is located in the
Integration Server_directory\instances\instance_name \cong directory. Typically you will
use the Settings > Extended screen from the Integration Server Administrator to update
this le, but there might be times when you need to edit the le directly using a text
editor. If you edit the le directly, you should rst shut down the Integration Server
before updating the le. After you make the changes, restart Integration Server.
Note:

If you are using the Settings > Extended screen to update the server
conguration le (server.cnf), server restart is not required unless otherwise
specied.

Integration Server uses default values for many of the parameters. If a parameter has a
default, it is listed with the description of the parameter. Many of these parameters are
set as you administer the Integration Server using the Integration Server Administrator.

watt.art.
watt.art.analysis
Species whether to enable logging to analyze adapter listeners and their linked
notications. When set to true, wm.art.dev.notication:analyzeListenerNotications
service and wm.art.dev.listener:analyzeListenerNodes service will log the data in the
server log le. Service wm.art.dev.listener:updateRegisteredNotications will update the
listener for missing listener notications. When set to false, no analysis is done and no
information is logged. The default is false.
watt.art.connection.nodeVersion
Species whether the adapter connection stores the password in the passman store and
the password handle in the connection node. When the wa.art.connection.nodeVersion
parameter is set to 1, the password is embedded in the adapter connection. When the
parameter is set to 2, the password handle is stored in the adapter connection. The
default is 2. Software AG recommends using the default value. Every time you set a
new value for this parameter, you must restart Integration Server or reload the WmART
package.
When the value of the wa.art.connection.nodeVersion parameter is 2, during runtimebased deployment with Deployer you must perform variable substitution for the
password eld to deploy the password to the target system.
watt.art.page.size
Species the maximum number of items to be displayed on an adapter's Connections
screen, Listeners screen, and Notications screen. The default is 10. For more
information about controlling pagination, see the adapter documentation.

webMethods Integration Server Administrators Guide Version 9.10

852

Odd Header
Server Configuration Parameters

watt.art.synchronousNotification.selectExecuteUser
Species WmArt-based adapters that are to include a Run as User column in the Listener
Notications screen. With this column in place, you can assign a user to a notication.
Then, when the listener notication invokes a service, it runs as the specied user. You
can specify one or more adapters. If you specify multiple adapters, separate the names
with semicolons (;), for example:
wa.art.synchronousNotication.selectExecuteUser=WmMQAdapter;WmSAP
watt.art.service.pipeline.hidden
Species whether the adapter service pipeline is logged in the Integration Server log le.
When the wa.art.service.pipeline.hidden parameter is set to true, the service pipeline
is not logged in the Integration Server log le. When the parameter is set to false, the
service pipeline is logged in the Integration Server log le. The default is false.

watt.broker.
watt.broker.sync.enableBrokerSync
Indicates whether Integration Server synchronizes to the Broker client. If this property is
set to true (the default), then Integration Server synchronizes to the Broker client. If the
value is false, Integration Server does not sync to the Broker client and logs a warning
message indicating that the sync is turned o.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.broker.sync.forceDispatcherInit
Indicates whether Integration Server should reinitialize the Broker conguration. If this
value is set to true, Integration Server reinitializes the Broker conguration. Integration
Server reinitializes from the conguration le if available. If the conguration le is
unavailable, Integration Server reinitializes the Broker conguration with default values.
The default is false.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.

watt.brokerCoder.
watt.brokerCoder.verbose
Indicates whether Integration Server enables verbose logging for BrokerCoder. If the
value is set to true, Integration Server is enabled for BrokerCoder verbose logging. The
default is false.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.

webMethods Integration Server Administrators Guide Version 9.10

853

Even Header
Server Configuration Parameters

watt.cachedirective.
watt.cachedirective.exclude.packages
Species a comma-separated list of packages whose Dynamic Server Pages you want the
browser to cache. You can specify the packages as regular expressions. The asterisk (*)
is the only wildcard character allowed in the regular expression. By default, the value of
this parameter is empty, meaning none of the Dynamic Server Pages in the Integration
Server Administrator are cached.
Note:

Software AG recommends that you use

wa.cachedirective.exclude.packages to cache the Dynamic Server Pages
that are related to custom packages only.

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.

watt.cds.
watt.cds.skip.role.types
Controls whether Integration Server evaluates LDAP or database query roles in the
server. If LDAP or database query roles are not used for any ACL management in
Integration Server with Common Users enabled, evaluation of these roles might impact
Integration Server performance. In this case, you can disable the query roles evaluation
function to increase performance. For more information, see "Considerations for My
webMethods Server Query Roles" on page 563.
To disable LDAP query role evaluation, set

watt.cds.skip.role.types=wm_xt_ldapqueryprovider.

To disable database query role evaluation, set

watt.cds.skip.role.types=wm_xt_dbrole.

To disable both query roles, enter the extended seing twice using both seings above.
For example, enter the following on the Edit Extended Settings page:
watt.cds.skip.role.types=wm_xt_ldapqueryprovider
watt.cds.skip.role.types=wm_xt_dbrole

To re-enable evaluation, delete either or both of the extended seings. If you change
the seing of this parameter, you must restart Integration Server for the changes to take
eect.

webMethods Integration Server Administrators Guide Version 9.10

854

Odd Header
Server Configuration Parameters

watt.config.
watt.config.systemProperties
Species the list of additional system parameters whose name does not start with watt.
Each additional system property is separated by a comma. By default, the property
mail.imap.partialfetch is included as an additional system property with a default
value set to true.

watt.core.
watt.core.brokerTypeCoder.verbose
Enables or disables verbose logging for BrokerTypeCoder. If set to true, Integration
Server enables verbose logging for BrokerTypeCoder. The default is false.
Important: You must restart Integration Server after you modify the value of this
property.
watt.core.brokerCoder.wireFormat
Species the wire type Integration Server uses to encode and decode Broker messages.
The default is 3.
The following table lists the possible seings:
When set to...

Integration Server...

Drops the current reference from the Broker context only if the
tag information is invalid and continues further encoding.

Always drops the current reference from the Broker context

without verifying whether the tag information is valid and then
continues further encoding.

Uses the default values specic to Broker for encoding and

decoding Broker messages.
Note: If set to 2 or 3, Integration Server sets the "is_Surrogate" ag
to true to enhance Broker message encoding. By default, if
the "is_Surrogate" ag is set, Broker uses the BROKER_INT
wire type for encoding and decoding, which is the Broker
default.

Uses current values set in Broker for encoding and decoding

Broker messages.

webMethods Integration Server Administrators Guide Version 9.10

855

Even Header
Server Configuration Parameters

When set to...

Integration Server...
Note: If set to 2 or 3, Integration Server sets the "is_Surrogate" ag
to true to enhance Broker message encoding. By default, if
the "is_Surrogate" ag is set, Broker uses the BROKER_INT
wire type for encoding and decoding.

Important: You must restart Integration Server after you modify the value of this
property.
watt.core.datatype.patternMatcherPool.delayFill
Indicates whether Integration Server should initialize the pool with minimum paern
matcher pool objects specied. If set to false (the default) Integration Server initializes
the pool whenever it parses or validates a schema. If the delayFill is set to true,
Integration Serverdoes not initialize the pool.
Important: You must restart Integration Server after you modify the value of this
property.
watt.core.datatype.patternMatcherPool.maxSize
Species the maximum number of paern matcher pool objects Integration Server
allows in a pool. The default is 50.
watt.core.datatype.usejavaregex
Species whether Integration Server uses the Java regular expression compiler during
validation. When wa.core.datatype.usejavaregex is set to true, during XML validation,
Integration Server uses the Java regular expression compiler and Integration Server
performs paern matching as described by java.util.regex.paern. When set to false,
during XML validation, Integration Server uses the Perl regular expression compiler and
uses paern matching. The default is false.
Note:

The wa.core.datatype.usejavaregex parameter aects XML validation,

including validation performed by the pub.shema:validate service and
validation of web service requests and responses performed by Integration
Server. The wa.core.datatype.usejavaregex parameter also aects schema
validation that Integration Server performs when creating an IS schema
or IS document type from an XML Schema denition or when creating a
web service descriptor from a WSDL document that contains or references
a schema denition.

watt.core.generatedTypeName.namespaceName.authority
Species the namespace element Integration Server uses to create a service URI. Specify
a String value that indicates the hostname. The default is localhost.
watt.core.generatedTypeName.localName.prefix
Species the prex Integration Server uses for a type name. This is appended to the type
name to form a local name. The default is __ (two underscores).

webMethods Integration Server Administrators Guide Version 9.10

856

Odd Header
Server Configuration Parameters

watt.core.schema.createSchema.omitXSDAny
When generating the schema denition in a WSDL, indicates whether Integration Server
omits the xsd:any element in the complex type denition that corresponds to an open
document. A document variable is considered open when the Allow unspecified fields
property is set to true. When wa.core.schema.createSchema.omitXSDAny is set to
true, the xsd:any element is omied from the schema portion of the WSDL document
even if the document variable has the Allow unspecified fields property is set to true.
When wa.core.schema.createSchema.omitXSDAny is set to false, Integration Server
includes the xsd:any element in the complex type denition only if the corresponding
document variable has the Allow unspecified fields property is set to true. The default for
wa.core.schema.createSchema.omitXSDAny is true.
watt.core.schema.generateAllTypeDocuments
When generating an IS document type from an XML schema denition, indicates
whether or not Integration Server generates IS document types for all complex types
regardless of whether the types are referenced or not. When this property is set to true,
Integration Server generates an IS document type for every complex type denition
in the XML schema. When this property is set to false, Integration Server generates a
separate IS document type for a complex type only if the complex type is referenced or is
derived from a referenced complex type. The default is false.
Note:

This parameter is obsolete.

watt.core.generatedTypeName.namespaceName.authority
Used to create a service URI, in the format - 'hp://' authority path '/' service-name,
authority stands for the value specied by this property. String value usually indicating
the hostname.
watt.core.schema.generateSubstitutionGroups
When generating an IS document type from an XML schema denition that contains a
substitution group, indicates whether the resulting document type contains an optional
element for each member of a substitution group. When this property is set to false,
the resulting document type contains a eld that corresponds to the head element in the
substitution group, but does not contain any elements for members of the substitution
group. When this property is set to true, the resulting document type contains a
eld that corresponds to the head element and elds that correspond to each member
element of the substitution group. All the elds, including the head element, are marked
as optional elements. The default is false.
watt.core.schema.validateIncomingXSD
This is an internal property. Do not modify.
watt.core.template.enableFilterHtml
Indicates whether Integration Server HTML encodes the output from a %value
Variable % tag in a DSP or output template. When this property is set to true, the
value of %value Variable % tags, including XML and JavaScript, is HTML encoded.
Having Integration Server HTML encode the values helps prevent cross-site scripting
aacks. When this property is true, you can still indicate that you do not want
Integration Server to HTML encode the output of a %value Variable % tag by including
the encode(none) option (%value Variable encode(none)%). When this property is set to
webMethods Integration Server Administrators Guide Version 9.10

857

Even Header
Server Configuration Parameters

false, the values of %value Variable % tags are not encoded, and, as a result, DSP pages

or pages resulting from output templates might be vulnerable to cross-site scripting

aacks. The default is true.

watt.core.template.enableSecureUrlRedirection
For DSP pages, this parameter controls whether Integration Server performs secure URL
redirection. Internal DSP pages commonly use the variable names url and returnurl
with the %value% tag to indicate to Integration Server that URL redirection can occur
in the client. As a result, whether a DSP page is an internal DSP page or a custom DSP
page, when Integration Server encounters the variable name url or returnurl for a
%value% tag, it assumes that the value is meant for URL redirection.
When the wa.core.template.enableSecureUrlRedirection parameter is set to true,
Integration Server uses secure URL redirection. When performing secure URL
redirection, if the %value% tag uses the variable name url or returnurl, Integration
Server checks the URL to determine whether it is a relative path to a location within
Integration Server (e.g., ..\redirectedurl.dsp) or another value. If it is a relative path,
Integration Server considers a redirection to the URL to be safe, and as a result, takes no
action. However, for other values, Integration Server assumes the URL to be an external
URL (e.g., hp://example.com) and alters the output, even if the intent of the %value%
tag is not to redirect to the URL. Integration Server alters the URL so that if an aempt is
made to redirect to the external URL, the redirection goes to an error page. Integration
Server alters the URL by prepending the value error.dsp?data= to the output of the
%value% tag (e.g., error.dsp?data=hp://example.com).
Seing this parameter to false disables secure URL redirection and, as a result, might
put your applications at risk.
You should use the variable url or returnurl with the %value% tag only when you
want to redirect to an internal URL. If you have existing applications that use the
variable name url or returnurl, Software AG recommends that you update your
applications and do not use these variable names except for internal URL redirection.
If you do not want to change the variable names in existing applications, you can set
wa.core.template.enableSecureUrlRedirection parameter to false.

The default seing for the wa.core.template.enableSecureUrlRedirection parameter is

true.
watt.core.validation.multipleroot
Species whether the pub.schema:validate service is to validate multiple roots
when processing multi-part documents. When this property is set to true, the
pub.schema:validate service checks for multiple root nodes. If multiple root nodes are
found, the service ags a validation error. When this property is set to false, the
pub.schema:validate service does not perform multiple root validations. The default is true.
watt.core.validation.skipMandatoryFields
Species whether Integration Server generates errors during document
validation if mandatory elds are missing from the document. When
wa.core.validation.skipMandatoryFields is set to true, Integration Server does not
generate validation errors during document validation even if required elds are
missing from the document. When this parameter is set to false, Integration Server
generates validation errors if required elds are missing from the document. The default

webMethods Integration Server Administrators Guide Version 9.10

858

Odd Header
Server Configuration Parameters

is false. This parameter aects document validation performed by the pub.schema:validate

service and SOAP request and SOAP response validation.
watt.core.validation.skipNoNamespaceReference
Indicates whether or not Integration Server skips validation of references to elements
that are not namespace qualied made from within a namespace qualied element
during XML validation against a schema. Set to true if you want Integration Server to
skip validation of these referenced elements. Set to false if you want Integration Server
to validate these referenced elements. The default is false.
watt.core.validation.w3cConformant
Indicates whether Integration Server evaluates instances of data types for illegal values
during XML validation according to the W3C recommendation XML Schema Part 2:
Datatypes. If you want Integration Server to validate data types consistent with the W3C
recommendation, set wa.core.validation.w3cConformant to true. The default is false.
watt.core.xml.allowedExternalEntities
Identies a list of trusted external entities (le URIs, HTTP URLs, and so on) that contain
XML content to transform in an XML or XSLT le. Use a comma to separate each entity.
The pub.xslt.Transformations:transformSerialXML service loads the content for any entity in this
list that is referenced either in the XML that the service receives or in the XSLT stylesheet
the service uses to transform the XML. The service reads this list in the following
situations:
The services loadExternalEntities input parameter is set to false.
The services loadExternalEntities input parameter is not specied in the service
signature, and the wa.core.xml.expandGeneralEntities server parameter is set to
false.
watt.core.xml.expandGeneralEntities
Indicates whether the pub.xml:loadXMLNode and pub.xml:xmlStringToXMLNode services should
return expanded general (internal and external) entities. Also indicates whether the
pub.xslt.Transformations:transformSerialXML service should allow external entities. When
this parameter is set to true, the loadXMLNode and xmlStringToXMLNode services expand
references to general entities, and the transformSerialXML service allows external entities.
When this parameter is set to false, the loadXMLNode and xmlStringToXMLNode services
ignore references to general entities, and the transformSerialXML service blocks external
entities. The default is true.
Note:

This parameter applies to all instances of loadXMLNode, xmlStringToXMLNode,

and any XSLT services. However, if the expandGeneralEntities input
parameter is specied for the loadXMLNode or xmlStringToXMLNode
service, or if the loadExternalEntities parameter is specied for the
transformSerialXML service, the service-level seing takes precedence over
wa.core.xml.expandGeneralEntities.

watt.core.xsd.useGeneratedURIForCreateXSD
Indicates whether, while creating the XSD, Integration Server should use the nodes
path for the URI and the namespace name for the node and schema. If set to true,
Integration Server generates the URI based on the node's path. This URI is then used
webMethods Integration Server Administrators Guide Version 9.10

859

Even Header
Server Configuration Parameters

as the namespace name for the particular node or schema. If set to false (the default),
Integration Server sets the namespace to null.
watt.core.xsd.useGeneratedURIForNonRPC
Species whether Integration Server should use the URI generated for the message as
the namespace name for the WSDL message. If set to true (the default), Integration
Server uses the URI generated for the message as the namespace name for the WSDL
message only if the style is non-RPC. If set to false, Integration Server sets the
namespace to null.

watt.debug.
watt.debug.layout
Species the format of messages wrien to the server's log le and to the Logs > Server
screen. You can specify one of the following formats:
new

Messages will be in the following format:

(Component ) [ComponentID .00SubComponentID .SubComponentID .MessageKey ]
TimeStamp MessageType MessageText
(IS.SERVER) [ISS.0025.25.6] 2007-07-31 10:45:27 EDT INFO: License Manager
started
legacy

This format corresponds to the message format used in Integration Server prior
to version 7.1. Use this format if you need to maintain backward compatibility
with the previous message format. For example, you might have wrien code to
process messages wrien to the server log.
When you select legacy as the message layout, messages will appear in the
following format:
TimeStamp [ComponentID .00SubComponentID .MessageKeyMessageType ]
MessageText
2007-07-31 10:39:59 EDT [ISS.0025.0006I] License Manager started
This is the default.
watt.debug.level
Sets level of debugging information wrien to the server's log le and the Logs > Server
screen. The default is Info.
Specify...

To display...

No messages.

webMethods Integration Server Administrators Guide Version 9.10

860

Odd Header
Server Configuration Parameters

Specify...

To display...

Fatal

Fatal messages only.

Error

Error and fatal messages.

Warn

Warning, error, and fatal messages.

Info

Informational, warning, error, and fatal messages. This is the default.

Debug

Debug, informational, warning, error, and fatal messages.

Trace

Trace, debug, informational, warning, error, and fatal messages.

Note:

You can also set the value of the wa.debug.level property by seing the
logging level for the Default facility on the Settings > Logging > View Server
Logger Details screen. For more information about conguring logging, see
"Specifying Amount and Type of Information to Include in the Server Log"
on page 217.

Prior to Integration Server 7.1, Integration Server used a number-based system to set
the level of debug information wrien to the server log. Integration Server maintains
backward compatibility with this system. The table below describes the number-based
system.
Specify...

To record...

Critical messages only.

Error and critical messages.

Warning, error, and critical messages.

3, 4

Informational, warning, error, and critical messages.

5, 6, 7

Debug, informational, warning, error, and critical messages. This is the

default.

8, 9, 10

Trace, debug, informational, warning, error, and critical messages.

The server records more levels of informational messages the higher
you set the number.

webMethods Integration Server Administrators Guide Version 9.10

861

Even Header
Server Configuration Parameters

watt.debug.logfile
Species the fully qualied path to the directory that contains the server log le. The
default is the Integration Server_directory\instances\instance_name \logs directory. For
complete information, see "Changing the Default Server Log Location" on page 220.
watt.debug.warnOnClasspathError
Species whether or not a warning message about a missing classpath entry will be
wrien to standard out. Set this parameter to true to write the message "Classpath entry
in ini.cnf not found: <classpath_entry_name >" to standard out. Set this parameter to false
if you do not want the message wrien. The default is false.
Because this message will be generated before any of the Integration Server logging
facilities are initialized, the warning message is wrien to standard out.

This conguration parameter does not appear in Extended Seings or in the server.cnf.
To have Integration Server write these warnings, you must pass this property to
Integration Server as a command line option. Add a line to Software AG_directory/
proles/IS_instance/conguration/custom_wrapper.conf, for example:
wrapper.java.additional.NNN =-Dwatt.debug.warnOnClasspathError=true

Where NNN is the next available wrapper.java.additional number.

watt.debug2.
watt.debug2.facList
Species a comma-delimited list of enabled facilities for which the server logs
information. The facilities are numbered. The default is 999, which indicates the server
is to log information for all facilities. Specify 1000 to prohibit the server from logging
information for any service.
To view the names of facilities, use the Log Settings screen of the Integration Server
Administrator to enable and disable facilities for which you want the server to log
information
watt.debug2.logstringfile
Species the name (without the extension .txt) for the dictionary le that contains error
codes and facilities. The default is lib\logstr (English Version).

watt.infradc.
watt.infradc.artmonitor
This is an internal parameter. Do not modify.
watt.infradc.artpollinterval
This is an internal parameter. Do not modify.

webMethods Integration Server Administrators Guide Version 9.10

862

Odd Header
Server Configuration Parameters

watt.net.
watt.net.clientKeepaliveTimeout
Controls how long (in seconds) a client keep alive connection can remain idle before
Integration Server closes it. The default is 180 seconds (3 minutes).
watt.net.defaultBufferSize
Species the maximum content length of an HTTP request that the WmTomcat
package will process. If the content length of a request exceeds the size congured
with wa.net.defaultBuerSize, the WmTomcat package does not process the request
and issues an error message. Specify the maximum number of bytes that you want the
WmTomcat package to accept. The default is 8096 bytes. Do not set this parameter to an
excessively high value because for every HTTP request, the WmTomcat package creates
an array of the wa.net.defaultBuerSize in memory.
watt.net.email.validateHost
Controls whether the Integration Server enforces IP access restrictions for e-mail
listeners. When dening an e-mail port, you can dene IP access restrictions that specify
the hosts that are allowed or denied access via the e-mail port. Set this property to true
if you want server to enforce the IP access restrictions for e-mail listeners or false if you
do not. The default is true.
watt.net.encodeToUpperCase
Species whether Integration Server should use uppercase leers when encoding
the characters in the request URL. When Integration Server processes a URL request,
it converts the characters outside of the ASCII set in the URL to encoded characters
by adding "%" followed by two hexadecimal digits. If this parameter is set to true,
Integration Server uses uppercase leers in the hexadecimal digits. For example, the
encoded value for "value1>4" will be "value1%3E4". When set to false, Integration
Server does not convert the leers to uppercase. For example, the encoded value for
"value1>4" will be "value1%3e4". Default is true.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.net.ftp.ignoreErrors
Species, using a comma-separated list, any FTP command error codes that you want
the FTP client to ignore. For example, seing the property to "501, 505" causes the FTP
client to ignore error codes 501 and 505.
watt.net.ftp.noExtensionKey
Species the extension Integration Server should use to determine the MIME type of
the input les when the les have no extension. When invoking an Integration Server
service through FTP commands, Integration Server uses the specied extension. The
default is ftp_no_extension, which means that Integration Server cannot determine
the MIME type because there is no extension.

webMethods Integration Server Administrators Guide Version 9.10

863

Even Header
Server Configuration Parameters

watt.net.ftpClientDataConnTimeout
Species the number of milliseconds that a built-in FTP service executing in active
mode (as specied by the transfertype input parameter) waits for a remote FTP server
to connect to it. If the connection is not established in the specied amount of time, an
exception is thrown. The default value is 30000 milliseconds (30 seconds).
watt.net.ftpClientTimeout
Species the length of time, measured in seconds, an FTP session can be idle before it is
removed from memory. The default is 600 seconds (10 minutes).
watt.net.ftpConnTimeout
Species the maximum number of milliseconds the FTP listener allows the connection
with the client to remain inactive. The default is 15 minutes.
watt.net.ftpDataConn
Species whether an Integration Server functioning as an FTP server allows multiple
concurrent connections and supports parallel downloads. When this parameter is set to
true, Integration Server allows parallel downloads from multiple FTP sessions. When
this parameter is set to false, Integration Server does not allow parallel downloads and
will reuse the same FTP session. The default is false.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.net.ftpDataConnTimeout
Species the maximum number of milliseconds the FTP listener waits between
successive reads when performing a le upload. The default is 60000 milliseconds (60
seconds).
watt.net.ftpPassiveLocalAddr
Species the address to be sent by the PORT command. A host name or IP address can
be specied.
Note:

This parameter is not applicable when an FTP/FTPS port is bound to an

IPv6 address. In that case, the passive mode listen address is the same as
the port bind address.

When running in passive mode, the FTP or FTPS port sends a PORT command to the
FTP or FTPS client. The PORT command species the address and port to which the
client should connect to create a data connection. If the FTP or FTPS port is behind a
NAT server, however, the address of the host on which the Integration Server runs is not
visible to the FTP or FTPS client. Consequently the PORT command does not contain the
information the client needs to connect to the server. To remedy this situation, you can
specify a value for the wa.net.ftpPassiveLocalAddr property.
Alternatively, when you congure an FTP or FTPS port (see "Adding an FTP Port"
on page 187 or "Adding an FTPS Port" on page 183), you can use the Passive Mode
Listen Address eld to specify the passive mode address for an individual FTP or
FTPS port. That way, you can specify a dierent passive mode address for each
FTP port. If an address is specied in the Passive Mode Listen Address eld and in the

webMethods Integration Server Administrators Guide Version 9.10

864

Odd Header
Server Configuration Parameters

wa.net.ftpPassiveLocalAddr property, the PORT command uses the value specied in

the wa.net.ftpPassiveLocalAddr property.
watt.net.ftpPassivePort.max
Species the maximum port number of a port range for FTP/FTPS listeners to use with
a client data connection that uses passive transfer mode (PASV). Must be used with
wa.ftpPassivePort.min. For usage information, see wa.ftpPassivePort.min.
watt.net.ftpPassivePort.min
Species the minimum port number of a port range for FTP/FTPS listeners to use with
a client data connection that uses passive transfer mode (PASV). Must be used with
wa.ftpPassivePort.max. When a port range is specied with these properties, only the
ports within the specied minimum and maximum port range (inclusive) are used as the
listening ports for incoming FTP/FTPS client data connections. This enables a rewall
administrator to open only the specied ports.
Operational considerations:
If both properties are not present or undened, FTP/FTPS listeners continue the
previous behavior of listening on any free port.
If the value specied for wa.net.ftpPassivePort.min is less than 1, a default
value of 1 is used. If the value specied for wa.net.ftpPassivePort.max is greater
than 65534, a default value of 65534 is used. When both of these conditions exist
simultaneously, FTP/FTPS listeners continue the previous behavior of listening
on any free port.
An error message is returned to the FTP/FTPS client on the command channel
when the specied values do not fall within the expected range. For example, if
one of the properties is not dened, if the wa.net.ftpPassivePort.min value is
larger than the wa.net.ftpPassivePort.max value, or if one of the properties is
not a valid number.
An error message is also returned when all the ports in the specied port range
are in use.
Specic details of the error messages are available in the serverYYYYMMDD.log
le.
Restarting the Integration Server is not required after dening these seings. You can
modify the port range properties in the Integration Server Administrator at any time.
watt.net.ftpSweepInterval
Species the frequency, measured in seconds, at which an FTP sweeper executes. The
FTP sweeper iterates through the FTP sessions in memory and removes the sessions that
have exceeded their alloed idle timeout. By default, the FTP sweeper executes every
600 seconds (10 minutes).
watt.net.ftpUseCertMap
Species whether the Integration Server will honor certicate maps for requests received
by FTPS ports.

webMethods Integration Server Administrators Guide Version 9.10

865

Even Header
Server Configuration Parameters

When this property is set to false (the default), the Integration Server ignores the user
specied on a client certicate and logs the user in with the information provided on the
userid/password prompt instead.
When this property is set to true, if the client certicate has been previously mapped
to an Integration Server user, the Integration Server will log the user in as the userid
specied in the client certicate. The Integration Server ignores the userid provided on
the userid/password prompt.
For example, suppose wa.net.ftpUseCertMap is set to false, and a certicate has been
previously mapped to user Alice. When a user provides a certicate for user Alice
and enters Alice's user name and password in response to the prompt, the Integration
Server will log the user in as Alice. However, if the user provides the same certicate,
but provides Bob's user name and password in response to the prompt, the Integration
Server will log the user in as Bob. In other words, the Integration Server ignores the
certicate map.
Note:

The None, Request Certificate, and Require Certificate client authentication

seings on the FTPS Listener Conguration screen control whether the
Integration Server asks for a certicate and how the Integration Server
behaves when it does not receive one. The wa.net.ftpUseCertMap
property controls how the Integration Server behaves when it does
receive a certicate from an FTP client. For more information about client
authentication at FTPS and HTTPS ports, see "Client Certicates" on page
450. For more information about certicate mapping, see "Importing a
Certicate (Client or CA Signing Certicate) and Mapping It to a User" on
page 452.

watt.net.ftpUseDefaultContentHdlr
Species how the FTP listening port on Integration Server should handle an incoming
request with an unrecognized le extension. When set to true, the FTP listening port
processes the incoming request using the default content handler, which treats the
content as text/html. When set to false, the FTP listening port returns an exception
when an incoming request with an unrecognized le extension is received. The default is
true.
watt.net.httpChunkSize
Sets the default chunk size when sending an HTTP request or response using TransferEncoding:Chunked. The default chunk size is 8192 bytes. The minimum chunk size is
500 bytes.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.net.httpPass
The default HTTP password that Integration Server must use when invoking a service as
a client.
watt.net.httpUser
Species the default authenticated HTTP user name that Integration Server will use
while acting as a client to invoke a service. For example, if Integration Server is invoking
webMethods Integration Server Administrators Guide Version 9.10

866

Odd Header
Server Configuration Parameters

the pub.client:http service without specifying the auth /user parameter, then Integration
Server uses the value of this property as the user name. There is no default value.
watt.net.http401.throwException
Species whether the pub.client:http service throws a NetException when receiving
a 401 error response or, instead, places the HTTP response header and body in
the pipeline. When wa.net.hp401.throwException is set to true, when the
pub.client:http service receives a 401 error, the service throws a NetException. When
wa.net.hp401.throwException is set to false, when the pub.client:http service receives a
401 error, the service suppresses the NetException and places the HTTP response header
and body, if one exists, into the header and body elds in the service output. The default
is false.
watt.net.http501-599.throwException
Species whether the pub.client:http service throws a ServiceException or returns response
headers and response body when receiving a 501 to 599 level response from a remote
HTTP server. When set to true, the pub.client:http service throws a ServiceException when
it receives a 501 to 599 level response from a remote HTTP server. When set to false, the
pub.client:http service does not throw a ServiceException when it receives a 501 to 599 level
response from a remote HTTP server. Instead, when the pub.client:http service returns a
status code in the 501 to 599 range, the service returns the status code, response headers,
and response body in the service output. The default is true.
Note:

When the remote HTTP server returns a response code of 500, the
pub.client:http service returns the status code, response headers, and
response body.

watt.net.jsse.client.enabledCipherSuiteList
Species, using a comma-separated list, the cipher suites used on JSSE sockets that
are used while making outbound HTTPS requests. To include all the cipher suites
supported by the JVM, set this parameter to default.
For example:

watt.net.jsse.client.enabledCipherSuiteList=
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_256_
CBC_SHA384,TLS_RSA_WITH_AES_256_CBC_SHA256
watt.net.jsse.client.enabledCipherSuiteList=default

The default values is default.

Note:

Any changes you make to wa.net.jsse.client.enabledCipherSuiteList aect

new connections only.

watt.net.jsse.client.enabledProtocols
Species the SSL protocol versions that Integration Server supports when acting as a
client making outbound requests. Specify a comma-separated list that includes one or
more of the following:
SSLv2Hello

webMethods Integration Server Administrators Guide Version 9.10

867

Even Header
Server Configuration Parameters

SSLv3
TLSv1
TLSv1.1
TLSv1.2

The default value is: TLSv1,TLSv1.1,TLSv1.2

Note:

The value of wa.net.jsse.client.enabledProtocols aects all HTTPS

outbound connections that use JSSE for SSL. An outbound HTTPS
connection uses JSSE when the useJSSE parameter for pub.client:http is set to
yes.

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.net.jsse.server.enabledCipherSuiteList
Species, using a comma-separated list, the cipher suites used on Integration Server
ports that use JSSE and handle inbound requests.
To include all the cipher suites supported by the JVM, set this parameter to default.
For example:

watt.net.jsse.server.enabledCipherSuiteList=
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_
256_CBC_SHA384,TLS_RSA_WITH_AES_256_CBC_SHA256
watt.net.jsse.server.enabledCipherSuiteList=default

The default value is default.

Important: For changes to this property to take eect, you must start the port. If the
port is already started, you can restart it by disabling the port and then
enabling it.
watt.net.jsse.server.enabledProtocols
Species the SSL protocol versions that Integration Server supports when acting as a
server handling inbound requests. Specify a comma-separated list that includes one or
more of the following:
SSLv2Hello
SSLv3
TLSv1
TLSv1.1
TLSv1.2

The default value is: SSLv2Hello,TLSv1,TLSv1.1,TLSv1.2

webMethods Integration Server Administrators Guide Version 9.10

868

Odd Header
Server Configuration Parameters

Note:

These values are case-sensitive. Specify the values exactly as shown. The
value of wa.net.jsse.server.enabledProtocols aects all HTTPS ports that
use JSSE for SSL. An HTTPS port uses JSSE when the Use JSSE parameter
for the port is set to Yes.

You can also congure the allowed protocols for use with a particular JSSE port by
specifying the allowed protocols in the HTTPS port record of the listeners.cnf le. For
more information, see "Conguring the Allowed Protocols for JSSE per Port" on page
213.
Note:

The jsseEnabledProtocols value specied for the port

record in the listeners.cnf le overrides the value set by
wa.net.jsse.server.enabledProtocols.

watt.net.localhost
Sets the host name of the machine from which you are using the Integration Server.
There is no default.
In some instances, such as when the Integration Server needs to identify itself to
other Integration Servers, the IP address of the machine hosting Integration Server
is required. In this case, Integration Server performs a reverse DNS lookup on the
specied host name and supplies the IP address of the machine in place of the
loopback address (127.0.0.1 in IPv4 or ::1 in IPv6), which is sometimes returned by
java.net.InetAddress.getLocalHost() in place of the actual IP address. In many cases, the
loopback address is not sucient and Integration Server needs the actual address. This
most commonly occurs when the IP address of the host is acquired dynamically from a
DHCP server, or when the host has more than one network interface card.
In most cases, you can resolve the IP address by modifying the C:\Windows
\system32\drivers\etc le (in Windows) or the etc/hosts or the etc/nsswitch.conf les
(in Linux and Unix). When you cannot modify these les, or if modifying them does not
correct the problem, set wa.net.localhost.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.net.maxClientKeepaliveConns
Sets the default number of client keep alive connections to retain for a given target
endpoint. If not specied, ve keep alive connections are retained.
watt.net.maxRedirects
Species the maximum number of HTTP redirects to allow before throwing an I/O
exception. The default is 5.
watt.net.maxRetires
Species the maximum number of retry aempts Integration Server can make for a
failed socket connection. The default is 1. A value of 0 indicates that Integration Server
should not retry a failed socket connection.

webMethods Integration Server Administrators Guide Version 9.10

869

Even Header
Server Configuration Parameters

watt.net.overrideSystemProxyselector
Species whether the proxy selector of Integration Server will override the default JVM
system proxy selector when a Java service tries to connect to a remote server. When this
property is set to true, all network connections will honor the proxy aliases congured
using Integration Server Administrator. When this property is set to false, the default
JVM system proxy selector will be used. The default is false.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.net.primaryListener
This is an internal property. Do not modify.
watt.net.proxySkipList
Species a comma-separated list of domain names for which the Integration Server
should not use proxy servers. The default is localhost.
watt.net.proxy.fallbackToDirectConnection
Species whether Integration Server should route HTTP, HTTPS, FTP, SFTP, and
SOCKS requests directly to the target server when connections through all of the
specied proxy server aliases for the requested protocol fail. For example, if the request
uses HTTP, Integration Server routes the request through an HTTP proxy server alias.
If this property is set to false and the connection to the destination server through
proxy aliases fails, Integration Server issues an exception. If this property is set to true,
Integration Server aempts to make a direct connection with the destination server
specied in the request. The default is true.
Note:

If there are no proxy server aliases dened for Integration Server, the value
of wa.net.proxy.fallbackToDirectConnection is ignored. For information
about proxy server aliases, see "Specifying a Default Proxy Server Alias" on
page 127.

watt.net.proxy.useNonDefaultProxies
Species whether Integration Server makes outbound connection requests
using all enabled proxy server aliases if the outbound request does not specify
a proxy server alias and if a default proxy server alias is not specied. When the
wa.net.proxy.useNonDefaultProxies parameter is set to true, if the outbound
request does not specify a proxy server alias and there is no default proxy server
alias, Integration Server makes outbound requests using each enabled proxy
server alias until the request is sent successfully or all proxy servers have been
tried. If all proxy servers have been tried and the aempt to send the request fails
or if there are no proxy aliases specied, Integration Server either makes a direct
connection to the target server or throws an exception depending on the seings
specied for the wa.net.proxy.fallbackToDirectConnection parameter. When the
wa.net.proxy.useNonDefaultProxies parameter is set to false, if a default proxy server
alias is not specied, Integration Server sends the request to the remote server using a
direct connection. Integration Server does not aempt to make outbound requests using
the enabled proxy server aliases. The default is true.

webMethods Integration Server Administrators Guide Version 9.10

870

Odd Header
Server Configuration Parameters

For more information about how Integration Server uses proxy servers, see "How
Integration Server Uses Proxy Servers" on page 121.
watt.net.retries
Species the number of times to retry a server that times out. This can be overridden by
the client. The default is 0.
watt.net.sftpSweepInterval
Species the frequency, measured in minutes, at which an SFTP sweeper executes. The
SFTP sweeper iterates through the SFTP sessions in memory and removes the sessions
that have exceeded their alloed idle timeout. By default, the SFTP sweeper executes
every 10 minutes.
watt.net.socketpool.sweeperInterval
Species the frequency, in seconds, at which the socket pool sweeper executes. The
socket pool sweeper sends a ping request to all webMethods Enterprise Gateway
connections and HTTP client connections. During a sweep it removes any invalid HTTP
client connections. By default, the sweeper executes every 60 seconds.
Note:

The value of wa.net.socketpool.sweeperInterval should be less than

the value of the wa.server.rg.internalregistration.timeout server
conguration parameter.

Note:

On your Enterprise Gateway, if wa.server.rg.gateway.pinginterval

is set, Integration Server uses that seing and ignores the value of
wa.net.socketpool.sweeperInterval.

watt.net.socketProvider
Identies the Java class that implements the com.wm.net.SocketProviderIf interface for
secure socket communication. The default is com.wm.ext.iaik.IaikSecureSocket.
watt.net.ssl.client.cipherSuiteList
Species a list of CipherSuites for outbound SSL connections. When the default value
is set to default, Integration Server uses its default list of cipher suites. If you want to
specify non-default cipher suites, enter a comma-separated list of CipherSuite names. If
the property wa.net.ssl.client.strongcipheronly is set to true, and if there are any nonstrong CipherSuites in the list specied, those will be ignored, and a warning message
will be logged.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.net.ssl.client.handshake.maxVersion
Species the maximum SSL protocol version that Integration Server supports when
Integration Server acts as a client and makes an outbound request. For example, if set
to tls (the default), the maximum version of SSL protocol supported by Integration
Server is TLS 1.0. If set to sslv3, the maximum version of SSL protocol supported by
Integration Server is SSL 3.0.

webMethods Integration Server Administrators Guide Version 9.10

871

Even Header
Server Configuration Parameters

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.net.ssl.client.handshake.minVersion
Species the minimum version of SSL protocol Integration Server supports when
Integration Server acts as a client and makes an outbound request. Set to:
sslv2 (the default) to specify SSL 2.0
tls to specify TLS 1.0
sslv3 to specify SSL 3.0

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.net.ssl.client.hostnameverification
When Integration Server is acting as an HTTPS client, this parameter species whether
Integration Server should restrict outbound HTTPS connections only when a valid
hostname is found in the servers certicate.
When set to true, Integration Server veries if the hostname is present in the
servers certicate. If this verication fails, an error is logged and the connection
is aborted.
When set to false, Integration Server will bypass the hostname verication. This
is the default.
When set to log, Integration Server logs the debug message in the server log if
the hostname verication fails, but allows the connection to go through. If the
hostname verication succeeds, no log is generated.
watt.net.ssl.client.strongcipheronly
Species whether the Integration Server is to restrict outbound HTTPS connections
to use strong cipher suites only (128 bit session keys or higher). If you specify false
(the default), when Integration Server initiates a connection to another server, it will
aempt to negotiate a strong cipher suite, and if unsuccessful will fall back to using a
weak (64, 56, or 40 bit) cipher suite. If you specify true, when Integration Server initiates
a connection to another server, it will aempt to negotiate a strong cipher suite, and if
unsuccessful will disconnect rather than use a weak cipher suite.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.net.ssl.client.useJSSE
Controls the use of JSSE for all of the outbound HTTPS connections from Integration
Server. Set this parameter to true to use JSSE for all of the outbound HTTPS
connections. Set this property to false to indicate that JSSE is not used for outbound
HTTPS connections. The default is false.

webMethods Integration Server Administrators Guide Version 9.10

872

Odd Header
Server Configuration Parameters

Note:

When executing the pub.client:http service, the value of the useJSSE input
parameter override the value of the wa.net.ssl.client.useJSSE server
conguration property.

watt.net.ssl.server.cipherSuiteList
Species a list of CipherSuites for inbound SSL connections. When the default value
is set to default, Integration Server uses its default list of cipher suites. If you want to
specify non-default cipher suites, enter a comma-separated list of CipherSuite names.
If the property wa.net.ssl.server.strongcipheronly is set to true, and if there are any
non-strong CipherSuites in the list, those will be ignored and a warning message will be
logged.
Important: If you change the seing of this parameter, you must restart any
impacted ports for the changes to take eect. To restart a port, you can
disable and then enable the port. Reloading the package associated with
the port or restarting Integration Server also restarts a port.
watt.net.ssl.randomAlgorithm
Identies the random algorithm name used by Integration Server. The default value is
FIPS186_2usingSHA1.
Note:

This parameter is for use only when Integration Server is installed on HPUX.

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.net.ssl.server.clientHandshakeTimeout
Species the number of milliseconds the server waits for a response from the client
during an SSL handshake before timing out. The default is 20000 milliseconds.
watt.net.ssl.server.strongcipheronly
Species whether the Integration Server is to restrict inbound HTTPS connections to
use strong cipher suites only (128 bit session keys or higher). If you specify false (the
default), when a client connects to the Integration Server, the server will aempt to
negotiate a strong cipher suite, and if unsuccessful will fall back to using a weak (64,
56, or 40 bit) cipher suite. If you specify true, when a client connects to the Integration
Server, the server will aempt to negotiate a strong cipher suite, and if unsuccessful will
disconnect rather than use a weak cipher suite.
Important: If you change the seing of this parameter, you must restart any
impacted ports for the changes to take eect. To restart a port, you can
disable and then enable the port. Reloading the package associated with
the port or restarting Integration Server also restarts a port.

webMethods Integration Server Administrators Guide Version 9.10

873

Even Header
Server Configuration Parameters

watt.net.timeout
Species the number of seconds the server waits for an HTTP request to be fullled
before the request times out. To set Integration Server to wait indenitely for a response
from the target server, set this parameter to 0. The default is 300 (5 minutes).
Important: If you set wa.net.timeout to 0 and the target server does not respond
to the request, the Integration Server making the request cannot process
new requests due to thread pool exhaustion.
watt.net.useCookies
Species whether Integration Server accepts or denies cookies when communicating
with web server. Set to true to accept cookies; set to false (or null) to deny cookies. The
default is true.
watt.net.userAgent
Species the value the server uses in the HTTP User Agent request header when
it requests a web document from a web server. The default is Mozilla/4.0 [en]
(WinNT; I).
watt.net.webapp.cookies.useRelevantPath
Species how WmTomcat can create fewer cookies to prevent the web application from
logging out because of exceeding the browser cookie limit.
When this property is set to true, WmTomcat returns cookies that contain the URI
prex in the pathname, and more cookies are created. By default, WmTomcat returns
cookies that contain a URI prex in the pathname. As a result, WmTomcat creates a
separate cookie for each unique path. For applications that include pages across many
dierent paths, the result can be many cookies. If the application exceeds the cookie
limit of the browser that invoked it, the application is forced to log out.
But when this property is set to false (the default), WmTomcat does not include the
URI prex in the cookie, and fewer cookies are created.
For example, when wa.net.webapp.cookies.useRelevantPath is set to false, and you
visit the WmTomcat sites site/a.jsp -> site/bar/b.jsp -> site/bar/baz/c.jsp,
WmTomcat creates just one cookie: cookie 1) name=ssnid, path=/.
But when this property is set to true, WmTomcat creates the following cookies:
cookie 1) name=ssnid, path=/site/
cookie 2) name=ssnid, path=/site/bar/
cookie 3) name=ssnid, path=/site/bar/baz

The default is false.

watt.security.
watt.security.cert.wmChainVerifier.enforceExtensionsChecks
Species whether Integration Server is to validate (true) or not validate (false)
certicate extensions, if any, when the server performs certicate verication. The
default is false.

webMethods Integration Server Administrators Guide Version 9.10

874

Odd Header
Server Configuration Parameters

watt.security.cert.wmChainVerifier.trustByDefault
In cases where no directory or a directory containing no certicates is specied for the
Trusted Certicates directory, species whether the server is to trust:
Certicates presented by peer servers (in response to this server's outbound
request)
S/MIME signatures
Species whether the server is to trust (true) or not trust (false) certicates and
S/MIME signatures in this situation. The default is true. For improved security,
Software AG recommends that you set this parameter to false and specify a Trusted
Certicates directory.
watt.security.decrypt.keyAlias
Species the alias of the default private key Integration Server uses for decryption.
watt.security.decrypt.keyStoreAlias
Species the alias of the keystore containing the default private key Integration Server
uses for decryption.
watt.security.fips.mode
Species whether the server is to support FIPS (Federal Information Processing
Standards). The default is false. If this parameter is set to true, the server initializes
FIPS as part of server startup. If FIPS initialization fails, the error is logged to server.log
and the server shuts down.
watt.security.KeystoreAndTruststore.defaultAliasCreated
This is an internal parameter. Do not modify.
watt.security.keyStore.supportedTypes
Species the keystore types supported by Integration Server. Each supported type is
separated by a comma. The default values are JKS and PKCS12.
To specify additional keystore types for Integration Server, you need to do the following:
1. Add the new keystore type to the list of values for this property.
2. Add the keystore provider, using one of the following methods:
a. Using the "Add Security Provider" link in Integration Server Administrator.
b. Modifying the "java.security" le of the JVM (you must use this method for a
PKCS11-type keystore).
Note:

Software AG does not guarantee the behavior of additional keystore

types, and does not provide support for them.

watt.security.ope.AllowInternalPasswordAccess
Species whether the built-in services supporting OPE (outbound password encryption)
for ow services may access the Integration Server's internal passwords. If this
parameter is set to true, the OPE services may access the internal passwords. If it is set
to false, the OPE services are not allowed access to the internal passwords. By default,
this parameter is set to false.
webMethods Integration Server Administrators Guide Version 9.10

875

Even Header
Server Configuration Parameters

Internal passwords are passwords for use by the Integration Server itself to access secure
resources (e.g., remote Integration Servers, JDBC connection pools, LDAP servers,
etc.). Internal passwords are managed using the Integration Server Administrator and
are stored in the outbound password store. Flow services are also allowed to store
passwords in the outbound password store. However, by default, passwords stored by
a ow service are considered public, as opposed to internal. This distinction allows
ow services to use the outbound password store as a secure mechanism for storing and
retrieving passwords, but protects the Integration Server's internal passwords.
You can allow ow services to access internal passwords (i.e., store, retrieve, and
modify) by seing wa.security.ope.AllowInternalPasswordAccess to true. However,
this should be done only if you explicitly wish to have a ow service work with internal
passwords. Otherwise, it is recommended you deny access to internal passwords by
seing wa.security.ope.AllowInternalPasswordAccess to false.
watt.security.openid.logExceptions
Species whether Integration Server writes OpenID errors to the error log. When
the OpenID authentication process encounters errors, Integration Server returns
error and error_description variables in the body of the HTTP response. When
wa.security.openid.logExceptions is true, the default, Integration Server throws an
exception from the redirection endpoint service, causing the error to be wrien to the
error log. To stop Integration Server from writing OpenID errors to the error log, set
wa.security.openid.logExceptions to false.
watt.security.pub.getFile.checkReadAllowed
Species whether the pub.file:getFile service is to check the allowedReadPaths property in
the leAccessControl.cnf le to determine if the requested le can be retrieved from the
le system. The allowedReadPaths property contains a list of directories to which the
services in the pub.le folder have read permission.
When wa.security.pub.getFile.checkReadAllowed is set to true, the pub.file:getFile
service checks the allowedReadPaths property in the leAccessControl.cnf le. If the
requested le or le directory is listed, the pub.file:getFile service returns its contents to the
pipeline.
If wa.security.pub.getFile.checkReadAllowed is set to true and the le or le directory
is not listed in the allowedReadPaths property, the pub.file:getFile service throws an
exception.
When wa.security.pub.getFile.checkReadAllowed is set to false, the pub.file:getFile
service retrieves the specied le from the local le system without checking the
leAccessControl.cnf le.
Changes to this property take eect immediately. However, if you modify the
leAccessControl.cnf le, the WmPublic package must be reloaded before the changes
take eect.
For more information about the pub.file:getFile service and conguring the
leAccessControl.cnf le, see webMethods Integration Server Built-In Services Reference.
watt.security.session.forceReauthOnExpiration
Species whether Integration Server accepts or rejects a request that includes an expired
or invalid session. When set to true, Integration Server rejects any request that includes

webMethods Integration Server Administrators Guide Version 9.10

876

Odd Header
Server Configuration Parameters

a cookie identifying an expired or invalid session, even if the request includes valid user
credentials. The rejection response directs the browser to clear its session identier and
to prompt the user for credentials. When set to false, Integration Server creates a new
session using the credentials in the cookie. The default value is false. A value of true
oers more secure behavior.
watt.security.sign.keyAlias
Species the alias of the default private key Integration Server uses to digitally sign
documents.
watt.security.sign.keyStoreAlias
Species the alias of the keystore containing the default private key Integration Server
uses to digitally sign documents.
watt.security.ssl.cacheClientSessions
Controls whether Integration Server reuses previous SSL session information (for
example, client certicates) for connections to the same client. When this property is set
to true, Integration Server caches and reuses SSL session information. For example, set
this property to true when there are repeated HTTPS requests from the same client. If
set to false (the default), Integration Server does not cache the sessions and creates a
new session for every SSL handshake.
Note:

Seing the property to false might decrease performance.

watt.security.ssl.cachedClientSessions.sweeperInterval
Species, in milliseconds, how often Integration Server checks for and removes expired
SSL client sessions from its session cache. The default value is 600000 milliseconds (10
minutes).
watt.security.ssl.client.ignoreEmptyAuthoritiesList
Species whether an Integration Server client will send its CA certicate when it receives
an empty list of trusted authorities from the SSL server. If set to true, the Integration
Server client accepts empty trusted authorities lists from the SSL server and returns its
CA certicate. If set to false, the client requires that the trusted authorities list contains
a trusted authority before sending its CA certicate. The default is false.
watt.security.ssl.ignoreExpiredChains
Species whether the Integration Server ignores expired CA certicates in a certicate
chain it receives from an Internet resource (i.e., a web server, another Integration Server).
To have the Integration Server ignore expired CA certicates and allow SSL connections
when a certicate is expired, set the watt.security.ssl.ignoreExpiredChains
seing to true. Note that this is less secure than denying connections when a certicate
is expired. The default is false. For more information about this seing, see "
Integration Server as an SSL Server" on page 403.
watt.security.ssl.keyAlias
Species the alias of the Integration Server default SSL private key.
watt.security.ssl.keypurposeverification
When Integration Server is acting as an HTTPS client, this parameter species whether
the server should restrict outbound HTTPS connections only when a valid Extended

webMethods Integration Server Administrators Guide Version 9.10

877

Even Header
Server Configuration Parameters

Key Purpose eld is present in the server's certicate. The content of the Key Purpose
eld, id-kp-serverAuth, should be in the IETF-mandated format, TLS WWW server
authentication for the verication to pass. Refer to the section titled Extended
Key Usage, in the document hp://www.ietf.org/rfc/rfc3280.txt for more information
regarding this format.
Three values are allowed for this wa property - true, false and log.
When set to true, it will verify the presence of the key purpose eld in the
server's certicate. If the key purpose verication fails, an error is logged and the
connection is aborted. If the verication succeeds, no error is logged.
When set to false, it will bypass the verication of the key purpose eld. The
default is false.
When set to log, it will log a debug message in the server log if the key purpose
eld verication fails.wa.security.ssl.keyStoreAlias Species the alias of the
Integration Server default SSL keystore.
watt.security.ssl.keyStoreAlias
Species the alias of the Integration Server default SSL keystore.
watt.security.trustStoreAlias
Species the alias for the truststore that Integration Server uses as the default truststore.
When Integration Server is acting as a server, it uses the default truststore to verify
the trust relation when no truststore is provided. For example, Integration Server uses
the default truststore when no truststore is provided for HTTPS/FTPS ports or for web
service security when there is no truststore at the provider web service endpoints alias.
When Integration Server is acting as a client, most of the components in Integration
Serverr (for example, HTTPS, FTPS, remote server alias) always use the default
truststore to verity the trust relation with the server. However, for web service security,
Integration Server only uses the default truststore when the user does not provide a
truststore in the consumer endpoint alias.
watt.security.trustStore.supportedTypes
Species the truststore types supported by Integration Server. Each supported type is
separated by a comma. The default value is JKS.
To specify additional truststore types for Integration Server, you need to do the
following:
1. Add the new truststore type to the list of values for this property.
2. Add the truststore provider, using one of the following methods:
a. Using the "Add Security Provider" link in Integration Server Administrator.
b. Modifying the "java.security" le of the JVM.
Note:

Software AG does not guarantee the behavior of additional

truststore types, and does not provide support for them.

webMethods Integration Server Administrators Guide Version 9.10

878

Odd Header
Server Configuration Parameters

watt.server.
watt.server
This is an internal parameter. Do not modify.
watt.server.acl.groupScanInterval
Species how often, in milliseconds, Integration Server checks for the availability of
the My webMethods Server database, if the database is unavailable at Integration
Server startup. While the database is unavailable, group information about users that
are managed by Central User Management is unavailable. As a result, users in those
groups do not have the access rights granted by their associated ACLs. While the My
webMethods Server database is unavailable, the Security > Access Control List screen
displays the aected groups with the sux @--@, for example FinanceGroup@--@.
When the My webMethods Server database becomes available, the groups regain their
access rights and Integration Server removes the @--@ sux. The default seing is 10,000
milliseconds (10 seconds).
watt.server.allowDirective
Restricts the use of specied directives to specied ports. For information on directives,
see "Controlling the Use of Directives" on page 433). The syntax for this property is:
port-string is a comma-delimited list of port numbers such as "5555,6666".
Suppose you want to allow all ports to use the default directive, but you want specic
ports to use the other directives, as described below:
Restrict use of the invoke directive to ports 5555 and 7777
Restrict use of the web directive to ports 6666 and 7777
Restrict use of the SOAP directive to port 7777
To obtain the behavior described above, you would specify the following:
watt.server.allowDirective=invoke,5555,7777,web,6666,7777,soap,7777

watt.server.audit.dbEncoding
Species the character set used by the audit logging database. The default is
UTF-8. The value for this property must be a standard Internet Assigned Numbers
Authority (IANA)-assigned character set name, as dened in the IANA Character Sets
specication.
Important: If you change the value of this property, you must restart Integration
Server for the change to take eect.
watt.server.audit.displayLogs.convertTime
Species how dates are displayed when you view the service, error, session, guaranteed
delivery, and security logs from the Integration Server Administrator. When this
property is set to false, time stamps are shown as GMT/UTC. When this property is set
to true (the default), time stamps are shown in the local time zone of the Integration
Server, and in the format specied by wa.server.dateStampFmt.

webMethods Integration Server Administrators Guide Version 9.10

879

Even Header
Server Configuration Parameters

watt.server.auditDocIdField
Species a custom document ID value to identify documents in a standard way and to
provide uniform business context in the logging display. Some documents are logged
by webMethods Broker through WmLogUtil to the document database, and some are
logged by various components within the Integration Server, for example, if a service
fails, or if the number of retries in a trigger are exceeded. As a result, when viewing
the Document Monitor, some documents are logged with a numeric document ID, and
some are logged with lengthy hexadecimal strings as the document ID. The custom
document ID value that you specify will be used to create the document logging ID.
This value is used in place of the BrokerEvent.getEventId() value (the original document
ID behavior). The value must be in the form of a Broker unicode string, and values in
excess of 128 characters will be truncated. If this extended seing is missing, the original
document ID behavior applies. If this extended seing is present but undened (null),
the _env.uuid value is used if present; if no _env.uuid value is dened, the original
document ID behavior applies. For more information about document logging, see
Administering webMethods Broker.
watt.server.audit.failFastLoggers
Species the loggers that can enter into fail-fast mode when fail-fast mode is enabled for
the ISCoreAudit functional alias.
If wa.server.audit.failFastLoggers is empty, all synchronous audit loggers that
use a database destination will have fail-fast capability.
If wa.server.audit.failFastLoggers is not empty, only the synchronous audit
loggers with a database destination listed in wa.server.audit.failFastLoggers
will have fail-fast capability.
Note:

Fail-fast mode is enabled for the ISCoreAudit functional alias when the
Fail-Fast Mode Enabled option is set to Yes for the alias.

If you want to identify the specic audit loggers that can enter fail-fast mode, use the
wa.server.audit.failFastLoggers to specify a comma-separated list of the loggers that
can enter into fail-fast mode. For example, if you want the Service Logger and Session
Logger to be able to enter into fail-fast mode, set the property as follows:
watt.server.audit.failFastLoggers=Service Logger,Session Logger

You must specify the word "Logger" as part of the logger name. The property is casesensitive. You must specify the logger name as it appears on the Settings > Logging page
of Integration Server Administrator. Do not include a space before or after the comma
that separates logger names.
Only synchronous loggers can enter fail-fast mode. Integration Server ignores any
asynchronous loggers specied in the wa.server.audit.failFastLoggers property.
The default for wa.server.audit.failFastLoggers is empty. That is, the default is that all
synchronous audit loggers that use a database destination will have fail-fast capability
when the ISCoreAudit functional species Yes for the Fail-Fast Mode Enabled option.
watt.server.audit.logDir
Species the directory that contains the audit log les. You can specify the
full-path name, or a relative path in relation to the Integration Server. The

webMethods Integration Server Administrators Guide Version 9.10

880

Odd Header
Server Configuration Parameters

directory must exist on the server. The default value is logs, which indicates the
Integration Server_directory\instances\instance_name \logs directory. If an invalid value is
specied, Integration Server uses the default value and writes an error to the server log
during startup.
Important: If you change the value of this property, you must restart Integration
Server for the change to take eect.
Note that wa.server.audit.logDir does not aect audit loggers that write to a database.
watt.server.audit.schemaName
Species the name of the database schema that Integration Server should use
while requesting metadata for the audit logging database. There is no default. If
wa.server.audit.schemaName is not set, Integration Server does not retrieve database
metadata and assumes the lengths of the WMSERVICECUSTOMFLDS.STRINGVALUE
and WMSERVICEACTIVITYLOG.FULLMESSAGE columns are 512 and 1024,
respectively.
Note:

Some databases are case-sensitive. When specifying the value for

wa.server.audit.schemaName, you should match the case of the schema
name with the schema name required by the database.

Note:

If you change the value of this property, you must restart Integration
Server for the changes to take eect.

watt.server.audit.um.sessionPool.min
Species the minimum number of sessions in the Universal Messaging session
pool. Integration Server maintains a separate session pool for each Universal
Messaging connection alias used by an audit logger. The value of this parameter
must be an integer value greater than 0 and less than or equal to the value of
wa.server.audit.um.sessionPool.max. The default value is 2.
If you specify an invalid value, Integration Server logs a warning message at start up
and then uses the default value at runtime. However, Integration Server does not persist
the default value over the invalid value you specied.
Note:

If you change the value of this property, you must restart Integration
Server for the changes to take eect.

watt.server.audit.um.sessionPool.max
Species the maximum number of sessions in the Universal Messaging session pool.
Integration Server maintains a separate session pool for Universal Messaging connection
alias used by an audit logger. The value of this parameter must be an integer greater
than 0 and greater than or equal to the value of wa.server.audit.um.sessionPool.min.
The default value is 10.
If you specify an invalid value, Integration Server logs a warning message at start up
and then uses the default value at runtime. However, Integration Server does not persist
the default value over the invalid value you specied.

webMethods Integration Server Administrators Guide Version 9.10

881

Even Header
Server Configuration Parameters

Note:

If you change the value of this property, you must restart Integration
Server for the changes to take eect.

watt.server.audit.um.sessionPool.retryInterval
Species the number of seconds for Integration Server to wait between aempts to reestablish a session on the Universal Messaging server after an audit logger enters queue
fail-fast mode. An audit logger enters queue fail-fast mode when it cannot establish a
connection to the Universal Messaging server that contains the audit logging queue.
Specify an integer greater than 0 (zero). The default is 30 seconds.
If you specify an invalid value, Integration Server uses the default value at runtime.
However, Integration Server does not persist the default value over the invalid value
you specied.
Note:

If you change the value of this property, you must restart Integration
Server for the changes to take eect.

watt.server.auth.cache.capacity
Species the number of user name and password combinations Integration Server stores
in the authentication cache. The default value is 250.
watt.server.auth.cache.enabled
Species whether the authentication cache is enabled. When set to true, the
authentication cache is enabled. The default value is true.
watt.server.auth.cache.timeout
Species the number of milliseconds that each cache entry can remain idle before
Integration Server removes it from the authentication cache. The default is 300000 (5
minutes).
Note:

Entries removed from the authentication cache are added again the next
time the credentials are authenticated successfully.

Note:

Once a user has changed the password and logged in successfully with
the new password, Integration Server removes the old password from the
authentication cache.

watt.server.auth.checkWithSession
When Integration Server receives an HTTP request that includes both an Authorization
header and a Cookie header with a session identier, this parameter species whether
Integration Server should check that the user identied in the Authorization header is
the owner of the session identied in the Cookie header. When set to true (the default),
Integration Server conrms that the user of the Authorization header is the owner of the
identied in the Cookie header. If the headers do not match, Integration Server returns
an HTTP 401 status code with the following message:
The user identied in the request does not own the requested session.
Important: If you set wa.server.auth.checkWithSession to false,Integration
Server allows HTTP requests to use mismatched credentials to access

webMethods Integration Server Administrators Guide Version 9.10

882

Odd Header
Server Configuration Parameters

the services on Integration Server and, as a result, might put your

applications at risk.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.auth.oauth.accessToken.useHeaderFields
Species whether Integration Server performs OAuth authentication when an inbound
HTTP/S request includes an access_token in the header elds. Specify true to perform
OAuth authentication. Specify false to skip OAuth authentication. The default is true.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.auth.oauth.accessToken.useQueryParameters
Species whether Integration Server performs OAuth authentication when an inbound
HTTP/S request includes an access_token in the query parameter. Specify true to
perform OAuth authentication. Specify false to skip OAuth authentication. The default
is true.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.auth.samlResolver
Species the URL to the SAML artifact resolver endpoint on the My webMethods Server
that will be used to validate My webMethods Server users on Integration Server. Along
with conguring central user management, the value of this property allows single-sign
on for My webMethods Server users. For more information, see "Conguring the MWS
Single Sign-On Resource Seing" on page 459.
Note:

Integration Server adds this property to the sever.cnf le when you specify
a value for the MWS SAML Resolver URL eld on the Settings > Resources
page of Integration Server Administrator. Software AG recommends that
you use the MWS SAML Resolver URL eld to specify the My webMethods
Server SAML artifact resolver endpoint instead of changing the value of
the wa.server.auth.samlResolver property.

watt.server.auth.session.retainJaasSubject
Species whether Integration Server should retain authentication credentials as part of
a session. When set to true, Integration Server retains the authentication credentials
until the session expires. If set to false (the default), Integration Server deletes the
authentication credentials from the session after it handles the initial request from the
client.
watt.server.auth.skipForMediator
Species whether Integration Server validates requests from Mediator to the native
service. When this parameter is set to true, Integration Server skips authentication for
Mediator requests. When set to false (the default) Integration Server authenticates all
Mediator requests.

webMethods Integration Server Administrators Guide Version 9.10

883

Even Header
Server Configuration Parameters

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.broker.producer.multiclient
Species the number of sessions for the default client. The default client is the Broker
client that the Integration Server uses to publish documents to the Broker and to retrieve
documents delivered to the default client. When you set this parameter to a value
greater than 1, the Integration Server creates a new multi-session, shared state Broker
client named clientPrex _DefaultClient_MultiPub, to use for publishing documents
to the Broker. Using a publishing client with multiple sessions can lead to increased
performance because it allows multiple threads to publish documents concurrently. The
default is 1 session.
watt.server.broker.replyConsumer.fetchSize
Species the number of reply documents that the Integration Server retrieves from the
Broker at one time. Increasing the reply documents the Integration Server retrieves for
each call can reduce the number of calls the Integration Server makes to the Broker.
The Integration Server maintains all reply documents in memory. You can reduce the
amount of memory used for reply documents by decreasing the number of documents
the Integration Server retrieves at one time. The default is 5 documents.
watt.server.broker.replyConsumer.multiclient
Species the number of sessions for the request/reply client. The request/reply client
is the Broker client that the Integration Server uses to send request documents to the
Broker and to retrieve reply documents from the Broker. Increasing the number of
sessions for the request/reply client can lead to improved performance because it allows
multiple requests and replies to be sent and retrieved concurrently. The default is 1
session.
watt.server.broker.replyConsumer.sweeperInterval
Species how often (in milliseconds) the Integration Server sweeps its internal mailbox
to remove expired replies to published requests. The length of the interval should
balance the amount of memory consumed by expired replies with retrieving the replies
for waiting requests. The Integration Server uses one background thread to age and
remove expired replies and uses multiple background threads to retrieve replies for
waiting requests. When the sweeper thread removes expired replies, it blocks the
threads aempting to retrieve replies. When then sweeper interval is too low, the
frequent execution of the sweeper thread can degrade performance because other
background threads cannot retrieve replies as often. A sweeper interval that is too high
can cause an increase in memory usage because expired replies consume memory for a
longer period of time. The default is 30000 milliseconds (30 seconds).
watt.server.brokerTransport.dur
Species the number of seconds of idle time that the Broker waits before sending a
keep-alive message to Integration Server. If Integration Server does not respond within
the amount of time specied by the wa.server.brokerTransport.max property, the
Broker sends another keep-alive message to Integration Server. If Integration Server
continues to be unresponsive, the Broker continues sending keep-alive messages until it
reaches the retry limit specied by the watt.server.brokerTransport.ret property.
If the Integration Server still has not responded to the keep-alive message, the Broker
webMethods Integration Server Administrators Guide Version 9.10

884

Odd Header
Server Configuration Parameters

explicitly disconnects the Integration Server. The wa.server.brokerTransport.dur value

must be an integer greater than or equal to zero but less than 2147483647. The default is
60 seconds.
For more information about using server parameters to congure the keep-alive seing
with the Broker, see "Seing Server Conguration Parameters for Keep-Alive Mode" on
page 256.
watt.server.brokerTransport.max
Species the number of seconds that the Broker waits for the Integration Server
to respond to a keep-alive message. This value must be an integer between 0 and
2147483647. The default is 60 seconds.
For more information about using server parameters to congure the keep-alive seing
with the Broker, see "Seing Server Conguration Parameters for Keep-Alive Mode" on
page 256.
watt.server.brokerTransport.ret
Species the number of times the Broker re-sends keep-alive messages before
disconnecting an un-responsive Integration Server. This value must be an integer
between 1 and 2147483647. The default is 3 retries.
watt.server.cache.prefetchUser
Species the user authorized to prefetch cache service entries. The default is
Administrator.
watt.server.cgi.cache
Species whether the output pipeline should display all the elements in a response
when using CGI content handlers to format the responses. When this property is set
to false, the output pipeline displays all the elements in the response. When this
property is set to true, if the response contains multiple non-string, non-null elements
with the same value, the output pipeline will display only the rst occurrence of the
value. For each of the subsequent occurrences, the output will contain the string,
*ObjectRef(className)*. The default is false.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.cgi.unicode
Species whether the CGI content handler should use Unicode encoding. When this
property is set to false, the CGI content handler will use the encoding specied by
the wa.server.netencoding property to encode responses. When this property is set
to true, the CGI content handler will use Unicode to encode responses. The default is
false.
watt.server.cache.flushMins
Species how often (in minutes) the server sweeps the cache to remove expired cache
entries and to prefetch cache service entries. The default is 10 minutes.
Note:

This conguration parameter applies to the service-results caching feature.

It does not aect the caching capabilities provided by Ehcache.

webMethods Integration Server Administrators Guide Version 9.10

885

Even Header
Server Configuration Parameters

watt.server.cache.gcMins
Species how often (in minutes) the server sweeps the cache to perform garbage
collection. The default is 60 minutes.
Note:

This conguration parameter applies to the service-results caching feature.

It does not aect the caching capabilities provided by Ehcache.

watt.server.cacheManager.connectTimeout
Species the number of milliseconds a cache manager will wait while trying to connect
to a server specied in the Terracoa Server Array URLs list. The default is 60000
milliseconds (i.e. 60 seconds).
Note:

Regardless of the wa.server.cacheManager.connectTimeout value, a cache

manager will wait for a maximum of 300 seconds to connect to a server in
the Terracoa Server Array. For example, if this property is set to 60000,
the cache manager will wait for 60000 milliseconds to connect to any of
the available server. If a connection is not established to any of the servers
in 60000 milliseconds, an exception is thrown and then Integration Server
takes the action specied by the wa.server.cluster.action.errorOnStartup
parameter.

watt.server.cachemanager.logsDirectory
Species the location where Ehcache will write log les. The default value of this folder
is Integration Server_directory\instances\instance_name \logs\tc-client-logs
watt.server.cachemanager.parallelThreads
Species the maximum number of threads that you want Integration Server to use when
initializing cache managers at startup.
If the server contains a large number of cache managers, distributed cache managers, or
a cache manager with a large number of caches, the registration process at start up could
take a long time. To avoid this, you can increase the number of threads used to initialize
cache managers by seing the wa.server.cachemanager.parallel.threads property.
If you want Integration Server to initialize cache managers sequentially, set the value to
1. If you want Integration Server to initialize cache managers in parallel, set the value to
2 or higher. Software AG recommends that you do not exceed 10. The default value is 5.
watt.server.centralUsers.shutdownOnError
Species whether the Central Users component shuts down when it encounters an error.
When this property is set to true, the Central User component shuts down when it
encounters an error. When the Central Users component shuts down, the Integration
Server must be restarted. When this property is set to false, the default, the Central
User component does not shut down when it encounters an error.
watt.server.checkAclsInternally
Species whether Integration Server performs ACL checking when a service is directly
invoked by a client or trigger and when it is invoked from other services. When set to
true, Integration Server always checks the Execute ACL for a service, regardless of the
value of the Enforce Execute ACL property for the service. When set to false, the value

webMethods Integration Server Administrators Guide Version 9.10

886

Odd Header
Server Configuration Parameters

of the Enforce Execute ACL property determines whether or not Integration Server
performs ACL checking when a service executes. The default is false.
watt.server.classloader.pkgpriority
Species the order in which Integration Server scans packages when loading a class le
for which no package information is available. When no order is specied, Integration
Server aempts to load the class by scanning all packages in the Packages directory, one
by one. This could delay class loading. For example, when a trigger contains a reference
to a Java class, the trigger does not have any package information. Integration Server
scans all the packages for the specic class le in random order. Specifying the packages
that Integration Server should scan rst may reduce the time needed for class loading.
Use the wa.server.classloader.pkgpriority property to specify a comma delimited list of
the packages whose class loader should load rst. The syntax for this property is:
watt.server.classloader.pkgpriority=packageName, packageName

For more information about class loading, refer to "How the Server Loads Java Classes"
on page 40.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.clientTimeout
Species the amount of time (in minutes) after which an idle user session times out. The
default is 10.
watt.server.cluster.action.errorOnStartup
Species how Integration Server responds when an error at start up prevents Integration
Server from joining the cluster. Select one of the following:
Value

Description

shutdown

If Integration Server encounters any errors that prevent it

from joining the cluster at start up, Integration Server shuts
down immediately. To make any changes to the clustering
conguration, you must start Integration Server in safe mode,
then edit the conguration, and then restart Integration Server.
shutdown corresponds to the Action on Startup Error parameter

option Shut DownIntegration Server on the Settings > Clustering > Edit
screen.
standalone

If Integration Server encounters any errors that prevent it

from joining the cluster at start up, Integration Server starts
as a stand-alone, unclustered Integration Server. Integration
Server continues to receive requests on inbound ports and serve
requests. Integration Server does not use any distributed caches
and instead uses local caches. You can use Integration Server
to make changes needed to resolve the startup errors. When
you restart Integration Server, Integration Server will rejoin the

webMethods Integration Server Administrators Guide Version 9.10

887

Even Header
Server Configuration Parameters

Value

Description
cluster if Integration Server does not encounter any start up
errors that prevent the connection to the Terracoa Server Array.
This is the default value.
standalone corresponds to the Action on Startup Error parameter

option Start as Stand-AloneIntegration Server on the Settings >

Clustering > Edit screen.
quiesce

If Integration Server encounters any errors that prevent it from

joining the cluster at start up, Integration Server starts as a standalone, unclustered Integration Server in quiesce mode. When
Integration Server is in quiesce mode, only the diagnostic port
and quiesce port are enabled. Integration Server will not receive
requests on inbound ports. However, you can use Integration
Server and Integration Server Administrator to make changes
needed to correct the startup errors. After correcting the errors,
exit quiesce mode. When exiting quiesce mode, Integration
Server starts all the cache managers and joins the cluster.
If Integration Server encounters any errors that prevent it from
joining the cluster when exiting quiesce mode, Integration Server
does not re-enter quiesce mode. Instead, Integration Server runs
as an unclustered, stand alone server. Integration Server captures
any errors that occurred while aempting to join the cluster in a
report displayed in Integration Server Administrator when the
server exits quiesce mode. Use the report and error logs to help
correct the underlying conguration errors. Then, to rejoin the
cluster, either restart Integration Server or enter and then exit
quiesce mode.
To use the quiesce option, a quiesce port must be congured
for Integration Server. If a quiesce port is not congured and the
quiesce option is selected, when Integration Server encounters
any errors that prevent it from joining the cluster at start up,
Integration Server shuts down instead of entering quiesce mode.
quiesce corresponds to the Action on Startup Error parameter

option Enter Quiesce Mode on Stand-AloneIntegration Server on the

Settings > Clustering > Edit screen.
For more information about quiesce mode, see "Quiescing the
Server for Maintenance" on page 821.
The wa.server.cluster.action.errorOnStartup parameter displays the value specied in
the Action On Startup Error parameter on the Settings > Clustering and Settings > Clustering
>Edit screens of Integration Server Administrator. Software AG recommends that you
specify the action to take when Integration Server cannot connect to the cluster on
startup using the Action On Startup Error parameter on the Settings > Clustering > Edit

webMethods Integration Server Administrators Guide Version 9.10

888

Odd Header
Server Configuration Parameters

screen instead of by changing the value of the wa.server.cluster.action.errorOnStartup

parameter.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.cluster.aliasList
Species a comma-delimited list of aliases for remote Integration Servers in a cluster.
The Integration Server uses this list when executing the remote invokes that update the
other cluster nodes with trigger management changes. When this property is congured,
the Settings > Messaging >webMethods Messaging TriggerManagement > Cluster View screen
will be visible and the Apply Change Across Cluster check box will be available when
performing trigger management tasks.
This parameter is applicable only when you are using webMethods clustering. For more
information, see the webMethods Integration Server Clustering Guide.
watt.server.cluster.aware
Species whether you want the server to participate in a cluster. A value of true
indicates that clustering is enabled for the server. The default is false.

The value of the wa.server.cluster.aware parameter is tied to the value of the Clustering
Status eld on the Settings > Clustering screen in Integration Server Administrator.
Software AG recommends that you use Integration Server Administrator to enable or
disable clustering for an Integration Server instead of using the wa.server.cluster.aware
property.
This parameter is applicable only when you are using this Integration Server in a cluster.
Important: You must restart Integration Server for changes to take eect.
Note:

If wa.server.cluster.aware is set to true, you must also specify values for

the wa.server.cluster.tsaURLs and wa.server.cluster.name parameters.

watt.server.cluster.name
Species the name of the cluster to which Integration Server belongs. If Integration
Server does not belong to a cluster, this parameter is empty.
Keep the following in mind when specifying the cluster name:
The cluster name cannot include any periods .. Integration Server converts any
periods in the name to underscores when you save the cluster conguration.
The cluster name cannot exceed 32 characters. If it does, Integration Server uses
the rst 20 characters of the supplied name and then a hash for the remaining
characters.
The wa.server.cluster.name parameter displays the value specied in the Cluster Name
parameter on the Settings > Clustering and Settings > Clustering >Edit screens of Integration
Server Administrator. Software AG recommends that you specify the cluster name using
the Cluster Name parameter on the Settings > Clustering > Edit screen instead of by changing
the value of the wa.server.cluster.name parameter.

webMethods Integration Server Administrators Guide Version 9.10

889

Even Header
Server Configuration Parameters

Important: You must restart Integration Server for changes to take eect.
Note:

If wa.server.cluster.aware is set to true, you must also specify values for

the wa.server.cluster.tsaURLs and wa.server.cluster.name parameters.

watt.server.cluster.SessTimeout
Species number of minutes that the server allows inactive session objects to remain in
the cluster store before removing them. The default is 60.
This parameter is applicable only when you are using webMethods Integration Server
Clustering. For more information, refer to the webMethods Integration Server Clustering
Guide.
watt.server.cluster.tsaURLs
A comma-separated list of the Terracoa Server Array URLs that the cluster uses for
distributed system caches. This parameter is applicable only when Integration Server
belongs to a cluster.
The wa.server.cluster.tsaURLs parameter is tied to Terracotta Server ArrayURLs
parameter on the Settings > Clustering and Settings >Clustering > Edit screen in Integration
Server Administrator. Software AG recommends that you specify the Terracoa
Server Array URLs using the Terracotta Server ArrayURLs parameter on the Settings >
Clustering > Edit screen instead of by changing the value of the wa.server.cluster.tsaURLs
parameter.
Important: You must restart Integration Server for changes to take eect.
Note:

If wa.server.cluster.aware is set to true, you must also specify values for

the wa.server.cluster.tsaURLs and wa.server.cluster.name parameters.

watt.server.coder.bincoder.trycontextloaderfirst
Species whether Integration Server uses the context loader before using the class
loader for the currently executing thread when Integration Server encodes or decodes a
pipeline. If a referenced class belongs to a particular package, it may be faster to use the
context loader rst. The default is false.
watt.server.compile
Species the compiler command that Integration Server uses to compile Java services
that are developed using Designer, for example, javac -classpath {0} -d {1} {2}. This
compiler command is also used from the jcode utility. If this property is omied or
empty, the server uses the JVM internal Java compile tool to compile Java services.
Note:

If you use the wa.server.compile property to have Integration

Server use a dierent compiler, and that compiler returns errors
and warnings to standard out rather than standard error, set
wa.server.compile.readFromStdErr to false so that the compiler errors
and warnings will be read and displayed to the Java developer.

webMethods Integration Server Administrators Guide Version 9.10

890

Odd Header
Server Configuration Parameters

watt.server.compile.exitOnError
Species whether the jcode utility should stop processing after it fails. If set to true,
the jcode utility stops processing at the package on which it fails. If set to false (the
default), the jcode utility will continue processing despite the failure.
watt.server.compile.readFromStdErr
Species from where Integration Server reads compiler errors and warnings. The
Software AG webMethods platform includes javac, the Java tool used to compile Java
services in Designer and with the jcode utility. The javac compiler returns information
about any errors or warnings it encountered during compilation to standard error. If
you use the wa.server.compile property to have Integration Server use a dierent
compiler, and that compiler returns errors and warnings to standard out rather
than standard error, set wa.server.compile.readFromStdErr to false so that the
compiler errors and warnings will be read and displayed to the Java developer. Set
wa.server.compile.readFromStdErr to true for Integration Server to read compiler
errors and warnings from standard error. The default is true.
watt.server.compile.unicode
Species the compiler command that Integration Server uses to compile Java services
that are stored in Unicode encoding, for example, javac -encoding Unicode -classpath
{0} -d {1} {2}. Note that the seing javac -encoding Unicode -classpath {0} -d {1} {2}
works with the Oracle JDK compiler. This compiler command is also used from the
jcode utility. If this property is omied or empty, the server uses the JVM internal Java
compile tool to compile Java services.
watt.server.content.type.default
Species what content type to use for HTTP requests that do not contain a Content-Type
header. The default value is application/octet-stream.
Note:

If you do not specify a value for wa.server.content.type.default and the

Content-Type header is empty, Integration Server assigns the default value
of application/octet-stream. In this case, you must create a content
handler for application/octet-stream.

To specify that Integration Server should use a dierent Content-Type, change the
value of wa.server.content.type.default to a dierent registered content type, such as
text/xml or text/html. If you set the value of wa.server.content.type.default to an
unregistered content type, Integration Server treats requests with a Content-Type header
as if they are text/html.
Changes to this property take eect immediately.

watt.server.content.type.mappings
Maps wildcards found in the Accept header eld of an HTTP client request to specic
content types. The Accept header eld species which content type or types the client
will accept in a response. Integration Server selects an outbound content handler based
on the allowed content type. The syntax for this parameter is:
wa.server.content.type.mappings=<wildcard > <content-type >,<wildcard > <contenttype >,<wildcard > <content-type > ...
Where:

webMethods Integration Server Administrators Guide Version 9.10

891

Even Header
Server Configuration Parameters

wildcard is a wildcarded content type, such as text/*

content-type is the specic content type to use
Use a space to separate the wildcarded content type from the specic content type. Use
a comma to separate <wildcard > <content-type > pairs from other pairs. Consider the
following examples:
To associate text/* with text/xml, specify:
watt.server.content.type.mappings=text/* text/xml

To associate text/* with text/xml, and multipart/* with multipart/related,

specify:
watt.server.content.type.mappings=text/* text/xml,multipart/* multipart/
related

Integration Server parses the Accept header and aempts to select a content type or
types as dened in the W3C Hypertext Transfer Protocol specication.

The default seing is text/* text/xml. If this parameter is not specied, and an Accept
header eld species a wildcard, Integration Server selects a content handler based on
the major content type specied, as shown below.
This Accept Header field...

Results in this content handler

text/*

XML

application/*

CGI

multipart/*

Multipart

The wa.server.hp.useAcceptHeader property must be set to true for the

wa.server.content.type.mappings parameter to work.
For more information about content handlers, refer to "Content Handlers" on page 813.
watt.server.control.controlledDeliverToTriggers.delayIncrementInterval
Species the interval used in conjunction with
wa.server.control.controlledDeliverToTrigger.delays to determine the delay that
Integration Server applies to services publishing documents locally when the trigger
document store reaches 90% of its capacity. The default is 2000.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.control.controlledDeliverToTriggers.delays
Species a comma-separated list of values specifying the number of milliseconds
that Integration Server delays services publishing local documents when the trigger
document store is greater than or equal to 90% of its capacity. Integration Server changes
the delay based on how long the trigger document store has continuously been at 90% or
higher capacity. The default value is 500,2000,3000,3500,4000,4500,5000.

webMethods Integration Server Administrators Guide Version 9.10

892

Odd Header
Server Configuration Parameters

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.control.controlledDeliverToTriggers.pctMaxThreshold
Species the trigger queue threshold at which the Integration Server slows down the
delivery rate of locally published documents. This threshold is expressed as a percentage
of the trigger queue capacity. For example, if you specify 80, the Integration Server
decreases the rate at which it delivers locally published documents to a trigger queue
when that trigger queue reaches 80% capacity. Integration Server resumes delivering
documents at the normal rate when the trigger queue capacity drops below the specied
threshold. The default is 90.
watt.server.control.freeMemoryThreshold
Species the threshold (as a percentage) at which Integration Server starts to warn of
insucient free memory. When the percentage of available free memory falls below the
value of this property, Integration Server generates a warning in the server log. Valid
values are 0 to 100. The default is 5.
watt.server.control.maxPersist
Species the capacity of the outbound document store. Integration Server places
published documents in the outbound document store when the congured Broker is
unavailable. When the number of documents in the outbound document store equals
the capacity, the Integration Server blocks any threads executing services that publish
documents. The Integration Server resumes execution of blocked threads after the
Broker becomes available. Set this parameter to a whole number greater than 0. The
default is 500,000 documents.
watt.server.control.maxPublishOnSuccess
Species the maximum number of documents that the server can publish on success at
one time. For example, suppose that you set the maximum to 100 documents. ServiceA
publishes 10 documents on success. ServiceB publishes 90 documents on success.
ServiceC publishes 5 documents on success. ServiceA and ServiceB can publish documents
concurrently. However, if ServiceC begins to publish documents before ServiceA or
ServiceB completes, the Integration Server throws an exception for ServiceC because the
documents published by ServiceC exceed the maximum number of documents that can be
published on success at one time. If ServiceD publishes 125 documents on success and the
maximum is 100, ServiceD will receive an exception every time it executes. The default is
50,000 documents.
watt.server.control.memorySensorInterval
The time interval (in milliseconds) at which the Integration Server will check the
available free memory. The default is 300000 (5 minutes).
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.control.serverThreadThreshold
Species the threshold at which Integration Server starts to warn of insucient available
threads. When the percentage of available server threads goes below the value of this
property, Integration Server generates a journal log message indicating the current
webMethods Integration Server Administrators Guide Version 9.10

893

Even Header
Server Configuration Parameters

available thread percentage and stating "Available Thread Warning Threshold

Exceeded." When you receive this message in the journal log, you can adjust the thread
usage to make server threads available.
The default is 15%.
Note:

It is recommended that you use the Available Threads Warning Threshold eld
in the Edit Resource Seings page of the Integration Server Administrator
to set the threshold value. For more information about seing an available
threads warning threshold, see "Managing the Server Thread Pool" on
page 110.

watt.server.control.threadSensorInterval
Species the interval, measured in milliseconds, at which Integration Server will monitor
the thread usage. When the percentage of available server threads goes below the
threshold value specied in the wa.server.control.serverThreadThreshold property,
Integration Server will generate a journal log message to warn of insucient available
threads. The default is 2000 milliseconds.
watt.server.control.triggerInputControl.delayIncrementInterval
Species the interval used in conjunction with
wa.server.control.triggerInputControl.delays to determine the frequency with which
Integration Server polls a trigger client queue on the Broker if the queue was empty
when it was last polled. The default is 10000.
Note:

If an exception occurs when parsing the supplied values

for wa.server.control.triggerInputControl.delays or
wa.server.control.triggerInputControl.delayIncrementInterval,
Integration Server resets both conguration parameters to the default
values.

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
For more information about controlling the polling frequency for trigger client queues
on the Broker, see "Delaying Polling Requests for webMethods Messaging Triggers" on
page 774.
watt.server.control.triggerInputControl.delays
Species a comma-separated list of values specifying the number of milliseconds that
Integration Server delays the polling of a trigger client queue on the Broker. Integration
Server changes the delay based on how long the trigger client queues has been empty.
The default value is 500,1000,1500,5000.
Note:

If an exception occurs when parsing the supplied values

for wa.server.control.triggerInputControl.delays or
wa.server.control.triggerInputControl.delayIncrementInterval,
Integration Server resets both conguration parameters to the default
values.

webMethods Integration Server Administrators Guide Version 9.10

894

Odd Header
Server Configuration Parameters

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
For more information about controlling the polling frequency for trigger client queues
on the Broker, see "Delaying Polling Requests for webMethods Messaging Triggers" on
page 774.
watt.server.cors.allowedOrigins
Species the URIs from which Integration Server is to allow cross-origin requests to
access resources.
As recommended by the CORS (Cross-Origin Resource Sharing) standard, Integration
Server uses the values of this parameter to validate the request. Integration Server checks
the URI specied in the Origin header of the CORS request. If it does not match a URI
specied by this parameter, Integration Server refuses the request and returns an HTTP
403 status code with the following message:
Specified Origin is not allowed

If the URI matches a value specied by this parameter, Integration Server sends a
response with the CORS Access-Control-Allow-Origin response header back to the requesting
user agent.
To dene this parameter, enter protocol ://hostname or protocol ://hostname :portnumber .
You can specify the IP address or the name of the machine for hostname . The values are
case-sensitive. Use a space or comma delimiter to specify multiple values. You can use
an asterisk (*) to indicate that any URI or origin is allowed.
Note:

The IP address and host name cannot be used interchangeably. If you

specify a host name, and a cross-origin request is received that uses the
corresponding IP address or vice versa, Integration Server will reject the
request.

Note:

You must specify a value if the wa.server.cors.enabled parameter is set to

true.

watt.server.cors.enabled
Species whether Integration Server is to support CORS. If this parameter is set to true,
Integration Server allows cross-origin requests. The default value is false.
Note:

In a webMethods Enterprise Gateway conguration, enable support for

CORS only on the Enterprise Gateway Server.

For more information about using CORS with Integration Server, see " Using CORS with
Integration Server " on page 137. For instructions on how to congure Integration Server
to allow cross-origin requests, see "Conguring Integration Server to Accept CORS
Requests" on page 137.
watt.server.cors.exposedHeaders
Species the values Integration Server can include with the CORS Access-Control-ExposeHeaders header in response to a CORS request. The CORS Access-Control-Expose-Headers
header denes the headers that can be exposed to the user agent. Examine your client-

webMethods Integration Server Administrators Guide Version 9.10

895

Even Header
Server Configuration Parameters

side code to determine which response headers, if any, are retrieved by the client and
need to be exposed.
The value for this parameter is case-sensitive. Use a space or comma delimiter to specify
multiple values. For example:
watt.server.cors.exposedHeaders=<value1,value2,value3>

As determined by the CORS (Cross-Origin Resource Sharing) standard, the following

are considered simple response headers and are always exposed: Cache-Control,
Content-Language, Content-Type, Expires, Last-Modied, Pragma.
watt.server.cors.host
Species the host and port on which clients send cross-origin requests to Integration
Server. Integration Server uses this value to validate the Host header in the crossorigin request. For improved security, Software AG recommends that you dene this
parameter if support for CORS is enabled (that is, wa.server.cors.enabled is set to
true).

To dene this parameter, enter hostname :port or hostname . You can specify the IP
address or the name of the machine for hostname . The value for this parameter is casesensitive. If a value is not provided for this parameter, Integration Server does not
validate the Host header in the request. If a value is provided but does not match the Host
header in the request, Integration Server returns a 403 response with the message.
Note:

The IP address and host name cannot be used interchangeably. If you

specify a host name, and a cross-origin request is received that uses the
corresponding IP address or vice versa, Integration Server will reject the
request.

watt.server.cors.maxAge
Species the amount of time in seconds a user agent is allowed to cache the results of a
preight request. Integration Server uses this value in the CORS Access-Control-Max-Age
response header.
The default is -1, which indicates the results do not remain on the client. The value must
be an integer.
watt.server.cors.supportsCredentials
Species whether Integration Server is to set the CORS Access-Control-Allow-Credentials
header in response to all CORS requests.
When set to true, Integration Server sets the CORS Access-Control-Allow-Credentials header
to true in the response. When seing this parameter to true, keep the following points in
mind:
If the user credentials are valid and the user is authorized to access the resources,
Integration Server will execute a CORS simple requests with credentials. The
user agent will display the response to the user.
When Integration Server responds to a CORS preight request, the response
includes the Access-Control-Allow-Credentials header set to true so the user agent will
allow the request with credentials.

webMethods Integration Server Administrators Guide Version 9.10

896

Odd Header
Server Configuration Parameters

Note:

User credentials can be cookies, HTTP authentication, or client-side SSL

certicates.

When set to false (the default), Integration Server does not set the CORS Access-ControlAllow-Credentials header in the response. When seing this parameter to false, keep the
following points in mind:
If the user credentials are valid and the user is authorized to access the resources,
Integration Server will execute a CORS simple requests with credentials. The
user agent will not display the response to the user.
When Integration Server responds to a CORS preight request, the response does
not include the Access-Control-Allow-Credentials header, so the user agent will not
allow the request with credentials.
Note:

For security reasons, Software AG recommends using the default seing

(false) for this parameter. When set to false, the user agent ignores
the cookies sent in the response. When this parameter is set to true,
Software AG highly recommends using CSRF protection to safe guard
your resources. For a more secure approach, consider using another
standard, such as OAuth, for accessing authorized resources instead of
relying on credentialed requests.

watt.server.cors.supportedHeaders
Species the request headers Integration Server will allow in cross-origin requests.
Integration Server uses the value to validate the CORS Access-Control-RequestHeader request header. If the header is not an exact match of a value specied by
wa.server.cors.supportedHeaders, Integration Server refuses the request and returns an
HTTP 403 status code with the following message:
Header not supported

If the header matches the value specied by this parameter, Integration Server responds
with the CORS header Access-Control-Allow-Headers populated with the value of this
parameter.
Examine your server-side code to determine which request headers, if any, are read by
your server application and need to be explicitly allowed.
The value for this parameter is case-sensitive. Use a space or comma to separate multiple
request headers. For example,
watt.server.cors.supportedHeaders=<header1,header2,header3>

As determined by the CORS (Cross-Origin Resource Sharing) standard, the following

are considered simple request headers and are always exposed: Accept, AcceptLanguage, Content-Type (when the value is application/x-www-form-urlencoded,
multiplart/form-data, or text/plain).
watt.server.cors.supportedMethods
Species the HTTP methods Integration Server will allow in cross-origin requests.
Integration Server uses this value to validate the value of the CORS Access-ControlRequest-Method request header. If the header is not an exact match of a value specied by

webMethods Integration Server Administrators Guide Version 9.10

897

Even Header
Server Configuration Parameters

wa.server.cors.supportedMethods, Integration Server refuses the request and returns

an HTTP 403 status code with the following message:
Method not supported

If the header matches a value specied by this parameter, Integration Server responds
with the CORS header Access-Control-Allow-Headers populated with the value of this
parameter.
Use a space or comma to separate multiple HTTP methods. Possible values are
OPTIONS, HEAD, GET, POST, PUT, and DELETE. Integration Server accepts any of
these values by default.
watt.server.createPackage.ignorePattern
Species the le types you do not want Integration Server to include when publishing
packages. You can use this parameter to specify the le types to exclude when
publishing packages through replication, publishing packages to VCS using the Version
Control System Integration feature in Integration Server, and deploying packages. For
example, to prevent Integration Server from publishing .svn les, you would specify the
parameter as wa.server.createPackage.ignorePaern=.svn.
You can specify several le types using a semi-colon (;) as a delimiter, as follows:
watt.server.createPackage.ignorePattern=.svn;.java;.xml

Important: The WmVCS package, which provides the functionality for using the VCS
Integration Feature, is deprecated as of Integration Server version 9.9.
Software AG recommends that you use the local service development
feature (Local Version Control Integration) to check package elements
and their supporting les into and out of a version control system (VCS)
directly from Designer.
watt.server.cronMaxThreads
The maximum number of threads maintained for the cronjob-based threadpool, which
Integration Server uses for scheduled system tasks. If this maximum number is reached,
Integration Server waits until processes complete and return threads to the pool before
running more processes. The default is 5.
watt.server.cronMinThreads
The minimum number of threads maintained for the cronjob-based threadpool, which
Integration Server uses for scheduled system tasks. When Integration Server starts, the
thread pool initially contains this minimum number of threads. The default is 2.
watt.server.dateStampFmt
Species the date format to use in the log les. For the server log, this parameter
species how the date format is displayed in the server log le as well as in Integration
Server Administrator. For all other logs, such as the service, error, session, guaranteed
delivery, and security logs, this parameter species how the date format is displayed
only in Integration Server Administrator.
Note:

In order to use this parameter to specify the date format for the
service, error, session, guaranteed delivery, and security log les, the

webMethods Integration Server Administrators Guide Version 9.10

898

Odd Header
Server Configuration Parameters

wa.server.audit.displayLogs.convertTime must be set to true. For usage

information, see wa.server.audit.displayLogs.convertTime.
To specify the date format to use, you can use any format that is supported by the Java
class java.text.SimpleDateFormat. For example, to display the date with the format
08-12-02 14:44:33:1235, specify dd-MM-yy HH:mm:ss:SSSS.
watt.server.date.SuppressPatternError
Species how the server should respond if no input is passed to the
pub.date:dateTimeFormat service. When set to true, the server simply returns a null value
for the value parameter. The default is for the server to throw an exception.
watt.server.db.blocktimeout
Species the maximum time in milliseconds the server is to block a request when
waiting for a connection to a database. (The database must be dened by an alias in the
WmDB package.) The default is to wait indenitely. Specifying -1 also means to wait
indenitely. This property is global to all pools.
watt.server.db.connectionCache
Species how the server manages connections to a database.
Specifying server tells the server to maintain a pool of connections for each database
that is dened to the server through an alias. If a request cannot be satised because the
pool has reached its maximum number of connections, the server blocks the request and
tries again later.
Specifying session tells the server to create a database connection per session. That
is, when the server receives a service request that requires a database connection, it
will create a new connection if one doesn't already exist for that session; otherwise the
server will use the connection that was previously created for that session. If the aempt
to create a connection for the session fails, for example because the database has no
available slots for connections, the request fails. The default is session.
Although enabling database connection pooling creates a pool for each database dened
to your server, you can control the characteristics of each pool individually by using the
Edit Alias Information screen of the Integration Server Administrator. See the WmDB Users
Guide for more information about conguring the server to connect to a database.
watt.server.db.maintainminimum
Species how the server handles purging inactive connections that have timed out.
With the parameter set to false, the server purges all of these connections. With the
parameter set to true, the server purges these connections, but stops when a minimum
number of connections in the pool has been reached. You specify the minimum when
you dene the alias. This property is global to all pools.
watt.server.db.share.ISInternal
Indicates whether the Integration Server ISInternal Functional Alias on the Integration
Server Administrator JDBC Pools page refers to the same database that other Integration
Servers use, even though the Integration Servers are not clustered. Set this property to
true to indicate that the Integration Server shares the same ISInternal database. Seing
the property to true is necessary if you want to use guaranteed delivery on multiple
Integration Servers that are not clustered but share the ISInternal database. You must set
this property to true for all Integration Servers that share the ISInternal database. Set
webMethods Integration Server Administrators Guide Version 9.10

899

Even Header
Server Configuration Parameters

this property to false if the Integration Server does not share the ISInternal database
with other Integration Servers. The default is false.
Important: You must restart Integration Server for changes to take eect.
watt.server.db.testSQL
Species a SQL statement that can be used to test a database connection in a JDBC
connection pool. If the wa.server.db.testSQL parameter species a SQL statement,
when a caller requests a JDBC connection from a JDBC connection pool, Integration
Server executes the specied SQL statement against the database used with the
JDBC connection pool. If the SQL statement executes successfully, Integration Server
considers the database connection to be valid and returns the connection to the caller.
If the SQL statement does not execute successfully, Integration Server considers
the database connection to be invalid and removes it from the JDBC connection
pool. Integration Server than creates a new JDBC connection, places it in the JDBC
connection pool, and returns the new connection to the caller. If no value is specied
for wa.server.db.testSQL, Integration Server does not test database connections in the
connection pool when a caller requests a JDBC connection. There is no default value for
the parameter.
Note:

Testing a database connection each time a JDBC connection is requested

may impact performance as each test executes a SQL statement against the
database.

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.debugFIPS
Species whether Integration Server checks the FIPS encryption provider every
time a user is authenticated. When this parameter is set to true, every time a user is
authenticated, Integration Server checks the FIPS encryption provider by using the
provider to create a java.security.MessageDigest instance. The provider check writes the
name of the provider and the generated MessageDigest to standard error. When set to
false, Integration Server does not check the encryption provider every time a user is
authenticated. The default is false.
Important: You must restart Integration Server for changes to take eect.
watt.server.defaultContentHandler
Species to which content handlers Integration Server should register the text/html
content type. If set to true (the default), then Integration Server registers the text/html
content type with the ContentHandler_Default content handler. If set to false, then
Integration Server registers the text/html content type with the ContentHandler_CGI
content handler.
Important: You must restart Integration Server for changes to take eect.

webMethods Integration Server Administrators Guide Version 9.10

900

Odd Header
Server Configuration Parameters

watt.server.defaultCountry
Species the default country, a component of a Java Locale, that Integration Server uses
when selecting strings from ResourceBundles to return to a client. Any ISO country code
is a valid value. The default value for this property is US. The default locale is en-US.
Important: You must restart Integration Server for changes to take eect.
watt.server.defaultLanguage
The default language, a component of a Java Locale, that Integration Server uses when
selecting strings from ResourceBundles to return to a client. Any ISO language code is a
valid value. The default value for this property is en. The default locale is en-US.
Important: You must restart Integration Server for changes to take eect.
watt.server.defaultPackage
Species the name of the default package. If this value is not set, Integration Server uses
WmRoot as the default package.
Note:

If you start Integration Server in safe mode, WmRoot becomes the default
value regardless of the value of wa.server.defaultPackage.

watt.server.deprecatedExceptionLogging
Species how the Integration Server logs service exceptions to the Integration Server
error log. Set this parameter to true for basic exception logging or false (the default
seing) for more detailed exception logging to help pinpoint the source of the exception.
When set
to...
true

Integration Server...
Logs the exception for each service in a nested stack as the
exception moves up the stack. If a parent service catches the
exception and does not rethrow it, the Integration Server still logs
the exception for each child service it passed on its way up the
stack.
Displays the stack trace for each service.

false

Logs the exception only once, at the top-level service, even if the
exception occurred at a nested service. If any service in the stack
catches the exception and does not rethrow it, the Integration
Server does not log the exception.
Note: The exception may be logged more than once if a service
in the call stack, or one of the core classes that the service
uses, explicitly logs the exception.
Displays, for logged exceptions, the stack trace of the
innermost service where the exception rst occurred.

webMethods Integration Server Administrators Guide Version 9.10

901

Even Header
Server Configuration Parameters

When set
to...

Integration Server...
This stack trace often gets truncated from the log when
watt.server.deprecatedExceptionLogging is set to true.
Concatenates the error messages from each of the nested
exceptions.

If this parameter is set to true, the cause of the exception becomes more dicult to
trace. For this reason, Software AG recommends that you do not set this parameter to
true unless you are executing services that catch exceptions and do not rethrow them.
For more information about interpreting the error log and using the log to help debug
services, see "Debugging Service Exceptions Using the Error Log" on page 993.

watt.server.diagnostic.logperiod
Species how many hours of logs are returned when you run the diagnostic tool. The
default is 6. When this property is set to 0, the diagnostic utility does not return any log
les. It returns only the congurational and run-time data les.
watt.server.diagnostic.port
Species the diagnostic port through which you can access Integration Server when
it is unresponsive. During installation, Integration Server automatically creates the
diagnostic port at 9999. The default is 9999.
Note:

This seing overrides the Port seing on the on the Edit Diagnostic Port
Conguration screen.

If you are running multiple Integration Servers on the same host machine, the diagnostic
port on each server must have a unique port number. Set this parameter for each
Integration Server instance to use a unique port number. For more information about the
diagnostic port and running multiple Integration Server instances, see "Adding an HTTP
Diagnostic Port" on page 196.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect. To change the diagnostic port
without restarting Integration Server, edit the default diagnostic port on
the Security > Ports page of Integration Server Administrator. For more
information, see "Editing a Port" on page 210.
watt.server.diagnostic.tabular
Species whether Integration Server should generate diagnostic les in tabular format. If
set to false, Integration Server generates the les in non-tabular format. The default is
true.
watt.server.dispatcher.comms.brokerPing
Species how often (in milliseconds) triggers (which are Broker clients) should ping
the Broker. When there is a rewall between the Integration Server and the Broker, the
rewall closes the connection between a trigger and the Broker when the connection
becomes idle. To prevent connections from becoming idle, trigger Broker clients

webMethods Integration Server Administrators Guide Version 9.10

902

Odd Header
Server Configuration Parameters

periodically ping the webMethods Broker. The default is 1800000 milliseconds (30
minutes).
watt.server.dispatcher.comms.connectionShareLimit
Species the number of BrokerClient objects that Integration
Server can use to communicate with Broker. Integration
Server passes this value to set the following Broker API:
COM.activesw.api.client.BrokerConnectionDescriptor.setConnectionShareLimit (int
value).
For more information, see webMethods Broker Java Client API Reference.
Each Broker connection represents a socket open to the Broker. While decreasing the
value of the property can increase throughput, it also increases the number of resources
and le descriptors Integration Server uses. Set this parameter to either 0 or a value
greater than 1. When set to 0, connection sharing is turned o and each Broker client
uses its own Broker connection. The default is 5.
Note:

Broker does not support a value of 1. If the value is set to 1, Broker issues
an exception.

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.dispatcher.join.reaperDelay
Species how often (in milliseconds) that the Integration Server removes state
information for completed and expired joins. The default is 1800000 milliseconds (30
minutes).
watt.server.dispatcher.messageStore.redeliverOriginalMessage
Species whether Integration Server stores and redelivers the original message or a
modied message for subsequent trigger service execution when retry failure occurs
for a trigger service invoked by webMethods messaging trigger. When set to true,
Integration Server stores and redelivers the message originally sent to the webMethods
messaging trigger. When set to false, Integration Server stores the message as it is at the
point at which retry failure occurs. Integration Server delivers a modied message to the
webMethods messaging trigger for subsequent processing. The default is false.
watt.server.displayDirectories
Species whether a browser user can view directories that reside on Integration Server
without using Integration Server Administrator. When this parameter is set to true (the
default), users can view Integration Server directories. When this parameter is set to
false, no directories are displayed.
watt.server.email.charset
Species the default character set used for encoding portions that contain non-ASCII
characters in email messages. Email elds that contain non-ASCII characters are
subject, MIME headers, body text, and aachments. The pub.client:smtp service uses this
property. The default is utf-8. For more information about the pub.client:smtp service, see
webMethods Integration Server Built-In Services Reference.

webMethods Integration Server Administrators Guide Version 9.10

903

Even Header
Server Configuration Parameters

watt.server.email.from
Species the email address the server presents as its From address when sending emails
about errors. By default, the server uses Integration-Server@localhost for the From
Address, where localhost is the name of the host on which the Integration Server is
running.
watt.server.email.processReplyEmails
Species whether Integration Server should process the reply emails that it receives
in its email port if the Subject line of the email contains the prex "Re:". Set the
wa.server.email.processReplyEmails property to true if you want Integration Server to
process reply emails that contain the prex "Re:" along with a valid service name in the
Subject line. If the property is set to false, Integration Server does not process the email
if the Subject line contains the prex "Re:". Instead, Integration Server generates a server
log message. The default is false.
watt.server.email.waitForServiceCompletion
Species whether Integration Server should wait for the email port to complete the
processing of a message before returning the thread used to retrieve the message to the
thread pool.
When retrieving and processing messages received by an email port, Integration
Server uses one thread to retrieve a message and a second thread to execute the service
that processes the message. By default, after using a thread to retrieve a message,
Integration Server returns it to the server thread pool, making it available to perform
other processing.
If the email port receives a large number of messages in a short period of time, the email
port might monopolize the server thread pool for retrieving and processing messages.
In addition, if the service that processes the messages executes slowly, it is possible that
the email port message processing will negatively aect the performance of Integration
Server.
To avoid this issue, you can limit the number of threads used to process messages
received by an email port by seing the wa.server.email.waitForServiceCompletion
property.
When the property is set to true, Integration Server does not return the thread used to
retrieve the message to the thread pool until after the service that processes the message
executes to completion. As a result, the maximum number of threads used to retrieve
and process messages for an email port is equal to 2 or twice the value of the Number of
threads if multithreading is turned on eld.
If the email port is for a POP3 email server, Integration Server can use up to
2 threads for retrieving and processing messages for the port (one thread to
retrieve a message received by the email port and one thread to execute the
service that processes the message).
If the email port is for an IMAP email server and multithreading is disabled,
Integration Server can use up to 2 threads for retrieving and processing messages
for the port (one thread to retrieve a message received by the email port and one
thread to execute the service that processes the message).

webMethods Integration Server Administrators Guide Version 9.10

904

Odd Header
Server Configuration Parameters

If the email port is for an IMAP email server and multithreading is enabled,
Integration Server can use a number of threads equal to twice the value of the
Number of threads if multithreading is turned on eld for retrieving and processing
messages for the port. For example, if the value of the Number of threads if
multithreading is turned on eld is 5, Integration Server can use a maximum of
10 threads to retrieve and process messages for the email port (5 threads to
concurrently retrieve messages for the email port and another 5 threads to
process those messages).
When wa.server.email.waitForServiceCompletion is set to false, Integration Server
does not wait for the service that processes the message to execute to completion before
returning the thread used to retrieve the message to the thread pool.
The default is false.
Note:

The wa.server.email.waitForServiceCompletion parameter applies to all

email ports on an Integration Server.

watt.server.enableHotDeployment
This is an internal property. Do not modify.
watt.server.errorMail
Species the email address to which Integration Server sends messages about critical
server log entries. There is no default.
watt.server.event.audit.async
Species whether the event handlers for the audit event are invoked asynchronously or
synchronously. When this parameter is set to true, Integration Server invokes the event
handlers (services) that subscribe to audit events asynchronously. When this parameter
is set to false, Integration Server invokes the event handlers that subscribe to audit
events synchronously. The default is true.
watt.server.event.exception.async
Species whether the event handlers for the exception event, error event, or journal
event are invoked asynchronously or synchronously. When this parameter is set to
true, Integration Server invokes the event handlers (services) that subscribe to exception
events asynchronously. When this parameter is set to false, Integration Server invokes
the event handlers that subscribe to exception events synchronously. The default is true.
watt.server.event.gd.async
Species whether the event handlers for guaranteed delivery events (gdStart and
gdEnd) are invoked asynchronously or synchronously. When this parameter is set
to true, Integration Server invokes the event handlers (services) that subscribe to
guaranteed delivery events asynchronously. When this parameter is set to false,
Integration Server invokes the event handlers that subscribe to guaranteed delivery
events synchronously. The default is true.
watt.server.event.jmsDeliveryError.async
Species whether the event handlers for JMS delivery failure events are invoked
asynchronously or synchronously. When this parameter is set to true, Integration
Server invokes the event handlers (services) that subscribe to JMS delivery failure events

webMethods Integration Server Administrators Guide Version 9.10

905

Even Header
Server Configuration Parameters

asynchronously. When this parameter is set to false, Integration Server invokes the
event handlers that subscribe to JMS delivery failure events synchronously. The default
is true.
watt.server.event.jmsRetrievalError.async
Species whether the event handlers for JMS retrieval failure events are invoked
asynchronously or synchronously. When this parameter is set to true, Integration
Server invokes the event handlers (services) that subscribe to JMS retrieval failure events
asynchronously. When this parameter is set to false, Integration Server invokes the
event handlers that subscribe to JMS retrieval failure events synchronously. The default
is true.
watt.server.event.nerv.subscribeService.user
Species the default user who will invoke the service specied in the
pub.event.nerv:subscribe built-in service when an event is received for a subscribed event
type. This user can be dened either internally or in an external directory but must
belong to an existing group that has appropriate ACL permissions to invoke the
specied service. Integration Server does not validate this user until the service specied
in pub.event.nerv:subscribe is executed.
It is not necessary to restart Integration Server after you change the value of this
parameter. Note, however, that the new value applies only to new subscriptions created
with pub.event.nerv:subscribe. Existing subscriptions will continue to use the previous value
of this parameter.
watt.server.event.replication.async
Species whether the event handlers for replication events are invoked asynchronously
or synchronously. When this parameter is set to true, Integration Server invokes the
event handlers (services) that subscribe to replication events asynchronously. When this
parameter is set to false, Integration Server invokes the event handlers that subscribe to
the replication events synchronously. The default is true.
watt.server.event.routing.runAsUser
Species the user who will invoke the service specied in the pub.event.routing:send and
pub.event.routing:subscribe built-in services. Integration Server uses the user specied in
this parameter only if no user is specied in the runAsUser input parameter of the
pub.event.routing:send and pub.event.routing:subscribe services. The default is Administrator.
This user can be dened either internally or in an external directory but must belong to
an existing group that has appropriate ACL permissions to invoke the specied service.
Integration Server does not validate this user until the service is executed.
The new value of the parameter applies to existing subscriptions as well as new
subscriptions created using pub.event.routing:subscribe.
watt.server.event.security.async
Species whether the event handler for security events is invoked asynchronously
or synchronously. When this parameter is set to true, Integration Server invokes the
event handlers (services) that subscribe to security events asynchronously. When this
parameter is set to false, Integration Server invokes the event handlers that subscribe to
security events synchronously. The default is true.

webMethods Integration Server Administrators Guide Version 9.10

906

Odd Header
Server Configuration Parameters

watt.server.event.session.async
Species whether the event handlers for session events (sessionStart, sessionEnd, and
sessionExpire) are invoked asynchronously or synchronously. When this parameter is
set to true, Integration Server invokes the event handlers (services) that subscribe to
session events asynchronously. When this parameter is set to false, Integration Server
invokes the event handlers that subscribe to session events synchronously. The default is
true.
watt.server.event.stat.async
Species whether the event handlers for stat (statistics) events are invoked
asynchronously or synchronously. When this parameter is set to true, Integration
Server invokes the event handlers (services) that subscribe to the statistics events
asynchronously. When this parameter is set to false, Integration Server invokes the
event handlers that subscribe to the statistics events synchronously. The default is true.
watt.server.event.tx.async
Species whether the event handlers for the transaction events (txStart and txEnd)
are invoked asynchronously or synchronously. When this parameter is set to true,
Integration Server invokes the event handlers (services) that subscribe to transaction
events asynchronously. When this parameter is set to false, Integration Server invokes
the event handlers that subscribe to transaction events synchronously. The default is
true.
watt.server.eventHandlerCreateSession
Controls whether Integration Server should create a session for the service that is
invoked by the Event Manager. When set to true, Integration Server creates a session
and associates it with the invoked service. When set to false, Integration Server does
not create a session for the service that is invoked by the Event Manager. The default is
false.
Note:

When set to true, specify a timeout value for the session using the
wa.server.eventHandlerSessionTimeout parameter.

watt.server.eventHandlerSessionTimeout
When wa.server.eventHandlerCreateSession is set to true,
wa.server.eventHandlerSessionTimeout species the timeout value for sessions created
by Integration Server for services that are invoked by the Event Manager. The default
value is 60000 milliseconds.
watt.server.eventMgr.maxThreads
Species the maximum number of threads that you want Integration Server to use for
the Event Manager thread pool. The default is 5.
Integration Server veries that this value is greater than
wa.server.eventMgr.minThreads. If the value of wa.server.eventMgr.maxThreads
is less than the value of wa.server.eventMgr.minThreads, Integration
Server sets the value of wa.server.eventMgr.maxThreads to one more than
wa.server.eventMgr.minThreads. For example, if wa.server.eventMgr.minThreads
is set to 6 and wa.server.eventMgr.maxThreads is set to 5, Integration Server sets the
value of wa.server.eventMgr.maxThreads to 7.

webMethods Integration Server Administrators Guide Version 9.10

907

Even Header
Server Configuration Parameters

watt.server.eventMgr.minThreads
Species the minimum number of threads that you want Integration Server to use for the
Event Manager thread pool. The default is 2.
Integration Server veries that this value is 1 or greater. If set to a value less than 1,
Integration Server resets it to 1.
watt.server.fileEncoding
Species the encoding the server is to use when reading and writing text les. This
seing has no eect on les stored as Unicode. The default is your JVM's le.encoding
property.
Note:

To process incoming XML les, use the wa.server.xml.encoding

parameter. If you have congured Integration Server to use the
character encoding specied in the wa.server.leEncoding parameter
to process incoming XML les, you must ensure that the value of
wa.server.leEncoding parameter is set to the same value specied for
wa.server.xml.encoding.

watt.server.ftpConnect.message
Species the content of the 220 message that Integration Server returns to an FTP client
when the client issues a connect request.
When this parameter is set to true (the default), Integration Server returns the following
messages to the FTP client:
Connected to IS_hostname.
220 IS_hostname FTP server (webMethods
Integration Server version n.n.n.n) ready.

When this parameter is set to false, Integration Server returns the following messages
to the FTP client:
Connected to IS_hostname . 220

When this parameter is set to any other value, that value is returned in the 220 message.
For example, if you specify Custom FTP connect message, Integration Server will
return the following to the FTP client:
Connected to IS_hostname . 220 Custom FTP connect message.

watt.server.ftp.listingFileAge
Species the number of seconds that must elapse before a le that has been updated
or created on an Integration Server functioning as an FTP server can be accessed. Files
created or updated within the time specied by this parameter will not be part of the
results of the FTP LIST command. The default value is 60 seconds.
watt.server.ftpLogin.message
Species the content of the 230 message that Integration Server returns to an FTP client
when the client issues a login request.
When this parameter is set to true (the default), Integration Server returns the following
message to the FTP client: 230 User userid logged in.
When this parameter is set to false, Integration Server returns the following message to
the FTP client: 230

webMethods Integration Server Administrators Guide Version 9.10

908

Odd Header
Server Configuration Parameters

When this parameter is set to any other value, that value is returned in the 230 message.
For example, if you specify Custom FTP login message, Integration Server will return
the following to the FTP client:
230 Custom FTP login message.

watt.server.ftpSystem.message
Species the content of message 215 that Integration Server returns to an FTP client
when the client issues a system request. When this parameter is set to true (the default),
Integration Server returns the following message to the FTP client:
215 UNIX Type: L8 Version: webMethods IS FTP <Integration Server n.n.n.n>

When this parameter is set to false, Integration Server returns the following message to
the FTP client:
215

When this parameter is set to any other value, that value is returned in the 215 message.
For example, if you specify Custom FTP system message, Integration Server returns the
following to the FTP client:
215 Custom FTP system message.

watt.server.ftp.usecommandip
Controls whether the pub.client:ftp service uses connection information from a NAT server
when connecting to an FTP server.
When the pub.client:ftp service tries to transfer data to or from an FTP server, Integration
Server rst connects to the FTP server at the IP address specied by the pub.client:ftp
service. In response, the FTP server sends back the IP address on the FTP server to which
Integration Server should connect to perform the transfer. If the FTP server sits behind
a NAT server, the NAT server intercepts this address, translates it, then sends it on to
Integration Server.
This property controls whether Integration Server uses the address provided by the NAT
server or the address already specied by the pub.client:ftp service.
When this parameter is set to true, Integration Server bypasses the translated address
and immediately tries the address specied by the service. If this aempt fails,
Integration Server throws an exception.
When this parameter is set to false, the default, Integration Server tries the address
provided by the NAT server. If that aempt fails, Integration Server tries the IP address
specied on the pub.client:ftp service. If both aempts fail, Integration Server throws an
exception.
watt.server.hostAccessMode
Species IP access for ports that do not have a custom IP access seing. When this
parameter is set to include, the server accepts requests from all IP addresses, except
those specically denied on the Integration Server Administrator interface. When this
parameter is set to exclude, the server denies requests from all IP addresses except
those specically allowed on the Integration Server Administrator interface. The default
is include.

webMethods Integration Server Administrators Guide Version 9.10

909

Even Header
Server Configuration Parameters

watt.server.hostAllow
Species the name of the host that is allowed service. There is no default.
watt.server.hotDeploymentAutoRecover
This is an internal property. Do not modify.
watt.server.hotDeploymentTimeout
This is an internal property. Do not modify.
watt.server.http.allowOptions
Indicates whether Integration Server allows a client to use the HTTP OPTIONS method
to determine the HTTP methods supported by Integration Server. When this parameter
is set to true, Integration Server allows the OPTIONS method. When this parameter is
set to false (or any other value), OPTIONS requests from clients receive a 405 Method
Not Allowed response.
The default is true.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.http.authorizationEncoding
Species the encoding that the HTTP client (such as a browser) uses when encoding
the user name and password for Integration Server. The HTTP client sends the user
name and password to Integration Server in the Authorization aribute in the header
of the HTTP request. Set the wa.server.hp.authorizationEncoding property to the
encoding that your browser uses for the Authorization aribute. Consult the browser
documentation, or contact the browser manufacturer, to nd what encoding is used in
your environment. The default is UTF-8.
Note:

If two browsers use dierent encodings for the Authorization aribute,

and both send non-ASCII passwords to Integration Server, only the
browser whose Authorization encoding matches the value of the
wa.server.hp.authorizationEncoding property will work.

watt.server.http.header.useHttpOnly
Species whether Integration Server includes the HpOnly aribute in the Set-Cookie
header in the response to an HTTP client. When this property is set to true (the default),
Integration Server includes the HpOnly aribute in the Set-Cookie header of the HTTP
response to an HTTP client. Software AG recommends seing this property to true
because it prevents a client side script from accessing a protected cookie. If you are
working with an HTTP client that does not support the HpOnly aribute, set this
property to false.
watt.server.http.header.useSecure
Species whether Integration Server includes the secure aribute in the Set-Cookie
header in the response to an HTTP/S client. When the wa.server.hp.header.useSecure
property is set to true (the default), Integration Server includes the secure aribute
in the Set-Cookie header of the HTTPS response to an HTTP/S client. Software AG

webMethods Integration Server Administrators Guide Version 9.10

910

Odd Header
Server Configuration Parameters

recommends seing this property to true because it ensures that the cookie is always
encrypted while being transmied from client to server.
watt.server.hostDeny
Species the name of the host that is denied service. There is no default.
watt.server.http.jsonFormat
Species how Integration Server handles JSON content in HTTP client requests. When
this property is set to parsed (the default), Integration Server parses JSON content into
pipeline variables automatically. Clients can then use JSON to compose pipelines and
execute existing services without having to call pub.json:jsonStreamToDocument.
If wa.server.hp.jsonFormat is set to stream, Integration Server places a jsonStream
variable containing the JSON content in the pipeline as an InputStream. You can then
use pub.json:jsonStreamToDocument to parse jsonStream into pipeline variables.
If wa.server.hp.jsonFormat is set to bytes, Integration Server places the incoming
stream of JSON into a byte array.
You can override the behavior specied by wa.server.hp.jsonFormat in individual
requests by adding the jsonFormat query parameter to the request URI. For example, if
wa.server.hp.jsonFormat is set to parsed, a client can override this seing and instead
specify a value of stream for the request by entering a URI as follows:
/invoke/myfolder/myservice?jsonFormat=stream

This will result in the request being placed in a jsonStream variable in the pipeline as an
InputStream containing the JSON content.
watt.server.http.listRequestVars
Species how Integration Server handles duplicate query tokens in an HTTP request.
When set
to...

Integration Server...

always

Converts duplicate and non-duplicate tokens into lists. For example:

http://host:5555/folder/service?arg1=X&arg1=Y&arg2=Z

becomes
INVOKE folder:service {arg1=X, arg1List=[X,Y], arg2=Z,
arg2List=[Z]}

asNeeded

Converts duplicate tokens into Lists. Non-duplicate tokens are not

converted. For example:
http://host:5555/folder/service?arg1=X&arg1=Y&arg2=Z

becomes
INVOKE folder:service {arg1=X, arg1List=[X,Y], arg2=Z}

This is the default seing.

error

Throws a ServiceException if duplicate tokens are found in the URL

query. Non-duplicate tokens are not converted. For example:

webMethods Integration Server Administrators Guide Version 9.10

911

Even Header
Server Configuration Parameters

When set
to...

Integration Server...
http://host:5555/folder/service?arg1=X&arg1=Y&arg2=Z

never

Ignores duplicate tokens found in the URL query. For example:

http://host:5555/folder/service?arg1=X&arg1=Y&arg2=Z

becomes
INVOKE folder:service {arg1=X, arg2=Z}

watt.server.http.preserveUriReservedChars
Species whether Integration Server should decode percent-encoded URI paths in
requests before evaluating URI paths. When this property is set to true (the default),
Integration Server defers decoding percent-encoded reserved characters until after
evaluating URI paths. When set to false, Integration Server decodes percent-encoded
reserved characters prior to evaluating the URI paths.
Note:

The value of wa.server.hp.preserveUriReservedChars is signicant

only for REST requests (those that use the rest directive). For requests
using the rest directive, the last tokens in the path identify the instance
of a resource or provide application-specic information. These tokens
become the $resourceID and $path variables in the pipeline. This portion
of the URI path can contain percent-encoded reserved characters. When
wa.server.hp.preserveUriReservedChars is set to true, Integration
Server decodes the percent-encoded characters after evaluating the URI
path, but before invoking the service.
For requests that use the invoke directive, the entire path of the URI after "/
invoke" refers to folders and services in the Integration Server namespace.
Folders and services cannot contain any URI-reserved characters, therefore
any request that uses the invoke directive and contains a percent-encoded
reserved character in its path will never identify an actual Integration
Server service and will always result in an HTTP 404 response.

Note:

If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.

watt.server.http.reauth.user-agent.list
Species a semicolon-delimited list of HTTP clients from which you want Integration
Server to request re-authentication after an HTTP session expires. By default, this
parameter is set to Firefox;MSIE so that requests from the Mozilla Firefox and
Microsoft Internet Explorer browsers will be asked to re-authenticate if the associated
HTTP session has expired. For user agents not specied on this list, Integration Server
sends a new session cookie when the session expires.
If you remove this property and restart Integration Server, the value of this property
resets to Firefox;MSIE.

webMethods Integration Server Administrators Guide Version 9.10

912

Odd Header
Server Configuration Parameters

watt.server.http.returnException
Species whether Integration Server should return a stack trace in the HTTP/SOAP
response it sends to the invoking client when an invoked service ends in error. You can
specify one of the following:
Value

Tells Integration Server...

true

To return a stack trace in the HTTP/SOAP response. This is

the default.

false

Not to return a stack trace.

webMethods

Return a stack trace only if the client's HTTP user agent is

set to webMethods or has the same value as the user agent
specied on the wa.net.userAgent parameter.

watt.server.http.securityRealm
Species the name of the Integration Server security realm. This value is included in
the headers of HTTP responses that Integration Server sends to clients that request
authentication. The default value is Integration Server.
watt.server.http.useAcceptHeader
Species whether Integration Server supports the Accept header eld in an HTTP
request. The Accept header eld species a content type or types the HTTP client will
accept in the HTTP response. The default seing is true. This parameter must be set
to true if you want to use the wa.server.content.type.mappings parameter to map
wildcard content types in the Accept header eld to specic content types.
watt.server.http.x-frame-options
Controls how Integration Server is to handle the X-Frame-Options aribute in response
headers.
Note:

Integration Server includes the X-Frame-Options aribute in the response

header to requests for webpages, as dened in the HTTP Header Field
X-Frame-Options specications. X-Frame-Options is not included in
responses to requests for service invocation, such as those including the
invoke, rest, or soap directives. It is only included in responses to requests
for webpages, such as hps://my-server/MyPackage/my-page.html.

Set this parameter to one of the following values:

Specify...

To indicate that...

SAMEORIGIN

The client's browser is to allow Integration Server pages to

be displayed in an HTML frame only if the frame is on a
page from the same server. This is the default value.

webMethods Integration Server Administrators Guide Version 9.10

913

Even Header
Server Configuration Parameters

Specify...

To indicate that...

ALLOW-FROM
other_origin

The client's browser is to allow Integration Server pages to

be displayed in an HTML frame only if the frame is on a
page from the same server specied by other_origin .

Note:

The value DENY is dened for the X-Frame-Options aribute but is not
allowed for Integration Server. DENY means that the page can never
appear in a frame, regardless of the frame's origin. This would cause
Integration Server Administrator to be unusable. If wa.server.hp.xframe-options is set to DENY, that value is ignored and SAMEORIGIN is
used instead.

If you do not want Integration Server to include the X-Frame-Options aribute in

response headers, remove the value from the wa.server.hp.x-frame-options property.
For example: wa.server.hp.x-frame-options= The property can be set on the Settings >
Extended page of Integration Server Administrator. Changes to this property take eect
immediately; the server does not need to be restarted.
watt.server.http.xmlFormat
Species whether Integration Server parses incoming XML documents automatically or
passes them directly to the service. Use this property to set the default behavior for how
Integration Server should pass XML documents via HTTP. Specify one of the following
values:
Specify...

To indicate that...

bytes

Integration Server passes XML bytes directly to the requested service

without parsing. When this parameter is set to bytes, the XML
appears in the input pipeline of the service as byte array, named
xmlBytes .

enhanced

Integration Server parses the XML automatically using the enhanced

XML parser and passes it to the service as an enhanced node object
named node that implements the org.w3c.dom.Node interface.

node

Integration Server parses the XML automatically using the legacy

XML parser and passes it to the service in a parameter named node of
type com.wm.lang.xml.Node. This is the default behavior.

stream

Integration Server passes XML streams directly to the requested

service without parsing. When this parameter is set to stream, the
XML appears in the input pipeline of the service as an InputStream,
named xmlStream .

If a value for wa.server.hp.xmlFormat is not specied or is invalid, the default XML

parsing behavior is "node".

webMethods Integration Server Administrators Guide Version 9.10

914

Odd Header
Server Configuration Parameters

This feature can be used when submiing and receiving XML via HTTP of HTTPS only.
Note:

The default established by this parameter can be overridden in any

individual client request that uses the xmlFormat argument in the URL.
For more information about the xmlFormat argument, see webMethods
Service Development Help.

Note:

Changing the default xmlFormat for all of Integration Server might

cause existing services and applications to fail. Consider changing the
xmlFormat on a service or application basis instead by using the Default
xmlFormat property for a service. For more information about the Default
xmlFormat property, see webMethods Service Development Help.

watt.server.httplog
Species whether Integration Server should log outbound HTTP/HTTPS
requests to a separate log le. If set to true, Integration Server creates the
Integration Server_directory\instances\instance_name \logs\hp.log le, which logs data
for HTTP/HTTPS requests. The hp.log le is created separately from the data captured
in the server log. The default is false.
Integration Server logs the following in hp.log:
Parameter

Description

CURRENTTIME

Time of the host Integration Server at the time the request is

made.

SIZE-OFRESPONSE

Size of the data (in bytes) in the response. This is either the
current size of the in-memory byte buer or the size of the
input stream.

TIME-TAKEN

Time (in milliseconds) it takes the Integration Server to process

the request. This parameter does not include transport time.

HOSTADDRESS

IP address of the host Integration Server.

REQUESTEDURL

The URL requested by the client.

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.idr.reaperInterval
Species the interval, measured in minutes, at which the scheduled system service
Message History Sweeper executes and removes expired document history entries. The
default is 10 minutes.

webMethods Integration Server Administrators Guide Version 9.10

915

Even Header
Server Configuration Parameters

watt.server.illegalNSChars
Species the characters that you cannot use when naming a package, folder or service.
The default is ?`-#&@^!%*:$.\ /';,~+=)(|}{][><.
watt.server.illegalUserChars
Species characters that you cannot use in user names and passwords. The default is
"\<&.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
Important: Do not remove characters from this property. If you remove characters
and create users that contain those characters, Integration Server cannot
parse users.cnf and will be unable to start.
watt.server.inetaddress
Species the IP address on which the server is to listen for incoming requests. By default,
Integration Server listens on all available IP addresses. To limit the server to listening on
a single IP address, specify the IP address as the value of this property.
watt.server.invokeDirective
Species an alternative word to use for the invoke directive in URLs
that invoke services on Integration Server. By default, this parameter
is set as watt.server.invokeDirective=invoke, which means users
must specify the invoke directive as invoke (http://host:port/
invoke/folder/service_name). To allow users to specify the invoke directive
as either invoke or an alternative word, set this parameter to the alternative
word. For example, to allow users to specify the invoke directive as either
invoke or submit, (http://host:port/invoke/folder/service_name or
http://host:port/submit/folder/service_name), set this parameter as
watt.server.invokeDirective=submit.
watt.server.invoke.maxRetryPeriod
Species the total amount of waiting time (in milliseconds) that can elapse if the
Integration Server makes the maximum aempts to retry a service. The default is 15,000
milliseconds (15 seconds). When conguring retries for an individual service, the value
calculated by multiplying Max attempts value by the Retry interval cannot exceed the value
set by this server parameter. For more information about conguring service retry, see
webMethods Service Development Help.
watt.server.java.unicode
Species whether the source code for Java services is stored in Unicode encoding. The
default is false. Set this value to true if the source code contains characters that cannot
be rendered in the server's native encoding.
watt.server.jca.connectionPool.createConnection.interrupt.waitTime
Species the wait time, measured in milliseconds, that elapses before Integration Server
interrupts a connection creation thread that is in a wait state. There is no default value.

webMethods Integration Server Administrators Guide Version 9.10

916

Odd Header
Server Configuration Parameters

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.jca.connectionPool.thresholdWaitingRequest
When enabled, this property represents the percentage value that is used in addition
to the congured maximum number of connections (set by the Maximum Pool Size
parameter on the Connections page) for the connection pool. For example, seing the
property as watt.server.jca.connectionPool.thresholdWaitingRequest=20 sets
the threshold to 120% of congured maximum number of connections.
If the property is not dened or if the value is less than or equal to zero, the feature
remains disabled.
When this property is enabled, the connection pool ensures that the waiting connection
requests plus the busy connections in the connection pool do not exceed the threshold
limit.
watt.server.jca.transaction.rollbackOnWriteFailure
If Integration Server cannot store the status of a transaction and its participating
resources in the XA recovery store (for example, because the store is corrupted), species
whether Integration Server should try to continue with the transaction anyway (false)
or try to roll it back (true). Seing the parameter to false involves some risk; if
Integration Server ends abnormally, no statuses will have been saved to the XA recovery
store, and Integration Server will not be able to resolve the uncompleted transaction or
give you the chance to resolve it manually.
watt.server.jca.transaction.writeRecoveryRecord
Species whether Integration Server maintains XA transaction information for use with
XA transaction recovery. If Integration Server does not save XA transaction information,
uncompleted XA transactions cannot be recovered using Integration Server. That is,
Integration Server does not aempt to recover incomplete XA transactions automatically
and you cannot use Integration Server Administrator to manually recover or resolve an
incomplete transaction. Specify true to enable XA transaction recovery. Specify false to
disable XA transaction recovery. The default is true.
watt.server.jdbc.datadirect.snoop.default
Species the default seings for the DataDirect Snoop tool for DataDirect Connect JDBC
drivers. The DataDirect Snoop tool logs network packets between Integration Server
and an external RDBMS. The resulting log le can be used for tracing and diagnostic
purposes.
Note:

This option is for use with an external RDBMS only. It is not for use with
the embedded IS internal database.

Set this parameter on each DataDirect Connect JDBC driver for which you want to log
data.
Important: To enable this feature for use with Integration Server, you must select
the Snoop option on either the Edit JDBC Connection Pool Alias screen or
the Create JDBC Connection Pool Alias screen of the Integration Server
Administrator.

webMethods Integration Server Administrators Guide Version 9.10

917

Even Header
Server Configuration Parameters

The default value for this parameter is:

ddtdbg.ProtocolTraceEnable=true;ddtdbg.ProtocolTraceMaxline=16;
ddtdbg.ProtocolTraceLocation=/logs/snoop/<alias_name>.log;
ddtdbg.ProtocolTraceShowTime=true

Where <alias_name> is the name of the JDBC connection pool alias.

Note:

For DB2, include the following command at the end of the value:
ddtdbg.ProtocolTraceEBCDIC=true

The default value denes the name and location of the log le and DataDirect Snoop
tool aributes. Typically, you do not need to change the default value. However, you
can modify the value if the aributes do not meet the needs of your system. If you
change the log le location, be aware that the diagnostic tool collects data from the
Integration Server_directory/instances/instance_name /logs/snoop directory. If you change
the log le location, the diagnostic utility might not import the data logged by the
DataDirect Snoop tool. For more information about using the diagnostic utility, see
"Using the Diagnostic Utility" on page 833. For more information about seing the
DataDirect Snoop tool aributes, consult the documentation on the DataDirect website.
Important: If you change the value of this parameter, you must restart the connection
pool for the changes to take eect.
watt.server.jdbc.datadirect.spy.default
Species the default seings for the DataDirect Spy diagnostic feature for DataDirect
Connect JDBC drivers. DataDirect Spy logs JDBC calls and SQL statement interactions
between Integration Server and an external RDBMS. The resulting log le can be used
for tracing and diagnostic purposes.
Note:

This option is for use with an external RDBMS only. It is not for use with
the embedded IS internal database.

Set this parameter for each DataDirect Connect JDBC driver for which you want to log
data.
Important: To enable this feature for use with Integration Server, you must select the
Spy option on either the Edit JDBC Connection Pool Alias screen or the Create
JDBC Connection Pool Alias screen of the Integration Server Administrator.
The default value for this parameter is:
SpyAttributes=(log=(file)/logs/
spy/<alias_name>.log;logTName=yes;timestamp=yes)

Where <alias_name> is the name of the JDBC connection pool alias.

The default value denes the name and location of the log le and DataDirect Spy
aributes. Typically, you do not need to change the default value. However, you
can modify the value if the aributes do not meet the needs of your system. If you
change the log le location, be aware that the diagnostic tool collects data from the
Integration Server_directory/instances/instance_name /logs/spy directory. If you change the
log le location, the diagnostic utility might not import the data logged by DataDirect
webMethods Integration Server Administrators Guide Version 9.10

918

Odd Header
Server Configuration Parameters

Spy. For more information about the diagnostic utility, see "Using the Diagnostic Utility"
on page 833. For more information about seing DataDirect Spy aributes, consult the
documentation on the DataDirect website.
Important: If you change the seing of this parameter, you must restart the
connection pool for the changes to take eect.
watt.server.jdbc.defaultDriver
For use with WmDB. Species the name of the Java class for the driver you want to use
to connect to databases when no driver name is supplied for a database alias.
watt.server.jdbc.derby.commitTolerance
Species the length of time, in milliseconds, that Integration Server waits for a commit
to the embedded database to complete before removing the associated connection
from the connection pool. Integration Server uses this property when it is congured
to use the embedded database for any of the ISInternal, DocumentHistory, and Xref
functions. If the commit process takes longer than the value dened by this property,
Integration Server removes the associated connection from the connection pool so that a
new connection can be initiated for future requests. The default value for this property is
150 milliseconds.
watt.server.jdbc.driverList
Species a comma-delimited list of JDBC drivers you want the server to load when it
initializes. There is no default.
Note:

This parameter is for use with the WmDB package only.

watt.server.jdbcLogFile
Species the name of the log le that contains JDBC log activity. When
the wa.server.jdbcLogging property is enabled (set to on), the server
logs activity to this le. The default value is jdbc.log. It is located in the
Integration Server_directory\instances\instance_name \logs folder. Note that the log le is
generated after WmDB makes a connection to the database.
Note:

This parameter is for use with the WmDB package only.

watt.server.jdbc.loginTimeout
Sets the maximum time, in seconds, that the JDBC driver on Integration Server is to
wait for a response while aempting to connect to a database. If Integration Server does
not receive a response in the alloed time, it terminates the request, logs the error and
moves on. The default value is 60 seconds.
If Integration Server is unable to connect to the audit logging database within the
number of seconds specied by wa.server.jdbc.loginTimeout, Integration Server
removes all connections from the ISCoreAudit JDBC connection pool and recreates
them. If the connection problem is resolved quickly (such as a momentary network
interruption), Integration Server reconnects to the audit logging database. If Integration
Server is unable to connect to the audit logging database, such as when the database is
oine, Integration Server writes an exception to the server log.

webMethods Integration Server Administrators Guide Version 9.10

919

Even Header
Server Configuration Parameters

Important: If you change the seing of this parameter, you must restart the
ISCoreAudit JDBC connection pool for the changes to take eect. To
restart the pool, in Integration Server Administrator, go to the Settings >
JDBC Pools page and click Restart for the ISCoreAudit functional alias.
watt.server.jdbcLogging
Species whether Integration Server is to enable logging on java.sql.DriverManager in
order to log JDBC activity. When set to on, the server writes the log le data to the le
specied by wa.server.jdbcLogFile. The default is off.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
Note:

This parameter is for use with the WmDB package only.

watt.server.jdbc.moreResults
Species if the Integration Server is to process the stored procedure results from a single
result set or multiple result sets. When set to true, Integration Server processes and
returns information produced by multiple result sets. When set to false, Integration
Server processes information produced from a single result set. The default is false.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
Note:

This parameter is for use with the WmDB package only.

watt.server.jdbc.sp.mandateParams
Species whether the $data input parameter of the pub.db:call service expects values to
invoke a stored procedure through the pub.db:call service. Set this property to false if
you do not want to specify values for the $data input parameter. Set this property to
true if you want the pub.db:call service to expect values for the $data input parameter.
The default is true.
watt.server.jdbc.statementCache
Species whether Integration Server is to cache prepared statements for later use.
When set to true, the server saves prepared statements in a local cache. When the server
receives subsequent requests to a database, it can reuse the prepared statements in the
cache instead of recreating them each time a request is made. To use Java heap space
eciently, the server removes cached statements automatically if it is not reused within
30 seconds. The default is false.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
Note:

This parameter is for use with the WmDB package only.

watt.server.jms.csq.maxRedeliveryCount
Species the number of aempts to redeliver a document from the client side queue.
Specify a positive integer value. The default is 5. If Integration Server is unable to deliver
webMethods Integration Server Administrators Guide Version 9.10

920

Odd Header
Server Configuration Parameters

the document in the congured number of aempts, the document is dropped from
the client side queue and not delivered. In this situation, Integration Server raises a
JMSDeliveryFailureEvent.
Note:

Specifying a large value for this property can impact Integration Server
performance if the failure to deliver the document is not a transient error,
such as the Broker being unavailable. If the reason a document cannot be
delivered is because there is problem with the document itself, Integration
Server performance is impacted because it will continue to aempt to
redeliver the document for the number of times you congure.

watt.server.jms.connection.monitorPeriod
Species the frequency (measured in seconds) with which Integration Server checks the
state of a connection to the JMS provider. The minimum is 1 second. If this parameter
is set to less than 1, Integration Server uses the default value instead. The default is 45
seconds.
watt.server.jms.connection.pingDestination
Congures Integration Server to send a keep-alive message to a destination on the JMS
provider, thereby preventing the rewall from terminating the connection between
Integration Server and a third-party JMS provider. A keep-alive message is a blank, nonpersistent JMS message with an immediate time out.
Set this parameter to one of the following values:
Specify...

To...

blank

Aempt to create a JMS session using the connection between

Integration Server and the JMS provider. This is the default.

temp

Create a temporary queue on the JMS provider and send

a keep-alive message to the temporary queue. Temp is not
case-sensitive.

<destinationName> Send a keep-alive message to the specied destination on the

JMS provider. If the specied destination does not exist on

the JMS provider, Integration Server periodically aempts
to create a JMS session using the connection between
Integration Server and the JMS provider.

Note:

The frequency with which Integration Server sends a keep-alive message is

determined by the value of wa.server.jms.connection.pingPeriod.

watt.server.jms.connection.pingPeriod
Species how often, measured in seconds, Integration Server should ping the JMS
provider. The ping serves as a keep alive request sent to the JMS provider. The default is
300 seconds (5 minutes).

webMethods Integration Server Administrators Guide Version 9.10

921

Even Header
Server Configuration Parameters

watt.server.jms.connection.retryPeriod
Species the length of time, in seconds, that Integration Server waits between connection
aempts when a connection to the JMS provider or JNDI provider fails. The default is 20
seconds.
watt.server.jms.connection.update.blockingTime
Species the maximum amount of time, measured in milliseconds, that a pub.jms* service
will wait for a connection while the connection used by the service is being updated.
If Integration Server does not restart the connection before the blocking time elapses,
Integration Server throws an ISRuntimeException and the sending service fails. A value
of 0 (zero) indicates that Integration Server does not block the pub.jms* services while
the JMS connection alias updates; Integration Server throws an ISRuntimeException
immediately. The maximum value is 10,000 milliseconds (10 seconds). The default is
1000 milliseconds.
Integration Server resets the wa.server.jms.connection.update.blockingTime parameter
to the default value if an invalid value is entered.
Important: You must restart Integration Server for the new value to take eect.
watt.server.jms.connection.update.restartDelay
Species the length of time, measured in milliseconds, Integration Server waits for
services sending JMS messages to execute to completion when the connection used
by the services needs to be updated. After the restart delay elapses, Integration
Server refreshes the connection using the updated connection factory object and then
restarts the connection. If the restart delay elapses before the pub.jms*services execute
to completion, Integration Server throws an ISRuntimeException and the sending
service fails. The maximum value is 10,000 milliseconds (10 seconds). The default is 500
milliseconds.
Integration Server resets the wa.server.jms.connection.update.restartDelay parameter
to the default value if an invalid value is entered.
Important: You must restart Integration Server for the new value to take eect.
watt.server.jms.csq.batchProcessingSize
Species the maximum number of messages Integration Server retrieves from the client
side queue and then sends to the JMS provider. Integration Server places sent messages
in the client side queue when the connection to the JMS provider fails. Integration Server
begins to drain the client side queue after the connection to the JMS provider becomes
available. The default is 25.
watt.server.jms.debugTrace
Enables an extra level of verbose logging for JMS triggers that can be controlled globally
or at the individual JMS trigger level.
To enable debugTrace logging for all JMS triggers, set the
wa.server.jms.debugTrace property to true. For this seing to take eect, you
need to disable and then enable all JMS triggers. For information about using

webMethods Integration Server Administrators Guide Version 9.10

922

Odd Header
Server Configuration Parameters

Integration Server Administrator to enable and disable all JMS triggers, see
"Enabling, Disabling, and Suspending JMS Triggers" on page 782.
To enable debugTrace logging for an specic JMS trigger, append the fully
qualied JMS trigger name to the wa.server.jms.debugTrace property and
set that property to true. For example, to enable debugTrace logging for the
JMS trigger named myFolder:myJMSTrigger, enter the following on the Edit
Extended Seings page:
wa.server.jms.debugTrace.myFolder:myJMSTrigger=true
For this seing to take eect, you need to disable and then enable the JMS
trigger specied in the property. For information about using Integration
Server Administrator to disable and enable an individual trigger, see "Enabling,
Disabling, and Suspending JMS Triggers" on page 782.
watt.server.jms.guaranteedMultisend.alwaysUseTxLogging
Species whether or not Integration Server always uses XA transaction logging when
sending a JMS message in accordance with a multisend guaranteed policy. In XA
transaction logging, Integration Server logs the state of each transaction. The XA
transaction logging allows Integration Server to recover any transactions that did not
complete due to Integration Server failure. While this is the most reliable way to ensure
the integrity of a transaction, it may be expensive in terms of performance and may
not always be necessary. When this property is set to true, Integration Server always
uses XA transaction logging and can perform XA transaction recovery for a multisend
guaranteed policy regardless of the connection transaction type When set to false,
Integration Server uses XA transaction logging only if the connection transaction type is
XA_TRANSACTION. The default is false.
watt.server.jms.nirvana.durableSubscriber.includeClientId
Species whether the client ID of the JMS connection alias will be used as the prex in
the names of durable subscribers created using Designer. Set to true to use the value of
the Client ID property in the JMS connection alias as a prex in the durable subscriber
name. Even if the wa.server.jms.nirvana.durableSubscriber.includeClientId is set to
true, if the Client ID property is empty the durable subscriber name will not have a client
ID prex. Set to false to omit the use of the client ID as a prex. The default is true.
watt.server.jms.producer.pooledSession.timeout
Species the number of milliseconds for which an inactive entry remains in the default
session pool or a destination-specic pool before Integration Server removes the entry.
Integration Server uses this value when -1 is specied for the Idle Timeout eld for a JMS
connection alias. The default is 60000.
watt.server.jms.trigger.concurrent.consecutiveMessageThreshold
Species the consecutive number of successful requests for more messages that a
concurrent JMS trigger must make before the trigger becomes multithreaded. For
example, when this property is set to 1000, Integration Serverbegins using multiple
threads for a concurrent JMS trigger when the JMS trigger retrieves messages fro the
JMS provider in 1000 consecutive requests. The default for this property is 0, which
indicates that Integration Server does not use a threshold to determine when JMS trigger
become multithreaded. When threshold is not used, the concurrent JMS trigger will

webMethods Integration Server Administrators Guide Version 9.10

923

Even Header
Server Configuration Parameters

always be multithreaded when more than one message is available for processing.
For more information about using a threshold for thread usage for a concurrent JMS
trigger, see "Establishing a Threshold for Using Multiple Threads with a Concurrent JMS
Trigger" on page 787.
Note:

The threshold for using multiple threads with concurrent JMS triggers
applies to all the concurrent JMS triggers on the Integration Server. This
includes standard JMS triggers, SOAP-JMS triggers, and WS-Endpoint
triggers.

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.jms.trigger.concurrent.primaryThread.pollingInterval
Species the lengthy of time (in milliseconds) for which the primary sever thread for a
concurrent JMS trigger polls the JMS provider for more messages. Each concurrent JMS
trigger has a server thread that retrieves messages from the JMS provider. This thread
is considered to be the primary thread for the concurrent JMS trigger. A short polling
interval increases the amount of CPU used by Integration Server and increases the load
on the JMS provider. However, a short polling interval can improve performance under
heavy load and in request-reply scenarios. The default is 500 milliseconds.
If a value of 0 is specied, Integration Server uses the
javax.jms.MessageConsumer.receiveNoWait() API to retrieve messages
from the JMS provider. The javax.jms.MessageConsumer.receiveNoWait()
API may or may not be supported by all JMS providers. If the JMS provider
from which a JMS trigger receives messages does not support this API
then the JMS trigger will be disabled. If this happens, modify the value of
wa.server.jms.trigger.concurrent.primaryThread.pollingInterval to be a positive
integer. and enable the JMS trigger.
Note:

The default value of 500 milliseconds is not optimal when

connecting to Universal Messaging. To improve performance when
Universal Messaging is the JMS provider, Integration Server uses
a minimum primary polling interval of 3000 milliseconds. If the
wa.server.jms.trigger.concurrent.primaryThread.pollingInterval property
is set to a value greater than 3000, Integration Server uses the property
value for connections to Universal Messaging.

Note:

A longer polling interval may aect the performance of JMS triggers

with joins because the JMS trigger must retrieve messages from multiple
destinations. If one of the destinations from which a JMS trigger retrieves
messages is empty, there will be a delay each time the JMS trigger requests
a message from the destination. This can impact overall performance.

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.

webMethods Integration Server Administrators Guide Version 9.10

924

Odd Header
Server Configuration Parameters

watt.server.jms.trigger.concurrent.secondaryThread.pollingInterval
Species the lengthy of time (in milliseconds) with which the secondary server threads
for a concurrent JMS trigger poll the JMS provider for more messages. The secondary
server threads are the additional threads that can be used to retrieve messages for a
concurrent JMS trigger. The number of secondary server threads for a concurrent JMS
trigger corresponds to the value Max execution threads property value minus 1. A short
polling interval increases the amount of CPU used by Integration Server and increases
the load on the JMS provider. A long polling interval can impact the time required for
Integration Server to shut down as Integration Server must wait for the polling interval
to elapse for each secondary thread used by concurrent JMS triggers. The default value
is 1 millisecond.
The value of wa.server.jms.trigger.concurrent.secondaryThread.pollingInterval must be
less than or equal to the value of
wa.server.jms.trigger.concurrent.primaryThread.pollingInterval.
If a value of 0 is specied, Integration Server uses the
javax.jms.MessageConsumer.receiveNoWait() API to retrieve messages
from the JMS provider. The javax.jms.MessageConsumer.receiveNoWait()
API may or may not be supported by all JMS providers. If the JMS provider
from which a JMS trigger receives messages does not support this API then
you may see unexpected behavior. If this happens, modify the value of
wa.server.jms.trigger.concurrent.secondaryThread.pollingInterval to be a positive
integer.
Note:

The default value of 1 millisecond is not optimal when connecting

to Universal Messaging. To improve performance, when Universal
Messaging is the JMS provider, Integration Server uses a minimum
secondary polling interval. If the JMS trigger that receives messages from
Universal Messaging uses a join, Integration Server uses a minimum
secondary polling interval of 10 milliseconds. If the JMS trigger does not
use a join, Integration Server uses a minimum secondary polling interval
of 3000 milliseconds. If the congured value is greater than the minimum,
Integration Server uses the congured value instead.

Note:

A longer polling interval aects the performance of JMS triggers with

joins because the JMS trigger must retrieve messages from multiple
destinations. If one of the destinations from which a JMS trigger retrieves
messages is empty, there will be a delay each time the JMS trigger requests
a message from the destination. This can impact overall performance.

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.jms.trigger.extendedDelay.delayIncrementInterval
Species the time interval, measured in milliseconds, at which Integration Server
introduces the polling delay for an inactive concurrent JMS trigger. If the JMS trigger
remains inactive, the same time interval determines when Integration Server increases
the extended delay. The default value is 0 which indicates that Integration Server

webMethods Integration Server Administrators Guide Version 9.10

925

Even Header
Server Configuration Parameters

does not use an extended polling delay for inactive concurrent JMS triggers. For
more information about delaying polling requests, see "Delaying Polling Requests for
Concurrent JMS Triggers" on page 789.
Important: You must restart Integration Server for the new value to take eect.
watt.server.jms.trigger.extendedDelay.delays
Species the length of the delay that an inactive concurrent JMS trigger waits before
polling the JMS provider for more messages. To increase the delay while the JMS
trigger remains inactive, specify a comma-separated list of increasing integers. The
wa.server.jms.trigger.extendedDelay.delays parameter is measured in milliseconds and
has a default value of: 0, 1000, 2000, 3000.
For more information about delaying polling requests, see "Delaying Polling Requests
for Concurrent JMS Triggers" on page 789.
Important: You must restart Integration Server for the new value to take eect.
watt.server.jms.trigger.maxDeliveryCount
Species the maximum number of times the JMS provider can deliver a message to
Integration Server. The default is 100.
watt.server.jms.trigger.maxPrefetchSize
Species the maximum number of messages that the webMethods Broker API for JMS
will retrieve and cache per request for a JMS trigger. Using pre-fetch cache can speed
up the retrieval of messages from the webMethods Broker. Because messages will be
placed in Integration Server memory, you may want to decrease this seing if you have
JMS triggers receiving very large messages. Otherwise, memory issues can occur. This
property only applies to JMS triggers receiving messages from the webMethods Broker.
The default is 10 messages.
Integration Server checks this value when a JMS trigger starts. To apply a new value to
all JMS triggers, use Integration Server Administrator to disable and then enable JMS
triggers. For information about using Integration Server Administrator to disable and
enable an individual trigger, see "Managing JMS Triggers" on page 781.
This property only takes eect when the trigger's prefetch property is set to -1.
When working in a cluster of Integration Servers, the behavior controlled by this
property might appear at rst to be misleading. For example, suppose that you have a
cluster of two Integration Servers. Each Integration Server contains the same JMS trigger.
Twenty messages are sent to a destination from which JMS trigger receives messages. It
might be expected the JMS trigger on Integration Server 1 will receive the rst message,
the JMS trigger on Integration Server 1 will receive the second message, and so forth.
However, what may happen is that the JMS trigger on Integration Server 1 will receive
the rst 10 messages and the JMS trigger on Integration Server 2 will receive the second
10 messages.
watt.server.jms.trigger.monitoringInterval
Species the interval, measured in seconds, at which Integration Server executes
resource monitoring services for JMS triggers. A resource monitoring service is a service
that you create to check the availability of resources used by a JMS trigger service.

webMethods Integration Server Administrators Guide Version 9.10

926

Odd Header
Server Configuration Parameters

After Integration Server suspends a JMS trigger because all retry aempts have failed,
it schedules a system task to execute the resource monitoring service assigned to the
JMS trigger. The default is 60 seconds. Changes to this property take eect the next time
Integration Server schedules a system task to execute a resource monitoring service for a
JMS trigger.
For more information about building resource monitoring services for JMS triggers, see
Using webMethods Integration Server to Build a Client for JMS.
watt.server.jms.trigger.pollingSession.timeout
Species the frequency (measured in minutes) with which Integration Server refreshes
an inactive connection for a JMS trigger. A JMS trigger session is considered to be
inactive when the JMS trigger does not use the session to retrieve messages. The default
is 30 minutes.
watt.server.jms.trigger.pooledConsumer.timeout
Species the length of time, in milliseconds, that an inactive pooled consumer remains
in the consumer pool before it is removed. Integration Server uses a pool of consumers
to retrieve and process messages for concurrent JMS triggers. When the timeout value
elapses, Integration Server deletes the inactive pooled consumer. For the Integration
Server to retrieve more messages for the concurrent JMS trigger, Integration Server
must create a new consumer, which entails creating a javax.jms.MessageConsumer and
javax.jms.Session. For some JMS providers, this can be an expensive operation. Seing a
high value for wa.server.jms.trigger.pooledConsumer.timeout server property results
in the JMS session and messageConsumer remaining open for a long period of time. If
the load on Integration Server is high, a long timeout value reduces the frequency with
which the pooled consumers must be created. However, when the timeout value is high
and the load on Integration Server is low there may be unused pooled consumers.There
is no default timeout value.
watt.server.jms.trigger.raiseEventOnException
Indicates whether Integration Server generates a JMS retrieval failure event when a JMS
trigger experiences a fatal exception, such as a non-transient error or a message that
cannot be reprocessed, during message processing. Specify true if you want Integration
Server to generate a JMS retrieval failure event. The default is true.
watt.server.jms.trigger.raiseEventOnRetryFailure
Indicates that Integration Server generates a JMS retrieval failure event when a JMS
trigger experiences a retry failure. A retry failure can occur when the JMS provider
has reached the max delivery count for a message or when an ISRuntimeException
is thrown and the JMS trigger is not congured to recover the message (for example,
if retry failure handling for a non-transacted JMS trigger is set to "Throw exception"
instead of "Suspend and Retry Later".) When set to true, Integration Server generates
a JMS retrieval failure event for a JMS trigger when retry failure occurs. The default is
true.
watt.server.jms.trigger.retryOnConsumerError
Determines whether or not Integration Server aempts to re-enable JMS triggers
automatically when an error unrelated to the connection to the JMS provider causes the
JMS trigger to be disabled. Set wa.server.jms.trigger.retryOnConsumerError to true
to instruct Integration Server to re-enable JMS triggers automatically. Set the property

webMethods Integration Server Administrators Guide Version 9.10

927

Even Header
Server Configuration Parameters

to false to instruct Integration Server to leave JMS triggers disabled when the message
consumer encounters an unexpected error unrelated to the connection to the JMS
provider. The default is true.
watt.server.jms.trigger.reuseJmsTxSession
Species whether or not sessions can be reused across multiple transactions for a
transacted JMS trigger. When set to true, a transacted JMS trigger will reuse the same
JMS session for receiving messages from the JMS provider. When set to false, Integration
Server creates and closes a session for each message a transacted JMS trigger receives
and processes. The default value is true.
Some JMS providers might not support the use of a single session across
multiple transactions. When working with these JMS providers, set
wa.server.jms.trigger.reuseJmsTxSession to false.
Important: You must restart Integration Server for the new value to take eect.
watt.server.jms.trigger.reuseSession
Indicates whether instances of a JMS trigger use the same session on Integration Server.
When this property is set to true, the JMS trigger uses a shared session. Each of the
trigger services executed by the JMS trigger will use the same session ID. When this
property is set to false, Integration Server uses a new session for each instance of a JMS
trigger. Reusing sessions for a JMS trigger might improve performance. However, this
property does not work with all adapters. If you are working with an adapter, such as
the SAP adapter, that requires the session ID to be unique, set this property to false. The
default is false.
watt.server.jms.trigger.serial.primaryThread.pollingInterval
Species the length of time (in milliseconds) for which the server thread for a serial
JMS trigger polls the JMS provider for messages. A short polling interval increases the
amount of CPU used by Integration Server and increases the load on the JMS provider.
However, shorter polling intervals can improve performance under heavy load and in
request-reply scenarios. The default is 500 milliseconds.
If a value of 0 is specied, Integration Server uses the
javax.jms.MessageConsumer.receiveNoWait() API to retrieve messages
from the JMS provider. The javax.jms.MessageConsumer.receiveNoWait()
API may or may not be supported by all JMS providers. If the JMS provider
from which a JMS trigger receives messages does not support this API
then the JMS trigger will be disabled. If this happens, modify the value of
wa.server.jms.trigger.serial.primaryThread.pollingInterval to be a positive integer and
then enable the JMS trigger.
Note:

The default value of 500 milliseconds is not optimal when connecting to

Universal Messaging. To improve performance when Universal Messaging
is the JMS provider, Integration Server uses a minimum primary polling
interval of 3000 milliseconds. If the trigger uses a join, Integration Server
uses a secondary polling interval which is set to 10 milliseconds. Note that
the secondary polling interval is not congurable for a serial JMS trigger

webMethods Integration Server Administrators Guide Version 9.10

928

Odd Header
Server Configuration Parameters

Note:

A longer polling interval aects the performance of JMS triggers with

joins because the JMS trigger must retrieve messages from multiple
destinations. If one of the destinations from which a JMS trigger retrieves
messages is empty, there will be a delay each time the JMS trigger requests
a message from the destination. This can impact overall performance.

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.jms.trigger.stopRequestTimeout
Species the maximum amount of time, measured in seconds that Integration Server
waits after a JMS trigger is disabled before forcing the JMS trigger to stop processing
messages. The minimum value is 0. The default is 3 seconds.
Note:

If you set wa.server.jms.trigger.stopRequestTimeout to 0, the JMS

trigger immediately stops processing messages after a JMS trigger is
disabled. In this case, Integration Server stops the trigger immediately
and does not wait for any processing to complete. This can result in a
javax.jms.IllegalStateException.

You can disable a JMS trigger by invoking the pub.trigger:disableJMSTrigger service or by

using or via the Settings > Messaging > JMS Trigger Management screens in Integration
Server Administrator. For information about disabling JMS triggers, see "Enabling,
Disabling, and Suspending JMS Triggers" on page 782.
When you save a JMS trigger in Designer, Integration Server stops and then restarts
the trigger. In this situation, Integration Server waits 3 seconds before forcing the JMS
trigger to stop processing messages. This value cannot be congured.
Note:

when a JMS trigger is disabled while it is processing messages,

Important: You must restart Integration Server for the new value to take eect.
watt.server.jms.trigger.wmjms.clientIDSharing
Indicates that Integration Server aempts to receive messages from durable subscribers
in a load-balanced fashion. When set to true, Integration Server does the following:
If the durable subscriber specied by the JMS trigger does not exist, Integration
Server creates the durable subscriber on the Broker and enables state sharing.
Integration Server also uses the message processing mode to set the Shared State
Order mode for the durable subscriber. (A message processing mode of serial
maps to a shared state order mode of publisher, a message processing mode of
concurrent maps to a shared state order mode of none.)
If the durable subscriber already exists, Integration Server does not make any
changes to the durable subscriber when it saves the JMS trigger.
Indicates to the Broker that client identiers can be shared by seing the
com.webmethods.jms.clientIDSharing property within Integration Server to true.

webMethods Integration Server Administrators Guide Version 9.10

929

Even Header
Server Configuration Parameters

This property only applies when the JMS trigger uses a JMS connection alias that
connects to the webMethods Broker using the native webMethods API.
The default is true.
Important: You must restart Integration Server for a new value to take eect.
watt.server.jms.wmjms.lms.readTimeout
Species the amount of time (measured in milliseconds) that Integration Server waits
for the next portion of an input stream before throwing WmReadTimeoutException. The
read timeout only applies after Integration Server retrieves the initial piece of the input
stream. The default is 30000 milliseconds.
watt.server.jndi.searchresult.maxlimit
Species the maximum number of records that Integration Server displays when
searching for users or groups in the LDAP or central directory and no search criteria
are specied. The default is 0. When set to 0, Integration Server displays all available
records.
watt.server.json.allowUnquotedFieldNames
The JSON standard requires that eld names be enclosed in double quotes. However,
when parsing legacy JavaScript as JSON text it may be helpful to allow unquoted eld
names as JavaScript does not require eld names to be enclosed in double quotes. If this
parameter is set to true, the pub.json:jsonStringToDocument and pub.json:jsonStreamToDocument
services allow unquoted eld names in any supplied JSON text. If this parameter is
set to false, the services throw a ServiceException when encountering unquoted eld
names. The default is false.

The wa.server.json.allowUnquotedFieldNames parameter also

aects the process of creating document types from a JSON text. If
wa.server.json.allowUnquotedFieldNames is set to true and a JSON text with
unquoted elds is used as the source for a document type, the resulting document
type contains elds that correspond to the unquoted elds as well as the quoted elds.
When wa.server.json.allowUnquotedFieldNames is set to false and a JSON text with
unquoted elds is used as the source for a document type, Designer throws an exception
and does not create the document type.
Important: You must restart Integration Server for a new value to take eect.
watt.server.json.decodeIntegerAsLong
Converts an integer that Integration Server retrieves from JSON content to either a
Long or Integer Java wrapper type. If this parameter is set to true, Integration Server
converts the JSON integer to a Long Java wrapper type. If this parameter is set to false,
Integration Server converts the JSON integer to a Integer Java wrapper type. The default
is true (Long).
watt.server.json.decodeRealAsDouble
Converts a real number that Integration Server retrieves from JSON content to either
a Float or Double Java wrapper type. If this parameter is set to true, Integration Server
converts the real number to a Double Java wrapper type. If this parameter is set to

webMethods Integration Server Administrators Guide Version 9.10

930

Odd Header
Server Configuration Parameters

false, Integration Server converts the real number to a Float Java wrapper type. The
default is true (Double).

watt.server.json.optimizeForUniqueKeys
Controls how Integration Server parses JSON documents based on whether the
documents have unique keys or duplicate keys. Integration Server can parse JSON
documents faster when you set this parameter based on the nature of the documents
you expect to receive. If you expect to process JSON documents that have unique keys or
only a few duplicate keys, set this property to true (the default). If you expect to process
JSON documents that have a lot of duplicate keys, set this property to false.
Note:

You must restart Integration Server for changes to go into eect.

watt.server.json.prettyPrint
Species whether the output of JSONCoder.encode() is formaed with carriage returns
and indentation to make the output easier to read. When Integration Server responds
to a client request with JSON content, the format of that response is controlled by this
property. If this parameter is set to true, Integration Server encodes JSON with carriage
returns and indentation to ease readability. The default is false. For more information
about JSONCoder, see webMethods Integration Server Java API Reference.
You can override this seing in individual requests that use the invoke or rest directives
by including a query parameter of jsonPrettyPrint=true or jsonPrettyPrint=false
in the URL used to invoke a service.
Note:

You cannot override this seing when using other directives, such as soap
or ws.

You can also set wa.server.json.preyPrint to specify whether the

pub.json:documentToJSONString service uses prey print formaing in the jsonString output
parameter. For more information about pub.json:documentToJSONString, see the webMethods
Integration Server Built-In Services Reference.
watt.server.json.quoteFieldNames
Species whether or not the pub.json:documentToJSONString service encloses all generated
JSON eld names in double quotes. The JSON standard requires that eld names be
enclosed in double quotes. However, you may need the service to produce unquoted
eld names if the generated JSON text will be processed by an older JavaScript
interpreter. Set this parameter to true instruct the pub.json:documentToJSONString service
to enclose eld names in quotes in the output JSON text. Set this parameter to false to
instruct the service to omit the double quotes around eld names in the generated JSON
text. The default is true.
Note:

Use caution when seing wa.server.json.quoteFieldNames to false as this

causes the pub.json:documentToJSONString service to generate non-standard
JSON text. This can cause interoperability issues if the JSON text is sent to
other organizations.

Note:

You must restart Integration Server for changes to take eect.

webMethods Integration Server Administrators Guide Version 9.10

931

Even Header
Server Configuration Parameters

watt.server.key
Species the license key for the server. There is no default.
watt.server.ldap.cleanContext
Species whether Integration Server should close the TCP/IP connection and clean
the LDAP context (the connectionHandle object) after processing a pub.client.ldap service
request. When this property is set to true, Integration Server closes the connection
and cleans the underlying LDAP context; Integration Server does not return the LDAP
context to the pipeline. When this property is set to false (the default), Integration
Server does not close the connection and returns the LDAP context to the pipeline.
For more information about the pub.client.ldap services, see webMethods Integration Server
Built-In Services Reference.
watt.server.ldap.DNescapeChars
Species the characters Integration Server can escape (using the \ character) in
distinguished names presented to an LDAP server. By default, this property is set to
null, meaning no characters are escaped.
Use this parameter if the distinguished names you are using include special characters
that Integration Server needs to escape. For example, if your LDAP server maintains
userids such as abc/def, specify the following:
watt.server.ldap.DNescapeChars = /

If you need to escape the \ character, specify it twice:

watt.server.ldap.DNescapeChars = \\

watt.server.ldap.DNescapePairs
Species the characters in LDAP distinguished names that Integration Server should
not double-escape prior to their presentation to an LDAP server. To escape special
characters in a distinguished name, you must precede the character with a backslash
(\). By default, the following characters are never double-escaped, and should not be
specied in wa.server.ldap.DNescapePairs:
,=+<>#;/\
If the distinguished names in your LDAP server contain special characters other than
those specied above, add them to wa.server.ldap.DNescapePairs so that Integration
Server does not double-escape the characters. For example, do not add an equal sign
(=) to wa.server.ldap.DNescapePairs, since this is never double-escaped by default.
However, if the LDAP distinguished name contains an ampersand (&) and it should
be double-escaped, add an ampersand character to wa.server.ldap.DNescapePairs as
follows:
watt.server.ldap.DNescapePairs=&

This property has no default value. If no value is supplied, no special characters beyond
the set listed above are protected from double-escape. This property is not dynamic.
Changes to its value go into eect after Integration Server is restarted.
watt.server.ldap.DNescapeURL
Indicates whether Integration Server should ignore the rst three forward slashes (/)
in domain names, or to treat them as escape characters. If set to false (the default),
Integration Server ignores the rst three slashes in a domain name. Integration

webMethods Integration Server Administrators Guide Version 9.10

932

Odd Header
Server Configuration Parameters

Server treats the slashes as part of the domain name, not as escape characters,
regardless of the escape characters dened in the wa.server.ldap.DNescapeChars and
wa.server.ldap.DNescapePairs server conguration parameters.
If set to true, Integration Server treats the forward slashes as escape characters and
escapes domain names in accordance to the seings of wa.server.ldap.DNescapeChars
and wa.server.ldap.DNescapePairs.
Important: You must restart Integration Server after you modify the value of this
property.
watt.server.ldap.DNstripQuotes
Species whether Integration Server should strip leading and trailing quotes from
domain names presented to an LDAP server. When set to true (the default), Integration
Server strips the quotes from domain names that contain special characters.
Note:

If wa.server.ldap.DNstripQuotes is set to false, Integration Server

retains the quotes in the domain names that have them. This could cause
lookups to break.

Important: You must restart Integration Server after you modify the value of this
property.
watt.server.ldap.doNotBind
Species whether the Integration Server authenticates against the LDAP server. If your
Integration Server uses a custom authentication module and you do not require users
to be authenticated against the LDAP directory, set this property to true to prevent
unnecessary requests to the LDAP server. The default is false.
watt.server.ldap.extendedMessages
Controls whether the Integration Server displays additional information returned from
the LDAP server when an authentication error occurs. This information is available only
if the LDAP server provides it. Active Directory is an LDAP server that provides this
additional information. The default is false.
When set to false, an error message might look like this:

2005-03-08 15:40:33 EST [ISS.0002.0035E] Invalid credentials connecting to

ldap://10.3.33.203:389/dc=KQA,dc=webMethods,dc=com as
CN=bob,OU=ISUsers,DC=KQA,DC=WEBMETHODS,DC=COM

When set to true, the same error would be displayed like this:

2005-03-08 15:40:33 EST [ISS.0002.0035E] Invalid credentials connecting to

ldap://10.3.33.203:389/dc=KQA,dc=webMethods,dc=com as
CN=bob,OU=ISUsers,DC=KQA,DC=WEBMETHODS,DC=COM: [LDAP: error code 49 80090308: LdapErr: DSID-0C09030F, comment: AcceptSecurityContext error,
data 52e, vece]

For Active Directory users, the data code (data 52e above) contains the reason the
authentication failed. You can convert the code to decimal and look it up on hp://
msdn.microsoft.com/library/en-us/debug/base/system_error_codes.asp to determine the
problem.

webMethods Integration Server Administrators Guide Version 9.10

933

Even Header
Server Configuration Parameters

watt.server.ldap.extendedProps
Species LDAP environment properties that the Integration Server will pass directly to
an LDAP implementation when initializing a JNDI context. It takes this form:
For example, if you are using a specialized JNDI provider other than the default, or if
your LDAP directory requires a special JNDI property to be passed into the environment
when a context is created, you could set the property customProperty to customValue:
watt.server.ldap.extendedProps=java.naming.customProperty=customValue

There is no default.

watt.server.ldap.memberInfoInGroups
Controls where Integration Server looks for LDAP group membership information.
When set to true, the default, the Integration Server looks for group membership
information in the group object. When set to false, the Integration Server looks for
group membership information in the user object.
watt.server.ldap.retryCount
Species how many times Integration Server should automatically try to reconnect to
an LDAP server after a network outage or LDAP server restart. If set to 0, the default,
Integration Server will prompt the LDAP user for credentials rather than retrying the
connection. If set to a positive integer, Integration Server will retry the connection the
number of times specied. The default is 0.
watt.server.ldap.retryWait
Species how long Integration Server should wait before trying to reconnect to an LDAP
server after a network outage or LDAP server restart. When set to 0, if there is a transient
failure while communicating with LDAP, Integration Server will not try to reconnect to
the LDAP server. If set to a positive integer, Integration Server will retry the connection
the number of times specied in watt.server.ldap.retryCount and will wait the
amount of time specied in watt.server.ldap.retryWait between retry aempts. The
default is 0.
watt.server.licenses
Species the number of licenses. The default is 1.
watt.server.log.alertMaxEntries
Species the number of entries that you can display in the Logs > logName page beyond
which Integration Server Administrator displays an alert message. If the value entered
in the Number of entries to display eld in the Logs > logName page is more than the value
specied for wa.server.log.alertMaxEntries, Integration Server Administrator displays
a message informing that the number of requested entries exceeds the threshold and
that displaying more entries might aect Integration Server performance. If no value is
specied for wa.server.log.alertMaxEntries, Integration Server Administrator does not
display any alert message.
watt.server.log.maxEntries
Species the default number of log entries to be displayed in the log viewing utility. The
default is 35 entries (the most recent entries). For complete information, see "Changing
the Display Permanently for All Logs" on page 226.

webMethods Integration Server Administrators Guide Version 9.10

934

Odd Header
Server Configuration Parameters

watt.server.log.orphanLoggers
Species the orphan loggers that you want to be adopted by the IS logging hierarchy.
Some Integration Server logs become lled with debug messages even though the
logging level is set to be higher than debug. This can happen when Integration Server
has orphan loggers (loggers that are not part of the IS logging tree hierarchy) and
a custom application congures the root logger of log4j. If there is not a custom
conguration of log4j, the orphan loggers will inherit the logging levels specied in the
IS logging tree hierarchy. However, if a custom application recongures the root logger
in the log4j conguration le, the orphaned loggers inherit the logging level from the
root logger. Consequently, if the log4j.rootLogger is set to DEBUG, the orphaned loggers
will log at the Debug level.Use this parameter to prevent orphan loggers from logging at
the modied log4j.rootLogger level. Use a comma to separate multiple orphan loggers.
For example:
watt.server.log.orphanLoggers=WEBMETHODS.DEFAULT,log4j.logger.com.softwareag
.wsstack,log4j.logger.com.softwareag.security,Debug.com.webmethods.lwq,com
.webmethods.jms.db.DbJMSClient

This is the default value.

watt.server.log.queued
Species whether the server is to queue log entries wrien by its facilities in memory,
then use a background thread to write them to the server log. The default is true (queue
log entries). For complete information, see the webMethods Audit Logging Guide.
watt.server.log.refreshInterval
Species the length of time (in seconds) that Integration Server Administrator refreshes
the displayed server log. The default is 90 seconds. For complete information, see
"Changing the Display Permanently for All Logs" on page 226.
watt.server.logEncoding
Species the encoding that Integration Server uses for reading and writing text to the log
les or to the console. The default is UTF-8.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.logRotateInterval
Species the length of the log recycle interval (in milliseconds) for log entries. Starting
with Integration Server 9.7, this server conguration parameter has been renamed
wa.server.statsLogRotateInterval.
The wa.server.logRotateInterval parameter was removed from Integration Server after
8.2 SP2. When it was reintroduced for the following xes, the scope of the parameter
changed so that it aected only the stats.log:
IS_9.0_SP1_Core_Fix6
IS_9.5_SP1_Core_Fix3
IS_9.6_Core_Fix2
If you migrate from Integration Server 9.6 or earlier to Integration Server 9.7, Integration
Server:

webMethods Integration Server Administrators Guide Version 9.10

935

Even Header
Server Configuration Parameters

Changes the name of the server conguration parameter in server.cnf from

wa.server.logRotateInterval to wa.server.statsLogRotateInterval
Converts the value of the server conguration parameter from milliseconds to
minutes
Uses wa.server.statsLogRotateInterval to set the log recycle interval for the
stats.log le
watt.server.loginFailureLimit
Species the number of times a user can supply the wrong login credentials before
Integration Server alerts the administrator and resets the count of login failures to
0. For example, if wa.server.loginFailureLimit is set to 5, when a user supplies the
wrong login credentials for the sixth time, Integration Server sends an email alert to the
administrator and resets the count of login failures to 0. The default value is 5.
watt.server.login.userFtpDir
Species whether the user who has connected to Integration Server through an FTP
listener is to be placed in the default FTP root directory or the client user directory.
When this property is set to false (or not specied), the user is logged into the FTP root
directory. The user must then issue the cd command to access the client user directory.
When this property is set to true, the user is logged into the client user directory. The
default value is false.
The FTP root directory can be the default directory named userFtpRoot in your
Integration Server home directory or a directory dened by the user using the
wa.server.userFtpRootDir property.

Important: You must restart Integration Server after you modify the value of this
property.
watt.server.logs.dateStampFmt
Species the format of the date and timestamp to be used in audit log les
(FailedAudit_*, WMERROR*, WMSESSION*, WMTXIN*, WMTXOUT*). The
format you specify must adhere to the java.text.SimpleDateFormat class. If the
wa.server.logs.dateStampFmt property is not set, Integration Server uses the default
format, which is yyyy -MM -dd Thh:mm :ss .SSS Z (for example, 2010-04-19T19:07:21.505Z).
watt.server.logs.dateStampTimeZone
Species the time zone to be used in audit log les (FailedAudit_*, WMERROR*,
WMSESSION*, WMTXIN*, WMTXOUT*). The format you specify must adhere to the
java.util.TimeZone class (for example, wa.server.logs.dateStampTimeZone=EST). If this
property is not set, Integration Server uses local time zone hosting. For this property to
take eect, the wa.server.logs.dateStampFmt must also be specied.
watt.server.math.floatOperation.mode
Species whether the pub.math:*Floats services return the exact result of an operation
involving two oating point numbers, the result as calculated by the JVM, or the result
based on a xed number of decimal places.
Set this parameter to one of the following values:

webMethods Integration Server Administrators Guide Version 9.10

936

Odd Header
Server Configuration Parameters

Specify...

If you want pub.math:*Floats services to...

dynamic

Return the precise result of the math operation. For example, when
using pub.math:addFloats to add 62.98 and 23, the service returns a
sum of 85.98.

default

Return the result of the math operation as calculated by the JVM.

For example, when using pub.math:addFloats to add 62.98 and 23, the
service returns a sum of 85.97999999999999.
This is the default behavior.

fixed

Return the result rounded to a pre-determined number of decimal

places. For the pub.math:addFloats and pub.math:subtractFloats services,
Integration Server rounds the result to 3 decimal places.
For the pub.math:multiplyFloats service, Integration Server rounds the
product to 16 decimal places.
For the pub.math:divideFloats service, Integration Server rounds the
result to 17 decimal places.

Note:

If you specify a value for the precision input parameter in pub.math:*Floats

services, the precision value is given precedence over the value of the
property 'wa.server.math.oatOperation.mode. For more information
about the pub.math:*Floats services, see webMethods Integration Server BuiltIn Services Reference.

Important: You must restart Integration Server for a new value to take eect.
watt.server.metadata.registry.timeout
The number of minutes a connection to aCentraSite registry can remain inactive before
Integration Server closes it. Integration Server connects to one or more CentraSite
registries to publish and retract metadata for your Integration Server assets. If no assets
are published to or retracted from a CentraSite registry for a period of time, Integration
Server closes the connection to that registry. The default period is 10 minutes.
watt.server.mime.decodeHeaders
Determines the global default behavior for how the pub.mime:createMimeData service
handles header decoding. The property can have one of the following values:
Specify...

To indicate that...

NONE

Species that by default the pub.mime:createMimeData service does

not decode the MIME header or body part headers. This is the
default.

webMethods Integration Server Administrators Guide Version 9.10

937

Even Header
Server Configuration Parameters

Specify...

To indicate that...

ONLY_MIME_HEADER
Species that by default the pub.mime:createMimeData service

decodes the MIME header only.

ONLY_BODY_PART Species that by default the pub.mime:createMimeData service

_HEADERS
decodes the body part headers only.
BOTH

Species that by default the pub.mime:createMimeData service

decodes the MIME header and the body part headers.

Note:

The values are not case sensitive.

Note:

Integration Server uses the value of the wa.server.mime.decodeHeaders

to determine whether or not to decode headers in a MIME message
only when the pub.mime:createMimeData service species no value
for the decodeHeaders input parameter. For information about the
pub.mime:createMimeData service and the decodeHeaders input parameter, see
the webMethods Integration Server Built-In Services Reference.

watt.server.netEncoding
Species the encoding the server is to use when reading and writing text to the
network. This seing has no eect on text that is explicitly encoded in a particular
encoding. The default is UTF-8. The encoding parameter in the pub.client:soapHTTP service,
if set, overrides the wa.server.netEncoding seing. For more information about
pub.client:soapHTTP, see webMethods Integration Server Built-In Services Reference.
watt.server.new.http.session.context
Species whether Integration Server should create a new session object when executing
the pub.client:http service. When this property is set to true, Integration Server ignores
the values from the session object of the last invocation of pub.client:http and creates a new
session object. When this property is set to false, Integration Server uses the values
from the existing session object. The default value is false.
watt.server.noObjectURL
Species the URL to which the server redirects a request after three aempts to log on
to the Integration Server Administrator have failed because the server cannot nd the
document the user is requesting. The default is for the server to display an HTML screen
saying "No such object."
watt.server.noAccessURL
Species the URL to which the server is to redirect a request after three aempts to log
on to the Integration Server Administrator have failed because the user does not have
access to the requested document. The default is for the server to display an HTML
screen saying "Access denied."

webMethods Integration Server Administrators Guide Version 9.10

938

Odd Header
Server Configuration Parameters

watt.server.ns.backupNodes
Species whether services are removed completely when they are deleted. When set
to true, service node.ndf les will be renamed to node.bak when they are deleted. The
default is false.
watt.server.ns.dependencyManager
Species whether the dependency checking features are enabled or disabled. When
set to true, the dependency checking features identify elements that will be aected
by moving, renaming, or deleting another element. For optimization in a production
environment, you might set this parameter to false. The default for this parameter is
true.
watt.server.ns.hideWmRoot
Indicates whether Integration Server should hide the WmRoot package from the
Software AG Designer workspace. When set to true (the default), Designer does not
display the WmRoot package in the workspace.
watt.server.ns.lockingMode
Species whether le locking is enabled on the Integration Server:
To enable use of the Version Control System Integration feature, set this value to
vcs.
To enable local locking on the Integration Server, set this value to full. This is
the default value.
To disable user locking and show no locks, set this value to none.
To disable user locking but show system locks, set this value to system. This
value is required to use the Local Service Development feature.
Important: The WmVCS package, which provides the functionality for using the VCS
Integration Feature, is deprecated as of Integration Server version 9.9.
Software AG recommends that you use the local service development
feature (Local Version Control Integration) to check package elements
and their supporting les into and out of a version control system (VCS)
directly from Designer.
watt.server.oauth.approvalpage.footer
Species the footer information that Integration Server displays on the OAuth approval
page. There is no default.
watt.server.oauth.approvalpage.header
Species the heading information that Integration Server displays on the OAuth
approval page. The default is Resource access approval.
watt.server.oauth.approvalpage.logo
Species the URL of the image le that Integration Server displays on the OAuth
approval page. Keep the following points in mind when specifying an image le:
Image les can be of any width, but can be no larger than 92 pixels high.

webMethods Integration Server Administrators Guide Version 9.10

939

Even Header
Server Configuration Parameters

You can specify an image of any image le format (for example, .gif, .png, .jpeg,
or another image le format) that your browser can display.
The image le does not have to reside on Integration Server. If the image le is
hosted on another server, provide the absolute path.
The default is /WmPublic/images/fw_logo_sag.gif, which is 234x92 pixels.
watt.server.oauth.approvalpage.title
Species the title that Integration Server displays on the OAuth approval page. The
default is Access Approval.
watt.server.oauth.authCode.expirySeconds
Species the amount of time (in seconds) before the OAuth authorization code expires.
A value of -1 indicates that the authorization code never expires. The maximum value is
2147483647. The default is 600.
The value of the wa.server.oauth.authCode.expirySeconds parameter is tied to the
value of the Authorization code expiration interval eld on the Security > OAuth > Edit OAuth
Global Settings screen in Integration Server Administrator. Software AG recommends that
you use Integration Server Administrator to specify the expiration time for the OAuth
authorization code instead of using the wa.server.oauth.authCode.expirySeconds
property. For more information about seing the expiration time for the OAuth
authorization code, see "Conguring OAuth" on page 535.
watt.server.oauth.authServer.alias
Species the alias of the remote server that Integration Server uses as an authorization
server. The value should match the Alias eld on the Settings > Remote Servers page of
Integration Server Administrator. For example, local.
Note:

You must add the remote server on the Settings > Remote Servers
page of Integration Server Administratorbefore specifying the alias in
wa.server.oauth.authServer.alias.

The value of the wa.server.oauth.authServer.alias parameter is tied to the value of

the Authorization server eld on the Security > OAuth > Edit OAuth Global Settings screen in
Integration Server Administrator. Software AG recommends that you use Integration
Server Administrator to specify the remote server alias to use as an authorization server
instead of using the wa.server.oauth.authServer.alias property. For more information
about specifying the remote server alias, see "Conguring OAuth" on page 535.
watt.server.oauth.custom.responseHeader
When set to true, OAuth and OpenID errors that are returned to client applications and
to end users appear in the HTTP response header with a header aribute name of XOAuth-Error. For most OAuth and OpenID errors, Integration Server returns a status
code in the range of 400 - 599 and the error message is returned in the body of the HTTP
response. Some browsers do not display the response body when the status code is not
successful (200 - 299). Problems with your applications that use OAuth or OpenID can
be easier to troubleshoot when the error message is in the response header. When the
Server logging facility "0038 HTTP Header" is set to TRACE, the response header is
visible in the server log. If wa.server.oauth.custom.responseHeader is true, OAuth and

webMethods Integration Server Administrators Guide Version 9.10

940

Odd Header
Server Configuration Parameters

OpenID error messages will appear as X-OAuth-Error response header aributes in the
server log.
The default value for wa.server.oauth.custom.responseHeader is false.
watt.server.oauth.requireHTTPS
Indicates whether Integration Server requires that client applications use HTTPS to
access the pub.oauth:authorize, pub.oauth:getAccessToken, and pub.oauth:refreshAccessToken
services. If you set the value of this property to false, Integration Server allows client
applications to use HTTP to access the pub.oauth services. The default is true.

If you set the value of this property to true and the client application accesses any of the
pub.oauth services over HTTP, Integration Server issues an HTTP 500 error response to
the client and writes a service exception to the error log.
Note:

To conform to the OAuth 2.0 Authorization Framework, you must set this
property to true.

Important: To simplify development, you can set wa.server.oauth.requireHTTPS to

false, but you should use HTTPS in production in accordance with the
OAuth Framework. If you do not require HTTPS, the authorization server
transmits access tokens in clear text, making them vulnerable to theft.
The value of the wa.server.oauth.requireHTTPS parameter is tied to the value of
the Require HTTPS eld in the Security > OAuth > Edit OAuth Global Settings page of the
Integration Server Administrator. Software AG recommends that you use Integration
Server Administrator to indicate whether Integration Server requires HTTPS for
applications to access OAuth services instead of using wa.server.oauth.requireHTTPS.
For more information about requiring HTTPS for accessing OAuth services, see
"Conguring OAuth" on page 535.
For more information about the pub.oauth services, see webMethods Integration Server BuiltIn Services Reference.
watt.server.oauth.token.defaultExpirySeconds
Species the amount of time (in seconds) that access tokens are valid before expiring.
A value of -1 indicates that authorization tokens never expire. The maximum value is
2147483647. The default is 3600.
The value of the wa.server.oauth.token.defaultExpirySeconds parameter is tied to the
value of the Access token expiration interval eld in the Security > OAuth > Edit OAuth Global
Settings page of the Integration Server Administrator. Software AG recommends that
you use Integration Server Administrator to set the expiration time for access tokens
instead of using wa.server.oauth.token.defaultExpirySeconds. For more information
about the Access token expiration interval eld, see "Conguring OAuth" on page 535.
watt.server.package.parallel.threads
Species the maximum number of threads that you want Integration Server to use when
loading IS packages at startup. The threads are from a thread pool that Integration
Server uses only at startup and specically for package loading. If you want Integration
Server to load packages sequentially, set the value to 1. If you want Integration Server to

webMethods Integration Server Administrators Guide Version 9.10

941

Even Header
Server Configuration Parameters

load packages in parallel, set the value to 2 or higher. It is recommended that you do not
exceed 10. The default value is 6.
Note:

If you set wa.server.package.parallel.threads to 0 or a negative number,

Integration Server loads packages sequentially.

watt.server.package.wsd.loadExternalResources
Species whether, at package load time, Integration Server loads the external resources
for a consumer web service descriptor or a WSDL rst provider web descriptor created
on a pre-8.2 version of Integration Server with thePre-8.2 compatibility mode property set to
true.
When this parameter is set to true , Integration Server resolves all the import and include
statements in the source WSDL document and related XML Schema denition les for
consumer web service descriptors or WSDL rst provider web service descriptors at the
package load time.
When this parameter is set to false , Integration Server skips loading the external
resources contained in the source WSDL document used to create the web service
descriptor. In some environments, seing this parameter to false may speed up the
loading of web service descriptors. The default is true.
watt.server.partner
Species the IP address or domain name of a hub server. This seing allows the partner
server to issue a remote invoke request to a remote Integration Server. Integration Server
will ignore a port number if you specify one as part of an IP address.
watt.server.password.minDigits
Species the minimum number of digits a password must contain for non-Administrator
users. When a non-Administrator user changes a password, he or she must create a
password containing at least the number of digits specied by this parameter. If the
minimum number of digits is not met, Integration Server sends a warning message to
the Administrator user. The default is 1.
watt.server.password.minLength
Species the minimum number of characters a password must contain for nonAdministrator users. The character length includes upper and lower case alphabetic
characters, digits (0-9), and special characters combined. When a non-Administrator user
changes a password, he or she must create a password containing at least the number
of characters specied by this parameter. If the minimum length is not met, Integration
Server sends a warning message to the Administrator user. The default is 8.
watt.server.password.minLowerChars
Species the minimum number of lowercase alphabetic characters a password must
contain for non-Administrator users. When a non-Administrator user changes a
password, he or she must create a password containing at least the number of lowercase
characters specied by this parameter. If the minimum is not met, Integration Server
sends a warning message to the administrator user. The default is 2.
watt.server.password.minSpecialChars
Species the minimum number of special characters, such as asterisk (*), period(.), and
question mark(?), a password must contain for non-Administrator users. When a nonwebMethods Integration Server Administrators Guide Version 9.10

942

Odd Header
Server Configuration Parameters

Administrator user changes a password, he or she must create a password containing at

least the number of special characters specied by this parameter. If the minimum is not
met, Integration Server sends a warning message to the Administrator user. The default
is 2. The use of special characters is regulated by the following restrictions:
A password cannot begin with an asterisk (*).
A password cannot contain quotation marks ("), backslashes (\), ampersands (&),
or less-than signs (<).
Use the wa.server.illegalUserChars conguration property to restrict the use of
additional characters.
watt.server.password.minUpperChars
Species the minimum number of uppercase alphabetic characters a password must
contain for non-Administrator users. When a non-Administrator user changes a
password, he or she must create a password containing at least the number of uppercase
characters specied by this parameter. If the minimum is not met, Integration Server
sends a warning message to the Administrator user.
watt.server.password.mode
Species whether or not to enforce the password restrictions when seing passwords for
administrator or non-administrator users. When set to strict, the password restrictions
are enforced and when set to lax, the password restrictions are not enforced. The
default is lax.
watt.server.pipeline.processor
Species whether to globally enable or disable the Pipeline Debug feature. When set to
true, Integration Server checks the Pipeline Debug values for the service at run time.
You can view and set the Pipeline Debug values in the Properties view in Designer.
When set to false, Integration Server ignores the Pipeline Debug options set for the
service in Designer. The default is true.
Enable this property in development environments where testing and debugging
is performed. In a production environment, however, disabling this property is
recommended.

Important: You must restart Integration Server for the new value to take eect.
watt.server.port
Species the port number of the Integration Server's primary port. The default is 5555.
watt.server.portQueue
Species the size of the port queue for HTTP and HTTPS ports. The port queue is the
number of outstanding inbound connections that are queued in the TCP/IP stack. The
default is 65534. If your server runs on AS/400, set this number to 511.
watt.server.publish.local.rejectOOS
Species whether Integration Server should reject locally published documents when the
queue for the subscribing trigger is at maximum capacity.
When this parameter is set to true, before placing a locally published document into
a subscribing trigger's queue, Integration Server rst checks the trigger's queue size. If

webMethods Integration Server Administrators Guide Version 9.10

943

Even Header
Server Configuration Parameters

the queue already contains the maximum number of documents allowed by the trigger's
Capacity property, Integration Server rejects the locally published document for that
trigger queue only.
When this parameter is set to false, Integration Server continues to place locally
published documents into a subscribing trigger's queue even when the queue is at
capacity. This is the default.
Note:

Multiple triggers can subscribe to the same document. Integration Server

places the document in any subscribing trigger queue that is not at
capacity.

Note:

This parameter applies only to documents published locally using the

pub.publish:publish or pub.publish.publishAndWait services.

watt.server.publish.useCSQ
Species whether Integration Server uses outbound client-side queuing if documents
are published when the Broker is unavailable. Set this parameter to always to send
published documents to the outbound document store when the Broker is not
available. Set this parameter to never to instruct the publishing service to throw a
ServiceException when the Broker is not available. The default is always.
watt.server.publish.drainCSQInOrder
If client-side queuing is enabled, this parameter species whether Integration Server
should empty the outbound document store in publication order or in parallel with
newly published documents. When this parameter is set to true, Integration Server
sends all newly published documents (guaranteed and volatile) to the outbound
document store until the outbound store has been emptied. This allows the Integration
Server to maintain publication order. When this parameter is set to false, the outbound
store is emptied while new documents are being published to the Broker. The default is
true.
Note:

This server conguration parameter applies to documents published to

Broker only.

watt.server.publish.usePipelineBrokerEvent
Species whether Integration Server should bypass encoding that is normally performed
when documents are published to the Broker. If this property is set to true, Integration
Server checks the pipeline for an object called $brokerEvent. If the object is found and is
of type BrokerEvent, Integration Server sends its value to the Broker and no additional
encoding is performed. Set this parameter to true if Integration Server is sending native
Broker events. The default is false.
For more information about publishing native Broker events, see the Publish-Subscribe
Developers Guide.

watt.server.publish.validateOnIS
Species whether Integration Server validates published documents. Set this parameter
to one of the following values:

webMethods Integration Server Administrators Guide Version 9.10

944

Odd Header
Server Configuration Parameters

Specify...

To...

always

Perform document validation for all published documents. This

includes instances of publishable document types for which the Validate
when published property is set false.

never

Disable document validation for all publishable document types. This

includes instances of publishable document types for which the Validate
when published property is set true.
Some reasons for disabling document validation include the following:
You want to improve performance.
You want to validate the documents manually.
You know that the system that sent Integration Server the data has
already validated the data.
You prefer to have the messaging provider, rather than Integration
Server, validate the documents.
Integration Server is sending or receiving native Broker events.

perDoc

Perform document validation only for instances of publishable

document types for which document validation is enabled. That is,
Integration Server validates published documents that are instances
of publishable document types for which the Validate when published
property is set true.
This is the default behavior.

Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
For information about handling native Broker events and specifying validation for an
individual publishable document type, see the Publish-Subscribe Developers Guide.
watt.server.recordTodocument.bufferSize
Species the size of the buer that Integration Server uses to write an XML string when
converting a document (IData) to an XML string. Increase the buer size if the majority
of the created XML strings will be greater than 4 KB. Decrease the buer size if the
majority of the created XML strings will be small documents less than 4 KB in size. The
default size is 4 KB.
watt.server.requestCerts
Species whether the Integration Server requests a digital certicate from clients that
connect to it through SSL. Set this parameter to true if you want the server to request
certicates. Set it to false if you do not want the server to request certicates. The
default is false.

webMethods Integration Server Administrators Guide Version 9.10

945

Even Header
Server Configuration Parameters

watt.server.RESTDirective
Species an alternative word to use for the rest directive in URLs that
access resources on Integration Server. By default, this parameter is set as
watt.server.RESTDirective=rest, which means users must specify the rest directive
as rest (for example, GET http://host:port/rest/resource/resourceID).
To allow users to specify the rest directive as either rest or an alternative word, set
this parameter to the alternative word. For example, to allow users to specify the
rest directive as either rest or process, (GET http://host:port/rest/resource/
resourceID) or GET http://host:port/process/resource/resourceID), set this
parameter as watt.server.RESTDirective=process.
watt.server.revInvoke.proxyMapUserCerts
For webMethods Enterprise Gateway only. Species whether an Enterprise Gateway
Server is to perform client authentication itself in addition to passing authentication
information to the Internal Server for processing. The default is false. If this property is
set to true, Enterprise Gateway Server will reject all anonymous requests (no certicate
and no username/password supplied), even if the request is for an unprotected service
on the Internal Server. See "Conguring webMethods Enterprise Gateway " on page 493
for more information.
watt.server.rg.internalregistration.timeout
For webMethods Enterprise Gateway conguration only. Set this value on the Internal
Server to specify the time (in seconds) the Internal Server will wait before closing an
unresponsive connection to the Enterprise Gateway Server. The default is 0, which
means the Internal Server will not time out (a timeout period of innity).
Important: Set the value of wa.server.rg.internalregistration.timeout
on the Internal Server to a value greater than the ping values
dened by the wa.net.socketpool.sweeperInterval server
conguration parameter on the Enterprise Gateway Server. Seing
wa.server.rg.internalregistration.timeout to a value that is lower than
wa.net.socketpool.sweeperInterval will cause the Internal Server to close
the connection to the Enterprise Gateway Server and re-establish a new
connection regularly.
watt.server.scheduler.deleteCompletedTasks
Species whether or not scheduled tasks that have expired should be automatically
deleted. When set to true, Integration Server deletes expired tasks when they expire. Set
this parameter to false if you want Integration Server to wait until the next server restart
to delete expired tasks. The default is true.
watt.server.scheduler.ignoreReferenceValidationErrors
Species whether Integration Server creates or executes a scheduled task if the
scheduled service has a broken reference. Set the property to true to indicate that
Integration Server ignores broken references for the scheduled service when executing
a scheduled task. Set it to false to indicate that Integration Server should not execute a
scheduled task if the scheduled service has one or more broken references. The default is
false.

webMethods Integration Server Administrators Guide Version 9.10

946

Odd Header
Server Configuration Parameters

watt.server.scheduler.logical.hostname
Species a unique logical name to identify Integration Server instances in a cluster
hosted on a single machine. By default, Integration Server uses the host name
to identify itself while scheduling tasks. However, when a cluster of Integration
Servers are hosted on a single machine, the host name itself cannot uniquely
identify the individual Integration Server instances. In such cases, use the
wa.server.scheduler.logical.hostname property to specify a unique logical name to
identify individual Integration Server instances.
The default value for this parameter is the host name.
Keep the following points in mind when seing the
wa.server.scheduler.logical.hostname property:
Set this property only if you are running multiple Integration Servers in a cluster
on a single machine.
Set this property on each Integration Server instance in the cluster before
scheduling any tasks.
The logical host name you specify must be unique.
The logical host name you specify cannot contain a semicolon (;).
This property is also useful when Integration Server is installed on a virtual
server whose host name or IP address might change over time. You can use
wa.server.scheduler.logical.hostname to provide a xed value that identies each
server in a cluster.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.scheduler.maxWait
Maximum time in seconds Integration Server waits between queries of the task queue.
The server periodically checks the queue for tasks that are scheduled to run. If there are
no tasks waiting to run, the server waits the maxWait time before checking the queue
again. If there are tasks waiting to run, the server checks again at the task's schedule
execution time, or after the maxWait time, whichever is earlier. For example, if the
pending task is due to execute in 30 seconds and the maxWait time is 60, the server will
check the queue again in 30 seconds. The default is 60.
Note:

You must ensure that the value you specify for this parameter must be less
than the minimum time interval set for a scheduled task.

If you run a cluster of Integration Servers and schedule a task to run on all servers in the
cluster, you might notice tasks starting at dierent times on the dierent servers if the
servers have dierent seings for this property. For this reason, if you are running in a
clustered environment, all the servers in your cluster should have the same seings for
this property. See the webMethods Integration Server Clustering Guide for more information
about conguring Integration Servers in a cluster.

webMethods Integration Server Administrators Guide Version 9.10

947

Even Header
Server Configuration Parameters

watt.server.scheduler.threadThrottle
Percentage of Integration Server threads the scheduler process is permied to use. The
default is 75%.
watt.server.serverlogRotateSize
Species the le size at which Integration Server rolls over the server.log le. Set this
property to N [KB|MB|GB], where N is any valid integer greater than or equal to 33.
The minimum size at which Integration Server rotates the server.log le is 33KB. Do not
include any spaces between the integer and the unit of measure.
There is no default value for this parameter. That is, by default, the parameter has no
value. If no value is specied for wa.server.serverlogRotateSize, Integration Server
rotates the server.log le at midnight only.
If an invalid value is specied, Integration Server resets the parameter to -1. Note that a
value of -1 results in the same behavior as specifying no value for the parameter.
For more information about the server.log, see "Seing Up the Server Log" on page 215.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.serverlogQueueSize
Controls the number of entries allowed in the server log queue. This property is related
to the watt.server.log.queued property, which controls whether the server is to
write entries directly to the server log, or queue them in memory rst and then use
a background thread to write them to the server log. If your conguration has the
watt.server.log.queued property set to true and you notice that expected server log
entries are not included in the log, try increasing the queue size. For more information
about the server log and the server log queue, see "Specifying Whether to Queue Server
Log Entries" on page 219. The default queue size is 8192.
watt.server.serverclassloadername
This is an internal property. Do not modify.
watt.server.service.lazyEval
Controls whether Integration Server initializes Java services during startup. When set
to true (the default), Integration Server does not initialize Java Services until they are
referenced during runtime. This can increase performance if the server initializes a lot of
Java Services at start up.
watt.server.serviceMail
Species the email address to which Integration Server sends messages about service
failures. There is no default.
When you specify an email address on this parameter, Integration Server creates
a simple scheduled task to perform the notication. This task requires a thread,
which Integration Server takes from the cronjob-based thread pool. See the
wa.server.cron.maxThreads and wa.server.cron.minThreads parameters for more
information about this thread pool.

webMethods Integration Server Administrators Guide Version 9.10

948

Odd Header
Server Configuration Parameters

watt.server.serviceUsageDSP.RefreshInterval
Species the interval, measured in seconds, that elapses before Integration Server
Administrator refreshes the data on the Server > Statistics page. The default is 90 seconds.
The change to the parameter takes eect the next time the Server > Statistic page is
reloaded.
watt.server.session.stateful.enableLimit
Controls whether the stateful session limit feature is enabled. When this property is
set to true, Integration Server allows stateful sessions to be created as needed until it
reaches the maximum allowed, which is specied by the wa.server.session.stateful.max
property. You can view statistics for stateful sessions on the Server > Statistics screen in
Integration Server Administrator.
watt.server.session.stateful.max
Species the number of concurrent stateful sessions allowed on the Integration Server.
If a user aempts to access the server and execute a stateful service while the maximum
number of stateful sessions are in use, the server rejects the request and returns an error
to the user.
The value for wa.server.session.stateful.max must be a positive integer. If a value is
not specied or the wa.server.session.stateful.enableLimit property is set to false, the
maximum number of concurrent sessions is dened by your Integration Server license.
Note:

It is recommended that you use the Maximum Stateful Sessions eld in the
Edit Resource Seings page of the Integration Server Administrator to set
the maximum value. For more information about seing a maximum limit
for stateful sessions, see "Managing Server Sessions" on page 112.

watt.server.session.stateful.warning
Species the threshold at which Integration Server starts to warn of insucient available
stateful sessions. When the percentage of available stateful sessions is equal to or less
than the value of this property, Integration Server generates a server log message stating:
The default is 25%.
Note:

It is recommended that you use the Enable Stateful Session Limit eld in the
Edit Resource Seings page of the Integration Server Administrator to
set the threshold value. For more information about seing an available
stateful sessions warning threshold, see "Managing Server Sessions" on
page 112.

watt.server.setResponse.pre82Mode
Species the order in which the pub.flow:setResponse service looks for and uses the
deprecated input parameters when neither of the input parameters responseString or
responseBytes are provided.
When set to true, the pub.flow:setResponse service follows a precedence order similar to
what was available in Integration Server 7.1x and 8.0x. Specically, the service looks
for the deprecated parameters in the following order and uses the value of the rst
parameter that it nds: response , string , bytes

webMethods Integration Server Administrators Guide Version 9.10

949

Even Header
Server Configuration Parameters

When set to false, the pub.flow:setResponseservice follows a precedence order similar to

what was available in Integration Server 8.2 and later. Specically, the service looks
for the deprecated parameters in the following order and uses the value of the rst
parameter that it nds: string , bytes , response
The default is false.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.server.smtpServer
Species the SMTP server to use for server error logging and service error email
notication. There is no default.
watt.server.smtpServerPort
Species the number of the listening port on the SMTP server to which the Integration
Server is to send server error logging and service error email notication. The default is
25.
watt.server.smtpTransportSecurity
Species the type of SSL encryption that Integration Server uses when communicating
with an SMTP server.
Set this property to any one of the following values:
When set to...

Integration Server...

None

Uses a non-secure mode when communicating with an SMTP

server.
When you specify None, the SMTP server authenticates the
SMTP client using only the username and password.

Explicit

Uses explicit security when communicating with an SMTP

server. With explicit security, Integration Server establishes
an un-encrypted connection to the SMTP server and then
upgrades to the secure mode.

Implicit

Uses implicit security when communicating with an SMTP

server. With implicit security, Integration Server always
establishes an encrypted connection to the SMTP server. Only
clients that support SSL will be permied access.

watt.server.smtpTrustStoreAlias
Species the alias for the truststore that contains the list of certicates that Integration
Server uses to validate the trust relationship between Integration Server and the SMTP
server. If you do not specify a truststore alias, the default truststore alias specied in
the wa.security.trustStoreAlias property will be used. For more information about
truststore alias, see "Creating Truststore Aliases" on page 412.

webMethods Integration Server Administrators Guide Version 9.10

950

Odd Header
Server Configuration Parameters

watt.server.SOAP.addEmptyHeader
Species whether Integration Server should create an empty header entry
in the SOAP message created by executing the pub.soap.utils:createSoapData or
pub.soap.utils:stringToSoapData services. When this property is set to true, Integration Server
creates an empty header in the SOAP message. When this property is set to false,
Integration Server does not create a header entry in the SOAP message. The default is
true.
The addEmptyHeader parameter in the pub.soap.utils:createSoapData
or pub.soap.utils:stringToSoapData services, if set, overrides the
wa.server.SOAP.addEmptyHeader seing.
For more information about pub.soap.utils:createSoapData and pub.soap.utils:stringToSoapData
services, see webMethods Integration Server Built-In Services Reference.
watt.server.SOAP.completeLoad
Species whether the XML node added by pub.utils:addBodyEntry, pub.utils:addHeaderEntry,
pub.utils:addTrailer will be completely loaded before adding to the SOAP message. When
set to true, Integration Server loads the entire XML node. When set to false, Integration
Server does not completely load the XML node before adding it to the service. The
default is true.
watt.server.soap.convertPlainTextHTTPResponseIntoSOAPFault
Species how Integration Server returns the response from a web service invocation
when it is acting as a client and the web service results in a plain text HTTP response.
This parameter applies only when the web service connector was created using:
Integration Server version 8.2 or later, but the web service descriptors Pre-8.2
compatibility mode property is true
A version of Integration Server prior to version 8.2
When the wa.server.soap.convertPlainTextHTTPResponseIntoSOAPFault parameter
is set to true (the default), Integration Server converts the plain text HTTP response and
returns the information from the HTTP response within web service connector's output
parameters.
If the web service connector was created using Integration Server version 8.2 or
later and the Pre-8.2 compatibility mode property is true, Integration Server returns
the converted HTTP payload in the web service connectors fault/reasons output
parameter.
If the web service connector was creating using a version of Integration Server
prior to version 8.2, Integration Server returns the converted HTTP payload in
one of the following based on the SOAP protocol in use:
SOAP-FAULT/Fault_1_1/faultstring
SOAP-FAULT/Fault_1_2/SOAP-ENV:Reason/SOAP-ENV:Text
Having the plain text HTTP response converted and returned in the web service
connectors output parameter can be helpful because it might contain the cause of the
exception.

webMethods Integration Server Administrators Guide Version 9.10

951

Even Header
Server Configuration Parameters

If you set the parameter to false, when the web service results in a plain text HTTP
response, Integration Server throws an exception indicating that an invalid SOAP
envelope is received.
Important: After updating this parameter, you must restart Integration Server for
changes to this parameter to take eect.
watt.server.soap.decodeElementWithPrefix
Species whether Integration Server recognizes document types that have dened XML
namespace URIs but do not have prexes associated with each namespace. By default,
in Integration Server version 8.2 SP2 and higher, if document types that have a dened
XML namespace URI but do not have a prex associated with each namespace are
specied as inputs to services, the SOAP processor fails to recognize the document types
at run time. If the wa.server.soap.decodeElementWithPrex property is set to true,
Integration Server recognizes the document types that have dened XML namespaces
but do not have prexes associated with each namespace.
The default is false.
The wa.server.soap.decodeElementWithPrex server conguration parameter value
aects how Integration Server decodes inbound SOAP messages for web service
descriptors created on Integration Server version 7.1.x. Specically, the parameter
aects how Integration Server decodes SOAP response messages received by a 7.1.x web
service connector and SOAP request messages received by a 7.1.x web service provider.
When wa.server.soap.decodeElementWithPrex is set to true, when decoding
an inbound SOAP message, Integration Server does not consider namespace and/
or prex declarations when decoding the SOAP message to IData for any web
service or web service connector that is part of a web service descriptor created
in 7.1.x. Integration Server will map namespace qualied elements in the XML
string to elds in an IS document type even if the eld names do not include
a prex. That is, when the parameter is set to true Integration Server uses the
decoding behavior available in version 7.1.x. for any web service or web service
connector that is part of a web service descriptor created in Integration Server
7.1.x.
Note:

The Integration Server 7.1.x decoding behavior described

above is invalid. However, the stricter decoding process in
Integration Server 8.2 and later can result in missing or extraneous
elds which, in turn, results in validation errors. Seing the
wa.server.soap.decodeElementWithPrex to true allows the 7.1.x
behavior and does not require changes to the 7.1.x web service
descriptors.

When wa.server.soap.decodeElementWithPrex is set to false, when decoding

an inbound SOAP message, Integration Server considers namespace and/or
prex declarations when decoding a SOAP message to IData for any web service
or web service connector that is part of a web service descriptor created in
Integration Server 7.1.x. Integration Server does not map namespace qualied
elements in the XML string to elds in an IS document type if the eld names do

webMethods Integration Server Administrators Guide Version 9.10

952

Odd Header
Server Configuration Parameters

not include a prex. That is, when the parameter is set to false, Integration Server
uses the decoding behavior available in version 8.2 SP2 and later for any web
service or web service connector that is part of a web service descriptor created in
Integration Server 7.1.x and later.
Note:

For web service descriptors created in Integration Server 8.2 SP2 onwards,
you must associate a prex with an XML namespace URI for elds in the
service signature.

The wa.server.soap.decodeElementWithPrex server conguration parameter

also determines whether or not the pub.xml.xmlNodeToDocument service considers
namespace and/or prex declarations when decoding namespace qualied elements to
corresponding elds in an IS document type.
When wa.server.soap.decodeElementWithPrex is set to true, the
pub.xml:xmlNodeToDocumentservice does not consider namespace and/or prex
declarations. The service will map namespace qualied elements in the
XML string to elds in an IS document type even if the eld names do not
include a prex. Note that this behavior is considered invalid but is allowed to
provide backward compatibility with services developed on earlier versions of
Integration Server.
When wa.server.soap.decodeElementWithPrex is set to false, the
pub.xml:xmlNodeToDocument service considers namespace and/or prex declarations.
The service does not map namespace qualied elements in the XML input to
elds in an IS document type if the eld names do not include a prex. The
pub.xml:xmlNodeToDocument service does not populate non-prexed elds. Instead
the service adds new elds that use the prex:name structure and populates
those elds with values from the XML instance.
Important: After updating the wa.server.soap.decodeElementWithPrex parameter,
you must restart Integration Server for changes to the parameter to take
eect.
watt.server.SOAP.defaultProtocol
Species the default protocol that Integration Server uses for new SOAP messages.
Specify SOAP 1.1 Protocol or SOAP 1.2 Protocol. The default is SOAP 1.1 Protocol.
watt.server.SOAP.directive
Species a dierent word to use for the SOAP directive in URLs that route requests
to the Integration Server SOAP handler. By default, this parameter is set as
watt.server.SOAP.directory=soap, which means users must specify the SOAP
directive as soap (http://host:port/soap). To allow users to specify the SOAP
directive as a dierent word instead, set this parameter to that word. For example, to
allow users to specify the SOAP directive as endpoint, (http://host:port/endpoint),
set this parameter as watt.server.SOAP.directive=endpoint.
watt.server.SOAP.encodeXSIType
Indicates where the xsi:type will appear as an aribute for an element in a SOAP
message that species RPC/Encoded. A value of true indicates that Integration Server
includes the xsi:type aribute for an element. False indicates that the xsi:type aribute

webMethods Integration Server Administrators Guide Version 9.10

953

Even Header
Server Configuration Parameters

will be omied. The default is true. Software AG recommends using a value of true for
this parameter.
watt.server.SOAP.encodeXSITypeValue
Indicates whether Integration Server should include the xsi:type aribute and its
value for an element of xsd:anyType in SOAP requests and responses. When set to
false, Integration Server omits the xsi:type aribute and its value for an element of
xsd:anyType in SOAP requests and responses. When set to true, Integration Server
includes the xsi:type aribute and its value for an element of xsd:anyType in SOAP
requests and responses. The default is true.
Note:

The wa.server.SOAP.encodeXSITypeValue server conguration

parameter aects only those SOAP requests and responses created by
Integration Server.

watt.server.SOAP.generateNilTags
Species whether or not Integration Server generates an xsi:nil aribute for an element
in a SOAP message. When set to true, Integration Server generates an xsi:nil aribute
for an element that is nillable (the Allow null property for the corresponding eld is
set to true) and the eld is null at run time. When wa.server.SOAP.generateNilTags
is set to false, Integration Server omits the xsi:nil aribute for an element even if the
corresponding eld is nillable and the eld is null at run time. The default is true.
watt.server.SOAP.generateRequiredTags
Species whether or not a SOAP message generated by Integration Server
includes empty element tags for required parameters for which a value was
not supplied at run time. When set to true, Integration Server generates empty
element tags for required parameters for which a value is not specied. When
wa.server.SOAP.generateRequiredTags is set to false, Integration Server omits empty
element tags for required parameters for which a value is not specied. The default is
true.
watt.server.SOAP.hideEPRHostInFault
Hides the endpoint reference host name and IP address details in the SOAP fault.
When this parameter is set to true, Integration Server replaces the host name and IP
address with *:* in the SOAP fault. When this parameter is set to false, Integration Server
includes the host name and IP address details of the endpoint reference in the SOAP
fault. The default is false.
Note:

This parameter applies only when the Pre-8.2 compatibility mode property of
the web service descriptor is set to false.

watt.server.SOAP.ignoreMissingResponseHeader
Determines whether missing required headers in a SOAP response results in an error.
When set to true, a SOAP response that does not contain a required header will not
result in an error. When set to false, a SOAP response that does not contain a required
header results in an error. The default is false.
Note that all headers in a web service descriptor, whether generated from the original
WSDL document or added to the web service descriptor, are treated as required. This

webMethods Integration Server Administrators Guide Version 9.10

954

Odd Header
Server Configuration Parameters

is an application of the WS-I basic prole rules declaring that all headers in a WSDL be
treated as required. Prior to Integration Server version 9.0, when processing a SOAP
response received by a web service descriptor, Integration Server did not properly
validate that all of the SOAP headers were present. As a result, Integration Server did
not throw an error when a SOAP response was missing a SOAP header. Beginning in
Integration Server version 9.0, Integration Server properly validates SOAP responses
for required headers. If a required header is not present, Integration Server throws the
following error: [ISS.0088.9443] One or more required Headers <headerName> are
not present in the SOAP response. While failure when a required header is missing
is the correct behavior, Integration Server provides a conguration property to control
whether missing required headers in a SOAP response results in an error. This can be
useful in migration situations.
watt.server.SOAP.MTOMStreaming.cachedFiles.location
Species the absolute path to the hard disk drive space that Integration Server
uses to temporarily store inbound SOAP messages when performing MTOM
streaming. This parameter takes eect only when MTOM streaming is enabled (i.e.,
wa.server.SOAP.MTOMStreaming.enable is set to true).
You can specify a directory on the same machine as the Integration Server or in
any other location accessible to Integration Server, such as a mapped logical drive
or network directory. The default value is Integration Server_directory\instances
\instance_name \temp\mtom\cached les.
Note:

If your Integration Server is in a clustered environment, you must set this

property in all the servers in the cluster. See webMethods Integration Server
Clustering Guide for more information about conguring Integration Server
in a cluster.

watt.server.SOAP.MTOMStreaming.enable
Indicates whether MTOM streaming is enabled for inbound SOAP messages and
whether HTTP chunking is enabled for outbound requests. Set this property to true
to enable MTOM streaming for inbound SOAP messages and HTTP chunking for
outbound requests. Set this property to false to disable MTOM streaming and HTTP
chunking. The default is false.
watt.server.SOAP.MTOMStreaming.threshold
Species the number of bytes an MTOM aachment in an inbound SOAP
message must be before Integration Server uses MTOM streaming for the MTOM
aachment. This parameter takes eect only when MTOM streaming is enabled (i.e.,
wa.server.SOAP.MTOMStreaming.enable is set to true).
Set the property to a positive integer to indicate the number of bytes for the MTOM
streaming threshold. Integration Server uses MTOM streaming when an MTOM
aachment is larger than the number of bytes you specify. The default is 4000 bytes.

watt.server.SOAP.MTOMThreshold
Species the eld size, in kilobytes, that determines whether Integration Server handles
base64binary encoded data in an outbound SOAP request as a MIME aachment or
whether it sends it inline in the SOAP message. If the web service descriptor for the
SOAP message enables aachments for the SOAP request, Integration Server passes

webMethods Integration Server Administrators Guide Version 9.10

955

Even Header
Server Configuration Parameters

as MIME aachments any base64 elds in a SOAP message that are larger than the
threshold. The default is 0.
watt.server.SOAP.request.timeout
Species the length of time, in seconds, Integration Server will wait for the SOAP
response from the server hosting the remote procedure. If Integration Server does not
receive a response in the alloed time, it terminates the request. The default value is -1,
which indicates that Integration Server will use the value set for the wa.net.timeout
property.
watt.server.SOAP.setNamespaceURIsToRoot
Species how Integration Server declares XML namespaces in a SOAP response. When
the wa.server.SOAP.setNamespaceURIsToRoot property is set to true, Integration
Server declares the namespace and prex once at the root element of the SOAP response
and then uses the prex for each element in the response. When set to false, Integration
Server declares the namespace the way it is dened in the original document, either
dening each element explicitly with the full namespace or declaring the namespace and
prex just once at the root element. The default value for this property is false.
watt.server.SOAP.streamHandlers
Species the custom SOAP handlers that expect stream inputs. Enter the SOAP handlers
as a semi-colon (;) separated list. There is no default.
watt.server.SOAP.treatNilAsNull
Indicates whether or not Integration Server, when decoding a SOAP message, generates
an @xsi:nil eld for an element for which the xsi:nil aribute is set to true. When set
to true, Integration Server treats an element that carries the xsi:nil aribute as a null
value and does not create an @xsi:nil aribute for the element. When this parameter is
set to false, Integration Server generates an @xsi:nil eld for an element that carries the
xsi:nil=true aribute. This conguration parameter aects all web services running on
Integration Server. The default is true.
Important: You must restart Integration Server for changes to this parameter to take
eect.
watt.server.SOAP.useMultiReference
For elements that appear in multiple places in a SOAP message, species whether
Integration Server serializes each occurrence of the element or serializes it in on only
one place and uses the href aribute in the other locations. When set to true, Integration
Server serializes one location and uses the href aribute in other locations. This
parameter applies to RPC/Encoded web services only. The default is true.
watt.server.SOAP.useStringforAnyTypewithSimpleValue
Species how Integration Server decodes an xsd:anyType element with simple content
in SOAP responses. When set to false, Integration Server decodes xsd:anyType
elements with simple content into an IData with an @xsi:type eld to retain the xsi:type
value and a *body eld to contain the element value. This is the default behavior.
When the wa.server.SOAP.useStringforAnyTypewithSimpleValue server conguration
parameter is set to true, Integration Server decodes xsd:anyType elements with simple
content into a String type eld that contains the element value. The element's xsi:type

webMethods Integration Server Administrators Guide Version 9.10

956

Odd Header
Server Configuration Parameters

information will be gone. You do not have to restart Integration Server for the change to
take eect.
watt.server.soap.validateResponse
Enables or disables SOAP response validation. When set to true, Integration Server
validates the SOAP response received by a web service connector. When set to false,
Integration Server does not validate the received SOAP response. The default is true.
watt.server.SOAP.validateSOAPMessage
When Integration Server acts as the web service provider, indicates whether Integration
Server validates inbound SOAP requests and outbound SOAP responses. When set
to true, Integration Server validates inbound SOAP requests and outbound SOAP
responses. The default is true.
watt.server.SOAP.warnOnPartValidation
When creating a web service descriptor from a WSDL document, indicates whether
Integration Server should treat message parts that are dened by the type aribute
instead of the element aribute as a warning and not an error. Set this parameter to
true to indicate that Integration Server should return a warning and allow the web
service descriptor to be created. Set this parameter to false to indicate that Integration
Server should return an error and not allow the web service descriptor to be created. The
default is false.
watt.server.soapJMS.defaultMessageType
Species the default message type for web service request messages sent using SOAP
over JMS. Set this parameter to "BytesMessage" to send a message whose body contains
a stream of uninterrupted bytes. Set this parameter to "TextMessage" to send a message
whose body contains a Java string. BytesMessage is considered to be a more ecient
way of sending JMS messages. However, you may want to set the parameter to
TextMessage for debugging purposes because the resulting messages will be in a
human-readable format. Keep in mind that the message type of the request message
determines the message type of the response message. The default is BytesMessage.
Important: You must restart Integration Server for changes to this parameter to take
eect.
Note:

The default message type can be overwrien during web service connector
execution by seing the jms.messageType property in the transportHeaders
input parameter.

Note:

If you set this parameter to TextMessage, Integration Server sends

all web service responses as TextMessage. If the request message is a
BytesMessage and wa.server.soapJMS.defaultMessageType is set to
TextMessage, Integration Server overrides the request message type and
sends the response as a TextMessage. This can be useful in debugging
situations.

watt.server.soapjms.request.timeout
Species the number of seconds that Integration Server waits for a response to a SOAP
request sent using SOAP over JMS. This value must be an integer greater than or

webMethods Integration Server Administrators Guide Version 9.10

957

Even Header
Server Configuration Parameters

equal to zero. A value of 0 indicates that Integration Server will wait indenitely for a
response. The default is 10 seconds.
Important: You must restart Integration Server for changes to this parameter to take
eect.
watt.server.SoapRPC.checkHeaders
Indicates whether Integration Server should check SOAP headers for SOAP RPC
requests. The default is true.
Important: You must restart Integration Server for changes to this parameter to take
eect.
watt.server.SoapRPC.distinguishDuplicateElements
Indicates whether Integration Server should dierentiate identically named arrays in
the SOAP response for a SOAP/RPC web service. When set to true, Integration Server
appends a number to the xsi:type value to distinguish between identically named
array elements in the SOAP response, for example elementName and elementName1.
When set to false, Integration Server does not dierentiate identically named arrays in
the SOAP response. The default is true.
watt.server.SoapRPC.useSecondaryType
Instructs Integration Server to use a second type denition when creating the SOAP
response for a service whose input or output signatures contain identically named
variables of dierent types. When creating a WSDL from a provider web service
descriptor that contains a service with identically named elds of dierent types,
Integration Server renames the second instance of the eld type in the WSDL. At run
time, for RPC-Encoded SOAP binding, Integration Server encodes the types in the SOAP
response. When this property is set to true, the SOAP response refers to the renamed
type denition. When set to false, the SOAP response refers to the original type
denition instead of the renamed one. The default is false. This property is applicable
to RPC-Encoded SOAP binding only.
watt.server.ssl.keyStoreAlias
Name of the keystore alias for the Integration Server keystore that contains the
information needed to establish an SSL connection with an SSL-enabled external
server. There is no default value for this parameter. For more information about storing
keystore information for an SSL connection to an external server, see "Storing SSL
Information for the Integration Server JVM in a Secure Manner" on page 415.
Important: You must restart Integration Server for changes to this parameter to take
eect.
watt.server.ssl.trustStoreAlias
Name of the truststore alias for the Integration Server truststore that contains the
information needed to establish an SSL connection an SSL-enabled external server. There
is no default value for this parameter. For more information about storing truststore
information for an SSL connection to a an external server, see "Storing SSL Information
for the Integration Server JVM in a Secure Manner" on page 415.

webMethods Integration Server Administrators Guide Version 9.10

958

Odd Header
Server Configuration Parameters

Important: You must restart Integration Server for changes to this parameter to take
eect.
watt.server.stats.avgTime
Species the time period (in seconds) for which performance metrics are averaged. The
default is 10.
watt.server.stats.logfile
Species the name of the le to receive statistics. The default is logs\stats.log.
watt.server.statsLogRotateInterval
Species the length of the log recycle interval (in minutes) for the stats.log le. The
recycle interval is the period of time that Integration Server retains statistics log records.
The default is 1440 (24 hours).

Integration Server Administrator displays this value as the Log Recycle task on
the Server > Scheduler > View System Tasks page. Integration Server Administrator
displays this value in seconds instead of minutes. For example, if you set
wa.server.statsLogRotateInterval to the default value of 1440, Integration Server
Administrator displays the value for the Log Recycle interval as 86400 seconds. For more
information about viewing system tasks, see "Viewing Scheduled User Tasks" on page
649.
Note:

The wa.serer.statsLogRotateInterval server conguration parameter was

previously named the wa.server.logRotateInterval.

watt.server.stats.pollTime
Species the number of seconds between updates of statistics loggings. For a standalone Integration Server, the wa.server.stats.pollTime must be an integer greater than
or equal to 0 (zero). For an Integration Server in a cluster, the wa.server.stats.pollTime
must be an integer greater than 0 (zero) but less than or equal to 60. The default is 60.
watt.server.storage.addKeyToStoreIfNotPresent
Species whether the pub.storage:lock service adds the specied key to the data store if the
key does not exist in the data store at the time the service executes. Set this parameter
to true to have the pub.storage:lock service add the specied key to the data store if the
key does not exist at the time the service executes. The pub.storage:lock service creates the
specied key, assigns it a NULL value, and then locks the entry in the data store. Set this
parameter to false if you do not want the pub.storage:lock service to add the key to the data
store. The pub.storage:lock service is a NOP (no operation) if the specied key value does
not exist in the data store. The default value is false. For more information about the
pub.storage services, see the webMethods Integration Server Built-In Services Reference.
watt.server.storage.lock.maxDuration
Species the maximum number of milliseconds a pub.storage service will hold a lock.
The default value is 180000 milliseconds (3 minutes). For more information about the
pub.storage services, see the webMethods Integration Server Built-In Services Reference.

webMethods Integration Server Administrators Guide Version 9.10

959

Even Header
Server Configuration Parameters

watt.server.storage.lock.maxWait
Species the maximum number of milliseconds a pub.storage service will wait to obtain a
lock. The default value is 240000 milliseconds (4 minutes). For more information about
the pub.storage services, see the webMethods Integration Server Built-In Services Reference.
watt.server.storage.lock.sweepInterval
Species how often (in seconds) Integration Server deletes expired pub.storage
locks. An expired pub.storage lock is one that is older than the value specied on
the wa.server.storage.lock.maxDuration parameter. The default is 5 seconds. If
the wa.server.storage.lock.sweepInterval parameter is set to a value less than one,
Integration Server ignores the seing and uses 5 seconds instead. Integration Server does
not have to be restarted for changes to this property to take eect. For more information
about the pub.storage services, see the webMethods Integration Server Built-In Services
Reference.
watt.server.strictAccessExceptionLogging
Species whether Integration Server will log HTTP 401 Access Denied as an error and
trigger a notication. When this property is set to true, Integration Server will log HTTP
401 AccessDenied as an error and trigger notications. When this property is set to
false, Integration Server will not log HTTP 401 Access Denied as an error and will not
trigger a notication. The default is false.
watt.server.suppresscwarn
Species whether, when running a C service in Designer, Integration Server should
write the warning messages issued about the missing variables to the server log. When
this property is set to true, Integration Server does not write these messages to the
server log. When this property is set to false, Integration Server writes messages about
missing variables to the server log. The default is false.
watt.server.sync.timeout
Species the time period that a lock object exists for a given key for which a notication
has been issued. After calling a pub.sync:notify service to create the notication, a
pub.sync:wait can receive the notication. Any thread that is waiting for a notication for
the key , receives the notication as long as the lifespan of the wait request overlaps with
the lifespan of the notication. However, if a thread with an exclusive wait is registered
for the notication key before any other service is waiting, the notication ends as soon
as the exclusive wait receives the notication. The default is 60 seconds.
watt.server.thread.aging.limit
Species the length of time, in minutes, a thread can remain in the thread pool. When
this length of time is reached and the thread has been used the maximum number of
times as specied by the wa.server.thread.usage.limit parameter, Integration Server
waits until the service is complete and releases the thread from the pool. A value of
-1 indicates that threads can remain indenitely in the thread pool. The default is 60
minutes.
Note:

Integration Server releases an expired thread only when the values for
both wa.server.thread.aging.limit and wa.server.thread.usage.limit are
reached. Both parameters must be set to a positive integer. If either or both
parameters have a value of -1, both parameters will be disabled.

webMethods Integration Server Administrators Guide Version 9.10

960

Odd Header
Server Configuration Parameters

Important: Use this seing with extreme care because it will aect server
performance and throughput.
watt.server.thread.usage.limit
Species the maximum number of times a pooled thread can be used. When
this maximum number is reached and the length of time specied by the
wa.server.thread.aging.limit parameter is reached, Integration Server waits until the
service is complete and releases the thread from the pool. A value of -1 indicates that
threads can be reused indenitely. The default is 1000.
Note:

Integration Server releases a used thread only when the values for both
wa.server.thread.aging.limit and wa.server.thread.usage.limit are
reached. Both parameters must be set to a positive integer. If either or both
parameters have a value of -1, both parameters will be disabled.

Important: Use this seing with extreme care because it will aect server
performance and throughput.
watt.server.threadKill.enabled
Controls whether the thread kill facility is enabled. This facility allows you to cancel or
kill service threads in cases where a service is unresponsive. When you cancel a thread,
Integration Server frees up resources that are held by the thread. When you kill a thread,
Integration Server stops the thread, releases it from the thread pool, and replenishes
the thread pool. The default is true. When the thread kill facility is enabled, you can
cancel or kill threads by going to the Server > Statistics > System Threads screen. For more
information about canceling and killing threads, refer to "Canceling and Killing Threads
Associated with a Service" on page 637.
watt.server.threadKill.interruptThread.enabled
Species whether Integration Server should interrupt a service for which a timeout
is triggered or is cancelled. If set to true, when a timeout is triggered or the service is
cancelled, Integration Server interrupts the service thread that is executing a service. The
default is false.
Important: If you change the value of this property, you must restart Integration
Server for the change to take eect.
watt.server.threadKill.timeout.enabled
Controls how Integration Server handles the timeout seing of ow steps. Flow
steps have a timeout property that controls how long the step can run. By default
(true), when the step has exceeded the timeout period, Integration Server raises a
FlowTimeoutException, and ow execution continues with the next step. When this
property is set to false, it is possible for the ow step to run beyond its timeout period,
in some cases. For instance, if a ow step calls another service, for example ServiceA,
and ServiceA is executing when the timeout period has passed, ServiceA will continue
executing past the timeout period. When ServiceA ends, it passes control back to the
parent ow service, which then issues an exception.

webMethods Integration Server Administrators Guide Version 9.10

961

Even Header
Server Configuration Parameters

watt.server.threadPool
Species the maximum number of threads that the server maintains in the thread pool
that it uses to run services. If this maximum number is reached, the server waits until
services complete and return threads to the pool before running more services. The
default is 75.
watt.server.threadPoolMin
Species the minimum number of threads that the server maintains in the thread pool
that it uses to run services. When the server starts, the thread pool initially contains
this minimum number of threads. The server adds threads to the pool as needed until
it reaches the maximum allowed, which is specied by the watt.server.threadPool
seing. The default is 10.
watt.server.transaction.recovery.abandonTimeout
If an error occurs while Integration Server tries to resolve an uncompleted XA
transaction, species the maximum length of time (in minutes) during which Integration
Server should make additional aempts. The default is 5 minutes.
watt.server.transaction.recovery.sleepInterval
If an error occurs while Integration Server tries to resolve an uncompleted XA
transaction, species the length of time (in seconds) that Integration Server waits
between additional aempts. The default is 30 seconds.
watt.server.trigger.interruptRetryOnShutdown
Species whether or not a request to shut down the Integration Server interrupts the
retry process for a webMethods messaging trigger service. If this parameter is set to
false, Integration Server waits for the maximum retry aempts to be made before
shuing down. Integration Server will also shut down if the trigger service executes
successfully during a retry aempt. If this parameter is set to true, Integration Server
waits for the current service retry to complete. If the webMethods messaging trigger
service needs to be retried again (the service ends because of an ISRuntimeException),
the Integration Server stops the retry process and shuts down. Upon restart, the
transport (Broker, Universal Messaging, or, for a local publish, the transient store)
redelivers the document to the trigger for processing. The default is false.
watt.server.trigger.keepAsBrokerEvent
Species whether Integration Server should bypass decoding that is normally performed
when documents are retrieved from the Broker on behalf of a webMethods messaging
trigger. If this property is set to true, Integration Server passes the value of the
Broker event to the trigger service in an object called $brokerEvent and no decoding is
performed. Set this parameter to true if Integration Server is receiving native Broker
events. The default is false.
For more information about publishing native Broker events, see the Publish-Subscribe
Developers Guide.

watt.server.trigger.local.checkTTL
Species whether Integration Server should strictly enforce a locally published
document's time-to-live. When this parameter is set to true, before processing a locally
published document in a trigger queue, Integration Server determines whether the

webMethods Integration Server Administrators Guide Version 9.10

962

Odd Header
Server Configuration Parameters

document has expired. Integration Server discards the document if it has expired. The
default is false.
watt.server.trigger.managementUI.excludeList
Species a comma-delimited list of triggers to exclude from the webMethods Messaging
TriggerManagement pages in Integration Server Administrator. Integration Server also
excludes these webMethods messaging triggers from trigger management changes
that suspend or resume document retrieval or document processing for all triggers.
Integration Server does not exclude these webMethods messaging triggers from changes
to capacity, rell level, or maximum execution threads that are made using the global
trigger controls (Queue Capacity Throle and Trigger Execution Threads Throle).
Note:

This server conguration parameter aects only webMethods messaging

triggers that receive messages from the Broker.

You can specify the fully qualied names of all the webMethods messaging triggers that
you want to exclude. You can also use paern matching to exclude a group of triggers
by specifying the beginning portion of the fully qualied name and following it with
an asterisk (*). The Integration Server excludes all triggers that begin with the supplied
paern. For example, if you want to exclude all triggers located in the pub.prt folder,
specify:
watt.server.trigger.managementUI.excludeList = pub.prt*

watt.server.trigger.monitoringInterval
Species the interval, measured in seconds, at which Integration Server executes
resource monitoring services for webMethods messaging triggers. A resource
monitoring service is a service that you create to check the availability of resources used
by a trigger service. When it suspends a webMethods messaging trigger because all
retry aempts have failed, Integration Server executes the resource monitoring service to
determine if all the resources are available. The default is 60 seconds.
For more information about resource monitoring services, see the Publish-Subscribe
Developers Guide.
watt.server.trigger.preprocess.monitorDatabaseOnConnectionException
Indicates whether Integration Server schedules a system task to monitor the document
history database when a ConnectionException causes a transient error occurs during
trigger preprocessing. A ConnectionException indicates that the document history
database is not enabled for exactly-once processing or is not properly congured.
When this property is set to true, Integration Server schedules a system task that
executes an internal service that monitors the connection to the document history
database. When the document history database is enabled for exactly-once processing or
is properly congured, the internal service indicates that the connection to the document
history database is available. Then, Integration Server resumes the trigger and reexecutes it when the connection to the document history database is available.
When this property is set to false, Integration Server does not schedule a system task
to check for the database's availability and will not resume the trigger automatically.
You must manually resume the trigger after conguring the document history database
properly.

webMethods Integration Server Administrators Guide Version 9.10

963

Even Header
Server Configuration Parameters

The default is false

Important: You must restart Integration Server for changes to this parameter to take
eect.
watt.server.trigger.preprocess.suspendAndRetryOnError
Indicates whether Integration Server suspends a trigger if an error occurs during the
preprocessing phase of trigger execution. The preprocessing phase encompasses the
time from when the trigger retrieves the document from its local queue to the time the
trigger service executes. When this property is set to true, the trigger property On Retry
Failure is set to Suspend and retry later, or the trigger property On Transaction Rollback is
set to Suspend and recover, Integration Server suspends a trigger if one of the following
occurs during preprocessing:
A transient error occurs because the document history database is not available
when Integration Server performs duplicate detection for the trigger. For more
information about transient error handling during trigger preprocessing, see
webMethods Service Development Help.
If the document history database is properly congured, Integration Server
suspends the trigger and schedules a system task that executes a service that
checks for the availability of the document history database. Integration Server
resumes the trigger and re-executes it when the service indicates that the
document history database is available.
If the document history database is not properly congured, Integration
Server throws a ConnectionException. To determine how Integration
Server handles a ConnectionException during trigger preprocessing, see
wa.server.trigger.preprocess.monitorDatabaseOnConnectionException.
The document resolver service ends because of an ISRuntimeException.
Integration Server suspends the trigger and schedules a system task to execute
the trigger's resource monitoring service (if one is specied). Integration Server
resumes the trigger and retries trigger execution when the resource monitoring
service indicates that the resources used by the trigger are available. If a resource
monitoring service is not specied, you will need to resume the trigger manually
(via the Integration Server Administrator or the pub.trigger* services).
When this property is set to false and the trigger property On Retry Failure is set to
Throw Exception or the trigger property On Transaction Rollback is set to Recover only,
Integration Server does not suspend the trigger if a trigger preprocessing error occurs. If
the document history database is not available, Integration Server
If the trigger species a document resolver service, Integration Server executes
the document resolver service to determine the status of the document. If the
document resolver service ends because of an ISRuntimeException, Integration
Server assigns the document a status of In Doubt, acknowledges the document,
and uses the audit subsystem to log the document.
If a document resolver service is not specied, Integration Server assigns the
document a status of In Doubt, acknowledges the document, and uses the audit
subsystem to log the document.

webMethods Integration Server Administrators Guide Version 9.10

964

Odd Header
Server Configuration Parameters

Note:

Integration Server uses the audit subsystem to log documents for

webMethods messaging triggers.

The default value for wa.server.trigger.preprocess.suspendAndRetryOnError is false.

Important: You must restart Integration Server for changes to this parameter to take
eect.
For more information about building a resource monitoring service, see the PublishSubscribe Developers Guide or Using webMethods Integration Server to Build a Client for JMS.
For more information about transient error handling during trigger preprocessing, see
webMethods Service Development Help.
watt.server.trigger.removeSubscriptionOnReloadOrReinstall
Species whether Integration Server deletes document type subscriptions for
webMethods messaging triggers when the package containing the trigger reloads or
an update of the package is installed. If this property is set to true (the default) and a
package reloads or an update of the package is installed, Integration Server deletes and
then recreates any document type subscriptions for webMethods messaging triggers
in the package. (If Integration Server connects to a Broker, Integration Server deletes
and recreates the subscriptions on the trigger client on the Broker.) This creates a small
window of time during which the document type subscriptions do not exist. During this
window, the trigger will not receive documents to which it normally subscribes.
If this property is set to false, Integration Server does not delete and then recreate
document type subscriptions for webMethods messaging triggers when the package
reloads or is updated. Although Integration Server creates new document type
subscriptions for triggers, Integration Server does not modify existing subscriptions.
Specically, if a trigger deleted a document type subscription, the subscription will
not be removed when the package reloads or is updated. Consequently, when this
property is set to false, the trigger might receive document types to which it no longer
subscribes because the deleted document type subscriptions still exist on the trigger
client on the Broker. When working with a 6.5.2 version of webMethods Broker, you can
use My webMethods to delete the obsolete document type subscriptions from the trigger
client on the Broker. The default is true.
Note:

This property does not aect webMethods messaging triggers running in

a cluster of Integration Servers nor does it aect webMethods messaging
triggers that receive documents from Universal Messaging.

watt.server.trigger.reuseSession
Indicates whether instances of a webMethods messaging trigger use the same session
on Integration Server when the document locale is the same as the default locale of
Integration Server. When this property is set to true, Integration Server checks the locale
of the document before processing it. If the document locale is the same as the default
locale of Integration Server, or no locale is specied, the trigger uses a shared session.
If the document locale is dierent from the default, then Integration Server creates a
new session for the trigger to use to process that document. When this property is set to
false, Integration Server uses a new session for each instance of a trigger. The default is
false.

webMethods Integration Server Administrators Guide Version 9.10

965

Even Header
Server Configuration Parameters

Reusing sessions for a webMethods messaging trigger might improve performance.

However, this property does not work with all adapters.
watt.server.trigger.suspendOnAuditErrorWhen
Species when Integration Server should suspend a webMethods messaging trigger. A
trigger can be suspended when both the following occur:
The trigger service fails.
The trigger service cannot write audit data to the audit database because an audit
exception occurs.
When Integration Server suspends a webMethods messaging trigger, it halts document
processing and document retrieval for the trigger. Suspending the trigger prevents
Integration Server from acknowledging the document and prevents the messaging
provider from discarding the document. After suspending the trigger, Integration
Server monitors the connection to the audit database and resumes the trigger (document
processing and document retrieval) when the connection to the audit database is reestablished. Integration Server retrieves the unacknowledged document from the
messaging provider and aempts to process it again.
Set the wa.server.trigger.suspendOnAuditErrorWhen parameter to one of the
following values:
Specify...

To...

Never

Indicate that Integration Server does not suspend a trigger

if the trigger service ends because of an error and an audit
exception occurs when the trigger service aempts to
write data to the audit database.

Error

Indicate that Integration Server suspends a trigger if the

trigger service ends because of an error and an audit
exception occurs when the trigger service aempts to
write data to the audit database.

ErrorPipelineEnabled Indicate that Integration Server suspends a trigger if

the trigger service ends because of an error, the trigger

service is congured to include the service pipeline in the
audit log, and an audit exception occurs when the trigger
service aempts to write data to the audit database. The
default is ErrorPipelineEnabled.

Important: You must restart Integration Server for changes to this parameter to take
eect.
The wa.server.trigger.suspendOnAuditErrorWhen conguration parameter only
applies when the audit subsystem is congured to write data synchronously.

webMethods Integration Server Administrators Guide Version 9.10

966

Odd Header
Server Configuration Parameters

watt.server.tspace.location
Species the absolute directory path of the hard disk drive space in which the
Integration Server is to temporarily store large documents rather than keep them in
memory. Each le that the Integration Server stores in this directory is given the name
DocResxxxxx .dat, where xxxxx is a value that can vary in length and character. Specify
the absolute directory path to a directory on the same machine as the Integration Server.
The default value is JVM's temporary directory (i.e., the value of java.io.tmpdir).
Example: If you want the Integration Server to use the LargeDocTemp directory on your
D drive, specify the following:
watt.server.tspace.location=D:\LargeDocTemp

If you have a cluster of Integration Servers, each one must have its own Tspace.
Important: You must restart Integration Server after you modify the value of this
property.
watt.server.tspace.max
Species the maximum number of bytes that can be stored at any one time in the hard
disk drive space that you dened using the watt.server.tspace.location property.
If the Integration Server aempts to write a large document to the hard disk drive space
that will cause the number of bytes you specify to be exceeded, an error message is
displayed on the server console, and the document is not stored. Specify a positive
whole number of bytes. The default value is 52,428,800 bytes (50 MB).
Example: To set the maximum number of bytes that can be stored to 30,000,000 bytes,
specify the following:
watt.server.tspace.max=30000000

Tip:

The size of the hard disk drive space for temporarily saving documents
will vary based on the number of documents that you process concurrently
and the size of the documents that you process. For example, if your
typical concurrent document load is 10, you would need a hard disk drive
space that is 10 to 15 times the combined size of the documents being
processed concurrently.

Important: You must restart the Integration Server after you modify the value of this
property.
watt.server.tspace.timeToLive
Species the amount of time in milliseconds that documents can remain in the Tspace
before they are deleted. If a document remains in the Tspace longer than the value
dened by this parameter, the document expires and becomes eligible for removal from
the Tspace. Expired Tspace documents are removed when the Tspace begins to run low
on free disk space. The default is 0.
Important: You must restart the Integration Server after you modify the value of this
property.

webMethods Integration Server Administrators Guide Version 9.10

967

Even Header
Server Configuration Parameters

watt.server.txMail
Species the email address of an administrator to notify when guaranteed delivery
capabilities are disabled due to an error (for example, if the Integration Server
encounters a disk full condition or if the audit-trail log is full). There is no default.
watt.server.tx.cluster.lockBreakSecs
Species the number of seconds a cluster server waits before breaking a lock on a job in a
cluster job store. The default is 120.
You must be using webMethods Integration Server Clustering to use this seing. For
more information, refer to the webMethods Integration Server Clustering Guide.
watt.server.tx.cluster.lockTimeoutMillis
Species the number of milliseconds a cluster server sleeps between aempts to place an
update lock on a job in a cluster job store. The default is 100.
You must be using webMethods Integration Server Clustering to use this seing. For
more information, refer to the webMethods Integration Server Clustering Guide.
watt.server.tx.heuristicFailRetry
Species whether the Integration Server is to re-execute services for guaranteed delivery
transactions in the job store that are pending when the Integration Server is restarted
after a failure. If a transaction is pending, the service began execution before the
Integration Server failed.
If the seing is true, the Integration Server resets the transaction status from pending to
new, and the service will be re-executed. If the seing is false, the Integration Server
resets the transaction status from pending to fail to indicate the heuristic failure, and the
service will not be re-executed. The default is true.
watt.server.tx.sweepTime
Species the number of seconds between sweeps (clean up) of the job store for inbound
guaranteed delivery transactions. The server sweeps the job store to remove expired
transactions. The default is 60.
watt.server.url.alias.partialMatching
Species whether Integration Server enables partial matching on URL aliases. If you set
this server conguration parameter to trueand dene a URL alias in Integration Server
Administrator, Integration Server enables partial matching on URL aliases. The default
is false.

When partial matching is enabled Integration Server considers an alias a match if the
entire alias matches all or part of the request URL, starting with the rst character of the
request URL path.
For information about partial matching and dening URL aliases, see "Seing Up HTTP
URL Aliases" on page 381. For specic information about partial matching for REST
resources, see REST Developers Guide.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.

webMethods Integration Server Administrators Guide Version 9.10

968

Odd Header
Server Configuration Parameters

watt.server.userFtpRootDir
Species the FTP root directory that the Integration Server will create at startup. When
any Integration Server user logs into the FTP Listener, the server creates that user's
FTP home directory in this root directory, for example FtpRoot/username . You can
specify any directory to be the root directory, including a mapped network directory. If
this property is not dened, a default directory named userFtpRoot is created in your
Integration Server home directory.
The user who connects to Integration Server through FTP listener is placed either
in the default FTP root directory or the client user directory as dened in the
wa.server.login.userFtpDir property.
Administrators, Replicators, and non-privileged users can perform put and get
operations in the following directories:
This user...

Can access...

Administrator

admin (in the Integration Server home directory)

The Administrator's own user directory
The entire namespace for all packages, including WmRoot
All other user directories
The Integration Server_directory\instances
\instance_name \replicate directory

Replicator

Any services in the namespace that have Replicator ACL

or lower
The Replicator's own user directory
Non-privileged
user

The user's own user directory

Any services that have an ACL at or below the level of the
user's ACL

When a user completes a put command in his or her own user directory (that is,
when the STOR command is completed on the server side but before the server
acknowledges the client with return code 226), an event is red to notify interested
parties by publishing a pub.client.ftp:putCompletedNotication document to the
webMethods Broker. EDI packages will subscribe to this document and will retrieve the
le just put onto the server.
Note:

The STOU command is not supported on the Integration Server. However,

it is supported for clients. See the following built-in services in the
webMethods Integration Server Built-In Services Reference: pub.client.ftp,
pub.client.ftp:put, and pub.client.ftp:mput.

webMethods Integration Server Administrators Guide Version 9.10

969

Even Header
Server Configuration Parameters

watt.server.ws.71xHandlerChainBehavior
Species whether Integration Server uses the 7.1x handler chain processing behavior
when executing handlers for a web service descriptor created in 7.1x. When set to true,
Integration Server uses the handler chain processing behavior available in Integration
Server version 7.1x for a 7.1x web service descriptor. When set to false, Integration
Server uses the handler chain processing behavior available in Integration Server 8.0 for
a 7.1x web service descriptor. The default is false.
watt.server.ws.defaultNamespace
This is an internal property. Do not modify.
watt.server.ws.defaultPrefix
Species the prex assigned to the namespace hp://www.webMethods.com/2001/10/
soap/encoding for use in details for SOAP faults. The default is webM.
watt.server.ws.responseTNS.from.request
For a provider web service descriptor for which thePre-8.2 compatibility mode property
is set to true, species whether the target namespace of the top-level element in the
response uses the target namespace of the top-level element in the request. When
set to true, a web service response sent by the Integration Server uses the target
namespace of the top-level element in the request as the top-level namespace of
the response. While this is incorrect behavior, it provides backward compatibility.
If existing web service clients failed because the client expected a response that
used the namespace of the top-level element of the request and you want to allow
existing clients to continue to process responses without any changes to the client, set
wa.server.ws.responseTNS.from.request to true.
When set to false, Integration Server uses the target namespace of the provider web
service descriptor as the namespace of the top-level element in the response. This is the
correct behavior. The default value is false.
Note:

After upgrading to Integration Server 9.10 or later from a version of

Integration Server earlier than 9.10, if you have web service providers that
specify Pre-8.2 compatibility mode = true with existing web service clients
that expect the namespace of the response to match the namespace of
the request, they may fail due to the namespace mismatch. Software AG
recommends regenerating those web service clients using a WSDL
document retrieved from current provider web service descriptor.
Alternatively, set wa.server.ws.responseTNS.from.request to true,
which will revert to behavior of using the namespace of the request on
the response rather than using the namespace as specied in the current
WSDL document. While this behavior may be backward compatible, it
may generate a response that does not match the current WSDL of the
provider web service descriptor. For this reason, Software AG discourages
seing wa.server.ws.responseTNS.from.request to true.

watt.server.ws.security.timestampMaximumSkew
Species the maximum number of seconds that the web services client and host clocks
can dier so that the timestamp expiry validation does not fail. Integration Server
validates the inbound SOAP message only if the creation timestamp of the message is
webMethods Integration Server Administrators Guide Version 9.10

970

Odd Header
Server Configuration Parameters

less than the sum of the timestamp maximum skew value and the current system clock
time.
You can use this parameter to set the timestamp maximum skew value when Integration
Server uses WS-Security policy to implement security and if you have not set a value in
the Timestamp Maximum Skew eld in the Create web Service Endpoints Alias screen. The
value must be a positive integer or zero. The default is 300 seconds.
watt.server.ws.security.timestampPrecisionInMilliseconds
Species whether the timestamp placed in the Timestamp element of the security
header of an outbound message is precise to seconds or milliseconds. If you set the
precision to milliseconds, Integration Server uses the timestamp format yyyy-MMdd'T'HH:mm:ss:SSS'Z'. If you set the precision to seconds, Integration Server uses the
timestamp format yyyy-MM-dd'T'HH:mm:ss'Z'.

You can use this parameter to set the precision when Integration Server uses WS-Policy
to implement WS-Security and if you have not set a value in the Timestamp Precision field
in the Create Web Service Endpoints Alias screen. Set this property to true, if you want
the timestamp precision set to milliseconds. Set this property to false, if you want the
timestamp precision set to seconds. The default is true.
watt.server.ws.security.timestampTimeToLive
Species the time-to-live value for an outbound message in seconds. Integration Server
uses this value to set the expiry time in the Timestamp element of outbound messages.
You can use this parameter to set the time-to-live value when Integration Server uses
WS-Policy to implement WS-Security and if you have not set a value in the Timestamp
Time to Live field in the Create web Service Endpoints Alias screen. The value must be an
integer greater than 0. The default is 300 seconds.
watt.server.wsdl.debug
Species whether Integration Server prints debug information to standard out and
stack traces to standard error while generating or consuming WSDL. When set to true,
Integration Server prints debug information to standard out and stack traces to standard
error. The default is false.
watt.server.xml.encoding
Species the encoding that Integration Server must use when processing incoming XML
les.
If an encoding is not dened in the XML header, Integration Server aempts to process
the XML le using the charset encoding of the hp or ftp request. If charset encoding is
not available in the request header, then Integration Server uses the character encoding
specied in the wa.server.xml.encoding server conguration parameter. There is no
default value for this parameter.
Note:

If you have congured Integration Server to use the character encoding

specied in the wa.server.leEncoding parameter to process incoming
XML les previously, ensure that the value of wa.server.leEncoding
parameter is set to the same value specied for wa.server.xml.encoding.
If you have not congured wa.server.leEncoding for processing XML
les previously, after installing this x or after upgrading to a higher
version of Integration Server, you can congure wa.server.xml.encoding

webMethods Integration Server Administrators Guide Version 9.10

971

Even Header
Server Configuration Parameters

to process incoming XML les. You can use wa.server.leEncoding to

process all les other than incoming XML les.
Important: You must restart Integration Server for changes to this parameter to take
eect.
watt.server.xml.enforceEntityRef
Species whether the server will throw an exception when the XML parser detects a
malformed entity. If the value is set to true, the server will throw an exception when it
detects a malformed entity in an XML or DTD. If the value is set to false (the default),
the server will allow malformed entities and does not throw an exception.
watt.server.xml.xmlNodeToDocument.keepDuplicates
Species whether the pub.xml:xmlNodeToDocument service keeps additional occurrences
of an element in an XML node when arrays are not created (the makeArrays input
parameter is set to false). This parameter also determines whether or not the
pub.event.eda:eventToDocument service keeps additional occurrences of an element in the
XML document passed into the service. When set to true, the document produced by the
pub.xml:xmlNodeToDocument service contains multiple occurrences of the element. When set
to false, the document produced by the pub.xml:xmlNodeToDocument service keeps only the
last occurrence of the element. The default is true.
For example, suppose the following XML node is provided as input to the
pub.xml:xmlNodeToDocument service:
<?xml version="1.0" encoding="UTF-8"?><myDoc><e1
e1Attr="attrValue1">e1Value1</e1><e2>e2Value</e2><e1
e1Attr="attrValue2">e1Value2</e1></myDoc>

When wa.server.xml.xmlNodeToDocument.keepDuplicates is set to true, the

pub.xml:xmlNodeToDocumentservice produces this document:

When wa.server.xml.xmlNodeToDocument.keepDuplicates is set to false, the

pub.xml:xmlNodeToDocument service produces this document:

webMethods Integration Server Administrators Guide Version 9.10

972

Odd Header
Server Configuration Parameters

Note that only the last <e1> element in the source XML is retained in the resulting
document.
watt.server.xml.xmlNodeToDocument.makeArrayforWS
Species how Integration Server decodes duplicate elements contained in an anyType
element. Set wa.server.xml.xmlNodeToDocument.makeArrayforWS to true if you
want Integration Server to create an array for duplicate elements contained in an
element of type anyType. Set this parameter to false if you want Integration Server
to leave duplicate elements as separate, repeated elements in the element dened to
be of type anyType. When set to false, Integration Server does not create an array for
elements that appear more than once in the element dened to be of type anyType. The
default is false.

watt.ssl.
watt.ssl.accelerator.provider
Enables the use of the SSL accelerator provided with a T1/T2 processor on a Solaris 10
OS machine. The only value you can specify with this parameter is SunPKCS11-Solaris.
To use this accelerator, Integration Server must be running with JVM 1.5 and the HSM
Based Keystore eld must be set to true on the Security > Keystore > Create Keystore Alias
screen.
If you do not specify this parameter, SSL ports will be able to use the nCipher accelerator
only. To use this accelerator, the HSM Based Keystore eld must be set to True on the
Security > Keystore > Create Keystore Alias screen.
watt.ssl.entrust.toolkit.ssl.fragmentblockcipher
Species whether the Entrust library is to fragment SSL records when a block cipher is
used.
The Entrust library included with Integration Server addresses an SSL vulnerability
identied in the US-CERT Vulnerability Note VU#864643 (hp://www.kb.cert.org/vuls/
id/864643). The Entrust library changes the way SSL records are fragmented when using
a block cipher such as AES. When a block cipher is used, the Entrust library breaks up
the SSL record into two records: a 1-byte record and a record consisting of the remaining
bytes. This change prevents the exploit from working.
If you need to disable fragmentation of the SSL records for
interoperability, you can disable the fragmentation feature by seing the

webMethods Integration Server Administrators Guide Version 9.10

973

Even Header
Server Configuration Parameters

wa.ssl.entrust.toolkit.ssl.fragmentblockcipher parameter to false. The default value of

this property is true.
watt.ssl.iaik.clientAllowUnboundRenegotiate
Indicates whether Integration Server should block renegotiation with the server when
serving as an SSL client. When this property is set to false (the default), Integration
Server blocks all renegotiation aempts with the server. When set to true, Integration
Server allows all renegotiation aempts.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.ssl.iaik.debug
Indicates whether Integration Server should log SSL handshake communication
messages between the SSL client and SSL server in the server console. If set to true,
Integration Server logs SSL handshake communication messages to the server console.
The default is false.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.ssl.iaik.serverAllowUnboundRenegotiate
Indicates whether Integration Server should block renegotiation with the client when
serving as an SSL server. When this property is set to false (the default), Integration
Server blocks all renegotiation aempts with the client. When set to true, Integration
Server allows all renegotiation aempts.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.

watt.ssh.
watt.ssh.jsch.ciphers
Species a list of ciphers that JSch supports by default. The default values are aes256ctr,aes192-ctr,arcfour,arcfour128,arcfour256. To include any other ciphers that
Integration Server acting as an SFTP client presents to the SFTP server while establishing
a connection, you can append to the default list of ciphers by entering comma-separated
list of cipher names.
Important: If you change the seing of this parameter, you must restart Integration
Server for the changes to take eect.
watt.ssh.jsch.logging
Enables JSch logging. When this property is set to true, all the logs from JSch will be
printed on Integration Server console. The default is false.

webMethods Integration Server Administrators Guide Version 9.10

974

Odd Header
Server Configuration Parameters

watt.wm.tnextdc.
watt.wm.tnextdc.configVersion
This is an internal parameter. Do not modify.

watt.tx.
watt.tx.defaultTTLMins
Species the default time-to-live (TTL) value for outbound guaranteed delivery
transactions. Specify the number of minutes you want the server to maintain outbound
transactions in the job store when a service initiating an outbound transaction does not
specify a TTL value. The default is 30.
watt.tx.disabled
Species whether you want to disable the use of guaranteed delivery for outbound
transactions. By default, the server allows the use of guaranteed delivery for outbound
transactions. The default is false.
watt.tx.heuristicFailRetry
Species whether Integration Server is to re-execute services for guaranteed delivery
transactions in the job store that are pending when Integration Server is restarted after
a heuristic failure. If the transaction status is pending, it means that the service began
execution before Integration Server failed.
If wa.tx.heuristicFailRetry seing is true, Integration Server resets the transaction
status from pending to new, and Integration Server will retry the service. When the
seing is true, a request to execute a service can only fail if the transaction expires
before Integration Server executes the service.
If the seing is false, Integration Server resets the transaction status from pending to
fail to indicate the heuristic failure, and Integration Server does not retry the service.
When the seing is false, a request to execute a service can fail due to a heuristic failure
or due to the transaction expiring.
The default is true.
watt.tx.jobThreads
Species the number of client threads you want to make available in a thread pool to
service pending requests in the outbound guaranteed delivery job store. The default is 5.
watt.tx.retryBackoffTime
Species the number of seconds to wait after a service request failure before the Job
Manager resubmits the request to execute the service to the Integration Server. The
default is 60.

webMethods Integration Server Administrators Guide Version 9.10

975

Even Header
Server Configuration Parameters

watt.tx.sweepTime
Species the number of seconds between sweeps of the job store of outbound
guaranteed delivery transactions. The server sweeps the job store to identify transactions
that it needs to submit. The default is 60.
watt.tx.vm.id
Species an Integration Server ID. Use this parameter when multiple Integration
Servers are running on the same host machine and they all use guaranteed delivery. By
specifying a unique ID for each Integration Server, you prevent the creation of duplicate
guaranteed delivery transaction IDs. The value must be an integer from 0 through
2147483647. The default is 0.

watt.xslt.
watt.xslt.debug.facList
Identies the facilities for which Integration Server logs XSLT information. The default is
999, which indicates that Integration Server is to log information for all XSLT facilities.
If you do not want Integration Server to log information for any XSLT facilities, specify
1000. If you want to log information for certain XSLT facilities only, specify the numbers
for those facilities in a comma-delimited list. The facilities are as follows:
Number

Facility

Description

SAX

SAX parsing-related information.

JAXP

JAXP-related information, including messages for

XML parsers and XSLT engines.

XSLT services

XSLT servicespublic service information.

Admin
services

XSLT servicesnon-public administrative service

information.

999

All services

Default. Logs information for all services.

1000

None

Will not log information for any facilities.

Note:

Software AG recommends that you use the Settings > Logging > View
Server Logger Details screen to specify the facilities for which Integration
Server logs XSLT information, instead of changing the value of the
wa.xslt.debug.facList parameter.

webMethods Integration Server Administrators Guide Version 9.10

976

Odd Header
Server Configuration Parameters

watt.xslt.debug.level
Sets the level of debugging information for XSLT services that Integration Server records
in its log le. The default is the level that is currently set for Integration Server. For
information on logging levels, see webMethods Audit Logging Guide.
Note:

Software AG recommends that you use the Settings > Logging > View Server
Logger Details screen to specify the debug level, instead of changing the
value of the wa.xslt.debug.level parameter.

watt.xslt.debug.logfile
Identies the fully qualied name of the le to which Integration Server writes
debugging information. The default is packages/WmXSLT/logs/xslt.log, which is in
the server instances home directory.
Note:

If you start Integration Server from the command prompt using the -log
none switch, it overrides the value assigned to wa.xslt.debug.logle for
this session. Instead, Integration Server displays logging information on
the computer console where you started Integration Server.

webMethods Integration Server Administrators Guide Version 9.10

977

Even Header

webMethods Integration Server Administrators Guide Version 9.10

978

Odd Header
FIPS 140-2 Compliance

C FIPS 140-2 Compliance

FIPS 140-2 Compliance .............................................................................................................

webMethods Integration Server Administrators Guide Version 9.10

980

979

Even Header
FIPS 140-2 Compliance

FIPS 140-2 Compliance

webMethods Integration Server Version 9.0 and later embeds the Entrust Authority
Security Toolkit for Java 8, which has obtained FIPS 140-2 validation. FIPS (Federal
Information Processing Standards) provides standards for information processing for
use within the Federal government. The policy for Version 8 is available at the following:
hp://csrc.nist.gov/groups/STM/cmvp/documents/140-1/1401val2012.htm#1839
Many government and nancial organizations require that their software be FIPS
140-2 compliant, which follows the current standards and guidelines for cryptographic
information processing.
Note:

Integration Server itself is not considered to be FIPS 140 certied.

Running Integration Server in FIPS 140-2-compliant mode ensures that it only uses FIPS
compliant algorithms in the FIPS compliant modes. You can enable FIPS mode by seing
the following extended seing on the Integration Server:
wa.security.ps.mode=true
Refer to "Server Conguration Parameters" on page 851 for a detailed description of this
server conguration parameter. Also, refer to "Working with Extended Conguration
Seings" on page 130 for instructions on viewing and updating extended seings for the
Integration Server.
In addition to running the server in FIPS compliant mode, you must follow the other
instructions in the Entrust Cryptographic Module Security Policy. The instructions
include implementing safeguards such as not allowing multiple users to access the
computer and ensuring that the computer is physically protected. In particular,
see section 5.4 of that document ("Operational Environment"). Depending on your
organization's policies, you might also be required to use the same hardware, operating
system, and JDK as was used in the Entrust approval.
FIPS mode encryption is only applicable to HTTPS or FTPS communications and S/
MIME encryption/signing.

webMethods Integration Server Administrators Guide Version 9.10

980

Odd Header
Using NTLM Authentication and Integrated Windows Authentication with Integration Server

D Using NTLM Authentication and Integrated Windows

Authentication with Integration Server

Overview .....................................................................................................................................

982

Using NTLM Authentication when Integration Server Acts as the Client ...................................

982

Working with Integrated Windows Authentication ......................................................................

982

Activating and Deactivating Integrated Windows Authentication ...............................................

983

webMethods Integration Server Administrators Guide Version 9.10

981

Even Header
Using NTLM Authentication and Integrated Windows Authentication with Integration Server

Overview
This appendix explains how to use NTLM authentication with Integration Server when
Integration Server acts as the client. This appendix also explains how to use Integrated
Windows authentication with Integration Server.

Using NTLM Authentication when Integration Server Acts as

the Client
Integration Server supports NTLM (Windows NT LAN Manager) authentication
on the connection from the Integration Server to web servers that support NTLM
authentication, such as Microsoft Internet Information Server (IIS). Support for NTLM
authentication allows clients that are already logged into a domain to be authenticated
using their existing credentials. When acting as a client, Integration Server responds to
an NTLM challenge from a web server with the appropriate authentication credentials,
whether Integration Server runs on Windows, UNIX, or another supported platform.
To use NTLM authentication with Integration Server 9.7 and higher, the authentication
credentials have to be provided by the user explicitly. Consequently, while providing
the authorization information, you must prex the domain name followed by
a backslash (\) before the username. For example, when using NTLM as the
authentication type for an invocation of the pub.client:http service, you must specify a
value for the user input parameter using the format: domain_name \user_name
Note:

Prior to version 9.7, Integration Server could use Integrated Windows

authentication as a means of authenticating its identity while establishing
connections between Integration Server and web servers on an intranet
only if the Integration Server was running in Windows platforms. When
Integration Server is running as an NT service, it uses the local system rights
for authentication when responding to an Integrated Windows authentication.
If you log on as a user, Integration Server uses the credentials associated with
that session when responding to an Integrated Windows authentication.

Working with Integrated Windows Authentication

When Integration Server executes services that access web pages, it behaves like a web
client making a request to a web server. If the web server is running Microsoft Internet
Information Server (IIS), Integration Server can use Integrated Windows authentication as
a means of establishing its identity. Integrated Windows authentication authenticates
a user without requiring the transmission of actual passwords or sensitive account
information across the network.

webMethods Integration Server Administrators Guide Version 9.10

982

Odd Header
Using NTLM Authentication and Integrated Windows Authentication with Integration Server

Note:

Although this appendix refers to the Microsoft Internet Information Server

(IIS), the information applies to any web server that supports Integrated
Windows authentication.

You can use Integrated Windows authentication for connections between Integration
Server and web servers on an intranet. Integration Server supports Integrated Windows
authentication on the connection from the Integration Server to a proxy; however, it does
not support Integrated Windows authentication on the connection from a proxy to the
Internet.
If Integration Server is running as an NT service, it uses the local system rights for
authentication when responding to an Integrated Windows authentication. If you log on
as a user, Integration Server uses the credentials associated with that logon session when
responding to an Integrated Windows authentication.

Activating and Deactivating Integrated Windows

Authentication
You must rst activate Integrated Windows authentication on Integration Server before
using it. Once Integrated Windows authentication is activated, Integration Server
automatically responds to its requests.

Activating Integrated Windows Authentication

To activate Integrated Windows authentication
1. Open Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. If the WmWin32 package is not already enabled, enable it by clicking No in the
Enabled column for this package.
4. In the list of packages, click WmWin32.
Note:

The WmWin32 package is deprecated as of Integration Server 7.1.

5. Click Browse Services in WmWin32.

6. In the list of services, click wm.ntlm:reg.
7. Click Test reg. The server displays the test screen for the win32.ntlm.reg service.
8. Click Test (without inputs). The server activates Integrated Windows authentication.
Note:

If you want Integrated Windows authentication available whenever

Integration Server is running, make the win32.ntlm:reg service a startup
service for the Win32 package. For more information about assigning
startup services, see webMethods Service Development Help.

webMethods Integration Server Administrators Guide Version 9.10

983

Even Header
Using NTLM Authentication and Integrated Windows Authentication with Integration Server

Deactivating Integrated Windows Authentication

To deactivate Integrated Windows authentication
1. Open the Integration Server Administrator if it is not already open.
2. In the Packages menu of the Navigation panel, click Management.
3. In the list of packages, click WmWin32.
4. Click Browse services in WmWin32.
5. In the list of services, click wm.ntlm:unreg.
6. Click Test unreg. The server displays the test screen for the win32.ntlm.unreg service.
7. Click Test (without inputs). The server deactivates Integrated Windows authentication.

webMethods Integration Server Administrators Guide Version 9.10

984

Odd Header
Wireless Communication with the Integration Server

E Wireless Communication with the Integration Server

Overview .....................................................................................................................................

986

How Does the Integration Server Communicate with Wireless Devices? ..................................

986

Using URLs for Wireless Access to the Integration Server .......................................................

988

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

990

webMethods Integration Server Administrators Guide Version 9.10

985

Even Header
Wireless Communication with the Integration Server

Overview
The webMethods Integration Server can receive requests from and send responses to
Internet-enabled wireless devices. A wireless device requests information from the
Integration Server the using a URL. The responses sent by the server contain WML
(Wireless Markup Language) content or HDML (Handheld Device Markup Language)
content. Examples of wireless devices that the Integration Server can communicate
with include Internet-enabled wireless phones and Internet-enabled personal digital
assistants.
You might want to use a wireless device to communicate with the Integration Server to:
Check inventory levels at your company or at a supplier.
Place an order or check the status of an existing order.
Receive order conrmation for an order submied with a wireless device.
Send or receive notication to alert subscribers to trade fulllments of security price
changes.
Collect statistics about your Integration Server by using event handlers that send
information to wireless devices.
Request an HDML or WML page stored on the Integration Server.
You access the Integration Server from a wireless device by entering a URL in the web
browser of wireless device. The URL can invoke a service on the Integration Server or
can request a WML or HDML page stored on the Integration Server.

How Does the Integration Server Communicate with Wireless

Devices?
The Integration Server communicates with wireless devices by means of a wireless
gateway. The wireless gateway (sometimes called a WAP gateway) converts a request
from a wireless device to an HTTP request. The wireless gateway also converts the
HTTP response from the Integration Server to a format understood by the web browser
or micro-browser on the wireless device.
The following diagram illustrates how the Integration Server communicates with an
Internet-enabled wireless device.

webMethods Integration Server Administrators Guide Version 9.10

986

Odd Header
Wireless Communication with the Integration Server

Communication Between the Integration Server and a Wireless Device

Stage

Description

A user requests a URL using a web browser on a wireless device

such as a wireless phone or a personal digital assistant (PDA). The
URL indicates the service to be invoked or identies the requested
WML or HDML page. The wireless device sends an encoded request
to the wireless gateway.

The wireless gateway (such as a Phone.com's Up.Link Server or

Nokia Active Server) decodes the request from the wireless device,
creates an HTTP or HTTPS request (depending on what is specied
in the URL) for the specied URL, and sends it to the Integration
Server.

The Integration Server does one of the following depending on what

the user requested in the URL:
Executes the service specied in the URL and inserts the service
results into the assigned WML or HDML output template.
-ORRetrieves the WML or HDML page requested in the URL.

The Integration Server sends an HTTP or HTTPS response to the

wireless gateway.

The wireless gateway removes the HTTP or HTTPS header from

the response and sends an encoded response containing the HDML
or WML content to the wireless device. The web browser on the
wireless device decodes the response and displays the WML or
HDML results.

webMethods Integration Server Administrators Guide Version 9.10

987

Even Header
Wireless Communication with the Integration Server

For more information about wireless gateways and wireless protocol, see
www.wapforum.org.

Using URLs for Wireless Access to the Integration Server

To use a wireless device to access information or invoke services on the Integration
Server, you need to use the device's web browser to enter or select a URL. The following
sections explain how to invoke a service with a URL and how to request a WML or
HDML page with a URL.
Note:

Some web browsers for wireless devices place limitations on the length of
a URL that a user can enter or select. Make sure any WML or HDML pages
that you create for use with wireless devices are compliant with browser
requirements.

Note:

To minimize the amount of user input and therefore reduce the possibilities
for input errors, embed hyperlinks to URLs in the WML or HDML page.

Invoking a Service with a URL

You can use a URL to invoke a service from an Internet-enabled wireless device. You can
request a URL by entering the URL into the web browser directly or by selecting a link
for the URL that is embedded into a HDML or WML page. In either case, the URL needs
to be in the following format:

Item
1

Description
Identies the name and port number for the Integration Server on
which the service you want to invoke resides.
Important:For wireless access, the server name (localhost) must be
a registered domain name; that is, the server needs to be
accessible via the Internet.
Important:Many wireless gateways use port 80 as the default registered
port number. If you want to use a dierent port number,
make sure to register the server name and port number with
the wireless gateway. (For security reasons, Software AG
discourages using port numbers below 1024. For more
information, see "Seing Up Aliases for Remote Integration
Servers" on page 117.

webMethods Integration Server Administrators Guide Version 9.10

988

Odd Header
Wireless Communication with the Integration Server

Item

Description

Species the required keyword "invoke", which tells the Integration

Server that the URL identies a service that is to be invoked.

Identies the folder in which the service to invoke resides. Separate

subfolders with periods. This eld is case sensitive. Be sure to use
the same combination of upper and lower case leers as specied in
the folder name on the Integration Server.

Identies the service that you want to invoke. This eld is case
sensitive. Be sure to use the same combination of upper and lower
case leers as specied in the service name on the Integration Server.

Species the input values for the service. Specify a question mark
(?) before the input values. The question mark signals the beginning
of input values. Each input value is represented as a variable =value
pair. The variable portion is case sensitive. Be sure to use the same
combination of upper and lower case leers as specied in your
service. If your service requires more than one input value, separate
each variable =value pair with an ampersand (&).
Note:

Only specify this part of the URL when using the HTTP GET
method.

For more information about invoking a service with a URL, see "Building a Browser
Based Client" in webMethods Service Development Help.
Note:

If you use the URL to invoke a service, make sure that the service applies
the output to the appropriate template type (WML or HDML). For more
information about creating output templates, see the Dynamic Server Pages and
Output Templates Developers Guide.

Requesting a WML or HDML Page with a URL

You can use an Internet-enabled wireless device to request a WML or HDML page
stored on the Integration Server. By entering a URL in the web browser of a wireless
device or by selecting a hyperlink to a URL, you can access any WML or HDML page
stored in the following directory:
Integration Server_directory\instances\instance_name \packages\packageName \pub
Where packageName is the name of the package in which the WML or HDML le is
saved.
The URL you enter in the web browser needs to adhere to the following format:

webMethods Integration Server Administrators Guide Version 9.10

989

Even Header
Wireless Communication with the Integration Server

Item
1

Description
Identies the name and port number for the Integration Server on
which the le you want to request resides.
Important:For wireless access, the server name (localhost) must be
a registered domain name; that is, the server needs to be
accessible outside via the Internet.
Important:Many wireless gateways use port 80 as the default registered
port number. If you want to use a dierent port number,
make sure to register the server name and port number with
the wireless gateway. (For security reasons, Software AG
discourages using port numbers below 1024. For more
information, see "Seing Up Aliases for Remote Integration
Servers" on page 117.)

Identies the package in which the WML or HDML le you want to

request resides.

Species the pub directory. WML and HDML les that can be served
to wireless devices need to reside in this directory.
Note:

You do not need to specify the pub directory. Integration

Server automatically looks in pub for the requested le if no
directory is specied.

Identies the le you want to request.

For example, the following URLs access the hello.wml le from the pub directory for the
Wireless package:
hp://localhost:5555/Wireless/pub/hello.wml
-ORhp://localhost:5555/Wireless/hello.wml

WML and HDML Samples

The webMethods Integration Server provides sample services, WML les, HDML les,
and output templates that you can use to view how wireless devices communicate
webMethods Integration Server Administrators Guide Version 9.10

990

Odd Header
Wireless Communication with the Integration Server

with the Integration Server. These les are located in the sample.wirelessfolder in the
WmSamples package. These samples provide examples of services that you might create
to enable wireless devices to order products, view order history, obtain Integration
Server statistics, and request the current date and time.
For more information about using these samples, see the following le:
WmSamples\pub\WAPDemo.htm
You can nd the WmSamples package in the certied samples area of the Knowledge
Base on the Empower Product Support website.

webMethods Integration Server Administrators Guide Version 9.10

991

Even Header

webMethods Integration Server Administrators Guide Version 9.10

992

Odd Header
Debugging Service Exceptions Using the Error Log

F Debugging Service Exceptions Using the Error Log

Introduction .................................................................................................................................

994

Controlling the Level of Exception Logging Detail .....................................................................

994

Displaying the Error Log ............................................................................................................

994

Interpreting the Error Log ...........................................................................................................

995

webMethods Integration Server Administrators Guide Version 9.10

993

Even Header
Debugging Service Exceptions Using the Error Log

Introduction
The Integration Server error log maintains information about exceptions that are
thrown by services. This appendix describes how to use this log to help debug service
exceptions.

Controlling the Level of Exception Logging Detail

You can control how the Integration Server logs service exceptions, and to what level
of detail, by seing the watt.server.deprecatedExceptionLogging parameter. The
information in this appendix assumes that this parameter is set to its default seing,
false, which provides more detailed exception logging. For more information about
this parameter, see "Server Conguration Parameters" on page 851.

Displaying the Error Log

In Integration Server Administrator, go to the Logs > Error page to view the error log. The
elds in the error log are listed below.
Column

Details

Timestamp

Date and time the entry was wrien to the log.

Service Name

Name of the service in which the exception occurred.

Service Stack

Parent services for the service in which the exception

occurred.

Error Message

Message that describes the exception that occurred.

Stack Trace

Trace that shows the call sequence leading to the exception.

To expand the display of stack trace data, select the Expand
Stack Trace Data check box in the Log display controls area and
click Refresh.

Root Context

Context information webMethods Monitor uses to connect

related entries from dierent logs.

Parent Context
Current Context

webMethods Integration Server Administrators Guide Version 9.10

994

Odd Header
Debugging Service Exceptions Using the Error Log

Interpreting the Error Log

The following image shows a portion of the error log that includes details that help you
identify which step caused an exception. The Integration Server Administrator displays
these details when you perform two actions:
Set the value of the wa.server.deprecatedExceptionLogging parameter to its default
seing, false.
Select the Expand Stack Trace Data check box on the Logs > Error page.
Integration Server error log showing detailed exception logging.

Understanding the Service Stack

The Service Stack column shows the Java services and ow services called up to the point
at which the exception occurred. The stack lists services in the following order:

webMethods Integration Server Administrators Guide Version 9.10

995

Even Header
Debugging Service Exceptions Using the Error Log

For ow services, the Service Stack column also shows an indexed path that identies the
step within a service at which the exception occurred. The path takes the form /n/n/n...,
where n represents a sequential index of ow steps and / indicates a level of nesting:

This path helps pinpoint the step at which the exception occurred and is particularly
useful when a ow service is called multiple times or when the service or step is deeply
nested. For example, suppose serviceA invokes serviceB three times, and the exception
occurred at the second invocation of serviceB. The Service Stack column in the error log
would show the path as serviceA(/1/2):
Step

Index

INVOKE serviceB

/0

SEQUENCE

/1

INVOKE serviceD

/1/0

INVOKE serviceE

/1/1

INVOKE serviceB

/1/2 (exception thrown here)

SEQUENCE

/2

INVOKE serviceC

/2/0

INVOKE serviceB

/2/1

webMethods Integration Server Administrators Guide Version 9.10

996

Odd Header
Debugging Service Exceptions Using the Error Log

Understanding the Error Messages

When you specify detailed exception logging, the error log's Error Message column shows
the error message that corresponds to the exception and a concatenation of the error
messages from each of the nested exceptions. The format of these messages is as follows:
Outer exception message
Caused by: middle.exception.className: Middle exception message
Caused by: inner.exception.className: Inner exception message

In addition to the standard error message text that Integration Server provides (for
example, "[ISS.0062.9021] "object" is null"), exception messages may also contain
additional, customized text that a service developer provides in the error handling
portion of the service.

Understanding the Stack Trace

Exceptions often contain other exceptions nested within them. The extent to which the
Stack Trace column reports the call sequence leading to the exceptions depends on the
seing you select for the watt.server.deprecatedExceptionLogging parameter, as
follows:
If this parameter is set to false (detailed exception logging), the error log's Stack
Trace column shows the innermost stack trace (that is, the stack trace that points to
the source of the problem).
If this parameter is set to true (basic exception logging), the stack trace is often
truncated and the cause of the exception becomes more dicult to trace. For this
reason, Software AG recommends that you do not set this parameter to true unless
you are executing services that catch exceptions and do not rethrow them.

webMethods Integration Server Administrators Guide Version 9.10

997

Even Header

webMethods Integration Server Administrators Guide Version 9.10

998

Odd Header
Server Log Facilities

G Server Log Facilities

About Server Log Facilities ......................................................................................................

1000

Integration Server .....................................................................................................................

1000

WmMobileSupport Package .....................................................................................................

1007

WmXSLT Package ...................................................................................................................

1008

Flat File ....................................................................................................................................

1008

Mediator ....................................................................................................................................

1008

webMethods Integration Server Administrators Guide Version 9.10

999

Even Header
Server Log Facilities

About Server Log Facilities

Server logging provides operational and error information from Integration Servers
major subsystems, called facilities.
You can select the facilities that you want Integration Server to include in the server log.
For more information about the server log, see "Seing Up the Server Log" on page 215.

Integration Server
The table below gives the list of Integration Server facilities for which the server logs
information.
Facility

Information and errors related to...

0000

General Debugging

Types of information that do not belong to

other listed facilities.

0001

License Manager

License manager of Integration Server.

0002

LDAP Connection

LDAP server connections.

0003

Database
Connection
Manager

Database connections.

0004

JDBC Connection

JDBC connection pools.

0006

Server SSL Interface

Integration Server SSL connection.

0007

Authorization

Authorization in Integration Server.

0008

NIS Connection

Network information services server that

contains network resource information just like
LDAP servers.

0009

Certicate

Handling, managing, and processing

certicates.

0011

Proxies

Proxy servers.

webMethods Integration Server Administrators Guide Version 9.10

1000

Odd Header
Server Log Facilities

Facility

Information and errors related to...

0012

Authentication

Authentication to Integration Server.

0013

Content Handler

Content handlers.

0014

Server

Integration Server startup and shutdown,

thread pooling, and other low-level parts of
Integration Server. Includes license managerrelated error managers that were not included
in the 0001 License Manager facility.

0015

Service Manager

Flow and coded services that run in Integration

Server.

0016

Service Caching

Service caching.

0017

Ehcache

Ehcache conguration.

0018

Utility classes

Utility classes used by Integration Server.

0021

Integration Cloud

Integration Cloud activities.

0022

Code Generation

Code generated using Designer for

implementing a service or for calling a service
from another service or client.

0024

User Manager

User management.

0025

Server Initialization

Server initialization.

0026

Services

Flow and coded (for example, Java) services

that run in Integration Server.

0027

Server
Conguration

HSM based keystores and nCiphers.

0028

Packages

Loading, unloading, and other operations of

packages.

0033

Cluster Manager

Clustered Integration Servers.

0036

Client Context

Client transactions.

webMethods Integration Server Administrators Guide Version 9.10

1001

Even Header
Server Log Facilities

Facility

Information and errors related to...

0037

Guaranteed
Delivery Context

Guaranteed delivery transactions.

0038

HTTP Header

HTTP headers.

0039

HTTP Request

HTTP requests to Integration Server.

0040

HTTP Response

HTTP responses from Integration Server.

0041

HTTP Cookie

HTTP cookies.

0042

XML Parser

XML parser.

0043

XML Parse Stream

XML parser reading XML data from a stream.

0046

HTTP Listener

HTTP listeners.

0047

HTTPS Listener

HTTPS listeners.

0048

Misc. Server Error

Messages

Miscellaneous errors that were not included in

the 0014 Server facility.

0049

Flow Operation

Flow operations.

0050

Flow Map

MAP steps in ow services and mapping of

pipeline data in INVOKE steps.

0051

Port Manager

Integration Server ports.

0053

HTTP Dispatch

Processing of HTTP requests.

0054

HTTP Document
Handler

Document handlers registered for an HTTP

response.

0055

Java Services

Java services.

0056

Mailer

Mailer that Integration Server uses.

0057

Deployer

Deployer.

webMethods Integration Server Administrators Guide Version 9.10

1002

Odd Header
Server Log Facilities

Facility

Information and errors related to...

0059

Service Thread

Service thread.

0061

Remote Servers

Remote servers.

0062

Core Services

XML and XQL processing.

0063

Transaction Job
Manager

Transaction manager.

0064

Network Services

Network services.

0068

Email Listener

E-mail listeners.

0070

Listeners

Listeners dened on Integration Server.

0071

FTP Listener

FTP listeners.

0072

Reporter

DSP processing.

0075

WmDB

WmDB package.

0076

Coders

Coders such as IDataBinCoder that Integration

Server uses to serialize Java objects into bytes
for storing into les or for sending on the
network, and vice versa.

0077

com.wm.util

com.wm.util coder.

0079

Enterprise Gateway

webMethodsEnterprise Gateway Server

activity.

0080

Asynchronous
Connection API

Network sockets.

0081

Namespace

Namespace congurations.

0082

XML Schema

XML Schema.

0085

WmRoot Package

WmRoot package.

webMethods Integration Server Administrators Guide Version 9.10

1003

Even Header
Server Log Facilities

Facility

Information and errors related to...

0087

WmWin32 Package

WmWin32 package.

0088

SOAP

SOAP messages.

0090

pub Flow Services

Certicates processing, pub.ow services, and

WSDL processing.

0091

WmRoot Admin
Services

WmRoot admin services.

0094

Repository V4

Repository Version 4.

0095

Audit Log Manager

Audit log manager.

0096

JDBC Connection
Manager

JDBC connection pools.

0097

Broker Document
Type Synchronizer

Synchronizing publishable document types

with the associated provider denitions on
the messaging provider (Broker or Universal
Messaging).

0098

Dispatcher

Triggers, JMS clients on Broker, and Broker

clients.

0099

Broker Transport
Layer

Broker connectivity.

0100

Web Container

Tomcat JSP engine and the component that

hosts the Tomcat JSP engine.

0101

Process Runtime

WmPRT package.

0105

Cross-referencing
and Latching

Cross-referencing and latching in Integration

Servers that belong to a cluster.

0106

Join Manager

Joins used in trigger processing.

0109

Server Statistics

Integration Server statistics for session and

thread activity.

webMethods Integration Server Administrators Guide Version 9.10

1004

Odd Header
Server Log Facilities

Facility

Information and errors related to...

0114

Adapter Runtime

Adapter runtime facilities.

0115

Adapter Runtime
(Listener)

Adapter listeners that use adapter connections

to connect to adapter resources.

0116

Adapter Runtime
(Notication)

Adapter notications including polling and

listener notications.

0117

Adapter Runtime
(Adapter Service)

Adapter services that dene operations that the

adapter will perform on adapter resources.

0118

Adapter Runtime
(Connection)

Adapter connections that contain parameters

that adapter notications and listeners use to
connect to an adapter resource.

0119

Monitor

webMethods Monitor.

0120

Monitor (Database
Layer)

webMethods Monitor database layer.

0121

Adapter Runtime
(SCC Transaction
Manager)

Adapter Runtime (JCA System Contract

Component Transaction Manager).

0123

Basis FSData

File system used as an underlying storage

system for other Integration Server components
such as the repository, temporary store, and
at le logging. Provides detailed information
about errors encountered by those components.

0125

Supervisory Control
Mechanism

Resources in Integration Server to prevent

resource (memory, thread, or disk) starvation.
Currently only controls resources assigned to
publish/subscribe and the thread pools.

0126

Adapter Runtime
(SCC Connection
Manager)

Adapter Runtime (JCA System Contract

Component Connection Manager).

0127

Basis Transient
Store

Temporary stores, such as the one used for

logging.

webMethods Integration Server Administrators Guide Version 9.10

1005

Even Header
Server Log Facilities

Facility

Information and errors related to...

0128

Exactly Once
Processor

Exactly-once processing for webMethods

messaging triggers or JMS triggers.

0129

.NET Package

.NET services.

0130

Mainframe Package

Mainframe package.

0131

Diagnostic Port

Integration Server diagnostic port.

0132

Version Control
System

Version Control System Integration feature in

Integration Server.

0133

DOM
Implementation

Used when XML Node is created as DOM

Node or used as a DOM Node

0134

JMS Subsystem

JMS Subsystem.

0135

JNDI Client
Conguration

JNDI Client Conguration.

0137

User Task Scheduler

User created scheduled tasks.

0138

Asset Publisher

Asset Publisher package.

0139

Keystore

Keystores.

0140

Designer

Software AG Designer

0141

Web Service stack

Web service stack.

0142

Thread Kill

Thread kill facility that you can use to cancel or

kill service threads in cases where a service is
unresponsive.

0144

XML Security
Services

The pub.security.xml services.

0147

SFTP Client

Integration Server functioning as an SFTP

client.

webMethods Integration Server Administrators Guide Version 9.10

1006

Odd Header
Server Log Facilities

Facility

Information and errors related to...

0149

Enterprise Gateway
Rules

webMethods Enterprise Gateway rules.

0150

SPM

Software AG Platform Manager subsystem in

Integration Server.

0151

Monitoring (CMP)

Content monitoring platform.

0152

CORS

CORS (Cross-Origin Resource Sharing)

support.

0153

Dispatcher
(Universal
Messaging)

Triggers that receive messages or documents

from Universal Messaging.

0154

Protocol Buer
Encoding
(Universal
Messaging)

Protocol buer encoding and decoding.

0155

Hot Deployment

Hot deployment of Integration Server assets.

0156

Event Routing

The pub.event.routing services in WmPublic.

0157

Assets

The pub.assets services in WmPublic.

0158

OData

OData services.

WmMobileSupport Package
The table below gives the list of WmMobileSupport package facilities for which the
server logs information.
Facility
0701

Information and errors related to...

CORE

webMethods Mobile Support service execution.

webMethods Integration Server Administrators Guide Version 9.10

1007

Even Header
Server Log Facilities

WmXSLT Package
The table below gives the list of WmXSLT package facilities for which the server logs
information.
Facility

Information and errors related to...

0001

SAX

SAX parsing-related information.

0002

JAXP

JAXP-related information, including messages for

XML parsers and XSLT engines.

0003

Services

XSLT services public service information.

0004

Admin Services

XSLT services non-public administrative service

information.

Flat File
The table below gives the list of at le facilities for which the server logs information.
Facility

Information and errors related to...

0000

FlatFile Logger

Flat le processing.

0001

FlatFile Listener

Flat le polling listeners.

0002

FlatFile Parser

Flat le parsers.

Mediator
The table below gives the list of Mediator facilities for which the server logs information.
Facility

Information and errors related to...

0001

Event Logging

Mediator events like SNMP sender, log formaers.

0010

Core

Service deployment.

webMethods Integration Server Administrators Guide Version 9.10

1008

Odd Header
Server Log Facilities

Facility

Information and errors related to...

0030

CentraSite
Communication

Communication messages between CentraSite and

Mediator.

0050

Runtime

Mediator runtime execution

0070

Mediators

Policies executed by Mediator

0100

Mediator
Listener

Incoming messages before Mediator receives a

request.

0110

Mediator
Incoming
Messages

Incoming messages after Mediator receives a

request.

0120

Mediator
Transformation
Logging

Deprecated. Use 0070-Mediators.

0200

Monitor
and Event
Notication
(MEN)

Monitoring and Event Notication by Mediator

0201

MEN - Runtime

Core service invocation events raised by Mediator

0202

MEN - Alerts

SNMP alerts generated by Mediator

0203

MEN - Cache

Cache management in a clustered environment

0204

MEN - Interval
Processing

Notication events when managing interval

notication cache change events

0205

MEN - Events

Events generated by SNMP, EDA, Email,

CentraSite, Local log and audit events

0206

MEN Processors

Service Invocation Event which is processed for a

web service invoke

0207

MEN - Readers

Interval and real-time thread pool implementations

like data collector

webMethods Integration Server Administrators Guide Version 9.10

1009

M
Index

webMethods Integration Server Administrators Guide Version 9.10

1010

M
Index

Index
Numerics

2PC for XA transactions 802

401 status code, for pub.client
http 867
501 to 409 status code, and pub.client
http 867

Accept header
HTTP request 819
Access Control Lists (ACLs)
ACL used when none assigned to service 439,
443
Administrators 439, 439
Anonymous 439
assigning to services 443
creating 440
Default 439, 439
deleting 441
description of use 435
Developers 439, 439
how they work with services 442
Internal 439
predefined 439
protecting use of remote server aliases 117
removing from services 444
removing protection from files 446
Replicators 440, 440
updating 441
access file, using to control access to files 445
accessing
any web document for package 595
home page for package 595
accessToken 883, 883
ACLs. 435
Action On Startup Error 887
activating packages 597
adding
Access Control Lists (ACLs) 440
administrators 94
aliases for remote servers 118
aliases for web services 134
developers 95
groups 101
packages 596
port restrictions 431, 432

ports 159
services manually 636
user accounts 92
users to a group 102, 103
administered objects
creating 297
Administrator user account 92
administrators
adding alternate administrators 32
defining 94
defining external users as 573
email address for guaranteed delivery 673
password for predefined user account 31
predefined ACL, description 439
predefined group, description 100
predefined user account, description 31, 92
receiving messages, overview 31
responsibilities 30
role 30
SMTP server for email address for guaranteed
delivery 673
Administrators ACL 439
Administrators group 100
alias
for JNDI providers 271
JMS connection alias 277
JNDI provider 271
predefined for JNDI providers 270
predefined JMS connection alias 276
predefined JNDI provider 270
aliases
remote servers
deleting 120
identifying 118
testing connection 120
updating 120
Allow By Default
port IP access (custom) 426
port IP access (global) 425
allowUnquotedFieldNames 930
Anonymous ACL, description 439
Anonymous group 100
anyType element with duplicates 973
architecture, we bMet hods Integration Server 35
archiving packages 600
AS/400 systems, port queue size 943
audit logging
fail-fast mode 880, 880
auditing

webMethods Integration Server Administrators Guide Version 9.10

1011

M
Index

security 51
audit-trail logging
overview 51
writing log to screen 59
authenticating
basic authentication 448
client certificates 454
using Integrated Windows authentication 983
using user names and passwords (basic) 448
using user names and passwords with Integrated
Windows authentication 983
when invalid password supplied 448
when invalid user name supplied 448
when it occurs 458
when user name not supplied 448
automatic pull facility 617
available threads warning threshold 111

blocking incoming requests to s erver 210

Broker
bypassing decoding for trigger services 962
checking for $brokerEvent objects 944
client group, description of 235
hand ling native e vents 945
keep-alive messages
response time 885
retry limit 885
wait time 884
keep-alive mode 255
Broker/loc a l trigg ers
suspending on error 964
Broker/local trigger
removing subscriptions 965
Broker/local triggers
deleting document type subscriptions 965
interrupting retries 962
monitoring interval 963
retrying on error 964
shut down requests 962
bypassing proxy server
specifying and editing a proxy bypass 128

C/C++ services, adding to server manually 636

caching service results
overview 666
resetting for all services 668

resetting for single service 668

viewing statistics 669
canceling
package subscriptions 624
scheduled service execution 654
capacity
default document store 260
definition of 751
outbound document store 265
trigger queues 751
CentraSite
testing connection to 135
certificate authorities (CAs)
certificates to validate client certificates 160
certificate mapping
changing user 453
certificates, digital
certificates required to validate client certificates
160
using for authentication 454
changing
Access Control Lists (ACLs) 441
aliases for remote servers 120
license key 109
membership for groups 104
passwords 96
primary port 208
scheduled service execution 651
checklists
configuring server 843
deploying the server 842
implementing SSL 404
installing server 842
installing services 845
security 847
setting up user accounts, groups, and ACLs 844
class loaders
class loading chain 41
cu rrent 45
Integration Server 41
JVM 41
parent 45
class loading
accelerating 49
how the process works 45
classes
where to place for packages 48
classpath
changing at startup 44

webMethods Integration Server Administrators Guide Version 9.10

1012

M
Index

Integration Server 42
Java 42
using to prepare client to communicate with
server 847
client certificates
certificates required to validate 160
description 454
client groups, switching 235
client ID, usi n g in durable subscriber name 923
client libraries, for JMS providers 305
client prefix, for webMethods Integration Server
234, 238
client.jar file
using to prepare client to commun icate with
server 847
clientKeepaliveTimeout 863
clients
preparing t o communicate with server 847
client-side queuing, described 263
client-side queuing, enabling or disabling 944
cluster
aware 889
configured 889
name of 889
Terracotta Server Array URLs 890
cluster error on startup 887
cluster synchronization
configuring for trigger management 768
monitoring for triggers 770
Cluster View page, display of 770
code subdirectory 585
command line
starting server from 55
communications with server, securing with SSL 402
configuration settings
bypass list for proxy servers 128
controlling who can set 94
descriptions 852
guaranteed delivery 673
how long to keep inactive sessions 112, 113
how to set 88
LDAP 566
license keys 108
overriding when starting server 55
ports 156
proxy servers 121
server.cnf file 88
configuring
additional ports 159

bypass list for p roxy se rvers 128

checklist 843
controlling who can configure the server 94
default document stores 259
description of all settings 852
guaranteed delivery 673
how long to keep inactive sessions 112, 113
outbound document store 263, 263
outbound password settings 473
ports 156
primary port 208
proxy servers 121
server 107
server resources 129, 130
SSL 410, 412
SSL, checklist 404
trigger document store 261
user account to use 92
XA recovery store 808
ConnectionException 963
content handler
how server chooses for HTTP requests and
responses 819
contr olling
who can develop services 95
controlledDeliverT oTrig g ers 893
controlling
access to services and files 435
access to services by port 422, 429
server SSL security level by port 415
who can configure the server 94
cookies
wiith expired sessions 876
copying packages
ACL used 440
group used 101
how to 612
publisher tasks 608
requesting subscriptions to packages 619
subscriber tasks 617
to other servers 600
user account used 92
creating
Access Control Lists (ACLs) 440
administred objects 297
JMS connection alias 277
JNDI provider alias 271
package release 612
packages 596

webMethods Integration Server Administrators Guide Version 9.10

1013

M
Index

packages distribution files 612

database drivers, for use with wmDB 919

debug mode of the server 57
decreasing
capacity of trigger queues 751
document processing for concurrent triggers 759
refill level of trigger queues 751
server threads for concurrent trigger execution
759
server threads for document processing 758
server threads for document retrieval 749, 750
trigger execution for concurrent triggers 759
Default ACL 439
default document store
capacity 260
configuring 259
description 258
initial size 260
location 259
refill level 260
default proxy server 121, 127
default proxy servers
change existing default 127
deleting existing default proxy 128
disabling 127
enabling 127
Default user account 92
defaultProtocol,SOAP 953
defining
Access Control Lists (ACLs) 440
administrators 94
developers 95
groups 101
packages 596
user accounts 91
deleting
Access Control Lists (ACLs) 441
aliases for remote servers 120
aliases for Web services 126, 127, 127, 127,
128
groups 105
JMS connection alias 296
JNDI provider alias 274
packages 599
ports 209
subscribers to packages 612

user accounts 93
Deny By Defa ult
access to services through a port 429
Deny By Default
port IP access (custom) 427
port IP access (global) 424
dependency manager, enabling and disabling 939
Designer
predefined user account to use 92
privilege required to access server from 95
user account 92
destinations
managing through Designer
JMS triggers 287
developers
defining 95
defining external users as 575
predefined ACL, description 439
predefined group, description 100
predefined user account, description 92
Developers ACL 439
Developers group 100
diagnostic data, description 832
diagnostic port
assigning 196, 200
dedicated thread pool 832
description 832, 832
thread priority 833
url 833
diagnostic utility
description 833, 833
diagnostics_hostname_port_yyyyMMddHHmmss.zip
833
wm.server.admin.getDiagnosticData 833
digital certificates
certificates required to validate client certificates
160
client certificates for authentication 454
direc tives
invoke 916
directives
default 433
invoke 433
rest 433
REST 946
restricting to specified ports 879
soap 433, 953
web 433
disabled keep-alive mode

webMethods Integration Server Administrators Guide Version 9.10

1014

M
Index

configuring 258
description of 256
disabling
guaranteed delivery for outbound requests 676
JMS connection alias 295
JMS triggers 782
packages 598
ports 210, 210
users 98
displaying
active sessions 66, 110
documentation for packages 594
folders 634
license key 108
licensed session limit 110
log information on screen 59
membership for groups 104
package subscribers 608
package subscriptions 618
packages 589
packages residing on your server 589
packages, enabled/disabled 591
packages, loaded/unloaded 590
scheduled service execution time 649
service information 634
service statistics 669
services 634
system task execution time 654
distribution files for packages
creating 612
sending 612
DMZ, running an Enterprise Gateway Server in 494
doc subdirectory 586
docu ment types
removing subscri ptions on reload or reinstall 965
docum ent stores
default
re fil l level 260
document history database
ConnectionException 963
reaper interval 798
document history database, removing expired
entries 915
document proc essing
server threads for 758
document processing
enforcing TTL 962
increasing or decreasing threads for 759
limiting threads for 766

overview of managing 757

rejecting locally published documents 943
resuming for all triggers 762
resuming for one trigger 764
susp ending for one trig ger 764
suspending for all triggers 762
threads, limiting 766
document retrieval
increasing or decreasing threads for 750
limiting threads for 766
overview of managing 748
resuming for all triggers 753
resuming for one trigger 755
server threads for 749
suspending and default client 755
suspending and local publishing 755
suspending for all triggers 753
suspending for one trigger 755
document stores
default
capacity 260
configuring size and location 259
outbound
capacity 265
configurin g s ize and location 263
configuring size and location 263
overview 258
triggers
configuring size and location 261
initial size 262
location 262
reducing capacity 751
document types
validate when published property 944
validating 944
document types, fields from substitution groups 857
documentation
for your packages 594
using effectively 27
documents
en forcing TTL 962
rejecting locally published 943
validating on publish 944
DSPs, preventing cross-site scripting attacks 857
Duplicate documents
statistics for 799
duplicates, in anyType element 973
durable subscriber name, client ID prefix in 923

webMethods Integration Server Administrators Guide Version 9.10

1015

M
Index

editing
JMS connection alias 295
JNDI provider alias 273
email
address for messages when guaranteed delivery
fails 673, 676
ports, assigning 159
SMTP server to use for messages when g
uaranteed delivery fails 673
SMTP server to use for messages when
guaranteed delivery fails 676
empty tags, including or omitting in SOAP requests
954
Enabled icon, color descriptions 591
enabling
client-side queuing 263
JMS connection alias 295
JMS triggers 782
packages 598
ports 211
users 99
encryption keys
for outbound passwords 472
endpoint aliases
adding 134
Enterprise Gateway
overview 494
error log
OpenID exceptions 876
errors
suspending triggers for 964
Event Manager 640
eventcfg.bin file 640
events, running services in response to 640, 640
Everybody group 101
exactly-once processing
statistics, clearing 799
statistics, viewing 799
exceptions
logging to error log 901
using error log to debug 994
executing
replication services 639
services 39
services at scheduled times 644
shutdown services 639

startup services 639

Execution Threads Throttle property 759
execution user, for adapters notifications, 853
expired UUIDs, deleting 915
external directories
considerations for user accounts and groups 572
granting users access to services and files 576
granting users administrator privileges 573
granting users developer privileges 575
how server uses 561
overview 564
to stop using 571
uses for multiple 564
external groups
assigning administrator privileges 573
assigning developer privileges 575
assigning to ACLs 576
how server uses 561
external port
on Enterprise Gateway Server 495
external user accounts
assigning access to services and files 576
assigning developer privileges 575
how server uses 561
externaluseraccounts
assigning administrator privileges 573

fail-fast mode 880

file age, for FTP LIST command 908
files
controlling access to 445
removing Access Control List (ACL) protection
from 446
filtering packages 589
firewall
configuring FTP/FTPS listerner port range 207
running an Internal Server behind 494
flat files, sending and receiving with Trading
Networks 38
flow service
outbound passwords 472, 875
folders
assigning Access Control List (ACLs) 443
description 632
listing 634
FTP
access the directories 969

webMethods Integration Server Administrators Guide Version 9.10

1016

M
Index

port range for listener 207

ports, assigning 159
root directory, spec ifying 969
FTP client timeout 864
FTP downloads
allowing concurrent 864
FTP LIST command 908
FTP R ETR command 908
FTP sessions
allowing multiple 864
FTPS ports, adding 183
full release, of a package 602

disabling outbound transactions 676

email address and SMTP server for error
notification 676
email address for error notification 673
handling heuristic failures 674
handling restart after a failure 674
inbound job store, clean up 674
inbound job store, description 674
reinitializing, for inbound transactions 678
reinitializing, for outbound transactions 678
requests to other servers 672
retry after server failure 674
retry wait 676
server failure 674
service threads 676
shutting down 677
SMTP server for error notification 673
specifying how long transactions active 676
submitting outbound transactions 676
thread pool 676

gateway. 986
generateAllTypeDocuments 857
group name
description 100
specifying for groups 100
groups
adding 101
adding users to 102, 103
administrator privileges 100
Administrators 100
Anonymous 100
changing membership 104
considerations when using external directories
572
defining 99
deleting 105
developer privileges 100
Developers 100
externally-defined 564
group name 100
overview 90
predefined 100
privileges that can be shared 99
purpose 90
Replicator 101
replicator privileges 101
settings 100
specify members of 100
specify users that belong to 91
viewing membership 104
guaranteed delivery
ad ministering 677
configuring 673
description of 672

Handheld Device Markup Language. 986

handler chain behavior 970
HDML (Handheld Device Markup Language) 986,
989
HDML pages, accessing with wireless devices 989
heuristic failures, specifying how to handle for
guaranteed delivery 674
home page for packages 595
hosts
allowing inbound requests 424, 427
denying inbound requests 425
HTTP ports
assigning 159
changing to or from primary port 208
HTTP proxy server
bypass list 128
configuring 121
HTTPS ports
assigning 168
changing to or from primary port 208
HTTPS proxy server
bypass list 128
configuring 121

In Doubt documents

webMethods Integration Server Administrators Guide Version 9.10

1017

M
Index

statistics for 799

inbound client-side queuing, description of 263
inbound document history, description of 263
inbound requests
SSL protocols 868
inbound vs. outbound passwords 472
inner firewall, running an Internal Server behind 494
installing
package published from another server 624
run-time classes 846
server 842
services, checklist 845
Integrated Windows authentication
activating 983
deactivating 983
description of 983
Integration Server 435
Internal ACL 439
interrupt trigger retry property 962
interval, for clearing expired document history
entries 798
invoke
directive 433, 916
IP access to ports
setting globally 424
IS services 435

jar files
where to place custom 49
where to place for packages 48
where to place thrid party 49
Java class loaders
how the process works 45
Java classes
how Integration Server loads them 40
loading 40
Java services
adding to server manually 636
specifying compiler command 891
Java system properties
passing to Integration Server at startup 64
java.transaction.Status interface for XA transactions
804
java.transaction.xa.Xid interface for XA transactions
804
javax.net.ssl properties 415

JDK, specifying non-default one to use with server

890, 891
JMS
SSL connection 415
SSL keystore alias 415, 958
SSL truststor e alias 958
SSL truststore alias 415
supported JMS providers 303
using SSL 302
JMS connection ali as
retry interval 295
JMS connection alias
creating 277
deleting 296
disabling 295
editing 295
enabling 295
keep-alive interval 297
managing destinations 287
predefined 276
transaction type 277
using native webMethods API 276
JMS provider
adding cleint libraries 305
Universal Messaging 309
JMS providers
supported 303
Universal Messaging 303
Universal Messaging guidelines 303
webMethods Universal Messaging guidelines
303
JMS triggers
adjusting thread usage 786
disabling 782
enabling 782
polling delay 789, 789, 790, 925, 926
polling delay examples 792
polling interval 924, 925, 928
state 782
suspending 782
thread threshold 787, 923
thread usage 785
JNDI provider alias
creating 271
deleting 274
editing 273
predefined 270
JNDI providers
creating alias 271

webMethods Integration Server Administrators Guide Version 9.10

1018

M
Index

for JMS 270

predefined alias 270
job store
for inbound guaranteed delivery transactions 674
how long outbound transactions active 676
removing expired inbound transactions 674
submitting outbound transactions 676
json
allowUnquotedFieldNames 930
quoteFieldNames 931
JSSE
inbound protocols 868
outbound protocols 867
JTA standard for XA transactions 804
JVM
checking version when copying a package 605
class loaders 41

keep-alive interval, for JMS connection alias 297

keep-alive messages
idle time 884
limit 885
response time 885
keep-alive mode
configuring disabled mode 258
configuring listen only mode 257
configuring normal mode 257
definition of 255
disabled mode 256
keep-alive period (duration) 884
listen only mode 256
maximum response property 885
normal mode 256
response time (max response time) 885
retry limit (retryCount) 885
server parameters for 256
keys, encryption
used for outbound passwords 472
keystore 407, 408
keystore alias
for SSL with JMS 415, 958

LDAP
assigning groups to ACLs 576
configuration settings 566
considerations for user accounts and groups 572

granting users access to services and files 576

granting users administrator privileges 573
granting users developer privileges 575
how server uses 561
uses for multiple directories 564
license keys
changing 109
description 108, 108
licensed sessions 109
renewal reminders 109
renewing 109
viewing 108
viewing licensed session limit 110
viewing number of active sessions 110
when session limit reached 109
licensing
changing 108
listen only keep-alive mode
configuring 257
description of 256
listeners 435
listing
active sessions 66
folders 634
log information on screen 59
packages residing on your server 589
services 634
Loaded? icon, color descriptions 590
loading
Java classes 40
packages 597
local document publishing
enforcing TTL 962
rejecting when trigger queue is full 943
LOCAL_TRANSACTION 278
locking
best practices 744
choosing local or VCS 742
disabling and enabling 742
locking mode, setting 939
locking out users 98
log files, encoding 935
logEn coding 935
loggers, fail-fast mode 880
logging
configuring server log to rotate based on size
221
controlling content of server log 217
controlling format of server log 224

webMethods Integration Server Administrators Guide Version 9.10

1019

M
Index

exceptions 901, 994

fail-fast mode 880
overriding logging level and location of server log
file 227
overview 51
queuing log entries for server log. 219
sending messages about critical log entries 222
setting up server log 217
viewing server log 223
writing log to screen 59

managing XA transactions 802

manifest file
for packages 45, 587
master password (for outbound passwords)
changing 474
description 472
file name and location 477
resetting when lost or corrupted 482
Maximum Documents to Send per Transaction
property 264
maximum retry period, for services 916
Maximum Threads property
for document processing 766
for document retrieval 766
maxPersist parameter 265
Message History Sweeper task 798, 915
metadata, publishing 134
MTOMThreshold, SOAP 955

naming services 632

native Broker ev ents
checking for $brokerEvent o bjects 944
native Broker events
bypassing decoding for trigger services 962
disabling document validation 945
native webMethods API
using 276
NetException 867
nhps 252
NIC, specifying wh ich one server is to listen on for
incoming requests 916
NO_TRANSACTION 278
normal keep-alive mode
configuring 257
description of 256

ns subdirectory 586
nsps 252

OAuth authentication, disabling 883, 883

omitXSDAny 857
OpenID
exceptions in error log 876
outbound document store
capa city 893
capacity 265
confi guring 263
configuring 263
defined 259
disabling use of 944
emptying 264
maxPersist parameter 265
setting transaction limit 264
outbound passwords
definition 472
encryption method, changing 477
expiration interval, changing 475
file name and location 476
flow service 472, 875
internal vs. public 876
management 473
master password, changing 474
master password, description 472
master password, file name and location 477
name or location of master password file,
changing 477
name or location of outbound passwords file,
changing 476
passman.props file, definition 475
resetting when master password is lost or
corrupted 482
vs. inbound 472, 472
outbound requests
SSL protocols 867
output templates, preventing cross-site scripting
attacks 857

package class loader

using instead of Integration Server class loader
45
packages
ACL for package replication 440

webMethods Integration Server Administrators Guide Version 9.10

1020

M
Index

activating 597
archivi ng 600
archiving 600
canceling subscriptions to 624
code subdirectory 585
controlling ac cess 598
copying 601
copying to another server 600
creating 596
cutting 601
deleting 599, 599
description 580
directory structure 48, 585
disabling 598
doc subdirectory 586
documentation for 594
Enabled icon color descriptions 591
enabling 598
filtering the list 589
full vs. patch release 602
home page 595
information you can view 587
installing published package 624
List, filtering 589
Loaded? icon color descriptions 590
loading 597
location 585
making available 598
manifest file 587
moving 601
ns subdirectory 586
package replication group 101
package replication guidelines 607
partial release 602
pasting 601
predefined 580
prohibiting access to 598
pub subdirectory 586
publishing to other servers 612
recovering 599
release 602
reloading 597
effect on trigger subscriptions 965
replicating 600, 612
residing on your server 589
resources subdirectory 586
retrieving automatically 617
retrieving manually 617
safe delete 599

sampleservices 584
status, enabled/disabled 591
status, loaded/unl oaded 590
subscribing to 619
subscriptions to 618
tasks you can perform 595
templates subdirectory 587
updating
effect on trigger subscripti ons 965
user account for package replication 92
web subdirectory 587
who can subscribe to 606
page size, controlling for adapters 852
pagination, controlling for adapter elements 852
partial release, of a package 602
passive FTP/FTPS listeners, port range for 207
passman.props file, definition 475
passwords 472
changing 96
description 91
inbound vs. outbound 472
predefined Administrator user account 31
requirements 97
specifying in user accounts 91
patch release, of a package 602
PBE (Password-Based encryption), used for
outbound passwords 472
pipeline Broker e v e nts
checking for $brokerEvent objects 944
pipeline Broker events
bypassing decoding for trigger services 962
disabling document validation 945
PKCS5, encryption used for outbound passwords
472
polli ng interval
serial JMS triggers 928
polling delay
examples 792
increment interval 789, 790, 925
length of delay 789, 926
polling interval
concurrent J M S tri ggers 925
concurrent JMS triggers 924
port queue size, lowering for AS/400 943
ports
adding 159
adding a security prov ider 212
configuring 156
controlling access to services through 422, 429

webMethods Integration Server Administrators Guide Version 9.10

1021

M
Index

controlling SSL security level of 415

deleting 209
Deny By Default access to services 429
disabling 210
editing 210
email client configuration 189
enabling 211
FTP 187
FTPS 183
HTTPS 168
overview 35
primary, changing 208
reasons to add additional 159
reasons to change primary 208
resetting access to 433
ports, listening
adding additional 159
changing primary 208
configuring 156
deleting 209
Deny By Default access to services 429
disabling 210, 210
enabling 211
overview 35
port range, specifying for FTP/FTPS 207
reasons to change primary 208
resetting access to 433
pr oxy servers
usage 121
pre82Mode, for pub.flow:setResponse 949
prepr ocess errors, for triggers 964
preventing
access to packages 598
hosts that can connect to server 425
use of ports 210
primary thread, c oncurre nt J MS triggers 924
primary thread, serial JMS triggers 928
privileges
administrator, description 94
administrator, granting 94
administrator, granting when using external
directory 573
developer, description 95
developer, granting 95
developer, granting when using external directory
575
replicator 101
shared between groups 99
protocols

email (SMTP) 156

FTP 156
HTTP 156
HTTPS 156
proxy bypass
editing proxy bypass 128
proxy port
web directive 434
proxy s e rver alias
bypassing proxy server 128
proxy server alias
changing the existing default 127
creating or adding 123
deleting existing proxy alias 128
editing existing proxy alias 126
proxy server aliases
changing existing default proxy 127
deleting existing default proxy 128
disabling 127
editing 126
enabling 127
proxy servers
bypassing 128
configuring 121
default 121, 127
editing 126
overview 37
pub subdirectory 586
pub.clienht
http
501 to 509 status code 867
pub.client
http
401 status code 867
NetException handling 867
pub.flow:setResponse 949
pub.trigger services
resumeProcessing 765
resumeRetrieval 757
suspendProcessing 765
suspendRetrieval 757
published documents, maximum published at one
time 893
publishing
metadata about server assets 134
publishing packages
creating the distribution file 612
guid elines 607
how to 612

webMethods Integration Server Administrators Guide Version 9.10

1022

M
Index

installing published package 624

removing recipients (subscribers) 612
requesting subscriptions 619
sending the distribution file 612
sending the release 612
updating subscriber information 610
who can publish 607
who can subscribe 606
publishing servers
creating package distribution file 612
displaying subscribers 608
publishing packages 612
sending package release 612
tasks 608
who can pu blish 607
publishing services
blocking 893
maximum published documents 893
publishing services, delaying 892
pulling a package
automatically 617
manually 617

Queue Capacity Throttle, definition of 751

quoteFieldNames 931

re ad fr om standard error 891

read from standard out 891
reaper interval, for documen t history database 915
reaper interval, for document history database 798
reauthentication, forcing for expired sessions 876
receiving administrator messages 31
recovering packages 599
refill level
default document store 260
definition of 751
registration port
on Enterprise Gateway Server 495
reinitializing
guaranteed delivery for inbound transactions 678
guaranteed delivery for outbound transactions
678
releases (packages)
creating 612
full vs. patch 602
sending 602, 612

reloading packages 597

remote servers, identifying aliases 117
removing
Access Control Lists (ACLs) 441
Access Control Lists (ACLs) from services 444
expired document history entries 915
groups 105
packages 599
ports 209
scheduled execution of service 654
subscribers to packages 612
user accounts 93
renewing license key 109
replica ting packages
who can subscr ibe 606
replicating packa g es
user account 92
replicating packages
ACL 440
group 101
guidelines 607
how to 612
overview 601
publisher tasks 608
Replicator user account 607
Replicators ACL 607
Replicators group 607
requesting subscriptions to packages 619
subscriber tasks 617
replication services, description 639
Replicator user account 92
Replicators ACL 440
Replicators group 101
resetting
access to ports 433
cache for all services 668
cache for single service 668
reso urce monitoring service, execution interval 963
resolving uncompleted XA transactions 803
response header, in server log 940
REST
directive 433
restarting
guaranteed delivery for inbound transactions 678
guaranteed delivery for outbound transactions
678
reasons for restarting server 67
server 67
restricting

webMethods Integration Server Administrators Guide Version 9.10

1023

M
Index

access to Server Administrator 94

access to server from Designer 95
access to services and files 435
access to services by port 422, 429
hosts that can connect to server 424, 427
resuming scheduled execution of service 652
retries, interrupting for shut down 962
retry failure for triggers 903
retry guaranteed delivery 674
retry interval, for JMS connection alias 295
role
of administrator 30
of webMethods Integration Server 34
run-time classes, installing 846

safe mode
autom atic 837
description 836
SAML artifact resolver endpoint 883
scheduler
server thread allotment 112
scheduling execution of services 651
canceling scheduled user task 654
changing scheduled times 651
description 644
examples of complex scheduling options 655,
657
pausing all scheduled user tasks 652
resuming a scheduled user task 652
resuming all user sceduled tasks 653
suspending a scheduled user task 651
system tasks 644
user tasks 644
viewing scheduled times 649
viewing when system tasks execute 654
screens
email client configuration 189
secondary thread, concurrent JMS trig gers 925
Secure Sockets Layer (SSL)
background information 402
checklist to implement 404
client certificates 454
configuring server to use 410, 412
controlling security level by port 415
how server uses 402
security
auditing 51

checklist 847
checklist to implement SSL 404
controlling access to services and files 435
controlling access to services by port 422, 429
controlling SSL security level by port 415
controlling who can configure the server 94
controlling who can develo p services 95
securing server communications 402
security provider
adding 212
sending
distribution files 612
releases 612
sending and receiving flat files
via Trading Networks 38
serv ices
testing 636
Server Administrat or
description 31
Server Administrator
controlling access to 94
description 84
how to use 86
picture of 86
starting 84
server log
configuring server log to rotate based on size
221
controlling content of 217
controlling format of 224
file location 217
logging levels 219
message format 860
overriding logging level and location of server log
file 227
queuing log entries for 219
response header 940
rotating 948
send ing messages about critical log entries 222
setting up 217
viewing 223
server resources 129, 130
server security 448, 462, 982
server session
stateful session limit 113
warning threshold 114
server thread pool
document retrieval threads 766
limiting thread usage 766

webMethods Integration Server Administrators Guide Version 9.10

1024

M
Index

maximum threads 111, 112

minimum threads 111
sizing 129, 130
trigger execution threads 766
warning level 111
server threads
concurrent JMS triggers 787, 923
for document processing 758
for document retrieval 749
for trigger execution 758
server.cnf
description of settings 852
guaranteed delivery settings 673
how to set configuration settings 88
location 852
updating from Server Administrator 130
services
Access Control Lists (ACLs) usage 442
ACL used when no assigned ACL 439, 443
assigning Access Control Lists (ACLs) to 443
caching results, overview 666
caching service results, overview 51
canceling scheduled user task 654
changing scheduled times of execution 651
controlling access to 435
controlling access to by port 422, 429
controlling who can access 435
controlling who can develop 95
deleting its Access Control List (ACL) 442
denying access to external users 576
execu tio n overview 39
fully qualified names 632
granting access to external users 576
guaranteeing delivery of requests to server 672
guaranteeing delivery of responses from services
672
guidelines for using startup/ shutdown/replication
640
invoking with URLs 988
listing 634
manually adding to server 636
maximum retry period 916
naming 632
overview 632
removing Access Control Lists (ACLs) from 444
replication 639
replication services execution 639
resetting cache for all services 668
resetting cache for single service 668

resuming scheduled user task 652

retrieving data for 37
running in response to specific events 640, 640
samples in WmSamples 584
scheduling execution 644
shutdown 639
shutdown service execution 639
startup 639
startup service execution 639
suspending scheduled user task 651
user account for invoking trigger services 265
viewing information about 634
viewing scheduled times of execution 649
viewing service statistics 669
viewing when system tasks execute 654
sessions
inactive sessions 112, 113
maximum number allowed per license 109
requiring reauthentication when expired 876
stopping all 65, 66
timeout limit 112, 113
viewing 66
sessions, licensed
limit 109
viewing limit 110
shared-state client, keep-alive mode 255
shutdown services
description 639
guidelines for use 640
shutting down
guaranteed delivery 677
server withrest art 67
webMethods Integration Server 65, 66
sizing
default document store 260
server thread pool 129, 130
trigger document store 261
SMTP address for messages when guaranteed de
livery fails 673
SMTP server, specifying for error messages
generated during guaranteed delivery processing
676
so ap - j ms request timeout 957
SOA P messages
omitting empty tags
web services
empty tags 954
soap
decod eElementWithPrefix 952

webMethods Integration Server Administrators Guide Version 9.10

1025

M
Index

directive 433, 953

SOAP messages
including empty tags 954
SOAP, defa ultProtocol 953
SOAP, MTOMThreshold 955
SOAP-JMS trigg ers
WS endpoint triggers 792
specifications, viewing information about 634
SSL
keystore 407, 408
Universal Messaging port 252
using with JMS 302
SSL protocols
inbound requests 868
outbound requests 867
SSL. 415
starting
diagnosing problems with startup 836
guaranteed delivery for inbound transactions 678
guaranteed delivery for outbound transactions
678
Server Administrator 84
server from command line 55
server on UNIX 55
server on Windows 54
server, overriding configuration settings 55
server, process 61
startup services
description 639
guidelines for use 640
statistics, for exactly-once processing 799
stopping
active sessions 65, 66
server 65, 66
server with restart 67
use of external directories 571
store location
default document store 259
master password for outbound passwords 477
outbound passwords 476
trigger document store 262
XA recovery store 809
subscribing serv ers
updating information for 610
subscribing servers
canceling subscriptions 624
displaying 608
installing published package 624
removing 612

requesting subscriptions 619

tasks 617
updating information for 621
who can subscribe 606
subscribing to packages
displaying current subscriptions 618
guidelines 607
how to 619
manually pulling current subscriptions 618
updating subscription information 621
who can subscribe 606
subscriptions
canceling 624
displaying 618
installing published package 624
pulling 618
requesting from a remote server 619
substitution groups, schema 857
suspe n ding
scheduled execution of service 651
suspending
document processing for triggers 762, 764
document retrieval for triggers 753, 755
JMS triggers 782
sweep interval, FTP sessions 865
synchronization, and dependency manager 939
synchronizing, trigger management changes 768
system tasks
description 644
viewing scheduled execution 654

templates subdirectory 587

Terracotta Server Array URLs, for a cluster 890
testing
connection to remote servers 120, 135
installation of server 849
services 636
thread pool
limiting server thread usage 766
scheduler 112
server 129, 130
warning threshold 111
thread usage, for c oncurrent JMS triggers 923
thread usage, for concurrent JMS triggers 787
threads
for document processing 759, 766
for document retrieval 749, 766

webMethods Integration Server Administrators Guide Version 9.10

1026

M
Index

for JMS triggers 785, 785, 786

threshold, for concurrent JMS trigger threads 787,
923
threshold, server thread availability 111
throttle controls
Execution Threads Throttle 759
Queue Capacity Throttle 751
time to live (TTL), specifying for guaranteed
delivery 676
timeout
for Flow steps 961
timeout limits, for sessions 112
timeouts, for soap -jms requests 957
timestam p Ma ximumSkew 970
timestampPrecisionInMilliseconds 971
timestampTimeToLive 971
Trading Networks, sending flat files to 38
transaction management (XA) 802
transaction type
for JMS connection alias 277
trigger document store
configuring 261
decription 259
initial size 262
location 262
reducing capacity 751
trigger preprocessing 963
trigger services
infinite retry loop, escaping 773
triggers
concurrent, reducing execution threads 759
document pro cessing
rejecting when queue is full 943
editing WS endpoint triggers 793
exactly-once processing, statistics 799
reuse sessions 965
WS endpoint triggers 792
truststore alias
for SSL with JMS 415, 958
tspace
loca tion 967
maximum bytes 967
TTL (time to live), specifying for guaranteed
delivery 676
two-phase commit for XA transactions 802

unauthenticated users, predefined group

description 100
Univesal Messaging
JMS provider 303
UNIX, starting webMethods Integration Server 55
updat ing
Access Control Lists (ACLs) 441
updating
aliases for remote servers 120
license key 109
membership for groups 104
subscr iption information 621
subscriber information 610
when services scheduled to execute 651
URLs
accessing the server with 988
invoking services with 988
using to access HDML or WML pages 989
user accounts
account to configure and manage server 92
account to use when connecting from Designer
92
adding 92
Administrator 31
considerations when using external directories
572
deleting 93
description 91
externally-defined 564
group membership 91
overview 90
password 91
predefined 91
purpose 90
settings 91
trigger service execution 265
user name 91
using to authenticate (basic) 448
using to authenticate with Integrated Windows
authentication 983
when client does not supply a user name 92
user name
externally-defined 564
specifying in user account 91
using to authenticate (basic) 448
using to authenticate with Integrated Windows
authentication 983
user tasks
canceling scheduled execution 654

webMethods Integration Server Administrators Guide Version 9.10

1027

M
Index

changing when scheduled to execute 651

examples of complex scheduling options 655,
657
resuming scheduled execution 652
suspending scheduled execution 651
viewing when scheduled to execute 649
userFtpRootDir property 969
users
disabling 98, 98
enabling 98, 99
locking out 98

Validate when published property 944

version control, enabli n g lockin g for 939
versions, checking when a package is copied 605
viewing
active sessions 66, 110
documentation for packages 594
folders 634
license key 108
licensed session limit 110
membership for groups 104
package subscriptions 618
packages 589
packages residing on your server 589
service information 634
service statistics 669
services 634
subscribers to packages 608
when services scheduled to execute 649
when system tasks execute 654
whether packages are enabled/disabled 591
whether packages are loaded/unloaded 590

wa tt . server.logs.dateStampTimeZone 936
wa tt.se rv e r.c o ntr ol .threadSensorInterval 894
wa tt.server.scheduler.thread Throttle 948
wa tt.server.userFtpRootDir 969
wa tt.t x.defaultTTLMins 676
WAP gateway. 986
warning threshold, server thread availabliity 111
wat t . server.centralUsers.shutdownOnError 886
wat t .se r ver.illegalUserChars 916
wat t.ser ve r. jdbc.loginTimeout 919
wat t.server.password.minSpecialChars 942
watt . server.ldap.DNe scapeChars 932

watt .ser ve r .st rictAc cessExceptionLogging 960

watt .server.login.userFtpDir 936
watt .server.scheduler.deleteCom pletedTasks 946
watt .server.threadPoolMin 962
watt .server.trigger.monitoringInterval 963
watt. server.event.stat.async 907
watt.art.analysis 852
watt.art.connection.nodeVersion 852
watt.art.page.size 852
watt.art.service.pipeline.hidden 853
watt.art.synchronousNotification.selectExecuteUser
853
watt.broker.sync.enableBrokerSync 853
watt.broker.sync.forceDispatcherInit 853
watt.brokerCoder.verbose 853
watt.config.systemProperties 855
watt.core.brokerCoder.wireFormat 855
watt.core.brokerTypeCoder.verbose 855
watt.core.datatype.p atternMatcherPool.delayFill
856
watt.core.datatype.patternMatcherPool.maxSize
856
watt.core.datatype.usejavarex 856
watt.core.generatedTypeName.localName.prefix
856
watt.core.generatedTypeName.namespaceName.authority
856, 857
watt.core.schema.createSchema.omitXSDAny 857
watt.core.schema.generateAllTypeDocuments 857
watt.core.schema.generateSubstitutionGroups 857
watt.core.schema.validateIncomingXSDUsingXerces
857
watt.core.template.enableFilterHtml 857
watt.core.validation.multipleroot 858
watt.core.validation.skipMandatoryFields 858
watt.core.validation.w3cConformant 859
watt.core.xml.allowExternalEntities 859
watt.core.xml.expandGeneralEntities 859
watt.core.xsd.useGeneratedURIForCreateXSD 859
watt.core.xsd.useGeneratedURIForNonRPC 860
watt.debug.layout 860
watt.debug.level 860
watt.debug.logfile 862
watt.debug.warnOnClasspathError 862
watt.debug2.facList 862
watt.debug2.logstringfile 862
watt.infradc.artmonitor 862, 863
watt.infradc.artpollinterval 862, 863
watt.net.clientDataConnTimeout 863, 863

webMethods Integration Server Administrators Guide Version 9.10

1028

M
Index

watt.net.clientKeepaliveTimeout 863
watt.net.defaultBufferSize 863
watt.net.email.validateHost 863
watt.net.ftp.ignoreErrors 863
watt.net.ftpClient DataConnTimeout 864
watt.net.ftpClientTimeout 864
watt.net.ftpConnTimeout 864
watt.net.ftpDataConn 864
watt.net.ftpDataConnTimeout 864
watt.net.ftpPassiveLocalAddr 864
watt.net.ftpPassivePort.max 207, 865
watt.net.ftpPassivePort.min 865
watt.net.ftpSweepInterval 865
watt.net.ftpUseCertMap 865
watt.net.http401.throwException 867
watt.net.http501-599.throwException 867
watt.net.httpUser 866
watt.net.jsse.client.enabledCipherSuiteList 867
watt.net.jsse.client.enabledProtocols 867
watt.net.jsse.server.enabledCipherSuiteList 868
watt.net.jsse.server.enabledProtocols 868
watt.net.localhost 869
watt.net.maxClientKeepaliveConns 869
watt.net.maxRedirects 869
watt.net.primaryListener 870
watt.net.proxy.fallbackToDirectConnection 870
watt.net.proxy.useNonDefaultProxies 870
watt.net.proxySkipList 870
watt.net.retries 871
watt.net.sftpSweepInterval 871
watt.net.socketpool.sweeperInterval 871
watt.net.socketProvider 871
watt.net.ssl.client.cipherSuiteList 871
watt.net.ssl.client.handshake.maxVersion 871
watt.net.ssl.client.handshake.minVersion 872
watt.net.ssl.client.hostnameverification 872
watt.net.ssl.client.strongcipheronly 872
watt.net.ssl.client.useJSSE 872
watt.net.ssl.randomAlgorithm 873
watt.net.ssl.server.cip herS uiteList 873
watt.net.ssl.server.clientHandshakeTimeout 873
watt.net.ssl.server.strongcipheronly 873
watt.net.timeout 874
watt.net.useCookies 874
watt.net.userAgent 874
watt.net.webapp.cookies.useRelevantPath 874
watt.s e r ver.ftp.connectMessage 908
watt.s erver.ldap.re tryCount 934
watt.se rver.l dap.doNotBind 933

watt.se rver.SOAP.generateN ilTags 954

watt.se rver.SOAP.useStringforAnyTypewithSimple
Value 956
watt.security.cert.wmChainVerifier.enforceExtensionsChecks
874
watt.security.cert.wmChainVerifier.trustByDefault
875
watt.security.fips.mode 875
watt.security.KeystoreAndTruststore.defaultAliasCreated
875
watt.security.ope.AllowInternalPasswordAccess
875
watt.security.openid.logExceptions 876
watt.security.pub.getFile.checkReadAllowed 876
watt.security.session.forceReauthOnExpiration 876
watt.security.sign.keyAlias 877
watt.security.sign.keyStoreAlias 877
watt.security.ssl.cacheClientSessions 877
watt.security.ssl.client.ignoreEmptyAuthoritiesList
877
watt.security.ssl.ig noreExpiredChains 875
watt.security.ssl.ignoreExpiredCh ains 875
watt.security.ssl.ignoreExpiredChains 875, 877
watt.security.ssl.keyAlias 877
watt.security.ssl.keypurposeverification 877
watt.security.ssl.keyStoreAlias 878
watt.security.trustStore.supportedTypes 878
watt.security.trustStoreAlias 878
watt.ser ve r .pipeline .processor 943
watt.ser ver.metadata.registry.timeout 937
watt.ser ver.xml.enforceEntityR ef 972
watt.serv er.publish.vali dateOnIS 944
watt.serv er.soapjms.request.timeout 957
watt.serv er.ssl.keyStoreAlias 958
watt.serve
r.soap.convertPlainTextHTTPResponseIntoSOAPFault
951
watt.serve r.SOAP.useMultiReference 956
watt.server 879
watt.server . h tt plog 915
watt.server .jms.csq.maxRedeliveryCount 920
watt.server .key 932
watt.server .ldap.DNstripQuotes 933
watt.server .package.parallel.threads 941
watt.server .scheduler.logical.hostname 947
watt.server. jms.trigger.pooledConsumer.timeout
927
watt.server. o auth.a pp r o valpage.header 939
watt.server. pas sword.minLowe rChars 942

webMethods Integration Server Administrators Guide Version 9.10

1029

M
Index

watt.server.acl.groupScanInterval 879
watt.server.control.controlledDeliverToTriggers.delays
watt.server.allowDirective 879
892
watt.server.audit.dbEncoding 879
watt.server.control.freeMemoryThreshold 893
watt.server.audit.displayLogs.convertTime 879
watt.server.control.maxPersist 265, 893
watt.server.audit.failFastLoggers 880
watt.server.control.maxPublishOnSuccess 893
watt.server.audit.schemaName 881
watt.server.control.memorySensorInterval 893
watt.server.auditDocIdField 880
watt.server.control.serverThreadThreshold 893
watt.server.auth.cache.capacity 882
watt.server.control.triggerInputCont rol.delays 894
watt.server.auth.cache.enabled 882
watt.server.control.triggerInputControl.delayIncrementInterval
watt.server.auth.cache.timeout 882
894
watt.server.auth.checkWithSession 882
watt.server.cronMaxThreads 898
watt.server.auth.oauth.accessToken.useHeaderFields watt.server.cronMinThreads 898
883
watt.server.date.suppressPatternError 899
watt.server.auth.oauth.accessToken.useQueryParameters
watt.server.dateStampFmt 898
883
watt.server.db.blocktimeout 899
watt.server.auth.samlResolver 883
watt.server.db.connectionCache 899
watt.server.auth.session.retainJaasSubject 883
watt.server.db.maintainminimum 899
watt.server.auth.skipForMediator 883
watt.server.db.share.ISInternal 899
watt.server.broker.producer.multiclient 884
watt.server.db.testSQL 900
watt.server.broker.r eplyConsumer.fetchSize 884
watt.server.debugFIPS 900
watt.server.broker.replyConsumer.multiclient 884
watt.server.defaultContentHandler 900
watt.server.broker.replyConsumer.sweeperInterval
watt.server.defaultCountry 901
884
watt.server.defaultLanguage 901
watt.server.brokerTransport.dur 257, 884
watt.server.defaultPackage 901
watt.server.brokerTransport.max 257, 885
watt.server.depreca te dException L o g ging 901
watt.server.brokerTransport.ret 257, 885
watt.server.diagnostic.logperiod 902
watt.server.cache.flushMins 885
watt.server.diagnostic.port 902
watt.server.cache.gcMins 886
watt.server.diagnostic.tabular 902
watt.server.cache.prefetchUser 885
watt.server.dispatcher.comms .brokerP ing 902
watt.server.cgi.unicode 885
watt.server.dispatcher.comms.connectionShareLimit
watt.server.checkAclsInternally 886
903
watt.server.classloader.pkgpriority 46, 47, 887
watt.server.dispatcher.join.reaperDelay 903
watt.server.clientTimeout 887
watt.server.dispatcher.messageStore.redeliverOriginalMessage
watt.server.cluster.action.errorOnStartup 887
903
watt.server.cluster.aliasList 889
watt.server.displayDirectories 903
watt.server.cluster.aware 889
watt.server.ema il .from 904
watt.server.cluster.name 889
watt.server.email.charset 903
watt.server.cluster.SessTimeout 890
watt.server.email.processReplyEmails 904
watt.server.cluster.tsaURLs 890
watt.server.email.waitForServiceCompletion 904
watt.server.coder.bincoder.trycontextloaderfirst 890
watt.server.errorMail 905
watt.server.compile 890
watt.server.event.audit.a sync 905
watt.server.compile.exitOnError 891
watt.server.event.exception.async 905
watt.server.compile.readFromStdError 891
watt.server.event.gd.async 905
watt.server.compile.unicode 891
watt.server.event.jmsDeliveryError.async 905
watt.server.content.type.default 891
watt.server.event.jmsRetrievalError.async 906
watt.server.content.type.mappings 891
watt.server.event.nerv.subscribeService.user 906
watt.server.control.controlledDeliverToTriggers 893
watt.server.event.replication.async 906
watt.server.control.controlledDeliverToTriggers.delayIncrementInterval
watt.server.event.routing.callbackService.runAsUser
892
906
webMethods Integration Server Administrators Guide Version 9.10

1030

M
Index

watt.server.event.security.async 906
watt.server.jms.trigger.concurrent.primaryThread.po
watt.server.event.session.async 907
llingInterval 924
watt.server.event.tx.async 907
watt.server.jms.trigger.concurrent.secondaryThread.pollingInterval
watt.server.eventMgr.maxThreads 907
925
watt.server.eventMgr.minThreads 908
watt.server.jms.trigger.extendedDelay.delayIncr em
watt.server.extendedMessages 933
entInterval 925
watt.server.fileEncoding 908
watt.server.jms.trigger.extendedDelay.delayIncrementInterval
watt.server.ftp.listingFileAge 908
789, 790
watt.server.ftp.loginMessage 908
watt.server.jms.trigger.extendedDelay.delays 789,
watt.server.ftp.usecommandip 909
790, 926
watt.server.hostAccessMode 909
watt.server.jms.trigger.maxDeliveryCount 926
watt.server.hostAllow 910
watt.server.jms.trigger.monitoringInterval 926
watt.server.hostDeny 911
watt.server.jms.trigger.pooledConsumer.timeout
watt.server.http.authorizationEncoding 910
927
watt.server.http.header.useHt tpOnly 910
watt.server.jms.trigger.raiseEventOnException 927
watt.server.http.jsonFormat 911
watt.server.jms.trigger.retryOnConsumerError 927
watt.server.http.listRequestVars 911
watt.server.jms.trigger.reuseJmsTxSession 928
watt.server.http.returnException 913
watt.server.jms.trigger.reuseSession 928
watt.server.http.securityRealm 913
watt.server.jms.trigger.serial.primaryThread.pollingInterval
watt.server.http.useAcceptHeader 913
928
watt.server.http.xmlFormat 914
watt.server.jms.trigger.stopRequestTimeout 929
watt.server.idr.reaperInterval 798, 915
watt.server.jms.trigger.wmjms.clientIDSharing 929
watt.server.illegalNSChars 916
watt.server.jms.wmjms.lms.readTimeout 930
watt.server.inetaddress 916
watt.server.jndi.searchresult.maxlimit 930
watt.server.invoke.m axRetryPeriod 916
watt.server.json.allowUnquotedFieldNames 930
watt.server.java.unico de 916
watt.server.json.decodeInteg erAsLong 930
watt.server.jca.connectionPool.createConnection.interrupt.waitTime
watt.server.json.decodeRealAsDouble 930
916
watt.server.json.prettyPrint 931
watt.server.jca.connectionPool.thresholdWaitingRequestwatt.server.json.quoteFIeldNames 931
917
watt.server.l dap.extendedProps 934
watt.server.jca.transaction.rollbackOnWriteFailure
watt.server.ldap.cleanContext 932
809, 917
watt.server.ldap.DNescapePairs 932
watt.server.jca.transaction.writeRecoveryRecord
watt.server.ldap.DNescapeURL 932
808
watt.server.ldap.memberInfoInGroups 934
watt.server.jdbc.defaultDriver 919
watt.server.ldap.retryWait 934
watt.server.jdbc.derby.commitTolerance 919
watt.server.licenses 934
watt.server.jdbc.driverList 919
watt.server.log.alertMaxEntries 934
watt.server.jms.connection.pi ngDestination 921
watt.server.log.maxEntries 934
watt.server.jms.connection.pingPeriod 297, 921
watt.server.log.or phanLoggers 935
watt.server.jms.connection.retryPeriod 922
watt.server.log.q ueued 935
watt.server.jms.csq.batchProcessingSize 922
watt.server.log.refreshInterval 935
watt.server.jms.debugTrace 922
watt.server.logEncoding 935
watt.server.jms.nirvana.durableSubscriber.includeClientIdwatt.server.loginFailureLimit 936
923
watt.server.logRotateInterval 935, 959
watt.server.jms.producer.po oledSession.timeout
watt.server.logs.dateStampFmt 936
923
watt.server.math.floatOperation.mode 936
watt.server.jms.tri gger.raiseE vent OnRetryFailu re
watt.server.mime.decodeHeaders 937
927
watt.server.netEncoding 938
watt.server.jms.trigger. maxPrefetchSize 926
watt.server.new.http.session.context 938
webMethods Integration Server Administrators Guide Version 9.10

1031

M
Index

watt.server.noAccessURL 938
watt.server.noObjectURL 938
watt.server.ns.b ackupNode 939
watt.server.ns.dependencyManager 939
watt.server.ns.hideWmRoot 939
watt.server.ns.lockingMode 939
watt.server.oauth.approvalpage.footer 939
watt.server.oauth.approvalpage.logo 939
watt.server.oauth.approvalpage.title 940
watt.server.oauth.authCode.expirySecon ds 940
watt.server.oauth.authServer.alias 940
watt.server.oauth.custom.responseHeader 940
watt.server.oauth.requireHTTPS 941
watt.server.oauth.token.defaultExpirySeconds 941
watt.server.package.WSD.loadExternalResources
942
watt.server.partner 942
watt.server.pas sword.minUpp erChars 943
watt.server.pass word.minDigits 942
watt.server.password.minLength 942
watt.server.port 943
watt.server.portQ ueue 943
watt.server.publi sh.useCSQ 944
watt.server.publish. local.rejectOOS 943
watt.server.publish.usePipelineB rokerE v ent 944
watt.server.recordTodocument. bu f fersize 945
watt.server.requestCerts 945
watt.server.RESTDirective 946
watt.server.revInvoke.proxyMapUserCerts 946
watt.server.rg.int ernalreg istration.timeout 946
watt.server.scheduler.maxWait 947
watt.server.serv iceMail 948
watt.server.serverclassloadername 948
watt.server.serverlogQueueSize 948
watt.server.serverlogRotateSize 948
watt.server.servic e.lazyEval 948
watt.server.setReponse.pre82Mode 949
watt.server.smtpServer 673, 950
watt.server.smtpServerPort 950
watt.server.smtpTransportSecurity 950
watt.server.smtpTrustStoreAlias 950
watt.server.SOAP.addEmptyHeader 951
watt.server.SOAP.completeLoad 951
watt.server.SOAP.defaultProtoc ol 953
watt.server.SOAP.encodeXSITypeValue 954
watt.server.SOAP.generate RequiredTags 954
watt.server.SOAP.M TOMThreshold 955
watt.server.SOAP.request.timeout 956
watt.server.SOAP.streamHandlers 956

watt.server.soap.validateResponse 957
watt.server.SOAP.validateSOAPMessage 957
watt.server.soapjms.defaultMessageType 957
watt.server.SoapRPC. useSecondaryType 958
watt.server.SoapRPC.checkHeaders 958
watt.server.SoapRPC.distinguishDuplicateElements
958
watt.server.ssl.keyStoreAlias 415
watt.server.ssl.trustStoreAlias 415, 958
watt.server.stats.avgTime 959
watt.server.stats.logfile 959
watt.server.stats.pollTime 959, 960
watt.server.statsLogRotateInterval 935, 959
watt.server.storage.lock.maxDuration 959
watt.server.storage.lock.sweep Interval 960
watt.server.sup presscwarn 960
watt.server.sync.timeout 960
watt.server.t
rigger.preprocess.suspendAndRetryOnError 964
watt.server.th readPool 962
watt.server.threadKill.enabled 961
watt.server.threadKill.interru pt Thread.enabled 961
watt.server.threadKill.timeout.enabled 961
watt.server.tr igger.reuseSession 965
watt.server.transaction.recove ry.abandonTimeout
809
watt.server.transaction.recovery.abandonTimeout
962
watt.server.transaction.recovery.sleepInterval 809,
962
watt.server.trigger.interruptRetryOnShutdown 772,
962
watt.server.trigger.keepAsBrokerEvent 962
watt.server.trigger.local.chec kTTL 962
watt.server.trigger.managementUI.e xcludeList 963
watt.server.trigger.preprocess.monitorDatabaseOnConnectionException
963
watt.server.trigger.removeSubscriptionOnRelo
adOrReinstall 965
watt.server.trigger.reuseSession 965
watt.server.tspace .max 967
watt.server.tspace.location 967
watt.server.tx.cluster.lock BreakSecs 968
watt.server.tx.cluster.lockTimeoutMillis 968
watt.server.tx.heuristicFailRetry 674, 968
watt.server.tx.swe epTime 968
watt.server.tx.sweepTime 674
watt.server.txMail 673, 968
watt.server.url.alias.partialMatching 968

webMethods Integration Server Administrators Guide Version 9.10

1032

M
Index

watt.server.ws.71xHandlerChainBehavior 970
shutting down 65
watt.server.ws.defaultNamespace 970
webMethods Integration Server
watt.server.ws.responseTNS.from.request 970
accessing with URLs 988
watt.server.ws.security.timestampMaximumSkew
architecture 35
970
client authentication 458
watt.server.ws.security.timestampPrecisionInMilliseconds client prefix 234, 238
971
configuration settings 852
watt.server.ws.security.timestampTimeToLive 971
configuring 107
watt.server.xml.encoding 971
debug mode 57
watt.server.xml.xmlNodeToDocument.keepDup
deploying 842
licates 972
determining if running 61
watt.server.xml.xmlNodeToDocument.makeArrayforWS how SSL is used 402
973
identify hosts that can connect 424, 427
watt.ssh.jsch.ciphers 974
installing 842
watt.ssh.jsch.logging 974
license keys 108
watt.ssl.accelerator.provider 973
overview 34
watt.ssl.iaik.clientAllowUnboundRenegotiate 974
preventing use of port 210
watt.ssl.iaik.debug 974
process for executing services 39
watt.ssl.iaik.serverAllowUnboundRenegotiate 974
process when starting 61
watt.tx. disabled 975
rejecting connections from specifi ed hosts 425
watt.tx.defaultTTLMins 975
restarting 67
watt.tx.disabled 676
retrieving data for services 37
watt.tx.heuristicFailRetry 975
role 34
watt.tx.jobThreads 676, 975
setting up aliases for remote serv ers 117
watt.tx.retryBackoff 676
shutting down 66
watt.tx.retryBackoffTime 975
starting from command line 55
watt.tx.sweepTime 676, 976
starting on UNIX 55
watt.tx.vm.id 674, 976
testing installation 849
watt.wm.tnextdc.configVersion 975
using with wireless gateways 986
watt.xslt.debug.facList 976
when to restart 67
watt.xslt.debug.level 977
wireless devices, communicating with 986
watt.xslt.debug.logfile 977
wireless devices, using with 986
web
webMethods messaging
directive 433
SSL with Universal Messaging 252
web directive, using with proxy port 434
webMethods messaging triggers
web servi ces
cluster synchronization 768, 768
timestampMaximumSkew 970
configuring 768
web service response, target namespace 970
log messages for 768
web services
monitoring 770
adding endpoint aliases 134, 312
document processing
handler chain behavior 970
concurrent trigger execution threads 759
timest ampPrecisionInMilliseconds 971
limiting threads 766
timestampTimeToLive 971
overview 757
web subdirectory 587
resuming for all triggers 762
webMe thods Integration Server
resuming for one trigger 764
audit-trail logging, overview 51
suspending for all triggers 762
webMethods Broker
suspending for one trigger 764
connecting to using native webMethods API 276
thread usage 758, 759
webMethods Integr ation Server
document retrieval
webMethods Integration Server Administrators Guide Version 9.10

1033

M
Index

overview 748
resuming for all triggers 753
resuming for one trigger 755, 755
suspending for all triggers 753
suspending for one trigger 755
thread usage 749, 749
editing properties 770
queue capacity, reducung 751
refill level, reducing 751
resuming all document processing 762
resuming document processing 762, 764
resuming document retrieval 753, 755
specifying user account 265
throttle controls
Execution Threads Throttle 759
Queue Capacity Throttle 751
webMethods Universal Messaging
client libraries 309
JMS provider 303
webMethodsIntegration Server
recovery after hardware or software failure 68
Windows authentication 983
wireless devices
communicating with webMethods Integration
Server 986
invoking services with URLs 988
requesting HDML or WML pages 989
using URLs to access servers 988
using with webMethods Integration Server 986
wireless gateway, role in wireless communication
986
Wireless Markup Language. 986
wm.server.admin
getDiagnosticData 833
WML (Wireless Markup Language) 986, 989
WML pages, accessing with wireless devices 989
WmSamples package, description 584
WS endpoint triggers
about 792
editing 793

deleting unresolved 810

disabling recovery 808
effect on Integration Server performance 803
enabling recovery 808
errors during manual recovery 811
JTA standard 804
management 802
resolving uncompleted transactions automatically
803
resolving uncompleted transactions manually
810, 810, 810
setting action to take when status not stored
809, 917
setting retry p eriod for auto matic resolution 962
setting retry period for automatic resolution 809
setting time limit for automatic resolution 809,
962
uncompleted transactions Integration Server
cannot resolve 804
XA interface 802
XIDs 804
XA_TRANSACTION 278
XIDs 802, 804
X-OAuth-Error header 940

zip files for packages

creating 612
sending 612

XA recovery store 802

configuring 808
description 802
initial size 809
location 809
XA transactions

webMethods Integration Server Administrators Guide Version 9.10

1034