My webMethods Server Administrator's Guide - Software AG ...

Title Page
My webMethods Server Version 7.1.1 My webMethods Server
Administrator’s Guide

Copyright
& Docu‐
ment ID
Cerebra, Glue, Infravio X‐Broker, Infravio X‐Registry, Infravio, My webMethods Server, My webMethods, webMethods Access, webMethods Administrator,
webMethods Broker, webMethods Central Configuration, webMethods Dashboard, webMethods Designer, webMethods Developer, webMethods Fabric,
webMethods Glue, webMethods Infrastructure Data Collector, webMethods Infravio X‐Broker, webMethods Infravio X‐Registry, webMethods Installer,
webMethods Integration Server, webMethods logo, webMethods Mainframe, webMethods Manager, webMethods Modeler, webMethods Monitor,
webMethods Optimize for Infrastructure, webMethods Optimize for Process, webMethods Optimize, webMethods Portal, webMethods Process Engine,
webMethods Servicenet, webMethods Task Engine, webMethods Trading Networks, webMethods Workflow, and webMethods are either registered
trademarks or trademarks of webMethods, Inc.
Acrobat, Acrobat, and Reader are registered trademarks of Adobe Systems Incorporated. Amdocs and ClarifyCRM are registered trademarks of Amdocs.
Ariba is a registered trademark of Ariba, Inc. BEA, BEA WebLogic Server, Jolt, and Tuxedo are registered trademarks, and BEA WebLogic Platform is a
trademark of BEA Systems, Inc. Action Request System, BMC Software, PATROL, and Remedy are registered trademarks of BMC Software, Inc. BroadVision
is a registered trademark of BroadVision, Inc. Chem eStandards and CIDX are trademarks of CIDX, The Chemical Industry Data Exchange. SiteMinder and
Unicenter are registered trademarks of CA, Inc. PopChart is a registered trademark of CORDA Technologies, Inc. Kenan and Arbor are registered trademarks
of Alcatel‐Lucent. Data Connection and SNAP‐IX are registered trademarks of Data Connection Corporation. D&B and D‐U‐N‐S are registered trademarks of
Dun & Bradstreet Corporation. Eclipse is a trademark of Eclipse Foundation, Inc. Entrust is a registered trademark of Entrust, Inc. papiNet is a registered
trademark of the European Union and the United States. Financial Information eXchange, F.I.X, and F.I.X Protocol are trademarks of FIX Protocol Ltd.
UCCnet and eBusinessReady are registered trademarks, and 1SYNC and Transora are trademarks of GS1 US. Hewlett‐Packard, HP, HP‐UX, OpenView, PA‐
RISC, and SNAplus2 are trademarks of Hewlett‐Packard Company. i2 is a registered trademark of i2 Technologies, Inc. AIX, AS/400, CICS, ClearCase, DB2,
Domino, IBM, Informix, Infoprint, Lotus, Lotus Notes, MQSeries, OS/390, OS/400, RACF, RS/6000, SQL/400, S/390, System/390, VTAM, and WebSphere, and
z/OS are registered trademarks; and Communications System for Windows NT, DB2 Universal Database, IMS, MVS, and SQL/DS are trademarks of IBM
Corporation. InnoDB is a trademark of Innobase Oy. Itanium is a registered trademark of Intel Corporation. Linux is a registered trademark of Linus
Torvalds. W3C is a registered trademark, and X Window System is a trademark of the Massachusetts Institute of Technology. MetaSolv is a registered
trademark of Metasolv Software, Inc. ActiveX, Microsoft, Outlook, Visual Basic, Visual SourceSafe, Windows, Windows NT, and Windows Server are
registered trademarks of Microsoft Corporation. Six Sigma is a registered trademark of Motorola, Inc. Firefox and Mozilla are registered trademarks of the
Mozilla Foundation. MySQL is a registered trademark of MySQL AB. nCipher is a trademark of nCipher Corporation Ltd. Eclipse is a trademark of Eclipse
Foundation, Inc. Entrust is a registered trademark of Entrust, Inc. papiNet is a registered trademark of the European Union and the United States. Financial
Information eXchange, F.I.X, and F.I.X Protocol are trademarks of FIX Protocol Ltd. UCCnet and eBusinessReady are registered trademarks, and 1SYNC and
Transora are trademarks of GS1 US. Hewlett‐Packard, HP, HP‐UX, OpenView, PA‐RISC, and SNAplus2 are trademarks of Hewlett‐Packard Company. i2 is a
registered trademark of i2 Technologies, Inc. AIX, AS/400, CICS, ClearCase, DB2, Domino, IBM, Informix, Infoprint, Lotus, Lotus Notes, MQSeries, OS/390,
OS/400, RACF, RS/6000, SQL/400, S/390, System/390, VTAM, and WebSphere, and z/OS are registered trademarks; and Communications System for Windows
NT, DB2 Universal Database, IMS, MVS, and SQL/DS are trademarks of IBM Corporation. InnoDB is a trademark of Innobase Oy. Itanium is a registered
trademark of Intel Corporation. Teradata is a registered trademark of NCR Corporation. Netscape is a registered trademark of Netscape Communications
Corporation. ServletExec is a registered trademark, and New Atlanta is a trademark of New Atlanta Communications, LLC. SUSE is a registered trademark
of Novell, Inc. Appia is a registered trademark and Javelin Technologies is a trademark of NYFIX, Inc. CORBA is a registered trademark of Object
Management Group, Inc. JD Edwards, OneWorld, Oracle, PeopleSoft, Siebel, and Vantive are registered trademarks; and Infranet, PeopleSoft Pure Internet
Architecture, Portal, and WorldSoftware are trademarks of Oracle Corporation. Perforce is a trademark of Perforce Software. JBoss and Red Hat are
registered trademarks of Red Hat, Inc. PIP and RosettaNet are trademarks of RosettaNet, a non‐profit organization. SAP and R/3 are registered trademarks
of SAP AG. PVCS is a registered trademark of Serena Software, Inc. SWIFT and SWIFTNet are registered trademarks of Society for Worldwide Interbank
Financial Telecommunication SCRL. SPARC and SPARCStation are registered trademarks of SPARC International, Inc. BAAN and SSA are registered
trademarks; and SSA Global is a trademark of SSA Global Technologies, Inc. EJB, Enterprise JavaBeans, Java, JavaServer, JDBC, JSP, J2EE, Solaris, Sun, and
Sun Microsystems are registered trademarks; and Java Naming and Directory Interface, JavaServer Pages, SOAP with Attachments API for Java, and SunSoft
are trademarks of Sun Microsystems, Inc. Sybase is a registered trademark of Sybase, Inc. VERITAS is a registered trademark, and VERITAS Cluster Server is
a trademark of Symantec Corporation. UNIX is a registered trademark of The Open Group. Unicode is a trademark of Unicode, Inc. VeriSign is a registered
trademark of Verisign, Inc.
Software AG and all Software AG product names are either trademarks or registered trademarks of Software AG.
Other product and company names mentioned herein may be the trademarks of their respective owners.
Copyright © 2004—2007 webMethods, Inc. All rights reserved.
Copyright © 2004—2007 Software AG and/or its suppliers, Uhlandstrasse 12, 64297 Darmstadt, Germany. All rights reserved.
Document ID: MWS-AG-711-20071207

Contents
C on te n ts
About This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Part I. Startup and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Chapter 1. Introduction to My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Introduction to My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Starting and Stopping My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Starting and Stopping on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Starting and Stopping from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Getting Started as an Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Logging Into My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Logging Out of My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Changing the Administrator Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Chapter 2. Changing My webMethods Server Configuration . . . . . . . . . . . . . . . . . . . . . . 23
Post-Installation Configuration Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Changing Listener Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Guidelines for Multiple My webMethods Server Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Chapter 3. My webMethods Server and HTTPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Using My webMethods Server as an HTTPS Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Communicating with webMethods Components Using HTTPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Chapter 4. Using My webMethods Server with Web Servers . . . . . . . . . . . . . . . . . . . . . . . 31
Integration with Web Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Configuring My webMethods Server with IIS 6.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Configuring My webMethods Server with Apache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Prerequisites to Configuring Apache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Locating the Apache Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Configuring the Apache Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Configuring My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Configuring Apache with a Server in a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Chapter 5. Running My webMethods Server from the Command Line . . . . . . . . . . . . . . . 43
Command Syntax for My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Simple Start and Stop Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 3

C on te n ts
Creating a New Server Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Modifying Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Deleting a Server Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Part II. My webMethods Administrator Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Chapter 6. Managing My webMethods Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Overview of My webMethods Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Managing Directory Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Setting Up the Internal System Directory Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Managing External Directory Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Configuring an External LDAP, ADSI, or ADAM Directory Service . . . . . . . . . . . . . . . . . . . 57
Configuring an External Database Directory Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Allowing Externally Defined Users Access to My webMethods . . . . . . . . . . . . . . . . . . . . . . 63
Updating the Configuration for a Directory Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Updating the Search Order for Search Directory Services . . . . . . . . . . . . . . . . . . . . . . . . . 65
Deleting a Directory Service Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Managing External Data Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Adding a Microsoft SQL Server Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Adding an Oracle Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Adding a DB2 Universal Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Adding a Sybase Adaptive Server Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Adding an Informix Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Adding a Generic ODBC Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Adding a Custom Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Modifying a Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Deleting a Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Managing E-Mail Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Chapter 7. Searches for Users, Groups, and Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Searching for Existing Users, Groups, or Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Advanced Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Using Saving Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Creating a Saved Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Using a Saved Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Modifying a Saved Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Deleting a Saved Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Exporting Search Results to a .csv File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Chapter 8. Managing Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Overview of Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 4

C on te n ts
Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Managing Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Adding Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Editing Information for a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
User Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Assigning a User to a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Deleting a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Locating a User’s Home Folder (System Administrator Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Managing Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Adding Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Editing Group Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Group Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Managing Members of a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Making a Group a Member of Another Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Deleting Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Managing Authentication Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Adding an Authentication Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Searching for Authentication Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Viewing Details of an Authentication Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Assigning a User to an Authentication Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Changing Users for an Authentication Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Removing a User from an Authentication Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Deleting an Authentication Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Chapter 9. Managing Roles and Access to My webMethods . . . . . . . . . . . . . . . . . . . . . . . 109
Overview of Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Granting Users Access to My webMethods and the My webMethods Users Role . . . . . . . . . . . . . . . 111
Users Defined in the Internal System Directory Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Externally-Defined Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Creating Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Adding a Static Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Editing Members of a Static Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Adding an LDAP Query Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Adding a Rule-Based Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Adding a Database Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Editing Information for a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Deleting Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Defining Dynamic Attributes Associated with a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Setting User-Specific Values for Dynamic Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Changing the Order of Dynamic Attributes Assigned to a Role . . . . . . . . . . . . . . . . . . . . . . . . . . 122
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 5

C on te n ts
Deleting Dynamic Attributes Assigned to a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Managing User Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Managing User Actions Within Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Chapter 10. My webMethods Server Clustering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
How a My webMethods Server Cluster Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
A Shared File System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
The Front End URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Cluster Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Guidelines for Assigning Specific Cluster Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Planning your My webMethods Server Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Creating a My webMethods Server Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Configuring the Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Configuring the Master Server in the Server Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Adding Server Machines to a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Starting a My webMethods Server Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Part III. System Administrator Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Chapter 11. Attribute Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
What are Attribute Providers? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Using Attribute Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
The Core Attributes Attribute Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
User Information Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Group Information Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Role Information Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
The User Preferences Attribute Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
The User Profile Attribute Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
The LDAP Attribute Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Displaying the LDAP Attribute Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Exposing LDAP Attributes from an External Directory Service . . . . . . . . . . . . . . . . . . . . . . 141
The Database Attribute Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Displaying the Database Attribute Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Exposing Database Attributes from an External Directory Service . . . . . . . . . . . . . . . . . . . 142
The Notification Attribute Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
The Dynamic Attribute Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Using Global Wiring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Managing the Display of Principal Attribute Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Adding a Principal Attribute Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Changing the Display Order for Principal Attribute Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Removing a Principal Attribute Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 6

C on te n ts
Chapter 12. Managing My webMethods Server Security . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Overview of My webMethods Server Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Server Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Forms Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Anonymous Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Basic Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
NTLM Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
HTTP Header Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Extended and Extensible Authentication Schemes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Extending Login and Splash Page Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Security Assertion Markup Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Server Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Controlling Permissions on Server Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Authorization Determination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Managing Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Specifying a Default Authentication Scheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Assigning an Authentication Scheme to a Server Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Redirecting a User After Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Redirecting an Unauthenticated Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Specifying a Primary Domain Controller for NTLM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Managing Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Viewing Permissions for a Server Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Adding a Principal to the Permissions for a Server Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Modifying Permissions for a Server Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Removing a Principal from Server Resource Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Managing Permissions to the Descendents of a Server Resource . . . . . . . . . . . . . . . . . . . . . . . 165
Using Security Realms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Creating a Container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Removing a Container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Renaming a Container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Creating a Security Realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Removing a Security Realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Renaming a Security Realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Adding Resources to a Security Realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Removing Resources from a Security Realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Clearing Session Passwords from Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Controlling Login IP Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Deploying the Lockdown Portlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Configuring the Lockdown Portlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 7

C on te n ts
Disabling the Lockdown Portlet in My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Disabling the Lockdown Portlet Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Chapter 13. Analysis, Reporting, and Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Controlling Server Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Setting Logging Thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Setting the Collector Threshold for View Logging Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Modifying the Log-File Rollover Period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Viewing Logging Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Using the Search Logged Messages Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Using the Manage Search Index Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Monitoring Real-Time User Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Collecting Data about Server Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Deploying the Events Collector Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Configuring the Events Collector Configuration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Events Collector Database Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Capturing Server Environment Diagnostic Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Chapter 14. My webMethods Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Managing Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Creating an Alias to a Server Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Searching for Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Performing a Simple Alias Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Specifically Including or Excluding System Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Performing an Advanced Alias Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Using Saved Alias Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Modifying an Alias to Point to a Different Server Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Deleting an Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Configuring External Configuration Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Enabling Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Checking Logs for HTTP Header Authentication Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Setting Login Logging Thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Checking HTTP Header Authentication Logs for Problems . . . . . . . . . . . . . . . . . . . . . . . . 197
Deploying My webMethods Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Modifying the Polling Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Installing a Portlet Using the Deploy Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Installing Portlets or Other Deployable Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Uninstalling Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 8

C on te n ts
Managing Server Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Configuring Properties for Managed Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Configuring Permissions for Managed Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Setting up Single Sign-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Configuring a Server as a Target for Single Sign-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Setting SAML Links on a Source Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Checking Logs for SAML Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Displaying System Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Chapter 15. Managing My webMethods Server Content . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Migrating My webMethods Server Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Content Migration Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Migrating Server Content using Export/Import Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Managing Content Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Managing Subscriptions for Individual Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Managing Group Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Publishing Portlets as an Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Managing the Search Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Resynchronyzing the Search Indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Optimizing the Search Indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Reloading the Default Search Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Chapter 16. Managing the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Locale Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
What are Server Rules? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Creating Locale Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Creating Login Page Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Creating Rendering Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Creating Start Page Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Modifying a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Copying a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Managing the Evaluation Order for Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Removing a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Working with Skins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Explicitly Assigning a Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Managing Skin Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Creating Skin Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Working with Shells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Managing Shell Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Creating Shell Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 9

C on te n ts
Setting Shells for Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Setting Shells for Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Chapter 17. Managing and Using a Wiki . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
What is a Wiki? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Managing Participation in a Wiki . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Creating a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Modifying a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Editing a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Wiki Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Finding a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Finding a Wiki Page by Browsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Searching for a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Wiki Saved Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Moving a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Renaming a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Adding a Subpage to a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Attaching a File to a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Opening a File Attached to a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Managing Versions of a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Viewing the History of a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Viewing an Older Version of a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Make a Wiki Page the Current Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Comparing With the Previous Version of a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Editing an Older Version of a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Chapter 18. Managing and Using a Forum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
What is a Forum? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
How Forums are Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Roles Associated with Forums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Standard Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
The Other Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
How this Chapter is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Getting Started with Forums as System Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Activities You can Perform as a Spectator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Viewing Forum Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Subscribing to a Forum or Forum Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Searching in a Forum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Rating a Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Activities You Can Perform as a Contributor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Creating a Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 10

C on te n ts
Creating a Message in an Existing Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Requesting a Retraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Activities You Can Perform as a Moderator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Moderating a Forum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Editing a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Deleting a Topic or Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Activities You Can Perform as an Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Creating a Forum or Forum Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Moving a Forum or Forum Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Renaming a Forum or Forum Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Modifying Options of a Forum or Forum Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Modifying Permissions for a Forum or Forum Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Deleting a Forum or Forum Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Managing Forums as System Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Managing Forum Security Realms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Creating a Forum Security Realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Editing a Forum Security Realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Deleting a Forum Security Realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Searching Forums as System Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Listing Topics and Messages Pending Approval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Listing Messages Requested for Retraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Running Forum Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Part IV. Page Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Chapter 19. Managing Pages in My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Overview of Page Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Editing My webMethods Pages as System Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Creating and Modifying Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Creating a Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Manipulating Rows on a Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Adding a Row to a Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Repositioning a Row on a Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Removing a Row from a Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Manipulating Columns on Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Adding Columns to a Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Repositioning a Column on a Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Removing a Column from a Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Adding and Managing Portlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Manipulating Portlets on Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Adding a Portlet to a Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 11

C on te n ts
Repositioning a Portlet in a Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Removing a Portlet from a Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Modifying the Settings of an Existing Portlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Managing Portlet Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Adding an Alias to a Portlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Removing an Alias from a Portlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Wiring Portlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Global Wiring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Controlling the Layout of the Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Creating Links for Single Sign-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Chapter 20. Working with Skins in My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . 311
What are Skins? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Managing Skins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Creating a New Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Deleting a Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Replacing Images in a Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Managing Colors in a Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Replacing Colors Using a Color Picker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Replacing Colors from a Skin or Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Managing Font Families in a Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Previewing a Page Elsewhere on the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Chapter 21. Working with Shells in My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . 319
What are Shells? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Creating a New Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Modifying a Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Using an Alias with a Shell Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Deleting a Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Making an Empty Shell Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 12

About This Guide
Document Conventions
Additional Information
About This Guide
This guide explains how to configure and manage My webMethods Server as a system
administrator. The guide explains how, as a My webMethods Administrator (not the
same as a system administrator), you can manage users, groups, and roles for the
applications that run on My webMethods Server. In addition, the guide describes how to
develop and manage pages for display by My webMethods Server.
Convention Description
Bold Identifies elements on a screen.
Italic Identifies variable information that you must supply or change
based on your specific situation or environment. Identifies terms the
first time they are defined in text. Also identifies service input and
output variables.
Narrow font Identifies storage locations for services on the webMethods
Integration Server using the convention folder.subfolder:service.
Typewriter
font
Identifies characters and values that you must type exactly or
messages that the system displays on the console.
UPPERCASE Identifies keyboard keys. Keys that you must press simultaneously
are joined with the “+” symbol.
\ Directory paths use the “\” directory delimiter unless the subject is
UNIX‐specific.
[ ] Optional keywords or values are enclosed in [ ]. Do not type the [ ]
symbols in your own code.
The webMethods Advantage Web site at http://advantage.webmethods.com provides you
with important sources of information about webMethods products:
� Troubleshooting Information. The webMethods Knowledge Base provides
troubleshooting information for many webMethods products.
� Documentation Feedback. To provide feedback on webMethods documentation, go to
the Documentation Feedback Form on the webMethods Bookshelf.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 13

About This Guide
� Additional Documentation. Starting with 7.0, you have the option of downloading the
documentation during product installation to a single directory called
“_documentation,” located by default under the webMethods installation directory.
In addition, you can find documentation for all webMethods products on the
webMethods Bookshelf.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 14

Part I. Startup and Configuration
� Introduction to My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
� Changing My webMethods Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
� My webMethods Server and HTTPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
� Using My webMethods Server with Web Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
� Running My webMethods Server from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 15

I. Startup and Configuration
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 16

Chapter 1. Introduction to My webMethods Server
� Introduction to My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
� Starting and Stopping My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
� Getting Started as an Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 17

Introduction to My webMethods Server
1. Introduction to My webMethods Server
My webMethods Server is a run‐time container for functions made available by
webMethods components. The user interface in which you perform these functions is
called My webMethods. My webMethods provides a ready‐made environment in which
users can perform functions on webMethods components, and administrators can
manage access to those functions. In addition, My webMethods Server gives you the
capability to develop additional user interface pages, and a broad‐based set of
administrative tools with which to manage the increased capabilities.
My webMethods Server recognizes two types of administrators, based on the functions
they perform:
Administrator Description
My webMethods
Administrator
The default administrator of My webMethods. This
user can perform user management functions and
manage external directory services. As installed, the
user ID is “Administrator” and the password is
“manage.” For more information about functions
available to this user, see “My webMethods
Administrator Functions” on page 51.
System administrator The system administrator for My webMethods Server.
This user can manage My webMethods Server,
including analysis, configuration, content, and user
management. As installed, the user ID is “SysAdmin”
and the password is “manage.” This administrator
does not use the My webMethods user interface. For
more information about functions available to this
account, see “System Administrator Functions” on
page 135.
In some cases, both types of administrator can perform the same functions, such as
performing user management. Where there are differences between the My webMethods
and system user interfaces, the procedures describe both.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 18

This guide is organized into multiple parts:
These activities... Are described here...
Getting started as an administrator,
changing the configuration of My
webMethods Server, using external Web
servers, and running servers from the
command line.
Managing users, groups and roles as a My
webMethods Administrator.
Managing the advanced capabilities of
My webMethods Server as a system
administrator.
Developing and managing user interface
pages.
For additional information:
Starting and Stopping My webMethods Server
1. Introduction to My webMethods Server
If you are running My webMethods Server Configurator to create a new My webMethods
Server instance or edit an existing one, you can start or stop the server from the
Configurator user interface. There are other ways to start and stop My webMethods
Server, described in the following sections.
Starting and Stopping on Windows
“Startup and Configuration” on page 15
“My webMethods Administrator
Functions” on page 51
“System Administrator Functions” on
page 135
Part IV, “Page Development”
These activities... Are described here...
Installation and initial configuration of
My webMethods Server.
The basic activities an individual user can
perform on My webMethods applications.
If My webMethods Server is configured on Windows computers as a service, you can use
the following commands for starting and stopping.
To start My webMethods Server on a Windows host
The webMethods Installation Guide.
Getting Started with My webMethods.
1 Open the Control Panel and double‐click the Administrative Tools icon.
2 In the Administrative Tools window, double‐click the Services icon.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 19

1. Introduction to My webMethods Server
3 In the Services window, double‐click the service named webMethods MwS.
4 Click Start.
After a few seconds, the status changes to Started.
To stop My webMethods Server on a Windows host
1 Open the Control Panel and double‐click the Administrative Tools icon.
2 In the Administrative Tools window, double‐click the Services icon.
3 In the Services window, double‐click the service named webMethods MwS.
4 Click Stop.
After a few seconds, the status changes to Stopped.
Starting and Stopping from the Command Line
You can start or stop My webMethods Server at a command prompt on either Windows
or UNIX computers.
To start or stop My webMethods Server from the command line
1 At a command line prompt, type the following command to move to the My
webMethods Server directory:
cd webMethods_install_dir/MWS/server/server_instance/bin
2 Type one the following commands:
Purpose Operating system Command
Start My webMethods Server in the
same console window
Start My webMethods Server in a
new console window
Windows run.bat
UNIX run.sh
Windows startup.bat
UNIX startup.sh
Stop My webMethods Server Windows shutdown.bat
UNIX shutdown.sh
For more information on controlling My webMethods Server from the command line, see
“Running My webMethods Server from the Command Line” on page 43.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 20

Getting Started as an Administrator
1. Introduction to My webMethods Server
The following sections describe some basic functions you can perform to get started using
My webMethods Server:
Functions Described here...
Log in “Logging Into My webMethods Server” on page 21
Log out “Logging Out of My webMethods Server” on page 22
Change your password “Changing the Administrator Password” on page 22
Logging Into My webMethods Server
My webMethods Server has a user interface that you access using a Web browser.
To log into My webMethods Server
1 Access the My webMethods Server Login page by entering a URL in a Web browser:
http://host:port
where:
� host is the host name of the machine on which My webMethods Server is
installed.
� port is the port on which My webMethods Server listens for incoming requests.
The default port for My webMethods Server is 8585.
For example, if the host name is rubicon.company.com and it uses the default port
(8585), type the following URL:
http://rubicon.company.com:8585
2 On the Login page, make these entries in the User Name and Password fields:
If you are... User Name Password
My webMethods Administrator Administrator manage
System administrator SysAdmin manage
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 21

1. Introduction to My webMethods Server
Note: When logging in, the value you specify in the user name is case insensitive.
However, after logging in, My webMethods Server uses the case of the user name that
is defined in your user account. For example, if the user account is defined as
“Administrator,” you can log in using “administrator.” When My webMethods
Server needs to use the user name, for example, for HTTP authentication, it uses the
version defined in the user account, which is “Administrator.”
Important! To keep My webMethods Server secure, you should change the default
administrator password. For instructions about how to change the password, see
“Changing the Administrator Password” on page 22.
3 Click Login.
After you log in, My webMethods Server displays the Administrator home page.
Logging Out of My webMethods Server
Perform the following procedure to log out of My webMethods Server.
To log out of My webMethods Server
Click the Logout link, which is located at the top of all My webMethods pages.
Changing the Administrator Password
Change your password by editing the fields on the User Information panel of your profile.
To change your password
1 Click My Profile, located at the top of all My webMethods pages.
2 On the User Information panel, type your new password in the Password field.
3 In the Confirm Password field, type your new password again for confirmation.
4 Click Apply.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 22

Chapter 2. Changing My webMethods Server Configuration
� Post-Installation Configuration Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
� Changing Listener Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
� Guidelines for Multiple My webMethods Server Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 23

Post-Installation Configuration Changes
2. Changing My webMethods Server Configuration
When you install My webMethods Server, it has a default configuration. You can specify
the type and location of the database used by the server and the HTTP port the server
uses, but nothing else. After the installation is completed and you have a default instance
of My webMethods Server running, you can make changes to the configuration, a few of
which are shown here:
Changing Listener Ports
Configuration change Where to find more information
Change the HTTP port, add an HTTPS
port, or add an AJP13 port for an external
Web server.
Change the levels of logging messages
collected by the server
Add or remove components deployed
with the server
Add server instances on the same
machine
You can change the HTTP listener port, add an HTTPS listener port, or add an AJP13
listener port for an external Web server. Management of listener ports takes place in
Cluster Administration.
To change only the HTTP listener port for a standalone server instance
1 To navigate to the correct page, do one of the following:
“Changing Listener Ports” on page 24.
“Controlling Server Logging” on page 178
“Managing Server Objects” on page 201
“Guidelines for Multiple My webMethods
Server Instances” on page 26 and
“Creating a New Server Instance” on
page 46.
� In My webMethods:
Administration > My webMethods > Cluster Settings > Basic Configuration.
� As system administrator:
Administration > Configuration > Cluster Administration > Basic Configuration.
2 In the HTTP PORT field, type the new port number and click Submit.
3 Restart My webMethods Server for the new setting to take effect.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 24

To change HTTP, HTTPS, and AJP13 listener ports for a server instance
1 To navigate to the correct page, do one of the following:
2. Changing My webMethods Server Configuration
� In My webMethods:
Administration > My webMethods > Cluster Settings > Advanced or Cluster Configuration.
� As system administrator:
Administration > Configuration > Cluster Administration > Advanced or Cluster
Configuration.
2 In the HTTP PORT field, type the port number to be used by the HTTP listener.
This field must always have a valid port number.
3 In the HTTPS PORT field, type the port number to be used by the HTTPS listener.
A value of 0 (zero) in this field disables the listener.
Note: My webMethods Server includes a sample HTTP certificate that you can use to
set up and test your HTTPS listener. The sample is located in the
webMethods_install_dir/MWS/server/server_instance/config/
demo.keystore file. For production environments, be sure to obtain an actual
Certificate from a qualified authority such as Verisign.
4 In the AJP13 PORT field, type the port number to be used by the AJP13 listener.
A value of 0 (zero) in this field disables the listener.
5 In the AJP13 ALLOWED WEB SERVER HOSTS field, type the host names from which
connections are allowed, separated by commas.
You use this setting when you are configuring an external Web server with your front
end segment. For more information, see “Using My webMethods Server with Web
Servers” on page 31.
6 Click Submit to save your settings.
7 Restart My webMethods Server for the new setting to take effect.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 25

2. Changing My webMethods Server Configuration
Guidelines for Multiple My webMethods Server Instances
You can run multiple instances of My webMethods Server on the same machine, but each
server instance must have its own external resources. This is not the same as clustering,
which is described in “My webMethods Server Clustering” on page 125. The following
guidelines apply to running two or more server instances on the same machine:
� Each My webMethods Server instance must have its own database; for a given
database server, the following configuration entries must be unique among all My
webMethods Server instances that use the same database server:
� Database user name
� Database name or tablespace name
� For My webMethods Server instances running concurrently on the same machine, the
following host/port number combinations, if used, must be unique among all servers:
� HTTP port
� HTTPS port (if used)
� AJP13 port and IIS or Apache Web server host and port (if used)
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 26

Chapter 3. My webMethods Server and HTTPS
� Using My webMethods Server as an HTTPS Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
� Communicating with webMethods Components Using HTTPS . . . . . . . . . . . . . . . . . . . . . . . . . 29
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 27

Using My webMethods Server as an HTTPS Client
3. My webMethods Server and HTTPS
If you want to connect My webMethods Server to a server using HTTPS, you must set up
the trusted CA store file (the cacerts file) that the JVM running in the My webMethods
Server machine uses. The trusted CA store file must contain the CA certificates of the
servers to which My webMethods Server will be issuing HTTPS requests.
For example, if you use webMethods Monitor, you must identify the Integration Server to
which My webMethods Server issues requests on behalf of Monitor pages. If you choose
to have the requests issued using HTTPS, you must then set up the trusted CA store file of
the JVM running in the My webMethods Server machine to contain the CA certificate of
the Certificate Authority that signed the Integration Server certificate.
You import CA certificates into the trusted CA store file of the JVM using the JVM’s
keytool command. By default, the trusted CA store file is located in the following location
where webMethods_install_dir is the location where you installed your webMethods
software and operating_system identifies the operating system you use:
webMethods_install_dir\jvm\operating_system\jre\lib\security\cacerts
For example, if you are using Windows, the location of the trusted CA store file is:
webMethods_install_dir\jvm\win50\jre\lib\security\cacerts
To import CA certificates into the trusted CA store file of the My webMethods Server JVM
1 Locate the CA certificate you need to add to the trusted CA store file and ensure it is
available on the machine running My webMethods Server.
2 At a command line prompt, type the following command to move to the
jvm/lib/security directory:
cd webMethods_install_dir\jvm\operating_system\jre\lib\security
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 28

3. My webMethods Server and HTTPS
3 Type the following command to import the CA certificate into the trusted CA store
file:
..\..\..\bin\keytool -import -v -keystore cacerts -file
-alias
where:
� -file identifies the path and file name of the file
that contains the CA certificate you want to import
� ‐alias assigns an alias to the certificate to identify the entry in the
key store file. Select a value that is meaningful to you.
For example, to import the CA certificate named serverCAcert.der, which is stored in
the same directory as the cacerts file, and identify the new entry in the key store file as
SERVERCA, you would use the following command:
..\..\..\bin\keytool -import -v -keystore cacerts -file
serverCAcert.der -alias SERVERCA
4 After entering the keytool command, the command prompts you for the password for
the cacerts file. Enter the password. By default, the password is changeit.
5 After entering the password, the keytool command prompts to verify that you want to
import the CA certificate. Type y for yes.
6 To ensure that the CA certificate was successfully imported into the trusted CA store
file, enter the following command:
..\..\..\bin\keytool -list -keystore cacerts
The keytool command prompts for the password for the cacerts file. Enter the
password.
Communicating with webMethods Components Using HTTPS
By default, My webMethods Server communicates with other webMethods components
using the HTTP protocol. You can change to the HTTPS protocol by doing the following:
To cause My webMethods Server to communicate only through the HTTPS protocol
1 In My webMethods Server do one of the following:
� In My webMethods:
Administration > My webMethods > Cluster Settings > View Segments.
� As system administrator:
Administration > Configuration > Cluster Administration > View Segments.
2 For the default segment, click the segment name or click Tools and then click Modify
Segment.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 29

3. My webMethods Server and HTTPS
3 On the Registered Servers panel, click the master name or click Tools and then click
Modify Server.
4 On the HTTP Listener panel, change the value in the Port field to 0 (zero).
5 On the HTTPS Listener panel, change the value in the Port field to a valid port number
and click Save.
6 On the View Segments panel, click the segment name (the same segment as in step 2) or
click Tools and then click Modify Segment.
7 On the Front End URL field of the Segment Properties panel, modify the URL as follows:
� Change http to https.
� Change the port number to the one you specified in step 5.
For example, change this URL:
To this:
8 Click Save.
http://my_host:8585
https://my_host:7238
9 Restart My webMethods Server.
10 Notify administrators of all webMethods components that communicate with My
webMethods Server of the new HTTPS port number.
Note: If you are using My webMethods Server in a clustered environment, you need to
make the changes in this procedure to all servers that have the Front End role.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 30

Chapter 4. Using My webMethods Server with Web Servers
� Integration with Web Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
� Configuring My webMethods Server with IIS 6.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
� Configuring My webMethods Server with Apache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 31

Integration with Web Servers
4. Using My webMethods Server with Web Servers
My webMethods Server can integrate with the leading Web servers, such as Microsoft
Internet Information Server or Apache HTTP Server. The primary mechanism for
integrating My webMethods Server with a third party Web server in a distributed
deployment scenario requires the use of a small plug‐in that is installed and configured on
the Web server. This plug‐in forwards HTTP requests from the Web server to the server
using the specialized open protocol AJP13.
My webMethods Server provides an integrated servlet engine with Jetty, which is a built‐
in Web server that supports both HTTP and HTTPS. As such, having a separate Web
server tier is not a hard requirement.
There are several reasons for configuring My webMethods Server with an external Web
server (or cluster of Web servers). The most notable reason is to adhere to corporate IT
policies and procedures. My webMethods Server supports a flexible deployment model
that allows an external Web server (or cluster of Web servers) to handle all HTTP requests
that can be separately load balanced.
Integrating an external Web server to handle HTTP requests requires configuring a Web
server plug‐in on the external Web server machine(s). The Web server plug‐in leverages
code from the Jakarta Web server project which is used extensively across many
production‐quality Web server products.
Configuring My webMethods Server with IIS 6.0
Windows 2003 supports Internet Information Server (IIS) 6.0. To use IIS 6.0 with My
webMethods Server, you need to run IIS isolation mode. Software AG does not support
running My webMethods Server through IIS on Windows XP.
Note: The following configuration is one of many distributed deployment scenarios. To
address your specific requirements, please contact Software AG Customer Care for
detailed distributed deployment information and guidelines.
Note: If the ISAPI redirector file described in the following procedure is under Program
Files, the space will cause problems because IIS will not recognize the ISAPI Filter. You
need to either put the ISAPI redirector file in a folder path without a space or manually
update the path within the ISAPI filter to be ʺProgra~1ʺ.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 32

4. Using My webMethods Server with Web Servers
To configure My webMethods Server with Internet Information Server (IIS) 6.0
1 After installing My webMethods Server, the components required to configure My
webMethods Server to leverage an external Web server connection are located in the
following directory on your server machine:
/webMethods_install_dir/MWS/bin/ajp-connectors/iis6
2 If you are configuring My webMethods Server with an IIS Web server running on a
separate machine, do the following:
a On the computer where the Web server resides, create a directory for the plug‐in
files. For example: c:/jk2.
b Copy all of the files from the server ajp‐connector directory for IIS6 to the new
directory you just created.
The following files should be copied:
� isapi_redirector2.dll ‐ this file contains the connector code for the plug‐in
� isapi_redirector2.properties ‐ configuration file
� workers2.properties ‐ configuration file
3 Modify the isapi_redirector2.properties configuration file as follows:
authComplete=0
extensionUri=/jakarta/isapi_redirector2.dll
log_Level=error
serverRoot=C:\JK2
threadPool=20
workersFile=C:\JK2\workers2.properties
4 Modify the workers2.properties configuration file to reflect the machine on which IIS
6.0 is running. In the sample below, modifications for the computer named sauron are
indicated in bold:
[shm]
# info=Scoreboard. Required for reconfiguration and status with
# multiprocess servers.
file=c:\JK2\jk2.shm
size=1048576
# Example socket channel, override port and host.
[channel.socket:sauron:8009]
port=8009
host=15.0.0.4
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 33

# define the worker
[ajp13:sauron:8009]
channel=channel.socket:sauron:8009
[status:]
info=Status worker, displays runtime information
#----
[uri:/jkstatus/*]
info=The Tomcat /jkstatus handler
# group=status:
[uri:/*]
worker=ajp13:sauron:8009
debug=10
[uri:/]
worker=ajp13:sauron:8009
debug=10
[logger]
level=ERROR
[logger.file:0]
level=DEBUG
file=c:\JK2\jk.log
debug=10
4. Using My webMethods Server with Web Servers
5 On the Start menu, go to Programs > Administrative Tools > Internet Information Services (IIS)
Manager.
6 If IIS is running, expand the Web Sites node, right‐click Default Web Site (or the Web site
My webMethods Server is configured to run against) and click Stop.
7 Allow the Jakarta extension in IIS by doing the following:
a On the Start menu, go to Programs > Administrative Tools > Internet Information Services
(IIS) Manager.
b In the Internet information Services Manager, right‐click the Web Service Extensions
node and click Add a new Web service extension.
c In the Extension Name field, type a name for the Web Service extension.
d To fill the Required files field, click Browse, move to select isapi_redirector2.dll, click
Open, and then click OK.
e Select the Set extension status to Allowed option and click OK.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 34

8 Create a virtual directory by doing the following:
4. Using My webMethods Server with Web Servers
a Expand the Web Sites node, right‐click Default Web Site (or appropriate Web site)
and click New > Virtual Directory.
b In the Virtual Directory Creation wizard, click Next and, in the Alias field type the
alias by which you want to identify the virtual directory, and click Next.
c Browse to the directory that contains isapi_redirector2.dll and click Next.
d Select the following options:
� Read
� Run scripts (such as ASP)
� Execute (such as ISAPI applications or CGI)
e Click Next and click Finish.
9 Configure IIS 6.0 to run in IIS 5.0 isolation mode by doing the following:
a Expand the Web Sites node, right‐click Default Web Site (or appropriate Web site)
and click Properties.
b On the ISAPI Filters tab, click Add.
c In the Filter name field, type a name for the filter.
d To fill the Executable field, click Browse, move to select isapi_redirector2.dll, and
click Open.
e Click OK.
f Right‐click the Web Sites node and click Properties.
g In the Isolation mode panel of the Service tab, select Run WWW service in IIS 5.0
isolation mode and click OK.
10 Right‐click Default Web Site (or appropriate Web site) and click Start.
11 Return to the ISAPI Filters tab and make sure the Status column displays a green arrow.
12 Restart My webMethods Server.
Configuring My webMethods Server with Apache
My webMethods Server supports the Apache Web Server, from the Apache Software
Foundation, on UNIX platforms.
My webMethods Server leverages the Apache JServ Protocol (AJP) for integration and
communication with separate Web servers such as Apache. To facilitate this
communication an AJP connector is installed into the Apache Web server. The connector
intercepts and forwards requests based on its configuration to the server. My
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 35

4. Using My webMethods Server with Web Servers
webMethods Server is configured to have an AJP listener either instead of or in addition
to the default HTTP listener. The AJP listener allows My webMethods Server to receive
and respond to browser requests forwarded from the Apache Web server by means of the
AJP tunnel. You can have all or none of the listeners configured; AJP is just one of several
options.
To use either of the AJP modules for Apache, you need to configure Apache with mod_so
support to allow for the AJP connectors to load. The mod_so utility module loads
executable code and modules into the server at start‐up time. See your Apache
documentation for information on how to do this configuration. If you have SSL
configured for your site, use the mod_jk.so module; if you do not have SSL configured,
use the mod_jk‐1.3‐noepi.so module. The following procedure assumes that you do not
have SSL configured.
Mod_jk-1.3noeapi.so
AJP
Listener
Client
Browser
Apache Web
Server
AJP
mod_so
HTTP
Some other
module
My webMethods Server
Client
Browser
HTTPS
Listener
Client
Browser
HTTPS HTTP
HTTP
Listener
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 36

Prerequisites to Configuring Apache
4. Using My webMethods Server with Web Servers
Before you can configure My webMethods Server to use the Apache Web server, you need
to meet the following requirements:
1 Install My webMethods Server and configure it to use the internal Jetty Web server, as
described in the webMethods Installation Guide.
A simple way to validate this is to log in to the server as SysAdmin and browse
around.
2 Install the Apache Web server and verify that it is responding correctly to its default
Web pages.
A simple way to validate this is to browse to the Apache Web server and view the
default Apache page.
Locating the Apache Files
After you have installed My webMethods Server on a UNIX platform, you will find the
Apache components in the following directory on your server machine:
/webMethods_install_dir/MWS/bin/ajp‐connectors/apache
The following files appear in this directory:
File Description
http.conf Example Apache configuration parameters
workers.properties Example AJP configuration file
mod_jk‐1.3‐noeapi.so Binary library file without SSL
mod_jk.so Binary library file requiring SSL
readme Information on configuring My webMethods Server to
communicate with an Apache Web server on UNIX
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 37

Configuring the Apache Web Server
4. Using My webMethods Server with Web Servers
If you have met the prerequisites in “Prerequisites to Configuring Apache” on page 37
and found the Apache files as described in “Locating the Apache Files” on page 37, you
can configure My webMethods Server to use the Apache Web server on a UNIX system.
The following procedure provides general guidelines and assumes the implementation of
a standard Apache configuration; the requirements of your specific situation may vary.
To configure My webMethods Server with Apache Web server on a UNIX system
1 Copy the mod_jk‐1.3‐noeapi.so binary file from the location described in “Locating
the Apache Files” on page 37 to the Apache /libexec directory.
2 Copy the example workers.properties to the Apache /conf directory.
Note: In the following step, do not copy the http.conf file, as you do not want to
overwrite the file that already exists in the Apache /conf file. Rather, use the http.conf
file in the My webMethods Server directory structure as an example of the correct
location for each entry.
3 Edit the http.conf file in the Apache / conf directory to add the following entries.
Add these lines to http.conf
LoadModule jk_module libexec/mod_jk‐1.3‐noeapi.so
JkWorkersFile $APACHE_HOME/conf/workers.properties
JkLogFile $APACHE_HOME/logs/mod_jk.log
JkLogLevel info
JkMount /portal
JkMount /* portal
If you have a more complex Apache distribution than just the defaults with shared
modules enabled, as shown here, you may need to adjust this configuration in more
detail as per your site needs. This example assumes that only the basic components
for an Apache Web server are installed. Both My webMethods Server and Apache are
VERY flexible, this is intended to be only the basics to get this integration to function.
4 Edit the settings in the workers.properties file to ensure that the host entry is correct
and has the same port number you intend to use when configuring the AJP13 listener
configuration.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 38

The following example shows an entry for the host my_host:
# Define 1 real worker using ajp13
worker.list=portal
# Set properties for portal (ajp13)
worker.portal.type=ajp13
worker.portal.host=my_host
worker.portal.port=8009
worker.portal.lbfactor=50
worker.portal.cachesize=10
worker.portal.cache_timeout=600
worker.portal.socket_keepalive=1
worker.portal.socket_timeout=300
5 Restart the Apache Web server.
Configuring My webMethods Server
4. Using My webMethods Server with Web Servers
To configure the server to use the Apache Web server, use the following procedure. The
steps refer to sections in Chapter 2, “Changing My webMethods Server Configuration”
which contains more complete information.
To configure the server to use the Apache Web server
1 If you have not already done so, make sure the Apache Web server is running.
2 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Cluster Settings > Advanced or Cluster Configuration.
� As system administrator:
Administration > Configuration > Cluster Administration > Advanced or Cluster
Configuration.
3 In the AJP13 PORT field, type the port number to be used by the AJP13 listener.
A value of 0 (zero) in this field disables the listener.
4 In the AJP13 ALLOWED WEB SERVER HOSTS field, type the host names from which
connections are allowed, separated by commas.
The port number should be the same port number as assigned in the
workers.properties file, described in “Configuring the Apache Web Server” on
page 38.
5 Click Submit to save your settings.
6 Restart My webMethods Server for the new setting to take effect.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 39

4. Using My webMethods Server with Web Servers
Configuring Apache with a Server in a Cluster
If a server is part of a cluster, you need to take some additional steps to configure it for
Apache Web server support.
To configure Apache for a server that is part of a cluster
1 If you have not already done so, configure the server for Apache, as described in
“Configuring My webMethods Server” on page 39.
2 Locate the cluster.xml file for the cluster.
See Chapter 10, “My webMethods Server Clustering” for information about using
servers in a cluster.
3 In a text editor, edit the cluster.xml file to add a port number to the AJP13 properties
for the server and ensure that the remoteservers name is an exact match for the host
name in the workers.properties file.
The following code fragment shows a portion of the cluster.xml file. The AJP13
listener port number should be the same as the one assigned in the workers.properties
file described in “Configuring the Apache Web Server” on page 38:
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 40

4. Using My webMethods Server with Web Servers
The relationship between the two files is shown in “Relationship between
workers.properties and cluster.xml files” below:
Relationship between workers.properties and cluster.xml files
workers.properties file cluster.xml file
# Define 1 real worker using ajp13
worker.list=portal
# Set properties for portal (ajp13)
worker.portal.type=ajp13
worker.portal.host=my_host
worker.portal.port=8009
worker.portal.lbfactor=50
worker.portal.cachesize=10
worker.portal.cache_timeout=600
worker.portal.socket_keepalive=1
worker.portal.socket_timeout=300
4 Restart the server.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 41

4. Using My webMethods Server with Web Servers
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 42

Chapter 5. Running My webMethods Server from the
Command Line
� Command Syntax for My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
� Simple Start and Stop Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
� Creating a New Server Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
� Modifying Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
� Deleting a Server Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 43

Command Syntax for My webMethods Server
5. Running My webMethods Server from the Command Line
There are times when it is useful to start and stop the server from the command line.
Starting the server this way, for example, allows you to use debug mode so you can record
or display server activity. There are several commands you can use to control operation of
the server, as described in the following procedure.
To control the server from the command line
1 At a command line prompt, type the following command to move to the server’s bin
directory:
cd webMethods_install_dir/MWS/bin
2 Type the following command:
For Windows: mws.bat -switch -switch ... command
For UNIX: mws.sh -switch -switch ... command
where switch is any of the following:
Switch Description
‐s servername The name of the server instance. Not required if you are
controlling the default server. You can find the server instances
on a machine by looking here:
webMethods_install_dir/MWS/server
‐n nodename In a clustered environment, the nodename assigned to the
server instance. Not required if the server is running
standalone, or if it is the master node of a cluster. See
Chapter 10, “My webMethods Server Clustering” for
information on clusters.
‐d[ebug] Starts the server in debug mode. DEBUG statements appear in
the console window and a Java debug listener is open on port
5000.
and command is any of the following:
Command Description
run Starts the server in the same console window.
start Starts the server in a new console window.
stop Stops a running server.
restart Stops a running server and then starts it again.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 44

Command Description
Simple Start and Stop Commands
5. Running My webMethods Server from the Command Line
ping If the server is stopped, indicates this fact. If the server is
running, returns information, including what ports the server
is using.
help Prints command syntax in the console window.
The following commands are for Windows only:
installservice Registers the server as a Windows service.
uninstallservice Unregisters the server as a Windows service.
startservice Starts a server that is registered as a Windows service.
stopservice Stops a server that is registered as a Windows service.
restartservice Stops a server that is registered as a Windows service and then
starts it again.
The following commands configure or delete server instances:
new Creates a new server instance. See “Creating a New Server
Instance” on page 46.
update Used as part of a product fix, updates classpaths and deploys
new or updated components. Accepts only the ‐s switch.
Note: Use this command only as directed while installing a fix
supplied by Software AG.
delete Deletes an existing instance of My webMethods Server.
Accepts only the ‐s switch. See “Deleting a Server Instance” on
page 49.
If you want to start or stop a server, without having to use the servername or nodename as
part of the command syntax, there are commands associated with each server instance on
a machine. This feature is not necessary for a standalone server, but may be useful if you
have multiple servers on a machine.
To start or stop a specific server
1 At a command line prompt, type the following command to move to the server’s
home directory:
cd webMethods_install_dir/MWS/server/server_instance/bin
where server_name is the name of the server.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 45

2 Type one the following commands:
5. Running My webMethods Server from the Command Line
Purpose Operating system Command
Start the server in the same console
window
Start the server in a new console
window
Creating a New Server Instance
You can run multiple instances of My webMethods Server on the same machine, but each
server instance must have its own external resources. For more information, see
“Guidelines for Multiple My webMethods Server Instances” on page 26.
Use the following command‐line syntax to create an instance of My webMethods Server
on the current machine.
1 If you have not already done so, use the Database Component Configurator to create
a unique database or tablespace for this server instance, as described in the
webMethods Installation Guide.
2 At a command line prompt, type the following command to move to the server’s bin
directory:
cd webMethods_install_dir/MWS/bin
3 Type the following command:
Windows run.bat
UNIX run.sh
Windows startup.bat
UNIX startup.sh
Stop the server Windows shutdown.bat
UNIX shutdown.sh
To create an instance of My webMethods Server from the command line
For Windows: mws.bat new [-Dparameter=value...]
For UNIX: mws.sh new [-Dparameter=value...]
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 46

where parameter is any of the following:
Parameter Description
5. Running My webMethods Server from the Command Line
server.name Name of the server instance. The default server name is
default.
http.port Port number on which the server instance listens. Must be
unique among server instances on the machine. The default
port number is 8585.
db.type The type of database used by the server instance. The choices
are:
ms Microsoft SQL Server
oracle Oracle
db2 DB2
db.url Database connection URL, based on the type of database and
the driver. See the following example.
db.username Username assigned to the My webMethods Server database.
db.password Password of the My webMethods Server database user.
server.features The set of component features configured with the server
instance: The choices are:
core The minimum set of features needed to support
development of JSR 168 portlets using
webMethods Designer.
default The standard set of My webMethods Server
features. This is the default value.
fabric The default My webMethods Server taxonomy
with all installed My webMethods user interfaces.
all All available components
The command creates the instance of My webMethods Server based on the input
parameters you have provided.
4 At the same command prompt, initialize the server instance using this command:
For Windows: mws.bat -servername run
For UNIX: mws.sh -servername run
where servername is the value of the server.name parameter you used in the previous
step. The default server name is default.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 47

Example:
Server name: test
HTTP port: 8090
Database server (SQL Server): db_server
Database name: my_wm_msql
Database user name: mws_user
Database password: password
5. Running My webMethods Server from the Command Line
> mws new -Dserver.name=test -Dhttp.port=8090 -Ddb.type=ms
-Ddb.url=jdbc:wm:sqlserver:db_server:1433;DatabaseName=my_wm_msql;
SelectMethod=direct;MaxPooledStatements=100 -Ddb.username=mws_user
-Ddb.password=password
[Configuration output displayed in console window....]
> mws -s test run
Modifying Server Configuration
You can use the mws new command described in “Creating a New Server Instance” on
page 46 to modify the configuration of an existing server instance. You can make changes
to the following parameters:
mws new parameter Purpose
http.port Change the HTTP port used by My webMethods Server.
db.url
db.username
db.password
Change the location of the database server where the My
webMethods Server database resides. Useful if you need to
move an existing database to a different database server.
server.features Add to the set of component features configured with the server
instance. You can only add component features this way.
Previously configured component features are not removed.
If you leave out a parameter to the mws new command, the default values are used. The
default values are stored in the following files, both of which reside in this location:
webMethods_install_dir/MWS/server/server_instance/config
� cluster.xml—contains the server HTTP port.
� db.xml—contains the URL of the server database, along with the database user name
and password (encrypted).
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 48

Deleting a Server Instance
5. Running My webMethods Server from the Command Line
Important! When you issue this command, there is no confirmation before the delete
operation takes place. Use this command with extreme caution.
To delete an instance of My webMethods Server, do the following:
To delete an instance of My webMethods Server from the command line
1 Stop the My webMethods Server instance.
See “Starting and Stopping My webMethods Server” on page 19 or “Command
Syntax for My webMethods Server” on page 44.
2 At a command line prompt, type the following command to move to the server’s bin
directory:
cd webMethods_install_dir/MWS/bin
3 Type this command:
mws -s server_name delete
where server_name is the name of the server to be deleted.
Example:
> mws -s test delete
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 49

5. Running My webMethods Server from the Command Line
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 50

Part II. My webMethods Administrator Functions
� Managing My webMethods Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
� Searches for Users, Groups, and Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
� Managing Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
� Managing Roles and Access to My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
� My webMethods Server Clustering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 51

II. My webMethods Administrator Functions
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 52

Chapter 6. Managing My webMethods Configuration
� Overview of My webMethods Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
� Managing Directory Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
� Managing External Data Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
� Managing E-Mail Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 53

Overview of My webMethods Configuration
6. Managing My webMethods Configuration
You can perform the following configuration functions as My webMethods Administrator
or as a system administrator (these users are described in “Introduction to My
webMethods Server” on page 18):
This function... Is described here...
Manage internal and external directory
services.
Connect to external data sources (such as
databases) to make them available to My
webMethods Server.
Configure the mail server settings used
by the server when processing E‐mail.
Where there are differences between the My webMethods and system user interfaces, the
procedures describe both.
Managing Directory Services
“Managing Directory Services” on
page 54
“Managing External Data Sources” on
page 66
“Managing E‐Mail Settings” on page 74
Manage My webMethods Server clusters. “My webMethods Server Clustering” on
page 125
A directory is similar to a database in that it contains a collection of entries (in this case,
individuals), each of which has a set of attributes, such as names, E‐mail addresses, and so
forth. A directory service provides a mechanism for delivering information about the
entries in the directory.
My webMethods Server includes an internal directory service. However, if you are using
an external directory (for example, if you are using Lightweight Directory Access Protocol
(LDAP), you can configure My webMethods Server to also access user and group
information from the external directory service.
� Internal directory service. The internal directory service that is provided with My
webMethods Server is called the system directory service. My webMethods Server
stores information about users, groups, and roles that you define in this system
directory service to the My webMethods Server database.
Use the system directory service if you need to maintain only a moderate number of
users and groups. When you install My webMethods Server, the users described in
the following table are automatically defined in the system directory service. For
information about how to define additional users and groups, see “Managing Users
and Groups” on page 83.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 54

User Name Description
My
webMethods
Administrator
6. Managing My webMethods Configuration
The default administrator of My webMethods. This user can
perform user management functions and manage external
directory services. As installed, the user ID is “Administrator ”
and the password is “manage.”
Important! Change the password for this user. For instructions
about how to update information for a user, see “Editing
Information for a User” on page 87.
System Admin The system administrator for My webMethods Server. This user
can manage My webMethods Server, including analysis,
configuration, content, and user management. As installed, the
user ID is “SysAdmin” and the password is “manage.” This
administrator does not use the My webMethods user interface.
For more information about functions available to this account,
see Part III, “System Administrator Functions”.
Important! Change the password for this user. For instructions
about how to update information for a user, see “Editing
Information for a User” on page 87.
Designer The page designer for My webMethods Server. This user has
privileges My webMethods Server similar to those of the system
administrator. As installed, the user ID is “Designer” and the
password is “manage.” For more information about functions
performed by this account, see Part IV, “Page Development”.
Important! Change the password for this user. For instructions
about how to update information for a user, see “Editing
Information for a User” on page 87.
Guest An anonymous user. This user can read pages that allow
anonymous access, such as the login page. Otherwise, this user
cannot read, modify, or delete content unless permission is
explicitly granted by an administrator. As installed, the user ID
for this user is “Guest.”
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 55

User Name Description
webMethods
Cluster
webMethods
System
6. Managing My webMethods Configuration
A user account to remotely invoke commands between cluster
nodes. As installed, the user ID is WEBM_CLUSTERUSER and
the password is “manage.”
Important! Change the password for this user. For instructions
about how to update information for a user, see “Editing
Information for a User” on page 87.
A user account that is used internally by My webMethods
Server to invoke Web services. My webMethods Server uses this
account for Web service authentication from one server to
another. As installed, the user account is WEBM_SYSUSER and
the password is “manage.”
Important! Changes to the password for this account must be
provided to administrators for webMethods applications that
use it when communicating with My webMethods Server.
� External directory services. In addition to the system directory service, My webMethods
Server can support multiple external directory services, allowing you to manage a
much larger and diverse group of users. If your company has one or more directory
services, My webMethods Server can connect to those services. My webMethods
Server supports the following directory services: SunOne Directory Server 5.2, Active
Directory, and ADAM. In addition, you can use a database as a directory service.
Setting Up the Internal System Directory Service
No set up is required for the internal system directory service beyond configuring the My
webMethods Server database. Configuring the database was required during the
installation of My webMethods Server, as described in the webMethods Installation Guide.
Managing External Directory Services
You can perform the following functions for external directory services:
Function... For more information, see...
Identify an external LDAP (SunONE only),
ADSI, or ADAM directory service.
Identify an external database directory
service.
“Configuring an External LDAP,
ADSI, or ADAM Directory Service”
on page 57
“Configuring an External Database
Directory Service” on page 60
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 56

Configuring an External LDAP, ADSI, or ADAM Directory Service
6. Managing My webMethods Configuration
Function... For more information, see...
Allow users defined in an external directory
access to My webMethods.
Update the properties defined for an external
directory service.
Modify the order in which My webMethods
Server searches directory services for
information.
Delete the configuration for a directory service
to stop My webMethods Server from using the
directory service.
Use the following procedure to configure My webMethods Server to use an external
LDAP (SunONE only), ADSI, or ADAM directory service.
To configure an external LDAP, ADSI, or ADAM directory service
1 To navigate to the correct page, do one of the following:
“Allowing Externally Defined Users
Access to My webMethods” on
page 63
“Updating the Configuration for a
Directory Service” on page 64
“Updating the Search Order for
Search Directory Services” on page 65
“Deleting a Directory Service
Configuration” on page 65
� In My webMethods:
Administration > My webMethods > Directory Services > Create New Directory Service.
� As system administrator:
Administration > User Management > Directory Services Administration > Create New
Directory Service.
2 In Directory Type field, click the option that describes the type of directory service:
This option... Configures this type of directory service...
LDAP Lightweight Directory Access Protocol. An internet protocol that
allows client programs to query LDAP directory servers about
entries using their attributes.
ADSI Active Directory Service Interfaces. A set of interfaces for querying
and manipulating objects in Microsoft Active Directory, providing
an LDAP view of the objects. Active Directory is tightly coupled
with the Windows operating system.
ADAM Active Directory Application Mode, a standalone directory server
offered by Microsoft. ADAM is an LDAP implementation that can
be installed and uninstalled without affecting the Active Directory
structure of a network.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 57

3 Click Next.
6. Managing My webMethods Configuration
4 Fill in the appropriate form fields for the directory service you want to add. You
should be prepared to provide the following information:
Section Property Description
General Name A name to identify the external directory
service. My webMethods Server uses this
name when it needs to identify the external
directory service in the user interface.
Description (Optional) A descriptive comment about the
external directory service.
Cache Cache Capacity The number of database queries you want to
cache. The default is 1000.
Cache Timeout The length of time that queries should remain
in the cache unless the cache capacity is
exceeded. The default is 1 hour.
Connection
Information
Service Enabled Specifies whether the service is active.
Settings are:
Connection Error
Threshold
� Yes. This service is enabled (the default)
� No. This service is disabled
The number of connection errors that should
occur before the service is enabled. The
default is 10.
Provider URL The URL for the external directory service
using this syntax:
ldap://host_name:port_number
For example: ldap://my_host:389
Base DN The base distinguished name for the external
directory service. For example,
ou=mywebMethods,o=webmethods.com
Groups DN (Optional) The distinguished name for a
group.
User DN (Optional) The base distinguished name to
find groups or users, which might be a
different location then the distinguished name
specified for Base DN.
Security Principal The distinguished name required to log in to
the external directory service.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 58

Section Property Description
Global
Attributes
Security
Credentials
6. Managing My webMethods Configuration
The password required to log in to the
external directory service.
Failover URLs Other LDAP servers that the system can use in
the event that the primary LDAP server
(identified by Provider URL) fails. If you specify
more than one failover provider URLs,
separate each with a space.
Search Timeout The maximum length of time (in seconds) that
the system allows an LDAP query to run
before the query times out. If you do not want
the query to time out, specify 0. The default is
0.
Object Class The Object Class attribute for the external
directory service.
Last Modified The Last Modified attribute for the external
directory service.
User Attributes User Object Class The User Object Class attribute for the
external directory service.
Group
Attributes
User ID The User ID attribute for the external
directory service.
First Name The First Name attribute for the external
directory service.
Last Name The Last Name attribute for the external
directory service.
Full Name The Full Name attribute for the external
directory service.
E-mail Address The E‐mail Address attribute for the external
directory service.
Password The Password attribute for the external
directory service.
Group Object Class The Group Object Class attribute for the
external directory service.
Group ID The Group ID attribute for the external
directory service.
Group Name The Group Name attribute for the external
directory service.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 59

Section Property Description
Connection
Pool
5 At the bottom of the page, click Finish.
Configuring an External Database Directory Service
6. Managing My webMethods Configuration
Group Members The Group Members attribute for the external
directory service.
Group E-mail The Group E‐mail attribute for the external
directory service.
Minimum
Connections
Maximum
Connections
Maximum
Connection Time
Use the following procedure to configure My webMethods Server to use an external
database directory service.
1 To navigate to the correct page, do one of the following:
The minimum number of connections to the
external directory service that you want kept
open at all times.
The maximum number of connections to the
external directory service that you want open
at any time.
The maximum amount of time you want to
allow an open connection to the external
directory service before the connection is
recycled.
Tip! To test your configuration to ensure you have correctly configured the external
directory service, perform a query to search for users or groups that are defined in the
external directory service. For instructions for how to perform a query, see “Searching for
Existing Users, Groups, or Roles” on page 76.
Note: To use a database directory service, you must first connect to the database as an
external data source. See “Managing External Data Sources” on page 66.
To configure an external database directory service
� In My webMethods:
Administration > My webMethods > Directory Services > Create New Directory Service.
� As system administrator:
Administration > User Management > Directory Services Administration > Create New
Directory Service.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 60

2 In Directory Type field, click Database:
3 Click Next.
6. Managing My webMethods Configuration
4 Fill in the appropriate form fields for the database directory service. You should be
prepared to provide the following information:
Section Property Description
General Name A name to identify the external database
directory service. My webMethods Server
uses this name when it needs to identify the
external database directory service in the user
interface
Description (Optional) A descriptive comment about the
external database directory service.
Attributes User ID The name of the query field containing the
user ID value.
Configuration Authentication
Handler
User DN The name of the query field containing the
distinguished name value for the user.
User First Name The name of the query field containing the
user first name.
User Last Name The name of the query field containing the
user last name.
User Full Name (Optional) The name of the query field
containing the user full name. If you do not
supply an attribute, the full name is derived
from the User First Name and User Last Name
attributes.
User E-mail (Optional) The name of the query field
containing the user E‐mail address.
Group ID The name of the query field containing the
group ID value.
Group DN The name of the query field containing the
distinguished name value for the user.
Group Name The name of the query field containing the
group name.
Group E-mail (Optional) The name of the query field
containing the group E‐mail address.
The page that handles authentication for the
database. By default, My webMethods Server
provides a clear‐text authentication handler.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 61

Section Property Description
5 At the bottom of the page, click Finish.
6. Managing My webMethods Configuration
Database Datasource The database to be used as a data store. For a
database to appear in the list, you must first
use the DataSource Administration page to
connect to the external database. See
“Managing External Data Sources” on
page 66.
Query Lookup User
by ID
A SQL query that returns a user record based
on the user ID.
Important! This query must return all user
attributes, as described under Attributes in this
table.
Query Authenticate A SQL query that returns persisted user
credentials for authentication.
Various queries (Optional) You can define several additional
SQL queries, as needed. Sample language is
provided for each type of query.
Cache Cache Enabled Determines whether My webMethods Server
will attempt to save the load on the database
by using cached data whenever possible.
Select:
� Yes to enable caching
� No to disable caching
Cache Capacity The number of database queries you want to
cache. The default is 1000.
Cache Timeout The length of time that queries should remain
in the cache unless the cache capacity is
exceeded. The default is 1 day.
Tip! To test your configuration to ensure you have correctly configured the external
directory service, perform a query to search for users or groups that are defined in the
external directory service. For instructions for how to perform a query, see “Searching for
Existing Users, Groups, or Roles” on page 76.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 62

Allowing Externally Defined Users Access to My webMethods
6. Managing My webMethods Configuration
By configuring an external directory service, you provide My webMethods Server with
the information it needs to connect to and retrieve information from the external directory
service. However, you need to take the following additional steps to allow users defined
in the external directory service access to My webMethods:
� Create one or more LDAP query roles and/or database roles to identify the users who
should be granted access to My webMethods, described in “Creating a Role to Define
Externally Defined Users You Want to Access My webMethods” next in this chapter.
� Add the roles you have created to the My webMethods Users role, described in
“Adding a Role to the My webMethods Server Users Role” on page 64.
Creating a Role to Define Externally Defined Users You Want to Access My webMethods
For each external directory service that you configure, create one or more roles that
identify the users or groups of users that you want to allow access to My webMethods
Server.
� For an LDAP, ADSI, or ADAM directory service, create an LDAP query role.
� For a database directory service, create a database role.
To create a role to identify users who will be granted access to My webMethods
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Roles > Add Role.
� As system administrator:
Administration > User Management > Manage Roles > Add Role.
2 In the Role Name field, specify the name you want to assign to the new role, for
example, “SystemX‐My webMethods Users”.
3 To specify the type of role you want to create, move it to the Selected Items box:
� LDAP Query Role Provider—LDAP, ADSI, or ADAM directory service
� Database Role Provider—database directory service
4 Click Create Role.
5 Specify the membership for the role. For more information about how to define the
membership:
� For an LDAP, ADSI, or ADAM directory service, see “Adding an LDAP Query
Role” on page 114.
� For a database directory service, see “Adding a Database Role” on page 118.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 63

6 Click Save.
Adding a Role to the My webMethods Server Users Role
6. Managing My webMethods Configuration
To grant those users who are identified by the roles you created access to My
webMethods, add the roles to the My webMethods Server Users role.
To grant users access to My webMethods
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Roles.
� As system administrator:
Administration > User Management > Manage Roles.
2 In the Keyword text box, type My webMethods Users, and click Go.
3 In the search results panel, click Edit for the My webMethods Users role.
4 In the ROLE MEMBERSHIP panel, click Add.
5 For each role you want to make a member of the My webMethods Users role, move
the role name to the Selected Items panel.
6 After you have selected all roles that identify users you want to assign to the My
webMethods Users role, click Select.
7 Click Save to make the membership changes to the My webMethods Users role.
Updating the Configuration for a Directory Service
After you initially configure an external directory service or database directory service,
you might need to update the values you specified for one or more of the properties. Use
the following procedure to update the values of properties associated with a directory
service.
To update the configuration for a directory service
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Directory Services > List Directory Services.
� As system administrator:
Administration > User Management > Directory Services Administration > List New Directory
Services.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 64

2 On the List Directory Services panel, do one of the following:
6. Managing My webMethods Configuration
� Click the name of the directory service configuration you want to modify.
� Click Tools for the directory service configuration and then click Properties.
3 Make your changes to the properties for the directory service.
4 After making your changes, click Apply.
Updating the Search Order for Search Directory Services
Some actions that you can perform using My webMethods Server can result in the system
querying multiple directory services. Use the following procedure to order your directory
services to control the order in which My webMethods Server searches your directory
services.
To update the order in which My webMethods Server searches external directory services
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Directory Services > Modify Directory Search Order.
� As system administrator:
Administration > User Management > Directory Services Administration > Modify Directory
Search Order.
My webMethods Server searches the external directory services in the order they are
listed in the Select list.
2 To reorder the list, move directory services up or down as needed.
3 After you have set the search order, click Apply.
Note: Setting the search order does not affect the order in which My webMethods Server
displays directory services in lists throughout the user interface.
Deleting a Directory Service Configuration
If you no longer want My webMethods Server to have access to users and groups defined
in an external directory service, you can delete the configuration information for that
external directory service using the following procedure.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 65

To delete the configuration for an external directory service
1 To navigate to the correct page, do one of the following:
6. Managing My webMethods Configuration
� In My webMethods:
Administration > My webMethods > Directory Services > List Directory Services.
� As system administrator:
Administration > User Management > Directory Services Administration > List Directory
Services.
2 Click Tools for the directory service configuration and then click Delete.
Managing External Data Sources
On the Data Source Administration page, you can connect to external data sources (such
as databases) and make them available to My webMethods Server. Before you can create
and use a database directory service, for example, you need to configure the data source.
The Data Source Administration page supports connections to Microsoft SQL Server,
Oracle, DB2 Universal, Sybase Adaptive Server, or Informix databases. There are also
options for configuring ODBC and custom connections.
Note: Before you configure a data source for connecting to DB2 Universal, Sybase
Adaptive Server, or Informix databases, you must have a corresponding database driver
for each respective database application. My webMethods Server distribution does not
include database drivers for DB2 Universal, Sybase Adaptive Server, or Informix
databases.
You can connect the following external data sources to My webMethods Server:
External data source... For more information, see...
Microsoft SQL Server “Adding a Microsoft SQL Server Data Source” on
page 67
Oracle “Adding an Oracle Data Source” on page 68
DB2 Universal “Adding a DB2 Universal Data Source” on page 68
Sybase Adaptive Server “Adding a Sybase Adaptive Server Data Source” on
page 69
Informix “Adding an Informix Data Source” on page 70
Generic ODBC “Adding a Generic ODBC Data Source” on page 70
Custom JDBC “Adding a Custom Data Source” on page 71
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 66

6. Managing My webMethods Configuration
You can perform the following additional functions for external data sources:
Function... For more information, see...
Modify the properties of the connection to
the external data source.
Deleting a connection to an external data
source.
Adding a Microsoft SQL Server Data Source
To connect a Microsoft SQL Server data source to My webMethods Server, use the
following procedure:
To add a new data source for Microsoft SQL Server databases
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Data Sources > Add DataSource.
� As system administrator:
Administration > Configuration > DataSource Administration > Add DataSource.
2 Type a unique DataSource Name to be used by My webMethods Server on the View
DataSources panel.
3 Type a Display Name to be used when you identify a data source to use for a database
directory service.
4 Select MS SQL Server from the Server Type list and click Next.
5 Type the SQL Server host name.
6 Type the port number used by the SQL Server. The default port is 1433.
7 Type the database name.
8 Type a valid SQL Server username and password that, at a minimum, has READ
access to the database to which you will connect.
9 Click Submit.
“Modifying a Data Source” on page 72
“Deleting a Data Source” on page 73
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 67

Adding an Oracle Data Source
6. Managing My webMethods Configuration
To connect an Oracle data source to My webMethods Server, use the following procedure:
To add a new data source for Oracle databases
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Data Sources > Add DataSource.
� As system administrator:
Administration > Configuration > DataSource Administration > Add DataSource.
2 Type a unique DataSource Name to be used by My webMethods Server on the View
DataSources panel.
3 Type a Display Name to be used when you identify a data source to use for a database
directory service.
4 Select Oracle from the Server Type list and click Next.
5 Type the Oracle host name.
6 Type the port number on which the Oracle host is running. The default port is 1521.
7 Type the instance name (SID) for the database.
8 Type a valid Oracle database username and password that, at a minimum, has READ
access to the database to which you will connect.
9 Click Submit.
Adding a DB2 Universal Data Source
To connect a DB2 Universal data source to My webMethods Server, use the following
procedure:
To add a new data source for DB2 Universal databases
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Data Sources > Add DataSource.
� As system administrator:
Administration > Configuration > DataSource Administration > Add DataSource.
2 Type a unique DataSource Name to be used by My webMethods Server on the View
DataSources panel.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 68

6. Managing My webMethods Configuration
3 Type a Display Name to be used when you identify a data source to use for a database
directory service.
4 Select DB2 Universal from the Server Type list and click Next.
5 Type the DB2 host name.
6 Type the port number that DB2 is running on.
7 Type the instance name for the database.
8 Type a valid DB2 username and password that, at a minimum, has READ access to the
database to which you are connecting.
9 Click Submit.
Adding a Sybase Adaptive Server Data Source
To connect a Sybase Adaptive Server data source to My webMethods Server, use the
following procedure:
To add a new data source for Sybase Adaptive Server databases
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Data Sources > Add DataSource.
� As system administrator:
Administration > Configuration > DataSource Administration > Add DataSource.
2 Type a unique DataSource Name to be used by My webMethods Server on the View
DataSources panel.
3 Type a Display Name to be used when you identify a data source to use for a database
directory service.
4 Select Sybase Adaptive Server from the Server Type list and click Next.
5 Type the Sybase Server host name.
6 Type the port number that Sybase Server is running on.
7 Type the instance name for the database.
8 Type a valid Sybase Server username and password that, at a minimum, has READ
access to the database to which you are connecting.
9 Click Submit.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 69

Adding an Informix Data Source
6. Managing My webMethods Configuration
To connect a Informix data source to My webMethods Server, use the following
procedure:
To add a new data source for Informix databases
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Data Sources > Add DataSource.
� As system administrator:
Administration > Configuration > DataSource Administration > Add DataSource.
2 Type a unique DataSource Name to be used by My webMethods Server on the View
DataSources panel.
3 Type a Display Name to be used when you identify a data source to use for a database
directory service.
4 Select Informix from the Server Type list and click Next.
5 Type the Informix host name.
6 Type the port number on which the Informix host is running.
7 Type the database name.
8 Type the Informix server name.
9 Type a valid Informix username and password that, at a minimum, has READ access
to the database to which you are connecting.
10 Click Submit.
Adding a Generic ODBC Data Source
Note: My webMethods Server can use any ODBC connection that is manually configured
at the operating system level (such as Windows Server). My webMethods Server uses a
standard Java JDBC‐ODBC bridge driver to connect to the ODBC data sources on the
underlying operating system. Consult you Microsoft vendor documentation for details on
how to configure an ODBC data source at the operating system level.
To connect a generic ODBC data source to My webMethods Server, use the following
procedure:
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 70

To add a new data source for generic ODBC databases
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Data Sources > Add DataSource.
6. Managing My webMethods Configuration
� As system administrator:
Administration > Configuration > DataSource Administration > Add DataSource.
2 Type a unique DataSource Name to be used by My webMethods Server on the View
DataSources panel.
3 Type a Display Name to be used when you identify a data source to use for a database
directory service.
4 Select Generic ODBC from the Server Type list and click Next.
5 Type the ODBC data source name that matches the ODBC data source configured at
the operating system level.
6 Type a valid username and password that, at a minimum, has READ access to the
database to which you are connecting.
7 Click Submit.
Adding a Custom Data Source
Note: This option is an advanced data source configuration and requires you to specify a
valid JDBC driver class name, connection URL, username, and password. Consult your
vendor documentation to get specific instructions on where to locate the proper database
drivers for the database application that you wish to connect to from the server.
To connect a custom data source to My webMethods Server, use the following procedure:
To add a new data source for a custom database
1 Before creating a customized data source, you must ensure that you have appropriate
drivers available to the server. To make these drivers available to the server, copy the
driver *.jar files into your webMethods_install_dir/server/default/lib
directory.
2 With the drivers in place, restart your My webMethods Server instance.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 71

3 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Data Sources > Add DataSource.
6. Managing My webMethods Configuration
� As system administrator:
Administration > Configuration > DataSource Administration > Add DataSource.
4 Type a unique DataSource Name to be used by My webMethods Server on the View
DataSources panel.
5 Type a Display Name to be used when you identify a data source to use for a database
directory service.
6 Select Custom JDBC from the Server Type list and click Next.
7 Type the JDBC Connection class for the custom drivers you want to use for the data
source connection.
8 Type a valid connection URL.
9 Type a valid username and password that, at a minimum, has READ access to the
database to which you are connecting.
10 Click Submit.
Modifying a Data Source
Note: You cannot modify the default data source, which is the My webMethods Server
database.
To modify a data source connection to My webMethods Server, use the following
procedure:
To modify an existing data source
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Data Sources > View DataSources.
� As system administrator:
Administration > Configuration > DataSource Administration > View DataSources.
2 Click Tools for the data source you want to modify, and then click Modify.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 72

6. Managing My webMethods Configuration
3 In the first page of the Datasource Properties wizard, modify one or more of these
fields:
In this field... Do this...
Datasource Name Type a different unique data source name to be used by
My webMethods Server on the View DataSources panel.
Display Name Type a different display name for the data source to be
used when you identify a data source to use for a database
directory service.
Server Type From the list, select a different database type.
4 Click Next.
5 In the second page of the Datasource Properties wizard, modify one or more of the
fields identify the location, names, and passwords for the data source.
6 Click Submit.
Deleting a Data Source
Note: You cannot delete the default data source, which is the My webMethods Server
database.
To delete a data source connection to My webMethods Server, use the following
procedure:
To delete a data source
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Data Sources > View DataSources.
� As system administrator:
Administration > Configuration > DataSource Administration > View DataSources.
2 Click Tools for the data source you want to modify, and then click Remove.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 73

Managing E-Mail Settings
6. Managing My webMethods Configuration
The Email Administration page is used to configure the mail server settings used by the
server when processing E‐mail.
To configure an E-mail server to send server notifications
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > E-Mail Servers
� As system administrator:
Administration > Configuration > E-mail Administration.
2 Type the SMTP Host Address for the E‐mail server you want to use as the mail server to
send server notifications. For example: smtp.server.com
3 Type the SMTP Server Port. For example: 25
4 Configure the default sender E‐mail address by entering the E‐mail address in the
From field.
Note: The Sender Address is the reply‐to E‐mail address that is attached to outgoing E‐
mail server notifications.
5 Select the skin that will be used to format the server notifications to be delivered by E‐
mail.
6 Click Save Settings.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 74

Chapter 7. Searches for Users, Groups, and Roles
� Searching for Existing Users, Groups, or Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
� Advanced Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
� Using Saving Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
� Exporting Search Results to a .csv File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 75

Searching for Existing Users, Groups, or Roles
You can search for the following:
� Users and groups defined in the internal system directory service
� Users and groups defined in external directory services
� Roles
To search for users, groups, or roles
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > User_type > Search.
� As system administrator:
Administration > User Management > Manage User_type > Search.
where User_type is Users, Groups, or Roles.
7. Searches for Users, Groups, and Roles
2 For users and groups, from the Directory Service list select the directory service where
the users or groups are defined.
If you select Any Directory, all directory services connected to the server are searched.
3 In the Keyword field of the Search panel, do one of the following:
For... Type any of these search criteria...
Users First name
Last name
E‐mail address
User ID
Groups Group name
Group ID
Group E‐mail address
Roles Role name
Role ID
The search is not case sensitive. If you leave the text box blank, My webMethods
Server returns information for all entries in the selected directory service.
For more information about searching, see Getting Started with My webMethods.
4 Click Go.
My webMethods Server displays the results in a table format.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 76

Advanced Searches
7. Searches for Users, Groups, and Roles
For information on exporting the results of a search, see “Exporting Search Results to
a.csv File” on page 81.
As a system administrator, you can perform an advanced search for users or groups,
based on user or group information and extended attributes.
To perform an advanced search for users, groups, or roles
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > User_type > Search.
� As system administrator:
Administration > User Management > Manage User_type > Search.
where User_type is Users, Groups, or Roles.
2 For users or groups, from the Directory Service list select the directory service where the
users or groups are defined.
If you select Any Directory, all directory services connected to the server are searched.
3 For users, in the Core Attributes panel, fill in any of the following fields that are part of
User Information:
In this field... Do this...
First Name Type a first name for the saved search.
Last Name Type a last name for the saved search.
User ID Type a user ID for the saved search.
E-mail Address Type a user E‐mail address for the saved search.
4 For groups, in the Core Attributes panel fill in any of the following fields that are part of
Group Information:
In this field... Do this...
Group Name Type a group name for the saved search.
Group ID Type a group ID for the saved search.
E-mail Address Type a group E‐mail address for the saved search.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 77

7. Searches for Users, Groups, and Roles
5 In the Extended Attributes panel, choose an extended attribute by doing the following:
a From the Attribute Provider list, choose an attribute provider.
For more information on attribute providers, see “Attribute Providers” on
page 137.
b In the Attribute Value field, type or modify the value to be used in the saved search.
6 Click Go.
Using Saving Searches
My webMethods Server displays the results in a table format.
For information on exporting the results of a search, see “Exporting Search Results to
a.csv File” on page 81.
If there is a search you perform regularly, you can save search criteria that you can reuse.
The following sections describe some actions you can perform with saved searches:
This action... Is described here...
Create a new saved search “Creating a Saved Search” on page 78
Use a saved search “Using a Saved Search” on page 79
Modify a saved search “Modifying a Saved Search” on page 79
Delete a delete a saved search “Deleting a Saved Search” on page 81
Creating a Saved Search
To create a saved search for a user, group, or role, follow these steps:
To create a saved search
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > User_type > Search.
� As system administrator:
Administration > User Management > Manage User_type > Search.
where User_type is Users, Groups, or Roles.
2 For users and groups, in the Directory Service list choose the directory service that
contains the users you want to find.
If you select Any Directory, all directory services connected to the server are searched.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 78

3 In the search field of the Search panel, do one of the following:
For... Type this to be used as search criteria...
Users The complete or partial user ID
Groups The complete or partial group ID
Roles The complete or partial role name
4 Click Save.
7. Searches for Users, Groups, and Roles
5 In the Search Name field of the Save Searches dialog box, type a name by which you
can identify the search criteria and click OK.
Using a Saved Search
You can use a saved search to find users, groups, or roles that match the criteria.
To perform a saved search
1 To navigate to the correct page, do one of the following:
� In My webMethods:
User Administration > User_type > Saved.
� As system administrator:
Administration > User Management > Manage User_type > Saved.
where User_type is Users, Groups, or Roles.
2 In the Saved Search list, choose the name of the saved search and click Go.
Modifying a Saved Search
You can modify an existing saved search.
To modify a saved search
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > User_type > Saved.
� As system administrator:
Administration > User Management > Manage User_type > Saved.
where User_type is Users, Groups, or Roles.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 79

7. Searches for Users, Groups, and Roles
2 In the Saved Search list, choose the name of the saved search to be modified and click
Details.
3 Do any of the following:
� In the search field of the Saved panel, change the search criteria.
� For users and groups, in the Directory Service list change the directory service in
which to perform the search.
� For users, in the Core Attributes panel modify any of the following fields that are
part of the User Information panel described in “User Information” on page 88:
In this field... Do this...
First Name Add, modify, or remove a first name for the saved search.
Last Name Add, modify, or remove a last name for the saved search.
User ID Add, modify, or remove a user ID for the saved search.
E-mail Address Add, modify, or remove an E‐mail address for the saved
search.
� For groups, in the Core Attributes panel modify any of the following fields that are
part of the Group Information panel described in “Group Information” on page 98:
In this field... Do this...
Group Name Add, modify, or remove a group name for the saved
search.
Group ID Add, modify, or remove a group ID for the saved search.
E-mail Address Add, modify, or remove a group E‐mail address for the
saved search.
� In the Extended Attributes panel, choose an extended attribute by doing the
following:
1 From the Attribute Provider list, choose an attribute provider.
For more information on attribute providers, see “Attribute Providers” on
page 137.
2 In the Attribute Value field, type or modify the value to be used in the saved
search.
4 To update the saved search, click Save.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 80

Deleting a Saved Search
When you no longer need a saved search, you can delete it.
To delete a saved search
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > User_type > Saved.
� As system administrator:
Administration > User Management > Manage User_type > Saved.
where User_type is Users, Groups, or Roles.
7. Searches for Users, Groups, and Roles
2 In the Saved Search list, choose the name of the saved search to be deleted and click
Delete.
Exporting Search Results to a .csv File
You can export search results to a comma‐delimited text file (.csv file) if the search results
panel includes the Export Table function.
After exporting search results to a .csv file, you can then import the .csv file into Microsoft
Excel, Microsoft Access, or any other application that accepts the .csv file format.
To export search results
1 In the search results panel, click Export Table.
2 From the Character Encoding list, select the character encoding to use.
3 Click Export.
4 Use the file‐download mechanism in your browser to browse to the location where
you want to save the .csv file.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 81

7. Searches for Users, Groups, and Roles
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 82

Chapter 8. Managing Users and Groups
� Overview of Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
� Managing Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
� Managing Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
� Managing Authentication Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 83

Overview of Users and Groups
8. Managing Users and Groups
You can manage users and groups as My webMethods Administrator or as a system
administrator (or as a user with administrator privileges, as described in “Overview of
Roles” on page 110). Where there are differences between the My webMethods and
system user interfaces, the procedures describe both.
Users
To access My webMethods, the system must have access to a definition for the user. To
define users, you can:
� Add users to the internal system directory service. You provide all information about the
user, for example the user ID the user is to supply to log into the system and the user’s
password. The following sections in this chapter describe how to manage users in the
internal system directory:
� “Adding Users” on page 86
� “Searching for Existing Users, Groups, or Roles” on page 76
� “Editing Information for a User” on page 87
� “Assigning a User to a Group” on page 94
� “Deleting a User” on page 94
� Access users already defined in external directory services. If your users are defined in one
or more external directory services, you can configure My webMethods Server to use
the external directory services. As a result, those users can access and use My
webMethods. For more information, see “Managing External Directory Services” on
page 56.
Note: With My webMethods Server, you can use a combination of users that are defined in
both the internal system directory service and external directory services.
Groups
You can logically organize collections of users into groups, which allows you to identify a
group of users by a group name rather than identifying each user individually. For
example, if you want to assign a group of users to a role, you can simply assign the group
containing the users to the role, rather than identifying each user individually.
To define a group, you can:
� Add groups to the internal system directory service. You provide information about the
group and define its membership. You can assign both individual users or other
groups to be a members. The users and groups that you assign to a group that is
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 84

Managing Users
8. Managing Users and Groups
defined in the internal system directory service must also be defined in the internal
system directory service. That is, you cannot assign users or groups that are defined in
an external directory service to an internally‐defined group. The following sections in
this chapter describe how to manage groups in the internal system directory:
� “Adding Groups” on page 96
� “Searching for Existing Users, Groups, or Roles” on page 76
� “Editing Group Information” on page 97
� “Managing Members of a Group” on page 99
� “Making a Group a Member of Another Group” on page 100
� “Deleting Groups” on page 101
� Access groups already defined in external directory services. If you want to use groups that
are defined in one or more external directory services, you can configure My
webMethods Server to use the external directory services. For more information, see
“Managing External Directory Services” on page 56.
Note: With My webMethods Server, you can use a combination of groups that are defined
in both the internal system directory service and external directory services.
The following table lists the functions you can perform for users based on whether they
are defined in the internal system directory service or an external directory service, and
where in this guide you can find more information about how to perform the function:
Where the user is
defined Function For more information, see...
Internal system
directory service
External directory
service
Add users “Adding Users” on page 86
Edit user information “Editing Information for a
User” on page 87
Assign users to groups “Assigning a User to a Group”
on page 94
Delete users “Deleting a User” on page 94
Allow users defined in an
external directory service
access to My webMethods
“Allowing Externally Defined
Users Access to My
webMethods” on page 63
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 85

Adding Users
8. Managing Users and Groups
Where the user is
defined Function For more information, see...
Either:
� Internal system
directory service
� External
directory service
Before a user can access and use My webMethods, you must either add the user to the
internal system directory service or configure My webMethods Server to use the external
directory service where the user is defined. For more information about configuring an
external directory service, see “Managing External Directory Services” on page 56. The
following procedure describes how to add a user to the internal system directory service.
To add a user
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Users > Add User.
Search for users “Searching for Existing Users,
Groups, or Roles” on page 76
Assign a user to a role “Creating Roles” on page 112
Assign user‐specific values for
dynamic attributes that are
associated with a role
Allow users access to view
functions
Allow users the ability to take
action within a function
� As system administrator:
Administration > User Management > Manage Users > Add User.
“Setting User‐Specific Values
for Dynamic Attributes” on
page 122
“Managing User Functions” on
page 123
“Managing User Actions
Within Functions” on page 124
Locate a user’s home folder. “Locating a User’s Home
Folder (System Administrator
Only)” on page 95
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 86

8. Managing Users and Groups
2 Fill in the following fields for the user you want to add to the internal system
directory service:
In this field... Specify...
User ID The user ID that you want to assign to the user you are adding.
My webMethods Server uses the user ID when forming the
distinguished name (DN) for the user.
3 Click Create.
Editing Information for a User
The user ID can be 1 through 255 characters and can contain
only alphanumeric ASCII characters with no spaces. The user
ID is not case sensitive.
Note: My webMethods Server adds the user ID to the internal
system directory service using the case you specify. My
webMethods Server typically regards user IDs as
case‐insensitive; however, My webMethods Server uses the
case you specify for actions that are case‐sensitive, for
example, HTTP authentication.
Password The password for the new user.
Confirm Password The same password you specified in the Password field.
First Name The first name of the user you are adding. My webMethods
Server uses the user’s first and last name when displaying the
user’s name on pages in the user interface.
Last Name The last name of the user you are adding.
E-mail Address (Optional) The E‐mail address for the user you are adding. My
webMethods Server uses the e‐mail address when it needs to
send a notification to the user by means of an E‐mail message.
You can edit the information for a user defined in the internal system directory service. If
a user is defined in an external directory service, you can edit only My webMethods
Server‐specific information. You must update the external directory service directory to
change settings that My webMethods Server obtains from the external directory. For a list
of the fields that My webMethods Server maintains for a user, see “User Information” on
page 88.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 87

To edit a user
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Users.
� As system administrator:
Administration > User Management > Manage Users.
8. Managing Users and Groups
2 Search for the user you want to edit. For more information, see “Searching for
Existing Users, Groups, or Roles” on page 76.
3 In the search results, click any link in the row of the user you want to edit or click
Edit.
4 Make the changes you want to the user’s information and click Save (Apply in system
administration).
For a description of all the fields on each panel, including whether you can update a
field or whether a field is view‐only, see“User Information” below.
Important! My webMethods Server displays the information grouped on various
panels. After making changes to information on a single panel, be sure to click Save
(Apply in system administration) to save your changes before selecting another panel.
User Information
The following table lists the information that My webMethods Server maintains for a user.
In the table, the Panel column identifies the panel on the Edit User page where the field is
maintained.
Panel Description
User
Information
Attributes that you specify when you add a user to the internal system
directory service. This panel is not editable for users in an external
directory service.
This panel is part of the user’s profile, and users can update some of the
fields; that is users can update the password and E‐mail address.
Fields on the User
Information panel Description
User ID The user ID that a user supplies to log into My
webMethods. The user ID is defined when the
user is added and cannot be changed.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 88

Panel Description
8. Managing Users and Groups
Password The password the user must supply to log into
My webMethods. My webMethods Server
masks this field when it is displayed in the
user interface.
If you want to change the user’s password,
update the Password and Confirm Password
fields.
Confirm Password The same as the Password field.
First Name The first name of the user.
Last Name The last name of the user.
E-mail Address An optional E‐mail address for the user that
My webMethods Server can use when it needs
to send a notification to the user via an e‐mail
message.
Distinguished Name (DN) The distinguished name for the user. You
cannot update this field. My webMethods
Server forms this field using information
defined for the user.
User Profile Attributes that My webMethods Server maintains regardless of the
directory service the user is a member of.
Note: Values in this panel that relate to a locale, and which display as
Default, do not represent the user’s default locale. Rather, they represent
a null value.
Fields on the User Profile
panel Description
First Name The first name of the user from the User
Information panel. You cannot edit this field on
the User Profile panel. To change the first name,
edit the value on the User Information panel.
Last Name The last name of the user from the User
Information panel. You cannot edit this field on
the User Profile panel. To change the first name,
edit the value on the User Information panel.
Middle Name The user’s middle name.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 89

Panel Description
8. Managing Users and Groups
Title The user’s title, for example, Mr., Mrs., or Ms.
If the title you want to use does not appear in
the list, select Other. My webMethods Server
prompts you for the title you want to use.
Name Suffix The suffix that should appear after the user’s
name, if any, for example, Jr., Sr., PhD, III. If
the suffix you want to use does not appear in
the list, select Other. My webMethods Server
prompts you for the suffix you want to use.
Preferred
The user’s language and locale.
Language/Locale
Country/Region ID The country where the user is located.
Address 1
Address 2
The street address for the user.
City The city where the user is located.
State/Province The state or province where the user is
located.
Postal Code The postal code for the user, for example, a
ZIP Code if the user is located in the United
States.
Custom Address (Optional) Additional information that is
needed when more than a postal code is
required for the user’s address, for example,
special instructions.
Phone 1 Area Code The user’s area code.
Phone 1 Number The user’s phone number.
Phone 1 Extension The extension at which the user can be
reached, if any.
Phone 1 Country Code The country code associated with the user’s
phone number.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 90

Panel Description
Groups Groups to which the user belongs.
Fields on the Groups
panel Description
8. Managing Users and Groups
Location Identifies where My webMethods Server
obtains the items it displays in the left panel of
Group Membership field.
Group Membership The left panel lists the items available to select.
Selected Items The right panel, Selected Items, lists the groups
to which the user is assigned, if any.
Search You can use the Search field to help you search
for and quickly locate an item in the Group
Membership left panel. This is useful when the
left panel contains more items than will
display on a single page.
Roles Roles to which a user is assigned and the dynamic attributes associated
with each role. For more information about:
� Assigning a user to a role, see “Creating Roles” on page 112
� Defining dynamic attributes and setting their values, see “Defining
Dynamic Attributes Associated with a Role” on page 121.
Note: If a user is assigned to dynamic roles, the list of roles might not
always be completely accurate. My webMethods Server determines the
roles to which a user belongs when a user logs into the system. If a
characteristic of a user changes that would make the user ineligible to be
a member of the role, the system will continue to consider the user a
member of the role until the next login when the system determines the
user’s roles for the session.
Fields on the Roles panel Description
Role Precedence A list of roles to which the user is assigned.
The roles are listed in precedence order.
To reorder the roles, move them up or down
as needed.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 91

Panel Description
8. Managing Users and Groups
Role Member Attributes A list of dynamic attributes associated with
the selected role. Dynamic attributes provide
more information about a role. For example, if
there is a “Customer Service” role, you might
add a “Location” attribute to identify where
the user assigned to the “Customer Service”
role is located. For each attribute, the
following information is listed:
� Attribute, which is the display name
specified when the attribute is added to
the role.
� Data Type, which is the data type of the
attribute.
� Role Value, which is the default value for
the attribute. All users are assigned this
value unless specifically overridden by a
user‐specific value. For more information
about setting the default value, see
“Defining Dynamic Attributes Associated
with a Role” on page 121.
� User Value which the user‐specific value for
the attribute. For more information about
setting a user‐specific value, see “Setting
User‐Specific Values for Dynamic
Attributes” on page 122.
Notifications Notification methods that My webMethods Server can use to notify the
user, for example when My webMethods Server is to notify a user when
a rule is violated.
This panel is part of the user’s profile, and users can update these fields
from their profiles.
Fields on the
Notifications panel Description
E-mail Address Specify an E‐mail address on the User
Information panel. My webMethods Server can
use the E‐mail address when sending a
notification to the user. You cannot edit this
field on the Notifications panel. To change the
first name, edit the value on the User
Information panel.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 92

Panel Description
User
Preferences
LDAP
Attributes
Database
Attributes
8. Managing Users and Groups
Pager Text Address The page text address that My webMethods
Server can use when sending a notification to
the user.
Mobile Phone Text
Address
The mobile phone address that My
webMethods Server can use when sending a
notification to the user.
Text Encoding The type of text encoding My webMethods
Server is to use with the corresponding
notification method.
User preferences for the display of information in My webMethods.
This panel is part of the user’s profile, and as a result, users can update
these fields from their profiles. For more information, see Getting Started
with My webMethods.
Fields on the User
Preferences panel Description
Items Per Page The number of items to display on one page
when My webMethods Server displays items
in a table for this user. If the number of items
to display exceeds the number you specify for
Items Per Page, the user can navigate to
subsequent pages to view the remaining
items.
Home Page Template The template to use to display information on
the My webMethods Home page. For more
information about the selections, see Getting
Started with My webMethods.
If the user is defined in an external directory service, this panel lists a set
of attributes from the external directory service. The fields on this panel
are based on the external directory service. LDAP attributes must be set
by the system administrator. See “Exposing LDAP Attributes from an
External Directory Service” on page 141.
If the user is defined in an external database directory service, this panel
lists a set of attributes from the external database directory service. The
fields on this panel are based on the external database directory service.
Database attributes must be set by the system administrator; see
“Exposing Database Attributes from an External Directory Service” on
page 142.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 93

Assigning a User to a Group
8. Managing Users and Groups
You can assign users that you have defined in the internal system directory service to
groups that you have also defined in the internal system directory service. For
information on creating groups, see “Adding Groups” on page 96.
Note: You cannot assign users that are defined in an external directory service to a group
defined in the internal system directory. Similarly, you cannot assign users defined in the
internal system directory service to an externally‐defined group. You can, however, assign
both internal and external users to a role. See “Managing Roles and Access to My
webMethods” on page 109.
To assign a user in the system directory service to a group in the system directory service
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Users.
� As system administrator:
Administration > User Management > Manage Users.
2 Search for the user that you want to assign to a group. For more information, see
“Searching for Existing Users, Groups, or Roles” on page 76. Be sure to select system
from the Directory Service list.
3 In the search results, click any link in the row of the user you want to edit or click
Edit.
4 Click Groups.
5 For each group to which the user should be a member, move it to the Selected Items
box.
6 With all groups in the Selected Items box, click Save (Apply in system administration).
Deleting a User
You can remove users that you have previously defined in the internal system directory
service.
To delete users from the internal system directory service
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Users.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 94

� As system administrator:
Administration > User Management > Manage Users.
8. Managing Users and Groups
2 Search for the users that you want to delete. For more information, see “Searching for
Existing Users, Groups, or Roles” on page 76. Be sure to select system from the
Directory Service list.
3 In the search results, select the check boxes beside the user IDs for the users you want
to delete, and click Delete.
Locating a User’s Home Folder (System Administrator Only)
A system administrator can locate and browse to a userʹs personal folders. Use this feature
if items become unavailable to the user because of permissions changes, or to remove
content when a user is no longer actively using the server.
1 As system administrator:
Administration > User Management > Locate a User's Home Folder.
2 Click Browse.
Managing Groups
To locate a user’s Home folder
3 To select a user, move that user to the Selected Items box and click Select.
4 To open the home folder for the user you selected, click Apply.
The following table lists the functions you can perform for groups based on whether they
are defined in the internal system directory service or an external directory service, and
where in this guide you can find more information about how to perform the function:
Where the group is
defined Function For more information, see...
Internal system
directory service
Add groups “Adding Groups” on page 96
Edit group information “Editing Group Information”
on page 97
Define the membership for a
group
Make a group a member of
another group
“Managing Members of a
Group” on page 99
“Making a Group a Member of
Another Group” on page 100
Delete groups “Deleting a User” on page 94
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 95

Adding Groups
8. Managing Users and Groups
Where the group is
defined Function For more information, see...
External directory
service
Either:
� Internal system
directory service
� External
directory service
Allow My webMethods Server
to use groups defined in an
external directory service
You can define groups of users in the internal system directory service. To do so, first
create the group. After the group is created, you can add members to the group.
To create a group
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Groups > Add Group.
� As system administrator:
Administration > User Management > Manage Groups > Add Group.
“Allowing Externally Defined
Users Access to My
webMethods” on page 63
Search for groups “Searching for Existing Users,
Groups, or Roles” on page 76
Assign a group to a role “Creating Roles” on page 112
Allowing groups of users
access to view My
webMethods functions
Allowing groups of user the
ability to take action within a
function.
“Managing User Functions” on
page 123
“Managing User Actions
Within Functions” on page 124
2 Fill in the following fields for the group you want to add to the internal system
directory service:
In this field... Specify...
Group ID An ID for the group. My webMethods Server uses this ID in
the distinguished name (DN) for the group.
The group ID can be 1 through 255 characters and can contain
only alphanumeric ASCII characters with no spaces. The user
ID is not case sensitive.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 96

In this field... Specify...
3 Click Create.
Editing Group Information
8. Managing Users and Groups
Group Name The name that you want to assign to the group you are adding.
The group ID can be 1 through 255 characters.
E-mail Address (Optional) The E‐mail address for the group you are adding.
You can edit the information for a group defined in the internal system directory service.
If a group is defined in an external directory service, you must update the external
directory service directory to change settings that My webMethods Server obtains from
the external directory. For a list of the fields that My webMethods Server maintains for a
group, see “Group Information” on page 98.
To edit a group
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Groups.
� As system administrator:
Administration > User Management > Manage Groups.
2 Search for the group you want to edit. For more information, see “Searching for
Existing Users, Groups, or Roles” on page 76.
3 In the search results, click any link in the row of the group you want to edit or click
Edit.
4 Make the changes you want to the group information and click Save (Apply in system
administration).
For a description of all the fields on each panel, including whether you can update a
field or whether a field is view‐only, see“Group Information” below.
Important! My webMethods Server displays the information grouped on various
panels. After making changes to information on a single panel, be sure to click Save
(Apply in system administration) to save your changes before selecting another panel.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 97

Group Information
8. Managing Users and Groups
The following table lists the information that My webMethods Server maintains for a
group. In the table, the Panel column identifies the panel on the Edit Group page where
the field is maintained.
Panel Description
Group
Information
Attributes that you specify when you add a group.
Fields on the Group
Information panel Description
Group ID The group ID assigned to a group. The group ID
is defined when the group is added and cannot
be changed.
Group Name The group name for the group.
E-mail Address The E‐mail address for the group.
Distinguished Name (DN) The distinguished name for the group. You
cannot update this field. My webMethods
Server forms this field using information
defined for the group.
Groups Groups to which the current group belongs.
Fields on the Groups
panel Description
Location Identifies where My webMethods Server
obtains the items it displays in the left panel of
Group Membership field.
Group Membership The left panel lists the items available to select.
Selected Items The right panel, Selected Items, lists the groups to
which the group is assigned, if any.
Search You can use the Search field to help you search
for and quickly locate an item in the Group
Membership left panel. This is useful when the
left panel contains more items than will display
on a single page.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 98

Panel Description
Group
Members
LDAP
Attributes
Database
Attributes
Managing Members of a Group
8. Managing Users and Groups
The members that are assigned to this group. The members can be users
and other groups.
Fields on the Group
Members panel Description
Location Identifies where My webMethods Server
obtains the items it displays in the left panel of
Group Members field.
Group Members The left panel lists the items available to select.
Selected Items The right panel, Selected Items, lists the users and
groups that are members of the group.
Search You can use the Search field to help you search
for and quickly locate an item in the Group
Members left panel. This is useful when the left
panel contains more items than will display on a
single page.
If the group is defined in an external directory service, this panel lists a
set of attributes from the external directory service. The fields on this
panel are based on the external directory service. LDAP attributes must
be set by the system administrator. See “Exposing LDAP Attributes from
an External Directory Service” on page 141.
If the user is defined in an external database directory service, this panel
lists a set of attributes from the external database directory service. The
fields on this panel are based on the external database directory service.
Database attributes must be set by the system administrator; see
“Exposing Database Attributes from an External Directory Service” on
page 142.
Members of a group can be users or other groups. You can add members to a group
defined in the internal system directory service if they are also defined in the same
directory service.
Note: To work with users and groups defined in external directory services, use the
mechanisms provided by the external directory services.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 99

To manage members in a group defined in the internal system service directory
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Groups.
� As system administrator:
Administration > User Management > Manage Groups.
8. Managing Users and Groups
2 Search for the group you want to edit. For more information, see “Searching for
Existing Users, Groups, or Roles” on page 76.
3 In the search results, click any link in the row of the group you want to edit or click
Edit.
4 Click Group Members.
5 To manage the members of the group, do any of the following:
� To add users (in the system directory service) to the group, move them to the
Selected Items box.
� To remove users from the group, move them from the Selected Items box.
� To add groups (in the system directory service) to the group, move them to the
Selected Items box.
� To remove groups from the group, move them from the Selected Items box.
6 When the Selected Items box lists all the members you want in the group, click Save
(Apply in system administration).
Making a Group a Member of Another Group
You can make a group a member of another group as long as both groups are defined in
the internal system directory service. When one group becomes a member of a second
group, all members of the first group also become members of the second group.
Note: You cannot assign groups that are defined in an external directory service to a group
defined in the internal system directory. Similarly, you cannot assign groups defined in
the internal system directory service to an externally‐defined group. You can, however,
assign both internal and external groups to a role. See “Managing Roles and Access to My
webMethods” on page 109.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 100

To make a group a member of another group
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Groups.
� As system administrator:
Administration > User Management > Manage Groups.
8. Managing Users and Groups
2 Search for the group you want to edit. For more information, see “Searching for
Existing Users, Groups, or Roles” on page 76.
3 In the search results, click any link in the row of the group you want to edit or click
Edit.
4 Click Groups.
5 To manage the membership of the group in other groups, do either of the following:
� To make the current group a member of other groups (in the system directory
service), move the parent groups to the Selected Items box.
� To remove the current group as a member of other groups, move the parent
groups from the Selected Items box.
6 When the Selected Items box lists all the groups of which the current group should be a
member, click Save (Apply in system administration).
Deleting Groups
You can remove groups that you have previously defined in the internal system directory
service.
Note: When you delete a group, the definition for the group is removed, but the individual
members of the deleted group (users and/or other groups) are not deleted.
To delete groups from the internal system directory service
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Groups.
� As system administrator:
Administration > User Management > Manage Groups.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 101

8. Managing Users and Groups
2 Search for the groups you want to delete. For more information, see “Searching for
Existing Users, Groups, or Roles” on page 76. Be sure to select system from the
Directory Service list.
3 In the search results, select the check boxes beside the names for the groups you want
to delete, and click Delete.
Managing Authentication Certificates
As My webMethods Administrator you can manage authentication certificates for users
who connect to Integration Server or other webMethods components. Authentication
certificates do not govern a connection between a user and My webMethods Server. To be
assigned a certificate, the user must be a member of the system directory service or an
external directory service connected to My webMethods Server (see “Managing Directory
Services” on page 54).
The assignment of users to authenticates follows these rules:
� A user can be assigned to multiple certificates.
� An instance of a certificate can have only one user assigned to it, but you can add
multiple instances of a certificate, each with a different certificate type, and assign a
different user to each instance.
You can perform the following actions with Certificates:
Function For more information see...
Add a certificate “Adding an Authentication Certificate” on page 103
Search for a certificate “Searching for Authentication Certificates” on
page 103
View details of a certificate “Viewing Details of an Authentication Certificate” on
page 105
Assign a user to a certificate “Assigning a User to an Authentication Certificate” on
page 105
Change users for a certificate “Changing Users for an Authentication Certificate” on
page 106
Delete a certificate “Deleting an Authentication Certificate” on page 107
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 102

Adding an Authentication Certificate
To add a certificate, do the following:
To add an authentication certificate
1 To navigate to the correct page in My webMethods:
Administration > System-Wide > User Management > Certificates.
2 Click Add New Certificate.
8. Managing Users and Groups
3 Click Browse, navigate to the location of the certificate file you want to add, and click
Open.
4 From the Certificate Type list, choose the type authentication certificate to be used by a
client connecting to Integration Server or other webMethods component:
Certificate Type Purpose
SSL (default) Authenticates the message sender. The credentials are
supplied in the protocol header.
Sign Verifies the digital signature on incoming messages to
Integration Server.
Encrypt Encrypts outgoing messages from Integration Server.
Sign and Encrypt Both verifies the digital signature on incoming messages and
encrypts outgoing messages. Used if a user has the same
certificate for sending and receiving messages.
Message Authenticates the message sender. The credentials are
supplied in the message header.
5 Click Upload.
The certificate appears on the Certificates panel.
Searching for Authentication Certificates
You can search for authentication certificates based on a number of criteria.
To perform a search for authentication certificates
1 To navigate to the correct page in My webMethods:
Administration > System-Wide > User Management > Certificates > Search > Advanced.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 103

2 Select any criteria that can define the certificate you want to find.
Criteria How to enter it
3 After you have selected search criteria, click Go.
8. Managing Users and Groups
CERTIFICATE INFO
Type Choose the certificate type assigned to the certificate. Valid
types are described in “Adding an Authentication Certificate”
on page 103. The default is Any.
Issuer Name Type the common name of the certificate issuer. This field is
not used if you leave it blank.
Serial Number Type the serial number assigned to the certificate. This field is
not used if you leave it blank.
Subject Name Type the common name of the subject. This field is not used if
you leave it blank.
VALID NOT BEFORE DATE
Range Choose a range of dates from the selection provided. The
default is All.
Start Date Type a start date using the format M/D/YYYY; if you use an
incorrect format, the border turns red. Or click Choose Date.
End Date Type an end date using the format M/D/YYYY; if you use an
incorrect format, the border turns red. Or click Choose Date.
VALID NOT AFTER DATE
Range Choose a range of dates from the selection provided. The
default is All.
Start Date Type a start date using the format M/D/YYYY; if you use an
incorrect format, the border turns red. Or click Choose Date.
End Date Type an end date using the format M/D/YYYY; if you use an
incorrect format, the border turns red. Or click Choose Date.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 104

Viewing Details of an Authentication Certificate
You can view the details associated with an authentication certificate.
To view the details of an authentication certificate
1 To navigate to the correct page in My webMethods:
Administration > System-Wide > User Management > Certificates.
8. Managing Users and Groups
2 If the certificate is not visible in the Certificates panel, use the Search panel to locate it,
as described in “Searching for Authentication Certificates” on page 103.
3 Locate the certificate and click Details.
The following details are available:
Certificate Detail Description
Certificate Type The certificate type assigned when the certificate was added,
as described in “Adding an Authentication Certificate” on
page 103.
Version The version number of the certificate.
Serial Number The serial number assigned to the certificate.
Issuer Common The common name of the issuer.
Name
Issuer DN The Distinguished Name of the issuer.
Subject Common
Name
The common name of the host being authenticated.
Subject DN The distinguished name of the host being authenticated.
Valid Not Before The date before which the certificate is not valid.
Valid Not After The date after which the certificate is not valid.
Alg Name The name of the algorithm used to calculate a fingerprint
(digest) of the certificate.
4 To return to the list of certificates, click Close.
Assigning a User to an Authentication Certificate
You can assign only one user to an instance of an authentication certificate. The procedure
for doing so is described here. To assign the same certificate to multiple users, add a
separate instance of the certificate (“Adding an Authentication Certificate” on page 103)
for each user.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 105

To assign a user to an authentication certificate
1 To navigate to the correct page in My webMethods:
Administration > System-Wide > User Management > Certificates.
8. Managing Users and Groups
2 If the certificate is not visible in the Certificates panel, use the Search panel to locate it,
as described in “Searching for Authentication Certificates” on page 103.
3 Locate the certificate and click Details.
4 On the Edit Certificate area, click Set.
5 In the Keywords field, type a user ID, click Search, move the user to the Selected box,
and click Apply.
6 Click Close.
Changing Users for an Authentication Certificate
You can exchange one user for another in an existing authentication certificate.
To change users for an authentication certificate
1 To navigate to the correct page in My webMethods:
Administration > System-Wide > User Management > Certificates.
2 If the certificate is not visible in the Certificates panel, use the Search panel to locate it,
as described in “Searching for Authentication Certificates” on page 103.
3 Locate the certificate and click Details.
4 On the Edit Certificate area, click Set.
5 In the Keywords field, type the user ID for the new user, click Search, move the user to
the Selected box, and click Apply.
This action replaces the former user with the new user.
6 Click Close.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 106

8. Managing Users and Groups
Removing a User from an Authentication Certificate
You can remove a user who is assigned to an existing authentication certificate.
To remove a user from an authentication certificate
1 To navigate to the correct page in My webMethods:
Administration > System-Wide > User Management > Certificates.
2 If the certificate is not visible in the Certificates panel, use the Search panel to locate it,
as described in “Searching for Authentication Certificates” on page 103.
3 Locate the certificate and click Details.
4 On the Edit Certificate area, click Remove.
5 Click Close.
Deleting an Authentication Certificate
You can view the details associated with an authentication certificate.
To view the details of an authentication certificate
1 To navigate to the correct page in My webMethods:
Administration > System-Wide > User Management > Certificates.
2 If the certificate is not visible in the Certificates panel, use the Search panel to locate it,
as described in “Searching for Authentication Certificates” on page 103.
3 In the search results, select the check boxes beside the certificates you want to delete,
and click Delete.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 107

8. Managing Users and Groups
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 108

Chapter 9. Managing Roles and Access to My webMethods
� Overview of Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
� Granting Users Access to My webMethods and the My webMethods Users Role . . . . . . . . . . 111
� Creating Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
� Editing Information for a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
� Deleting Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
� Defining Dynamic Attributes Associated with a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
� Managing User Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
� Managing User Actions Within Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 109

Overview of Roles
9. Managing Roles and Access to My webMethods
A role is a collection of users, groups, or other roles. For information about creating roles,
see “Creating Roles” on page 112.
A set of default roles is installed with My webMethods Server, to which you can add
users, groups, and other roles as needed:
Default role Description
Admin Role Provides access to all My webMethods Server
resources. By default, the SysAdmin and Designer
users are members of this role.
My webMethods Administrators Provides access to user management and other
functions needed by the My webMethods
Administrator, who is a default member of this role.
My webMethods Users Provides access to the My webMethods user interface
for all users of My webMethods applications. By
default, the My webMethods Server Administrator is
a member of this role, but you must add all other users
to it. See “Granting Users Access to My webMethods
and the My webMethods Users Role” on page 111.
The members assigned to a role can span across multiple directory services. That is, their
membership can include users, groups, and roles defined in the internal directory service,
as well as, users and groups defined in external directory services. The membership of a
role can be static, like groups where each member is specifically assigned. However, you
can also make the membership of a role dynamic. It is valid for roles to be recursive,
making it possible for roles to be members of each other. The following table lists the
different ways you can define the membership of a role, whether the membership is static
or dynamic, and where to find more information in this chapter about how to define
membership for each type of role.
Membership of a role defined by
specifying... Static or Dynamic For more information, see...
The users, groups, and other roles you
want to be members of the role
An LDAP query that queries an
external directory service to determine
the users or groups assigned to the role
A database query that queries a
database directory service to
determine the users or groups
assigned to the role
Static “Adding a Static Role” on
page 113
Dynamic “Adding an LDAP Query
Role” on page 114
Dynamic “Adding a Database Role”
on page 118
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 110

9. Managing Roles and Access to My webMethods
Within My webMethods Server, you use roles to grant or deny users access to
functionality. The following table lists what you can control via roles and where to find
more information in this chapter about how to manage control to functionality.
To control... For more information, see...
The functions that appear in the
navigation panel or navigation list for a
user.
The actions a user can take after selecting
a function.
“Managing User Functions” on page 123
“Managing User Actions Within
Functions” on page 124
You can associate dynamic attributes with a role to provide more information about a
role. For example, if there is a “Customer Service” role, an administrator might add a
“Location” attribute to identify where the user assigned to the “Customer Service” role is
located. When you add the attribute to the role, you assign it a value. This becomes the
default value for the attribute. Continuing with the example, assume your main service
center is in Ohio. As a result, when you add the “Location” attribute to the “Customer
Service” role, you assign it the value Ohio. You can also assign user‐specific values to a
dynamic attribute. Once again, continuing with the example, assume you have a user that
is a member of the “Customer Service” role, but who is located in Colorado rather than
Ohio. You can assign that user a specific value of Colorado for the “Location” attribute in
the “Customer Service” role.
For more information about dynamic attributes, see the following sections in this chapter:
� “Defining Dynamic Attributes Associated with a Role” on page 121
� “Setting User‐Specific Values for Dynamic Attributes” on page 122
Granting Users Access to My webMethods and the My
webMethods Users Role
My webMethods Server includes the My webMethods Users role, which is already
defined for you. The My webMethods Users role governs access to My webMethods. That
is, a user must be a member of the My webMethods Users role for the system to allow the
user to log into the user interface. The My webMethods Users role is a static role; that is,
the membership of the My webMethods Users role is a specified list of users, groups, and
other roles.
Users Defined in the Internal System Directory Service
When you add users to the internal system directory service, My webMethods Server
automatically assigns the new users to the My webMethods Users role. You do not need
to take any further action.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 111

Creating Roles
Externally-Defined Users
9. Managing Roles and Access to My webMethods
You can configure My webMethods Server to obtain information about users and groups
from external directory services. After configuring an external directory service, you need
to take further action to identify the externally‐defined users that you want to be able to
access My webMethods. These users must be identified in the My webMethods Users
role. For information about using external directory services with My webMethods
Server, see “Configuring an External LDAP, ADSI, or ADAM Directory Service” on
page 57 and “Allowing Externally Defined Users Access to My webMethods” on page 63.
The following table describes the types of roles you can create. The differences in these
roles are only in how you identify the membership of the role, and not how My
webMethods Server uses the roles. My webMethods Server uses all roles, regardless of
type, in the same manner.
Role You identify the membership of the role by specifying...
Static Role A collection of users, group, and roles that are members of the role you
are creating. The membership of the role does not change unless you
manually edit the role and change its membership. See “Adding a Static
Role” next in this chapter.
LDAP Query
Role
Database
Role
Note: This is similar to a group except that role membership can span
multiple directory services.
An LDAP query. The users, groups, and roles that match the query
become members of the role. The membership of the role is dynamic
based on the outcome of the query at run time. See “Adding an LDAP
Query Role” on page 114.
A query for a database directory service. The users, groups, and roles
that match the query become members of the role. The membership of
the role is dynamic based on the outcome of the query at run time. See
“Adding a Database Role” on page 118.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 112

Adding a Static Role
A static role is a simple collection of users, groups, and other roles.
To create a static role
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Roles > Add Role.
� As system administrator:
Administration > User Management > Manage Roles > Add Role.
9. Managing Roles and Access to My webMethods
2 In the Role Name field, type the name you want to assign to the new role.
3 To select the Static Role Provider, move that role provider to the Selected Items box.
4 Click Create Role.
Editing Members of a Static Role
To edit the members of a static role, do the following:
To edit members in a static role
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Roles
� As system administrator:
Administration > User Management > Manage Roles
2 Search for the static role to which you want to add members. For more information,
see “Searching for Existing Users, Groups, or Roles” on page 76.
3 In the search results, click the role name or click Edit.
4 On the Members panel, click Edit Members.
5 To add members, do the following:
a Under Search For, choose the Users, Groups, or Roles option.
b In the Keywords field, type a keyword representing the users, groups, or roles you
want to search for, and click Search.
c Move one or more users, groups, or roles to the Selected box.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 113

9. Managing Roles and Access to My webMethods
6 To delete members from the static role, move them from the Selected box.
7 Click Apply.
Adding an LDAP Query Role
An LDAP query role is based on an LDAP query to an external directory service. Any user
or group that meets the requirements of the query is a member of the role.
To create an LDAP query role
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Roles > Add Role.
� As system administrator:
Administration > User Management > Manage Roles > Add Role.
2 In the Role Name field, type the name you want to assign to the new role.
3 To select the LDAP Query Role Provider, move that role provider to the Selected Items box.
4 Click Create Role.
5 In the LDAP Query field type a valid LDAP query.
6 Select the Simple Query option if the query in the LDAP Query field contains simplified
LDAP query syntax.
Unless you are creating a complex LDAP query, the query syntax can be cumbersome
to use. With the Simple Query option, the syntax is filled in for you. For example, to find
all persons whose manager has the user ID abrown, the simple query syntax is
manager=abrown.
7 In LDAP Directory Service, click Browse.
8 Move the LDAP directory service to the Selected Items box and click Select.
9 In the Principal Type list, choose whether the query searches for Users or Groups.
10 To update the LDAP query, click Save (Apply in system administration).
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 114

Adding a Rule-Based Role
9. Managing Roles and Access to My webMethods
A rules‐based role is based on a server rule. Any user, group, or role that matches the rule
is a member of the role.
To create a rule-based role
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Roles > Add Role.
� As system administrator:
Administration > User Management > Manage Roles > Add Role.
2 In the Role Name field, type the name you want to assign to the new role.
3 To select the Rule Based Role Provider, move that role provider to the Selected Items box.
4 Click Create Role.
5 Under the Match Criteria heading, select Match All Criteria Below or Match Any Criteria Below
as the criteria for the rule‐based role.
6 Fill in the appropriate match criteria for the rule‐based role using the following
guidelines:
User DN Value(s)—A regular expression that matches any part of the current userʹs
directory distinguished name (DN). In the field, type the portions of the DN to which
you want a match.
For example, ou=Engineering.*ou=US matches a user with the following DN:
uid=joe,ou=Development,ou=Engineering,ou=Midwest,ou=US,o=webMethods
Domain Name Expression—A regular expression that matches any part of the name of
the current userʹs directory service as registered in My webMethods Server. In the
field, type the directory service name to which you want a match.
For example, US (without quotes) matches a user from the US Corporate directory
service. This is a very effective way to govern the look and feel for users that may be
in different user directories, such as partners.
Group DN and Role DN Expression—A regular expression that matches any part of any
group or role of which the current user is a member. In the field, type the portions of
the DN to which you want a match.
For example, ou=Engineering matches a user belonging to a group with the
following DN:
cn=portal,ou=Engineering,ou=Midwest,ou=US,o=webMethods.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 115

9. Managing Roles and Access to My webMethods
User Attributes—One or more pairs of user attributes and their values from the user’s
record. If you have more than one user attribute, the value set in Match Criteria
determines how attributes are matched:
Match Criteria value How the rule is applied
Match All Criteria Below Each regular expression must match some part of the
corresponding attribute value for the current user.
Match Any Criteria Below Any regular expression in the list can match some part
of the corresponding attribute value for the current
user.
For example, if the rule is configured to match all criteria, and the configured user
attribute pairs are the following:
Name Value
office Bellevue
telephonenumber (425) 564‐0000
and the current userʹs attribute values are the following:
Name Value (current user)
office Bellevue
telephonenumber (206) 123‐4567
the rule does not match the current user because it matches the office attribute value
but not the telephonenumber attribute value. If, however, the rule is configured to
match any criteria, the preceding example rule does match the current user.
To create an attribute‐value pair, click Add. At the prompt, type the attribute name
and click OK. At the prompt, type the value to be matched and click OK.
Request Headers—One or more pairs of HTTP header attributes and values. You can
match anything that appears within an HTTP header, such as the browser agent
string or the kinds of MIME types the user will accept. The rule can be a regular
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 116

9. Managing Roles and Access to My webMethods
expression, or a simple text string. If you have more than attribute‐value pair, the
value set in Match Criteria determines how attributes are matched:
Match Criteria value How the rule is applied
Match All Criteria Below Each regular expression must match some part of the
corresponding attribute value for the request header.
Match Any Criteria Below Any regular expression in the list must match some
part of the corresponding attribute value for the
request header.
For example, if the rule is configured to match all criteria, and the configured request
header pairs are the following:
Name Value
Accept‐Charset utf‐8
Accept‐Language ja
and the request header values for the current user are the following:
Name Value (current user)
Accept‐Charset ISO‐8859‐1,utf‐8;q=0.7
Accept‐Language en‐us,en;q=0.5
the rule does not match the current user because it matches the Accept‐Charset
header value but not the Accept‐Language header value. If, however, the rule was
configured to match any criteria, the rule does match the current user.
To create an attribute‐value pair, click Add. At the prompt, type the attribute name and
click OK. At the prompt, type the value to be matched and click OK.
Parent Resource—A resource that matches the current resource or a parent of the
current resource. To select a resource, click Browse to open the resource selector and
select a resource against which to match the rule.If you want match a resource that is
referenced by an alias, you can optionally click Use Alias to select an existing alias on
My webMethods Server.
Resource Type—A resource type that matches the current resource type. To select a
resource type, click Browse to open the resource selector and select a resource type,
from the Extended Types folder, against which to match the rule.If you want match a
resource type that is referenced by an alias, you can optionally click Use Alias to select
an existing alias on My webMethods Server.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 117

9. Managing Roles and Access to My webMethods
Resource Property—One or more pairs of resource properties and values. If you know
the internal name of a property associated with a resource, you can match it. If you
have more than one property‐value pair, the value set in Match Criteria determines how
properties are matched:
Match Criteria value How the rule is applied
Match All Criteria Below Each regular expression must match some part of the
corresponding attribute value for the request header.
Match Any Criteria Below Any regular expression in the list must match some
part of the corresponding attribute value for the
request header.
For example, if you want to match files that are PDFs, the property‐attribute pair is
mimeType=pdf.
To create an property‐value pair, click Add. At the prompt, type the attribute name
and click OK. At the prompt, type the value to be matched and click OK.
7 Click Apply.
Adding a Database Role
A database role is based on a query to a database directory service. Any user, group, or
role that matches the rule is a member of the role.
Note: To create a database role, you must first connect to the database as an external data
source. See “Managing External Data Sources” on page 66.
To create a database role
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Roles > Add Role.
� As system administrator:
Administration > User Management > Manage Roles > Add Role.
2 In the Role Name field, type the name you want to assign to the new role.
3 To select the Rule Based Role Provider, move that role provider to the Selected Items box.
4 Click Create Role.
5 From the Datasource list, select the database to be used as a data store.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 118

9. Managing Roles and Access to My webMethods
6 If the role can include users, in the Query User field, type a SQL query that returns a
record for a given user in the database who should be a member of the role.
The parameters to the query are:
� {uid}—Principal unique ID
� {dn}—Principal distinguished name
An example of a valid query is:
select * from user-roles where roleID=‘Admin’ and userid=‘{uid}’
7 If the role can include groups, in the Query Group field, type a SQL query that returns a
record for a given group in the database that should be a member of the role.
8 Click Save.
Editing Information for a Role
To update the information for a role, perform the following procedure:
To edit a role
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Roles
� As system administrator:
Administration > User Management > Manage Roles
2 Search for the role that you want to edit. For more information, see “Searching for
Existing Users, Groups, or Roles” on page 76.
3 In the search results, click the role name or click Edit.
4 Make the changes you want to the role and click Save (Apply in system
administration).
Important! My webMethods Server displays the information grouped on various
panels. After making changes to information on a single panel, be sure to click Save
(Apply in system administration) to save your changes before selecting another panel.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 119

Deleting Roles
9. Managing Roles and Access to My webMethods
The following table lists the panels displayed for a role and the sections in this chapter
that contains a procedure that describes how to edit the information on that panel:
Panel See...
Role Information “Adding a Static Role” on page 113
If you no longer need a role, you can delete it.
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Roles
“Adding an LDAP Query Role” on page 114
“Adding a Database Role” on page 118
Dynamic Attributes “Defining Dynamic Attributes Associated with a Role” on
page 121
Access Privileges “Managing User Functions” on page 123
Functional Privileges “Managing User Actions Within Functions” on page 124
Note: When you delete a role, the members of the role (users, groups, and/or other roles)
are not deleted.
To delete a role
� As system administrator:
Administration > User Management > Manage Roles
2 Search for the roles you want to delete. For more information, see “Searching for
Existing Users, Groups, or Roles” on page 76.
3 In the search results, select the check boxes beside the roles you want to delete, and
click Delete.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 120

9. Managing Roles and Access to My webMethods
Defining Dynamic Attributes Associated with a Role
You can associate dynamic attributes with a role. Some webMethods components use
dynamic attributes.
When you define the attribute in the role, you assign it a value. The value you assign to
the role is considered the default value. The default value is used for all users unless a
user‐specific value is defined for the attribute.
To define a dynamic attribute for a role
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Roles
� As system administrator:
Administration > User Management > Manage Roles
2 Search for the role. For more information, see “Searching for Existing Users, Groups,
or Roles” on page 76.
3 In the search results, click the role name or click Edit.
4 Click Dynamic Attributes.
5 Click Add Attribute.
6 Fill in the following fields:
In this field... Specify...
Attribute Name The internal name for the dynamic attribute. There are no
restrictions on what characters you can use for this name.
Display Name The name you want My webMethods Server to use when it
displays information about this attribute in the user interface.
Data Type The data type of the attribute. Select a data type from the list.
Value The value you want assigned to the attribute. This is the default
value for the attribute. This value will be used for all users
assigned to this role unless a user‐specific value is defined for the
attribute. For more information, see “Setting User‐Specific Values
for Dynamic Attributes” on page 122.
7 Click Save.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 121

9. Managing Roles and Access to My webMethods
Setting User-Specific Values for Dynamic Attributes
The default value assigned to a dynamic attribute is the default for all users unless you
assign a user‐specific value for the attribute. To assign a user‐specific value to a dynamic
attribute, perform the following procedure.
To assign a user-specific value to a dynamic attribute
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Users.
� As system administrator:
Administration > User Management > Manage Users.
2 Search for the user for which you want to assign a user‐specific value to a dynamic
attribute. For more information, see “Searching for Existing Users, Groups, or Roles”
on page 76.
3 In the search results, click any link in the row of the user or click Edit.
4 Click Roles.
5 In the Role Member Attributes panel, locate the dynamic attribute for which you want to
assign a user‐specific value, and type the value in the User Value column. Note that in
the display the attributes are grouped by role; the role name appears before the list of
attributes assigned to the role.
6 Click Save (Apply in system administration).
Changing the Order of Dynamic Attributes Assigned to a
Role
You can change the order in which dynamic attributes display for a role. Changing the
order affects only how the system displays the attributes in the Role Member Attributes panel
for a user, but does not otherwise affect how the attributes are used by My webMethods
Server or by webMethods components.
To change the order of dynamic attributes assigned to a role
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Roles
� As system administrator:
Administration > User Management > Manage Roles
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 122

9. Managing Roles and Access to My webMethods
2 Search for the role. For more information, see “Searching for Existing Users, Groups,
or Roles” on page 76.
3 In the search results, click the role name or click Edit.
4 Click Dynamic Attributes and then click Change Attribute Order.
5 To reorder dynamic attributes, move them up or down as needed.
6 When the dynamic attributes are in the order you want, click Save (Apply in system
administration).
Deleting Dynamic Attributes Assigned to a Role
If you no longer want one or more dynamic attributes assigned to a role, you can delete
them.
To delete one or more dynamic attributes assigned to a role
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > Roles
� As system administrator:
Administration > User Management > Manage Roles
2 Search for the role. For more information, see “Searching for Existing Users, Groups,
or Roles” on page 76.
3 In the search results, click the role name or click Edit.
4 Click Dynamic Attributes and then click Change Attribute Order.
5 Select the check boxes beside the dynamic attributes you want to delete, and click
Delete Selected Attributes.
6 Click Save.
Managing User Functions
As My webMethods Administrator, you can control the functions that appear in the
navigation panel or navigation list for a user by granting or denying a role access to the
functions. When a role has access to a function, users assigned to that role can select the
function to view information. If you want to grant users the privilege to perform actions
within a function, you must also assign the role privileges; for more information, see
“Managing User Actions Within Functions” on page 124.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 123

To grant or deny a role access to My webMethods functions
1 In My webMethods:
Administration > Roles
9. Managing Roles and Access to My webMethods
2 Search for the role for which you want to manage access to functions. For more
information, see “Searching for Existing Users, Groups, or Roles” on page 76.
3 In the search results, click the role name or click Edit.
4 Click Access Privileges.
5 To grant a role access to one or more functions, select the check boxes for those
functions.
6 To deny a role access to one or more functions, be sure the check boxes for those
functions are cleared.
7 Click Save.
Managing User Actions Within Functions
Within a function, My webMethods Server supports the ability to take actions that are
associated with that function. For example, within the Integration Monitoring function, My
webMethods Server supports viewing services, resubmitting services, and modifying and
resubmitting services. You can control the actions a user can take by updating the
functional privileges for a role to grant or deny a role the ability to perform the actions.
To grant or deny a role the ability to take action within a function
1 In My webMethods:
Administration > Roles
2 Search for the role for which you want to manage access to functions. For more
information, see “Searching for Existing Users, Groups, or Roles” on page 76.
3 In the search results, click the role name or click Edit.
4 Click Functional Privileges.
5 To grant a role the ability to take actions within functions, select the check boxes for
the actions.
6 To deny a role the ability to take actions within a functions, be sure the check boxes
for those actions are cleared.
7 Click Save.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 124

Chapter 10. My webMethods Server Clustering
� How a My webMethods Server Cluster Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
� Planning your My webMethods Server Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
� Creating a My webMethods Server Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 125

How a My webMethods Server Cluster Works
10. My webMethods Server Clustering
A My webMethods Server cluster is an active/active environment in which multiple
server instances run at the same time, sharing the same file system and My webMethods
Server database. The purpose of a My webMethods Server cluster is to achieve high
scalability by distributing the workload among multiple servers. This model is different
from an active/passive environment, which achieves high availability through the use of a
standby server.
To create a cluster, you need to install My webMethods Server only on one machine
which we will call the master machine. Additional nodes of the cluster run on other
machines but share the following:
� The same configuration (established on the master machine)
� The same My webMethods Server database
� The My webMethods Server program files that exist on the master machine
A My webMethods Server cluster architecture
Server 1
Program Files
Master Machine
My webMethods
Server Database
Server 2
Machine 2
Server 3
Machine 3
The nodes in the cluster exchange information when they run. There are two methods of
communication:
� Through the My webMethods Server database. Cluster bookkeeping is maintained
this way.
� Through HTTP. When a server delegates another server to run a command, it does so
through the HTTP port of the target server.
For example, only one node in a cluster should have the Search role to avoid locking
issues in using the search index. Cluster roles are described in “Cluster Roles” on
page 127.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 126

A Shared File System
10. My webMethods Server Clustering
For a My webMethods Server cluster to function, all machines must share a common file
system. To accomplish this, the webMethods installation directory on the machine where
you have installed My webMethods Server needs to be a shared directory giving users full
access. If the installation directory is webMethods_install_dir/MWS, the shared directory is
webMethods_install_dir.
On the other nodes of the cluster, you point to that directory as a mapped drive
(Windows) or a mounted drive (UNIX).
As multiple nodes in a cluster use the shared file system, most activity is read‐only, so
there is no likelihood of a file‐locking problem. Nodes do write to the shared file system in
these cases:
� You upload content to the content repository.
� Each node writes its own log file on the shared file system.
� Using system administrator actions or from webMethods Designer, you can deploy
portlets through any node in a cluster. Once deployed, a portlet is immediately
available to all nodes.
The Front End URL
In a production environment, all users and all webMethods applications that
communicate with the My webMethods Server cluster need to use the Front End URL
established for the cluster, described in “Configuring the Master Server in the Server
Cluster” on page 131. In addition, a production cluster should include the use of a load
balancer, shown in “A My webMethods Server cluster network diagram” on page 129.
In practice, users and applications log into the Front End URL through the load balancer.
In turn, the load balancer distributes calls to the nodes. A cluster can have only one Front
End URL.
Note: The load balancer must be set up to use sticky sessions, in which a user session, once
established, is routed to the same server machine until the session is closed.
Cluster Roles
There are several cluster roles that can be assigned to a server instance in a cluster. These
include:
� The Auto Deploy cluster role allows for the automatic deployment of portlets that are
copied to the webMethods_install_dir/MWS/server/server_instance/deploy directory,
and for upgrading to a newer version of My webMethods Server. A cluster can have
only one Auto Deploy node, preferably on machine where My webMethods Server is
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 127

10. My webMethods Server Clustering
installed. This role is enabled by default, but is only needed during upgrades or if you
want the automatic deployment capability. It is often desirable to have this role
disabled in a production environment to reduce the possibility of unauthorized
modification of the server.
� The Notification cluster role is responsible for formatting and sending E‐mail
notifications, and notifications that are sent to a user. A cluster can have multiple
Notification nodes. The Notification role is enabled by default, but is needed only if
you use notifications in your production environment. For example, if you are
running Task Engine, users will not receive task notifications if the Notification role is
not enabled.
� The Search role is responsible for indexing all content that is exposed to the embedded
search engine, maintaining the search index, and performing the searches. Only one
server in a cluster should have the Search role. This role is disabled by default because
it is not exposed by default in My webMethods Server. (The search feature is exposed
in the default shell when you log in as the system administrator.) To take advantage if
this feature, you need to modify existing shells or use different shells as part of a
custom deployment.
� The Task Engine cluster role is responsible for all task engine activities, such as
queuing tasks, processing task rules, searching and retrieving task data. A cluster can
have multiple Task Engine roles. This role is enabled by default, but is needed only if
you actually have Task Engine running on your cluster.
Guidelines for Assigning Specific Cluster Roles
� The Task Engine and Notification roles can be assigned to as many server machines as
you need.
� The Auto Deploy and Search roles should not be assigned to more than one machine.
� Server machines that are running one or more roles can be further broken down and
separately clustered. This may be necessary if your scalability requirements warrant
setting up additional cluster roles to handle increased traffic.
� All of the configuration data for each server node and role is stored in the cluster.xml
file. It is possible to edit the data for your cluster directly in the cluster.xml file,
provided you know the proper data structures and values for the properties of your
cluster. This file is located in the
/webMethods_install_dir/MWS/server/server_instance/config directory.
� Any changes to the cluster configuration will require each node to be restarted.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 128

Planning your My webMethods Server Cluster
10. My webMethods Server Clustering
“A My webMethods Server cluster architecture” shows just one of many types of
distributed deployments that can be configured with My webMethods Server.
A My webMethods Server cluster network diagram
Web Tier
Server Tier
Data Tier
Optional
Browser Browser Browser
Server
Task Engine
Hardware Load Balancer
External Web Server External Web Server
Notification
Auto Deploy
The preceding diagram assumes that there will be three server machines operating in a
cluster, each with its own cluster roles. The machines defined in the Web tier include a
hardware‐based load balancer and two Web server machines. The following sections
illustrate the process that an administrator would work through to start with one server
instance and sequentially add additional servers, each with their own roles in the
distributed deployment.
The procedures for configuring IIS or Apache in an external load‐balanced Web server
cluster configuration with your deployment are explained in Chapter 4, “Using My
webMethods Server with Web Servers” on page 31.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 129
Server
Server
Search
Enterprise Directory Search Index Content
File System

Creating a My webMethods Server Cluster
10. My webMethods Server Clustering
To create a My webMethods Server cluster, you need mount a network drive and make
My webMethods Server software files accessible to all nodes in the cluster by sharing out
the files to all server machines in the cluster. The entire cluster must be running from a set
of shared files that are accessible by all machines in the cluster. In this procedure, we refer
to the machine on which you have installed My webMethods Server as the master
machine, but the use of this term does not imply a master‐slave relationship among the
servers.
Configuring the Cluster
The following procedure is for a Windows system, but the general set of actions is also
applicable for UNIX.
To configure a My webMethods Server cluster
1 Make the webMethods_install_dir/ directory on the master machine a shared directory,
giving users full rights to access the shared directory.
All clustered servers you create will use the My webMethods Server executable and
all other files in this shared directory.
2 On the master machine, map a drive to \\master_machine\webMethods_install_dir on
the same machine.
You should use the same drive letter (for example, M) on all server machines in step 5.
3 Update the JAVA_HOME PATH in the setenv.bat file on the master machine to point
to the mapped drive created in step 2.
The setenv.bat file is located at webMethods_install_dir\MWS\bin\setenv.bat. If you
do not change this setting, the other nodes will not be able to find the JVM.
4 Start My webMethods Server from the mapped drive:
M:\MWS\bin\mws ‐n master start
5 On each configured server machine in the cluster, map a drive (for example, M) to
\\master_machine\webMethods_install_dir.
6 Start My webMethods Server on each configured server machine from the mapped
drive:
7 Start My webMethods Server from the mapped drive:
M:\MWS\bin\mws ‐n node_name start
8 Open a Web browser, and log in into My webMethods Server on the master machine.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 130

10. My webMethods Server Clustering
9 Add server machines in the cluster, as described in “Adding Server Machines to a
Cluster” on page 132.
10 Restart each server machine in the cluster after you make changes to the cluster, as
described in “Starting a My webMethods Server Cluster” on page 133.
Configuring the Master Server in the Server Cluster
Setting up a cluster requires that you start with an instance of My webMethods Server on
a single machine. We call this the master server, but can change the name in the following
procedure.
To verify the default cluster setting
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Cluster Settings > Advanced or Cluster Configuration.
� As system administrator:
Administration > Configuration > Cluster Administration > Advanced or Cluster
Configuration.
2 In the MwS Front End URL field, note that the URL takes this form:
http://host_name:port number
Do not change the URL at this time. After you set up the other machines in your
cluster, you have the option of configuring a separate Web server cluster. You do this
by pointing to the IP address or host name (including domain if appropriate) for your
load‐balanced Web server farm. See Chapter 4, “Using My webMethods Server with
Web Servers” on page 31 for procedures.
3 (Optional) If you want to change the name of this server from the default value of
master, in the Name field, type the new name to be used for this server in the cluster.
4 If you have made any changes, click Submit.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 131

Adding Server Machines to a Cluster
10. My webMethods Server Clustering
Before you add server machines to the cluster, you need prepare the master machine and
the other nodes as described in steps 1 through 5 in “Configuring the Cluster” on
page 130.
To add server machines to the server cluster
1 To navigate to the correct page, do one of the following:
� In My webMethods:
Administration > My webMethods > Cluster Settings > Advanced or Cluster Configuration.
� As system administrator:
Administration > Configuration > Cluster Administration > Advanced or Cluster
Configuration.
2 Click Add.
3 In the NAME field, type a descriptive server name.
This is the name you will use when starting the server.
4 In the HOST field, type the host name (including domain if appropriate) or IP address
of the machine where the server is to run.
See your network administrator for information about host names and network setup
at your site.
5 In the HTTP PORT field, type the port number to be used by the HTTP listener.
This field must always have a valid port number.
6 (Optional) In the HTTPS PORT field, type the port number to be used by the HTTPS
listener.
A value of 0 (zero) in this field disables the listener.
Note: My webMethods Server includes a sample HTTP certificate that you can use to
set up and test your HTTPS listener. The sample is located in the
webMethods_install_dir/MWS/server/server_instance/config/
demo.keystore file. For production environments, be sure to obtain an actual
Certificate from a qualified authority such as Verisign.
7 (Optional) In the AJP13 PORT field, type the port number to be used by the AJP13
listener.
A value of 0 (zero) in this field disables the listener.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 132

10. My webMethods Server Clustering
8 (Optional) In the AJP13 ALLOWED WEB SERVER HOSTS field, type the host names from
which connections are allowed, separated by commas.
You use this setting when you are configuring an external Web server as your front
end. For more information, see “Using My webMethods Server with Web Servers” on
page 31.
9 To select one or more roles for a server, select the check box for the role.
Cluster roles are described in “Cluster Roles” on page 127.
10 Reassign cluster roles for the master server, as needed.
11 Repeat this procedure for each server machine that you want to configure as part of
the cluster.
12 Click Submit to save your settings.
13 Restart the cluster, as described in “Starting a My webMethods Server Cluster” on
page 133.
Starting a My webMethods Server Cluster
After configuring all of the server machines in the cluster, start each server from the
machine on which it resides.
Note: On Windows, a service cannot access a mapped drive. For this reason, on Windows
you need to run each server instance as an application rather than as a service.
Starting a server instance in a cluster is much slower than starting a server with the
program files on the same machine. At start‐up, there are many small classes that must be
loaded onto the target machine.
To start a server cluster
1 If you have not already done so, configure the cluster nodes, as described in
“Configuring the Cluster” on page 130.
2 On each configured server machine, browse to the following directory on the master
machine:
/webMethods_install_dir/MWS/bin
3 Run the mws.bat or mws.sh script, appending it with the server name, as shown in
the example below:
> mws -s server_name run
where server_name corresponds to the server name you have assigned to be run on the
current machine.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 133

Example: There are three machines to be used in a cluster:
10. My webMethods Server Clustering
� My webMethods Server is installed on machine_1 (the master machine) and has the
Auto Deploy and Search roles. The server instance configured on this machine is
named master. Browse to webMethods_install_dir/MWS/bin and, at the command
prompt, run this command:
mws -s master run
� The second machine is named machine_2 and has the Notification role. The server
name you assigned in “Adding Server Machines to a Cluster” on page 132 is notify.
On machine_2, browse to the mapped drive
//master_machine/webMethods_install_dir/MWS and run this command:
mws -s notify run
� The third machine is named machine_3 and has the Task Engine role. The server
name you assigned is task_engine. On machine_3, browse to the mapped drive
//master_machine/webMethods_install_dir/MWS and run this command:
mws -s task_engine run
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 134

Part III. System Administrator Functions
� Attribute Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
� Managing My webMethods Server Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
� Analysis, Reporting, and Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
� My webMethods Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
� Managing My webMethods Server Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
� Managing the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
� Managing and Using a Wiki . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
� Managing and Using a Forum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 135

III. System Administrator Functions
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 136

Chapter 11. Attribute Providers
� What are Attribute Providers? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
� Using Attribute Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
� Managing the Display of Principal Attribute Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 137

What are Attribute Providers?
11. Attribute Providers
There are a variety of ways to provide and use attributes belonging to My webMethods
Server users. Basic to each user are the My webMethods Server attributes: home page,
skin, and number of lines displayed per page. In addition, there are Principal Attribute
Providers:
Attribute provider Description
Core Attributes A set of core attributes such as user ID and E‐mail address. If the
user is in the system directory service, some fields are editable. If
the user is in an external directory service, all fields are read only.
See “The Core Attributes Attribute Provider” on page 139.
User Profile A rich set of user attributes that you can maintain regardless of
which directory service the user is a member of. The attributes are
stored in the My webMethods Server database. Once established
for each user, the User Profile Attributes can be used for wiring
globally within My webMethods Server. See “The User Profile
Attribute Provider” on page 140
LDAP A set of attributes from the external directory service. You can
specify which attributes are exposed from a given directory
service. See “The LDAP Attribute Provider” on page 141.
Database A set of attributes from an external database directory service. You
can specify which attributes are exposed from a given directory
service. See “The Database Attribute Provider” on page 142.
Notification A set of addresses, such as E‐mail, at which the user can receive
notifications from My webMethods Server. See “The Notification
Attribute Provider” on page 143.
Dynamic A set of attributes whose values can change depending on the roles
the user is a member of. See “The Dynamic Attribute Provider” on
page 144.
Principal Attribute Providers are useful because any attribute they expose can be made
available as wiring for a portlet. For example, suppose a portlet uses a postal code to
display certain information when a user views a page. If the postal code is provided by
wiring from a Principal Attribute Provider, when the postal code attribute is modified
within a directory service, the portlet uses the modified attribute value.
Principal Attribute Providers are not enabled by default. To enable them, use the Principal
Profile Administration page, described in “Managing the Display of Principal Attribute
Providers” on page 145.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 138

Using Attribute Providers
11. Attribute Providers
The Profile page for a user, group, or role displays the various sets of attributes as well as
memberships in groups or roles. Depending on the directory service to which a user or
group belongs, you can edit some attributes, or expose them for use in global wiring.
To see an example of the Profile page, as a system administrator, in the standard links,
click My Profile. The page displayed is the Profile page for SysAdmin.
To see the Profile page for any user, group, or role, follow this search procedure:
To find the Profile page for a user, group, or role
1 As system administrator:
Administration > User Management > Manage User_type > Search.
where User_type is Users, Groups, or Roles.
2 Search for the user you want to edit. For more information, see “Searching for
Existing Users, Groups, or Roles” on page 76.
3 In the search results, click any link in the row of the user, group, or role, or click
Edit.
The Profile page for the user, group, or role is displayed.
The following sections describe the Attribute Providers available in My webMethods
Server.
This Attribute Provider... Is described here...
Core Attributes “The Core Attributes Attribute Provider” on page 139
User Preferences “The User Preferences Attribute Provider” on page 140
User Profile Attributes “The User Profile Attribute Provider” on page 140
Ldap Attributes “The LDAP Attribute Provider” on page 141
Database Attributes “The Database Attribute Provider” on page 142
Notification Attributes “The Notification Attribute Provider” on page 143
Dynamic Attributes “The Dynamic Attribute Provider” on page 144
The Core Attributes Attribute Provider
The Core Attributes Attribute Provider contains a set of attributes such as user ID and E‐
mail address. Some fields are editable, depending on directory service membership.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 139

User Information Panel
11. Attribute Providers
For individual users, the contents of the Core Attributes Attribute Provider appears on the
Profile page as the User Information panel. For users in the system directory service, some
fields, such as the E‐mail address, are editable. To edit information in this panel, see
“Editing Information for a User” on page 87.
For members of external directory services, this information is not editable, but it is
available for the global wiring feature described in “Using Global Wiring” on page 144.
Group Information Panel
For groups, the contents of the Core Attributes Attribute Provider appears on the Profile
page as the Group Information panel. For groups in the system directory service, some fields,
such as the E‐mail address, are editable. To edit information in this panel, see “Editing
Group Information” on page 97.
For groups in external directory services, this information is not editable but it is available
for the global wiring feature described in “Using Global Wiring” on page 144.
Role Information Panel
For roles, the contents of the Core Attributes Attribute Provider appears on the Profile
page as the Role Information panel. The fields are not editable, but the information is
available for the global wiring feature described in “Using Global Wiring” on page 144.
The User Preferences Attribute Provider
User preferences are basic to any user of My webMethods Server. A My webMethods
Server Administrator, system administrator, or the individual user (if given permission)
can edit these basic attributes. To edit user preferences, see “Editing Information for a
User” on page 87.
The User Profile Attribute Provider
The User Profile Attribute Provider has a rich set of user attributes that you can maintain
regardless of which directory service the user is a member of. The attributes are stored in
the My webMethods Server database. Once established for each user, the User Profile
Attributes can be used with the global wiring feature described in “Using Global Wiring”
on page 144.
A My webMethods Server Administrator, system administrator, or the individual user (if
given permission) can edit the User Profile attributes. You need to enter the user profile
attributes individually for each user, or allow the user to do so. You can use all of the
attributes or a subset that is appropriate to your needs. To edit the User Profile attributes,
see “Editing Information for a User” on page 87.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 140

The LDAP Attribute Provider
11. Attribute Providers
The LDAP Attribute Provider displays a specified set of attributes from the external
directory service to which a user or group belongs. The attributes displayed in the LDAP
Attributes panel are not editable but they are available for the global wiring feature
described in “Using Global Wiring” on page 144.
Note: If the LDAP Attribute Provider is not enabled by default. See “Managing the Display
of Principal Attribute Providers” on page 145.
This attribute provider is not applicable to users or groups in the system directory service.
Similar attributes are included in the User Profile Attribute Provider described in “The
User Profile Attribute Provider” on page 140.
Displaying the LDAP Attribute Provider
You cannot modify the contents of the LDAP Attributes panel on a Profile page, but you can
display it if needed. To search for the Profile page of a user or group, see “Searching for
Existing Users, Groups, or Roles” on page 76.
Exposing LDAP Attributes from an External Directory Service
The LDAP Attributes Provider displays user attributes that are exposed from an external
directory service. You can expose selected attributes that are then available for the global
wiring feature.
To expose LDAP attributes from an external directory service
1 As system administrator:
Administration > System > Service > Directory > Principal Attribute Providers > Provider_type.
where Provider_type is User Principal Attribute Providers or Group Principal Attribute
Providers.
2 For Ldap Attributes, click Tools and then click Properties.
You should now be on the Properties of LDAP Attributes page.
3 Under LDAP Attribute Names, click Add.
4 Type the attribute name exactly as it is used in the external directory service and click
OK.
For example, the attribute name for E‐mail on a particular directory service might be
mail.
5 Under LDAP Attribute Titles, click Add.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 141

11. Attribute Providers
6 Type a display name for the attribute for use within My webMethods Server and click
OK.
For example, for the mail attribute, you might type a display name of E-mail.
7 If you have multiple LDAP attributes, make sure the order in the LDAP Attribute Names
and LDAP Attribute Titles lists are the same.
The order in which attributes and titles appear in the lists determine the order in
which they are displayed in the Ldap Attributes panel on the Profile page.
8 Click Apply.
The Database Attribute Provider
The Database Attribute Provider displays a specified set of attributes from the external
database directory service to which a user or group belongs. The attributes displayed in
the Database Attributes panel are not editable but they are available for the global wiring
feature described in “Using Global Wiring” on page 144.
Note: If the Database Attribute Provider is not enabled by default. See “Managing the
Display of Principal Attribute Providers” on page 145.
This attribute provider is not applicable to users or groups in the system directory service.
Similar attributes are included in the User Profile Attribute Provider described in “The
User Profile Attribute Provider” on page 140.
Displaying the Database Attribute Provider
You cannot modify the contents of the Database Attributes panel on a Profile page, but you
can display it if needed. To search for the Profile page of a user or group, see “Searching
for Existing Users, Groups, or Roles” on page 76.
Exposing Database Attributes from an External Directory Service
The Database Attributes Provider displays user or group attributes that are exposed from
an external database directory service. You can expose selected attributes that are then
available for the global wiring feature.
To expose database attributes from an external database directory service
1 As system administrator:
Administration > System > Service > Directory > Principal Attribute Providers > Provider_type.
where Provider_type is User Principal Attribute Providers or Group Principal Attribute
Providers.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 142

2 For Database Attributes, click Tools and then click Properties.
You should now be on the Properties of LDAP Attributes page.
3 Click Tools for Database Attributes, and then click Properties.
You should now be on the Properties of Database Attributes page.
4 Under Attribute Names, click Add.
11. Attribute Providers
5 Type the attribute name exactly as it is used in the external database directory service
and click OK.
Important! An attribute used here must be returned by the Query Lookup User by ID
attribute in the database directory service. See “Configuring an External Database
Directory Service” on page 60.
For example, the attribute name for postal code on a particular directory service
might be zipcode.
6 Under Attribute Titles, click Add.
7 Type a display name for the attribute for use within My webMethods Server and click
OK.
For example, for the zipcode attribute, you might type a display name of Zip Code.
8 If you have multiple database attributes, make sure the order in the Attribute Names
and Attribute Titles lists are the same.
The order in which attributes and titles appear in the lists determine the order in
which they are displayed in the Database Attributes panel on the Profile page.
9 Click Apply.
The Notification Attribute Provider
The Notification Attribute Provider allows you to specify the various addresses at which a
user can receive notifications.A My webMethods Server Administrator, system
administrator, or the individual user (if given permission) can edit these basic attributes.
To edit user preferences, see “Editing Information for a User” on page 87.
Note: The Notification Attribute Provider is not enabled by default. See “Managing the
Display of Principal Attribute Providers” on page 145.
User preferences are basic to any user of My webMethods Server. A My webMethods
Server Administrator, system administrator, or the individual user (if given permission)
can edit these. To edit user notifications, see “Editing Information for a User” on page 87.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 143

The Dynamic Attribute Provider
11. Attribute Providers
The Dynamic Attribute Provider allows you to provide an attribute for a role. A user,
group, or role that is a member of a role has all dynamic attributes of the role. If a user is a
member of multiple roles, and multiple roles have attributes with the same key, you can
determine which role will have precedence. In addition, you can assign an attribute value
to a user, overriding the attribute values provided by roles. Dynamic attributes are
available for the global wiring feature described in “Using Global Wiring” on page 144.
Note: The Dynamic Attribute Provider is valid only for roles. Users and groups have
dynamic attributes based on roles of which they are members.
For information on functions you can perform on dynamic attributes, see “Defining
Dynamic Attributes Associated with a Role” on page 121.
Using Global Wiring
Users and groups have a set of Principal Attributes that you can wire to a portlet. For
example, suppose a portlet uses a postal code to display certain information when a user
views a page. If the postal code is provided by wiring from a Principal Attribute Provider,
when the postal code attribute is modified within a directory service, the portlet uses the
modified attribute value.
To wire a Principal Attribute to a portlet
1 As system administrator, move to the portlet.
2 In the portlet title bar, click Tools > Wiring.
3 In the Portlet list, choose Other.
4 Click Global Wiring Data, move a Principal Attribute Provider to the Selected Items box
and click Select.
Depending on what Principal Attributes exist on the server, you can see one or more
of the following:
Principal Attribute Provider Description
Core Attributes Wiring A set of attributes valid for all users of the server.
User Profile Wiring A set of user attributes maintained by the system
administrator.
Ldap Attributes Wiring A set of attributes exposed from external directory
services.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 144

11. Attribute Providers
5 Return to the Portlet list and select the Principal Attribute Provide to be used.
6 Click Browse.
7 From the list, select the attribute you want to wire to the portlet and click Select.
The portlet is now wired to use the attribute value belonging to the user who views
the page on which it appears.
Managing the Display of Principal Attribute Providers
If all Principal Attribute Providers were displayed on a Profile page by default, the page
would be crowded and potentially difficult to read. On the Principal Profile
Administration page, you can choose which Principal Attribute Providers to display on a
Profile page and the order in which they appear. You can set Principal Attribute Providers
for users, groups, and roles:
This list... Configures the display of...
USER Attribute
Providers
GROUP Attribute
Providers
ROLE Attribute
Providers
The Profile page for a user. By default, the Core Attributes
Provider is displayed as the User Information panel. Other default
attribute providers are Groups, Roles, and User Preferences. You
can add any Principal Attribute Provider applicable to an
individual user.
The Profile page for a group. By default, the Core Attributes
Provider is displayed as the Group Information panel.The default
attribute providers are Groups and Group Members. You can add
any Principal Attribute Provider applicable to a group.
The Profile page for a role. By default, the Core Attributes
Provider is displayed as the Role Information panel.The other default
attribute provider is Dynamic Attributes.
You can perform the following functions on the Principal Profile Administration page:
This function... Is described here...
Add a Principal Attribute Provider to the
Profile page
Rearrange the position of Principal
Attribute Providers on the Profile page
Remove a Principal Attribute Provider
from the Profile page
“Adding a Principal Attribute Provider”
on page 146
“Changing the Display Order for
Principal Attribute Providers” on
page 146
“Removing a Principal Attribute
Provider” on page 146
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 145

Adding a Principal Attribute Provider
11. Attribute Providers
To add a Principal Attribute Provider to a Profile page, use the following procedure.
To add a Principal Attribute Provider to a Profile page
1 As system administrator:
Administration > User Management > Principal Profile Administration.
2 In the USER, GROUP, or ROLE Attribute Providers area, click Add.
3 To specify the Principal Attribute Provider want to add, move it to the Selected Items
box and click Select.
4 At the bottom of the page, click Apply.
Changing the Display Order for Principal Attribute Providers
To change the order in which Principal Attribute Providers appear on a Profile page, use
the following procedure.
To change the display order for Principal Attribute Providers
1 As system administrator:
Administration > User Management > Principal Profile Administration.
2 In the USER, GROUP, or ROLE Attribute Providers area, To reorder Principal Attribute
Providers, move them up or down as needed.
The first attribute provider in the list has the left‐most position on the Profile page,
followed by the second attribute provider, and so on.
3 At the bottom of the page, click Apply.
Removing a Principal Attribute Provider
To remove a Principal Attribute Provider from a Profile page, use the following
procedure.
To remove a Principal Attribute Provider from a Profile page
1 As system administrator:
Administration > User Management > Principal Profile Administration.
2 In the USER, GROUP, or ROLE Attribute Providers area, select a Principal Attribute
Provider from the list and then click Remove.
3 At the bottom of the page, click Apply.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 146

Chapter 12. Managing My webMethods Server Security
� Overview of My webMethods Server Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
� Managing Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
� Specifying a Primary Domain Controller for NTLM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
� Managing Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
� Using Security Realms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
� Clearing Session Passwords from Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
� Controlling Login IP Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 147

Overview of My webMethods Server Security
12. Managing My webMethods Server Security
My webMethods Server has many different features and functions that contribute to its
overall security infrastructure. When discussing security, it is always necessary to
separate the discussion of authentication (Auth) from Authorization (AZ). While they are
almost always related, the two concepts are distinct and work together to contribute to an
overall security solution.
Authentication is defined as an assurance that a party to some computerized transaction
is not an impostor. Authentication typically involves using a password, certificate, PIN, or
other information that can be used to validate identity. The goal of authentication is to
simply verify that “you are who you say you are.”
Authorization is defined as the process of determining, by evaluating applicable access
control information, whether a party is allowed to have the specified types of access to a
particular resource. Usually, authorization is in the context of authentication. Once a party
is authenticated, that party may be authorized to perform different types of activities.
My webMethods Server provides built‐in infrastructure for both authentication and
authorization. My webMethods Server is also is designed in a way that allows it to be
extended so that existing security infrastructure can be re‐used and leveraged for both
authentication and authorization. This chapter discusses both the built in mechanisms
and the extensible mechanisms.
In My webMethods Server, you can apply both authentication and authorization to the
entire server or to individual server resources, which include folders, pages, portlets,
links, documents, files, or custom objects.
Server Authentication
My webMethods Server supports many different ways for users to identify themselves.
These different methods are called Authentication Schemes. These schemes are simply
different ways to gather user credentials and validate their authenticity. The different
types of authentication schemes that are supported are:
This authentication scheme... Is described here...
Forms authentication “Forms Authentication” on page 149
Anonymous authentication “Anonymous Authentication” on page 149
Basic authentication “Basic Authentication” on page 149
NTLM authentication “NTLM Authentication” on page 149
HTTP header authentication “HTTP Header Authentication” on page 150
User‐defined authentication “Extended and Extensible Authentication Schemes”
schemes
on page 151
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 148

Forms Authentication
12. Managing My webMethods Server Security
Forms authentication is the default authentication scheme for My webMethods Server.
This authentication scheme presents a form to a user and gathers the necessary credentials
that are passed to the server by means of a form POST (data is passed to the server’s
standard input). It is simple to customize the form or page that is used for authentication.
It is also easy to present different forms and pages based on a wide variety of different
criteria. For example, it is very likely that you would want to provide different login
experiences for users accessing a server from mobile devices than for users accessing the
server from a browser.
Anonymous Authentication
The anonymous authentication scheme is used when you do not want to challenge users
for credentials. My webMethods Server honors an anonymous request and establishes a
session with the server as a special Guest user, but the user is never prompted for
credentials. The anonymous authentication scheme is used for unprotected areas of the
server that might be public facing and do not contain sensitive information. By associating
the request with a session and a user ID of Guest, an administrator can extend behaviors
of anonymous access by controlling permissions of the Guest user. Guest is one of the
default users installed as part of the system directory service. It is also possible to track
session activity of anonymous users for reporting requirements.
Basic Authentication
Basic authentication is one of the original and most compatible authentication schemes for
programs using HTTP as a transport mechanism. Unfortunately, it is also one of the least
secure, as it sends the username and password unencrypted to the server. The credentials
are typically passed in as HTTP header parameters. The user experience for basic
authentication is a popup window that renders in the native windowing system. For
example, when you use basic authentication on Windows, a Windows dialog box opens to
prompt the user for credentials before the request can be honored.
NTLM Authentication
NTLM (Windows NT LAN Manager) is an authentication protocol used in various
Microsoft network protocol implementations and supported by the NTLM Security
Support Provider (NTLMSSP). Originally used for authentication and negotiation of
secure DCE/RPC, NTLM is also used throughout Microsoftʹs systems as an integrated
single sign‐on mechanism. On Windows deployments, when NTLM is set up and
configured as an authentication scheme for My webMethods Server, users do not need to
re‐authenticate for server resources if they are already logged into a Windows domain. To
use NTLM authentication you need to explicitly specify the Primary Domain Controller
for the domain, as described in “Specifying a Primary Domain Controller for NTLM” on
page 162.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 149

HTTP Header Authentication
12. Managing My webMethods Server Security
My webMethods Server can be configured to accept External HTTP authentication
credentials from third‐party security and access control products (such as Computer
Associates, Oblix, and so forth). These credentials are case sensitive, depending on
platform and Web server and are most likely to be headers such as sm_user or SM_USER.
When you configure and set up HTTP header authentication within My webMethods
Server, the server uses credentials from a third‐party authentication engine. Typically,
these third parties use a security agent to intercept the request prior its getting to the
server. The basic flow of events in this request is:
1 The user attempts to go to a server resource.
2 Prior to connecting to the server, if the third‐party security agent does not see the
proper credentials, the agent redirects the user to a mechanism that gathers
credentials.
3 The user provides the credentials and is then redirected back to the server resource.
4 The server reads the appropriate HTTP header and maps the user appropriately.
To configure this interaction between the server and the third‐party security agent, you
need to take these actions:
1 After My webMethods Server installation, configure the third‐party product to
protect the server, which typically involves creating a policy that protects the server
URL.
2 Verify that the server and the third‐party security product are configured to look at
the same directory store. See “Managing External Data Sources” on page 66 for more
information on directory services.
3 Configure the server to look for the right HTTP header. See “Configuring External
Configuration Credentials” on page 195.
Note: In the case of Siteminder from Computer Associates, it is also necessary to specify
the Logout URI in Siteminder.
In the Siteminder Administrator applet, modify the logoutURI attribute to be
ʹ/?method=logoutʹ (without the quotes)
Important! The HTTP Header Authentication Administration page should only be enabled
if you are using a third‐party security provider. After the page is enabled, the server acts
as though all users have been authenticated.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 150

Extended and Extensible Authentication Schemes
12. Managing My webMethods Server Security
My webMethods Server provides hooks for developers to provide their own custom
authentication schemes. To develop a custom authentication scheme, create a portlet,
implement the correct interfaces, and register it with the server. Once created, the new
authentication scheme participates in the security infrastructure just like any other
authentication scheme that is provided as part of My webMethods Server.
My webMethods Server has a concept of a default authentication scheme that is applied to
an entire deployment. A newly configured server uses forms as its default authentication
scheme. The server challenges initial requests for protected resources with a form
requiring the user to type a user name and password.
At any time, you can change the default authentication scheme for a server to one of the
registered authentication schemes. For more information, see “Specifying a Default
Authentication Scheme” on page 159.
Every server resource can have an authentication scheme that overrides the setting for the
entire deployment. For example, you might have one set of pages and portlets that are
completely anonymous and others that require user credentials to be presented. You
would do this by associating the anonymous authentication scheme with the resources
that do not require authentication. For information on managing authentication schemes
for individual server resources, see “Assigning an Authentication Scheme to a Server
Resource” on page 160.
Extending Login and Splash Page Behavior
To understand the login process and flow of events, it helps to analyze an example of how
a system administrator would extend a deployment to have custom login page behavior.
The following set of steps uses the concepts of anonymous access, forms‐based
authentication, and login pages to form a solution. Some of the steps require developer
knowledge.
1 Design a page that has a login portlet on it. For information on creating pages, see
“Creating and Modifying Pages” on page 297. Once the page is created, set the
authentication scheme of the page to “anonymous” so everyone can get to the page
and be presented with the login portlet.
Optionally, you can set access rights on other parts of the page so that the login page
has different appearances, depending on the identities of users. To address even
broader requirements of personalizing the login page, it is also easy to set up custom
login pages based on rules themselves.
2 After setting the authentication scheme of the page to anonymous, make sure the
login portlet itself can be seen by a Guest user (see Guest in “Managing Directory
Services” on page 54).
You may also want to modify the look and feel of the page by removing title bars,
adding explicit instructions, or implementing other business requirements.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 151

12. Managing My webMethods Server Security
3 You can control where a user is redirected after login. In the Properties page for the
login portlet, modify the Login Target property to the page where the user is
redirected. Keep in mind that the Login Target be static or it can be an alias. If you use
an alias like /user.current.start.page, you can alternatively set up start page rules to
govern different start pages based on information about the user logging in.
It is also possible to redirect a request, if not authenticated, to go to the appropriate login
page. To do so, modify the Redirect URI property of the authentication scheme assigned
to the page. When an unauthenticated user requests the page, the user is redirected to the
specified page. As with login targets, a redirect URI can be either static or an alias.
Security Assertion Markup Language
My webMethods Server supports single sign‐on through the Security Assertion Markup
Language (SAML), an XML‐based framework for the exchange of security information.
Using SAML, an application on a target computer grants access based on an assertion
from the source computer.
My webMethods Server can be the calling program, or Security Provider, or can be
configured as an Artifact Receiver, which authenticates the user sign‐on for a target Web
application. For information, see “Setting up Single Sign‐On” on page 204.
Server Authorization
After a user request has been authenticated by the server, it is usually necessary to do
some authorization checks to make sure that the user making the request has the
necessary privilege to act on that resource. In My webMethods Server, the most common
way to do authorization checks is by evaluating Access Control Lists (ACLs). ACLs can be
associated with every kind of server resource, such as pages, portlets, and so forth.
More advanced concepts like verbs and mechanics (groupings of business logic) are server
resources as well, and therefore also participate in the ACL evaluation model. This feature
allows developers to programmatically lock down capabilities of the server.
To understand the authorization engine in My webMethods Server, look at the
composition of an ACL. An ACL is a list of Access Control Entries (ACEs). An ACE is a
simple structure containing an element called a Principal and an element called a Right
Set.
A Principal is a user, group or role. Some examples of Principals are:
Principal Example of a Principal
User Myles Perkins
Group Members of the Perkins family
Role A role definition that resolves to Myles, such as, “Users who have
the ‘Job Title” attribute value set to ‘Product Manager.’”
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 152

12. Managing My webMethods Server Security
Right Sets are groupings of actions that can be performed on a server resource. An
example of a Right Set is “Grant the ability to read.” Right Sets themselves are broken
down into two distinct parts, Capabilities and Settings. Different types of server resources
have different Capabilities associated with them. For example, pages have Capabilities
that include “Add Portlet To Page” while folders have Capabilities that include “Create
Sub Folder” and “Can Read Items in this Folder.”
The other part of a Right Set, the Setting, can have four possible values: DELEGATE,
DENY, GRANT or NONE. Each Capability that makes up a Right Set has a Setting value.
Right Sets are made up of many Capability‐Setting pairings. Here is an example of a Right
Set:
DENY + create sub folder
GRANT + read
This particular Right Set is made up of two Capability‐Setting pairings. If associated with
a folder resource, this Right Set is resolved to deny a Principal the ability to create sub
folders but grant the ability to actually read the folder.
The values for Settings have the following meanings:
This Setting value... Has this effect for the Principal...
DENY Denies the access to perform the capability.
GRANT Explicitly grants access to perform the capability.
DELEGATE Explicitly grants access and gives the right to assign the capability
to another Principal.
NONE Provides no explicit Setting. Authorization for this server resource
will be determined from another source. The decision process is
shown in “Authorization Decisions in My webMethods Server” on
page 157.
“The anatomy of an ACL” shows the relationships described in this section.
The anatomy of an ACL
ACL = Owner + 1 or more ACEs
ACE = Principal + Right Set
Principal = User | Group | Role Right Set = 1 or more Capability/Setting pairs
Setting = DENY | DELEGATE | GRANT | NONE
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 153

12. Managing My webMethods Server Security
As an example, to deny read access to Brian and the Marketing Group from the
Engineering page, we would have the following setup:
� The server resource is the Engineering page.
� The Engineering page has an ACL associated with it that contains two ACEs:
Principal Right Set
Brian DENY read
Marketing Group DENY read
Controlling Permissions on Server Resources
If you have authorization to change access to a server resource, you use the Permissions
portlet of My webMethods Server to assign access control to it. For example, if you are the
owner of the Engineering folder in the previous example, a wizard in the Permissions
portlet allows you to select one or more Principals and Right Sets, and associate them with
that folder. For more information on controlling permissions, see “Managing
Permissions” on page 163.
You do not have to explicitly grant and deny access for every newly created object. If you
give your taxonomy a little forethought, you can keep the potential maintenance burden
to a minimum. My webMethods Server employs a method called static propagation of its
access rights on server objects when they are created. This means that at creation time, a
server resource receives its access rights from its parent resource. If subsequent changes
are made to the parentʹs access rights, these rights are not dynamically updated in the
child object. However, you can use the Permissions portlet to cause parent objects to apply
access rights explicitly to their children.
To illustrate static propagation and parent‐child interaction as it relates to access rights,
we will return to the previous example of the Engineering folder. In that example, the
Engineering folder has BRIAN DENY. As the owner of the Engineering folder, a user
creates a sub folder called Secret Project. Because of static propagation, the new Secret
Project folder has BRIAN DENY at the time of creation. If the owner goes back and
changes the permissions of the Engineering Folder to allow Brian access, Brian still does
not have access to the Secret Project sub folder.
The user can, however, go back to the Engineering Folder and choose to apply the access
rights explicitly down to the Secret Project sub folder (and potentially its children or sub
folders as well). For more information, see “Managing Permissions to the Descendents of
a Server Resource” on page 165.
Authorization Determination
Now that you have a background in the concepts of making an authorization decision,
you can see how access is actually determined at run time. When a server resource is
requested, the server evaluates the ACL associated with that resource against the context
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 154

12. Managing My webMethods Server Security
in which the current request is generated. If a user requests access to a page, the ACL for
that page is evaluated to determine whether the user request should be honored.
There are a few simple rules in determining authorization that handle a large percentage
of any conflicts that may arise:
1 DENY always takes precedence over Allow (It is good to be paranoid in dealing with
security)
2 Users always take precedence over groups and roles
To illustrate these rules and how they are applied to resolve conflict, we return to the
example Engineering folder. In the following example, there are three ACE entries in the
ACL associated with the Engineering folder:
BRIAN + DENY READ
MARKETING GROUP + DENY READ
BRIAN + GRANT READ
If Brian is a member of the Marketing group (and even if he wasnʹt) he is denied access to
the Engineering folder. The user‐based ACE takes precedence over the group‐based ACE
so the MARKETING GROUP ACE has no effect. Subsequently, the conflict between
BRIAN being granted and denied access is resolved by denying access because DENY
always wins.
“Authorization Decisions in My webMethods Server” on page 157 shows a detailed flow
chart for authorization decisions. The flow chart highlights some of the conflict resolution
activities.
Lists, pages, child objects and Searches
As mentioned earlier, a Principal can be a user, group, or role. Information about a
Principal comes from a directory service. My webMethods Server has an embedded
system directory service, described in “Managing Directory Services” on page 54, as well
as the ability to tie to external directory servers. Examples of these external directory
servers are Active Directory, LDAP servers, ADAM, and an RDBMS. In addition, group
and role information for My webMethods Server authorization decisions is determined
when a user logs into the server. If a userʹs group membership changes during an active
session, the change is not reflected in the server until the user logs out and logs back in.
See Chapter 8, “Managing Users and Groups” for more information about users, groups,
roles, and directory services.
Security Realms
My webMethods Server provides a feature called Security Realms to augment its security
model. Security Realms are collections of server resources that share the same ACL. The
use of Security Realms makes it possible to easily manage permissions on large numbers
of server resources. By adding the resources directly to a Security Realm, a system
administrator can add Principal information to that realm to control access.
Security Realms become very useful if you have a large number of server resources and
only a few access levels. For example, you may have a large customer‐facing server that
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 155

12. Managing My webMethods Server Security
has a large number of portlets, pages and areas of taxonomy. However, this server may
only have three levels of access that need to managed: Gold, Silver and Bronze. With each
level represented by a Security Realm with the appropriate pages, portlets and taxonomy
elements in them, a system administrator needs only to add a new customer to the
appropriate Security Realm, granting the customer the correct level of access. Likewise,
changing a customer from one level to another is a simple one‐step operation.
Used in the appropriate deployments, Security Realms add value, not only by minimizing
the administrative burden, but by greatly reducing the number of underlying records
required to support the security model. For example, assume a server has 500,000 server
resources and you are managing permissions for 50 users, all of whom have the same
access:
� Managing permissions by ACL requires 25 million records in the My webMethods
Server database.
� Managing permissions by Security Realm uses one Security Realm and one role with
50 members, requiring a total of three records in the My webMethods Server
database.
It should be noted that if a server resource is added to a Security Realm, the Security
Realm access control has precedence over an individual ACL and authentication scheme
for that resource.
Server Verbs and Access Control
A server verb is an operation such as publishing, deleting, updating, subscribing, and
setting permissions, which is available through the My webMethods Server API. As noted
earlier, server verbs are server resources that can also participate in the security model of
the server. In this way, one can control granular access to server capabilities
programmatically as well as through the Administrative Dashboard. It should be noted
that server verbs typically have two levels of security checks, performed in this order:
1 Does the user have access to the server verb itself?
2 Does the user have the rights to the resource upon which the server verb is trying to
act.
A system administrator can control access to server verbs using the Security Realms
Administrative page. My webMethods Server ships with default Security Realms to help
administrators manage access to different server capabilities. The default Security Realms
are described in “Using Security Realms” on page 166.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 156

Grant
Right
Yes
Yes
Yes
Authorization Decisions in My webMethods Server
Is Item
deleted?
No
Start
Is there an
exclusive
lock?
No
Have I been
granted
access?
No
Have I been
denied
access?
No
Am I the
owner?
No
Do I belong to
the group or role
that owns it?
Yes Do I hold
the lock?
Yes
Access is evaluated by iterating
through every ACE on the ACL.
Yes Am I the
owner?
No
No
12. Managing My webMethods Server Security
Is the “Read”
right?
Grant Deny
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 157
Yes
Yes
Find granted and
denied rights based
on my group or role
membership
Has right been
denied?
No
No
Yes
Yes Has right been No
granted?
Deny
Right
No
Yes
Yes
No
Roles
Roles
Find granted and
denied rights based
on my group or role
Has right been
denied?
No
Has right been
granted?
Yes

Managing Authentication
12. Managing My webMethods Server Security
An authentication scheme is a way to gather user credentials and validate their
authenticity. Within My webMethods Server, you can manage authentication for a server
as a whole by specifying a default authentication scheme. As delivered, the forms
authentication scheme is the default for all server resources. In addition, every server
resource can have an authentication scheme that overrides the setting for the entire
deployment.
Note: A Security realm always takes precedence over an authentication scheme.
My webMethods Server uses the following authentication schemes:
Scheme Description
anonymous Allows unrestricted access to a server resource. Used for
unprotected areas of the server that might be public facing and do
not contain sensitive information. Because a user is not challenged
for credentials, the anonymous authentication scheme is
appropriate for login pages.
forms Presents a form to an unauthenticated user and gathers the
necessary credentials that are passed to the server. The forms
authentication scheme is the default for all server resources
because it redirects unauthenticated requests to a default login
page.
basic Typically passes credentials as HTTP header parameters. The user
experience for basic authentication is a popup window that
renders in the native windowing system.
httpHeader Accepts external HTTP authentication credentials from third‐party
security and access control products (such as Computer
Associates, Oblix, and so forth). After this authentication scheme is
enabled, the server ignores all other authentication schemes. See
“Configuring External Configuration Credentials” on page 195.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 158

Scheme Description
12. Managing My webMethods Server Security
ntlm Used for authentication in various Microsoft network protocol
implementations. On Windows deployments, when the ntlm
authentication scheme is the default for a server, users do not need
to re‐authenticate for server resources if they are already logged
into a Windows domain.To use NTLM authentication you need to
explicitly specify the Primary Domain Controller for the domain,
as described in “Specifying a Primary Domain Controller for
NTLM” on page 162.
saml Supports single sign‐on through the Security Assertion Markup
Language (SAML). Using SAML, an application on a target
computer grants access based on an assertion from the source
computer. See “Setting up Single Sign‐On” on page 204.
You can perform the following types of functions to manage authentication in My
webMethods Server.
This function... Is described here...
Change the default authentication scheme
to be used for My webMethods Server.
Specify an authentication scheme for an
individual server resource
Redirect a user to a page other than the
login page after logging in.
Redirect an unauthenticated request for a
protected server resource to a specified
login page other than the default login
page.
For My webMethods Server using NTLM
authentication, identifies the Primary
Domain Controller responsible for
authentication on the network.
“Specifying a Default Authentication
Scheme” on page 159
“Assigning an Authentication Scheme to
a Server Resource” on page 160
“Redirecting a User After Login” on
page 161
“Redirecting an Unauthenticated
Request” on page 161
Specifying a Default Authentication Scheme
“Specifying a Primary Domain Controller
for NTLM” on page 162
When My webMethods Server is initialized, the forms authentication scheme is the
default. the forms authentication scheme redirects unauthenticated requests to a default
login page. You can change the default authentication scheme for My webMethods Server
to one of the registered authentication schemes.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 159

12. Managing My webMethods Server Security
Note: Do not use this procedure if you intend to use the httpHeader authentication scheme
to accept credentials from third‐party security providers. Instead, use the HTTP Header
Authentication Administration page, described in “Configuring External Configuration
Credentials” on page 195.
To change the default authorization scheme for My webMethods Server
1 As system administrator:
Administration > System > Authentication Schemes.
2 Click name of the default authentication scheme.
At installation, the default authentication scheme is forms.
3 Under Aliases, select the auth.scheme.default alias and then click Remove.
4 Click Apply.
5 Click the authentication scheme that is to become the default.
6 Under Aliases, click Add.
7 In the prompt window, type auth.scheme.default and then click OK.
8 Click Apply.
Assigning an Authentication Scheme to a Server Resource
Every server resource can have an authentication scheme that overrides the default
authentication scheme for My webMethods Server.
To assign an authentication scheme for an individual server resource
1 For a server resource, such as a page, click Tools and then click Permissions.
2 If the Custom option is selected, click Edit.
3 From the Authentication list, choose the authentication scheme to apply to the server
resource and click Apply.
4 If you also want to apply the same authentication scheme to any pages or individual
portlets contained by this page, select the Apply to all descendants check box.
5 Click Apply.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 160

Redirecting a User After Login
12. Managing My webMethods Server Security
By default, when a user logs into a server, redirects the user to the same page. You can
alter the Login Target property of the login portlet so a successful login redirects the user
to a page of your choosing.
To redirect a user to another page after login
1 At the right edge of the title bar for the login portlet, click Tools and then click
Properties.
2 For the Login Target property, do one of the following:
Click this... And do this...
Browse Move the target page to the Selected Items box and click Select.
Use Alias In the Alias Name field, type the alias of the page to which the
user should be redirected. Click Test to determine if the alias is
valid and the alias target is the correct one. If the alias is
correct, click Select.
3 Click Apply.
Note: If you type /user.current.start.page, the user is
redirected to the start page defined by start‐page rules.
Redirecting an Unauthenticated Request
Using the forms authentication scheme, an unauthenticated request to a protected server
resource results in the user being redirected to a default login page. Alternatively, you can
redirect the user to a target of your choosing, whether it is a custom login page or a page
that provides unprotected content.
To redirect an unauthenticated request to a different page
1 As system administrator:
Administration > System > Authentication Schemes.
2 Click Tools for the default authentication scheme, and then click Properties.
By default, the forms authentication scheme redirects unauthorized requests to the
default login page. You can verify that an authorization scheme is the default by
looking at the Properties page; the Aliases list contains the auth.scheme.default alias.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 161

12. Managing My webMethods Server Security
3 In the Performs Redirect list of the Properties page for the authentication scheme, make
sure Yes, this performs a redirect is selected.
4 Under Redirect URI, do one of the following:
Click this... And do this...
Browse Move the target page to the Selected Items box and click Select.
Use Alias In the Alias Name field, type the name of the alias to which the user
should be redirected. Click Test to determine if the alias is valid
and the alias target is the correct one. If the alias is correct, click
Select.
5 Click Apply.
Specifying a Primary Domain Controller for NTLM
Using NTLM authentication, a user who has logged into a Windows domain does not
have to re‐authenticate to log in to a server. A Primary Domain Controller is a Microsoft
Windows server responsible for handling all accounts in a domain. To use NTLM
authentication, you must explicitly specify the Primary Domain Controller in the NTLM
Authentication Scheme.
To specify a Primary Domain Controller for NTLM authentication
1 As system administrator:
Administration > Configuration > NTLM Authentication Administration.
2 In the Domain Controller Name field of the Properties page, type the hostname of the
Primary Domain Controller and click Submit.
To disable NTLM Authentication
1 As system administrator:
Administration > Configuration > NTLM Authentication Administration.
2 In the Domain Controller Name field, delete all characters including spaces and click
Submit.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 162

Managing Permissions
12. Managing My webMethods Server Security
Note: The information in this section relates to managing permissions to pages and other
server resources you develop that are not part of a My webMethods application. Access to
My webMethods applications is managed through Security Realms, as described in
“Using Security Realms” on page 166.
You can control the access of any Principal (user, group, or role) to a server resource or a
hierarchy of server resources. Denying access to a server resource also prevents a
Principal from seeing the resource in server navigation, such as in any listing of the
resource’s siblings or the contents of the resourceʹs parent.
This function... Is described here...
Determine which Principals have access
rights specified for a server resource and
what rights are assigned to each.
Add a Principal to the permissions list for
a server resource.
Modify the permissions for a Principal
who currently has access rights assigned
for the server resource.
Remove a Principal from the permissions
list for a server resource.
Manage permissions to the descendents of
a server resource, such as portlets that
reside on a particular page.
“Viewing Permissions for a Server
Resource” on page 163
The list of Principals who have specific permissions to a server resource appears on the
Permissions page for the resource. You can add Principals to the list, modify their
permissions, or remove them from the list.
Viewing Permissions for a Server Resource
To view the existing permissions for a server resource
“Adding a Principal to the Permissions
for a Server Resource” on page 164
“Modifying Permissions for a Server
Resource” on page 164
“Removing a Principal from Server
Resource Permissions” on page 165
“Managing Permissions to the
Descendents of a Server Resource” on
page 165
1 For a server resource, such as a page, click Tools and then click Permissions.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 163

‘
2 If the Custom option is selected, click Edit.
12. Managing My webMethods Server Security
The Capacity column lists the various permissions that are applicable to the server
resource. The first entry in this listing is always the owner, and the owner always has
complete control of the server resource.
3 When you are finished viewing permissions, click Cancel.
Adding a Principal to the Permissions for a Server Resource
Remember that a Principal is a user, group, or role.
To add a Principal to the permissions for a server resource
1 For a server resource, such as a page, click Tools and then click Permissions.
2 If the Custom option is selected, click Edit.
3 On the Authorization panel, click Add Users or Groups.
4 To add a user or group to the permissions for the server resource, move it to the
Selected Items box and click Next.
5 For each action listed, select one of the following options:
This Option... Means that you...
Grant Explicitly grant permission to execute the action.
Deny Explicitly deny permission to execute the action.
None Neither explicitly grant nor deny permission to execute the action.
The permissions settings for other Principals to which the
Principal belongs will determine whether or not the Principal can
execute the action.
6 Click Apply twice.
Modifying Permissions for a Server Resource
To modify the permissions for a server resource
‘
1 For a server resource, such as a page, click Tools and then click Permissions.
2 If the Custom option is selected, click Edit.
3 For a user or group on the Authorization panel, click Properties.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 164

‘
4 For each Capacity listed, select one of the following options:
5 Click Apply twice.
12. Managing My webMethods Server Security
Removing a Principal from Server Resource Permissions
Remember that a Principal is a user, group, or role.
1 For a server resource, such as a page, click Tools and then click Permissions.
2 If the Custom option is selected, click Edit.
3 For a user or group on the Authorization panel, click Delete.
4 For a specific Principal on the Permissions page, click Tools and then click Remove.
5 Click Apply twice.
Managing Permissions to the Descendents of a Server
Resource
‘
This Option... Means that you...
Grant Explicitly grant permission to execute the action.
Deny Explicitly deny permission to execute the action.
None Neither explicitly grant nor deny permission to execute the action.
The permissions settings for other Principals to which the
Principal belongs will determine whether or not the Principal can
execute the action.
To remove a Principal from the permissions for a server resource
To apply permissions to the descendents of a server resource
1 For a server resource, such as a page, click Tools and then click Permissions.
2 On the Permissions page, select the Apply to all descendents check box and click Apply.
To remove all permissions to the descendents of a server resource
‘
1 For a server resource, such as a page, click Tools and then click Permissions.
2 On the Permissions page, clear the Apply to all descendents check box and click Apply.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 165

Using Security Realms
12. Managing My webMethods Server Security
When you manage permissions, as described in “Managing Permissions” on page 163,
you do so one resource at a time. This method is satisfactory for small servers, but can be
cumbersome as the number of pages and users increases. Security Realms allow you to
manage permissions for resources based on users, groups, or roles, making it easier to
manage large servers. After a Security Realm is applied to a resource, individually set
permissions do not apply unless you specifically choose to set them.
For convince, you can organize Security Realms into folders called containers. My
webMethods Server has the following Security Realm containers by default:
This container... Holds...
Forum Realms Security Realms that manage permissions for forums.
My webMethods
Security Realms
Security Realms that manage permissions for My webMethods
resources.
Portal Resources Security Realms that manage permissions for My webMethods
Server resources
The Security Realms Administration page allows you to create, rename, and remove
containers, as described in these sections:
This function... Is described here...
Create a container “Creating a Container” on page 168
Remove a container “Removing a Container” on page 168
Rename a container “Renaming a Container” on page 169
There are several default Security Realms that manage permissions for My webMethods
Server resources, all of which reside in the Portal Resources container. System
administrators have the right to read, modify or delete the server resources; other users
have permissions as described here:
This Security Realm... Manages permissions for these My webMethods Server pages...
Administrative
Commands
Directory Management
Commands
Directory Service
Commands
Administrative pages. Permits only server administrators
to read, modify, or delete the resource.
Pages that manage users, group, and roles. Permits users
to view or execute the resource. Anonymous users are
denied access.
Pages that manage directory services. Permits users to
view or execute the pages. Anonymous users are denied
access.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 166

12. Managing My webMethods Server Security
This Security Realm... Manages permissions for these My webMethods Server pages...
Developer Commands Pages for the development and maintenance of pages and
content. Members of the Developers group are granted the
right to read, modify, or delete the resource. Permits users
to view or execute the resource. Anonymous users are
denied access.
Public Commands Pages for interacting with a server, such as logging in.
Permits all users, including anonymous users, to read or
execute the resource, but not to modify or delete it.
Restricted Commands Pages for interacting with a server after one has logged in.
Permits users who have logged in to read or execute the
resource, but not to modify or delete it. Anonymous users
are denied access.
User Profile Management
Commands
Pages that control the look and feel of the server. Permits
users to view or execute the resource. Anonymous users
are denied access.
The Security Realms Administration page allows you to create and manage Security
Realms you can use for your content. There are several functions you can perform on this
page:
This function... Is described here...
Create a Security Realm “Creating a Security Realm” on page 169
Remove a Security Realm “Removing a Security Realm” on page 170
Rename a Security Realm “Renaming a Security Realm” on page 170
Add resources to a Security “Adding Resources to a Security Realm” on
Realm
page 171
Remove resources from a Security “Removing Resources from a Security Realm” on
Realm
page 171
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 167

Creating a Container
12. Managing My webMethods Server Security
You can create a container at the same level as the default containers or you can create a
container within a container.
To create a new container
1 As system administrator:
Administration > Configuration > Security Realms Administration.
2 Do one of the following:
To create a container... Do this...
At this level Go on to step 3.
Within a container at this level Click the name of the container to
reveal its contents.
3 Click Create New Container.
4 In the Name field, type a display name for the container.
5 (Optional) In the Description field, type a description.
6 Click Create Container.
Removing a Container
Important! If you remove a container, any Security Realms or other containers within it are
also removed.
To remove a container, do the following:
To remove a container
1 As system administrator:
Administration > Configuration > Security Realms Administration.
2 Click Tools for the container you want to remove, and then click Remove Container.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 168

Renaming a Container
To rename a container, do the following:
To rename a container
1 As system administrator:
Administration > Configuration > Security Realms Administration.
12. Managing My webMethods Server Security
2 Click Tools for the container you want to rename, and then click Modify Container.
3 In the Name field, type the new name.
4 (Optional) In the Description field, type a new description.
5 Click Update.
Creating a Security Realm
To create a Security Realm, do the following:
To create a new Security Realm
1 As system administrator:
Administration > Configuration > Security Realms Administration.
2 Click the name of the container in which to create the Security Realm.
Note: After you have created a Security Realm within a container, you cannot move it
to another container.
3 Click Create New Security Realm.
4 In the Name field, type a display name for the Security Realm.
5 (Optional) In the Description field, type a description.
6 (Optional) To add an extended type, move it to the Selected Items box and click Select.
7 (Optional) To add an external policy provider, move it to the Selected Items box.
8 Click Create Security Realm.
9 Click Tools for the new Security Realm, and then click Configure Permissions.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 169

12. Managing My webMethods Server Security
10 On the Configure Permissions panel, to add new users, groups, or roles to the Security
Realm, click Add Users or Groups.
You can add any user or group from any directory service, or any role to the Security
Realm.
11 To add a user, group, or role to the Security Realm, move it to the Selected Items box
and click Next.
12 For each action listed, select one of the following options:
This Option... Means that you...
Grant Explicitly grant permission to execute the action.
Deny Explicitly deny permission to execute the action.
None Neither explicitly grant nor deny permission to execute the action.
The permissions settings for other Principals to which the
Principal belongs will determine whether or not the Principal can
execute the action.
13 Click Apply twice.
Removing a Security Realm
To remove a Security Realm, do the following:
To remove a Security Realm
1 As system administrator:
Administration > Configuration > Security Realms Administration.
2 Click the name of the container in which the Security Realm resides.
3 Click Tools for the Security Realm you want to remove, and then click Remove
Security Realm.
Renaming a Security Realm
To rename a Security Realm, do the following:
To rename a Security Realm
1 As system administrator:
Administration > Configuration > Security Realms Administration.
2 Click the name of the container in which the Security Realm resides.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 170

12. Managing My webMethods Server Security
3 Click Tools for the Security Realm you want to rename, and then click Modify
Security Realm.
4 In the Name field, type the new name.
5 (Optional) in the Description field, type a new description.
6 Click Update.
Adding Resources to a Security Realm
To add resources to a Security Realm, do the following:
To add resources to a Security Realm
1 As system administrator:
Administration > Configuration > Security Realms Administration.
2 Click the name of the container in which the Security Realm resides.
3 Click Tools for the Security Realm you want to manage, and then click Modify
Security Realm.
4 On the Manage Security Realm panel, click Add Portal Resource.
5 In the left panel, browse to a server resource to be added to the Security Realm.
6 To have the Security Realm manage a server resource, move the resource to the
Selected Items box and click Add Items.
Removing Resources from a Security Realm
To remove resources from a Security Realm, do the following:
To remove resources from a Security Realm
1 As system administrator:
Administration > Configuration > Security Realms Administration.
2 Click the name of the container in which the Security Realm resides.
3 Click Tools for the Security Realm you want to manage, and then click Modify
Security Realm.
4 For the resource you want to remove, Click Tools and then click Remove.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 171

Clearing Session Passwords from Memory
12. Managing My webMethods Server Security
By default, when a user logs in, the password is stored until the user logs out or until the
session times out. You can, however, cause My webMethods Server to clear passwords
from memory immediately after the login is completed. This setting clears all passwords
presented to My webMethods Server; you cannot clear passwords on a case‐by‐case basis.
To clear session passwords from memory
1 As system administrator:
Administration > System > Managers > sessionManager > default > validate.
2 At Configuration XML, click Edit.
3 In the Edit Text Area, change this text:
clearPassword=”false”
to this:
clearPassword=”true”
4 To save the file and close the editor, click Update.
5 Click Apply.
This setting remains until you change it, even if you stop and restart My webMethods
Server.
To retain session passwords in memory
1 As system administrator:
Administration > System > Managers > sessionManager > default > validate.
2 At Configuration XML, click Edit.
3 In the Edit Text Area, change this text:
clearPassword=”true”
to this:
clearPassword=”false”
4 To save the file and close the editor, click Update.
5 Click Apply.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 172

Controlling Login IP Ranges
12. Managing My webMethods Server Security
You can use the Lockdown portlet to control the IP ranges from which users are allowed
to log in to My webMethods Server. Up to four different IP ranges are allowed. The
portlet does not take into account the credentials of the person logging in or any
authentication mechanism. Upon being unable to log in, the user is redirected to an error
page of your choosing. This portlet is useful for a site that allows guest access only, or one
that is to be access only from a secure location.
Important! If you make an error in configuring IP ranges, you may not be able to log in to
correct the problem. To correct the problem, you need to have physical access to the
machine on which My webMethods Server is running.
Deploying the Lockdown Portlet
The Lockdown portlet is not deployed automatically when you initialize My webMethods
Server. The portlet is included in a My webMethods Server installation, but you must
deploy it before use.
To deploy the Lockdown portlet
1 Locate the Lockdown portlet within the webMethods installation directory at this
location:
/webMethods_install_dir/MWS/components/extras/security/wm_lockdown.pdp
2 Copy the wm_lockdown.pdp file to the deploy directory for the server instance:
/webMethods_install_dir/MWS/server/server_instance/config
My webMethods Server detects the presence of the portlet and automatically deploys
it.
Configuring the Lockdown Portlet
After the Lockdown Portlet is deployed, you can configure it for use.
To configure the Lockdown portlet on My webMethods Server
1 As system administrator:
Folders > System > Portlets > Administration > Portal Lockdown Administration.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 173

12. Managing My webMethods Server Security
2 For the Error page property, find a page to which users are redirected if they fail to log
in by doing one of the following:
Click this... And do this...
Browse Move the target page to the Selected Items box and click Select.
Use Alias In the Alias Name field, type the alias of the page to which the
user should be redirected. Click Test to determine if the alias is
valid and the alias target is the correct one. If the alias is
correct, click Select.
3 (Optional) In the E-mail Address for Login Notification field, type an e‐mail address to
which My webMethods Server should send a notification if a login is attempted from
a disallowed IP address.
4 Specify up to four IP ranges from which users are allowed to log into My
webMethods Server.
For each range, provide a value in the Start IP Range and End IP Range fields.
5 On the Is Active field, choose the True option.
6 Click Submit.
The lockdown is in effect immediately.
Disabling the Lockdown Portlet in My webMethods Server
If you can log in to My webMethods Server as system administrator, you can disable the
Lockdown portlet by doing the following.
To disable the Lockdown portlet in My webMethods Server
1 As system administrator:
Folders > System > Portlets > Administration > Portal Lockdown Administration.
2 On the Is Active field, choose the False option.
3 Click Submit.
Disabling the Lockdown Portlet Manually
If you cannot log in to My webMethods Server as system administrator, you need to have
physical access to the machine on which My webMethods Server is installed, and modify
the portal.properties file. Everything in this file is set as a system property, read after the
My webMethods Server starts but prior to initialization of portlets.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 174

To disable the Lockdown portlet manually
12. Managing My webMethods Server Security
1 On the machine where My webMethods Server is installed, locate this file:
/webMethods_install_dir/MWS/server/server_instance/config/portal.properties
2 Open the portal.properties file in an editor and add the following line at the end of the
file:
lockdown.disable=false
For example, with a descriptive comment included:
#======================
# Lockdown Portlet
lockdown.disable=false
3 Restart My webMethods Server.
Note: After you have corrected the IP address range problem, you cannot reactivate
the Lockdown portlet until you remove this line from the portal.properties file.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 175

12. Managing My webMethods Server Security
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 176

Chapter 13. Analysis, Reporting, and Troubleshooting
� Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
� Controlling Server Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
� Viewing Logging Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
� Monitoring Real-Time User Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
� Collecting Data about Server Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
� Capturing Server Environment Diagnostic Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 177

Overview
13. Analysis, Reporting, and Troubleshooting
My webMethods Server provides administrators with a number of tools for analyzing,
reporting, managing, and maintaining server deployment. This chapter provides detailed
instructions on how to use these tools.
Controlling Server Logging
The Logging Configuration page enables you to control logging for the server. With this
page, you can set thresholds for individual categories of logging information. In addition,
you can set the collector threshold for the View Logging Messages page.
By default, log files roll over to a new set of files once a day at midnight. You can modify
the frequency of log‐file rollover using the logging.properties file.
Setting Logging Thresholds
As it runs, the server collects logging information in a variety of categories. Using the
Logging Configuration page you can determine the level of information provided for each
category individually. This feature makes it possible to limit the growth of log files except
in categories where you want more information.
A logging message is assigned one of four log levels of increasing importance. When you
set a threshold at a particular log level, messages at that level, and all higher levels, are
included. The following table describes the levels, from the lowest level to the highest:
Log level Description
DEBUG The server issues messages at multiple points within a server
event. DEBUG messages are useful for debugging a problem, but
log files grow quickly. Messages of all log levels are included in the
log.
INFO The server issues a message to indicate that a server event has
occurred. Messages of all log levels except DEBUG are included in
the log.
WARN A non‐fatal error has occurred. Only WARN and FATAL messages
are included in the log.
FATAL A fatal error has occurred. Only FATAL messages are included in
the log.
Logging information is collected in two stages, which you can control independently.
When the server collects a log message, it sends the message to a specified category. If the
log level of the message meets or exceeds the category threshold, the server forwards the
message on to the logging outputs; if the message does not meet the threshold, it is
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 178

13. Analysis, Reporting, and Troubleshooting
discarded. The logging categories are displayed on the Logging Thresholds panel of the
Logging Configuration page.
The server forwards messages that meet a category threshold to valid outputs for the
category. If the log level of the message meets or exceeds the output threshold, the server
writes the message to the output; if the message does not meet the threshold, it is
discarded.
You can set both category thresholds and output thresholds on the Logging Thresholds
panel of the Logging Configuration page. A category threshold takes precedence over an
output threshold; a logging message discarded for a category cannot be written to output.
To set a category or output threshold
1 As system administrator:
Administration > Analysis > Logging Configuration > Logging Thresholds.
2 For each logging category you want to modify, in the Category Threshold column, select
the log level to the lowest level of message you want to accept.
3 For each output threshold you want to modify, in the Output Threshold list, select the
log level to the lowest level of message you want to accept.
Tip! To set all logging categories to the same logging level, click Tools to the right of
the Category Threshold or Output Threshold label and then click the log level to be used.
4 Click Apply.
Setting the Collector Threshold for View Logging Messages
The Logging Collector is an agent that listens for logging activity and log messages that
meet the collector threshold available to the View Logging Messages page, described in
“Viewing Logging Messages” on page 181. You can use the Logging Collector panel of the
Logging Configuration page to enable or disable message collection and control the log
level of messages being collected.
Note: Input to the Logging Collector is dependent on the category threshold settings
described in “Setting Logging Thresholds” on page 178. The Logging Collector cannot
receive a message with a log level that does not meet a category threshold.
To control the collection of messages for the View Logging page
1 As system administrator:
Administration > Analysis > Logging Configuration > Logging Collector.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 179

13. Analysis, Reporting, and Troubleshooting
2 In the Collector Threshold list, select the log level to the lowest level of message you
want to collect for the View Logging Messages page.
Valid log levels are INFO, WARN (the default), and FATAL.
3 Under Log Collection Enabled, do one of the following:
Click this option... To do this...
Yes Enable the collection of log messages.
No Disable the collection of log messages.
4 Click Apply.
Modifying the Log-File Rollover Period
My webMethods Server log files reside in the
/webMethods_install_dir/MWS/server/server_instance/logs directory. Periodically, the
logging process rolls over to a new set of files, making it easier locate a specific date and
time, and to discard old log files as needed. By default, the rollover occurs once a day at
midnight, but you can modify the rollover period from once a month to once a minute.
The directory structure for log files looks like this:
/logs/YYYY‐MM‐DD/Host/HH‐MM
Where this... Means...
YYYY The calendar year in which the rollover occurs.
MM The month in which the rollover occurs.
DD The day in which the rollover occurs.
Host The name of the machine on which the server is running.
HH The hour at which the rollover occurs.
MM The minute at which the rollover occurs.
If the default server is running on the machine myhost and the rollover occurs at midnight
on April 15th, 2005, log files are created here:
/webMethods_install_dir/MWS/server/default/logs/2005‐04‐15/myhost/00‐00
To change the log‐file rollover period, you need to modify a single line in this file:
/webMethods_install_dir/MWS/server/server_instance/config/logging.properties
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 180

To modify the log-file rollover period
1 Open the logging.properties file in a text editor.
2 Locate this portion of the file:
13. Analysis, Reporting, and Troubleshooting
# Sets the rollover pattern.
#It is possible to specify a rollover period from once a month to once a minute.
#log4j.rollover='.'yyyy-MM (Rollover at the beginning of each month)
#log4j.rollover='.'yyyy-ww (Rollover at the first day of each week.
# The first day of the week depends on the
# locale.)
#log4j.rollover='.'yyyy-MM-dd (Rollover at midnight each day.)
#log4j.rollover='.'yyyy-MM-dd-a (Rollover at midnight and midday of each
day.)
#log4j.rollover='.'yyyy-MM-dd-HH (Rollover at the top of every hour.)
#log4j.rollover='.'yyyy-MM-dd-HH-mm (Rollover at the top of every minute.)
#Modify the following line by copying and pasting from the examples in the
#preceding lines.
log4j.rollover='.'yyyy-MM-dd
3 Replace the date‐and‐time portion of the log4j.rollover statement with one from
the example statements in the preceding lines.
For example, to cause log‐file rollover to occur at the top of every hour, change the
statement from this:
to this:
log4j.rollover='.'yyyy-MM-dd
log4j.rollover='.'yyyy-MM-dd-HH
Do not include the descriptive comments that accompany the example statements.
4 Restart the server.
Viewing Logging Messages
Changes to the logging.properties file do not take effect until the server is restarted.
The View Logging Messages page allows you to search for the occurrence of log messages
that have been collected by the Logging Collector. In the View Logging Messages page,
you can set search criteria, view the messages, and clear the search index.
You can only search for log messages that have already been collected. For the View
Logging Messages page to be useful, you need to make sure you are collecting the right
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 181

13. Analysis, Reporting, and Troubleshooting
messages for your needs. Use the Logging Configuration page to set message collection
criteria:
In this panel... Do this...
Logging Threshold Make sure the threshold settings in the Category Threshold
column are set low enough that your messages are not
discarded before they reach the Logging Collector. See
“Setting Logging Thresholds” on page 178.
Logging Collector Make sure the collector is enabled and that the threshold is set
low enough that your messages are collected. See “Setting the
Collector Threshold for View Logging Messages” on page 179.
You can manage the search engine used for logging searches using the Search
Administration page that can be found in the Content folder of the Administration
Dashboard. See “Managing the Search Engine” on page 217.
Using the Search Logged Messages Panel
Use the Search Logged Messages panel of the View Logging Messages page to set the
criteria and initiate log searches.
To search for log messages
1 As system administrator:
Administration > Analysis > View Logging Messages > Search Logged Messages.
2 Use the search fields provided to set criteria for your log‐message search:
Search field Description
Priority Threshold From the list, select the lowest log‐level of messages to be
included in the search. Valid levels are INFO, WARN, and
FATAL. You can also choose to have no level selected.
Log Category From the list, select a log category to be included in the
search.
Log Message Type the text of the log message to be included in the
search.
Host Type the name of the host on which the server is running.
Timestamp Range The two fields in Timestamp Range allow you to select
beginning and ending days from which to search. Click
the Select Date / Time icon to display a calendar, and then
choose a date.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 182

Search field Description
13. Analysis, Reporting, and Troubleshooting
Stack Trace Type a stack trace to be included in the search.
Thread Type a thread to be included in the search.
3 In the Maximum Results list, choose the maximum number of log messages to be
displayed. The default is 100 messages.
4 In the Match Criteria list, choose one of these criteria:
This criterion... Does this...
All Fields (Default) Causes the search engine to include only those
messages that match all search fields in which you have
entries.
Any Fields Causes the search engine to include a log message that
matches any of the search criteria you have selected.
5 To start the search, click Search.
The search results appear in the View Logged Messages panel, which appears only when
you conduct a search.
Using the Manage Search Index Panel
Use the Manage Search Index panel of the View Logging Messages page to remove all log
messages that have been collected by the Logging Collector.
To remove log messages from the Logging Collector
1 As system administrator:
Administration > Analysis > View Logging Messages > Manage Search Index.
2 Click Click here to clear the logging search index.
The Logging Collector removes all collected log messages and displays the Search
Logged Messages panel.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 183

Monitoring Real-Time User Activity
13. Analysis, Reporting, and Troubleshooting
The Session Monitor page can be used to monitor real‐time user activity for a server
deployment and send status messages to active users by means of E‐mail. For active users,
a system administrator can accomplish two important functions:
� view a user’s profile information
� send the user E‐mail directly from within this page
To view all active server sessions
1 As system administrator:
Administration > Analysis > Session Monitor.
2 (Optional) On the list of active sessions, click a user’s name to view that user’s profile.
3 (Optional) On the list of active sessions, click E-mail this Page.
If you have an E‐mail client installed on the machine you are working on, an E‐mail
message window is displayed allowing you to compose and send an E‐mail to the
selected user. If the user does not have a valid E‐mail address in User Information, the
To field is empty.
Collecting Data about Server Events
The Events Collector page collects data about events on the server so they can be used by
other pages.
When deployed on a server, the Events Collector page captures information about certain
types of server events and places them in the server database.
� Login and logout.
� Get events, such as when a user browses a page.
� Operation events, such as when an object is created, updated, moved, or deleted.
For each event captured, the page collects information on the user associated with the
event, the date and time of the event, the host name of the machine, and where possible,
information about the operation being performed.
To take advantage of data collected by this page, another page performs a query against
the server database and then displays the results on a page. Assuming that samples have
been included in the installation of My webMethods Server, you can find examples of
pages that perform these queries in the
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 184

13. Analysis, Reporting, and Troubleshooting
webMethods_install_dir/MWS/samples/analysis directory. To try one or more of these
pages, you need to take the following actions:
This function... Described here...
Deploy the Events Collector page and the
sample pages on the server.
Sample pages include portlet source code so you can import the portlets into webMethods
Designer and see how they function. An example of the database schema used by the
Events Collector page for placing data into the server database appears in “Events
Collector Database Schema” on page 186.
Deploying the Events Collector Page
“Deploying the Events Collector Page” on
page 185.
Configure the Events Collector page “Configuring the Events Collector
Configuration Page” on page 185
Populate a page with the sample portlets
that display server events
The Events Collector page is part of a standard My webMethods Server installation but is
not deployed by default. Before you can use the page, you must first deploy it on the
server.
To deploy the Events Collector Configuration page on a server
“Creating and Modifying Pages” on
page 297.
1 Locate the Events Collector Configuration page at this location in the My
webMethods Server directory structure:
/webMethods_install_dir/MWS/components/extras/analysis/
wm_eventscollector.pdp
2 Copy the wm_eventscollector.pdp file and paste it into the Deploy directory:
/webMethods_install_dir/MWS/server/server_name/deploy
where server_name is the name of the server. After a few seconds, the page is
automatically deployed on the server.
Configuring the Events Collector Configuration Page
By default, the Events Collector Configuration page is ready to begin collecting data on
events as soon as you deploy it, but you may want to change how long data is kept, or to
disable the page.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 185

To configure the Events Collector Configuration page
1 As system administrator:
Administration > Analysis > Events Collector Configuration.
13. Analysis, Reporting, and Troubleshooting
Note: If you cannot find the Events Collector Configuration page in the Analysis
folder, it may not be deployed. See “Deploying the Events Collector Page” on
page 185.
2 Use the Collection Enabled check box to control data collection by doing one of the
following:
Do this... To have this effect...
Select the check box Enable the collection of server event data. Data collection
is enabled by default.
Clear the check box Disable the collection of server event data.
3 In the Keep Data for list, select how long to keep server event data.
Choices range from One Day to One Year. The default is One Month.
4 Click Apply.
Events Collector Database Schema
The Events Collector page uses the following database schema. Examples of queries used
against these tables appear in webMethods_install_dir/MWS/samples/analysis.
tblwEvents (main table where events data is being collected)
idEvent - Primary key
idType - Foreign key to tblwEventTypes. Stores the type of an event.
idHost - Foreign key to tblwEventHosts. Stores the host where the event occurs.
timestamp - Time stamp of an event, defined as the number of milliseconds since epoch
(java.lang.System.currentDateMillis()).
userID - Database ID of the user who performed an operation.
thingID_1 - object_1. For example, for Get type events this is the database ID of the object
being viewed.
thingID_2 - object_2. Used in rare cases where two objects are involved, for example when an
object is created. Then object_1 is the database ID of the container, and object_2
is the database ID of an object that was created.
action - Used for Login events: 1 – user logged in, 2 – user logged out.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 186

tblwEventHosts (stores mapping between hostID and hostname)
idHost - Host id.
hostname - Actual host name where the event occurs.
tblwEventTypes (stores mapping between eventID and eventTypeName)
idType - Event type ID.
eventType - Event type name.
13. Analysis, Reporting, and Troubleshooting
Possible eventType name values:
com.webmethods.portal.event.add.impl.CreateEvent - New object is created.
com.webmethods.portal.event.impl.GetEvent - Object is being browsed.
com.webmethods.portal.event.system.impl.LoginEvent - User logs in/out.
com.webmethods.portal.event.modify.impl.UpdateEvent - Object is updated.
com.webmethods.portal.event.remove.impl.DeleteEvent - Object is deleted.
Capturing Server Environment Diagnostic Information
If you need help from Software AG Customer Care in troubleshooting problems with My
webMethods Server, you will likely be asked to supply information about the server
environment. Software AG provides a tool that captures information about the My
webMethods Server configuration along with a set of log files, and writes it to a .zip file
you can attach to E‐mail. If you collect this information before you contact Customer Care,
it can speed up the resolution of your problem.
You run the My webMethods Server environment capture tool from the command line.
The tool captures information regardless of whether the server instance is running or not.
To capture My webMethods Server environment diagnostic information
1 At a command line prompt, type the following command to move to the My
webMethods Server env_capture directory:
cd webMethods_install_dir/MWS/tools/env_capture
2 Run the run.bat or run.sh script, appending it with the server name, as shown in the
example below:
> run -s server_name
where server_name corresponds to the name of the My webMethods Server instance.
For example:
> run -s default
The environment capture tool creates this file:
webMethods_install_dir/MWS/tools/env_capture/portal‐env.zip
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 187

13. Analysis, Reporting, and Troubleshooting
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 188

Chapter 14. My webMethods Server Configuration
� Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
� Managing Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
� Configuring External Configuration Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
� Deploying My webMethods Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
� Managing Server Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
� Setting up Single Sign-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
� Displaying System Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 189

Overview
Managing Aliases
14. My webMethods Server Configuration
My webMethods Server provides administrators with a number of tools that can be used
to help configure your server. You perform these functions after installing and
configuring a default server instance. This chapter provides detailed instructions on how
to use the My webMethods Server Configuration tools to configure your My webMethods
Server deployment.
The Alias Management page lets you manage URL aliases as server objects. With this
page, you can create, view, modify, or delete custom URL aliases and create more friendly
URLs for various parts of your server.
For example, if you want to create an area of the server for the Sales Department, and you
have already created a folder for the Sales team in your server’s Public Folders, it might be
referenced by a non‐intuitive URL such as:
http://server/meta/default/folder/0000002216
To make it easier for the Sales team to remember the location of the Sales server, you can
use the Alias Management page to create a more user friendly URL such as:
http://server/Sales
You can perform the following functions within the Alias Management page:
This function... Is described here...
Create a new alias “Creating an Alias to a Server Resource” on page 191
Search for aliases “Searching for Aliases” on page 192
Save alias searches “Using Saved Alias Searches” on page 194
Modify the target server “Modifying an Alias to Point to a Different Server
resource for an alias Resource” on page 194
Delete an alias “Deleting an Alias” on page 195
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 190

Creating an Alias to a Server Resource
14. My webMethods Server Configuration
There are two ways to create an alias for a server resource. The first way to create an alias
is on the Properties page of the server resource:
To create an alias to a server resource on the Properties page
1 As system administrator, navigate to the page where the server resource is located.
2 On the server resource, click Tools and then click Properties.
3 On the Alias field of the Properties page, click Add.
4 Type an alias name for the server resource and click OK.
Do not include spaces in your alias name, or the alias will not function properly.
5 Click Apply.
The second way to create an alias for a server resource is on the Alias Management page:
To create an alias to a server resource on the Alias Management page
1 As system administrator:
Administration > Configuration > Alias Management.
2 Click Create.
3 In the Alias Name field, type the name for the new alias you want to create (such as
Sales).
Do not include spaces in your alias name, or the alias will not function properly.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 191

14. My webMethods Server Configuration
4 In the Target panel, select a target for the new alias by doing one of the following:
If you want to... Do this...
Target a server resource Select the Resource option and then click
Browse. Move the resource (folder, item, or
portlet) to the Selected Items box and click
Select.
5 Click Add Alias.
6 Confirm that your alias behaves as expected by browsing to the user‐friendly URL for
your new alias.
By default, when you create an alias, it is appended to the root URL for your server.
For example, if you create an alias called Sales, you can access the new alias by typing
the URL http://server:port/Sales.
Searching for Aliases
You can use the Alias Management page to search for existing aliases. The page places
search results in a list from which you can modify or delete aliases, or view target
resources.
Performing a Simple Alias Search
To search for aliases, use the following procedure.
1 As system administrator:
Administration > Configuration > Alias Management > Search.
Note: To pass parameters or invoke a server
command on the resource the alias references,
click the Append this string option, and then
append the string portion of the alias.
Target an external resource Select the Path option. In the Path box, type the
path to the resource. For example,
http://www.webmethods.com
Tip! In the alias search field, you can use a single wildcard character (*) to substitute for
text anywhere within the name.
To perform a simple search for aliases
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 192

2 Type the name of the alias you want to find.
14. My webMethods Server Configuration
To specifically include or exclude system aliases from search criteria, see “Specifically
Including or Excluding System Aliases” on page 193.
3 Click Go.
All aliases that match the search appear in a table.
Specifically Including or Excluding System Aliases
To include or exclude system aliases during a search, use the following procedure.
To include or exclude system aliases during a search
1 As system administrator:
Administration > Configuration > Alias Management > Search.
2 Type the name of the alias you want to find.
3 Click Refine.
4 In the Include System Aliases list, choose one of the following:
Choose this... To do this...
Yes Include system aliases in the search
No Exclude system aliases from the search
5 Click Go.
6 To close the refined search panel, click Close.
Performing an Advanced Alias Search
To perform an advanced search for aliases, use the following procedure.
To perform an advanced search for aliases
1 As system administrator:
Administration > Configuration > Alias Management > Advanced.
2 Type the name of the alias you want to find.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 193

3 Modify any or all of the following search criteria:
Search criteria Actions
4 Click Go.
Using Saved Alias Searches
14. My webMethods Server Configuration
System aliases In the Include System Aliases list, choose one of the following:
Search for a
target resource
Choice Action
Yes Includes system aliases in the search
No Excludes system aliases from the search
For the Alias Target panel, do one of the following:
Browse Move the target resource to the Selected Items box
and click Select.
Use Alias In the Alias Name field, type the alias of the target
resource. Click Test to determine if the alias is valid
and the alias target is the correct one. If the alias is
correct, click Select.
You can save an alias search for regular use. The techniques for using saved alias searches
is similar to those described in “Using Saving Searches” on page 78, except they are
performed from this location:
As system administrator:
Administration > Configuration > Alias Management.
Modifying an Alias to Point to a Different Server Resource
To modify an alias to point to a different server resource, follow these steps:
To modify an existing alias to point to a different server resource
1 As system administrator:
Administration > Configuration > Alias Management.
2 Use the Alias Search panel to find the alias you want to modify.
3 In the search results, click Edit for the alias to be modified.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 194

14. My webMethods Server Configuration
4 In the New Target panel, select a new target for the alias by doing one of the following:
If you want to... Do this...
Target a server resource Select the Resource option and then click
Browse. Move the resource (folder, item, or
portlet) to the Selected Items box and click
Select.
5 Click Update.
Deleting an Alias
To delete an alias, use the following procedure.
1 As system administrator:
Administration > Configuration > Alias Management.
2 Use the Alias Search panel to find the alias you want to modify.
3 In the search results, click Edit for the alias to be deleted.
4 In the search results, select the check boxes beside the alias you want to delete, and
click Delete.
Configuring External Configuration Credentials
Note: To pass parameters or invoke a server
command on the resource the alias references,
click the Append this string option, and then
append the string portion of the alias.
Target an external resource Select the Path option. In the Path box, type the
path to the resource. For example,
http://www.webmethods.com
To delete an existing alias
The HTTP Header Authentication Administration page allows system administrators to
configure My webMethods Server to accept external HTTP authentication credentials
from third party security and access control products such as SiteMinder (Computer
Associates) or Oblix. These credentials are case‐sensitive and, depending on the platform
and Web server, will most likely be sm_user or SM_USER.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 195

Enabling Authentication
14. My webMethods Server Configuration
Important! The HTTP Header Authentication Administration page should only be enabled
if you are using a third‐party security provider. After the page is enabled, the server acts
as though all users have been authenticated.
To accept authentication from a third party security and access control product
1 As system administrator:
Administration > Configuration > HTTP Header Authentication Administration.
2 For User Header Name, type sm_user or SM_user.
3 Select the Enable HTTP Header Authentication check box.
4 If appropriate, in the Logout URL field, type the URL to which the user is redirected
after logging out of the server.
5 Click Submit.
6 Configure the third party security and access control software as directed in your
vendor’s product documentation.
Note: To properly configure an external security and access control product, both My
webMethods Server and the third party product must point to the same directory
server instance (SunOne, Active Directory, or ADAM).
Checking Logs for HTTP Header Authentication Problems
If you are having a problem in getting HTTP Header authentication on to work properly,
you can check log files to assist in diagnosing the problem. Log messages for HTTP
Header authentication are assigned to the portalLogin category. Before you can display
HTTP Header authentication logging messages, you need to change the logging threshold
values. The default thresholds for writing to the console, the _full.log file, and the
portalLogin.log file are set to the INFO log level but HTTP Header authentication logging
messages use the DEBUG log level, which is lower.
Server log files reside in the /webMethods_install_dir/MWS/server/server_instance/logs
directory. For information on controlling the collection of logs, see “Controlling Server
Logging” on page 178. For information on searching for log messages, see “Viewing
Logging Messages” on page 181.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 196

Setting Login Logging Thresholds
14. My webMethods Server Configuration
You need to set both the category and output settings to DEBUG if you want the logging
messages to be written to the output. For information on setting logging thresholds, see
“Controlling Server Logging” on page 178.
To set category and output thresholds for HTTP Header authentication
1 As system administrator:
Administration > Analysis > Logging Configuration > Logging Thresholds.
2 In the Category Threshold list, select the DEBUG log level for any or all of the following
logging categories:
Logging category Controls output for...
root The console and the _full.log file
portalLogin The portalLogin.log file
3 In the Output Threshold list, select the DEBUG log level for any or all of the following
logging output types:
Logging output Controls output for...
Console Logging messages sent to the console
_full.log Logging messages sent to the _full.log file
portalLogin Logging messages sent to the portalLogin.log file
4 Click Apply.
Checking HTTP Header Authentication Logs for Problems
With HTTP Header authentication enabled, the server acts as though all users have been
authenticated. With this in mind, the log messages will reveal one of three likely
outcomes, as described in the following sections.
The Login is Successful
Messages for a successful login using HTTP Header authentication look similar to the
following example:
Date_and Time (portalLogin : DEBUG) - HttpHeaderHandler Auth Handler
looking for: user_name
Date_and Time (portalLogin : DEBUG) - Found userID: user_name
where user_name is the name of the user who logged in under HTTP Header
authentication.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 197

HTTP Header Authentication is Disabled
14. My webMethods Server Configuration
If you have not enabled HTTP Header authentication, the log message looks similar to the
following example:
Date_and Time (portalLogin : DEBUG) - HttpHeaderHandler Auth Handler is
not enabled
To enable HTTP Header authentication, see “Enabling Authentication” on page 196.
The Problem Rests with the Third-Party Site
If the third‐party site is not configured correctly, HTTP Header authentication will fail.
The resulting log message looks similar to the following example:
Date_and Time (portalLogin : DEBUG) - HttpHeaderHandler Auth Handler
looking for:
Date_and Time (portalLogin : DEBUG) - No value found!
Deploying My webMethods Server Components
System administrators have the following options available to them when installing
server components, such as portlets or DBOs, on a server.
� Through the Install Administration page on the Administration Dashboard.
� Through the Deploy folder on the server’s File System. This folder allows system
administrators and developers to copy or paste a newly developed portlet package
(such as a portlet, DBO, or deployable package) into a specific directory that is
periodically polled by the server. If the server detects new deployable components in
this folder, these components are automatically retrieved and installed on the server.
You have the option to configure the polling interval that specifies how often the
server will poll the Deploy directory to detect any new components.
You can perform the following functions within the Datasource Administration page:
This function... Is described here...
Modify the polling interval used in
deploying portlets to a server
Install a portlet using the Deploy folder
for a server
“Modifying the Polling Interval” on
page 199
“Installing a Portlet Using the Deploy
Folder” on page 200
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 198

This function... Is described here...
Install a portlet or other deployable
component using the Install
Administration page
Modifying the Polling Interval
14. My webMethods Server Configuration
If your organization is developing multiple portlets, this installation method may be more
convenient than manually installing portlets one at a time. The default file system location
for the Deploy folder is /webMethods_install_dir/MWS/server/server_instance/deploy
1 From the server root install directory, navigate to the following location:
/webMethods_install_dir/MWS/server/server_instance/config
2 Open the phaseProvider.xml configuration file in a text editor or equivalent XML
editing facility. Locate the following XML fragment:
3 To turn polling off, change the enabled attribute from true to false.
4 To change the polling interval, modify the interval attribute to the desired value. The
default setting is 5 seconds.
5 Save the file.
6 Restart your server instance.
“Installing Portlets or Other Deployable
Server Components” on page 200
Uninstall a server component “Uninstalling Server Components” on
page 201
Note: Polling can be turned on or off by modifying the PhaseProvider.xml
configuration file on the serverʹs file system. Use the following instructions to modify
the polling interval.
To modify the polling interval
Note: This setting will not have an impact on overall performance
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 199

Installing a Portlet Using the Deploy Folder
14. My webMethods Server Configuration
To use the Deploy folder to install a portlet on a server, do the following.
To install a portlet using the Deploy folder
� Copy and paste the server component(s) that you want to deploy into the deploy
directory.
The server will fire an event every five seconds that polls this folder, so no further
action is needed.
Note: If any server component fails to deploy, the server will automatically create a
Failed directory on the server’s file system in the Deploy folder. All components that
do not install properly will be copied into the Failed directory.
Installing Portlets or Other Deployable Server Components
To use the Install Administration page to install portlets or other deployable server
components, do the following
To install a portlet or other deployable server component
1 As system administrator:
Administration > Configuration > Install Administration.
2 Select the Install option and click Next.
3 Choose Local or Network Location or Remote Location.
4 Type the complete path to the component you want to install if you are installing from
a remote location (such as FTP, HTTP), or click Browse and navigate to the deployable
component you want to install if it resides on your local file system.
5 Click Next.
6 Review the Component Info Summary and then click Install.
If the component is installed successfully, you will get a confirmation message
verifying that the install succeeded.
Note: If a component install fails, that component is automatically uninstalled. Be sure
to check your log files to troubleshoot the installation failure.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 200

Uninstalling Server Components
14. My webMethods Server Configuration
Before you uninstall a component, determine how its removal will affect all of its
instances on a user’s page. Uninstalling will break any page that contains specific portlet
instances of the portlet that was uninstalled, and disrupt any portlets that may be wired to
that portlet using the portlet wiring feature.
For example, you are not warned about wiring relationships when removing a portlet that
is wired to another portlet.
You may want to change the portlet’s status property to Hidden or Disabled to phase out
the portlet before you uninstall it. After users are informed of the impending uninstall and
have removed it from their page, it will then be safe to uninstall it.
Important! When an uninstalled portlet’s instances are broken, it causes errors on each page
on which that portlet is being used. It also may remove the data for a portlet and its
instances, the configuration files, the portlet database tables, and the portlet packaging
files. Reinstalling will not restore the broken references caused by uninstalling a portlet.
To uninstall a component using the Install Administration page
1 As system administrator:
Administration > Configuration > Install Administration.
2 Select the Uninstall option and click Next.
3 Navigate to the component you want to uninstall, click the component, and click
Uninstall.
Managing Server Objects
The Manage Components page allows system administrators to globally configure and
manage how server objects, called Extended Types or Dynamic Business Objects (DBOs),
are made available to end users. Extended Types (DBOs) are server objects that are created
from existing base level server objects such as content, folders, pages, forms, links, and
portlets.
The Manage Components page allows system administrators to configure the default
properties and permissions for all Extended Types, regardless of whether they are
installed as part of the regular server installation process, or are created by a developer
using Designer and installed at a later date.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 201

14. My webMethods Server Configuration
You can perform the following functions within the Manage Components page:
This function... Is described here...
Configure the properties of managed
components
Configure permissions for managed
components
Configuring Properties for Managed Components
To configure properties of managed components, do the following.
To configure properties using the Manage Components page
1 As system administrator:
Administration > Configuration > Manage Components.
“Configuring Properties for Managed
Components” on page 202
“Configuring Permissions for Managed
Components” on page 203
2 To modify the default Properties on a given DBO (content, folder, form, link, or
portlet) click on the link for the specific Extended Type you want to modify. This will
display a list of all descendents of that particular Extended Type.
For example, if you want to configure the default Properties on the Basic Folder
object, which is a descendent of the folder object, click on the folder link. This will
display a list of all Extended Types that are based on the folder object.
3 For the Extended Types (such as a Basic Folder) for which you want to modify
properties, click Tools, and select Properties.
This will display a list of properties for the Extended Type you selected earlier. At this
point, depending upon the type of Extended Type, you will have the option to
configure the default properties for that Extended Type instance.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 202

14. My webMethods Server Configuration
For example, if you want to modify the default properties for the Basic Folder
Extended Type, which is based on the Folder Extended Type, you have the option to
modify the following properties:
Status Property
This property allows you to define the default Status for all instances of this portlet
that are published to the server.
To set the default status for a given Extended Type (such as Basic Folder), select one
of the three options from the drop down menu.
Enabled Can run. Can publish.
Selecting this option means that end users can execute this
portlet and publish instances of this portlet. The portlet will
appear in Page Designer tool.
Hidden Can run. Cannot publish.
Selecting this options means that end users can execute this
portlet, but not publish instances of it. The portlet will not
appear in Page Designer tool.
Disabled Cannot run, cannot publish.
Selecting this option means that end users cannot run or
publish instances of this portlet. The portlet will not appear in
Page Designer tool.
Note: Developers who build portlets using Designer can configure additional Extended
Properties on portlets as they develop them. These properties are then made available for
further configuration using the Managed Components page.
Configuring Permissions for Managed Components
To configure permissions for managed components, do the following.
To configure permissions for Managed Components pages
1 As system administrator:
Administration > Configuration > Manage Components.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 203

14. My webMethods Server Configuration
2 To modify the permissions on a given Extended Type (content, folder, form, link, and
portlet) click on the link for the specific Extended Type you want to modify. This will
display a list of all instances of that particular Extended Type.
For example, if you want to configure the default Permissions on the RSS portlet,
which is based on the folder object, click on the folder link. This will display a list of
all Extended Type instances that are based on the folder object.
3 For the Extended Type instance (such as RSS Folder) that you want to modify, click
Tools, and select Permissions.
4 Make the appropriate changes to the default Permissions using the Permissions
Wizard and click Apply.
5 Click Done to return to the Manage Components page.
Setting up Single Sign-On
Single sign‐on is the ability for a user to log into one application and then use other
applications without having to log into each one separately. My webMethods Server
supports single sign‐on through the Security Assertion Markup Language (SAML), an
XML‐based framework for the exchange of security information. Using SAML, an entity
on a target computer grants access based on an assertion from the source computer that
the user is logged into the source computer. My webMethods Server can provide a single
sign‐on capability in the following ways:
� Between a source server and one or more target servers
� Between a server and other webMethods components that have single sign‐on
capability
� Between a server and a third‐party application that supports SAML
� Between a server, an Artifact Receiver that authenticates the user sign‐on, and a target
Web application
Using this model, one server is the source, providing a central login for users. Links on
pages on the source server point to any number of SAML‐capable entities. The target
entities all point back to one source server. If the target is another server, that server can
accept SAML assertions from only one source.
To take advantage of single sign‐on, a user must be known on both the source server and
the target entity. In most cases, common knowledge of a user is provided by use of the
same directory service.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 204

14. My webMethods Server Configuration
Configuring a Server as a Target for Single Sign-On
A server can be a target for only one single sign‐on source at a time.
To configure a server to be a target for single sign-on
1 As system administrator:
Administration > Configuration > SAML Authentication Administration.
2 Modify Properties as follows:
For this property... Do this...
Artifact Parameter
Name
Security Provider
URI
3 Click Submit.
Once submitted, the server will accept SAML assertions from the specified source entity.
Setting SAML Links on a Source Server
On any page, you can add a link to a SAML target entity, such as a server. If the target
accepts SAML assertions from the source server, when a known user clicks the link, no
login credentials are required. If the target entity does not accept SAML assertions from
the source server, or if the user is not known on the target entity, login credentials may be
required.
Under the SAML specification, an intermediary called an artifact receiver can perform
authentication on behalf of the target Web application. In such a case, the SAML source
requires two URLs: one for the Artifact Receiver and one for the target Web application.
You can place one or more SAML links on any page you have permission to edit.
To create a SAML link on a source page
If this is a SAML connection with another webMethods server,
do not change the default value SAMLart. If this is a SAML
connection to a third‐party source, type the artifact parameter
name used by the third‐party application.
Type the URI of the SAML security provider (source). If this is
a connection with another webMethods server, use this syntax:
server_name:port/services/SAML
where server_name is the host where the source server is
running and port is the server port number. The default port
number is 8585.
1 In the upper right‐hand corner of the page, click Tools > Edit Page.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 205

2 In the Root list of the Available Portlets panel, click Links.
14. My webMethods Server Configuration
3 In the Links list of the Available Portlets panel, drag the Single Sign-on Link portlet and
drop it onto the page at the location where you want to add the link.
A red box appears beneath the cursor location whenever the cursor is over a valid
page location, indicating where the portlet would be positioned if you released the
mouse button.
4 On the left side of the page control area, click Save.
5 At the right edge of the title bar for the single sign‐on portlet, click Tools >
Properties.
6 In the Properties page make modifications as appropriate:
Make changes here... If you want to...
Name Replace Single Sign-on Link with the text that
is to go with the link.
SAML Authentication URL Type the URL for a resource on the target
computer. The target can be any page on a server.
If you are connecting to a Web application
through a SAML Artifact Receiver, use this field
for the Artifact Receiver URL.
Use POST or GET Determines the method used to pass data to the
target computer.
POST Passes data to a gateway program’s
STDIN. POST, the default, is the
preferred method for single sign‐on
data.
GET Passes data as a string appended to the
URL after a question mark.
Artifact Parameter Name If this is a SAML connection with another server
or other webMethods component, do not change
the default value SAMLart. If this is a SAML
connection to a third‐party source, type the
artifact parameter name used by the third‐party
application.
Application Target URL If you have typed the URL for a SAML Artifact
Receiver in the SAML Authentication URL field, type
the URL for a Web application. Otherwise, leave
this field empty.
7 Click Apply.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 206

Checking Logs for SAML Problems
14. My webMethods Server Configuration
If you are having a problem in getting single‐sign on to work properly, you can check log
files to assist in diagnosing the problem. Log messages for SAML are assigned to the
portalLogin category. Assuming logging thresholds are set to the default values, SAML
logging messages are written to the console, the _full.log file, and the portalLogin.log file.
Server log files reside in the /webMethods_install_dir/MWS/server/server_instance/logs
directory. For information on controlling the collection of logs, see “Controlling Server
Logging” on page 178. For information on searching for log messages, see “Viewing
Logging Messages” on page 181.
If the SAML Login is Successful
A message for a successful SAML login has an INFO log level and looks similar to the
following example:
Date_and Time (portalLogin : INFO) - SAML authenticated user: user_name
where user_name is the name of the user for whom the SAML authentication was
performed.
If the SAML Login Fails
A failed SAML notification has a WARN log level, contains an exception message, and
looks similar to the following example:
Date_and Time (portalLogin : WARN) - Failed SAML > authentication
com.webmethods.portal.PortalException:[POP.012.0002.wm_xt_samlsecurityservice]
The SAML artifact is invalid or has expired.
The stack dump that accompanies the exception message can help determine where the
authentication has failed.
Displaying System Information
The System Information page provides a wealth of information about the current state of
the server. The page gathers the information dynamically at the time you open each panel.
To display system information about the current state of the server
� As system administrator:
Administration > Configuration > System Information.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 207

14. My webMethods Server Configuration
The System Information page contains five panels. When you click a panel to bring it
to the front, the page dynamically collects the data for display:
Panel and Heading Description
Request/Response Information that is gleaned from the userʹs Web request.
Request Information Typical cgi‐bin parameters describing the requested path.
Request Headers Incoming HTTP headers.
Request Parameters Incoming HTTP parameters on the URL.
Request Attributes Attributes (objects) stored on the current request.
Response
Miscellaneous information, such as encoding and locale,
Information
gleaned from the request.
Session Misc
User session information.
Session Attributes Attributes (objects) stored on the user’s session.
Locale Information The current locale of the user.
Presentation Data Various information used to render requests for this user.
Session Attributes
Request Attributes
Application Attributes
Portlet Controller Session objects associated with this user.
Portlet Controller Request objects associated with this
userʹs request.
Information shared throughout the server (across all
users).
System Information Environment variables, such as Classpath, path, and so
forth).
Server Information Information about the current front‐end server.
Context Information Servlet object information.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 208

Chapter 15. Managing My webMethods Server Content
� Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
� Migrating My webMethods Server Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
� Managing Content Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
� Managing Subscriptions for Individual Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
� Managing Group Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
� Publishing Portlets as an Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
� Managing the Search Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 209

Overview
15. Managing My webMethods Server Content
My webMethods Server provides administrators with a number of tools that can be used
to help manage server content. This chapter provides detailed instructions on how to use
My webMethods Server tools to manage server content.
Migrating My webMethods Server Content
The Content Migration Wizard page enables system administrators to migrate server
content from one server instance to another, such as from development to staging to
production.
This page can be used to migrate the following types of server content: documents,
folders, external links, internal links (using aliases), pages (including layouts), portlets,
Dynamic Business Objects (DBOs), permissions, subscriptions, and portlet wiring
properties.
Content Migration Considerations
Content migration involves two distinct activities: exporting the content from the source
server instance, followed by importing the content on the target server instance. Before
performing these actions, consider the following:
� Migrating portlets and DBOs: If you are developing or installing any portlets on a
development server and want to migrate pages that contain instances of these
portlets, you must deploy them on the target server before migrating any pages or
published instances of the portlets that were developed or installed on the
development server instance.
� Migrating published content: Content published to the Content Management system can
be migrated from one server instance to another. If you are using your development
environment to configure permissions on items published to the content management
system, you have the option to migrate the permissions as well. To properly migrate
permissions and subscriptions associated with published content, see Migrating
permissions and subscriptions below.
� Migrating links: To properly migrate internal links with references to other objects, such
as a link from one page to another, create aliases for these links instead of using the
base URL.
For example, if you want to publish a link to an existing page, such as a Sales page
that has the following as its initial URL:
http://server/meta/default/folder/0000002132
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 210

15. Managing My webMethods Server Content
Create an alias that points to this URL, but has a more “friendly” URL such as the
following:
http://server/Sales
� Migrating permissions and subscriptions: To properly migrate permissions and
subscriptions from a source to target server instance, be sure that both servers are
pointing to the same directory services.
Migrating Server Content using Export/Import Processes
The following procedures describe the basic export/ import process for migrating content
from one server instance to another.
The examples that follow describe only one scenario for migrating from a development
server to a production server. You can also use webMethods Deployer, as described in the
webMethods Deployer Users Guide.
To export server content from a source development server to another target server instance
1 As system administrator:
Administration > Content > Content Migration Wizard.
2 Select Export and click Next.
3 Under the Exporting Properties heading enter an export name for the components you
want to export. For example, Sales.
4 Click Browse.
5 To select an item to export, move it to the Selected Items box and click Select.
6 If the item you want to export contains child folders, pages, content items, and so
forth, you can explicitly set the export depth.
The default value for this setting is ‐1, which means that all child items under the item
you selected in the preceding step will be exported. If you only want to export content
down to a specific child level, enter a value that corresponds to the number of child
levels that you want to export.
7 (Optional) Select the Create Auto Deployable Component option if the server resource is
intended to be an auto‐deployable component.
This option is intended for auto‐deployable components, which are automatically
retrieved and installed on the server when you place them in the Deploy directory for
the server. When imported, auto‐deployable components install only in the parent
container from which they were exported.
8 (Optional) Select the Export Content (Documents) option to include content items that
may have been published within the folder you want to export.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 211

15. Managing My webMethods Server Content
9 (Optional) Select the Export Access Control Lists option if you want to export all
permissions that may have been set on the folder, or items published within the folder
you are exporting.
10 (Optional) Select the Export Subscriptions option if you want to export all subscriptions
that may have been set on the folder or items published within the folder you are
exporting.
11 Click Next.
12 To complete the export procedure, click Save.
To import server content on a target server instance
Note: If you are importing content with pages that have portlets and/or DBOs that
were created and deployed to your development server (source), you must deploy the
portlets and/or DBOs before you use the following import procedures.
Note: The export archive you created in the previous instructions contains a .zip file
extension. You must remove the .zip file extension before using the following Import
procedure. For example, if the Export process generates the file SalesExport.cdp.zip,
you would rename the file to SalesExport.cdp.
1 As system administrator:
Administration > Content > Content Migration Wizard.
2 Select the Import option and click Next.
3 For Install Destination, click Browse and select a destination folder for content import. To
import the content to a location on your target server that is referenced by an alias,
you can optionally click Use Alias to select an existing alias on your target server.
Note: If the export archive was created with the Create Auto Deployable Component option
selected, the Content Migration wizard ignores the selected install destination and
installs the component in the parent container from which it was exported.
4 For the Install Component, click Browse to locate the export archive you want to import,
such as on your file system.
5 Click Next.
Tip! If you run into problems, don’t forget to check the webMethods Advantage Web
site. See “Troubleshooting Information” on page 13.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 212

Managing Content Storage
15. Managing My webMethods Server Content
The Content Service page allows system administrators to manage the storage locations
available for content published to the server, which is physically stored in the locations
configured in the content service. It typically resides on a separate file server for backup
and redundancy purposes.
To configure a new Content Service for the server repository
1 As system administrator:
Administration > Content > Content Service > Create New Content Service.
2 In the Service Name field, type a name for your new content service.
The user ID can be 1 through 255 characters and can contain only alphanumeric ASCII
characters with no spaces.
3 From the Type list, select one of content service types and click Next.
4 Depending on your choice of content service type do the following:
If you choose File System, type a physical storage location for your content service.
Valid locations include the following types of network paths:
� file:\\y:\ (where y:\ is a mapped network drive to an external file server)
� f:\repository (where f:\ repository is a separate hard drive on the server
machine)
Note: There are many ways to configure an external content repository for My
webMethods Server. The two examples here assume that your network administrator
has provided the proper security settings to allow the server to access a network
shared on a separate file server.
—OR—
If you choose Ftp, do the following:
a In the Location field, type a valid FTP server name.
b In the User name field, type a user name valid on the FTP server.
c In the Password field, type the password associated with the user name.
5 Click Apply.
6 To make the new content service the default content service, click Tools and then
click Set As Default.
The new Content Service becomes the default location for storing new content that is
published to the server.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 213

To import content from an existing content service
1 As system administrator:
Administration > Content > Content Service > View Content Services.
15. Managing My webMethods Server Content
2 Locate the content service into which you want to migrate the contents of an existing
content service, click Tools and then click Import Content.
3 For the Target Folder property, do one of the following:
Click this... And do this...
Browse Move the target page to the Selected Items box and click Select.
Use Alias In the Alias Name, type the alias of the page to which the user
should be redirected. Click Test to determine if the alias is valid
and the alias target is the correct one. If the alias is correct,
click Select.
4 Click Import.
To set the maximum file size for content published to the server repository
1 As system administrator:
Administration > Content > Content Service > Set Max File Size.
2 In the Size (MB) field, type a maximum publish size (in Megabytes).
3 Click Apply.
Managing Subscriptions for Individual Users
The Manage Subscriptions page allows system administrators to view existing
subscriptions within the server. It allows an administrator to view subscriptions for a
given user, resource, group, or group subscription created by any given user.
To view or modify subscriptions for a specific user
1 As system administrator:
Administration > Content > Manage Subscriptions > View Subscriptions for a Specific User.
2 Move the user to the Selected Items box and click Select.
3 (Optional) If you want to modify the subscription rules for a subscription, click the
subscription, select or clear checkboxes as desired, and then click Apply.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 214

15. Managing My webMethods Server Content
4 (Optional) If you want to delete one or more subscriptions for a given user, select the
user subscription from the list by selecting the corresponding check box and click
Delete Selected.
Managing Group Subscriptions
The Group Subscriptions page allows system administrators to create subscriptions for
groups exposed by the underlying user directory (such as LDAP or ADSI). Use this page
to create new group subscriptions and manage existing subscriptions.
To configure a new group subscription
1 As system administrator:
Administration > Content > Group Subscriptions > Create New Group Subscription.
2 To configure a subscription for a group, move the server resource (file, folder, portlet,
or page) to the Selected Items box and click Select.
3 Move the group you want to subscribe to the resource to the Selected Items box and
click Select.
4 Define your subscription rules by selecting or clearing check boxes as desired and
click Create.
Note: The subscription rules that are available depend on the type of resource to which
you are subscribing. For example, subscriptions on folders have slightly different
subscription rules than a Content item has.
To view or modify group subscriptions that you have created
1 As system administrator:
Administration > Content > Group Subscriptions > View Group Subscriptions I’ve Created.
2 Click the name of the subscriber group that you want to change.
3 Change rules by selecting or clearing checkboxes as desired, and then click Apply.
4 (Optional) If you want to delete a group subscription, select the group subscription
from the list by selecting the corresponding check box and click Delete Selected.
To view all subscriptions for a given group
1 As system administrator:
Administration > Content > Group Subscriptions > View Subscriptions for a Given Group.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 215

15. Managing My webMethods Server Content
2 To select the group whose subscriptions you want to view, move the group to the
Selected Items box and click Select.
3 (Optional) If you want to modify the subscription rules for a given subscription, click
on the subscription, change the rules by selecting and clearing checkboxes as needed.
Click Apply.
4 (Optional) If you want to delete one or more subscriptions for a given group, select
the group subscription from the list by selecting the corresponding check box and
click Delete Selected.
Publishing Portlets as an Administrator
The Publish page provides system administrators with expanded publishing capabilities
that are generally not exposed to most users. The Publish page allows administrators to
publish many different types of content such as files, folders, forms, links, and specific
portlet instances. You can also publish custom content types such as Dynamic Business
Objects or Custom Forms can also be published from this page.
To publish content using the Publish page
1 As system administrator:
Administration > Content > Publish.
2 Select the corresponding option for the content type you wish to publish. The default
options are: File, Folder, Form (for DBOs only), Link, and Portlet.
3 For a given content type, select one of the options from the drop down menu.
Note: If you previously created any custom objects that are based on any given content
type, they will now show up as options in the drop down menu for the respective
content type. As an example, the RSS Feed option under the Folder content type is a
Dynamic Business Object. It was created to extend the Folder object type with custom
attributes and business logic for publishing RSS syndicated news feeds to a folder
object type.
4 Click Next.
5 From the Location heading, click Browse to select a parent folder location for the
content item you are publishing.
Note: You can optionally click Use Alias if you want to publish the content item to a
location that is referenced by an existing alias.
6 Click Next.
7 Enter a name for the content item you are publishing.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 216

15. Managing My webMethods Server Content
8 (Optional) Enter a description for the content item you are publishing.
9 Depending on the type of content you are publishing, fill in any Extended Properties
for the given content type (such as. RSS Feed URL for an RSS Feed content item).
10 Click Next.
11 Click Finish.
Managing the Search Engine
The Search Administration page allows system administrators to manage the Lucene
search engine that is offered with My webMethods Server (the link is
http://lucene.apache.org/java/docs/gettingstarted.html) and the logging search engine in
the View Logging Messages in the Analysis folder of the Administration Dashboard (see
“Viewing Logging Messages” on page 181).
There are two primary search engine management functions that system administrators
can execute from this page:
� Resynch Search Index
� Optimize Search Indexes.
If the search engine becomes corrupted, you may need to reload it, described in
“Reloading the Default Search Engine” on page 218.
Resynchronyzing the Search Indexes
Executing the Resynch Indexes command will re‐index all content that was previously
published to the server and update the default search indexes again. A system
administrator might need to do this if the search index somehow becomes corrupted and
search stops working.
In the case where the default search index is corrupted, a system administrator has the
option of running the Resync Indexes command, which will rebuild the indexes from
scratch.
Tip! If your server has a lot of content published to the content management system, this
operation may take a long time to run. You should run this operation at off‐peak hours.
To resync the search indexes
1 As system administrator:
Administration > Content > Search Admin.
2 For either search engine, click Tools and then click Resync Indexes.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 217

Optimizing the Search Indexes
15. Managing My webMethods Server Content
With the Lucene search engine, the number of files that are stored in the libraries data
folder on the file system that are used for the index can grow over time as more content is
added to the search index. This file is opened every time a search request comes into the
system, and each file in the data folder requires an additional open file handle. If the
number of files grows too large, you may receive an error message related to having too
many files open.
To avoid this error, system administrators can execute the Optimize Indexes command,
which will attempt to take all of the segments in the index and merge them together. This
will reduce the number of files back to a manageable level, thus optimizing the
performance of the embedded search engine.
To optimize the search indexes
1 As system administrator:
Administration > Content > Search Admin.
2 For either search engine, click Tools and then click Optimize Indexes.
Reloading the Default Search Engine
If the search engine configuration somehow becomes corrupted, you have the option of
reloading the default search engine configuration in an attempt to fix any corrupt
configuration settings. During the initial server startup, the search service reads the
configuration information from the wm_portalsearch portlet and copies that information
to the corresponding information fields on the search service. On subsequent server
startups, the configuration is loaded directly from the server’s underlying database.
To reload the search configuration
1 Locate the wm_portalsearch portlet at this location:
/webMethods_install_dir/MWS/components/services/search/
wm_portalsearch.pdp
2 To deploy the wm_portalsearch.pdp file, copy it and then paste it into the deploy
directory for the server:
/webMethods_install_dir/MWS/server/server_instance/deploy
In addition to fixing a corrupted search configuration, you might also need to reload the
configuration because you have manually edited the luceneSearch.xml file.
One reason to edit the file if you are deploying a My webMethods Server cluster. When
deployed in a cluster, the search index files for the search agent node should be on the
local hard drive, rather than on a network file system or on a mapped drive. Read/write
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 218

15. Managing My webMethods Server Content
operations over a network are slow and can lead to index corruption. When you would
edit the LuceneSearch.xml file, change the
home:/data/lucene value to a local path (for example:
c:/MWS/searchdata).
If you have written a custom document converter for a file type the server cannot index by
default, need to add an extra node to the section.
To make manual changes to the luceneSearch.xml file
1 Extract (unzip) the luceneSearch.xml file from the wm_portalsearch portlet:
/webMethods_install_dir/MWS/components/services/search/
wm_portalsearch.pdp
2 In a text editor, manually edit the luceneSearch.xml file as needed.
3 Zip the luceneSearch.xml file back into the wm_portalsearch.pdp portlet file.
4 Redeploy the portlet, as described in the preceding procedure.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 219

15. Managing My webMethods Server Content
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 220

Chapter 16. Managing the User Interface
� Locale Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
� What are Server Rules? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
� Creating Locale Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
� Creating Login Page Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
� Creating Rendering Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
� Creating Start Page Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
� Modifying a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
� Copying a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
� Managing the Evaluation Order for Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
� Removing a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
� Working with Skins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
� Working with Shells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 221

Locale Administration
16. Managing the User Interface
The Locale Administration page allows you to set the default locale rules for My
webMethods Server when they are not determined by other rules, as described in
“Creating Locale Rules” on page 224.
1 As system administrator:
Administration > User Interface > Locale Administration.
2 From the Locale list, choose the locale to be used as the default rule for My
webMethods Server.
3 Click Apply.
What are Server Rules?
To set the default My webMethods Server locale rule
My webMethods Server uses rules to control a variety of user activities, from which page
they use to log into the server, to the appearance of the pages they see. Using rules, you
can define default behaviors for the entire application or you can dynamically control the
experience of a given user, group, or role.You can create rules of the following types:
Rule type Description
Locale rules Rules that allow you to dictate what locale should be used for a
user session if it is not defined in the user profile. See “Creating
Locale Rules” on page 224.
Login page rules Rules that determine what login page should be used. You can, for
example, redirect users to different login pages, depending on
whether they are inside or outside the firewall. See “Creating
Login Page Rules” on page 225.
Start page rules Rules that determine what start page should be used. The start
page is the page to which the server redirects users after log in. See
“Creating Start Page Rules” on page 229.
Rendering rules Rules that determine what renderer should be used.Renderers are
user interface formatting capabilities that can be assigned to
specific server objects by defining rendering rules. You can define
rendering rules for virtually any server object type. Rendering
rules are useful in providing a consistent look and feel for common
object types that can be invoked through explicit rule definitions.
See “Creating Rendering Rules” on page 227.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 222

Rule type Description
16. Managing the User Interface
Shell rules Rules that determine what shell should be used.A shell is an
installable component that generates the My webMethods Server
header, footer, and portlet title bars. Shell rules define what shell
elements should be displayed for a given user, group, or role. For
example, if a server serves both employees and customers, you can
use shell rules to assign the corresponding shell to a given user
group. See “Creating Shell Rules” on page 237.
Skin rules Rules that determine what skin should be used. A skin is an
installable My webMethods Server component that defines the
look and feel of the user interface. Skin rules define what skin
should be displayed for a given user, group, or server resource.
For example, if a server serves both employees and customers, and
there are requirements for a different set of graphics, colors, and
fonts for each distinct user population, you can use skin rules to
assign the corresponding skin to a given user group. See “Creating
Skin Rules” on page 235.
In addition to the rule types described here, you can use rules for the creation of roles,
which are collections of users, groups, and other roles. You can create a rule‐based role
that defines members based on the same types of criteria as are used for the rule types. For
information, see “Adding a Rule‐Based Role” on page 115.
These aspects of rule management are described as follows:
This aspect... Is described here...
Creating rules “Creating Locale Rules” on page 224
“Creating Login Page Rules” on page 225
“Creating Rendering Rules” on page 227
“Creating Start Page Rules” on page 229
“Creating Skin Rules” on page 235
Modifying rules
“Creating Shell Rules” on page 237
“Modifying a Rule” on page 230
Copying rules “Copying a Rule” on page 232
Changing the evaluation order of “Managing the Evaluation Order for Rules”
rules
on page 233
Removing rules “Removing a Rule” on page 233
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 223

Creating Locale Rules
16. Managing the User Interface
The Manage Locale Page Rules page allows you to define rules that dictate what locale
should be used for a user session if it is not defined in the user profile.
To create a new locale rule
1 As system administrator:
Administration > User Interface > Manage Locale Rules > Create New Rule.
2 In the Name field, type a name for the rule.
3 (Optional) On the Description field, type a description for the new rule.
4 To add a condition for individual users, click Current User(s) and do the following:
a In the Keywords field, type a keyword representing the users you want to search
for, and click Search.
b Move one or more users to the Selected box and click Apply.
5 To add a condition based on group or role membership, click Group / Role Membership
and do the following:
a Under Search For, choose the Groups or Roles option.
b In the Keywords field, type a keyword representing the groups or roles you want
to search for, and click Search.
c Move one or more groups or roles to the Selected box and click Apply.
6 To add a condition based on user attributes, click User Attributes, on the Pick User
Attribute list, choose a user attribute, and click Apply.
For more information about the user attributes in the list, see “User Information” on
page 88.
7 To add a condition based on the request header, click Request and do the following:
a Choose the expression, and click Submit.
b In the Condition field, complete the expression.
For example, assume that you want to match any HTTP GET request. The wizard
moves #{request.method} into the Condition field and you type the remainder:
#{request.method} == "GET"
8 To add a condition that matches the current resource or a parent of the current
resource, click Parent Resource and then do the following:
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 224

c Click Apply.
16. Managing the User Interface
9 To add a condition that matches the current resource type, click Current Resource Type,
choose the resource type and do the following:.
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
10 To add a condition for a resource property and a value associated with it, click
Resource Properties, and do the following:
a In the Property Name field, type the property name.
b In the Property Value field, type the property value.
c Click Apply.
For example, if you want to match files that are PDFs, the property name is mimeType
and the property value is pdf.
11 From the Result list, choose the locale to be used for the rule.
12 Click Create Rule.
Creating Login Page Rules
The Manage Login Page Rules page allows you to define rules that dictate what login
page should be used. Login page rules can be defined to dynamically set the default login
page for a given for a given user, group, or role.
To create a new login page rule
1 As system administrator:
Administration > User Interface > Manage Login Page Rules > Create New Rule.
2 In the Name field, type a name for the rule.
3 (Optional) On the Description field, type a description for the new rule.
4 To add a condition for individual users, click Current User(s) and do the following:
a In the Keywords field, type a keyword representing the users you want to search
for, and click Search.
b Move one or more users to the Selected box and click Apply.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 225

16. Managing the User Interface
5 To add a condition based on group or role membership, click Group / Role Membership
and do the following:
a Under Search For, choose the Groups or Roles option.
b In the Keywords field, type a keyword representing the groups or roles you want
to search for, and click Search.
c Move one or more groups or roles to the Selected box and click Apply.
6 To add a condition based on user attributes, click User Attributes, on the Pick User
Attribute list, choose a user attribute, and click Apply.
For more information about the user attributes in the list, see “User Information” on
page 88.
7 To add a condition based on the request header, click Request and do the following:
a Choose the expression, and click Submit.
b In the Condition field, complete the expression.
For example, assume that you want to match any HTTP GET request. The wizard
moves #{request.method} into the Condition field and you type the remainder:
#{request.method} == "GET"
8 To add a condition that matches the current resource or a parent of the current
resource, click Parent Resource and then do the following:
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
9 To add a condition that matches the current resource type, click Current Resource Type,
choose the resource type and do the following:.
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
10 To add a condition for a resource property and a value associated with it, click
Resource Properties, and do the following:
a In the Property Name field, type the property name.
b In the Property Value field, type the property value.
c Click Apply.
For example, if you want to match files that are PDFs, the property name is mimeType
and the property value is pdf.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 226

16. Managing the User Interface
11 On the Result field, type an alias for the login page, or to browse to the page, click Pick
and do the following:
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
12 Click Create Rule.
Creating Rendering Rules
The Manage Rendering Rules page allows system administrators to configure rendering
rules for specific server objects, such as a folder, page, portlet, and so forth. For example,
an administrator who wants all folders to display a detailed view of content can create a
rendering rule that applies a “details” renderer to all folder objects. For each of the types
of conditions you can apply in the following procedure, you can add multiple instances,
one at a time.
To create a new Rendering rule
1 As system administrator:
Administration > User Interface > Manage Rendering Rules > Create New Rule.
2 On the Name field, type a name for the rule.
Example: folder-thumbnails view (for image files).
3 (Optional) On the Description field, type a description for the new rule.
4 To add a condition for individual users, click Current User(s) and do the following:
a In the Keywords field, type a keyword representing the users you want to search
for, and click Search.
b Move one or more users to the Selected box and click Apply.
5 To add a condition based on group or role membership, click Group / Role Membership
and do the following:
a Under Search For, choose the Groups or Roles option.
b In the Keywords field, type a keyword representing the groups or roles you want
to search for, and click Search.
c Move one or more groups or roles to the Selected box and click Apply.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 227

16. Managing the User Interface
6 To add a condition based on user attributes, click User Attributes, on the Pick User
Attribute list, choose a user attribute, and click Apply.
For more information about the user attributes in the list, see “User Information” on
page 88.
7 To add a condition based on the request header, click Request and do the following:
a Choose the expression, and click Submit.
b In the Condition field, complete the expression.
For example, assume that you want to match any HTTP GET request. The wizard
moves #{request.method} into the Condition field and you type the remainder:
#{request.method} == "GET"
8 To add a condition that matches the current resource or a parent of the current
resource, click Parent Resource and then do the following:
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
9 To add a condition that matches the current resource type, click Current Resource Type,
choose the resource type and then do the following:.
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
10 To add a condition for a resource property and a value associated with it, click
Resource Properties, and do the following:
a In the Property Name field, type the property name.
b In the Property Value field, type the property value.
c Click Apply.
For example, if you want to match files that are PDFs, the property name is mimeType
and the property value is pdf.
11 On the Result list, choose the target renderer.
The renderer you select will be applied to all server objects that meet the evaluation
criteria you define in the following steps. For example, the thumbnails renderer is
useful for displaying thumbnail views for images that are published to the server.
12 Click Create Rule.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 228

Creating Start Page Rules
16. Managing the User Interface
The Manage Start Page Rules page allows system administrators to define rules that
dictate what start page should be used. The start page is the page to which the server
redirects users after log in. Start page rules can be defined to dynamically set the default
start page for a given for a given user, group, or role.
To create a new start page rule
1 As system administrator:
Administration > User Interface > Manage Start Page Rules > Create New Rule.
2 On the Name field, type a name for the rule.
3 (Optional) On the Description field, type a description for the new rule.
4 To add a condition for individual users, click Current User(s) and do the following:
a In the Keywords field, type a keyword representing the users you want to search
for, and click Search.
b Move one or more users to the Selected box and click Apply.
5 To add a condition based on group or role membership, click Group / Role Membership
and do the following:
a Under Search For, choose the Groups or Roles option.
b In the Keywords field, type a keyword representing the groups or roles you want
to search for, and click Search.
c Move one or more groups or roles to the Selected box and click Apply.
6 To add a condition based on user attributes, click User Attributes, on the Pick User
Attribute list, choose a user attribute, and click Apply.
For more information about the user attributes in the list, see “User Information” on
page 88.
7 To add a condition based on the request header, click Request and do the following:
a Choose the expression, and click Submit.
b In the Condition field, complete the expression.
For example, assume that you want to match any HTTP GET request. The wizard
moves #{request.method} into the Condition field and you type the remainder:
#{request.method} == "GET"
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 229

Modifying a Rule
16. Managing the User Interface
8 To add a condition that matches the current resource or a parent of the current
resource, click Parent Resource and then do the following:
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
9 To add a condition that matches the current resource type, click Current Resource Type,
choose the resource type and do the following:.
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
10 To add a condition for a resource property and a value associated with it, click
Resource Properties, and do the following:
a In the Property Name field, type the property name.
b In the Property Value field, type the property value.
c Click Apply.
For example, if you want to match files that are PDFs, the property name is mimeType
and the property value is pdf.
11 On the Result field, type an alias for the start page, or to browse to the page, click Pick
and do the following:
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
12 Click Create Rule.
After a rule exists, you can modify any portion of it that is editable.
To modify a rule
1 As system administrator:
Administration > User Interface > Manage rule-type Rules > View Rules
where rule-type contains the rule you want to modify.
2 For the rule you want to modify, click Tools and then click Modify Rule.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 230

3 Do any of the following:
� In the Name field, type a new name for the rule.
16. Managing the User Interface
� (Optional) On the Description field, type a new description for the rule.
� To modify a condition for individual users, click Current User(s) and do the
following:
1 In the Keywords field, type a keyword representing the users you want to
search for, and click Search.
2 Move one or more users to the Selected box and click Apply.
� To modify a condition based on group or role membership, click Group / Role
Membership and do the following:
1 Under Search For, choose the Groups or Roles option.
2 In the Keywords field, type a keyword representing the groups or roles you
want to search for, and click Search.
3 Move one or more groups or roles to the Selected box and click Apply.
� To modify a condition based on user attributes, click User Attributes, on the Pick
User Attribute list, choose a user attribute, and click Apply.
For more information about the user attributes in the list, see “User Information”
on page 88.
� To modify a condition based on the request header, click Request and do the
following:
1 Choose the expression, and click Submit.
2 In the Condition field, complete the expression.
For example, assume that you want to match any HTTP GET request. The wizard
moves #{request.method} into the Condition field and you type the remainder:
#{request.method} == "GET"
� To modify a condition that matches the current resource or a parent of the current
resource, click Parent Resource and then do the following:
1 To find children of a resource, click the name of the resource.
2 To select a resource, click the option button to the left of the resource.
3 Click Apply.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 231

Copying a Rule
16. Managing the User Interface
� To modify a condition that matches the current resource type, click Current
Resource Type, choose the resource type and do the following:.
1 To find children of a resource, click the name of the resource.
2 To select a resource, click the option button to the left of the resource.
3 Click Apply.
� To modify a condition for a resource property and a value associated with it, click
Resource Properties, and do the following:
1 In the Property Name field, type the property name.
2 In the Property Value field, type the property value.
3 Click Apply.
� Modify the Result as needed field as needed.
4 Click Update Rule.
If you want to create a rule that is similar to an existing one, you can do so by copying the
existing rule.
To copy a rule
1 As system administrator:
Administration > User Interface > Manage rule-type Rules > View Rules
where rule-type contains the rule you want to copy.
2 For the rule you want to copy, click Tools and then click Copy Rule.
3 Type a name for the new rule.
4 (Optional) Type a description for the new rule.
5 Click Copy The Rule.
You can then modify the new rule, as described in “Modifying a Rule” on page 230.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 232

Managing the Evaluation Order for Rules
Removing a Rule
16. Managing the User Interface
When a user requests a server resource, the server uses rules to determine how to fill the
request. For example, perhaps the look and feel of the page is dependent on whether the
user is a company employee or a customer. The server evaluates the skin rules to
determine which skin to apply, in this order:
1 If there are multiple skin rules, the skin associated with the first rule that matches the
user applies.
2 If none of the rules match the user, or if there are no skin rules, the default skin
assigned in the User Preferences tab of the user’s Profile page applies.
3 If no skin is assigned on the Profile page, the default skin for the server applies.
If there are multiple skin rules, you can determine the order in which they are evaluated.
To change the order in rules are evaluated
1 As system administrator:
Administration > User Interface.
2 Click the name of the set of rules you want to manage.
3 Click Change Rule Evaluation Order.
4 To reorder rules, move them up or down as needed.
The first rule in the list is searched first, followed by the second, and so on.
5 Click Update.
To remove a rule, use the following procedure.
To remove a rule
1 As system administrator:
Administration > User Interface > Manage rule-type Rules > View Rules
where rule-type contains the rule you want to remove.
2 For the rule you want to remove, click Tools and then click Remove Rule.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 233

Working with Skins
16. Managing the User Interface
A skin is an installable My webMethods Server component that defines the look and feel
of the My webMethods Server user interface. A skin modifies the images, fonts, colors,
and other subtle stylable aspects of HTML content, but it does not modify the HTML
content in any functional way.
A developer creates new custom skins to accomplish many different functions. Some of
these include:
� Branding the server with corporate, partner, or departmental logos.
� Aligning the color scheme with corporate, partner, or departmental colors.
Developers create skins with the Skin Administration page.You can set up many different
criteria to determine which skin is used for a particular user request. My webMethods
Server offers a variety of ways to configure personalization rules that dictate what skin is
displayed for a given user, group, or resource.
You can explicitly assign a particular skin to a specific user or set up rules that
dynamically assign a skin based on a variety of criteria.
Explicitly Assigning a Skin
To assign a particular skin to a specific user, you can use the User Preferences tab of the
profile page for a user. by default, users are granted the right to assign their own skins.
See
“The User Preferences Attribute Provider” on page 140.
Managing Skin Rules
The Manage Skin Rules page allows you to define rules that dictate what skins can be
used by users, groups, or roles. This page allows a system administrator to create, modify,
or remove rules, and change the evaluation order of a list of rules that are evaluated for
each user every time the user logs in. The following list provides information about
managing rules:
This information about managing rules... Is described here...
Changing the evaluation order of
rules
“Managing the Evaluation Order for Rules”
on page 233
Creating rules “Creating Skin Rules” on page 235
Modifying rules “Modifying a Rule” on page 230
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 234

This information about managing rules... Is described here...
Copying rules “Copying a Rule” on page 232
Removing rules “Removing a Rule” on page 233
Creating Skin Rules
To create a new skin rule, use the following procedure.
To create a new skin rule
1 As system administrator:
Administration > User Interface > Manage Skin Rules > Create New Rule.
2 On the Name field, type a name for the rule.
3 (Optional) On the Description field, type a description for the new rule.
16. Managing the User Interface
4 To add a condition for individual users, click Current User(s) and do the following:
a In the Keywords field, type a keyword representing the users you want to search
for, and click Search.
b Move one or more users to the Selected box and click Apply.
5 To add a condition based on group or role membership, click Group / Role Membership
and do the following:
a Under Search For, choose the Groups or Roles option.
b In the Keywords field, type a keyword representing the groups or roles you want
to search for, and click Search.
c Move one or more groups or roles to the Selected box and click Apply.
6 To add a condition based on user attributes, click User Attributes, on the Pick User
Attribute list, choose a user attribute, and click Apply.
For more information about the user attributes in the list, see “User Information” on
page 88.
7 To add a condition based on the request header, click Request and do the following:
a Choose the expression, and click Submit.
b In the Condition field, complete the expression.
For example, assume that you want to match any HTTP GET request. The wizard
moves #{request.method} into the Condition field and you type the remainder:
#{request.method} == "GET"
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 235

16. Managing the User Interface
8 To add a condition that matches the current resource or a parent of the current
resource, click Parent Resource and then do the following:
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
9 To add a condition that matches the current resource type, click Current Resource Type,
choose the resource type and then do the following:.
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
10 To add a condition for a resource property and a value associated with it, click
Resource Properties, and do the following:
a In the Property Name field, type the property name.
b In the Property Value field, type the property value.
c Click Apply.
For example, if you want to match files that are PDFs, the property name is mimeType
and the property value is pdf.
11 On the Result list, choose the target skin.
12 Click Create Rule.
Working with Shells
A shell is an installable component of My webMethods Server. A shell is segment is a
special kind of page that generates the My webMethods Server header, footer, and portlet
title bars.
Where regular portlets produce the primary content of a page, a shell provides the
structure that frames that primary content. Common Web page idioms such as banners,
standard links, and search boxes appear in a shell.
A developer creates new custom shells to accomplish many different functions, such as:
� Adding a row of links to other corporate Web sites below the page banner
� Changing the default search box to one that searches the corporate catalogue
� Adding a left‐hand navigation bar to every page.
Developers create shells with the Skin Administration page. See “Working with Shells” on
page 236 for information about creating your own custom shells.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 236

16. Managing the User Interface
You can set up many different criteria to determine which shell is used for a particular
user request. My webMethods Server offers a variety of ways to configure personalization
rules that dictate what shell is displayed for a given user, group, or resource.
Note: Unlike skins, you cannot explicitly assign a particular shell to a specific user. You
need to use rules that dynamically assign a shell based on a variety of criteria.
Managing Shell Rules
The Manage Shell Rules page allows you to define rules that dictate what shells can be
used by users, groups, or roles. This page allows a system administrator to create, modify,
or remove rules, and change the evaluation order of a list of rules that are evaluated for
each user every time the user logs in. The following list provides information about
managing rules:
This information about managing rules... Is described here...
Changing the evaluation order of
rules
Creating Shell Rules
To create a new shell rule, use the following procedure.
1 As system administrator:
Administration > User Interface > Manage Shell Rules > Create New Rule.
2 On the Name field, type a name for the rule.
Example: folder-thumbnails view (for image files).
“Managing the Evaluation Order for Rules”
on page 233
Creating rules “Creating Shell Rules” on page 237
Modifying rules “Modifying a Rule” on page 230
Copying rules “Copying a Rule” on page 232
Removing rules “Removing a Rule” on page 233
To create a new shell rule
3 (Optional) On the Description field, type a description for the new rule.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 237

16. Managing the User Interface
4 To add a condition for individual users, click Current User(s) and do the following:
a In the Keywords field, type a keyword representing the users you want to search
for, and click Search.
b Move one or more users to the Selected box and click Apply.
5 To add a condition based on group or role membership, click Group / Role Membership
and do the following:
a Under Search For, choose the Groups or Roles option.
b In the Keywords field, type a keyword representing the groups or roles you want
to search for, and click Search.
c Move one or more groups or roles to the Selected box and click Apply.
6 To add a condition based on user attributes, click User Attributes, on the Pick User
Attribute list, choose a user attribute, and click Apply.
For more information about the user attributes in the list, see “User Information” on
page 88.
7 To add a condition based on the request header, click Request and do the following:
a Choose the expression, and click Submit.
b In the Condition field, complete the expression.
For example, assume that you want to match any HTTP GET request. The wizard
moves #{request.method} into the Condition field and you type the remainder:
#{request.method} == "GET"
8 To add a condition that matches the current resource or a parent of the current
resource, click Parent Resource and then do the following:
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
9 To add a condition that matches the current resource type, click Current Resource Type,
choose the resource type and then do the following:.
a To find children of a resource, click the name of the resource.
b To select a resource, click the option button to the left of the resource.
c Click Apply.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 238

16. Managing the User Interface
10 To add a condition for a resource property and a value associated with it, click
Resource Properties, and do the following:
a In the Property Name field, type the property name.
b In the Property Value field, type the property value.
c Click Apply.
For example, if you want to match files that are PDFs, the property name is mimeType
and the property value is pdf.
11 On the Result list, choose the target shell.
The renderer you select will be applied to all server objects that meet the evaluation
criteria you define in the following steps. For example, the thumbnails renderer is
useful for displaying thumbnail views for images that are published to the server.
12 Click Create Rule.
Setting Shells for Requests
To set a specific shell for a request, a developer creates a link to a server resource and adds
a shell parameter to the link. The shell parameter value should be an alias to the target
shell.
For example, the URL for a link to the public folder with the extranet shell is
/folder.public?shell=shell.extranet. When users follow the link, they view the public folder
framed with the specified extranet shell. When users click another link from the public
folder page, they return to whatever shell they were using before, provided the link does
not also have a shell parameter.
Setting Shells for Sessions
To set a specific shell for a session, sometimes referred to as a sticky shell because the
setting is retained for the duration of the session, a developer creates a link to the
forceShell command. This command takes a returnUrl parameter, which redirects a user
to the specified URL once the shell has been set.
For example, the URL for a link to the public folder with a sticky extranet shell is
/?command=forceShell&shellURI=shell.extranet&returnUrl=folder.public. When users
follow the link, they view the public folder now framed with the extranet shell. When
users click another link from the public folder page, provided the link does not have a
shell parameter, they see that page still framed with the extranet shell.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 239

16. Managing the User Interface
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 240

Chapter 17. Managing and Using a Wiki
� What is a Wiki? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
� Managing Participation in a Wiki . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
� Creating a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
� Modifying a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
� Finding a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
� Moving a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
� Renaming a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
� Adding a Subpage to a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
� Attaching a File to a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
� Opening a File Attached to a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
� Managing Versions of a Wiki Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 241

What is a Wiki?
17. Managing and Using a Wiki
A wiki is a Web interface for a storage organization. A wiki makes it possible to write
documents collectively, giving multiple individuals the ability create, edit, and reorganize
content. A wiki is a body of individual pages, called wiki pages, interconnected by
hyperlinks. A wiki uses a simple markup language with which you can format text, create
structure, and add hypertext links within the wiki or to external sites.
The wiki maintains versions of wiki pages. With this feature, you can see who has made
various changes to a wiki page or restore an earlier version of a page as the current
version.
Managing Participation in a Wiki
Creating a Wiki Page
Because of the collaborative nature of a wiki, it becomes important to manage access to it.
For some wikis, it may be acceptable to allow anyone to make changes to content while
others may require limited access. As a system administrator, you have control over the
kinds of actions an individual can perform against a wiki page:
To allow a user to do this... Grant the user this permission
View a wiki page View
Modify text and rename the page Modify properties
Create a subpage or attach a file Modify properties and Create child
Create a new page Create child permission for the folder or page
where the wiki page is to be created
In addition, everyone who can view a wiki page has permission to browse or search for
wiki pages on the server. For more on managing permissions, see “Managing
Permissions” on page 163.
As system administrator or a user with system administrator privileges, you can create a
wiki.
To create a wiki
1 As system administrator:
Administration > Content > Wiki Administration > Create New Wiki.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 242

2 In the Wiki Name field, type a display name to identify the wiki page.
17. Managing and Using a Wiki
There are no restrictions on what characters you can use for this name. The maximum
length for a name is 255 characters.
3 In the Place wiki on the portal page panel, do one of the following:
4 In the editor, type a heading for the wiki page, and any other text you want to start
with.
5 Click Next.
6 Click Finish.
Modifying a Wiki Page
Click this... And do this...
Browse To select a target page or folder, move it to the Selected Items
box and then click Select.
Use Alias In the Alias Name field, type the alias of the target page or
folder. Click Test to determine if the alias is valid and the alias
target is the correct one. If the alias is correct, click Select.
Anyone with modify permission for a wiki page can edit the page and perform a variety
of actions on the page.
Do do this... Look here...
Edit a wiki page “Editing a Wiki Page” on page 243
See wiki syntax “Wiki Syntax” on page 244
Editing a Wiki Page
To edit a wiki page
1 Locate the wiki page and click or the name of the wiki page to open it.
By default, a wiki page opens on the View tab.
2 Click Edit.
3 Modify, add, or remove text as appropriate.
4 If you need assistance with the syntax for marking up wiki content, click Syntax Help.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 243

5 To save your work, do one of the following:
This command... Does this...
Wiki Syntax
The following table shows the syntax used in formatting wiki pages:
17. Managing and Using a Wiki
Save Saves the wiki page, updates wiki history, and sends a
notification event to anyone who is subscribed to the wiki
page.
Quiet Save Saves the wiki page but does not update wiki history or send a
notification event. Use this command to save changes before
you have finished editing.
Both commands close the editor and return the wiki page to the View tab.
Formatting Commands Syntax Example
Headings Heading text wrapped with single
quotation marks renders a heading style.
The number of marks sets the level of
heading.
At least three dashes at the beginning of a
line, followed by plus signs and the
heading text. The number of plus signs
sets the level of heading.
Paragraph Two carriage returns or line feeds create a
new paragraph.
Force Next
Line
’’Heading_2’’
---+++Heading_3
First paragraph
Second paragraph
Two backslashes (\\) force a new line. First line\\Next line
Bold Text Text enclosed with asterisks (*) is
displayed in bold text.
Italic Text Text enclosed with underscores (_) is
displayed in italic text.
Bold Italic Text Text enclosed with double underscores
(__) is displayed in bold italic text.
Text Coloring Text enclosed between %COLOR% and
%ENDCOLOR% is displayed in the
specified color, where COLOR is one of
the sixteen HTML color names.
*Bold text*
_Italic text_
__Bold italic text__
%BLUE%Blue
text%endcolor%
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 244
i

Formatting Commands Syntax Example
Fixed Font Text enclosed with equal signs(=) is
displayed in fixed font.
Bold Fixed
Font
Text enclosed with double equal signs(==)
is displayed in bold fixed font.
Text Style Text enclosed within style tags
([color,style]) is displayed according to
the elements within the tag. Valid style
elements are Bold and Italic.
Line Separator At least three dashes at the beginning of a
line creates a horizontal rule. You cannot
place any other text on the same line.
HTML
Encoding
To show HTML encoding, enclose it with
((( and ))) (triple parentheses). Otherwise,
raw HTML is transformed.
Bullet List Three, six, nine (and so forth) spaces
followed by a single asterisk (*) define a
bullet list.
You can also use one, two, three, or more
asterisks.
Numbered List Three spaces and a 1 start a numbered list.
To nest another numbered list inside the
first, use three spaces and two 1s.
You can also use pound signs (#). Precede
each line of the numbered list with #. To
nest another numbered list inside the first,
use ##, and so on.
Tables Table cells are enclosed in vertical bars
(|).
=Fixed font=
==Bold fixed font==
[blue]Blue text[/blue]
[red,bold,italic]Red
bold italic
[/red,bold,italic]
17. Managing and Using a Wiki
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 245
+++
((( tag)))
* Level_1
* Level_2
* Level_1
** Level_2
1 Item_1
11 Item_a
11 Item_b
1 Item_2
# Item_1
## Item_a
## Item_b
# Item_2
| *L* | *C* | *R* |
| A2 | 2 | 2 |
| A3 | 3 | 3 |
| multi span |||
| A4 | next | next |

Formatting Commands Syntax Example
Links to
External Sites
Links to Other
Wiki Pages
To create a link, specify the link reference
and the link display text separately using
nested square brackets:
[[reference][text]]
where [reference] is a wiki name or an
external link.
Optionally, add a link target to the
reference to open the link in a new
window:
[[reference;target=new][text]]
A valid wiki name takes the form:
[WikiPagePath].WikiName
where WikiName is the valid wiki name
without spaces. The name My Wiki
becomes MyWiki.
If the wiki page is a subpage,
WikiPagePath is the parent wiki page
where the subpage resides, where
WikiPagePath is the valid wiki name
without spaces. You can omit
WikiPagePath if the referenced wiki page
is a sibling or direct subpage of the
current wiki page.
17. Managing and Using a Wiki
[[http://www.yahoo.com][Yahoo]]
Displays as:
[[http://www.yahoo.com;target=new][Yahoo
in a New Browser]]
Displays as:
[[MyWiki][My Wiki]]
Displays as:
[[MyWiki.MySubpage][My Subpage]]
Displays as:
URLs Any valid URL draws itself as a link. http://www.yahoo.com
URLs to
Attachments
To embed an image or a file attached to
the wiki page, use the
%ATTACHURLPATH% macro followed
by the name of the attached file. Use this
URL as an tag source to display
attached images in place.
Displays as:
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 246

Formatting Commands Syntax Example
Table of
Contents
Finding a Wiki Page
The %TOC% macro creates a table of
contents of the current page, made up of
headings used on the page.
Includes The %INCLUDE% macro includes
content of another wiki page into the
current page.
%TOC%
17. Managing and Using a Wiki
As a system administrator, there are multiple functions you can take to find and open a
wiki.
Finding a Wiki Page by Browsing
%INCLUDE{ʺWikiPath.WikiNameʺ}%
This function... Is described here...
Find all wiki pages on the server “Finding a Wiki Page by Browsing” on
page 247
Search for a specific wiki page “Searching for a Wiki Page” on page 248
If you know the name of a particular wiki page, you can quickly locate it from a list of
wiki pages on the server.
1 As system administrator:
Administration > Content > Wiki Administration > Browse Wiki.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 247

17. Managing and Using a Wiki
The Wiki Browse page contains a list of wiki pages stored on the server, including the
following information about each wiki page:
Column Description
Name The name of the wiki page. Click the Name column to open the
wiki page.
Location The location of the wiki page. Click the Location column to
open the page or folder on which the wiki page resides. The
location provides this additional information about the wiki:
2 Locate the wiki and do one of the following:
Searching for a Wiki Page
If the location is... It means this...
A page or folder The wiki page can be made available to
anyone who has access rights to the page
or folder.
Wiki Pages The wiki page is only available for
someone with system administrator
rights.
Another wiki
page
As a system administrator, you can search for a wiki page by name or based on criteria
such as author name.
1 As system administrator:
Administration > Content > Wiki Administration > Search Wiki.
The wiki page is a subpage of another
wiki page.
Author The user name of the creator of the wiki page.
Date Modified The date and time the wiki page was last modified or
renamed.
Take this action... To do this...
Click or the
name
To open the wiki page in a View tab.
Click the location To open the page or folder on which the wiki page resides.
To search for a wiki page
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 248

17. Managing and Using a Wiki
2 In the Query field, type keywords on which to search, using these guidelines:
� Keywords can be in the wiki name or in the text on the wiki page
� The search is not case sensitive
� Use whole words only
� A space between keywords is an implicit OR (for example, one two finds either
one or two)
� A plus sign (+) is an implicit AND (for example, +one +two must find both words
to match)
� Use an asterisk (*) as a multiple‐character wildcard or a question mark (?) as a
single‐character wildcard to complete a keyword (for example, thr*, th*e, and
th?ee all find three)
� Use double quotation marks (“) to enclose a string (for example “one two
three”)
3 (Optional) Refine the search using any or all of the following fields:
Field Description
Start Date Searches for wiki pages last modified on or after the specified
date. Click and click the start date for the search.
End Date Searches for wiki pages last modified on or before the
specified date. Click and click the end date for the search.
Author Searches for wiki pages created by a specified user.
Click Browse. To select a user, move the user to the Selected
Items box and then click Select. You can select only one user at a
time.
Location Folder Searches for wiki pages located in a specified folder. In the
Location Folder area, do one of the following:
Browse To select a target resource, move it to the Selected
Items box and then click Select.
4 Click Search.
Use Alias In the Alias Name field, type the alias of the target
resource. Click Test to determine if the alias is
valid and the alias target is the correct one. If the
alias is correct, click Select.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 249

17. Managing and Using a Wiki
The Search Results page provides a list of wiki pages that match the search criteria,
including the following information about each wiki page:
Column Description
Rank An approximate ranking of how closely the item matches the
search criteria.
Name The name of the wiki page. Click the Name column to open the
wiki page.
Description The description of the wiki page provided at the time the page
was created.
Modified The date and time the wiki page was last modified or
renamed.
Location The location of the wiki page. Click the Location column to
open the page or folder on which the wiki page resides. The
location provides this additional information about the wiki:
If the location is... It means this...
A page or folder The wiki page can be made available to
anyone who has access rights to the page
or folder.
Wiki Pages The wiki page is only available for
someone with system administrator
rights.
Another wiki
page
5 Locate the wiki and do one of the following:
Take this action... To do this...
Click or the
name
To open the wiki page in a View tab.
The wiki page is a subpage of another
wiki page.
Click the location To open the page or folder on which the wiki page resides.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 250

Wiki Saved Searches
17. Managing and Using a Wiki
After you perform a search for wiki content, as described in “Searching for a Wiki Page”
on page 248, you have the opportunity to save the search criteria in the Search Results
page. By saving search criteria, you can reuse the same criteria to perform the same search
on a regular basis.
To save a wiki search
1 After performing a wiki search, on the Search Results page, click Add to my Saved
Searches.
2 At the prompt, type a descriptive name for the saved search and click OK.
There are no restrictions on what characters you can use for this name. The maximum
length for a name is 255 characters. The saved search is stored in your Saved Searches
folder.
To use a saved wiki search
Moving a Wiki Page
1 In the standard links, click My Folders.
2 In the Saved Searches folder, locate the saved search and click the link.
As a system administrator, you can move a wiki page from one folder to another. When
you move the wiki page, any subpages and attached files are moved along with the wiki
page.
To move a wiki page
1 As a system administrator, locate the wiki page you want to move and open it.
2 On the wiki page, click Tools and then click Clipboard and Cut.
3 Locate the page or folder where you want the wiki page to reside.
4 On the page or folder, click Tools and then click Clipboard and Paste.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 251

Renaming a Wiki Page
17. Managing and Using a Wiki
A system administrator or a user with modify permission can rename a wiki page.
Renaming a wiki page causes all links to the page to be renamed.
To rename a wiki
1 Open the wiki page you want to rename.
2 Click Rename.
3 In the New Wiki Name field, type the new name for the wiki.
There are no restrictions on what characters you can use for this name. The maximum
length for a name is 255 characters
4 Click Rename.
Adding a Subpage to a Wiki Page
A system administrator or a user with modify permission can add a new subpage to an
existing wiki page. A subpage is a separate wiki page that is child to the wiki page in
which it is created. After you add a new subpage to a wiki page, it is listed in the Subpages
and Files tab.
To add a new subpage to a wiki
1 Open the wiki page to which you want to add a subpage.
2 Click New Subpage.
3 In the Wiki Name field, type the name for the wiki subpage.
There are no restrictions on what characters you can use for this name. The maximum
length for a name is 255 characters
4 By default, the new subpage is created on the wiki page from which it is created. If
you want to add the subpage to a different wiki page, do one of the following:
Click this... And do this...
Browse To select a target wiki page, move it to the Selected Items box
and then click Select.
Use Alias In the Alias Name field, type the alias of the target wiki page.
Click Test to determine if the alias is valid and the alias target is
the correct one. If the alias is correct, click Select.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 252

17. Managing and Using a Wiki
5 In the editor pane, type a heading for the wiki subpage, and any other text you want
to add.
6 Click Next.
7 Click Finish.
Attaching a File to a Wiki Page
A system administrator or a user with modify permission can attach a file to a wiki page
as a means of sharing that file with other users. There are no restrictions on the type of file
you can attach. You can control the maximum size of attached files by clicking Content
Service in the Content folder of the Administration Dashboard.
To attach a file to a wiki page, do the following:
To attach a file to a wiki page
1 Open the wiki page to which you want to attach a file.
2 Click Attach File.
3 In the Name field of the Publish page, type a display name for the file.
There are no restrictions on what characters you can use for this name. The maximum
length for a name is 100 characters
4 (Optional) In the Description field, type descriptive comments about the file.
The description appears when you display a list of files attached to the wiki page.
5 In the File field, browse to the location of the file to be attached and click Open.
The file must be on a network file system or on a mapped drive for the computer you
are using.
6 In the Encoding list, do one of the following:
� Choose the type of encoding suitable for the type of file you are attaching. The
default encoding value is Non text (binary).
� If you do not find the suitable encoding type in the list, choose Other from the list,
type the correct encoding, and click OK.
7 In the Link Target field, choose one of the following:
� Open content in the current window (the default)
� Open content in a new window
8 Click Finish.
Files that are attached to a wiki page appear in the Subpages and Files tab for that page.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 253

Opening a File Attached to a Wiki Page
17. Managing and Using a Wiki
A system administrator or a user who has view permission for an attached file can open it.
To open a file attached to a wiki page
1 Open the wiki page to which the file is attached.
2 Click Subpages and Files.
3 Click the name of the attached file to open it.
If the file... The expected behavior is...
Can open in a
browser
Cannot open in a
browser window
To attach a file to a wiki page, see “Attaching a File to a Wiki Page” on page 253.
Managing Versions of a Wiki Page
The file opens in the same window or in a new window
according to the setting in the Link Target field when the file
was attached.
The browser offers you the choice of opening the file with an
application on your computer or saving the file to disk.
One of the features of a wiki is that a version is stored each time someone updates a page.
You can go back to view and edit earlier versions, and restore a particular version to be the
current version. The wiki displays a list of versions on the History tab for a wiki page. You
can take the following functions to manage versions of a wiki page.
This function... Is described here...
View the list of versions for a wiki page “Viewing the History of a Wiki Page” on
page 255
View a version of the wiki page “Viewing an Older Version of a Wiki
Page” on page 256
Change an older version of the wiki page
to be the current version
Compare textual changes between one
version and the previous version in the
history list.
“Make a Wiki Page the Current Version”
on page 256
“Comparing With the Previous Version of
a Wiki Page” on page 257
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 254

Viewing the History of a Wiki Page
17. Managing and Using a Wiki
When you view a wiki page, it is the current version of that page. The wiki retains earlier
versions of the page and maintains a history of those versions. To view the history of a
wiki page, do the following:
To view the history of a wiki page
1 Find and open the wiki page for which you want to view the history, as described in
“Finding a Wiki Page” on page 247.
2 Click History.
The History panel contains a record of versions of the wiki page:
Column Description
Date The date and time the version was saved.
Action The action performed before the version was saved:
Action Description
Reverted Version An older version was made to be the current
version.
Renamed The wiki page was renamed.
Updated Text A change was made to the content of the wiki page.
User The name of the user who performed the action.
Tools A popup menu containing further actions you can take on the version.
Action Description
View Open this version in the View panel.
Compare to
Previous
Compare the content of this version to the previous
version. See “Comparing With the Previous
Version of a Wiki Page” on page 257.
Make This Current Make this version the current version of the wiki
page. “Make a Wiki Page the Current Version” on
page 256.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 255

Viewing an Older Version of a Wiki Page
To view an older version of a wiki page, do the following:
To view an older version of a wiki page
17. Managing and Using a Wiki
1 Find and open the wiki page for which you want to view the history, as described in
“Finding a Wiki Page” on page 247.
2 Click History.
The version at the top of the History panel is the current version.
3 For the version of the wiki page you want to view, click the link in the Action column.
4 Take other actions as needed:
To do this... Do this...
Edit the page Click Edit. For more information, see “Modifying a
Wiki Page” on page 243.
View a different version Click History and repeat the steps in this procedure.
Make this page the
current version
Make a Wiki Page the Current Version
The version at the top of the History panel is the current version. To make an older version
of a wiki page the current page, do the following:
To make an older version of a wiki page the current page
1 Find and open the wiki page, as described in “Finding a Wiki Page” on page 247.
2 Click History.
3 Locate the version of the wiki page that should be the current version.
4 Click Tools and then click Make This Current.
See “Make a Wiki Page the Current Version” on
page 256.
This version of the wiki page is displayed in the View panel. If you click History, you
will see an addition at the top of the history list with the Action value of Reverted
Version.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 256

17. Managing and Using a Wiki
Comparing With the Previous Version of a Wiki Page
For any version of a wiki page on the History tab except the first, you can compare text
changes between that version and the previous version in the list.
To a compare version of a wiki page with the previous version in the list
1 Find and open the wiki page, as described in “Finding a Wiki Page” on page 247.
2 Click History.
3 Locate the version of the wiki page that should be compared.
4 Click Tools and then click Compare to Previous.
A comparison view is displayed:
These lines... Are displayed like this...
Added lines Blue in color and preceded by >>>
Deleted lines Red in color, preceded by

17. Managing and Using a Wiki
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 258

Chapter 18. Managing and Using a Forum
� What is a Forum? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
� How this Chapter is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
� Getting Started with Forums as System Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
� Activities You can Perform as a Spectator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
� Activities You Can Perform as a Contributor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
� Activities You Can Perform as a Moderator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
� Activities You Can Perform as an Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
� Managing Forums as System Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 259

What is a Forum?
18. Managing and Using a Forum
A forum is a Web interface for a discussion board. A forum makes it possible for users to
post messages, sharing information and opinions about one or more topics. A forum can
be moderated, allowing the Moderator to control access to the forum and accept or reject
messages posted to it.
How Forums are Organized
Discussion boards are made up of the following objects:
Object Description
Category A container for one or more forums. You can choose to have the
forums within a category inherit the options and permissions
chosen for the category. A category resides within a folder on the
server.
Forum A container for one or more topics. A forum can reside within a
category or within a folder.
Topic A container for messages. When you create a topic, you also create
the first message it contains. By default, a topic resides within a
forum.
Message The content of a forum topic. Users can post, edit, and reply to
messages. Messages reside within topics and can contain
attachments.
Roles Associated with Forums
There are a variety of roles associated with a forum. By assigning roles, you can control
who is allowed to post, who is allowed only to read, and who is denied access to
participate. You can assign roles for a specific forum or forum category (“Modifying
Permissions for a Forum or Forum Category” on page 281) or create a forum Security
Realm for use throughout the server (“Managing Forum Security Realms” on page 284).
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 260

Standard Roles
The following roles are listed in order of increasing capability:
Forum role Capability Description
18. Managing and Using a Forum
Denied Access Does not have permission to view the forum.
Spectator Can view forum postings but cannot create topics or messages.
Spectators have the following capabilities:
View Can view forum topics and messages. See
“Getting Started with Forums as System
Administrator” on page 263.
Subscribe Can receive notifications to changes in the
forum. See “Subscribing to a Forum or Forum
Category” on page 265.
Rate Give a rating from Poor to Excellent to a topic
or message. See “Rating a Topic” on page 268.
Contributor In addition to the capabilities above, can do the following:
Create a topic Open a new topic and create the first message
in it. See “Creating a Topic” on page 269.
Create a message Reply to an existing topic. See “Creating a
Message in an Existing Topic” on page 270
Request a Request that message be deleted from the
retraction forum. See “Requesting a Retraction” on
page 271.
Moderator In addition to the capabilities above, can perform the following
actions:
Approve or reject In a moderated forum, allow a new topic or
a topic or message to be posted or deny permission to
message
do so. See “Moderating a Forum” on
page 272.
Edit a message Modify the content of an existing message.
See “Editing a Message” on page 273
Delete a topic or Delete an existing message, or a topic and all
message
messages within it. See “Deleting a Topic or
Message” on page 274
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 261

Forum role Capability Description
(Forum)
Administrator
The Other Role
18. Managing and Using a Forum
In addition to the standard roles, you can assign a role named Other. The Other role is
neither granted nor denied any permissions. This option is for use when a system
administrator has set some permissions manually that do not translate to a known forum
permission setting. See “Managing Permissions” on page 163.
How this Chapter is Organized
In addition to the capabilities above, can perform the following
actions:
Create a forum or
forum category
The following section (“Getting Started with Forums as System Administrator”) provides
general information on the initial setup of forums and forum categories, along with cross‐
references to specific procedures later in the chapter. The sections that follow are
organized to match the increasing capabilities associated with the various forum roles:
� “Activities You can Perform as a Spectator” on page 263
� “Activities You Can Perform as a Contributor” on page 269
� “Activities You Can Perform as a Moderator” on page 272
Create a new forum or forum category,
placing it in a specified folder. See “Creating a
Forum or Forum Category” on page 275.
Move a forum Move a forum from one folder to another.
“Moving a Forum or Forum Category” on
page 278.
Rename a forum
or forum
category
Rename a forum or forum category. See
“Renaming a Forum or Forum Category” on
page 279.
Edit options Determine what options will apply, such as
whether the forum is moderated or whether
attachments are allowed. “Modifying Options
of a Forum or Forum Category” on page 280.
Edit permissions Assign roles, such as Moderators,
Contributors, and Spectators. “Modifying
Permissions for a Forum or Forum Category”
on page 281.
Delete a forum or
forum category.
Delete a forum or forum category and all
topics within it. “Deleting a Forum or Forum
Category” on page 282.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 262

� “Activities You Can Perform as an Administrator” on page 275
� “Managing Forums as System Administrator” on page 283
Getting Started with Forums as System Administrator
18. Managing and Using a Forum
Before anyone can use forums in the server, the system administrator must create the first
forum or forum category, establish initial rules for usage, and establish permissions for
various types of forum user. The following steps represent some suggested activities you
can perform, depending on the your needs.
1 Create at least one forum or forum category, as described in “Creating a Forum or
Forum Category” on page 275.
2 If, necessary, modify usage options for forums and categories, as described in
“Modifying Options of a Forum or Forum Category” on page 280.
3 If you want to create the ability for users other than system administrators to
moderate or administrate forums or forum categories, do the following:
a Create one or more forum Security Realms in which you identify forum privileges
for users and groups, as described in “Managing Forum Security Realms” on
page 284.
b In individual forums and forum categories, assign forum Security Realms or
create custom sets of privileges, as described in “Modifying Permissions for a
Forum or Forum Category” on page 281.
After you have established forums and forum categories, the forum Moderators and
Administrators can manage daily activities.
Activities You can Perform as a Spectator
If you have Spectator privileges, you are limited to activities needed to find and read
forum topics:
This activity... Is described here...
Reading topics and messages “Viewing Forum Objects” on page 264
Receiving notifications of changes
to topics
Finding topics based on text or
keywords
Giving your opinion on the
relatively usefulness of a message
“Getting Started with Forums as System
Administrator” on page 263
“Searching in a Forum” on page 266
“Rating a Topic” on page 268
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 263

Viewing Forum Objects
18. Managing and Using a Forum
Anyone with at least Spectator privileges can view forum categories, forums, or topics. A
table containing forums and forum categories has the same columns:
Column Purpose
Name The name of the forum category, forum, or topic:
If the descendent is a... Click the name to display...
Forum category A table of forums or forum categories that
are descendents.
Forum A table of topics within the forum.
Topic A view of postings related to the topic.
Rating (Optional) For a forum, displays the average rating given to each
topic and the number of reviews. To rate a topic, see “Rating a
Topic” on page 268. A Forum Administrator can enable or disable
this option. See “Modifying Options of a Forum or Forum
Category” on page 280.
Posts The number of topics in descendent forums or forum categories.
Last Post The date, time, and Contributor of the most recent posting to any
descendent forum or forum category.
Created The date, time, and creator of the forum or forum category.
To view a forum, topic, or message
1 To locate the forum, topic, or message, do one of the following:
� Browse to the forum category that contains the forum you want to view.
� Browse to the forum that contains the topic and message you want to view.
� Search for the topic or message, as described in “Searching in a Forum” on
page 266.
2 Click the name of the forum to display it.
3 Within a forum, click the name of the topic to display it.
By default, a topic is displayed in the Details View panel.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 264

4 As needed click one of the following panels to change the topic view:
This panel... Presents this view of a topic...
Subscribing to a Forum or Forum Category
18. Managing and Using a Forum
Details View Each posting to the topic appears in a separate table row. If you are
at least a Contributor, the row includes a list of actions that are
available to you, such as Reply or Request Retraction.
Outline View A table contains summary information about each posting to the
topic. The row has the following columns:
Name The name of the posting. Click the name of the posting to
display it individually (same as Individual View).
Author The Contributor who made the posting
Date The date and time the posting was made.
Individual View Each posting is displayed on a separate page. If you are at least a
Contributor, the row includes a list of actions that are available to
you, such as Reply or Request Retraction. Standard navigation
features allow you to browse forward and backward among the
postings.
If you have at least Spectator privileges, you can subscribe to changes in a forum object:
If you subscribe to... You are notified when...
A forum A topic or a message is added or deleted.
A forum category A topic or a message is added or deleted, assuming you have
permission to view the parent forum.
To subscribe to a forum or a forum category
1 Browse to the forum or forum category to which you want to subscribe.
2 In the forum or forum category, click Subscribe.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 265

18. Managing and Using a Forum
3 On the Subscribe page, select subscription options for the forum or forum category:
This option... Determines whether or not...
Subscribe to this Forum Select Yes to enable subscription or No to disable
subscription.
Subscription Type Select how often to receive notifications of subscription
events. You can receive individual notifications (the
default), a daily digest, or a weekly digest.
Delivery Mechanism Notifications are delivered by E‐mail (the default) or
posted to your inbox.
4 Click Apply.
Tip! To find your inbox, go to the standard links at the top of each page and click My
Notifications.
Searching in a Forum
If you have at least Spectator privileges, you can search for a forum topic by name, text
within the topic, or based on criteria such as author name.
To search for a forum topic or message
1 Browse to any forum or forum category you have permission to view.
2 In the Search list, choose one of the following:
Choose this item... If...
Search All Forums You don’t know in which forum the topic belongs.
Search This Forum If you are certain the topic is a descendent of the current
forum or forum category.
3 In the query field, type text on which to search, using these guidelines:
� Text can be in the topic name or in the message text.
� The search is not case sensitive.
� Use whole words only.
� A space between keywords is an implicit OR (for example, one two finds either
one or two).
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 266

18. Managing and Using a Forum
� A plus sign (+) is an implicit AND (for example, +one +two must find both words
to match)
� Use an asterisk (*) as a multiple‐character wildcard or a question mark (?) as a
single‐character wildcard to complete a keyword (for example, thr*, th*e, and
th?ee all find three)
� Use double quotation marks (ʺ) to enclose a string (for example ʺone two threeʺ)
4 Click Go.
The Search Results page provides a list of topics that match the search criteria,
including the following information about each topic:
Column Description
Forum The name of the forum to which the topic belongs. Click the
forum name to open the forum.
Topic The name of the topic. Click the topic name to open the topic
in the Details View.
Message The name of the message. Click the message name to open the
message in the Individual View (without navigation aids).
Rating The average rating given to the topic and the number of
reviews.
Author The name of the user who created the topic. Click the author
name to display the user information page.
Created The date and time the message was created.
5 (Optional) To refine the search, click Advanced Search and use any or all of the
following fields:
Field Description
Query Type text on which to search, using the guidelines in step 3, or
a forum alias (see the Search Type field). By default, the field is
filled with the text of the previous search.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 267

Field Description
6 Click Search.
Rating a Topic
18. Managing and Using a Forum
Forum Searches for messages that are descendents of a specified
forum or forum category. In the Forum area, do one of the
following:
Browse Move the target resource to the Selected Items box
and then click Select.
Use Alias In the Alias Name field, type the alias of the target
resource. Click Test to determine if the alias is
valid and the alias target is the correct one. If the
alias is correct, click Select.
Author Searches for topics created by a specified user. Click Browse,
move the author to the Selected Items box click Select. You can
select only one user at a time.
Start Date Searches for topics last modified on or after the specified date.
Click Start Date and click the start date for the search.
End Date Searches for topics last modified on or before the specified
date. Click End Date and click the end date for the search.
Search Type Searches based on text or keywords. In the Search Type area,
choose either of the following options:
Full Text Searches for text within a topic using the
guidelines in step 3. The default.
Keyword Searches for a keyword assigned to a forum or
forum category.
A Forum Administrator has the capability to enable or disable the rating of topics within a
forum. If rating is enabled and if you have at least Spectator privileges, you can rate a
forum topic or message. A rating for a topic or a message is an average of values.
To rate a forum topic or message
1 Browse to a forum topic you have permission to view.
2 In either the Details View for the topic, or the Individual View for the topic or
message, click Rate at the right side of the title area.
If rating is disabled, the Rate link is not visible.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 268

3 On the Rate page, select one of the rating options.
The options and their values are:
Option Value
Excellent 10
Good 7
Poor 3
Unacceptable 0
4 Click Rate.
Activities You Can Perform as a Contributor
18. Managing and Using a Forum
If you have Contributor privileges, you can perform all of the activities of a Spectator
(“Activities You can Perform as a Spectator” on page 263) and also post topics and
messages:
This activity... Is described here...
Create a new topic “Creating a Topic” on page 269
Post a message in an existing
topic
Request that a message you have
posted be retracted
Creating a Topic
If you have at least Contributor privileges in a forum, you can create a topic and add the
first message to it.
To create a topic
1 Browse to the forum or forum category in which you want to create the topic.
If you have at least Contributor privileges, the New Topic panel appears on the forum
page.
2 In the forum, click New Topic.
3 In the Subject field, type the title for the new topic.
“Creating a Message in an Existing Topic” on
page 270
“Requesting a Retraction” on page 271
This value appears in the Name column on the forum page.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 269

4 In the editor, type the text of the first message for the topic.
18. Managing and Using a Forum
If the Allow HTML in Posts option is enabled for the forum, the editor allows you to
apply formatting to the text. Otherwise, only a text editor is available.
5 If the Allow Attachments option is enabled for the forum, you can add one or more
attachments by doing the following:
a In the Attachments area, click Add.
b In the Attachment field, click Browse, browse to the file you want to attach, and
click Open.
c In the File Encoding list, select the type of file encoding appropriate for the
attachment.
The default encoding is Non Text (binary).
d Click Add.
6 Click Post.
The attachment is added to the message.
If the forum is unmoderated, the topic is added to the forum page. If the forum is
moderated, the Moderator must approve the topic.
Creating a Message in an Existing Topic
A topic is a container that holds messages. If you have at least Contributor privileges, you
can create a message in an existing topic.
To create a message in an existing topic
1 To find the topic, do one of the following:
� Browse to the forum that contains the topic and click the topic name.
� Search for the topic, as described in “Searching in a Forum” on page 266 and click
the topic name.
By default, the topic opens in the Details View, which displays as many messages as
will fit on the screen.
2 Locate a message to which you want to reply and click Reply.
When you click a message, the text of that message is placed in the editor. You can
delete some or all of the text, depending on the nature of your reply.
3 In the editor, type the text of the message.
If the Allow HTML in Posts option is enabled for the forum, the editor allows you to
apply formatting to the text. Otherwise, only a text editor is available.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 270

18. Managing and Using a Forum
4 If the Allow Attachments option is enabled for the forum, you can add one or more
attachments by doing the following:
a In the Attachments area, click Add.
b In the Attachment field, click Browse, browse to the file you want to attach, and
click Open.
c In the File Encoding list, select the type of file encoding appropriate for the
attachment.
The default encoding is Non Text (binary).
d Click Add.
5 Click Post.
The attachment is added to the message.
If the forum is unmoderated, the message is added to the topic. If the forum is
moderated, the Moderator must approve the message.
Requesting a Retraction
If you are the author of a topic or a message, you can request that it be deleted from the
forum. A topic or message can be deleted only by someone with at least Moderator
privileges.
To request that a topic or message be retracted
1 To find the topic, do one of the following:
� Browse to the forum that contains the topic and click the topic name.
� Search for the topic, as described in “Searching in a Forum” on page 266 and click
the topic name.
By default, the topic opens in the Details View, which displays as many messages as
will fit on the screen.
2 If you are the author, you can request retraction of a topic or message as follows:
To request retraction of... If you are the author, do this...
A topic In the first message, click Request Retraction. The entire
topic is labeled Requested for Retraction.
A message Click Request Retraction. The message is labeled
Requested for Retraction.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 271

18. Managing and Using a Forum
The topic or message continues to appear until actually deleted by a Moderator or
Administrator. The topic or message waiting to be retracted is labeled (Requested for
Retraction).
Activities You Can Perform as a Moderator
If you have Moderator privileges, you can perform all of the activities of these roles:
This role Is described here
Spectator “Activities You can Perform as a Spectator” on page 263
Contributor “Activities You Can Perform as a Contributor” on page 269
You can also moderate forums, and edit or delete postings:
This activity... Is described here...
In a moderated forum, approve or
reject topics and messages
Edit the text of an existing
message
Delete a topic or message from a
forum
Moderating a Forum
“Moderating a Forum” on page 272
“Editing a Message” on page 273
“Deleting a Topic or Message” on page 274
In a moderated forum, if you have at least Moderator privileges, you can approve or reject
topics and messages.
Note: To ensure that you are aware of postings pending approval, you need to subscribe to
the forums for which you are responsible. See “Subscribing to a Forum or Forum
Category” on page 265.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 272

To moderate a forum
18. Managing and Using a Forum
1 When you receive notification of a change in a forum, do one of the following:
If your notification is... Do this...
Your My
Notifications page
The topic or message waiting to be approved is labeled (Pending Approval).
Contributors and Spectators cannot see the topic or message until it is approved.
2 In the new topic or message, do one of the following:
Editing a Message
If you have at least Moderator privileges, you can edit the text of a message and add or
remove attachments. The forum can be either moderated or unmoderated.
1 To find the message, do one of the following:
� Browse to the topic that contains the message.
� Search for the message, as described in “Searching in a Forum” on page 266 and
click the message name.
2 In the message, click Edit.
3 In the editor, edit the text as needed.
In the Inbox, click the Subject of the notification and then
click View Topic.
E‐mail In the E‐mail notification you receive, click View Topic.
To do this... Take this action...
Approve the
posting
In the message, click Approve.
Reject the posting In the message, click Reject.
Edit the posting In the message, click Edit. In the editor, make changes as
needed and then click Update. You can also edit postings in
unmoderated forums.
To edit a message
If the Allow HTML in Posts option is enabled for the forum, the editor allows you to
apply formatting to the text. Otherwise, only a text editor is available.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 273

18. Managing and Using a Forum
4 If the Allow Attachments option is enabled for the forum, you can add or remove
attachments by doing one of the following:
To this... Take this action...
Add an attachment Click Add. Browse to the file you want to attach and
click Open. Select the appropriate file encoding and
click Add.
Remove an attachment In the Attachment list, select the file to be removed
and click Remove.
5 Click Update.
Deleting a Topic or Message
If you have at least Moderator privileges, you can a topic or message. The forum can be
either moderated or unmoderated.
One reason to delete a topic or message is if the author has requested a retraction, as
described in “Requesting a Retraction” on page 271. A topic or message waiting to be
retracted is labeled (Requested for Retraction).
Note: To ensure that you are aware of postings for which a retraction has been requested,
you need to subscribe to the forums for which you are responsible. See “Subscribing to a
Forum or Forum Category” on page 265.
To delete a topic or message
1 To find the topic, do one of the following:
� Browse to the forum that contains the topic and click the topic name.
� Search for the topic, as described in “Searching in a Forum” on page 266 and click
the topic name.
By default, the topic opens in the Details View, which displays as many messages as
will fit on the screen.
2 In message to be deleted, click Delete.
If this if the first message in the topic, the entire topic is deleted.
3 To confirm that you want to delete the topic or message, click OK.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 274

Activities You Can Perform as an Administrator
18. Managing and Using a Forum
If you have Forum Administrator privileges, you can perform all of the activities of these
roles:
This role Is described here
Spectator “Activities You can Perform as a Spectator” on page 263
Contributor “Activities You Can Perform as a Contributor” on page 269
Moderator “Activities You Can Perform as a Moderator” on page 272
You can also create, manage, and delete forums and forum categories:
This activity... Is described here...
Create a new forum or forum
category within an existing
category
Move a forum or forum category
within existing categories
Rename an existing forum or
forum category
Determine what options will
apply, such as whether the forum
is moderated or whether
attachments are allowed
Assign roles, such as Moderators,
Contributors, and Spectators
Delete a forum or forum category
and all topics within it
Creating a Forum or Forum Category
“Creating a Forum or Forum Category” on
page 275
“Moving a Forum or Forum Category” on
page 278
“Renaming a Forum or Forum Category” on
page 279
“Modifying Options of a Forum or Forum
Category” on page 280
“Modifying Permissions for a Forum or Forum
Category” on page 281
“Deleting a Forum or Forum Category” on
page 282
A forum category is a container for one or more forums, or forum categories. Categories
are useful for organizing forums into groups having similar content. Another feature of a
category is that you can you can specify options that are inherited by the forums within it.
As system administrator or a user with system administrator privileges, you can create a
forum category. If you are not a system administrator, but have been given Forum
Administrator privileges for a forum category, you can create a descendent forum or
category.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 275

To create a forum or forum category
1 If you are a system administrator, do the following:
a As system administrator:
Administration > Content > Forum Administration.
b Do one of the following:
To create a... Do this...
Forum category Click Create New Forum Category.
Forum Click Create New Forum.
2 If you are a Forum Administrator, do the following:
18. Managing and Using a Forum
a Browse to a forum category for which you have Administrator privileges.
b Do one of the following:
To create a... Do this...
Forum category Click New Category.
Forum Click New Forum.
3 In the Name field, type a name to identify the forum or forum category.
There are no restrictions on what characters you can use for this name. The maximum
length for a name is 255 characters.
4 (Optional) In the Description field, type a description for the forum or forum category,
which appears in the Description field of the folder that contains the category.
5 (Optional) Add one or more keywords to be used in searching for the forum or forum
category by doing the following:
a In the Keywords area, click Add.
b In the prompt window that opens, type a keyword and then click OK.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 276

6 In the Parent Container area, do one of the following:
7 Click Next.
8 On the Options page, select options for the forum or forum category:
9 Click Next.
Click this... And do this...
18. Managing and Using a Forum
Browse Move the target folder to the Selected Items box and then click
Select.
Use Alias In the Alias Name field, type the alias of the target folder. Click
Test to determine if the alias is valid and the alias target is the
correct one. If the alias is correct, click Select.
Tip! If you create a forum or forum category from within a forum category, that
category is the default container.
This option... Determines whether or not...
Allow Un-moderated
Posts
Messages must be approved by a Moderator or
Administrator before they are posted. Select Yes to allow
unmoderated posts or No to require moderated posting.
Allow Attachments Contributors can post attachments to messages. Select Yes
to allow attachments or No to disable the posting of
attachments.
Allow HTML in Posts Messages can contain HTML formatting. Select Yes to
allow HTML formatting or No to limit postings to plain
text.
Allow Ratings Contributors and Spectators can rate individual messages.
Select Yes to allow the rating of messages or No to disable
the rating feature.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 277

18. Managing and Using a Forum
10 On the Permissions page, determine what forum Security Realm is to be applied to
the forum category, by doing one of the following:
Click this... And do this...
Browse Move a forum real to the Selected Items box and click Select. The
default choices are:
Anonymous Users are Contributors Anyone, including users
without login accounts, can
view the forum and post
messages to it.
Authenticated Users are Contributors Only authenticated users can
post messages to a forum.
Use Alias In the Alias Name field, type the alias of the target forum realm. Click
Test to determine if the alias is valid and the alias target is the correct
one. If the alias is correct, click Select.
Note: If you do not choose any forum Security Realm, the forum or forum category
inherits the permissions set for the parent container in which it was created. You can
later change permissions to assign members to the various forum roles and to cause
descendents to inherit permissions. See “Modifying Permissions for a Forum or
Forum Category” on page 281.
11 Click Create.
Moving a Forum or Forum Category
As system administrator or a user with system administrator privileges, you can move an
existing forum category to a new location. If you are a Forum Administrator, you can also
move a forum or forum category, but only to a location where you have Administrator
privileges.
To move a forum or forum category
1 As a system administrator or a Forum Administrator, browse to the folder that
contains the forum or forum category and click the name to open it.
2 In the forum or forum category, click Move.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 278

18. Managing and Using a Forum
3 On the Move page, do one of the following to find the target folder where the forum
or forum category is to reside:
Click this... And do this...
Browse Move the target folder to the Selected Items box and then click
Select.
Use Alias In the Alias Name field, type the alias of the target folder. Click
Test to determine if the alias is valid and the alias target is the
correct one. If the alias is correct, click Select.
4 With the new location selected, click Move.
Renaming a Forum or Forum Category
As system administrator, user with system administrator privileges, or a Forum
Administrator, you can rename a forum or forum category and edit keywords associated
with it.
To rename a forum or forum category
1 As a system administrator or a Forum Administrator, browse to the folder that
contains the forum or forum category and click the name to open it.
2 In the forum category, click Rename.
3 In the Name field, type a new name to identify the forum or forum category.
There are no restrictions on what characters you can use for this name. The maximum
length for a name is 255 characters.
4 (Optional) In the Description field, type a description of the forum or forum category,
which appears in the Description field of the folder that contains the forum or forum
category.
5 (Optional) Add, edit, or remove keywords to be used in searching for the forum or
forum category by doing one of the following in the Keywords area:
To do this... Do this...
Add a keyword Click Add, type a new keyword in the prompt window,
and click OK.
Edit a keyword Select the keyword, click Edit, type a revised keyword in
the prompt window, and click OK.
Remove a keyword Select the keyword, click Remove, and click OK.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 279

6 Click Apply.
Modifying Options of a Forum or Forum Category
18. Managing and Using a Forum
As system administrator, a user with system administrator privileges, or a Forum
Administrator, you can modify the options of a forum or forum category. You can specify
whether or not the options apply to any descendant forum or forum category.
To modify options of a forum or forum category
1 As a system administrator or a Forum Administrator, browse to the folder that
contains the forum or forum category and click the name to open it.
2 In the forum category, click Options.
3 On the Options page, change one or more of the following options:
This option... Determines whether or not...
Allow Un-moderated
Posts
Messages must be approved by a Moderator or
Administrator before they are posted. Select Yes to allow
unmoderated posts or No to require moderated posting.
Allow Attachments Contributors can post attachments to messages. Select Yes
to allow attachments or No to disable the posting of
attachments.
Allow HTML in Posts Messages can contain HTML formatting. Select Yes to
allow HTML formatting or No to limit postings to plain
text.
Allow Ratings Contributors and Spectators can rate individual messages.
Select Yes to allow the rating of messages or No to disable
the rating feature.
4 Use the Apply to Descendents option to specify whether or not the options apply to any
descendant forum or forum category:
Do this... To do this...
Select the check
box
Clear the check
box
To cause all descendant forums and forum categories to inherit
the options.
To specify that descendant forums and forum categories do
not automatically inherit the options.
You can override options within individual descendent forums and forum categories.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 280

18. Managing and Using a Forum
Modifying Permissions for a Forum or Forum Category
As system administrator, a user with system administrator privileges, or a Forum
Administrator, you can modify the permissions of a forum or forum category. You can
specify whether or not the permissions apply to any descendant forum or forum category.
To modify permissions of a forum or forum category
1 As a system administrator or a Forum Administrator, browse to the folder that
contains the forum or forum category and click the name to open it.
2 In the forum category, click Permissions.
3 On the Permissions page, do one of the following:
� Select the Realm option (the default) and determine what forum Security Realm is
to be applied to the forum category, by doing one of the following:
—OR—
Click this... And do this...
Browse Move the target forum realm to the Selected Items box and then
click Select. The default choices are:
Anonymous Users are
Contributors
Authenticated Users are
Contributors
� Provide a set of custom permissions by doing the following:
a Select the Custom option and click Edit.
Anyone, including users
without login accounts, can
view the forum and post
messages to it.
Only authenticated users can
post messages to a forum.
With Forum Realms in the Selected Items panel, click Select.
Use Alias In the Alias Name field, type the alias of the target forum realm.
Click Test to determine if the alias is valid and the alias target is
the correct one. If the alias is correct, click Select.
b From the Scheme list, select the authentication scheme to be used for this forum
category.
The default authentication scheme is inherited from the parent of the forum or
forum category or, lacking any custom authentication scheme, from the system
default. For information on authentication schemes, see “Managing Permissions”
on page 163.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 281

c In the Authorization table, do one of the following:
18. Managing and Using a Forum
d After you have finished activities in the Authorization table, click Apply.
4 On the Permissions page, use the Apply to Descendents option to specify whether or not
the permissions apply to any descendant forum or forum category:
You can override options within individual descendent forums and forum categories.
5 Click Apply.
To do this... Do this...
Add a new user
or group
Edit a user or
group
Delete a user or
group
Do this... To do this...
Select the check
box
Clear the check
box
Deleting a Forum or Forum Category
Click Add Users or Groups. Move the users and groups to
the Selected Items box and then click Next. From the Capacity
list, select the role to be used by these users and groups
and click Apply. Standard roles are described in “Standard
Roles” on page 261.
Locate the user or group in the Authorization table and click
Properties for the resource. From the Capacity list, select
the role to be used by the resource and click Apply.
Standard roles are described in “Standard Roles” on
page 261.
Locate the user or group in the Authorization table and click
Delete for the resource. To confirm that the resource
should be deleted, click OK.
To cause all descendant forums and forum categories to inherit
the permissions.
To specify that descendant forums and forum categories do
not automatically inherit the permissions.
As system administrator, a user with system administrator privileges, or a Forum
Administrator, you can delete a forum or forum category.
Note: Deleting a forum category also deletes any forums or forum categories that are its
descendents.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 282

To delete a forum or forum category
18. Managing and Using a Forum
1 As a system administrator or a Forum Administrator, browse to the folder that
contains the forum or forum category and click the name to open it.
2 In the forum or forum category, click Delete.
3 To confirm that the forum or forum category should be deleted, click OK.
Managing Forums as System Administrator
As a system administrator or a user with system administrator privileges, you can
perform all of the activities of these forum roles:
This role Is described here
Spectator “Activities You can Perform as a Spectator” on page 263
Contributor “Activities You Can Perform as a Contributor” on page 269
Moderator “Activities You Can Perform as a Moderator” on page 272
Administrator “Activities You Can Perform as an Administrator” on page 275
As system administrator, you can perform the following activities from the
Administrative Dashboard:
This activity... Is described here...
Create forums and forum
categories
Create, edit, and delete forum
Security Realms
Perform advanced searches for
forum topics
Create a list of topics and
messages pending approval
Create a list of messages
requested for retraction
“Creating a Forum or Forum Category” on
page 275
“Managing Forum Security Realms” on page 284
“Searching Forums as System Administrator” on
page 286
“Listing Topics and Messages Pending Approval”
on page 288
“Listing Messages Requested for Retraction” on
page 289
Create a variety of forum reports “Running Forum Reports” on page 290
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 283

Managing Forum Security Realms
By default, there are two forum Security Realms:
This Security Realm... Allows this type of access...
18. Managing and Using a Forum
Anonymous users are Contributors Anyone, including users without login
accounts, can view the forum and post
messages to it.
Authenticated users are Contributors Only authenticated users can post a message.
As a system administrator, you can create additional forum Security Realms that specify
the forum privileges of users and groups. Once you have established a forum Security
Realm, you can apply it to forums and forum categories, as described in “Modifying
Permissions for a Forum or Forum Category” on page 281.
Creating a Forum Security Realm
As a system administrator or a user with system administrator privileges, you can create a
new forum Security Realm.
To create a forum Security Realm
1 As system administrator:
Administration > Content > Forum Administration > Manage Forum Security Realms > Create
New Realm.
2 In the Name field, type a name to identify the forum Security Realm.
There are no restrictions on what characters you can use for this name. The maximum
length for a name is 255 characters.
3 (Optional) In the Description field, type a description for the forum Security Realm,
which appears in the Description field on the Manage Forum Security Realms page.
4 Click Create.
5 On the Manage Forum Security Realms page, click Properties for the forum
Security Realm you have just created.
6 From the Scheme list, select the authentication scheme to be used for this forum
category.
The default authentication scheme is inherited from the parent of the Security Realm,
or, lacking any custom authentication scheme, from the system default. For
information on authentication schemes, see “Managing Permissions” on page 163.
7 Click Add Users or Groups.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 284

18. Managing and Using a Forum
8 Select the users and groups to be given a set of forum privileges, such as Moderator,
as described in “Standard Roles” on page 261, by doing the following:
a Move the users and groups to the Selected Items box and then click Next.
b From the Capacity list, select the role to be used by these users and groups and
click Apply.
9 Repeat step 8 for each set of privileges you want to include in the forum Security
Realm.
10 Click Apply.
11 Click Done.
You can now apply the forum Security Realm to any forum or forum category.
Editing a Forum Security Realm
As a system administrator or a user with system administrator privileges, you can edit an
existing forum Security Realm.
To edit a forum Security Realm
1 As system administrator:
Administration > Content > Forum Administration > Manage Forum Security Realms.
2 In the Forum Administration page, click Manage Forum Security Realms.
3 On the Manage Forum Security Realms page, click Properties for the forum
Security Realm you want to edit.
4 If you want to change the authentication scheme to be used for this forum Security
Realm, from the Scheme list, select the new authentication scheme.
5 If you want to edit forum privileges in the Authorization table, do one or more of the
following:
To do this... Do this...
Add a new user
or group
Click Add Users or Groups. Move the users and groups to the
Selected Items box and then click Next.
From the Capacity list, select the role to be used by these users
and groups and click Apply. Standard roles are described in
“Standard Roles” on page 261.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 285

To do this... Do this...
Edit a user or
group
Delete a user or
group
6 After you have finished editing, click Apply.
18. Managing and Using a Forum
The changes are applied to any forum or forum category that uses this forum Security
Realm.
Deleting a Forum Security Realm
As a system administrator or a user with system administrator privileges, you can delete
an existing forum Security Realm.
To delete a forum Security Realm
Locate the user or group in the Authorization table and click
Properties for the resource. From the Capacity list, select the role
to be used by the resource and click Apply. Standard roles are
described in “Standard Roles” on page 261.
Locate the user or group in the Authorization table and click
Delete for the resource. To confirm that the resource should be
deleted, click OK.
1 As system administrator:
Administration > Content > Forum Administration > Manage Forum Security Realms.
2 In the Forum Administration page, click Manage Forum Security Realms.
3 On the Manage Forum Security Realms page, click Delete for the forum Security
Realm you want to delete.
4 To confirm that you want to delete the forum Security Realm, click OK.
5 On the Manage Forum Security Realms page, click Done.
Any forum or forum category that used the deleted forum Security Realm reverts to
the set of permissions it inherited from the parent container in which it was created.
Searching Forums as System Administrator
As a system administrator or a user with system administrator privileges, you can
perform a search of forum topics from within the Forum Administration page. The
capabilities are similar to performing an advanced search from within a forum or forum
category.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 286

To search for a forum topic or message as a system administrator
1 As system administrator:
Administration > Content > Forum Administration > Search Forums.
18. Managing and Using a Forum
2 In the query field, type text on which to search, using these guidelines:
� Text can be in the topic name or in the message text.
� The search is not case sensitive.
� Use whole words only.
� A space between keywords is an implicit OR (for example, one two finds either
one or two).
� A plus sign (+) is an implicit AND (for example, +one +two must find both words
to match)
� Use an asterisk (*) as a multiple‐character wildcard or a question mark (?) as a
single‐character wildcard to complete a keyword (for example, thr*, th*e, and
th?ee all find three)
� Use double quotation marks (ʺ) to enclose a string (for example ʺone two threeʺ)
3 (Optional) To refine the search, click Advanced Search and use any or all of the
following fields:
Field Description
Query Type text on which to search, using the guidelines in step 2, or
a forum alias (see the Search Type field). By default, the field is
filled with the text of the previous search.
Forum Searches for messages that are descendents of a specified
forum or forum category. In the Forum area, do one of the
following:
Browse Move the target resource to the Selected Items box
and then click Select.
Use Alias In the Alias Name field, type the alias of the target
resource. Click Test to determine if the alias is
valid and the alias target is the correct one. If the
alias is correct, click Select.
Author Searches for topics created by a specified user.
Click Browse.Move the user to the Selected Items box and then
click Select. You can select only one user at a time.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 287

Field Description
4 Click Search.
18. Managing and Using a Forum
Start Date Searches for topics last modified on or after the specified date.
Click Start Date and click the start date for the search.
End Date Searches for topics last modified on or before the specified
date. Click End Date and click the end date for the search.
Search Type Searches based on text within a topic or by alias. In the Search
Type area, choose either of the following options:
Full Text Searches for text using the guidelines in step 2.
The default.
Keyword Searches for a keyword assigned to a forum or
forum category.
The Search Results page provides a list of topics that match the search criteria,
including the following information about each topic:
Column Description
Forum The name of the forum to which the topic belongs. Click the
forum name to open the forum.
Topic The name of the topic. Click the topic name to open the topic
in the Details View.
Message The name of the message. Click the message name to open the
message in the Individual View (without navigation aids).
Rating The average rating given to the topic and the number of
reviews.
Author The name of the user who created the topic. Click the author
name to display the user information page.
Created The date and time the message was created.
Listing Topics and Messages Pending Approval
As a system administrator or a user with system administrator privileges, you can create a
list of forum topics and messages pending approval. Messages posted to moderated
forums do not appear until they have been approved by someone with at lease Moderator
privileges. While forum Moderators and Administrators can be notified of changes to
forums by subscribing (“Subscribing to a Forum or Forum Category” on page 265), only a
system administrator can create a list of all forum messages pending approval.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 288

To search for a forum topic or message pending approval as a system administrator
18. Managing and Using a Forum
� As system administrator:
Administration > Content > Forum Administration > List Topics and Messages Pending Approval.
The Forums Reports page provides a list of topics that are pending approval,
including the following information about each topic:
Column Description
Forum The name of the forum to which the topic belongs. Click the
forum name to open the forum.
Topic The name of the topic. Click the topic name to open the topic
in the Details View.
Message The name of the message. Click the message name to open the
message in the Individual View (without navigation aids).
Author The name of the user who created the topic. Click the author
name to display the user information page.
Created Date The date and time the message was created.
Listing Messages Requested for Retraction
As a system administrator or a user with system administrator privileges, you can create a
list of forum messages that have been requested for retraction. Messages requested for
retraction can be deleted only by someone with at lease Moderator privileges. While
forum Moderators and Administrators can be notified of changes to forums by
subscribing (“Subscribing to a Forum or Forum Category” on page 265), only a system
administrator can create a list of all forum messages requested for retraction.
To search for a forum message requested for retraction as a system administrator
� As system administrator:
Administration > Content > Forum Administration > List Messages Requested for Retraction.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 289

18. Managing and Using a Forum
The Forums Reports page provides a list of topics that are requested for retraction,
including the following information about each topic:
Column Description
Forum The name of the forum to which the topic belongs. Click the
forum name to open the forum.
Topic The name of the topic. Click the topic name to open the topic
in the Details View.
Message The name of the message. Click the message name to open the
message in the Individual View (without navigation aids).
Author The name of the user who created the topic. Click the author
name to display the user information page.
Created Date The date and time the message was created.
Running Forum Reports
As a system administrator or a user with system administrator privileges, you can create
reports based on a variety of criteria.
To run a forum report
1 As system administrator:
Administration > Content > Forum Administration > Run Report.
2 In the Report Type panel choose from among several options:
This option... Provides the following report...
Messages
Pending
Approval
Messages
Requested for
Retraction
Messages by
Forums
Messages by
Forums by
Authors
A list of messages in moderated forums that are pending
approval. Same as the report created in “Listing Topics and
Messages Pending Approval” on page 288.
A list of messages that are requested for retraction. Same as the
report created in “Listing Messages Requested for Retraction”
on page 289.
A list of forums and the number of topics (T) and messages
(M) in each. Click a forum name to open the forum.
A list of forums, the names of authors posting to each, and the
number of topics (T) and messages (M) by each author. Click a
forum name to open the forum. Click the author name to
display the user information page.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 290

This option... Provides the following report...
Messages by
Authors
Messages by
Authors by
Forums
18. Managing and Using a Forum
A list of authors and the number of topics (T) and messages
(M) by each author. Click the author name to display the user
information page.
A list of authors and the forums they post to, along with the
number of topics (T) and messages (M) posted to each forum.
Click the author name to display the user information page.
Click a forum name to open the forum.
3 (Optional) To refine the scope of the report, use any or all of the following fields:
Field Description
Forum Root Limits the report to messages that are descendents of a
specified forum or forum category. In the Forum Root area, do
one of the following:
Browse Move the target resource to the Selected Items box
and then click Select.
Use Alias In the Alias Name field, type the alias of the target
resource. Click Test to determine if the alias is
valid and the alias target is the correct one. If the
alias is correct, click Select.
Author Limits the report to messages created by a specified user.
Click Browse. Move the user to the Selected Items box and then
click Select. You can select only one user at a time.
Start Date Limits the report to messages last modified on or after the
specified date. Click Start Date and click the start date for
the report.
End Date Limits the report to messages last modified on or before the
specified date. Click End Date and click the end date for the
report.
Interval Adds columns to report the number of topics (T) and messages
(M) in each interval. For example, if you choose the Daily
option, the report includes a set of T and M columns for each
day in the range reported on. Chose one of these options:
None No interval is specified. The default.
Daily Number of topics and messages each day.
Weekly Number of topics and messages each week.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 291

Field Description
4 Click Run Report.
18. Managing and Using a Forum
Monthly Number of topics and messages each month.
Yearly Number of topics and messages each year.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 292

Part IV. Page Development
� Managing Pages in My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
� Working with Skins in My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
� Working with Shells in My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 293

IV. Page Development
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 294

Chapter 19. Managing Pages in My webMethods Server
� Overview of Page Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
� Creating and Modifying Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
� Adding and Managing Portlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
� Controlling the Layout of the Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
� Creating Links for Single Sign-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 295

Overview of Page Development
19. Managing Pages in My webMethods Server
My webMethods Server aggregates information from a variety of sources and serves that
information as Web pages. A static Web site served by a Web server like Apache or
Internet Information Services (IIS) usually has three kinds of items: folders, documents,
and executables. Executables, such as .cgi scripts, enable a Web server to serve dynamic
content or process form data from a Web application. My webMethods Server can also
contain these items, but executable‐like presentation and logic are encapsulated as
portlets. Instead of serving a simple directory listing when a client requests a folder, the
server can serve a sophisticated page that combines the contents of the folder into a
dynamic Web page. By wiring two or more portlets together on a page, you can even
create a whole new Web application (see “Wiring Portlets” on page 304).
You can create new or simpler names for server resources, configure the server to
recognize those names when they appear in a URL, and automatically redirect a user to
the named item. In the server, a simple name that points to a server resource is called an
alias. To manage aliases for portlets, see “Managing Portlet Aliases” on page 303. To
manage aliases for a page, see “Managing Aliases” on page 190.
All Web pages My webMethods Server serves are generated dynamically. You can
configure the server to serve the exact same content to different users using a different
look and feel for each user. You can also configure the server to serve specific pages with
differing looks and feels. The look and feel of a page is called a skin. See Chapter 20,
“Working with Skins in My webMethods Server” for more information about skins.
You can configure the server to serve the same page content to different users using
different headers, footers, or side‐navigations for each user. You can also configure the
server to serve specific pages with differing headers, footers, or side‐navigations. The
specific combination of a header, footer, and side‐navigation is called a shell. See
Chapter 21, “Working with Shells in My webMethods Server” for more information about
shells.
Editing My webMethods Pages as System Administrator
While pages in My webMethods applications are already well defined, there are some
cases that call for a system administrator to edit a page, such as to add a new Task chart.
As a system administrator, you can navigate to any page displayed in My webMethods by
following a path from the root Folder. For example, if the navigation path in My
webMethods is this:
Monitoring > Business > Tasks > Task Charts
The path for a system administrator to reach the same page is this:
Folders > My webMethods Applications > Fabric Tasks > Business > Tasks > Task Charts
You may, however, encounter a situation in which a page appears to have no content
(does not display any folders), even though you know you should be able to navigate to
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 296

19. Managing Pages in My webMethods Server
another level. To display the page content, in the address field of the browser append this
text to the end of the page URL:
?layout=details
For example, this URL:
http://server:8585/meta/default/wm_xt_fabricfolder/0326
becomes this:
http://server:8585/meta/default/wm_xt_fabricfolder/0326?layout=details
In this way, you can navigate deeper into the taxonomy until you reach the appropriate
page.
Creating and Modifying Pages
In My webMethods Server, the terms page and folder are synonyms. By default, when a
client requests a folder, the server combines all the contents of the folder into a dynamic
page.
A page is made up of rows, column, and portlets. On a page, the server displays any items
that are not actually portlets, such as documents, links, or sub‐folders, in a way that
makes them look and behave like portlets. You can move any portlet on a page into any
row or column on that page, and you can create any number of rows and columns. You
can also order portlets from top to bottom within a column. By default, a new page has
one row containing two columns.
The following sections describe basic ways of creating and modifying a page:
This activity... Is described here...
Create a new page. “Creating a Page” on page 297
Add, reposition, or remove rows in a
page.
Add, reposition, or remove columns in a
page.
Creating a Page
To create a new page, use the following procedure.
To create a new page
1 As system administrator, move to the folder where the new page is to reside.
2 In the folder title bar, click Tools > New > Page.
“Manipulating Rows on a Page” on
page 298
“Manipulating Columns on Pages” on
page 299
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 297

3 In the Name field, type the name of the new page.
19. Managing Pages in My webMethods Server
4 (Optional) In the Description field, type a description of the new page.
5 Click Create.
6 In the folder, click the new page you have created.
A blank page appears in your browser window.
Manipulating Rows on a Page
On a page, you can add a row, reposition a row, or remove a row.
Adding a Row to a Page
To add a row to a page, use the following procedure.
To add a row to a page
1 As system administrator, move to the page.
2 In the page title bar, click Tools > Edit Page.
3 In the Root list of the Available Portlets panel, click Page Features.
4 In the Page Features list of the Available Portlets panel, drag the New Row portlet and
drop it onto the page at the location where you want to add the row.
A red box appears beneath the cursor location whenever the cursor is over a page row
location, indicating where the row would be positioned if you released the mouse
button.
5 Drag a new row portlet for each row you want to add to the page.
6 On the left side of the page control area, click Save.
A blank row appears on your page.
Repositioning a Row on a Page
To reposition a row on a page, use the following procedure.
To reposition a row on a page
1 As system administrator, move to the page.
2 In the page title bar, click Tools > Edit Page.
3 Hold the mouse down over the title bar of the row you want to reposition.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 298

‘
4 Drag the row and drop it onto the new location on the page.
19. Managing Pages in My webMethods Server
A red box appears beneath the cursor location whenever the cursor is over a page row
location, indicating where the row would be positioned if you released the mouse
button.
5 On the left side of the page control area, click Save.
Removing a Row from a Page
To remove a row from a page, use the following procedure.
To remove a row from a page
1 As system administrator, move to the page.
2 In the page title bar, click Tools > Edit Page.
3 On the title bar of the row you want to delete, click Delete.
Note: Any portlets in the deleted row are permanently deleted from the page.
4 On the left side of the page control area, click Save.
Manipulating Columns on Pages
On a page, columns appear within rows. You can add a column, reposition a column, or
remove a column.
Adding Columns to a Page
To add a column to a page, use the following procedure.
To add a column to a page
1 As system administrator, move to the page.
2 In the page title bar, click Tools > Edit Page.
3 In the Root list of the Available Portlets panel, click Page Features.
4 In the Page Features list of the Available Portlets panel, drag the New Column portlet and
drop it onto the page in the row where you want to add the column.
A red box appears beneath the cursor location whenever the cursor is over a page
column location, indicating where the column would be positioned if you released the
mouse button.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 299

19. Managing Pages in My webMethods Server
5 Drag a new column portlet for each column you want to add to the page.
6 On the left side of the page control area, click Save.
A blank column appears on your page.
Repositioning a Column on a Page
To reposition a column on a page, use the following procedure.
To reposition a column on a page
1 As system administrator, move to the page.
2 In the page title bar, click Tools > Edit Page.
3 Hold the mouse down over the title bar of the column you want to reposition.
4 Drag the column and drop it onto the new location on the page
A red box appears beneath the cursor location whenever the cursor is over a page
column location, indicating where the column would be positioned if you released the
mouse button.
5 On the left side of the page control area, click Save.
Removing a Column from a Page
To remove a column from a page, use the following procedure.
To remove a column from a page
1 As system administrator, move to the page.
2 In the page title bar, click Tools > Edit Page.
3 On the title bar of the column you want to delete, click Delete.
Note: Any portlets in the deleted column are permanently deleted from the page
4 On the left side of the page control area, click Save.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 300

Adding and Managing Portlets
19. Managing Pages in My webMethods Server
Portlets provide the functionality for a page. There are several functions you can perform
on portlets from within My webMethods Server:
These functions... Are described here...
Add, reposition, or remove a portlet. “Manipulating Portlets on Pages” on
page 301
Modify the settings of a portlet. “Modifying the Settings of an Existing
Portlet” on page 303
Add and remove portlet aliases. “Managing Portlet Aliases” on page 303
Make connections between portlets. “Wiring Portlets” on page 304
Manipulating Portlets on Pages
On a page, portlets appear within columns. You can add a portlet, reposition a portlet, or
remove a portlet.
Adding a Portlet to a Page
To add a portlet to a page, use the following procedure.
To add a portlet to a page
1 As system administrator, move to the page.
2 In the page title bar, click Tools > Edit Page.
3 In the Root list of the Available Portlets panel, click Portlets.
4 In the Portlets list of the Available Portlets panel, click the category that contains the
portlet you want to add to the page.
5 In the appropriate category list of the Page Editor, drag the portlet and drop it onto the
page in the column where you want it to reside.
A red box appears beneath the cursor location whenever the cursor is over a page
column, indicating where the portlet would be positioned if you released the mouse
button.
6 On the left side of the page control area, click Save.
The portlet appears on your page.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 301

Repositioning a Portlet in a Page
To reposition a portlet on a page, use the following procedure.
To reposition a portlet on a page
1 As system administrator, move to the page.
2 In the page title bar, click Tools > Edit Page.
19. Managing Pages in My webMethods Server
3 Hold the mouse down over the title bar of the portlet you want to reposition.
4 Drag the portlet and drop it onto the new location on the page
A red box appears beneath the cursor location whenever the cursor is over a page
column, indicating where the portlet would be positioned if you released the mouse
button.
5 On the left side of the page control area, click Save.
Tip! If you are the system administrator or have administrator privileges, you can move a
portlet on the page without editing the page. Place the cursor over Move and drag the
portlet where you want to move it.
Removing a Portlet from a Page
To remove a portlet from a page, use the following procedure.
To remove a portlet from a page
1 As system administrator, move to the page.
2 In the page title bar, click Tools > Edit Page.
3 On the title bar of the portlet you want to delete, click Delete.
4 On the left side of the page control area, click Save.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 302

Modifying the Settings of an Existing Portlet
19. Managing Pages in My webMethods Server
You can configure the settings of a portlet independently from settings of the page in
which it resides. Some of the settings are properties defined during portlet development.
To modify the properties of a portlet
1 As system administrator, move to the portlet.
2 In the portlet title bar, click Tools > Properties.
3 On the Properties page make modifications as appropriate:
Make changes here... If you want to...
General Change the name or description of the portlet.
Properties Change or set properties designed into the portlet at the
time it was developed. For example, a portlet dealing with
locations might require a postal code.
Display Change how the portlet is displayed with respect to the
page.
Maintenance Add or remove aliases by which the portlet can be called
by other sites, as described in “Managing Portlet Aliases”
on page 303.
4 At the bottom of the page, click Apply.
Tip! If you are editing a page, you can also set portlet properties from the page control area
at the bottom of the page. In edit mode, click a portlet to select it. In the page control area,
click the Properties panel.
Managing Portlet Aliases
Just as you can assign aliases to be used in accessing a page from another Web site or Web
application, you can assign one or more aliases to individual portlets.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 303

Adding an Alias to a Portlet
To add an alias to a portlet, use the following procedure.
To add an alias to a portlet
1 As system administrator, move to the portlet.
2 In the portlet title bar, click Tools > Properties.
3 In the Aliases section of the Properties page, click Add.
4 In the Script Prompt field, type the portlet alias to be added.
5 At the bottom of the page, click Apply.
Removing an Alias from a Portlet
To remove an alias from a portlet, use the following procedure.
To remove an alias from a portlet
1 As system administrator, move to the portlet.
2 In the portlet title bar, click Tools > Properties.
19. Managing Pages in My webMethods Server
3 In the Aliases section of the Properties page, select the alias to be removed and click
Remove.
4 At the bottom of the page, click Apply.
Wiring Portlets
You can connect, or wire, any property of any portlet on a page to any property of any
other portlet on the same page. When you wire one property to another, whenever the
page is rendered, the server automatically sets the value of the destination property to the
value of the source property. This feature allows you to quickly create a composite
application out of several different portlets.
For example, if you create a page with two portlets, one a search form and one a search
results display, you can wire the search form value (the source value) to the results
display input value (the destination value). When a user enters some information into the
search form and submits it, the server updates the results display to the results of that
search.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 304

To wire one portlet to another
19. Managing Pages in My webMethods Server
1 Decide which portlet is the wiring source and which is the wiring destination.
The destination portlet property receives its property value from the source portlet
property.
2 In the portlet title bar, click Tools > Wiring.
The wiring dialog page displays a list of properties on the destination portlet that are
available for wiring to other portlets.
3 In the Portlet list for each property to be wired, select the source portlet.
4 Click Submit.
The run‐time view of this page should display the destination portlet with whatever
values are configured in the source portlets.
Tip! If you are editing a page, you can also perform wiring from the page control area at
the bottom of the page. In edit mode, click a portlet to select it. In the page control area,
click the Wiring panel.
Global Wiring
Users and groups have a set of Principal Attributes that you can wire to a portlet. For
example, suppose a portlet uses a postal code to display certain information when a user
views a page. If the postal code is provided by wiring from a Principal Attribute Provider,
when the postal code attribute is modified within a directory service, the portlet uses the
modified attribute value.
To wire a Principal Attribute to a portlet
1 As system administrator, move to the portlet.
2 In the portlet title bar, click Tools > Wiring.
3 In the Portlet list, choose Other.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 305

19. Managing Pages in My webMethods Server
4 Click Global Wiring Data, move a Principal Attribute Provider to the Selected Items box
and click Select.
Depending on what Principal Attributes exist on the server, you can see one or more
of the following:
Principal Attribute Provider Description
Core Attributes Wiring A set of attributes valid for all users of the server.
User Profile Wiring A set of user attributes maintained by the system
administrator.
Ldap Attributes Wiring A set of attributes exposed from external directory
services.
5 Return to the Portlet list and select the Principal Attribute Provide to be used.
6 Click Browse.
7 From the list, select the attribute you want to wire to the portlet and click Select.
The portlet is now wired to use the attribute value belonging to the user who views
the page on which it appears.
See Chapter 11, “Attribute Providers” for information about Principal Attribute
Providers.
Controlling the Layout of the Page
You can control the layout of the page by modifying properties of rows, columns, and
portlets as you place them on the page. You can use these properties on regular pages and
on the Header, Leftnav, Rightnav, and Footer shell sections. Some layout properties are
ignored when the page is displayed as a page and some are ignored when the page is used
as a shell section.
To control page layout by modifying row, column, and portlet properties
1 As system administrator, move to the page.
2 In the portlet title bar, click Tools > Edit Page.
3 In edit mode, click the title bar for the row, column, or portlet for which you want to
change properties.
4 In the Layout panel, make changes as needed.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 306

19. Managing Pages in My webMethods Server
In edit mode, if you have a row, column, or portlet selected, the following properties
appear in the Layout panel. The actual properties displayed depends on what you
have selected:
This property... Applies to... Affects... And does this...
Titlebar Pages Portlets Specifies whether or not to use
the Titlebar shell section at the
top of the portlet. Choices are Yes
or No.
Border Pages Portlets Specifies whether or not to place a
border around the portlet.
Choices are Yes or No.
Attributes Pages and
shell sections
Width Pages and
shell sections
Height Pages and
shell sections
Word wrap Pages and
shell sections
Horz align Pages and
shell sections
Vert align Pages and
shell sections
Rows,
columns
Reserved.
Columns Specifies a width for the column.
Type a percentage, such as 40%.
Actual widths may vary, based on
the number and size of columns
in a row, and may also be affected
by the Word wrap property.
Rows,
columns
Specifies a height for the row or
column. Accepts units that are
valid for HTML and CSS, such as
px or in.
Columns Specifies whether or not to use
word wrap to enforce column
width. Choices are Yes or No. If
you choose No, the column will
never be narrower than the width
of the text contained on any line
within it.
Columns Specifies how items in the column
are aligned horizontally. Choices
are Left, Center, and Right.
Columns Specifies how items in the column
are aligned vertically. Choices are
Top, Middle, and Bottom.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 307

This property... Applies to... Affects... And does this...
CSS class Shell sections Rows,
columns,
portlets
CSS style Shell sections Rows,
columns,
portlets
Background image Shell sections Rows,
columns,
portlets
5 On the left side of the page control area, click Save.
19. Managing Pages in My webMethods Server
Applies a CSS class to the row,
column or portlet. Type the name
of the class, omitting the leading
period (use nav for the .nav
class). The server uses the CSS file
for the skin associated with the
page. The location of the CSS file
is:
webMethods_install_dir/MWS/
server/default/deploy/portal.war/
ui/skins/skin_name/css/base.css
Applies a style to the row,
column, or portlet. Type any style
that is valid for use in a CSS file.
For example, if you type border:
1pt dashed red, a dashed red
line appears as a border.
Applies a background from the
skin associated with the page.
Type the name of the image file.
The file is assumed to be in this
location:
webMethods_install_dir/MWS/
server/default/deploy/
portal.war/ui/skins/
skin_name/images/
The background is like a regular
HTML background image in that
it does not affect the size of the
content area. You can use
standard CSS background
properties in the CSS style field to
control how the background is
displayed: whether it repeats,
whether it is centered or is offset
in some direction, and whether it
scrolls with the page or is fixed.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 308

Creating Links for Single Sign-On
19. Managing Pages in My webMethods Server
Single sign‐on is the ability for a user to log into one application and then use other
applications without having to log into each one separately. My webMethods Server
supports single sign‐on through the Security Assertion Markup Language (SAML), an
XML‐based framework for the exchange of security information.
To take advantage of single sign‐on, a user must be known on both the source server and
the target entity. In most cases, common knowledge of a user is provided by use of the
same directory service. For more information on configuring a server to be used as a
target for single sign‐on, “Setting up Single Sign‐On” on page 204.
On any page, you can add a link to a SAML target entity, such as a server. If the target
accepts SAML assertions from the source server, when a known user clicks the link, no
login credentials are required. If the target entity does not accept SAML assertions from
the source server, or if the user is not known on the target entity, login credentials may be
required.
Under the SAML specification, an intermediary called an artifact receiver can perform
authentication on behalf of the target Web application. In such a case, the SAML source
requires two URLs: one for the Artifact Receiver and one for the target Web application.
You can place one or more SAML links on any page you have permission to edit.
To create a SAML link on a source page
1 In the upper right‐hand corner of the page, click Tools > Edit Page.
2 In the Root list of the Available Portlets panel, click Links.
3 In the Links list of the Available Portlets panel, drag the Single Sign-on Link portlet and
drop it onto the page at the location where you want to add the link.
A red box appears beneath the cursor location whenever the cursor is over a valid
page location, indicating where the portlet would be positioned if you released the
mouse button.
4 On the left side of the page control area, click Save.
5 At the right edge of the title bar for the single sign‐on portlet, click Tools >
Properties.
6 In the Properties page make modifications as appropriate:
Make changes here... If you want to...
Name Replace Single Sign-on Link with the text that
is to go with the link.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 309

Make changes here... If you want to...
7 Click Apply.
19. Managing Pages in My webMethods Server
SAML Authentication URL Type the URL for a resource on the target
computer. The target can be any page on a server.
If you are connecting to a Web application
through a SAML Artifact Receiver, use this field
for the Artifact Receiver URL.
Use POST or GET Determines the method used to pass data to the
target computer.
POST Passes data to a gateway program’s
STDIN. POST, the default, is the
preferred method for single sign‐on
data.
GET Passes data as a string appended to the
URL after a question mark.
Artifact Parameter Name If this is a SAML connection with another server
or other webMethods component, do not change
the default value SAMLart. If this is a SAML
connection to a third‐party source, type the
artifact parameter name used by the third‐party
application.
Application Target URL If you have typed the URL for a SAML Artifact
Receiver in the SAML Authentication URL field, type
the URL for a Web application. Otherwise, leave
this field empty.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 310

Chapter 20. Working with Skins in My webMethods Server
� What are Skins? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
� Managing Skins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
� Replacing Images in a Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
� Managing Colors in a Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
� Managing Font Families in a Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
� Previewing a Page Elsewhere on the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 311

What are Skins?
Managing Skins
20. Working with Skins in My webMethods Server
The look and feel of a page is encapsulated in a skin. A skin is composed of a particular set
of colors, fonts, and images. You can associate a skin with a particular user or group, in
which they will view the contents of a page using the skin. You can associate a skin with a
particular folder hierarchy; all users who view pages within that hierarchy view them
using the skin.
You can perform the following types of functions in managing skins:
These functions... Are described here...
Create or delete a skin. “Managing Skins” on page 312
Replace images in a skin with images “Replacing Images in a Skin” on page 313
from your local drive, from an existing
skin, or from a Web site.
Replace colors in a skin using a color
picker, colors from an existing skin, or
colors from a Web site.
Replace font families in a skin, including
the use of font families taken from a Web
site.
Preview changes made to a skin using
pages not in the My Folders, Home Page,
or Public Folders folders.
You can create and delete skins with the Skin Administration page. To use the Skin
Administration page, you must either have the system administrator grant you
permission to access the page, or you must log in as the system administrator.
Creating a New Skin
“Managing Colors in a Skin” on page 314
As a system administrator, you can create a skin with the Skin Administration page.
To create a new skin
“Managing Font Families in a Skin” on
page 316
“Previewing a Page Elsewhere on the
Server” on page 318
1 As system administrator:
Administration > User Interface > Skin Administration > Create New Skin.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 312

20. Working with Skins in My webMethods Server
2 In the System Name field, type a short name that contains only letters, numbers, and
the underscore character.
This name is used internally by the server.
3 In the Display Name field, type the skin title that you want users to see.
This name has no character restrictions.
4 From the Parent Skin list, choose the skin from which the new skin will inherit any
unspecified properties.
The system default skin is selected by default.
5 Click Create.
A new skin initially inherits all of its properties (colors, fonts, and images) from its parent.
You can modify the new skin, changing just a single property, such as adding a new
header logo, or you can modify the skin to create a radical new look and feel with
completely different colors, fonts, and images.
Deleting a Skin
As a system administrator, you can delete a skin with the Skin Administration page.
To delete a skin
1 As system administrator:
Administration > User Interface > Skin Administration.
2 To delete a skin, click Tools and then click Delete.
Replacing Images in a Skin
The skin of a page contains images, such as logos, that help shape the appearance and
structure of the page. Using the Skin Administration page, you can replace images in a
skin with images from your local drive, images from an existing skin, or images from a
Web site.
To replace an image in a skin
1 As system administrator:
Administration > User Interface > Skin Administration.
2 To modify a skin, click Tools and then click Edit.
3 Click Images.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 313

4 Click the image you want to replace.
The image is highlighted with a red box.
5 Depending on the source of the image, do one of the following:
If the image source is... Do this...
6 Click Preview.
20. Working with Skins in My webMethods Server
The preview demonstrates how your changes have affected the skin.
7 Close the Preview window and click Save.
Managing Colors in a Skin
On the local drive In the Picker panel, click Browse. Navigate to the new
image, click Open, and then click Upload. To replace the
image, click .
Part of an existing skin In the Select palette list, select the skin from which you
want to copy the image. Select the new image and
click .
On a Web site In the Select palette list, select URL, type the Web site
URL and click OK. Select the new image and click .
Tip! To preview a page other than My Folders, My Home Page, or Public Folders, see
“Previewing a Page Elsewhere on the Server” on page 318.
The skin of a page uses colors to define the look and feel of the page. Using the Skin
Administration page, you can replace color settings in a skin using colors created in a
color picker, colors from an existing skin, or colors taken from a Web site.
Replacing Colors Using a Color Picker
There are a number of different color settings in a skin that affect different parts of a page.
To change settings, you select colors in the skin editor, apply the colors to skin properties,
and preview your changes.
To replace the color of a skin property using a color picker
1 As system administrator:
Administration > User Interface > Skin Administration.
2 To modify a skin, click Tools and then click Edit.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 314

3 Click Colors.
4 Click the skin property for which you want to replace the color.
The skin property is highlighted with a red box.
5 In the Picker panel, click the color to be used as a replacement.
20. Working with Skins in My webMethods Server
The selected color appears in the horizontal bar at the bottom of the Picker panel, and
the hexadecimal value appears in the # field at the top.
Tip! If you know the hexadecimal value of the replacement color, you can type it
directly in the # field.
6 To save a color to the Scratchpad panel, click the down arrow directly beneath the
Picker panel.
Tip! If you want lighter and darker shades of a particular color for use in foregrounds
and backgrounds, save the color in the Scratchpad panel and, in the vertical bar on the
right edge of the Picker panel, click above or below the original color. Save multiple
colors to the Scratchpad.
7 To set the color for a skin property, click from either the Picker panel or the
Scratchpad panel.
8 At the bottom of the page, under the Preview heading, click Preview.
The preview demonstrates how your changes have affected the skin.
Tip! If the page is not in one of the folders labeled My Folders, My Home Page, or
Public Folders, see “Previewing a Page Elsewhere on the Server” on page 318.
9 Close the Preview window.
10 Click Save.
Replacing Colors from a Skin or Web Site
You can replace the color of a skin property using color values from an existing skin or
from a Web site.
To replace the color of a skin property using a color from a skin or a Web site
1 As system administrator:
Administration > User Interface > Skin Administration.
2 To modify a skin, click Tools and then click Edit.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 315

3 Click Colors.
4 Click the skin property for which you want to replace the color.
The skin property is highlighted with a red box.
5 Depending on the source of the color, do one of the following:
If the color source is... Do this...
20. Working with Skins in My webMethods Server
Part of an existing skin In the Select palette list, select the skin from which you
want to copy the color. Select the new image and click
.
On a Web site In the Select palette list, select URL, type the Web site
URL and click OK. Select the new color and click .
6 At the bottom of the page, under the Preview heading, click Preview.
The preview demonstrates how your changes have affected the skin.
Tip! If the page is not in one of the folders labeled My Folders, My Home Page, or
Public Folders, see “Previewing a Page Elsewhere on the Server” on page 318.
7 Close the Preview window.
8 Click Save.
Managing Font Families in a Skin
In controlling the font families used by a skin, you have the choice of designing the style
yourself or selecting a set of font families used by another Web site. Rather than
attempting an exhaustive description of the capabilities available to you in the selection of
font families, the following procedure presents a scenario describing how one might go
about replacing font families based on the families used in another Web site.
Note: Font properties used by individual skins can vary. The properties described in the
following sample procedure may not be available in all skins.
To replace the font families used by a skin with the font families used by another Web site
1 As system administrator:
Administration > User Interface > Skin Administration.
2 To modify a skin, click Tools and then click Edit.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 316

3 Click Fonts.
20. Working with Skins in My webMethods Server
4 On the Select palette list, select URL, type the Web site URL and click OK.
The Palette displays a list of font families derived from the Web site.
5 In the Palette on the lower‐right side of the page, find a line that seems to represent
the normal body text of the Web site, and select it.
This action should result in several font families being listed in the Picker panel. If not,
try some other lines in the palette that look like normal body text.
6 Click directly above the Palette.
This action saves the font information to the Scratchpad panel for later use.
7 In the line you just created in Scratchpad panel, select the text in the edit field and
rename it to something meaningful, such as my regular text.
8 In the Skin Properties list on the left side of the page, select the regular skin property.
The regular skin property is highlighted with a red box, meaning it is selected for
editing.
9 To set the regular skin property, click from the Scratchpad panel.
This action sets the regular skin property with the value selected in the Scratchpad
panel.
10 In the Skin Properties list on the left side of the page, select the bold skin property.
The bold skin property is highlighted with a red box.
11 In the Scratchpad panel, select my regular text.
While the my regular text scratchpad item was already the active item in the Scratchpad
panel (with a dark red border around it), selecting it again makes it the active item for
the page (with a bright red border around it), and loads the my regular text font
information back into the Picker panel.
12 In the Font-style area of the Picker panel, select the Bold check box.
13 Click from the Picker panel.
This action sets the bold skin property with the value in the Picker panel.
14 In the Skin Properties list, click the small skin property.
15 In the Scratchpad panel, select my regular text.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 317

16 In the Font-size area of the Picker panel, do one of the following:
If this option is selected... Do this...
17 Click the arrow directly to the left of the Picker panel.
18 In the Skin Properties list, select the medium skin property.
19 In the Scratchpad panel, select my regular text.
20. Working with Skins in My webMethods Server
Relative size Change the value in the list to be a size smaller than
the existing size
Numeric size Edit the number in the field to be a value two or three
smaller than the existing size
20 In the Preview list at the bottom of the page, choose Public folders and then click Preview.
The preview demonstrates how your changes have affected the skin.
Tip! If the page is not in one of the folders labeled My Folders, My Home Page, or
Public Folders, see “Previewing a Page Elsewhere on the Server” on page 318.
21 Close the preview window.
22 Click Save.
Previewing a Page Elsewhere on the Server
You can preview a page other than My Folders, My Home Page, or Public Folders in the
skin editor.
To preview a page elsewhere on the server
1 Make changes to skin properties within Skin Administration.
2 In the Preview list at the bottom of the page, choose URL.
3 Open a new browser window, navigate to the server, navigate to the page you want to
preview.
4 In the Address bar of the browser, select the URL and type CTRL+C to copy it.
5 Return to the Script Prompt dialog from the first browser and paste in the URL by
typing CTRL+V.
6 Click OK.
7 Click Preview.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 318

Chapter 21. Working with Shells in My webMethods Server
� What are Shells? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
� Creating a New Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
� Modifying a Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
� Using an Alias with a Shell Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
� Deleting a Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
� Making an Empty Shell Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 319

What are Shells?
Creating a New Shell
21. Working with Shells in My webMethods Server
My webMethods Server derives the content and layout of the header and footer of a page
from the content and layout of the current shellʹs Header and Footer folders. When the
server renders one page, it is actually displaying the contents of up to five folders at once:
the shellʹs Header, the shellʹs Leftnav, the requested page, the shellʹs Rightnav, and the
shellʹs Footer. The server displays the content of the requested page as individual portlets,
but it renders the content of shell sections without title bars, borders, or additional
spacing. You can apply Cascading Style Sheet (CSS) classes and styles to the rows and
columns that compose the shell sections, as well as specify the exact dimensions of those
rows and columns, to further customize the layout of the shell.
The Titlebar shell section applies a title bar to each portlet on the page, which includes the
display name and buttons for controlling the portlet. You can hide the Titlebar shell
section individually for each portlet.
You can create and modify a shell with the Shell Administration page. To use the Shell
Administration page, you must either have the system administrator grant you
permission to access the portlet, or you must log in as the system administrator.
The first step in constructing a new shell is to create it using an existing shell as a parent.
A new shell initially inherits all of its properties from its parent. These properties (or shell
sections) are: Header, Footer, Leftnav, Rightnav, and Titlebar. You can replace any of these
sections with a new, custom shell section.
To create a new shell
1 As system administrator:
Administration > User Interface > Shell Administration > Create New Shell.
2 In the Name field, type a name for the shell.
This name has no character restrictions.
3 (Optional) In the Description field, type a description of the shell.
The description appears in the list of shells on the Shell Administration page.
4 From the Parent Shell list, choose the shell from which the new shell will inherit any
unspecified properties.
The system default shell is selected by default.
5 Click Create.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 320

Modifying a Shell
21. Working with Shells in My webMethods Server
After you have created a new shell from a parent shell, you can modify individual
sections of that shell independently to construct a new shell.
To modify a shell
1 As system administrator:
Administration > User Interface > Shell Administration.
2 To modify a shell, click Tools and then click Edit.
3 If you want to change the display name for the shell, in the Display Name field, type a
new name for the shell.
4 If you want to change the parent shell from which to take the various shell sections, in
the Parent Shell list, choose the parent shell. The list contains shells that currently exist
on the server.
5 For each shell section, choose the parent or source for the section from among these
choices:
Choose this option... To do this...
Inherited To use the shell section from the shell chosen in the Parent
Shell field.
Portal Page (Not available for the Titlebar shell section.) To use the
content of an existing folder for the shell section, move the
folder to the Selected Items box and then click Select.
Portlet (Titlebar shell section only.) To use an existing portlet,
move the portlet to the Selected Items box and then click
Select.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 321

21. Working with Shells in My webMethods Server
6 For shell sections that you want to edit, take one of the following actions:
To accomplish this... Do this...
Edit a shell section inherited from
another shell
Edit an existing folder used as a shell
section
7 Click Edit.
The folder that represents the shell section opens in edit mode.
8 Modify the shell section just as you would any other folder, as described here:
� “Creating and Modifying Pages” on page 297
� “Adding and Managing Portlets” on page 301
9 Click Save.
10 Click Save.
Using an Alias with a Shell Section
If a folder has an alias, you can use the alias to select it for use as a shell section. For
information about using aliases with folders, see “Managing Aliases” on page 190.
1 As system administrator:
Administration > User Interface > Shell Administration.
2 To modify a shell, click Tools and then click Edit.
3 In the shell section you want to associate with an alias, click Use Alias.
4 In the Alias Name field of the server resource selector, type the alias of the folder you
want to use for this shell section.
5 To determine if the server can find the alias, click Test.
With the Inherited option selected, click
Clone from Parent.
The server creates a folder based on the
inherited shell section.
With the Portal Page option selected,
make sure the name of the target folder
is displayed.
Note: Within the server, you cannot edit portlets. You need to use webMethods
Designer.
To select a shell section using an alias
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 322

Deleting a Shell
6 If the server correctly resolves the alias, click Select.
21. Working with Shells in My webMethods Server
7 If needed, you can clone this folder or edit it directly, as described in “Modifying a
Shell” on page 321.
8 Click Save.
After it is no longer needed, you can delete a shell.
To delete a shell
1 As system administrator:
Administration > User Interface > Shell Administration.
2 To delete a shell, click Tools and then click Delete.
Making an Empty Shell Section
A shell always has the four folders that make up the shell sections. You may, however,
want a shell design in which one or more of the shell sections is empty and takes up no
space in the display. A shell section is empty if it contains no portlets and has no
formatting information associated with it. In the default shells provided with My
webMethods Server, the Leftnav and Rightnav shell sections display as being empty.
You cannot edit the Titlebar shell section as you do the others. To hide the title bar, you
need to set the Titlebar attribute for individual portlets to No. For more information, see
“Controlling the Layout of the Page” on page 306.
To make a shell section (other than a Titlebar) empty
1 As system administrator:
Administration > User Interface > Shell Administration.
2 To modify a shell, click Tools and then click Edit.
3 In the Alias Name field of the resource selector, type the alias shell.section.blank.
4 To determine if the server can find the alias, click Test.
5 If the server correctly resolves the alias, click Select.
6 Click Save.
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 323

21. Working with Shells in My webMethods Server
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 324

Index
A
Active Directory Application Mode (ADAM), configuring 57
Active Directory Service Interfaces (ADSI), configuring 57
adding
authentication certificates 103
column to a page 299
custom data source 71
DB2 Universal data source 68
dynamic attributes to a role 121
generic ODBC data source 70
groups to internal system directory service 96
groups to other groups 100
Informix data source 70
members to a group 99
Microsoft SQL Server data source 67
Oracle data source 68
portlets to pages 301
Principal Attribute Provider to Profile 146
resources to Security Realms 171
roles
LDAP query 114
rule-based 115
static 113
row to a page 298
subpage to wiki page 252
Sybase Adaptive Server data source 69
users to groups 94
users to internal system directory service 86
Admin Role 110
Administrative Commands Security Realm 166
Administrator forum role
activities of 275
defined 262
Administrator user, initial password 18, 55
ADSI (Active Directory Service Interfaces), configuring 57
advanced search for aliases 193
AJP13 Listener, configuring 25, 39, 132
Alias Management page, configuring 190
aliases
add to a portlet 304
advanced search for 193
creating 191
deleting 195
modifying 194
portlet 303
remove from a portlet 304
saved searches 194
searching for 192
simple search for 192
system, including or excluding 193
with shells 322
Anonymous authentication, defined 149
Apache, configuring 35
Artifact Parameter Name, SAML 205
assigning
groups to other groups 100
members to a group 99
users to groups 94
attaching file to wiki page 253
attribute providers
Core Attributes 139
Database 142
Dynamic 144
LDAP 141
Notification 143
Principal 138
User 140
User Preferences 140
using 139
Attributes property 307
authentication
Anonymous 149
Basic 149
Forms 149
HTTP Header 150
NTLM 149
authentication certificate
adding 103
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 325
Index

assigning a user 105
changing users 106
deleting 107
details of 105
removing a user 107
searching 103
authentication schemes
assigning to a server resource 160
default, specifying 159
extended and extensible 151
managing 158
Auto Deploy role, clusters 127
B
Background image property 308
Basic authentication, defined 149
Border property, portlets 307
browsing for a wiki page 247
C
capturing server environment 187
certificate
adding 103
assigning a user 105
changing users 106
deleting 107
details of 105
removing a user 107
searching 103
changing
configuration of external directories 64
dynamic attributes order 122
E-mail address My webMethods has for group 98
E-mail address My webMethods has for user 89
group information 97
listener ports 24
password 22, 89
profile 22
role precedence 91
roles 119
search order of directory services 65
server configuration 24
user information 87
clearing
Logging Collector 183
passwords from memory 172
Cluster Administration page
Task Engine server role 128
cluster.xml file 48, 128
clusters
adding server machines 132
architecture of 126
Auto Deploy role 127
configuring master server 131
creating 130
Front End URL 127
guidelines for roles 128
Notification role 128
planning 129
roles in 127
Search role 128
shared file system 127
starting a server cluster 133
collecting event data 184
colors
created in color picker 314
from a Web site 315
columns
add to a page 299
Attributes property 307
Background image property 308
CSS class property 308
CSS style property 308
Height property 307
Horz align property 307
remove from a page 300
reposition on a page 300
Vert align property 307
Width property 307
Word wrap property 307
command line
create new server instance 46, 48
delete server instance 49
full syntax 44
moving server database 48
simple start and stop commands 45
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 326
Index

configuration
changing 24
creating a new server instance 46, 48
deleting a server instance 49
moving server database 48
configuring
Apache 35
content storage locations 213
E-mail server settings 74
Events Collector page 185
external database directory services 60
external HTTP authentication credentials 195
external LDAP, ADSI, or ADAM directory services 57
group subscriptions 215
Internet Information Server (IIS) 6.0 32
locale page rules 224
Lockdown portlet 173
login page rules 225
permissions for managed components 203
properties of managed components 202
server content migration 210
shell rules 237
skin rules 234
start page rules 229
URL aliases 190
containers
creating 168
defined 166
removing 168
renaming 169
Content Migration Wizard page, configuring 210
Content Service page, configuring 213
content storage, managing 213
Contributor forum role
activities of 269
defined 261
controlling IP login ranges 173
conventions used in this document 13
copying rules 232
Core Attributes Attribute Provider 139
creating
alias for a server resource 191
clusters 130
containers 168
forum messages 270
forum Security Realms 284
forum topics 269
forums and forum categories 275
group ID 96
groups in internal system directory service 96
new server instance 46, 48
new shells 320
new skins 312
page 297
password for a user 87
Security Realms 169
shell rules 237
user ID 87
users in internal system directory service 86
wiki page 242
CSS class property 308
CSS style property 308
csv file, exporting seach results to 81
custom databases, adding as a data source 71
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 327
D
data source
adding
custom 71
DB2 Universal 68
generic ODBC 70
Informix 70
Microsoft SQL Server 67
Oracle 68
Sybase Adaptive Server 69
deleting 73
modifying 72
Data Source Administration page 66
Database Attribute Provider 142
Database Attributes tab
description of fields 93, 99
group information 99
user information 93
database role
description 112
db.xml file 48
Index

DB2 Universal databases, adding as a data source 68
default authentication scheme, specifying 159
default locale rules 222
default search engine, reloading 218
definitions
database role 112
directory service 54
groups 84
Guest user 55
LDAP query role 112
My webMethods Administrator 55
My webMethods Users role 111
role 110
static role 112
System Admin user 55
system directory service 54
deleting
access to My webMethods from internally-defined users 94
aliases 195
authentication certificates 107
configuration of external directory service 65
data source 73
dynamic attributes from roles 123
forum Security Realms 286
forums and forum categories 282
groups from internal system directory service 101
members from a group 99
new server instance 49
roles 120
shells 323
skins 313
users from internal system directory service 94
Denied Access forum role 261
Deploy folder, installing portlets 200
deploying Events Collector page 185
deploying the Lockdown portlet 173
Developer Commands Security Realm 167
Directory Management Commands Security Realm 166
Directory Service Commands Security Realm 166
directory services
definition 54
external, description of 56
system, description of 54
Directory Services Administration page 56
disabling the Lockdown portlet
in My webMethods Server 174
manually 174
discussion boards, See forums
displaying members of a group 99
distinguished name (DN)
groups 98
users 89
documentation
additional 14
conventions used 13
feedback 13
Dynamic Attribute Provider 144
dynamic attributes
adding to a role 121
changing the order of 122
default value
defining 121
description 121
user-specific value, defining 122
Dynamic Attributes tab, description of fields 121
Dynamic Business Objects (DBOs), managing 201
dynamic membership of roles 110
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 328
E
editing
forum Security Realms 285
group information 97, 140
My webMethods pages as system administrator 296
roles 119
user information 87, 140
wiki page 243
E-mail address
changing for a group 98
changing for a user 89
purpose of user E-mail address 89
specifying for group 97
specifying for user 87
Email Administration page, configuring 74
empty shell sections 323
environment diagnostic tool 187
evaluation order, rules 233
Index

Events Collector page 184
configuring 185
database schema 186
deploying 185
explicitly assigning skins 234
exporting search results to .csv file 81
exporting server content 211
Extended Types (server objects), managing 201
external content repository, configuring 213
external directory services
ADAM (Active Directory Application Mode)
configuring 57
updating configuration 64
ADSI (Active Directory Service Interfaces)
configuring 57
updating configuration 64
allowing users access to My webMethods 63
configuring database 60
configuring LDAP, ADSI, or ADAM 57
deleting configuration 65
functions 56
groups
functions you can perform 96
searching for 76
LDAP (Lightweight Directory Access Protocol)
configuring 57
updating configuration 64
re-ordering search order of 65
supported 56
updating configuration 64
users
allowing access to My webMethods 63
functions you can perform 85
searching for 76
external security and access control, accepting 195
F
file
cluster.xml 48, 128
db.xml 48
logging.properties 180
PhaseProvider.xml 199
portal.properties 174
portal-env.zip 187
setenv 130
Forms authentication, defined 149
forum roles
Administrator
activities of 275
defined 262
Contributor
activities of 269
defined 261
Denied Access 261
Moderator
activities of 272
defined 261
Other, defined 262
Spectator
activities of 263
defined 261
system administrator, activities of 283
forums
creating 275
creating messages 270
defined 260
deleting 282
forum objects 260
getting started as admiministrator 263
listing
messages requested for retraction 289
topics and messages pending approval 288
modifying options 280
modifying permissions 281
moving 278
organization of 260
renaming 279
replying 270
requesting retractions 271
roles in 260
running reports 290
searching in 266
searching in (as system administrator) 286
Security Realms
creating 284
deleting 286
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 329
Index

editing 285
managing 284
subscribing to 265
topics
creating 269
rating 268
viewing topics and messages 264
Front End URL, clusters 127
functions
controlling access to 123
controlling actions users can perform 124
G
generic ODBC databases, adding as a data source 70
global wiring 144, 305
granting access to
functions 123
My webMethods
for externally-defined users 63
for internally-defined users 111
group ID 96
Group Information tab 140
description of fields 98
specifying E-mail address 97
group information, editing 140
Group Members tab, description of fields 99
Group Subscriptions page, configuring 215
group subscriptions, managing 215
groups
adding members to 99
assigning
internally-defined groups to 100
internally-defined users to 94
to other groups 100
definition 84
deleting 101
displaying members of 99
distinguished name (DN) 98
editing information 97
E-mail address, specifing 97
externally-defined 96
group ID 96
group name 97
information My webMethods maintains for 98
internal system directory service
adding members to 99
assigning to other groups 100
deleting 101
editing 97
functions you can perform 95
removing members from 99
members of 99
purpose of 84
removing members from 99
saved searches
creating 78
deleting 81
modifying 79
using 79
searching for 76
specifying
group ID 96
group name 97
to which a group belongs 98
to which users belong 91
Groups tab, description of fields 91
Guest user, description of 55
guidelines for cluster roles 128
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 330
H
Index
Height property, page layout 307
history of wiki page, viewing 255
Horz align property 307
HTTP certificate file location (sample) 25, 132
HTTP Header Authentication Administration page, configuring
195
HTTP Header authentication, defined 150
HTTP Listener, configuring 25, 132
HTTPS client, My webMethods Server as 28
HTTPS Listener, configuring 25, 132
HTTPS, communicating with webMethods components 29
I
importing server content 212
Informix databases, adding as a data source 70
Install Administration page

configuring 198
installing portlets 200
uninstalling portlets 201
installing portlets
Install Administration page 200
using Deploy folder 200
Internet Information Server (IIS) 6.0, configuring 32
IP login ranges, controlling 173
L
layout, controlling page 306
LDAP Attribute Provider 141
LDAP Attributes tab
description of fields 93, 99
group information 99
user information 93
LDAP query role
adding 114
description 112
LDAP user directory 215
Lightweight Directory Access Protocol (LDAP) directory service,
configuring 57
links from a single sign-on source 205
listener ports, changing 24
Locale Administration page 222
locale rules
default 222
defined 222
Lockdown portlet
configuring 173
deploying 173
disabling
in My webMethods Server 174
manually 174
log files, single sign-on 207
log messages, viewing 181
log-file rollover period 180
Logging Collector panel 179
Logging Configuration page
collector threshold 179
setting logging thresholds 178
logging into My webMethods Server 21
logging out of My webMethods Server 22
Logging Thresholds tab 178
logging.properties file 180
Login page 21
login page rules, defined 222
Lucene search engine, managing 217
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 331
M
Index
Manage Components page
configuring permissions 203
configuring properties 202
Manage Locale Rules page, configuring 224
Manage Login Page Rules page, configuring 225
Manage Rendering Rules page, configuringconfiguring
rendering rules 227
Manage Search Index tab 183
Manage Shell Rules page, configuring 237
Manage Skin Rules page, configuring 234
Manage Start Page Rules page, configuring 229
Manage Subscriptions page, configuring 214
managing
colors in a skin 314
font families in a skin 316
images in a skin 313
portlet aliases 303
Microsoft SQL Server databases, adding as a data source 67
migrating server content to other server instances 210
Moderator forum role
activities of 272
defined 261
modifying
alias for a server resource 194
data source 72
forum options 280
forum permissions 281
polling interval 199
portlet properties in a page 303
rules 230
shells 321
moving
forum or forum category 278
wiki page 251
multiple instances of My webMethods Server 26

My webMethods
allowing externally-defined users access to 63
allowing users access to 86, 111
editing pages as system administrator 296
My webMethods Administrator
description 55
initial password 18, 55
user ID 18, 55
My webMethods Administrators role 110
My webMethods Server
guidelines for multiple instances 26
logging into 21
logging out of 22
roles
Admin Role 110
My webMethods Administrators 110
My webMethods Users 110
starting
as a Windows service 19
from the command line 20
stopping
as a Windows service 19
from the command line 20
My webMethods Users role 110
My webMethods Users role, purpose of 111
N
Notification Attribute Provider 143
Notification role, clusters 128
Notifications tab
description of fields 92
specifying E-mail address 87
notifications, configuring an email server 74
NTLM authentication
defined 149
specifying a Primary Domain Controller 162
O
opening file attached to wiki page 254
optimizing search indexes 218
Oracle databases, adding as a data source 68
organization of forums 260
Other forum role, defined 262
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 332
P
pages
add column 299
add row 298
adding portlets 301
creating 297
layout, controlling 306
portlets in 301
remove a column 300
remove a row 299
removing portlets 302
reposition a column 300
reposition a row 298
repositioning portlets 302
passwords
changing 22, 89
clearing from memory 172
defining 87
permissions
add Principal 164
apply to descendents 165
forum, modifying 281
modify 164
remove (all) to descendents 165
remove Principal 165
viewing 163
PhaseProvider.xml file 199
polling interval, modifying 199
portal.properties file 174
portal-env.zip file 187
portlets
add alias to 304
adding to a page 301
aliases, managing 303
Background image property 308
Border property 307
CSS class property 308
CSS style property 308
modifying properties in a page 303
remove alias from 304
removing from a page 302
repositioning in a page 302
Titlebar property 307
Index

wiring 304
ports, listener 24
previewing a portal page elsewhere on the server 318
Primary Domain Controller for NTLM 162
Principal Attribute Providers 138
profile
updating 22
User Information tab 22
program code conventions in this document 13
Public Commands Security Realm 167
Publish page, configuring 216
R
rating forum topics 268
rearranging Principal Attribute Providers in Profile 146
reloading the default search engine 218
removing
access to My webMethods from internally-defined users 94
column from a page 300
containers 168
members from a group 99
portlets from a page 302
Principal Attribute Provider from Profile 146
resources from Security Realms 171
row from a page 299
rules 233
Security Realms 170
users from authentication certificates 107
renaming
containers 169
forum or forum category 279
Security Realms 170
wiki page 252
Rendering rules, creating 227
rendering rules, defined 222
re-ordering
dynamic attributes 122
roles for a user 91
search order of directory services 65
replacing
colors created in a color picker 314
colors from a skin or Web site 315
reports, forum 290
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 333
Index
repositioning
column on a page 300
portlets on a page 302
row on a page 298
request, setting a shell for 239
requesting retractions in forums 271
Restricted Commands Security Realm 167
resynching search indexes 217
resynchronyzing the Search Indexes 217
revoking access to My webMethods from internally-defined users
94
Role Information tab 140
role precedence
changing 91
determining for user 91
ROLE VALUE field
default dynamic attribute value 121
specifying value 121
roles
Admin Role 110
changing order of dynamic attributes 122
clusters 127
controlling actions users can perform 124
creating types 112
database role, description 112
defining dynamic attributes 121
definition 110
deleting 120
deleting dynamic attributes from 123
dynamic attributes
adding to a role 121
changing order 122
changing the order of 122
default value 121
default value, specifying 121
deleting 123
user-specific 122
editing 119
LDAP query role description 112
membership
about 110
dynamic 110
editing 119

static 110
types 110
ways to define 110
My webMethods Administrators 110
My webMethods User, purpose of 111
My webMethods Users 110
saved searches
creating 78
deleting 81
modifying 79
using 79
searching for 76
static role
description 112
static, adding 113
to which users belong 91
Roles tab, description of fields 91
rollover, log-file 180
rows
add to a page 298
Attributes property 307
Background image property 308
CSS class property 308
CSS style property 308
Height property 307
remove from a page 299
reposition on a page 298
rule-based roles, adding 115
rules
copying 232
creating skin 235
evaluation criteria 233
locale 222
login page 222
modifying 230
removing 233
rendering 222
shell 223
skin 223
start page 222
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 334
S
SAML
checking logs for problems 207
configuring a target 205
links on a source page 205
SAML Authentication Administration page, using 204
saved searches
creating 78
deleting 81
modifying 79
using 79
wiki 251
schema, Events Collector page 186
Search Administration page, configuring 217
search engine (Lucene) management 217
Search Index resynchronizing 217
search indexes
optimizing 218
resynching 217
Search Logged Messages tab 182
Search role, clusters 128
searching
authentication certificate 103
exporting search results to .csv file 81
for a wiki page 248
for aliases 192
forums 266
forums as system administrator 286
group information 76
log messages 182
role information 76
user information 76
Security Provider URI, SAML 205
Security Realms
adding resources 171
Administrative Commands 166
creating 169
Developer Commands 167
Directory Management Commands 166
Directory Service Commands 166
Index

forum
creating 284
deleting 286
editing 285
managing 284
Public Commands 167
removing 170
removing resources 171
renaming 170
Restricted Commands 167
User Profile Management Commands 167
Security Realms Administration page, using 166
server repository, managing 213
server resources
add Principal to permissions for 164
apply permissions to descendents 165
creating aliases for 191
modify permissions 164
modifying an alias for 194
remove all permissions to descendents 165
remove Principal from permissions 165
view permissions for 163
Session Monitor page, configuring 184
session, setting a shell for 239
setenv file 130
setting logging thresholds 178
shared file system, clusters 127
Shell Administration page
configuring 236
shell rules, defined 223
shells
aliases with 322
creating new 320
creating rules for 237
deleting 323
empty sections 323
managing rules for 237
modifying 321
setting for a request 239
setting for a session 239
sticky 239
simple search for aliases 192
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 335
Index
single sign-on
Artifact Parameter Name 205
checking logs for problems 207
configuring a target 205
described 204
links for 309
links on a source page 205
Security Provider URI 205
Skin Administration page
configuring 234
skin rules, defined 223
skins
colors, replacing 314
creating new 312
creating rules for 235
deleting 313
explicitly assigning 234
font families, replacing 316
images, replacing 313
Spectator forum role
activities of 263
defined 261
start page rules, defined 222
starting
My webMethods Server
as a Windows service 19
command syntax, simple 45
from the command line 20
static roles
adding 113
description 112
editing members 113
sticky shells 239
stopping My webMethods Server
as a Windows service 19
command syntax, simple 45
from the command line 20
storage locations, managing 213
subscriptions
creating for groups 215
forums 265
modify for a given user 214
Sybase Adaptive Server databases, adding as a data source 69

syntax, wiki 244
System Admin user, description 55
system directory service
adding
groups to 96
users to 86
allowing users access to My webMethods 86, 111
definition 54
groups
adding 96
adding members to 99
assigning to other groups 100
deleting 101
editing information for 97
functions you can perform 95
removing members from 99
searching for 76
setup 56
users
adding 86
allowing access to My webMethods 86, 111
assigning to groups 94
deleting 94
editing information for 87
functions you can perform 85
searching for 76
T
target for single sign-on 205
Task Engine server role 128
third party security and access control, accepting 195
Titlebar property 307
troubleshooting information 13
typographical conventions in this document 13
U
uninstalling portlets, Install Administration page 201
updating
configuration of external directories 64
dynamic attributes order 122
E-mail address My webMethods has for group 98
E-mail address My webMethods has for user 89
group information 97
password 22, 89
profile 22
role precedence 91
roles 119
search order of directory services 65
user information 87
URL to access My webMethods 21
User Attribute Provider 140
user ID 87
User Information tab 140
changing password 22
description of fields 88
first and last name, specifying 87
specifying E-mail address 87
user information, editing 140
User Preferences Attribute Provider 140
User Preferences tab, description of fields 93
user profile information, viewing 184
User Profile Management Commands Security Realm 167
User Profile tab
description of fields 89
first and last name, specifying 87
users
allowing access to My webMethods 63
assigning to groups 94
controlling
ability to perform actions 124
deleting 94
distinguished name (DN) 89
editing information 87
E-mail address, specifying 87
externally-defined 85
first and last name, specifying 87
group membership 91
information My webMethods maintains for 88
initial password 87
internal system directory service
allowing access to My webMethods 86, 111
assigning to groups 94
deleting 94
editing 87
functions you can perform 85
role membership 91
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 336
Index

V
saved searches
creating 78
deleting 81
modifying 79
using 79
searching for 76
specifying user ID 87
user ID 87
version
wiki page
compare with previous 257
edit older 257
make current 256
managing 254
Vert align property 307
View Logging Messages page, using 181
viewing
authentication certificate details 105
forum topics and messages 264
history of wiki page 255
members of a group 99
older version of wiki page 256
user profile information 184
W
Web server integration 32
webMethods Cluster user 56
webMethods System user 56
Width property 307
wiki
defined 242
managing participation in 242
page
attaching file to 253
comparing with previous version 257
creating 242
edit older version 257
editing 243
find by browsing 247
making current 256
moving 251
open attached file 254
renaming 252
searching for 248
subpage, adding 252
viewing history 255
viewing older version 256
saved search 251
syntax 244
wiring
global 144, 305
one portlet to another 304
Word wrap property 307
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 337
Index

Index
My webMethods Server Administrator’s Guide Version 7.1.1 � � � 338