Title 

Page

webMethods Deployer
User’s Guide

VERSION 7.0

APRIL 2007

webMethods, Inc.
South Tower
3877 Fairfax Ridge Road
Fairfax, VA 22030
USA
703.460.2500
http://www.webmethods.com
Copyright
&  Docu‐
ment ID

B2B Integration Server, Business Process Integration, Cerebra, Get There Faster, Glue, Glueprints, Glueware, Guided SOA Governance, Infravio X‐Broker, 
Infravio X‐Registry, Infravio, My webMethods Server, My webMethods, Process Improvement Lifecycle, Process Improvement Lifecycle Methodology, 
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 SOA Governance, webMethods SOA Management, webMethods Task Engine, 
webMethods Trading Networks, webMethods Workflow, and webMethods are either registered trademarks or trademarks of webMethods, Inc. in the United 
States and/or other countries.  
Acrobat and Adobe are registered trademarks, and Reader is a trademark of Adobe Systems Incorporated. Amdocs is a registered trademark, and ClarifyCRM 
is a trademark 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. ChemeStandards and CIDX are trademarks of Chemical Industry Data Exchange. 
Unicenter is a registered trademark of Computer Associates International, Inc. PopChart is a registered trademark of CORDA Technologies, Inc. Kenan and 
Arbor are registered trademarks of CSG Systems, Inc. Data Connection and SNAP‐IX are registered trademarks of Data Connection Corporation. DataDirect, 
DataDirect Connect, and SequeLink are registered trademarks of DataDirect Technologies. D&B and D‐U‐N‐S are registered trademarks of Dun & Bradstreet 
Corporation. 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, DB2, Domino, IBM, Informix, Infoprint, Lotus, Lotus Notes, MQSeries, OS/390, OS/400, 
RACF, RS/6000, SQL/400, S/390, System/390, VTAM, z/OS, and WebSphere 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. JBoss is a registered trademark, and JBoss Group is a trademark of Jboss, Inc. 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, Windows, and Windows NT are registered trademarks; and Windows Server is a trademark of 
Microsoft Corporation.  Six Sigma is a registered trademark of Motorola, Inc. Firefox is a registered trademark, and Mozilla is a trademark of the Mozilla 
Foundation. MySQL is a registered trademark of MySQL AB. nCipher is a trademark of nCipher Corporation Ltd. Teradata is a registered trademark of NCR 
International, Inc. 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 PeopleSoft Pure Internet Architecture and WorldSoftware are trademarks of Oracle Corporation. Infranet and Portal 
are trademarks of Portal Software, Inc. Red Hat is a registered trademark 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. SWIFT and SWIFTNet are registered trademarks of Society for Worldwide Interbank 
Financial Telecommunication SCRL. SPARC and SPARCStation are registered trademarks of SPARC International, Inc. SSA is a registered trademark, and 
Baan and SSA Global are trademarks 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, SOAP with Attachments API for Java, JavaServer Pages, 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.
All other marks are the property of their respective owners.  
Copyright © 2007 by webMethods, Inc. All rights reserved, including the right of reproduction in whole or in part in any form.
Document ID: DEP-UG-70-20070420
 Contents

Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 1. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Deployment Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Create the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Define the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Build the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Map the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Deploy the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Checkpoint and Roll Back . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 2. Starting and Configuring Communication with the Deployer . . . . . . . . . . . . . 17

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Start the Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Configure for Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Configure for ProcessModel Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Configure for Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Configure for My webMethods Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Configure for Optimize Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Chapter 3. Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Set Default Properties for Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Set the Default for Dependency Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Set the Default Properties for Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Set Default Properties for Integration Server & Trading Networks Projects . . . . . . . . . . . . . . . . 25
Create a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Authorize Groups to Perform Tasks on a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Add and View Instructions or Notes About a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Chapter 4. Defining a Broker Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Create the Broker Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Identify the Source Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Add webMethods Broker Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Resolve Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

webMethods Deployer User’s Guide Version 7.0 3

Contents

Chapter 5. Defining a ProcessModel Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Create the ProcessModel Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Identify the Source ProcessModel Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Add Process Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Resolve Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Remove Process Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Chapter 6. Defining an IS & TN Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Create the IS & TN Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Identify Source Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Add Integration Server Administration Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Add Integration Server Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Add an Entire Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Add Package Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Add Package Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Set the Package Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Add webMethods Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Add Trading Networks Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Resolve Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Manually Add Dependencies to a Package Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Chapter 7. Defining an MWS Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Create the MWS Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Identify the Source My webMethods Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Add My webMethods Server Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Resolve Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Chapter 8. Defining an Optimize Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Create the Optimize Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Identify the Source Optimize Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Add Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Resolve Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Chapter 9. Building a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Create a Project Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Create a Build Using the Deployer Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Create a Build Using a Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Rebuild a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

4 webMethods Deployer User’s Guide Version 7.0

 Contents

Export and Import a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Export and Import a Build Using the Deployer Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Export and Import a Build Using Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Chapter 10. Mapping a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Map a Project to Target Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Change Configuration Parameters for IS & TN Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Chapter 11. Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Deploy Using the Deployer Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Deploy Using a Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Generate a Checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Roll Back the Target Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Chapter 12. Deploying to Clustered 6.5 Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . 85

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Manual Cluster Deployment or Automatic Cluster Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Deploying to Clustered Trading Networks Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Deploying to Clustered ProcessModel Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Configure Cluster Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Deploy Scheduled Tasks in a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

webMethods Deployer User’s Guide Version 7.0 5

Contents

6 webMethods Deployer User’s Guide Version 7.0

 About This Guide

About This Guide

This guide explains how to use webMethods Deployer. The Deployer is a tool you use to 
deploy items that reside on source webMethods servers to target webMethods servers. 
You can deploy items from the products listed below.     

Product Versions
Blaze Advisor 6.1.7
webMethods Broker 6.5.x
webMethods Designer 7.0 SP2
webMethods Integration Server 6.5.x
My webMethods Server 7.0 SP2
webMethods Optimize 7.0 SP2
webMethods Trading Networks 6.5.x

Document Conventions

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 Identifies characters and values that you must type exactly or 
font 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.

webMethods Deployer User’s Guide Version 7.0 7

 About This Guide

Additional Information
The webMethods Advantage Web site at http://advantage.webmethods.com provides you 
with important sources of information about the webMethods Integration Platform:
Troubleshooting Information. webMethods provides troubleshooting information for 
many webMethods components in the webMethods Knowledge Base.
Documentation Feedback. To provide documentation feedback to webMethods, go to the 
Documentation Feedback Form on the webMethods Bookshelf.
Additional Documentation. All webMethods documentation is available on the 
webMethods Bookshelf.

webMethods Deployer User’s Guide Version 7.0 8

Chapter 1. Concepts

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Deployment Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

webMethods Deployer User’s Guide Version 7.0 9

 1. Concepts

Overview
webMethods Deployer is a tool you use to deploy items that reside on source 
webMethods servers to target webMethods servers. For example, you might want to 
deploy items you have developed on servers in a development environment to servers in 
a test or production environment.
The sections below list the items you can deploy and the source and target servers for 
those items.   

From... You can deploy... Source and Target Servers

webMethods  Files from webMethods  Integration Servers
files installations on machines that 
host an Integration Server
Blaze  Rules Integration Servers equipped with 
Advisor the Blaze Rule Service Package
webMethods  Document types and client  Brokers
Broker groups
Designer Process models that have been  Integration Servers equipped with 
generated for deployment and  the Process Engine; these are 
updated for monitoring using  called “ProcessModel servers” in 
Designer Deployer

Note: A deployed process model 
does not contain the design‐time 
source code for the project, just 
the run‐time elements that are 
necessary for process execution.

webMethods Deployer User’s Guide Version 7.0 10

 1. Concepts

From... You can deploy... Source and Target Servers

Integration  Administration items such as  Integration Servers
Server ports, users, ACLs, groups, 
extended settings, and user‐ Note: You can use special 
created scheduled tasks instructions to facilitate 
User‐created packages, from  deployment to a cluster of 
entire packages to selected  Integration Server 6.5s. For more 
package files or selected package  information, see Chapter 12, 
components (such as IS document  “Deploying to Clustered 6.5 
types, services, triggers, adapter  Integration Servers”.
notifications, flat file schemas, 
and mainframe host pools)

Important! Do not deploy packages 
that are webMethods products. 
For example, do not deploy the 
WmMonitor package, which is 
webMethods Monitor. Instead, 
install such packages using the 
webMethods Installer.

My  Pages, portlets, CAF and task  My webMethods Servers

webMethods  applications, tasks, DBOs, shells, 
Server skins, renderers, rules, users, 
groups, roles, directory services, 
data sources, and security realms
Optimize Process configuration such as  Analytic Engines, called 
process and step timeouts and  “Optimize servers” in Deployer
process extensions, and other 
analysis KPI metadata such as 
event maps, rules, dimensions, 
data filters, hierarchies, and 
custom trees
Trading  Items such as processing rules,  Integration Servers equipped 
Networks TN document types, trading  with Trading Networks Server
partner agreements (TPAs), and 
partner profiles and security data

webMethods Deployer User’s Guide Version 7.0 11

 1. Concepts

Deployment Steps
The deployment process involves these steps:
1 Create a deployment project by assigning the project a name, setting the project’s 
properties, and authorizing users to work on the project.
2 Define the project by identifying its contents.
3 Build the project.
4 Map the contents of the project to target servers.
5 Deploy the project to the target servers.

Create the Project

A deployment project identifies the items on source servers that you want to deploy to 
target servers. To create a project, you assign the project a name and set its properties; then 
authorize users to perform the project tasks (that is, viewing, defining, building, mapping, 
and deploying the project).
When you create a project, the Deployer automatically creates an HTML home page for 
the project. You can modify this page to contain instructions or notes about the project 
that you want users to view. For example, you might want to list the target servers for the 
users who will perform the mapping task, or you might want to provide instructions for 
testing the deployed solution.

Define the Project

When you define a project, you create project deployment sets. Each deployment set 
identifies items from source servers that you want to deploy as a set to target servers. The 
Deployer stores each project definition as an XML file that contains pointers to the items 
in the project’s deployment sets.
You can define these types of deployment sets within a single project:  

Deployment Set Contents

Broker Document types and client groups from multiple 
source Brokers
ProcessModel Process models from one source ProcessModel server

Note: If you want to deploy process models from 
multiple ProcessModel servers, you must define a 
deployment set for each ProcessModel server.

webMethods Deployer User’s Guide Version 7.0 12

 1. Concepts

Deployment Set Contents

IS & TN Integration Server administrative items, Integration 
Server packages, and Trading Networks items from 
multiple source Integration Servers, and files from 
multiple webMethods installations on machines that 
host an Integration Server
MWS My webMethods Server items from multiple My 
webMethods Servers
Optimize Analytic metadata from multiple Optimize servers

The items you include in a deployment set depend on the target servers to which you 
want to deploy the items. For example, if you want to deploy a set of Integration Server 
items to the same target servers, you can define a single deployment set that identifies 
those items.

project
deployment set target servers

If you want to deploy some Integration Server items to one set of target servers and other 
Integration Server items to a different set of target servers, you would have to define two 
different deployment sets.
project
deployment sets target servers

As you define a deployment set, the Deployer determines when items that are in a 
deployment set require other items that are not in the deployment set. The Deployer 

webMethods Deployer User’s Guide Version 7.0 13

 1. Concepts

identifies these missing items as unresolved dependencies. For example, if you add a trigger 
to an IS & TN deployment set, but do not add the service that is invoked by the trigger, 
the Deployer identifies the missing service as an unresolved dependency. The Deployer 
gives you several options for resolving unresolved dependencies.

Build the Project

You build a project to create a file that contains the actual items that the project definition  
points to. You can build projects using the Deployer user interface or using a script.

Map the Project

You map a project build to identify the target servers for each deployment set the build 
contains. You can create multiple deployment maps for each project build.
As part of the mapping task for an IS & TN deployment set, you can tell the Deployer to 
change configuration parameters for the items so they will run properly on target servers 
after deployment. Suppose a development Integration Server has a file polling port 
configured to monitor the C:\TEMP directory. You want to deploy this port to a 
production Integration Server on a Solaris system and have the port poll the /tmp 
directory instead. You would change the portʹs configuration parameters so that the port 
will poll the /tmp directory. You can change configuration parameters for ports, 
scheduled tasks, adapter connections, and adapter notifications. You can specify different 
configuration parameters for different target servers.
If the Deployer in the source environment can also access the target environment, you will 
be able to map the project build using that Deployer. If the source environment Deployer 
cannot access the target environment, you will have to use a source environment 
Deployer to export the project build, then use a target environment Deployer to import 
(and later, map and deploy) the build.

Deploy the Project

To deploy a project, you first create a deployment candidate, which is the combination of a 
project build and a deployment map. You then generate a simulation report that scans the 
source and target servers and alerts you to some potential problems before you deploy. 
You then address any problems and deploy the project. The Deployer creates a deployment 
report that informs you of all actions that occurred during deployment.
You can deploy from the Deployer interface or you can deploy using a script. The 
Deployer copies the contents of each deployment set in the specified project build to the 
target servers identified in the specified deployment map.
For an IS & TN deployment set, if you specified changes to configuration parameters for 
certain deployed Integration Server or Trading Networks items on target servers, the 
Deployer changes those parameters during deployment.

webMethods Deployer User’s Guide Version 7.0 14

 1. Concepts

Checkpoint and Roll Back

If a deployment fails and the target environment is in an inconsistent state, or a 
deployment is successful but the deployed items are not working as expected, you can use 
the Deployer’s rollback feature to undo the deployment.
To use the rollback feature, you must create a checkpoint to which you want to roll back 
before you deploy. A checkpoint contains a copy of the assets on the target servers that 
will be replaced by assets you are about to deploy. The rollback feature rolls back the 
target servers to the checkpoint. If the deployment added assets to the target servers, the 
rollback removes them.
You can choose automatic or manual checkpoint, rollback, or both. If you choose 
automatic checkpoint or rollback, the Deployer automatically generates a checkpoint as 
the first step when you actually deploy a project. If you choose automatic rollback and the 
deployment fails, the Deployer automatically rolls back the target servers to the 
checkpoint.
If you choose manual checkpoint, you can generate a checkpoint at any time before you  
deploy. If you take multiple checkpoints for a deployment candidate, only the latest is 
retained. If you choose manual rollback, you can roll back the target servers manually any 
time after a deployment.

webMethods Deployer User’s Guide Version 7.0 15

 1. Concepts

webMethods Deployer User’s Guide Version 7.0 16

Chapter 2. Starting and Configuring Communication with the
Deployer

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Start the Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Configure for Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Configure for ProcessModel Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Configure for Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Configure for My webMethods Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Configure for Optimize Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

webMethods Deployer User’s Guide Version 7.0 17

 2. Starting and Configuring Communication with the Deployer

Overview
Some servers require a special component to communicate with the Deployer; you must 
install the appropriate communications component on each server. For most servers, you 
must configure communication between the Deployer and the server.    

Servers Communications Component

Brokers Built into the Deployer
Integration Servers WmDeployerResource package
ProcessModel servers that  WmDeployerResource package
run process steps
My webMethods Servers Built into My webMethods Server
Optimize servers Built into Optimize servers (that is, Analytic Engines)

Start the Deployer

The Deployer starts automatically when you start the host Integration Server.
Open the Deployer interface by entering this URL in an Internet browser, where 
Integration Server is the Integration Server that hosts the Deployer:
http://Integration Server_host:Integration Server_port/WmDeployer

The Deployer and Integration Server Administrator use the same log on user name and 
password. If you just installed the Deployer with a new Integration Server, the defaults 
are user name Administrator and password manage.
To log out of the Deployer, click Log Off on the top right corner of any Deployer page.

webMethods Deployer User’s Guide Version 7.0 18

 2. Starting and Configuring Communication with the Deployer

Configure for Brokers

Important! The Deployer cannot use SSL to connect to Brokers.

To configure communication with source and target Brokers:

In the Deployer, go to the ServersBroker page. For every source and target Broker, click 
Configure Broker Server. In the Configure Broker Server area, complete these fields:  

Box Entry
Name Name to assign to the Broker.
Host Host name or IP address of the Broker.
Port Port for the Broker.
Client Group Client group to use to access the Broker. For target Brokers, type admin.
Broker Name Name of the Broker.

Click Configure. If you want to test the connection, click  .

Configure for ProcessModel Servers

To configure communication with ProcessModel servers:

1 In the Deployer, go to the ServersProcessModel page. For every source and target 
ProcessModel server, click Configure ProcessModel Server. In the Configure ProcessModel
Server area, complete these fields:  

Box Entry
Name Name to assign to the server.
Host Host name or IP address of the server.
Port Port for the server.
User User name for a user account with Administrator authority that 
Deployer can use to access the server.

webMethods Deployer User’s Guide Version 7.0 19

 2. Starting and Configuring Communication with the Deployer

Box Entry
Password Password that is associated with the user name.
Use SSL Whether to encrypt the communication between the server and the 
Deployer. If you want to encrypt the communication, choose the Yes 
option.
You can only use SSL if the server is configured to use SSL. When 
defining the HTTPS port that the server uses for SSL, configure the 
port so that it does not request client certificates. For instructions on 
defining the HTTPS port, see the webMethods Integration Server 
Administrator’s Guide.

Click Configure. If you want to test the connection, click  .
2 In Designer, a logical‐to‐physical server mapping is defined for each process model. 
For deployment purposes, you must duplicate the mapping for each process model 
you want to deploy on the model’s source and target ProcessModel servers. In the 
Integration Server Administrator for each of the servers, do the following:
a Define the physical servers in the mapping as remote servers. For instructions, see 
the webMethods Integration Server Administrator’s Guide.

b Go to the PackagesManagement page and click   for the WmDesigner package.
c Click Add Logical Server and complete these fields:  

Box Entry
Name Name of a logical server in the mapping for the process model.
Type Integration Server.
Physical Physical server to which the logical server is mapped.
Server

d Click Add Logical Server.

e Repeat these steps to duplicate the rest of the mapping.
f Repeat these steps for every process model you want to deploy.
3 Install the WmDeployerResource package on each ProcessModel server that will run 
process steps. In the Deployer, go to the ServersIS & TN page.; the page lists all 
ProcessModel servers you defined as remote servers. In the Install column, select the 
check box next to each ProcessModel server, then click Install.
4 If a process model you want to deploy includes a task, go to the PackagesManagement 
page on the model’s source and target ProcessModel servers, click   for the 
WmTaskClient package, and identify the My webMethods Server that hosts the task.

webMethods Deployer User’s Guide Version 7.0 20

 2. Starting and Configuring Communication with the Deployer

Configure for Integration Servers

To configure communication with source and target Integration Servers:

1 Open the Integration Server Administrator for the Integration Server that hosts the 
Deployer and define the following as remote servers:
All source Integration Servers
All target Integration Servers
The Integration Server that hosts the Deployer, if you will be using it as a source 
or target server (that is, define the Integration Server as a remote server to itself)
For instructions on defining remote servers, see the webMethods Integration Server 
Administrator’s Guide.
2 Install the WmDeployerResource package on each Integration Server. In the 
Deployer, go to the ServersIS & TN page; the page lists all Integration Servers you 
defined as remote servers. In the Install column, select the check box next to each 
Integration Server, then click Install.

Configure for My webMethods Servers

To configure communication with My webMethods Servers:

In the Deployer, go to the ServersMWS page. For every source and target My 
webMethods Server, click Configure MWS Server. In the Configure MWS Server area, complete 
these fields:  

Box Entry
Name Name to assign to the My webMethods Server.
Host Host name or IP address of the My webMethods Server.
Port Port for the My webMethods Server.
User User name for a user account with Administrator authority that 
Deployer can use to access the My webMethods Server.
Password Password that is associated with the user name.
Include security When resolving dependencies for an item, whether to include 
dependencies security realms that contain that item, as well as  user/group/role 
references in the itemʹs security ACLs.
Root folder aliases My webMethods Server aliases to use as root folders when 
selecting pages to deploy. Separate the folders using commas.

webMethods Deployer User’s Guide Version 7.0 21

 2. Starting and Configuring Communication with the Deployer

Box Entry
Maximum folder Maximum number of items to display within My webMethods 
object count Server folders when you are defining and choosing items to 
include in an MWS deployment set.
Enable additional Whether to log debug information about items you select to source 
MWS logging My webMethods Server logs, and about items the Deployer 
deploys to target My webMethods Server logs.
Maximum folder Maximum number of My webMethods Server folder levels to 
depth display when you are defining and choosing items to include in an 
MWS deployment set.
Use SSL Whether to encrypt the communication between the My 
webMethods Server and the Deployer.
You can only use SSL if the My webMethods Server is configured 
to use SSL. When using the My webMethods Server Configurator 
to define the HTTPS port that the server uses for SSL, configure the 
port so that it does not request client certificates. For instructions, 
see the My webMethods Server Administrator’s Guide.

Click Configure. If you want to test the connection, click  .

Configure for Optimize Servers

To configure communication with Optimize servers:

In the Deployer, go to the ServersOptimize page. For every source and target Optimize 
server, click Configure Optimize Server. In the Configure Optimize Server area, complete these 
fields:  

Box Entry
Name Name to assign to the server.
Host Host name or IP address of the server.
Port Port for the server.

Click Configure. If you want to test the connection, click  .

webMethods Deployer User’s Guide Version 7.0 22

Chapter 3. Creating a Project

Set Default Properties for Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Create a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Authorize Groups to Perform Tasks on a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Add and View Instructions or Notes About a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

webMethods Deployer User’s Guide Version 7.0 23

 3. Creating a Project

Set Default Properties for Projects

The Deployer uses default properties for all projects. You can change these properties, and 
you can override many of those properties for individual projects if necessary. To set these 
properties, click Settings on the Deployer page. When you are done, click Save.

Set the Default for Dependency Checking

Under the Dependency Checking Defaults area on the Settings page, indicate how you want to 
check dependencies in deployment sets.  

Option Description
Automatic Tells the Deployer to automatically check dependencies regularly as you 
modify the project and progress through the different phases of 
deployment.
Reduced Tells the Deployer to automatically check dependencies when you create 
a project build and when you deploy. You can trigger additional 
dependency checking at different steps yourself.
Manual You trigger dependency checking at different steps yourself.

Set the Default Properties for Deployment

Under the General Deployment Defaults area on the Settings page, indicate whether the  
options below should be set manually by the user or automatically by the Deployer.  

Option Entry
Checkpoint To have the Deployer automatically create a checkpoint for a 
Creation deployment candidate before it is deployed, click Automatic. If you only 
want to generate checkpoints when you choose to (see “Generate a 
Checkpoint” on page 84), click Manual.  
Rollback on To have the Deployer automatically roll back a deployment candidate 
Error after a failed deployment, click Automatic. If you only want to roll back 
the project when you choose to (see “Roll Back the Target Servers” on 
page 84), click Manual.
Cluster If you want to deploy to each Integration Server 6.5 in a cluster yourself, 
Support click Manual.
If you want to deploy to a single Integration Server 6.5 in a cluster and 
have that Integration Server automatically propagate the deployment to 
the other Integration Servers in the cluster, click Automatic. For 
instructions on setting up this feature, see Chapter 12, “Deploying to 
Clustered 6.5 Integration Servers”.

webMethods Deployer User’s Guide Version 7.0 24

 3. Creating a Project

Set Default Properties for Integration Server & Trading

Networks Projects
The default properties for Integration Server & Trading Networks projects apply to all 
items except Integration Server packages. You specify package properties for each 
package individually, as described in “Set the Package Properties” on page 49.

To set default properties for IS & TN projects:

1 Under the Suspend During Deployment area, indicate whether the Deployer should 

suspend activity for the Integration Server items listed below while deployment is 
going on. Typically, if the targets are production Integration Servers, you would 
suspend all of these types of items. After deployment, the Deployer resumes the 
suspended triggers, adapter listeners; polling notifications; enables the disabled ports, 
and stops preventing the scheduled tasks.  

Item Description Click...

Triggers Allow all running trigger operations to complete, then  All
suspend all trigger execution and document retrieval on 
the target Integration Servers.

Important! If you choose All, the Deployer suspends execution and 
document retrieval for ALL triggers on the target Integration 
Servers, not just for the triggers that you include in the project.

Not suspend triggers. None
Choose individual triggers to suspend from the  Selected
packages in the project. You can use this option under 
these conditions:
The source and target Integration Servers are 
release 6.0.1 and are equipped with SP1 and Fix 144, 
and the triggers were developed on a 6.0.1 
Developer equipped with SP1_Fix9
The source and target Integration Servers are 
release 6.1 and are equipped with Fix 22
The source and target Integration Servers are 
release 6.5
You choose the triggers when you set package 
properties. For instructions, see “Set the Package 
Properties” on page 49.
Ports Whether to disable ports on the target Integration Servers that 
match ports you are trying to deploy.

webMethods Deployer User’s Guide Version 7.0 25

 3. Creating a Project

Item Description Click...

Scheduled Whether to prevent scheduled tasks on the target Integration 
Tasks Servers that match scheduled tasks you are trying to deploy from 
running.

Note: Tasks that are already running at deployment time are not 
affected by deployment.

Adapters Not suspend adapter listeners or polling notifications. None

Choose individual adapter listeners and polling  Selected
notifications to suspend from the packages in the 
project. You can use this option when the source and 
target Integration Servers are release 6.5.
You choose the notifications when you set package 
properties. For instructions, see “Set the Package 
Properties” on page 49.

2 Under the Overwrite Existing area, indicate how the Deployer should proceed when it 
finds that items you are trying to deploy already exist on target Integration Servers.  

For this
option... Indicate whether the Deployer should...
TN Rules Overwrite existing Trading Networks processing rules or append 
the processing rules you are trying to deploy to the ones that 
already exist.
ACL Maps Deploy the mapping of ACLs to services for any services you 
choose to deploy. You would choose to deploy ACL maps if you 
want to assign the same ACLs to the deployed services on the 
target Integration Server that you assigned to the source services 
on the source Integration Servers.
Other Non- Overwrite existing items. This option applies to all items except 
Package Items the following:
Trading Networks processing rules (see TN Rules, above).

Integration Server ACL maps (see ACL Maps, above).

Integration Server packages. You specify the overwrite option 
for Integration Server packages on a package‐by‐package 
basis, as described in “Set the Package Properties” on page 49.

webMethods Deployer User’s Guide Version 7.0 26

 3. Creating a Project

Note: Before you deploy a project, you can find out which items the Deployer will 
overwrite by generating the simulation report.

3 Under Activate After Deployment, indicate whether the Deployer should activate newly 

deployed ports and scheduled tasks on the target Integration Servers. Activate After
Deployment is used only if Suspend During Deployment is set to Yes.   

Note: If you choose to activate ports, and one of the ports you deploy uses the same 
port number as an existing port on a target Integration Server, the Deployer will 
display a message to that effect and will not activate the port.

4 Click Save.

Create a Project
You can create a project by creating a new, blank project or by copying an existing project 
and modifying it.   

To create a project:

1 On the Projects page, create a project using one of these methods:  

Create... Steps
New 1 Click Create Project.
2 In the Name box, type the name to use for the new project. The 
name can be up to 32 characters long and can include any 
characters that are valid for a file name in your operating system.
3 In the Description box, type a description for the project. The 
description length has no limit and can include any characters.
4 Click Create.
From  1 Click Copy Project.
existing
2 In the Project to Copy box, click the project to copy.
3 In the New Project Name box, type the name to use for the new 
project. The name can be up to 32 characters long and can include 
any characters that are valid for a file name in your operating 
system.
4 Click Copy Project.

5 Review the default properties for projects in the right pane and override any if 
necessary, then click Save.

webMethods Deployer User’s Guide Version 7.0 27

 3. Creating a Project

For explanations of the Dependency Checking Options, General Deployment Options, and IS

& TN Deployment Options properties, see “Set Default Properties for Projects” on 
page 24.
If the project is for Optimize, you can set the Include Dimension Values property for the 
project under the Optimize Options area to indicate whether the Deployer should 
include the values for dimensions you add to deployment sets (for example, 
Customer Names or Product Types).
If the project is for Designer, you can set the properties below for the project under the 
ProcessModel Deployment Options area. For more information, see the webMethods 
Monitor User’s Guide.  

For this option... Indicate whether the Deployer should...

Enable process for Enable webMethods‐executed process model versions for 
execution execution after deployment. When a process model version is 
enabled, the Process Engine uses the enabled version when 
starting new process instances. When a process model is 
disabled, the Process Engine does not use the model version 
for new process instances.
Only one version of a process model can be enabled at a time. 
If there are no enabled versions of a process model, the Process 
Engine will not start any process instances of the model.
Enable process for Enable webMethods‐executed process models for analysis. 
analysis When a process model is enabled, the Process Engine forwards 
all process instance activity to the Optimize Analytic Engines. 
When a process model is disabled, no activity is forwarded.

If the project is for My webMethods Server, you can set these properties for the project 
under the MWS Deployment Options area:  

For this option... Indicate whether the Deployer should...

Export Deploy subscriptions for My webMethods Server items you 
Subscriptions are deploying.
Export Access Deploy ACLs for My webMethods Server items you are 
Control Lists deploying.
Export Principal Include attributes contained in attributes providers when 
Attributes exporting users, groups, and roles.
Alias Prefix Place a prefix on every automatically generated My 
webMethods Server alias. Type the prefix to apply to the aliases.

webMethods Deployer User’s Guide Version 7.0 28

 3. Creating a Project

For this option... Indicate whether the Deployer should...

Auto Generate Automatically generate an alias on the target My webMethods 
Aliases Server for every My webMethods Server item that is deployed. 
If an item already has one or more aliases, then the aliases are 
retained when the auto‐generated alias is added.
Export Content Deploy content referenced by portal pages and folders you are 
(Documents) deploying (for example, a PDF document that has been 
published on a portal page you are deploying).

6 Click Save.

Authorize Groups to Perform Tasks on a Project

You authorize users to perform tasks by selecting a task and assigning Integration Server 
security groups to it. After you authorize certain groups to perform tasks on projects, the 
users in those groups will see only those projects to which they are authorized when the 
users display the Projects page.   
You must have Administrator ACL authorization to create projects and authorize other 
users to perform tasks in Deployer. Users must have Developer ACL authorization to 
perform tasks in Deployer.

To authorize groups to perform tasks:

1 All users you want to authorize to perform certain tasks (by authorizing their groups 
to perform the tasks) must belong to the Developers security group. You can also 
create intuitively named groups for use with the Deployer (for example, you could 
create groups named viewProjects, buildProjects, mapProjects, deployProjects, and 
defineProjects). For instructions on assigning users to security groups and creating 
security groups, see the webMethods Integration Server Administrator’s Guide.
2 In the Deployer, go to the Projects page.
3 Locate the project to which you want to authorize users. In the Authorize column for 
the project, click  .
4 In the Select Authorization list, click a task to which you want to authorize users.
5 The Not Specified box lists all groups defined on the local Integration Server. Using the 
arrow buttons, move each group that you want to assign to the selected task into the 
Allowed box. Move each group that you do not want to assign to the selected task into 
the Denied box.
6 Click Update.
The Resulting users with this Authorization lists all users that belong to the groups you 
assigned to the task (that is, the groups you moved into the Allowed box).

webMethods Deployer User’s Guide Version 7.0 29

 3. Creating a Project

Add and View Instructions or Notes About a Project

When you create a project, the Deployer automatically creates an HTML home page for 
the project. The HTML home page for a project is located in the Integration 
Server_directory\packages\WmDeployer\pub\projects\project directory. The file name 
for the home page is project.html. Modify the page as necessary, but do not move it from 
this directory or rename it.    

To view the home page for the project, go to the Deployer Projects page and click   in the 
Home column for the project.

webMethods Deployer User’s Guide Version 7.0 30

Chapter 4. Defining a Broker Deployment Set

Create the Broker Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Identify the Source Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Add webMethods Broker Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Resolve Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

webMethods Deployer User’s Guide Version 7.0 31

 4. Defining a Broker Deployment Set

Create the Broker Deployment Set

To create the Broker deployment set:

1 In the Deployer, go to the Projects page. In the Name column, click the project in which 
to create a Broker deployment set.

2 In the right pane, click   Define.
3 Click Create Deployment Set.
4 In the Type list, click Broker, then complete these fields:  

Box Entry
Name Name to use for the deployment set. The name can be up to 32 
characters long and can include any characters that are valid 
for a file name in your operating system.
Description Description for the deployment set. The description length has 
no limit and can include any characters.
All other items After you choose the source Brokers, the Deployer will display 
all items on those Brokers. You can use this field to narrow the 
display. Specify a regular expression that specifies the text the 
item names must contain in order to be listed.

5 Click Create.

Identify the Source Brokers

To identify the source Brokers:

1 On the Deployer ProjectsprojectDefine page, in the left pane in the Name column, 
click the name of the deployment set for which to identify source Brokers. In the right 
pane in the Select Source Broker Servers area, the Deployer lists all Brokers you set up to 
work with the Deployer.  

Note: If a Broker you want to use as a source does not appear in the list, you have not 
yet set it up to work with the Deployer. For instructions, see “Configure for Brokers” 
on page 19. 

2 In the Select column, select the check box next to each Broker that contains items to 
add to the deployment set.
3 Click Save.

webMethods Deployer User’s Guide Version 7.0 32

 4. Defining a Broker Deployment Set

Add webMethods Broker Items

To add webMethods Broker items:

1 In the Deployment Sets area, under the deployment set to which you want to add 
webMethods Broker items, click the Broker folder. In the right pane, the Deployer lists 
the source Brokers you identified.
2 In the right pane, open the tree to show the items on the source Brokers, then select 
the check box next to each item to add to the deployment set.  

Important! Do not add any client groups with a queue type of persistent and a lifecycle 
set to explicit destroy. The Deployer cannot deploy such client groups.

3 Click Save. The Deployer shows your choices in the left pane under the Broker folder 
for the deployment set.

Resolve Dependencies
For any project, the Deployer can determine when items that are in a deployment set 
require other items that are not in the deployment set. The items that require other items 
are called dependent items, while the items that are required are called referenced items. The 
Deployer identifies missing referenced items as unresolved dependencies. For example, if 
you add a client group to a Broker deployment set, but do not add the documents that the 
client group can publish or subscribe to, then the Deployer identifies the documents as 
unresolved dependencies. 
In the project properties (“Set the Default for Dependency Checking” on page 24), you 
indicated how you want to check dependencies in the deployment sets. When the 
Deployer automatically checks dependencies and finds unresolved dependencies in a 
deployment set, it shows   in the Unresolved Dependencies or References column for the 
deployment set; when there are no unresolved dependencies, the Deployer shows   in 
the column. When you can check dependencies manually, the Deployer shows   in the 
Unresolved Dependencies or References column for each deployment set; click Check next to 
the  . If necessary, you can later un‐resolve a dependency you have resolved and re‐
resolve it a different way.

To resolve dependencies:

1 In the Unresolved Dependencies column for the deployment set, click Check. The 
Deployer shows all unresolved dependencies on the Unresolved Dependencies page. 
The Referenced Item column lists the missing referenced items. The next column offers 
the possible ways you can resolve the unresolved dependency. The Project Item column 
shows the dependent items.

webMethods Deployer User’s Guide Version 7.0 33

 4. Defining a Broker Deployment Set

2 Tell the Deployer how to resolve each unresolved dependency as described below. If 
you want to resolve all items in a folder the same way, you can set the resolution at the 
folder level rather than at the level of the individual items.

Option Description
Add If the referenced item does not exist on the target servers and you want 
to deploy the referenced item to them, use this option. The Deployer 
adds the referenced item to the deployment set.
Exists If you believe the referenced item already exists on the target servers 
and you want to continue working, but you want the Deployer to make 
sure the item does in fact exist later, use this option. The Deployer will 
check for the referenced item when you map the project to target  
servers. If the Deployer does not find the item, an icon alerts you during 
the mapping task.
If you do not address the problem during the mapping task, the 
Deployer will write a message about the problem to the simulation 
report. If you deploy without addressing the problem, the Deployer will 
not deploy the deployment set.
Ignore If you want to bypass dependency checking for the referenced item at 
this time so you can continue working, use this option. You might use 
this option if the referenced item is missing on the source server. Missing 
referenced items are marked with a question mark (?) on the Unresolved
Dependencies page.
Before deploying, make sure either that the referenced item exists on the 
target server or that the referenced item is unnecessary. If the referenced 
item does not exist on the target server, the Deployer might not be able 
to deploy correctly; if it can deploy, the deployed items will not run 
correctly.
The Deployer will list ignored items in the simulation report and in the 
deployment report.

3 Click Save. The Deployer moves dependencies you resolved using the Exists or Ignore 
option to the Resolved Dependencies page.
4 To see the resolved dependencies, click Resolved Dependencies.
You can un‐resolve a resolved dependency and re‐resolve it differently, as follows:
To un‐resolve a dependency you resolved using the Exists option or the Ignore 
option, go to the Resolved Dependencies page, select the check box in the Delete 
column for the resolved dependency, and click Delete.
To un‐resolve a dependency you resolved using the Add option, return to the 
ProjectsprojectDefine page, open the folder that contains the item, navigate to 

webMethods Deployer User’s Guide Version 7.0 34

 4. Defining a Broker Deployment Set

the item in the tree in the right pane, cancel the selection of the item by clearing 
the appropriate check box, and save the deployment set.
When you un‐resolve a resolved dependency, the Deployer returns the dependency to 
the Unresolved Dependencies page. Go to that page and re‐resolve the dependency.

webMethods Deployer User’s Guide Version 7.0 35

 4. Defining a Broker Deployment Set

webMethods Deployer User’s Guide Version 7.0 36

Chapter 5. Defining a ProcessModel Deployment Set

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Create the ProcessModel Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Add Process Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Resolve Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Remove Process Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

webMethods Deployer User’s Guide Version 7.0 37

 5. Defining a ProcessModel Deployment Set

Overview
A ProcessModel deployment set can deploy process models from only one ProcessModel 
server. If you want to deploy process models from multiple ProcessModel servers, you 
must create a deployment set for each of those ProcessModel servers.

Create the ProcessModel Deployment Set

To create the ProcessModel deployment set:

1 In the Deployer, go to the Projects page. In the Name column, click the project in which 
to create a ProcessModel deployment set.

2 In the right pane, click   Define.
3 Click Create Deployment Set.
4 From the Type list, select ProcessModel, then complete these fields:  

Box Entry
Name Name to use for the deployment set. The name can be up to 32 
characters long and can include any characters that are valid 
for a file name in your operating system.
Description Description for the deployment set. The description length has 
no limit and can include any characters.
Packages After you choose the source ProcessModel servers, the 
Deployer will display all packages on those servers. You can 
use this field to narrow the display. Specify a regular 
expression that specifies the text the package names must 
contain in order to be listed.
All other items After you choose the source ProcessModel servers, the 
Deployer will display all items on those servers. You can use 
this field to narrow the display. Specify a regular expression 
that specifies the text the item names must contain in order to 
be listed.

5 Click Create.

webMethods Deployer User’s Guide Version 7.0 38

 5. Defining a ProcessModel Deployment Set

Identify the Source ProcessModel Server

To identify the source ProcessModel server:

1 On the Deployer ProjectsprojectDefine page, in the left pane in the Name column, 
click the name of the deployment set for which to identify the source ProcessModel 
server. In the right pane in the Select Source ProcessModel Server area, the Deployer lists 
all ProcessModel servers you set up to work with the Deployer.  

Note: If the ProcessModel server you want to use as the source does not appear in the 
list, you have not yet set it up to work with the Deployer. For instructions, see 
“Configure for ProcessModel Servers” on page 19. 

2 In the Select column, click the ProcessModel server that contains process models to 
add to the deployment set.
3 Click Save.

Add Process Models

To add process models:

1 In the Deployment Sets area, under the deployment set to which you want to add 
process models, click the ProcessModel folder. In the right pane, the Deployer lists the 
source ProcesModel server you identified.
2 In the right pane, open the tree to show the process models on the ProcessModel 
server, then select the check box next to each process model to add to the deployment 
set.
3 Click Save. The Deployer shows your choices in the left pane under the ProcessModel 
folder for the deployment set.

Resolve Dependencies
For any project, the Deployer can determine when items that are in a deployment set 
require other items that are not in the deployment set. The items that require other items 
are called dependent items, while the items that are required are called referenced items. The 
Deployer identifies missing referenced items as unresolved dependencies. For example, if 
you add a process model to a ProcessModel deployment set, but do not add the flow 
services that are called by that process model, the Deployer identifies the flow services as 
unresolved dependencies.

In the project properties (“Set the Default for Dependency Checking” on page 24), you 
indicated how you want to check dependencies in the deployment sets. When the 

webMethods Deployer User’s Guide Version 7.0 39

 5. Defining a ProcessModel Deployment Set

Deployer automatically checks dependencies and finds unresolved dependencies in a 
deployment set, it shows   in the Unresolved Dependencies or References column for the 
deployment set; when there are no unresolved dependencies, the Deployer shows   in 
the column. When you can check dependencies manually, the Deployer shows   in the 
Unresolved Dependencies or References column for each deployment set; click Check next to 
the  . If necessary, you can later un‐resolve a dependency you have resolved and re‐
resolve it a different way.

To resolve dependencies:

1 In the Unresolved Dependencies column for the deployment set, click Check. The 
Deployer shows all unresolved dependencies on the Unresolved Dependencies page. 
The Referenced Item column lists the missing referenced items. The next column offers 
the possible ways you can resolve the unresolved dependency. The Project Item column 
shows the dependent items.
2 Tell the Deployer how to resolve each unresolved dependency as described below. If 
you want to resolve all items in a folder the same way, you can set the resolution at the 
folder level rather than at the level of the individual items.

Option Description
Add If the referenced item does not exist on the target servers and you want 
to deploy the referenced item to them, use this option. The Deployer 
adds the referenced item to the deployment set.
Exists If you believe the referenced item already exists on the target servers 
and you want to continue working, but you want the Deployer to make 
sure the item does in fact exist later, use this option. The Deployer will 
check for the referenced item when you map the project to target  
servers. If the Deployer does not find the item, an icon alerts you during 
the mapping task.
If you do not address the problem during the mapping task, the 
Deployer will write a message about the problem to the simulation 
report. If you deploy without addressing the problem, the Deployer will 
not deploy the deployment set.

webMethods Deployer User’s Guide Version 7.0 40

 5. Defining a ProcessModel Deployment Set

Option Description
Ignore If you want to bypass dependency checking for the referenced item at 
this time so you can continue working, use this option. You might use 
this option if the referenced item is missing on the source server. Missing 
referenced items are marked with a question mark (?) on the Unresolved
Dependencies page.
Before deploying, make sure either that the referenced item exists on the 
target server or that the referenced item is unnecessary. If the referenced 
item does not exist on the target server, the Deployer might not be able 
to deploy correctly; if it can deploy, the deployed items will not run 
correctly.
The Deployer will list ignored items in the simulation report and in the 
deployment report.

3 Click Save. The Deployer moves dependencies you resolved using the Exists or Ignore 
option to the Resolved Dependencies page.
4 To see the resolved dependencies, click Resolved Dependencies.
You can un‐resolve a resolved dependency and re‐resolve it differently, as follows:
To un‐resolve a dependency you resolved using the Exists option or the Ignore 
option, go to the Resolved Dependencies page, select the check box in the Delete 
column for the resolved dependency, and click Delete.
To un‐resolve a dependency you resolved using the Add option, return to the 
ProjectsprojectDefine page, open the folder that contains the item, navigate to 
the item in the tree in the right pane, cancel the selection of the item by clearing 
the appropriate check box, and save the deployment set.
When you un‐resolve a resolved dependency, the Deployer returns the dependency to 
the Unresolved Dependencies page. Go to that page and re‐resolve the dependency.

Remove Process Models

When you add a process model to a deployment set and then add referenced items that 
reside on the logical servers, the Deployer shows the referenced items as children of the 
process model. If you want to remove a process model from a deployment set, you must 
first remove all its child items.

webMethods Deployer User’s Guide Version 7.0 41

 5. Defining a ProcessModel Deployment Set

webMethods Deployer User’s Guide Version 7.0 42

Chapter 6. Defining an IS & TN Deployment Set

Create the IS & TN Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Identify Source Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Add Integration Server Administration Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Add Integration Server Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Add webMethods Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Add Trading Networks Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Resolve Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Manually Add Dependencies to a Package Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

webMethods Deployer User’s Guide Version 7.0 43

 6. Defining an IS & TN Deployment Set

Create the IS & TN Deployment Set

To create the IS & TN deployment set:

1 In the Deployer, go to the Projects page. In the Name column, click the project in which 
to create an IS & TN deployment set.

2 In the right pane, click   Define.
3 Click Create Deployment Set.
4 From the Type list, select IS & TN, then complete these fields:  

Box Entry
Name Name to use for the deployment set. The name can be up to 32 
characters long and can include any characters that are valid 
for a file name in your operating system.
Description Description for the deployment set. The description length has 
no limit and can include any characters.
Packages After you choose the source Integration Server, the Deployer 
will display all packages on those Integration Servers. You can 
use this field to narrow the display. Specify a regular 
expression that specifies the text the package names must 
contain in order to be listed.
All other items After you choose the source Integration Servers, the Deployer 
will display all items on those Integration Servers. You can use 
this field to narrow the display. Specify a regular expression 
that specifies the text the item names must contain in order to 
be listed.

5 Click Create.

webMethods Deployer User’s Guide Version 7.0 44

 6. Defining an IS & TN Deployment Set

Identify Source Integration Servers

To identify source Integration Servers:

1 On the Deployer ProjectsprojectDefine page, in the left pane in the Name column, 
click the deployment set for which you want to identify source Integration Servers. In 
the right pane, in the Select Source Servers area, the Deployer lists all remote servers 
defined to the Integration Server that hosts the Deployer.  

Note: If an Integration Server you want to use as a source does not appear in the list, 
you must define it as a remote server to the host Integration Server. This includes the 
host Integration Server; to use it as a source, you must define it as a remote server to 
itself. For instructions, see the webMethods Integration Server Administrator’s Guide. 
After you define a new remote server with the Integration Server Administrator, click 
Refresh this Page on the Deployer to update the list of servers. 

2 In the Select column, select the check box next to each Integration Server that contains 
items to add to the deployment set.
3 Click Save.
4 Make sure every Integration Server you identified as a source is equipped with the 
Deployer resource package. To do so, go to the ServersIS & TN page and check 
whether the Resource Package column displays the word “Installed” for those 
Integration Servers. If the column does not show “Installed,” you must install the 
resource package on the Integration Servers. In the Install column, select the check box 
next to each Integration Server you identified as a source, then click Install.

Add Integration Server Administration Items

You cannot deploy Integration Server 6.5 diagnostic ports.  
To add Integration Server administration items:

1 In the Deployment Sets area, under the deployment set to which you want to add 
Integration Server administration items, click the Administration folder. In the right 
pane, the Deployer lists the source Integration Servers you identified.
2 In the right pane, open the tree to show the administration items on the source 
Integration Servers, then select the check box next to each item to add to the 
deployment set.
3 Click Save. The Deployer shows your choices in the left pane under the Administration 
folder for the deployment set. 
4 If you are not going to add any more items to the deployment set, go to “Resolve 
Dependencies” on page 53.

webMethods Deployer User’s Guide Version 7.0 45

 6. Defining an IS & TN Deployment Set

Add Integration Server Packages

When you add an Integration Server package to the deployment set, you can do one of the 
following:
Add the package in its entirety

Add selected package components only

Add selected package files only
A package from which you have added only selected components or files is called a partial 
package. You can add both entire packages and partial packages to a deployment set.
If you add a partial package of only selected files to a deployment set and the package 
already exists on target Integration Servers, you can have the Deployer delete specified 
files from the existing package on the target Integration Servers after deployment. You 
might use this feature if the existing package contains a service that has been superseded; 
you would deploy the files that make up the new service and delete the files that make up 
the old service.

Add an Entire Package

To add an entire package:

1 In the Deployment Sets area, under the deployment set to which you want to add 
packages, click the Packages folder. In the right pane, the Deployer lists the source 
Integration Servers you identified.
2 In the right pane, open the tree to show the packages on the source Integration Servers, 
then select the check boxes next to the packages you want to add in their entirety.

3 Click Save. The Deployer shows the entire package icon ( ) in the left pane under the 
Packages folder for the deployment set. The Deployer also shows the entire package 
icon for selected packages in the package list in the right pane, and the check boxes 
next to the packages are marked with a black check mark.
4 If you are done adding packages to the deployment set, go to “Set the Package 
Properties” on page 49.

webMethods Deployer User’s Guide Version 7.0 46

 6. Defining an IS & TN Deployment Set

Add Package Components

Important! Use caution if you choose to add both package components and package files to 
a deployment set, for these reasons:
If you first select components, then select files, the Deployer only allows you to add 
files from the package file list.
If you first select files, then select components, the Deployer might overwrite certain 
file selections to ensure consistency.

To add package components:

1 In the Deployment Sets area, under the deployment set to which you want to add 
package components, click the Packages folder. In the right pane, the Deployer lists 
the source Integration Servers you identified.
2 In the right pane, open the tree to show the packages on the source Integration Servers, 
then click the name of a package that contains components you want to add to the 
deployment set.
3 In the Select Components area, open the tree to show the components in the package, 
then select the check box next to each component to add to the deployment set.
4 Click Save.

5 Click Return to Package List. The Deployer shows the partial package icon ( ) in the 

left pane under the Packages folder for the deployment set. The Deployer also shows 
the partial package icon for the selected package in the package list in the right pane, 
and the check box next to the package is marked with a gray check mark (as opposed 
to the black check mark used for selected entire packages).  

Note: If you later decide you want to include the entire package (as opposed to 
selected components only), cancel the selection of the components by clicking the 
name of the partial package, clearing all checked boxes, and clicking Save. Then save 
the deployment set and select the entire package as explained in “Add an Entire 
Package” on page 46.

6 If you are done adding packages to the deployment set, go to “Set the Package 
Properties” on page 49.

webMethods Deployer User’s Guide Version 7.0 47

 6. Defining an IS & TN Deployment Set

Add Package Files

Important! Use caution if you choose to add both package components and package files to 
a deployment set, for these reasons:
If you first select files, then select components, the Deployer might overwrite certain 
file selections to ensure consistency.
If you first select components, then select files, the Deployer only allows you to add 
files from the package file list.

To add package files:

1 In the Deployment Sets area, under the deployment set to which to add package files, 
click the Packages folder. In the right pane, the Deployer lists the source Integration 
Servers you identified.
2 In the right pane, open the tree to show the packages on the source Integration 
Servers, then click the name of a package that contains files you want to add to the 
deployment set.
3 Click Select Files. The Deployer lists all files in the package. 

Note: The Select Files option is near the top of the right pane. It is a link, not a button. 

Do one of the following:

If you want to add... Action

All the files in the list Click All files.
Only files you select in  Click Selected Files, then press the CTRL button and 
the list click each file to add to the deployment set.
Only files other than those  Click All except selected files, then press the CTRL 
you select in the list button and click each file to not add to the deployment 
set.
All files in the list whose  Click Files specified by filter, then type the string on 
name contains a specified  which to match. You can use an asterisk (*) as a wild 
string card (for example, *.java or *.class).
All files in the list whose  Click All except files specified by filter, then type the 
name does not contain a  string on which to match. You can use an asterisk (*) as 
specified string a wild card (for example, *.java or *.class).

4 If a package of the same name as this partial package already exists on one of the 
deployment set’s target Integration Servers, and the existing package contains files 

webMethods Deployer User’s Guide Version 7.0 48

 6. Defining an IS & TN Deployment Set

you want to delete after deployment, type the fully qualified names of the files to 
delete in the Files to Delete from Target box. Type each file name on its own line, and end 
each line with a semicolon (;). For example:
code/classes/wm/administratorResource/admin.class;
code/classes/wm/administratorResource/user.class;
ns/wm/administratorResource/

5 Click Save.

6 Click Return to Package List. The Deployer shows the partial package icon ( ) in the 

left pane under the Packages folder for the deployment set. The Deployer also shows 
the partial package icon for the selected package in the package list in the right pane, 
and the check box next to the package is marked with a gray check mark (as opposed 
to the black check mark used for selected entire packages).

Note: If you later decide you want to include the entire package (as opposed to 
selected files only), cancel the selection of the files by navigating to the file selection 
page and clicking None, then save the deployment set, and then select the entire 
package as explained in “Add an Entire Package” on page 46.

7 If you are done adding packages to the deployment set, go to “Set the Package 
Properties” on page 49.

Set the Package Properties

You must set the package properties for each package you added to the deployment set. 
To set properties for a package:

1 In the Deployment Sets area, under the deployment set to which you added entire or 
partial packages, open the tree under the Packages folder and click a package.
2 In the package_name Properties area, specify the following:  

Box Entry
Package Type Use this property when the source package already exists on the 
target Integration Servers. You can use the options below for entire 
packages and for partial packages.
If you want the Deployer to... Click...

Deploy the source package, replacing the existing package  Full
entirely. When you choose to deploy an entire package, 
this is the default.

webMethods Deployer User’s Guide Version 7.0 49

 6. Defining an IS & TN Deployment Set

Box Entry
Deploy the components and files in the source package  Patch
over the corresponding components and files in the 
existing package. When you choose to deploy package 
components, package files, or both, this is the default.

Note: Before you deploy a project, you can find out which items the 
Deployer will overwrite by generating the simulation report.

Version Supply the version number to use for the source package in 
comparisons with existing packages on target Integration Servers. 
Whether the Deployer actually deploys depends on the version 
numbers of the source package and the existing package. If the 
source package’s version number is the same or higher than the 
existing package’s version number, the Deployer deploys. If the 
source package’s version number is lower than the existing 
package’s version number, the Deployer does not deploy.

Note: The version number for the source package on the source 
Integration Server is not affected by your entry here.

Build Supply the build number to assign to the deployed package on the 
target Integration Servers. Specify a build number only if you 
selected Full for Package Type.
Patches Supply the list of patches that have been applied to the deployed 
Included package on the target Integration Servers. Specify the patch 
numbers, separated by commas (for example, 44, 45, 55). Specify 
patches only if you selected Full for Package Type.
Brief Supply a description to use for the deployed package on the target 
Description Integration Servers (for example, “December 2003 release with 
patches to correct Order Process problem.”) Specify a description 
only if you selected Full for Package Type.

3 In the Recommendations for Target area, you can recommend the minimum version of 

Integration Server and Java Virtual Machine (JVM) to run the source package. If the 
JVM version on the target Integration Server is lower than you specify here, the 
Deployer will deploy the source package but will not activate it, regardless of the 
setting of the Activate After Deployment option, and the target Integration Server will 
display a warning about the JVM version. The defaults shown in this area reflect the 
Integration Server and JVM that host the source package.
4 In the Package Build Options area, indicate whether you want the Deployer to use the 
package version and build numbers that exist in the source Integration Server each 

webMethods Deployer User’s Guide Version 7.0 50

 6. Defining an IS & TN Deployment Set

time the user makes a build instead of the package version and build numbers 
specified in the package_name Properties area.
5 In the Package Deployment Options area, specify the following:

Option Entry
Activate After How the Deployer should deploy the package.
Deployment
If you want to... Click

The Deployer deploys the package to the Integration  Activate
Server_directory\replicate\inbound directory on the 
target Integration Servers, then enables the package.
The Deployer deploys the package to the Integration  Install
Server_directory\replicate\inbound directory on the  Only
target Integration Servers and installs it but does not 
enable it.
The Deployer deploys the package to the Integration  Inbound
Server_directory\replicate\inbound directory on the  Only
target Integration Servers but does not install or 
enable it.
Sync Whether the Deployer should synchronize the publishable IS 
Document document types in the source package with documents types on 
Types the Brokers that are connected to the target Integration Servers.
The connected Brokers must be available at deployment time for 
synchronization to occur. If a connected Broker is not available, IS 
document types are not synchronized for the Integration Server to 
which the Broker is connected. The Deployer writes a message to 
that effect to the deployment report.

Note: The Deployer can detect Broker unavailability when you 
generate the simulation report and will write a message advising 
you of the problem to the report.

If you want to... Click

Synchronize all publishable IS document types in the  New
package that are new to the target Integration Servers. 
Do not synchronize IS document types in the package 
that already exist on the target Integration Servers, 
even if they have been modified.

webMethods Deployer User’s Guide Version 7.0 51

 6. Defining an IS & TN Deployment Set

Option Entry
Synchronize all publishable IS document types in the  All
package.
Not synchronize any IS document types. None

6 If you indicated in the project properties that you want to suspend individual triggers 
during deployment, click Suspend Triggers, select the check box next to each trigger to 
suspend, click Suspend, and then return to the previous page.
7 If you indicated in the project properties that you want to suspend individual adapter 
notifications during deployment, click Suspend Notifications, select the check box next 
to each notification to suspend, click Suspend, and then return to the previous page.  

Important! If you suspend a particular adapter notification but the notification does not 
exist on a target Integration Server, you will not be able to deploy. Only suspend 
notifications that already exist on all target Integration Servers.

8 Click Save.
9 Repeat these steps for each package in the deployment set.
10 If you are not going to add any more items to the deployment set, go to “Resolve 
Dependencies” on page 53.

Add webMethods Files

When the Deployer deploys a webMethods file, the file retains the read/write permissions 
it had on the source server. 
To add webMethods files:

1 In the Deployment Sets area, under the deployment set to which you want to add 
webMethods files, click the webMethods Files folder. In the right pane, the Deployer 
lists the source Integration Servers you identified.
2 In the right pane, open the tree to show the webMethods installation directory and its 
contents on the source Integration Servers. Select the check box next to each file to add 
to the deployment set.
3 Click Save. The Deployer shows your choices in the left pane under the webMethods
Files folder for the deployment set.
4 If you are not going to add any more items to the deployment set, go to “Resolve 
Dependencies” on page 53.

webMethods Deployer User’s Guide Version 7.0 52

 6. Defining an IS & TN Deployment Set

Add Trading Networks Items

When you deploy Trading Networks items to an Integration Server, the Deployer updates 
the Trading Networks database that is connected to the Integration Server with the 
deployed items. When defining a project that includes deploying Trading Networks items 
to a clustered environment, you can deploy the items to only one Trading Networks‐
equipped Integration Server in the cluster. Do not deploy to multiple Integration Servers 
in the network, or you will experience unpredictable results.  
To add Trading Networks items:

1 In the Deployment Sets area, under the deployment set to which you want to add 
Trading Networks items, click the Trading Networks folder. In the right pane, the 
Deployer lists the source Integration Servers you identified.
2 In the right pane, open the tree to show the Trading Networks items on the source 
Integration Servers, then select the check box next to each item to add to the 
deployment set.  

Important! If you add a processing rule from a 6.0.1 Trading Networks to a deployment 
set, the processing rule might require custom contact types. If the custom contact 
types do not already exist on the target Integration Servers, you must add them to the 
deployment set. If you do not, the Deployer will log an error to the deployment report 
and the processing rule will not be deployed. (This is not an issue when adding 
processing rules from a 6.1 Trading Networks.)

If you add a TN document type with the Duplicate Checking option set to Use 
Custom Service, the Deployer does not detect the dependency on the service. If the 
service does not already exist on the target Integration Servers, you must add the 
service to the deployment set. If you do not, the Deployer will log an error to the 
deployment report and will not deploy the TN document type.

3 Click Save. The Deployer shows your choices in the left pane under the Trading
Networks folder for the deployment set.
4 If you are not going to add any more items to the deployment set, go to “Resolve 
Dependencies”, below.

Resolve Dependencies
For any project, the Deployer can determine when items that are in a deployment set 
require other items that are not in the deployment set. The items that require other items 
are called dependent items, while the items that are required are called referenced items. The 
Deployer identifies missing referenced items as unresolved dependencies. For example, if 
you add a trigger to an IS & TN deployment set, but do not add the service that is invoked 
by the trigger, the Deployer identifies the service as an unresolved dependency. 

webMethods Deployer User’s Guide Version 7.0 53

 6. Defining an IS & TN Deployment Set

In the project properties (“Set the Default for Dependency Checking” on page 24), you 
indicated how you want to check dependencies in the deployment sets. When the 
Deployer automatically checks dependencies and finds unresolved dependencies in a 
deployment set, it shows   in the Unresolved Dependencies or References column for the 
deployment set; when there are no unresolved dependencies, the Deployer shows   in 
the column. When you can check dependencies manually, the Deployer shows   in the 
Unresolved Dependencies or References column for each deployment set; click Check next to 
the  . If necessary, you can later un‐resolve a dependency you have resolved and re‐
resolve it a different way.

To resolve dependencies:

1 In the Unresolved Dependencies column for the deployment set, click Check. The 
Deployer shows all unresolved dependencies on the Unresolved Dependencies page. 
The Referenced Item column lists the missing referenced items. The next column offers 
the possible ways you can resolve the unresolved dependency. The Project Item column 
shows the dependent items.
2 Tell the Deployer how to resolve each unresolved dependency as described below. If 
you want to resolve all items in a folder the same way, you can set the resolution at the 
folder level rather than at the level of the individual items.

Option Description
Add If the referenced item does not exist on the target servers and you want 
to deploy the referenced item to them, use this option. The Deployer 
adds the referenced item to the deployment set.
Exists If you believe the referenced item already exists on the target servers 
and you want to continue working, but you want the Deployer to make 
sure the item does in fact exist later, use this option. The Deployer will 
check for the referenced item when you map the project to target  
servers. If the Deployer does not find the item, an icon alerts you during 
the mapping task.
If you do not address the problem during the mapping task, the 
Deployer will write a message about the problem to the simulation 
report. If you deploy without addressing the problem, the Deployer will 
not deploy the deployment set.

webMethods Deployer User’s Guide Version 7.0 54

 6. Defining an IS & TN Deployment Set

Option Description
Ignore If you want to bypass dependency checking for the referenced item at 
this time so you can continue working, use this option. You might use 
this option if the referenced item is missing on the source server. Missing 
referenced items are marked with a question mark (?) on the Unresolved
Dependencies page.
Before deploying, make sure either that the referenced item exists on the 
target server or that the referenced item is unnecessary. If the referenced 
item does not exist on the target server, the Deployer might not be able 
to deploy correctly; if it can deploy, the deployed items will not run 
correctly.
The Deployer will list ignored items in the simulation report and in the 
deployment report.

3 Click Save. The Deployer moves dependencies you resolved using the Exists or Ignore 
option to the Resolved Dependencies page.
4 To see the resolved dependencies, click Resolved Dependencies.
You can un‐resolve a resolved dependency and re‐resolve it differently, as follows:
To un‐resolve a dependency you resolved using the Exists option or the Ignore 
option, go to the Resolved Dependencies page, select the check box in the Delete 
column for the resolved dependency, and click Delete.
To un‐resolve a dependency you resolved using the Add option, return to the 
ProjectsprojectDefine page, open the folder that contains the item, navigate to 
the item in the tree in the right pane, cancel the selection of the item by clearing 
the appropriate check box, and save the deployment set.
When you un‐resolve a resolved dependency, the Deployer returns the dependency to 
the Unresolved Dependencies page. Go to that page and re‐resolve the dependency.

Manually Add Dependencies to a Package Component

The Deployer cannot always detect all dependencies. If you are aware that an item has a 
dependency on a package component, and the Deployer has not detected this 
dependency, you can manually add that dependency. For example, when you add Trading 
Networks 6.5 Profile objects to the deployment set, the Deployer does not generate 
dependencies for Profile Groups that are referenced by the Profile objects. You must 
manually add the Profile Groups to the deployment set.
The Deployer will check for the referenced item when you map the project to target 
Integration Servers, as it does when you use the Exists option to resolve an unresolved 
dependency. If the Deployer does not find the item, an icon alerts you during the mapping 
task. If you do not resolve the dependency at that time, the Deployer will write a message 

webMethods Deployer User’s Guide Version 7.0 55

 6. Defining an IS & TN Deployment Set

about it to the simulation report and, if you do not resolve it at that time, to the 
deployment report.

To manually add a dependency on a package component:

1 Go to the Resolved Dependencies page as explained in the previous section.
2 Under the Manually Add Dependency area, in the Referenced Package box, type the name 
of the package that contains the referenced component.
3 In the Referenced Component box, type the name of the referenced component.
4 Click Add. 
You can remove a dependency you added manually. To do so, return to the 
ProjectsprojectDefine page, open the folder that contains the item, navigate to the 
item in the tree in the right pane, cancel the selection of the item by clearing the 
appropriate check box, and save the deployment set.

webMethods Deployer User’s Guide Version 7.0 56

Chapter 7. Defining an MWS Deployment Set

Create the MWS Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Identify the Source My webMethods Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Add My webMethods Server Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Resolve Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

webMethods Deployer User’s Guide Version 7.0 57

 7. Defining an MWS Deployment Set

Create the MWS Deployment Set

To create the MWS deployment set:

1 In the Deployer, go to the Projects page. In the Name column, click the project in which 
to create a MWS deployment set.

2 In the right pane, click   Define.
3 Click Create Deployment Set.
4 In the Type list, click MWS, then complete these fields:  

Box Entry
Name Name to use for the deployment set. The name can be up to 32 
characters long and can include any characters that are valid 
for a file name in your operating system.
Description Description for the deployment set. The description length has 
no limit and can include any characters.
All other items After you choose the source My webMethods Servers, the 
Deployer will display all items on those My webMethods 
Servers. You can use this field to narrow the display. Specify a 
regular expression that specifies the text the item names must 
contain in order to be listed.

5 Click Create.

Identify the Source My webMethods Servers

To identify the source My webMethods Servers:

1 On the Deployer ProjectsprojectDefine page, in the left pane in the Name column, 
click the name of the deployment set for which to identify source My webMethods 
Servers. In the right pane in the Select Source MWS Servers area, the Deployer lists all 
My webMethods Servers you set up to work with the Deployer.  

Note: If a My webMethods Server you want to use as a source does not appear in the 
list, you have not yet set it up to work with the Deployer. For instructions, see 
“Configure for My webMethods Servers” on page 21. 

2 In the Select column, select the check box next to each My webMethods Server that 
contains items to add to the deployment set.
3 Click Save.

webMethods Deployer User’s Guide Version 7.0 58

 7. Defining an MWS Deployment Set

Add My webMethods Server Items

To add My webMethods Server items:

1 In the Deployment Sets area, under the deployment set to which you want to add My 
webMethods Server items, click the MWS folder. In the right pane, the Deployer lists 
the source My webMethods Servers you identified.
2 In the right pane, open the tree to show the items on the My webMethods Servers, 
then select the check box next to each item to add to the deployment set.  

Note: In the Deployer, each My webMethods Server folder is listed twice within its 
directory, as a container preceded by   and as an item preceded by  . If you want to 
add a folder with all the items it contains to the deployment set, select the folder 
where it appears next to the square icon. If you want to add individual items in the 
folder without adding the folder itself, open the folder where it appears as a container 
and click the items to add.

3 Click Save. The Deployer shows your choices in the left pane under the My webMethods
Server folder for the deployment set.

Resolve Dependencies
For any project, the Deployer can determine when items that are in a deployment set 
require other items that are not in the deployment set. The items that require other items 
are called dependent items, while the items that are required are called referenced items. The 
Deployer identifies missing referenced items as unresolved dependencies. For example, if 
you add a page to an MWS deployment set, but do not add the portlets that are referenced 
by that page, the Deployer identifies the portlets as unresolved dependencies.
In the project properties, you indicated whether you want the Deployer to automatically 
check the deployment sets in the project for unresolved dependencies each time you add 
an item to a deployment set, or whether you want to initiate dependency checking for 
deployment sets manually.
If you chose automatic checking, the Deployer automatically checks dependencies each 
time you add an item to a deployment set or go to the ProjectsprojectDefine page. If it 
finds unresolved dependencies, the Deployer shows   in the Unresolved Dependencies 
column for the deployment set. If there are no unresolved dependencies, the Deployer 
shows   in that column.

If you chose manual checking, the Deployer shows   in the Unresolved Dependencies 

column for each deployment set. To have the Deployer check dependencies for a 
deployment set, you must click Check next to the  .

webMethods Deployer User’s Guide Version 7.0 59

 7. Defining an MWS Deployment Set

You must resolve all unresolved dependencies before you can continue to the next task 
(that is, the project build task). If necessary, you can later un‐resolve a dependency you 
have resolved and re‐resolve it a different way.

To resolve dependencies:

1 In the Unresolved Dependencies column for the deployment set, click Check. The 
Deployer shows all unresolved dependencies on the Unresolved Dependencies page. 
The Referenced Item column lists the missing referenced items. The next column offers 
the possible ways you can resolve the unresolved dependency. The Project Item 
column shows the dependent items.
2 Tell the Deployer how to resolve each unresolved dependency as described below. If 
you want to resolve all items in a folder the same way, you can set the resolution at the 
folder level rather than at the level of the individual items.

Option Description
Add If the referenced item does not exist on the target servers and you want 
to deploy the referenced item to them, use this option. The Deployer 
adds the referenced item to the deployment set.
Exists If you believe the referenced item already exists on the target servers 
and you want to continue working, but you want the Deployer to make 
sure the item does in fact exist later, use this option. The Deployer will 
check for the referenced item when you map the project to target servers. 
If the Deployer does not find the item, an icon alerts you during the 
mapping task.
If you do not address the problem during the mapping task, the 
Deployer will write a message about the problem to the simulation 
report. If you deploy without addressing the problem, the Deployer will 
not deploy the deployment set.
Ignore If you want to bypass dependency checking for the referenced item at 
this time so you can continue working, use this option. You might use 
this option if the referenced item is missing on the source server. Missing 
referenced items are marked with a question mark (?) on the Unresolved
Dependencies page.
Before deploying, make sure either that the referenced item exists on the 
target server or that the referenced item is unnecessary. If the referenced 
item does not exist on the target My webMethods Server, the Deployer 
might not be able to deploy correctly; if it can deploy, the deployed items 
will not run correctly.
The Deployer will list ignored items in the simulation report and in the 
deployment report.

webMethods Deployer User’s Guide Version 7.0 60

 7. Defining an MWS Deployment Set

3 Click Save. The Deployer moves dependencies you resolved using the Exists or Ignore 
option to the Resolved Dependencies page.
4 To see the resolved dependencies, click Resolved Dependencies.
You can un‐resolve a resolved dependency and re‐resolve it differently, as follows:
To un‐resolve a dependency you resolved using the Exists option or the Ignore 
option, go to the Resolved Dependencies page, select the check box in the Delete 
column for the resolved dependency, and click Delete.
To un‐resolve a dependency you resolved using the Add option, return to the 
ProjectsprojectDefine page, open the folder that contains the item, navigate to 
the item in the tree in the right pane, cancel the selection of the item by clearing 
the appropriate check box, and save the deployment set.
When you un‐resolve a resolved dependency, the Deployer returns the dependency to 
the Unresolved Dependencies page. Go to that page and re‐resolve the dependency.

webMethods Deployer User’s Guide Version 7.0 61

 7. Defining an MWS Deployment Set

webMethods Deployer User’s Guide Version 7.0 62

Chapter 8. Defining an Optimize Deployment Set

Create the Optimize Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Identify the Source Optimize Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Add Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Resolve Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

webMethods Deployer User’s Guide Version 7.0 63

 8. Defining an Optimize Deployment Set

Create the Optimize Deployment Set

To create the Optimize deployment set:

1 In the Deployer, go to the Projects page. In the Name column, click the project in which 
to create an Optimize deployment set.

2 In the right pane, click   Define.
3 Click Create Deployment Set.
4 In the Type list, click Optimize, then complete these fields:  

Box Entry
Name Name to use for the deployment set. The name can be up to 32 
characters long and can include any characters that are valid 
for a file name in your operating system.
Description Description for the deployment set. The description length has 
no limit and can include any characters.
All other items After you choose the source Optimize servers, the Deployer 
will display all items on those servers. You can use this field to 
narrow the display. Specify a regular expression that specifies 
the text the item names must contain in order to be listed.

5 Click Create.

Identify the Source Optimize Servers

To identify the source Optimize Servers:

1 On the Deployer ProjectsprojectDefine page, in the left pane in the Name column, 
click the name of the deployment set for which to identify source Optimize servers. In 
the right pane in the Select Source Optimize Servers area, the Deployer lists all Optimize 
servers you set up to work with the Deployer.  

Note: If an Optimize server you want to use as a source does not appear in the list, you 
have not yet set it up to work with the Deployer. For instructions, see “Configure for 
Optimize Servers” on page 22. 

2 In the Select column, select the check box next to each Optimize server that contains 
items to add to the deployment set.
3 Click Save.

webMethods Deployer User’s Guide Version 7.0 64

 8. Defining an Optimize Deployment Set

Add Items
To add items:

1 In the Deployment Sets area, under the deployment set to which you want to add 
Optimize items, click the Optimize folder. In the right pane, the Deployer lists the 
source Optimize servers you identified.
2 In the right pane, open the tree to show the items on the Optimize servers, then select 
the check box next to each item to add to the deployment set.
3 Click Save. The Deployer shows your choices in the left pane under the Optimize folder 
for the deployment set.

Resolve Dependencies
For any project, the Deployer can determine when items that are in a deployment set 
require other items that are not in the deployment set. The items that require other items 
are called dependent items, while the items that are required are called referenced items. The 
Deployer identifies missing referenced items as unresolved dependencies. For example, if 
you add a rule to a deployment set, but do not add the dimensions used by that rule, the 
Deployer identifies the dimensions as unresolved dependencies.
In the project properties (“Set the Default for Dependency Checking” on page 24), you 
indicated how you want to check dependencies in the deployment sets. When the 
Deployer automatically checks dependencies and finds unresolved dependencies in a 
deployment set, it shows   in the Unresolved Dependencies or References column for the 
deployment set; when there are no unresolved dependencies, the Deployer shows   in 
the column. When you can check dependencies manually, the Deployer shows   in the 
Unresolved Dependencies or References column for each deployment set; click Check next to 
the  . If necessary, you can later un‐resolve a dependency you have resolved and re‐
resolve it a different way.

To resolve dependencies:

1 In the Unresolved Dependencies column for the deployment set, click Check. The 
Deployer shows all unresolved dependencies on the Unresolved Dependencies page. 
The Referenced Item column lists the missing referenced items. The next column offers 
the possible ways you can resolve the unresolved dependency. The Project Item column 
shows the dependent items.

webMethods Deployer User’s Guide Version 7.0 65

 8. Defining an Optimize Deployment Set

2 Tell the Deployer how to resolve each unresolved dependency as described below. If 
you want to resolve all items in a folder the same way, you can set the resolution at the 
folder level rather than at the level of the individual items.

Option Description
Add If the referenced item does not exist on the target servers and you want 
to deploy the referenced item to them, use this option. The Deployer 
adds the referenced item to the deployment set.
Exists If you believe the referenced item already exists on the target servers 
and you want to continue working, but you want the Deployer to make 
sure the item does in fact exist later, use this option. The Deployer will 
check for the referenced item when you map the project to target  
servers. If the Deployer does not find the item, an icon alerts you during 
the mapping task.
If you do not address the problem during the mapping task, the 
Deployer will write a message about the problem to the simulation 
report. If you deploy without addressing the problem, the Deployer will 
not deploy the deployment set.
Ignore If you want to bypass dependency checking for the referenced item at 
this time so you can continue working, use this option. You might use 
this option if the referenced item is missing on the source server. Missing 
referenced items are marked with a question mark (?) on the Unresolved
Dependencies page.
Before deploying, make sure either that the referenced item exists on the 
target server or that the referenced item is unnecessary. If the referenced 
item does not exist on the target server, the Deployer might not be able 
to deploy correctly; if it can deploy, the deployed items will not run 
correctly.
The Deployer will list ignored items in the simulation report and in the 
deployment report.

3 Click Save. The Deployer moves dependencies you resolved using the Exists or Ignore 
option to the Resolved Dependencies page.
4 To see the resolved dependencies, click Resolved Dependencies.
You can un‐resolve a resolved dependency and re‐resolve it differently, as follows:
To un‐resolve a dependency you resolved using the Exists option or the Ignore 
option, go to the Resolved Dependencies page, select the check box in the Delete 
column for the resolved dependency, and click Delete.
To un‐resolve a dependency you resolved using the Add option, return to the 
ProjectsprojectDefine page, open the folder that contains the item, navigate to 

webMethods Deployer User’s Guide Version 7.0 66

 8. Defining an Optimize Deployment Set

the item in the tree in the right pane, cancel the selection of the item by clearing 
the appropriate check box, and save the deployment set.
When you un‐resolve a resolved dependency, the Deployer returns the dependency to 
the Unresolved Dependencies page. Go to that page and re‐resolve the dependency.

webMethods Deployer User’s Guide Version 7.0 67

 8. Defining an Optimize Deployment Set

webMethods Deployer User’s Guide Version 7.0 68

Chapter 9. Building a Project

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Create a Project Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Rebuild a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Export and Import a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

webMethods Deployer User’s Guide Version 7.0 69

 9. Building a Project

Overview
You can create a project build using the Deployer interface or a script.
If a project build you create becomes out of sync with the current project definition, or if 
the build contains items that you know have changed on the source servers, you can 
rebuild the project build to bring it up to date. You can rebuild a project build using the 
Deployer interface or a script.
If the Deployer in the source environment cannot access the target environment, you must 
use the source environment Deployer to export the project build, then use the target 
environment Deployer to import (and later, map and deploy) the build. You can export 
and import a project build using the Deployer interface or a script.  

Important! If you encounter unresolved dependencies during this step, resolve them using 
the instructions in the “Resolve Dependencies” section in any chapter on defining 
projects.

Create a Project Build

Create a Build Using the Deployer Interface

To create a project build using the Deployer interface:

1 In the Deployer, go to the Projects page. 
2 In the Name column, click the name of the project for which you want to create a build.
3 In the Description box, you can type a description for the deployment map. The 
description can be of any length and can include any characters.

4 Click   Build. The Deployer displays the ProjectsprojectBuild page and lists all 
builds that exist for the selected project.

Note: The Status column on the ProjectsprojectBuild page indicates whether each 
project build is in sync with the current project definition. If the build and the current 
project definition are in sync, the column shows  . If the project definition has 
changed since the build was created, the column shows  . You can rebuild such a 
project if you want. For instructions, see “Rebuild a Build” on page 72.

5 In the left pane, click Create Build.
6 In the Name box accept the default build name or replace it with a name that you 
choose. The name can be up to 32 characters long and can include any characters that 
are valid for a file name in your operating system.

webMethods Deployer User’s Guide Version 7.0 70

 9. Building a Project

7 Click Create. The Deployer creates the build and stores it as a file in the Integration 
Server_directory/packages/WmDeployer/persist/projects/project_name/builds directory.

Important! If the project for which you are trying to create the build contains 
unresolved dependencies, you will receive a message to that effect and the build 
process will fail. For instructions on viewing and resolving unresolved dependencies, 
see the appropriate section in the chapters on defining projects.

8 Under Build Properties in the right pane, click   in the Build Report column to view the 

build report. The build report lists the items that were successfully included in the 
build, describes any errors that occurred during the build process, and informs you if 
the project contains unresolved dependencies.

Create a Build Using a Script

The syntax for the CreateBuild script is as follows:

CreateBuild -h host -p port -u user -x password -r build_name -f project [-d]

Parameter Description
-h host -p port Host name or IP address and port for the Deployer host 
machine.
-u user -x password User name and password to use to log onto the Deployer.
-r build_name Name to use for the build. The name can be up to 32 
characters long and can include any characters that are 
valid for a file name in your operating system.
-f project Name of the project from which to create the build.
[-d] Optional. Tells the Deployer to write debug information to 
standard output. By default, standard output echoes to 
your console.

webMethods Deployer User’s Guide Version 7.0 71

 9. Building a Project

Rebuild a Build
The Status column on the ProjectsprojectBuild page indicates whether each project 
build is in sync with the current project definition. If the build and the current project 
definition are in sync, the column shows  . If the project definition has changed since the 
build was created, the column shows  .
If a project build is out of sync with the current project definition or contains items that 
you know have changed on the source servers, and you want to recreate the build to bring 
it up to date, click   in the Rebuild column for the build.
If you want to rebuild a build using a script, use the CreateBuild script as described in 
“Create a Build Using a Script”, above, and specify the name of the existing build on the ‐
r build_name parameter.

Export and Import a Build

Export and Import a Build Using the Deployer Interface

To export and import a project build from the Deployer interface:

1 Export the build from the source environment as follows: 
a In the Deployer in the source environment, go to the ProjectsprojectBuild page.

b Locate the build to export and click   in the build’s Export column. The Deployer 
creates a file that contains the build. The file is named project_build and is stored in 
the Integration Server_directory\packages\WmDeployer\replicate\outbound 
folder.
2 Move the build into the target environment as follows:
a Copy the project_build file to the Integration Server_directory\packages\ 
WmDeployer\replicate\inbound directory on the machine that hosts the 
Deployer in the target environment.
b In the Deployer in the target environment, go to the ToolsImport Build page.
c In the Project Build list, click the project_build file you just copied to the inbound 
directory.
d Click Import.
3 Use the Deployer in the target environment to map and deploy the build as described 
in the appropriate chapters in this guide.

webMethods Deployer User’s Guide Version 7.0 72

 9. Building a Project

Export and Import a Build Using Scripts

The syntax for the ExportBuild script is as follows:   
ExportBuild -h host -p port -u user -x password -f project
-r build -o {true|false} [-d]

Parameter Description
-h host -p port Host name or IP address and port for the Deployer host 
machine.
-u user -x password User name and password to use to log onto the Deployer.
-f project Name of the project from which the build you are 
exporting was created.
-r build Name of the build to export.
-o {true|false} Indicates whether to overwrite an existing project_build 
file, if there is one.
[-d] Optional. Tells the Deployer to write debug information to 
standard output. By default, standard output echoes to 
your console.

The syntax for the ImportBuild script is as follows:      
ImportBuild -h host -p port -u user -x password -r project_build [-d]

Parameter Description
-h host -p port Host name or IP address and port for the Deployer host 
machine.
-u user -x password User name and password to use to log onto the Deployer.
-r project_build Name of the file to import (project_build).
[-d] Optional. Tells the Deployer to write debug information to 
standard output. By default, standard output echoes to 
your console.

webMethods Deployer User’s Guide Version 7.0 73

 9. Building a Project

webMethods Deployer User’s Guide Version 7.0 74

Chapter 10. Mapping a Project

Map a Project to Target Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Change Configuration Parameters for IS & TN Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . 78

webMethods Deployer User’s Guide Version 7.0 75

 10. Mapping a Project

Map a Project to Target Servers

Important! If you encounter unresolved dependencies during this step, resolve them using 
the instructions in the “Resolve Dependencies” section in any chapter on defining 
projects.

To map a project to target servers:

1 In the Deployer, go to the Projects page.
2 In the Name column, click the name of the project to map.

3 In the right pane, click   Map. The Deployer displays the Projects  project  Map 
page and lists all maps that exist for the selected project.
4 In the left pane, click Create Deployment Map.
5 In the Name box, accept the default deployment map name or replace it with a name 
that you choose. The name can be up to 32 characters long and can include any 
characters that are valid for a file name in your operating system.
6 In the Description box, type a description for the deployment map. The description 
length has no limit and can include any characters.
7 Click Create.
8 Under the Deployment Map Topology area, in the Deployment Set Mapping column for a 
deployment set, click Add Target Server, then do the following:   

For this type of

deployment set... Do this...
Broker Deployer lists all Brokers set up to work with the Deployer. 
Select the check box next to each Broker to which you want to 
deploy the items in the deployment set, then click Add.
IS & TN Deployer lists all remote Integration Servers defined in 
Integration Server Administrator. Select the check box next to 
each Integration Server to which you want to deploy the items 
in the deployment set, then click Add.

Note: If the Integration Servers you want to use as targets do 
not appear in the list, you must define them as remote servers 
to the host Integration Server. For instructions, see the 
webMethods Integration Server Administrator’s Guide. After you 
define a new remote server with the Integration Server 
Administrator, click Refresh this Page on the Deployer to 
update the list of servers.

webMethods Deployer User’s Guide Version 7.0 76

 10. Mapping a Project

For this type of

deployment set... Do this...
ProcessModel Deployer lists all ProcessModel servers you set up to work 
with the Deployer. Select the check box next to each 
ProcessModel server to which you want to deploy the process 
models in the deployment set, then click Add.
MWS Deployer lists all My webMethods Servers you set up to work 
with the Deployer. Select the check box next to each My 
webMethods Server to which you want to deploy the items in 
the deployment set, then click Add.
Optimize Deployer lists all Optimize servers you set up to work with the 
Deployer. Select the check box next to each Optimize server to 
which you want to deploy the items in the deployment set, 
then click Add.

9 When the Deployer returns to the map  Properties page, the Reference Items column in 
the Deployment Map Topology area might show  . This icon indicates that you resolved 
an unresolved dependency using the Exists option, but the Deployer has found that 
the referenced item does not exist on target servers. Click   to see the missing 
referenced item. You can then place the referenced item on the target servers, or you 
can return to the project definition stage and re‐resolve the dependency in a different 
way (see the appropriate section in the chapters on defining projects).

Important! If you do not address the problem at this time, the Deployer will write a 
message about it to the simulation report. If you deploy without addressing the 
problem, the Deployer will not deploy the deployment set.

webMethods Deployer User’s Guide Version 7.0 77

 10. Mapping a Project

Change Configuration Parameters for IS & TN Deployment Set

For an IS & TN deployment set, you can tell the Deployer to change configuration 
parameters for items in the project so the items will run properly on the target Integration 
Servers after deployment.

To change configuration parameters:

1 Under the Deployment Map Topology area for the IS & TN deployment set, click   next 

to an Integration Server you just added as a target. If items in the mapped deployment 
set have configuration parameters, the Deployer displays those items in the left pane. 
You can change the configuration parameters for these items on the target Integration 
Server as follows: 
a In the left pane, click the item whose configuration parameters you want to 
change. The Deployer displays the configuration parameters for the item as it 
exists on the source Integration Server in the top right pane.
b In the bottom right pane, type the configuration parameters to use for the item 
when it is deployed on the target Integration Server.
c Click Save Substitutions.
d Repeat the previous steps for each item on the selected target Integration Server 
whose configuration parameters you want to change.
2 If needed, repeat the previous step for every Integration Server you added as a target 
for the IS & TN deployment set.
3 If needed, repeat the steps from step 8 in the previous section for all IS & TN 
deployment sets in the project.

webMethods Deployer User’s Guide Version 7.0 78

Chapter 11. Deploying a Project

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Deploy Using the Deployer Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Deploy Using a Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Generate a Checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Roll Back the Target Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

webMethods Deployer User’s Guide Version 7.0 79

 11. Deploying a Project

Overview
You can deploy a project using the Deployer interface or using a script.
Before you deploy, you can generate a simulation report that contains information such as 
the following:
Items that will be suspended during deployment

Items that will be enabled after deployment

Changes that will occur on the target servers, such as the items that will be added or 
overwritten, and configuration parameters that will be changed
Messages about problems, such as unresolved dependencies
You set up the checkpoint and rollback features in the project properties (see “Set the 
Default Properties for Deployment” on page 24). If you chose automatic checkpoint or 
rollback, the Deployer automatically generates a checkpoint as the first step when you 
actually deploy the project. If you chose automatic rollback and the deployment fails, the 
Deployer automatically rolls back the target servers to the checkpoint.
If you chose manual checkpoint, you can generate a checkpoint at any time before you  
deploy. If you take multiple checkpoints for a deployment candidate, only the latest is 
retained. If you chose manual rollback, you can roll back the target servers manually at 
any time after a deployment.  

Important! If you encounter unresolved dependencies during this step, resolve them using 
the instructions in the “Resolve Dependencies” section in any chapter on defining 
projects.

webMethods Deployer User’s Guide Version 7.0 80

 11. Deploying a Project

Deploy Using the Deployer Interface

To deploy using the Deployer interface:

1 If you chose to suspend triggers, ports, and scheduled tasks, but a service is triggered 
by one of these items before the Deployer suspends them, and the service is a long‐
running service, the Deployer might overwrite the service during deployment. Make 
sure long‐running services have completed.
2 In the Deployer, go to the Projects page. In the Name column, click the name of the 
project you want to deploy.

3 In the right pane, click   Deploy. The Deployer displays the ProjectsprojectDeploy 
page and lists all deployment candidates that exist for the selected project.
4 In the left pane, click Create Deployment Candidate.
5 In the Name box, accept the default deployment candidate name or replace it with a 
name that you choose. The name can be up to 32 characters long and can include any 
characters that are valid for a file name in your operating system.
In the Description box, type a description for the deployment set. The description 
length has no limit and can include any characters.
6 In the Project Build list, click the project build to deploy.
7 In the Deployment Map list, click the deployment map that identifies the target servers 
to which to deploy the items in the selected project build.  

Important! If the words Missing referenced items appears next to the map name in the list, 

it means that you resolved an unresolved dependency using the Exists option, but the 
Deployer found during the mapping task that the referenced item in fact does not 
exist on the target server. You can place the referenced item on the target servers, or 
you can return to the project definition stage and re‐resolve the dependency in a 
different way (see the appropriate section in the chapters on defining projects).

If you do not address the problem during the mapping task, the Deployer will write a 
message about the problem to the simulation report. If you deploy without 
addressing the problem, the Deployer will not deploy the deployment set.

8 Click Create. In the candidate list in the left pane, if the selected build and the current 
project definition are in sync, the Status column shows  . If the project definition has 
changed since the build was created, the column shows  . You can rebuild the 
project build before proceeding. For instructions, see “Rebuild a Build” on page 72.

9 If you want to simulate the deployment, in the Deployment Candidates list, click    in 

the Simulate column. The simulation report appears in the right pane in the Deployment

webMethods Deployer User’s Guide Version 7.0 81

 11. Deploying a Project

History area. Click   next to Simulation in the Report Type column to display the report.  

Read the report and address all problems.  

Important! If you do not address all problems at this time, you will probably experience 
errors during the deployment.

10 To deploy the project, click   in the Deploy column for the deployment candidate. 
The Deployer does the following:
If you chose automatic checkpointing or automatic rollback in the project 
properties, automatically generates a checkpoint at this time.
Deploys the items in the selected project build to the target servers you identified 
in the selected deployment map.
Creates a deployment report and lists the report in the Deployment History area. 
Click   next to Deployment Report in the Report Type column to display the report. 
The report contains similar information to the simulation report, except that the 
events have actually occurred at this point. 

Deploy Using a Script

The syntax for the Deploy script varies based on whether you are creating a new 
deployment candidate and deploying it or deploying an existing deployment candidate.
If you are creating a new deployment candidate and deploying it, the syntax for the 
Deploy script is as follows:    
Deploy -h host -p port -u user -x password -r project
-n new_candidate_name -s new_candidate_description -b build -m map
-l {true|false} [-d]

Parameter Description
-h host -p port Host name or IP address and port for the 
Deployer host machine.
-u user -x password User name and password to use to log onto the 
Deployer.
-r project Name of the project from which the build you are 
deploying was created.
-n new_candidate_name Name to use for a new deployment candidate. 
The name can be up to 32 characters long and can 
include any characters that are valid for a file 
name in your operating system.

webMethods Deployer User’s Guide Version 7.0 82

 11. Deploying a Project

Parameter Description
-s new_candidate_description Brief description of the new deployment 
candidate. The description length has no limit 
and can include any characters that are valid for a 
file name in your operating system.
-b build Name of the project build to deploy.
-m map Name of the deployment map that identifies the 
target servers to which to deploy the items in the 
selected project build.
-l {true|false} Tells the Deployer to either generate the 
simulation report (true) or to deploy the 
deployment candidate (false).
[-d] Optional. Tells the Deployer to write debug 
information to standard output. By default, 
standard output echoes to your console.

If you are deploying an existing deployment candidate, the syntax for the Deploy script is 
as follows:     
Deploy -h host -p port -u user -x password -e candidate -r project
-l {true|false} [-d]

Parameter Description
-h host -p port Host name or IP address and port for the 
Deployer host machine.
-u user -x password User name and password to use to log onto the 
Deployer.
-e candidate Name of an existing deployment candidate to 
deploy.
-r project Name of the project from which the build you are 
deploying was created.
-l {true|false} Tells the Deployer to either generate the 
simulation report (true) or to deploy the 
deployment candidate (false).
[-d] Optional. Tells the Deployer to write debug 
information to standard output. By default, 
standard output echoes to your console.

webMethods Deployer User’s Guide Version 7.0 83

 11. Deploying a Project

Generate a Checkpoint
The target servers must be available for the checkpoint generation to be successful. 
To generate a checkpoint:

In the Deployment Candidates list, click   in the Checkpoint column. The checkpoint report 

appears in the right pane in the Deployment History area.

Click   next to Checkpoint in the Report Type column to display the report. In the 

checkpoint report, the term EXTRACT is used for assets that exist on the target system and 
have been extracted to a backup. The term MISSING is used for assets that do not exist on 
the target system and will be deleted during a rollback.

Roll Back the Target Servers

To roll back the target servers:

In the Deployment Candidates list, click   in the Rollback column. The rollback report 

appears in the right pane in the Deployment History area.

Click   next to Rollback in the Report Type column to display the report.   

Note: If you roll back an IS&TN deployment set, and the Activate After Deployment option for 

a package was set to Inbound Only, the report will include a warning that the package is 
already not present on the target Integration Servers. You can ignore this warning.

webMethods Deployer User’s Guide Version 7.0 84

Chapter 12. Deploying to Clustered 6.5 Integration Servers

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Configure Cluster Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Deploy Scheduled Tasks in a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

webMethods Deployer User’s Guide Version 7.0 85

 12. Deploying to Clustered 6.5 Integration Servers

Overview
The Deployer can deploy to clustered 6.5 Integration Servers. The Deployer can deploy all 
Integration Server items in a clustered environment except existing scheduled tasks (see 
“Deploy Scheduled Tasks in a Cluster”). For complete information on Integration Server 
clustering, see the webMethods Integration Server Clustering Guide.

Manual Cluster Deployment or Automatic Cluster Support

In the default project properties for deployment (“Set the Default Properties for 
Deployment” on page 24), you chose the method to use to deploy Integration Server items 
to clustered Integration Servers.
If you chose manual cluster deployment, you chose to deploy the items to each Integration 
Server in the cluster yourself.
If you chose automatic cluster support, you chose to deploy the items to one Integration 
Server in the cluster, called the primary node, and have that Integration Server 
automatically propagate the deployment to the other Integration Servers in the cluster. If 
you chose automatic cluster support, you must configure cluster synchronization as 
described in “Configure Cluster Synchronization” on page 87.  

Note: When you checkpoint a cluster, the assets are checkpointed from the primary node.

Deploying to Clustered Trading Networks Servers

The Trading Networks items you can deploy using the Deployer are all database objects. 
Trading Networks Servers on clustered Integration Servers typically point to the same 
Trading Networks database component.
If you are using automatic cluster support, the Deployer deploys the items to the primary 
node, and all the Trading Networks Servers on the clustered Integration Servers access the 
deployed database objects in the shared Trading Networks database component.
If you are using manual cluster deployment, you must deploy to only one Integration 
Server in the cluster. All the Trading Networks Servers on the clustered Integration 
Servers will access the deployed database objects in the shared Trading Networks 
database component.  

Important! Do not deploy to multiple Integration Servers in the cluster. The Trading 
Networks database component would be updated multiple times, and you might 
experience unexpected results. 

webMethods Deployer User’s Guide Version 7.0 86

 12. Deploying to Clustered 6.5 Integration Servers

Deploying to Clustered ProcessModel Servers

Process models consist of Integration Server items and database objects. Clustered 
Integration Servers that host a Process Engine (that is, ProcessModel servers) typically 
point to the same Process Audit Log database component.
If you are using automatic cluster support, the Deployer deploys the Integration Server 
items and database objects to the primary node. The primary node propagates the 
deployed Integration Server items to the other nodes in the cluster, and all the 
ProcessModels in the cluster access the database objects in the shared Process Audit Log 
database component.
If you are using manual cluster deployment, you must deploy to every ProcessModel 
server in the cluster, because each server must receive the Integration Server items. The 
Process Audit Log database component will be updated multiple times, but this will not 
cause a problem.

Configure Cluster Synchronization

To configure cluster synchronization:

1 In the Integration Server Administrator for the Integration Server you want to use as 
the primary node, do the following:
a Specify a remote server alias for every Integration Server, or node, in the cluster, 
including the primary node.
b On the watt.server.cluster.aliasList property, list the remote server alias 
name of every node in the cluster, including the primary node. Separate the alias 
names using a comma.
For detailed instructions, see the webMethods Integration Server Administrator’s Guide.   

Important! Integration Server uses this list when executing the remote invokes that 
update the other cluster nodes. If you do not include a cluster node on this list, the 
Deployer will not propagate the deployment to that node.

2 Install the WmDeployerResource package to the primary node only. For instructions, 
see “Configure for Integration Servers” on page 21.
3 Map projects for the cluster to the primary cluster node only. For instructions, see 
Chapter 10, “Mapping a Project”.  

Important! Do not map to any other nodes in the cluster, or the project will be deployed 
multiple times.

webMethods Deployer User’s Guide Version 7.0 87

 12. Deploying to Clustered 6.5 Integration Servers

Deploy Scheduled Tasks in a Cluster

The Deployer can deploy new (that is, can add) scheduled tasks to clustered Integration 
Servers. It cannot deploy existing (that is, cannot update) scheduled tasks.
You cannot use cluster synchronization for scheduled tasks; you must deploy to each 
Integration Server in the cluster.
The Deployer always activates scheduled tasks you deploy to clustered Integration 
Servers after deployment, regardless of the setting of the Activate After Deployment option in 
the project properties.

To deploy scheduled services to a cluster:

1 Create a separate project that contains the scheduled tasks to deploy.
2 Define every Integration Server in the cluster as a remote server. For instructions, see 
the webMethods Integration Server Administrator’s Guide.
3 Map the project to every Integration Server in the cluster.
4 Checkpoint, deploy, and, if necessary, roll back the project as you would normally do 
in an unclustered environment.

webMethods Deployer User’s Guide Version 7.0 88