Вы находитесь на странице: 1из 100

Title Page

webMethods Deployer
User’s Guide

Version 7.1.1

February 2008

webMethods
Copyright
&  Docu‐
ment ID

This document applies to webMethods Deployer Version 7.1.1  and to all subsequent releases. 
Specifications contained herein are subject to change and these changes will be reported in subsequent release notes or new editions.
© Copyright Software AG 2008.
All rights reserved.
The name Software AG and/or all Software AG product names are either trademarks or registered trademarks of Software AG. Other 
company and product names mentioned herein may be trademarks of their respective owners.
Document ID: DEP-UG-711-20080229
Table of Contents

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


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

1. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
webMethods Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Deployment Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Create the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Define the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Build the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Map a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Deploy the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Checkpoint and Roll Back . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Access to Target Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Deployer Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Part I. Using the Deployer Graphical User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

2. Starting and Configuring Communication with Deployer . . . . . . . . . . . . . . . . . . . . . . . 19


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Starting Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Configuring Communication with Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Configuring Communication with ProcessModel Servers . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Configuring Communication with Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Configuring Communication with My webMethods Servers . . . . . . . . . . . . . . . . . . . . . . . . 23
Configuring Communication with Optimize Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Configuring Target Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

3. Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Setting Default Properties for Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Setting the Default for Dependency Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Setting the Default Properties for Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Setting Default Properties for Integration Server and Trading Networks Projects . . . . 27
Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Authorizing Groups to Perform Tasks on a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Adding and Viewing Instructions or Notes About a Project . . . . . . . . . . . . . . . . . . . . . . . . . 31

webMethods Deployer User’s Guide Version 7.1.1 3


Table of Contents

4. Defining a Broker, ProcessModel, MWS, or Optimize Deployment Set . . . . . . . . . . . . 33


Creating the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Identifying the Source Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Adding Assets to the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Resolving Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Removing Process Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

5. Defining an IS & TN Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39


Creating the IS & TN Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Identifying Source Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Adding Integration Server Administration Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Adding Integration Server Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Adding an Entire Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Adding Package Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Adding Package Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Setting the Package Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Adding webMethods Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Adding Trading Networks Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Resolving Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Manually Adding Dependencies to a Package Component . . . . . . . . . . . . . . . . . . . . . . . . . 51

6. Building, Mapping, and Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53


Building a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Create a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Rebuilding a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Exporting and Importing a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Mapping a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Mapping a Project to Target Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Exporting and Importing a Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Substituting Configuration Values for Integration Server Assets . . . . . . . . . . . . . . . . . 58
Exporting and Importing Substitute Configuration Values . . . . . . . . . . . . . . . . . . . . . . 59
Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Generating a Checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Simulating Deployment of or Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Rolling Back the Target Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

7. Deploying to Clustered Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Manual Cluster Deployment or Automatic Cluster Support . . . . . . . . . . . . . . . . . . . . . 66
Deploying to Clustered Trading Networks Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Deploying to Clustered ProcessModel Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Configuring Cluster Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Deploying Scheduled Tasks in a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

4 webMethods Deployer User’s Guide Version 7.1.1


Table of Contents

Part II. Using the Deployer Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

8. Scripts, Configuration Files, and Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71


Creating and Running Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Specifying Log On Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Creating a Configuration File for Log On Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 76
Error Handling and Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

9. General and Project Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79


Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Listing Builds, Maps, or Deployment Candidates for a Project . . . . . . . . . . . . . . . . . . . . . . 80
Displaying Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Exporting Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Importing Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Deleting a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

10. Build Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83


Creating a Project Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Listing the Builds for a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Displaying the Contents of a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Displaying the Substitute Configuration Values for Integration Server Assets in a Build . . 85
Displaying the Contents of a Build File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Displaying the Substitute Configuration Values for Integration Server Assets in a Build File 86
Exporting a Build from a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Importing a Build into a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Listing Build Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Displaying a Build Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

11. Map Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89


Command Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Listing All Deployment Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Exporting a Deployment Map from a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Editing a Deployment Map or Substitute Configuration Values . . . . . . . . . . . . . . . . . . . . . . 90
Importing a Deployment Map Into a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Exporting Substitute Configuration Values for Integration Server Assets from a
Deployment Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Importing Substitute Configuration Variables for Integration Server Assets into a
Deployment Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Deleting a Deployment Map from a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

12. Deployment Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95


Command Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Creating a Deployment Candidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Displaying Information About a Deployment Candidate . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Deleting a Deployment Candidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

webMethods Deployer User’s Guide Version 7.1.1 5


Table of Contents

Generating a Checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Simulating a Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Deploying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Rolling Back Target Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Listing Simulation, Rollback, and Deployment Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Displaying a Simulation, Rollback, or Deployment Report . . . . . . . . . . . . . . . . . . . . . . . . . . 99

6 webMethods Deployer User’s Guide Version 7.1.1


About This Guide

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

Product Versions
Blaze Advisor 6.5.x
webMethods Broker 7.1.x
webMethods Designer 7.1.x
webMethods Integration Server 7.1.x
My webMethods Server 7.1.x
webMethods Optimize 7.1.x
webMethods Trading Networks 7.1.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.1.1 7


About This Guide

Additional Information
The webMethods Advantage Web site at http://advantage.webmethods.com provides 
you with important sources of information about webMethods products:
„ Troubleshooting Information. The webMethods Knowledge Base provides 
troubleshooting information for many webMethods products. 
„ Documentation Feedback. To provide feedback on webMethods documentation, go to 
the Documentation Feedback Form on the webMethods Bookshelf.
„ Additional Documentation. Starting with 7.0, you have the option of downloading the 
documentation during product installation to a single directory called 
“_documentation,” located by default under the webMethods installation directory. 
In addition, you can find documentation for all webMethods products on the 
webMethods Bookshelf.

8 webMethods Deployer User’s Guide Version 7.1.1


1 Concepts

„ webMethods Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
„ Deployment Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
„ Access to Target Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
„ Deployer Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
„ Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

webMethods Deployer User’s Guide Version 7.1.1 9


1 Concepts

webMethods Deployer
webMethods Deployer is a tool you use to deploy assets that reside on source 
webMethods servers to target webMethods servers. For example, you might want to 
deploy assets you have developed on servers in a development environment to servers in 
a test or production environment.

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 Create a project build.
4 Map the contents of the project build to target servers.
5 Deploy the project to the target servers.

Create the Project


A deployment project identifies the assets 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, 
and then you authorize users to perform the project tasks (that is, defining, building, 
mapping, and deploying the project).
When you create a project, 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 
users who will test the deployed solution.

Define the Project


When you define a project, you create project deployment sets. Each deployment set 
identifies assets from one type of source servers (for example, My webMethods Servers) 
that you want to deploy as a set to target servers of the same type. You can define these 
types of deployment sets within a single project:

10 webMethods Deployer User’s Guide Version 7.1.1


1 Concepts

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.

IS & TN „ Integration Server administrative assets such as ports, users, 
groups, and user‐created scheduled tasks, packages, and Web 
Service Descriptors.
„ Integration Server packages.
„ Trading Networks assets such as processing rules, document 
types, trading partner agreements, and partner profiles and 
security data from multiple source Integration Servers.
„ Blaze Advisor rules
„ Files from multiple webMethods installations on machines that 
host an Integration Server.
MWS User‐created assets such as pages, portlets, CAF and task 
applications, rules, users, groups, roles, and directory services from 
multiple My webMethods Servers.
Optimize Process configuration such as process and step timeouts and process 
extensions, and other analysis KPI metadata from multiple 
Optimize servers.

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

project
deployment set target servers

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

webMethods Deployer User’s Guide Version 7.1.1 11


1 Concepts

project
deployment sets target servers

As you define a deployment set, Deployer determines when assets that are in a 
deployment set require other assets that are not in the deployment set. Deployer 
identifies these missing assets 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, 
Deployer identifies the missing service as an unresolved dependency. Deployer gives you 
several options for resolving unresolved dependencies.

Build the Project


You build a project to create a file that contains the actual assets referenced in the project. 
If you later change the project, or if the build contains assets that you know have changed 
on the source servers, you can re‐create the build to bring it up to date.

Map a Project
In a deployment map, you identify target servers for each deployment set in a project. If 
you add or delete deployment sets from a project, and then re‐create the build to reflect 
the changes, you would update the map as well. You can create multiple deployment 
maps for each project build (for example, if you are deploying to multiple environments).
If you find that you repeatedly have to map deployment sets to the same set of target 
servers, you can reduce your effort by grouping the target servers into a target group. You 
can then map the deployment sets to the target group rather than to the individual target 
servers.
As part of the deployment map for an IS & TN deployment set, you can specify 
configuration values for Integration Server assets that you want Deployer to substitute 
during deployment so the assets will run properly on target servers. Suppose an 
Integration Server in a development environment has a file polling port that is 
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. In the deployment map, you would specify a substitute configuration 
value of /tmp directory for the port. You can substitute different configuration values for 

12 webMethods Deployer User’s Guide Version 7.1.1


1 Concepts

scheduled tasks, ports, adapter connections, adapter notifications, and extended settings. 
You can substitute different configuration values for different target servers.

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 can address problems and re‐generate the simulation reports until all problems are 
resolved.
When you are ready, you deploy the project. Deployer copies the contents of each 
deployment set in the specified project build to the target servers identified in the 
specified deployment map. Deployer creates a deployment report that lists all actions that 
occurred during deployment.
For an IS & TN deployment set, if you specified substitute configuration values for 
certain deployed Integration Server assets on target servers, Deployer changes those 
values during deployment.

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 assets are not working as expected, you can 
use Deployer’s roll back feature to undo the deployment.
To use the roll back feature, you must create a checkpoint to which you want to roll back 
the target servers before you deploy a deployment candidate. A checkpoint contains a 
copy of the assets on the target servers that will be replaced by the assets in the 
deployment candidate. The roll back feature rolls back the target servers to the 
checkpoint. If the deployment candidate added assets to the target servers, the roll back 
removes them.
You can choose automatic or manual checkpoint, roll back, or both. If you choose 
automatic checkpoint or roll back, Deployer automatically generates a checkpoint as the 
first step when you actually deploy a project. If you choose automatic roll back and the 
deployment fails, 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 roll back, you can roll back the target servers manually 
any time after a deployment.

webMethods Deployer User’s Guide Version 7.1.1 13


1 Concepts

Access to Target Environments


You might want to deploy from one environment to another, but the Deployer in your 
source environment might not be able to access the target environment. In such cases, 
you can export the build you want to deploy from the Deployer in the source 
environment and import the build into the Deployer in the target environment. The 
Deployer in the target environment automatically creates the deployment project and 
deployment sets from the imported build.
You can then map the imported build, or you can export a deployment map for the build 
from the Deployer in the source environmenet and import it into the target project.
Before you import a map, you can edit any of the attributes (for example, you could map 
a deployment set to a different target server).

Deployer Interfaces
Deployer offers a graphical user interface and a command line interface. You can enter 
commands at a command prompt or you can create scripts that execute commands 
automatically.
The table below shows which tasks you can perform from each type of Deployer 
interface.   
Command
Task GUI Line
Configure communication between Deployer and the source and 
target servers
Create or delete projects, set default properties for projects, 
authorize groups to work on projects, add and view instructions or 
notes about projects
Export project properties

Import project properties

Define deployment sets

Map deployment sets to target servers

List, display, export, import, and delete maps

Create project builds

List, export, and import builds; display build contents; list and 
display build reports

14 webMethods Deployer User’s Guide Version 7.1.1


1 Concepts

Command
Task GUI Line
List, create, display, or delete deployment candidates;  simulate 
deployments; deploy; list and display simulation and deployment 
reports
Generate a checkpoint or roll back target servers, list and display 
rollback reports

Logging
Deployer writes log entries to the Integration Server server log. The server log contains 
information about operations and errors that occur on Integration Server, such as the 
starting of Integration Server subsystems and the loading of Integration Server packages 
such as Deployer. You control server logging using the Integration Server Administrator; 
you can activate or deactivate logging and specify the amount of detail to write to the log. 
For instructions, see the webMethods Logging Guide.
Deployer logs errors that occur during command line operations in the Deployer 
command line log file. For more information about the log file, see the “Error Handling 
and Logging” on page 77.

webMethods Deployer User’s Guide Version 7.1.1 15


1 Concepts

16 webMethods Deployer User’s Guide Version 7.1.1


I Using the Deployer Graphical User Interface

„ Starting and Configuring Communication with Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19


„ Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
„ Defining a Broker, ProcessModel, MWS, or Optimize Deployment Set . . . . . . . . . . . . . . . . . . . . 33
„ Defining an IS & TN Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
„ Building, Mapping, and Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
„ Deploying to Clustered Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Full Book Title Version x.x 17


I Using the Deployer Graphical User Interface

18 Full Book Title Version x.x


2 Starting and Configuring Communication with
Deployer

„ Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
„ Starting Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
„ Configuring Communication with Brokers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
„ Configuring Communication with ProcessModel Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
„ Configuring Communication with Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
„ Configuring Communication with My webMethods Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
„ Configuring Communication with Optimize Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
„ Configuring Target Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

webMethods Deployer User’s Guide Version 7.1.1 19


2 Starting and Configuring Communication with Deployer

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

Servers Communications Component


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

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

Deployer and Integration Server Administrator use the same log on user name and 
password. If you just installed Deployer with a new Integration Server, the defaults are 
user name Administrator and password manage.

Configuring Communication with Brokers


Important! Deployer cannot use SSL to connect to Brokers. 

To configure communication with source and target Brokers:

1 In Deployer, go to the Servers Broker page. For every source and target Broker, click 
Configure Broker Server and 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.

20 webMethods Deployer User’s Guide Version 7.1.1


2 Starting and Configuring Communication with Deployer

Box Entry
Client Group Client group to use to access the Broker. For target Brokers, type 
admin.

Broker Name Name of the Broker.

2 Click Configure. To test the connection, click  .

Configuring Communication with ProcessModel Servers

To configure communication with ProcessModel servers:

1 In Deployer, go to the Servers ProcessModel page. For every source and target 
ProcessModel server, click Configure ProcessModel Server and 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.
Password Password that is associated with the user name.
Use SSL Whether to encrypt communication between Deployer and the server. 
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. 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 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 Packages Management page and click   for the WmDesigner package.
c Click Add Logical Server and complete these fields:

webMethods Deployer User’s Guide Version 7.1.1 21


2 Starting and Configuring Communication with Deployer

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 to deploy.
3 Install the WmDeployerResource package on each ProcessModel server that will run 
process steps. In Deployer, go to the Servers IS & 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 to deploy includes a task, go to the Packages Management 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.

Configuring Communication with Integration Servers

To configure communication with source and target Integration Servers:

1 Open the Integration Server Administrator for the Integration Server that hosts 
Deployer and define the following as remote servers:
„ All source Integration Servers
„ All target Integration Servers
„ The Integration Server that hosts 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 Deployer, go 
to the Servers IS & 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.

22 webMethods Deployer User’s Guide Version 7.1.1


2 Starting and Configuring Communication with Deployer

Configuring Communication with My webMethods Servers

To configure communication with My webMethods Servers:

1 In Deployer, go to the Servers MWS page. For every source and target My 
webMethods Server, click Configure MWS Server and 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.
Password Password that is associated with the user name.
Cache Timeout Length of time queries should remain in the cache unless the 
cache capacity is exceeded.
Include security When resolving dependencies for an asset, whether to include 
dependencies security realms that contain that asset, as well as  
user/group/role references in the assetʹs security ACLs.
Root folder My webMethods Server aliases to use as root folders when 
aliases selecting pages to deploy. Separate the folders using commas.
Maximum folder Maximum number of assets to display within My webMethods 
object count Server folders when you are defining and choosing assets to 
include in an MWS deployment set.
Enable additional Whether to log debug information about selected assets to 
MWS logging source My webMethods Server logs, and assets that 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 assets to include in 
an MWS deployment set.
Use SSL Whether to encrypt the communication between Deployer and 
the server. You can only use SSL if 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.

2 Click Configure. To test the connection, click  .

webMethods Deployer User’s Guide Version 7.1.1 23


2 Starting and Configuring Communication with Deployer

Configuring Communication with Optimize Servers

To configure communication with Optimize servers:

1 In Deployer, go to the Servers Optimize 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.
Use SSL Whether to encrypt the communication between Deployer and the 
Optimize server. 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.

2 Click Configure. To test the connection, click  .

Configuring Target Groups

To configure a target group:

1 In Deployer, go to the Target Group server page.


2 Click Configure server Target Groups.
3 In the Name box, type the name to use for the target group. 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 In the Description box, type a description for the target group. The description length 
has no limit and can include any characters. 
5 Click Configure.
6 In the Available Servers list, select the servers to add to the target group, and then click 
Add.
7 Click Save.
8 To test the connection between Deployer and the target group, click  .

24 webMethods Deployer User’s Guide Version 7.1.1


3 Creating a Project

„ Setting Default Properties for Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26


„ Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
„ Authorizing Groups to Perform Tasks on a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
„ Adding and Viewing Instructions or Notes About a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

webMethods Deployer User’s Guide Version 7.1.1 25


3 Creating a Project

Setting Default Properties for Projects


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 in the Deployer menu. When you are done, click Save.

Setting the Default for Dependency Checking


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

Option Description
Automatic Tells Deployer to automatically check dependencies regularly as you 
modify the project and progress through the different phases of 
deployment.
Reduced Tells 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.

Setting 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 you or automatically by Deployer.

Option Entry
Checkpoint To have Deployer automatically create a checkpoint for a deployment 
Creation candidate before it is deployed, click Automatic. If you only want to 
generate checkpoints when you choose to (see “Generating a 
Checkpoint” on page 60), click Manual.
Roll back To have Deployer automatically roll back a deployment candidate after a 
on Error failed deployment, click Automatic. If you only want to roll back the 
project when you choose to (see “Rolling Back the Target Servers” on 
page 62), click Manual.
Cluster To deploy to each clustered Integration Server yourself, click Manual.
Support
To deploy to a single Integration Server 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 7, “Deploying to Clustered 
Integration Servers”.

26 webMethods Deployer User’s Guide Version 7.1.1


3 Creating a Project

Setting Default Properties for Integration Server and Trading


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

To set default properties for Integration Server and Trading Networks projects:

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


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

Asset 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, 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.

Do not suspend triggers. None
This option is obsolete. Selected
Ports Whether to disable ports on the target Integration Servers that 
match ports you are trying to deploy.
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 choose the notifications when you set package 
properties. For instructions, see “Setting the Package 
Properties” on page 45.

webMethods Deployer User’s Guide Version 7.1.1 27


3 Creating a Project

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

For this option... Indicate whether 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-Package Overwrite existing assets. This option applies to all assets 
Items except 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 “Setting the Package 
Properties” on page 45.

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

3 Under Activate After Deployment, indicate whether 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, Deployer will 
display a message to that effect and will not activate the port.

4 Click Save.

28 webMethods Deployer User’s Guide Version 7.1.1


3 Creating a Project

Creating 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‐hand pane and override any if 
necessary, then click Save.
For explanations of the Dependency Checking Options, General Deployment Options, and IS
& TN Deployment Options properties, see “Setting Default Properties for Projects” on 
page 26.
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 Deployer should include 
the values for dimensions you add to deployment sets (for example, Customer 
Names or Product Types).
If the project is for process models, you can set the properties below for the project 
under the ProcessModel Deployment Options area. For more information about process 
models, see the webMethods Monitor User’s Guide.

webMethods Deployer User’s Guide Version 7.1.1 29


3 Creating a Project

For this property... Indicate whether Deployer should...


Enable process for Enable webMethods‐executed business process versions for 
execution execution after deployment. When a process version is enabled, 
the Process Engine uses the enabled version when starting new 
process instances. When a process is disabled, the Process 
Engine does not use the process version for new process 
instances.
Only one version of a process can be enabled at a time. If there 
are no enabled process versions, the Process Engine will not 
start any process instances of the process.
Enable process for Enable webMethods‐executed processes for analysis. When a 
analysis process is enabled, the Process Engine forwards all process 
instance activity to the Optimize Analytic Engines. When a 
process 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 property... Indicate whether Deployer should...


Export Deploy subscriptions for My webMethods Server assets you are 
Subscriptions deploying.
Export Access Deploy ACLs for My webMethods Server assets you are 
Control Lists deploying.
Export Principal Include attributes contained in attributes providers when 
Attributes exporting users, groups, and roles.
Export Content As Export a reference to the page content without deploying the 
Reference content.
Alias Prefix Apply the specified prefix to every automatically generated My 
webMethods Server alias.
Export Version Include all versions of an asset in Portal version control. This 
History applies to the content within a page or folder.
Auto Generate Automatically generate an alias on the target My webMethods 
Aliases Server for every My webMethods Server asset that is deployed. 
If an asset 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.

30 webMethods Deployer User’s Guide Version 7.1.1


3 Creating a Project

Authorizing 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 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 Deployer, go to the Projects page.
3 Locate the project to which to authorize users. In the Authorize column for the project, 
click  .
4 In the Select Authorization list, click a task to which to authorize users.
5 The Not Specified box lists all groups defined on the local Integration Server. Using the 
arrow buttons, move each group 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).

Adding and Viewing Instructions or Notes About a Project


When you create a project, 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.1.1 31


3 Creating a Project

32 webMethods Deployer User’s Guide Version 7.1.1


4 Defining a Broker, ProcessModel, MWS, or Optimize
Deployment Set

„ Creating the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34


„ Identifying the Source Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
„ Adding Assets to the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
„ Resolving Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
„ Removing Process Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

webMethods Deployer User’s Guide Version 7.1.1 33


4 Defining a Broker, ProcessModel, MWS, or Optimize Deployment Set

Creating the Deployment Set

To create the deployment set:

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

2 In the right‐hand pane, click   Define.
3 Click Create Deployment Set.
4 In the Type list, click Broker, MWS, ProcessModel, or Optimize, and 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 After you choose the source servers, Deployer will display all assets 
items on those servers. You can use this field to narrow the display. 
Specify a regular expression that specifies the text that the asset 
names must contain in order to be listed.
Packages For a ProcessModel or Optimize deployment set, after you choose 
the source servers, Deployer will display all packages on the 
servers. You can use this field to narrow the display. Type a regular 
expression that specifies the text that the package names must 
contain in order to be listed.

5 Click Create.

34 webMethods Deployer User’s Guide Version 7.1.1


4 Defining a Broker, ProcessModel, MWS, or Optimize Deployment Set

Identifying the Source Servers

To identify the source servers:

1 On Deployer Projects project Define page, in the left‐hand pane in the Name column, 


click the name of the deployment set for which to identify source servers. In the right‐
hand pane in the Select Source type Servers area, Deployer lists all servers of the 
appropriate type (for example, ProcessModel servers for a ProcessModel deployment 
set) that you set up to work with Deployer.

Note: If a server you want to use as a source does not appear in the list, you have 
not yet set it up to work with Deployer. For instructions, see Chapter 2, “Starting 
and Configuring Communication with Deployer”.

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

Adding Assets to the Deployment Set

To add assets to the deployment set:

1 In the Deployment Sets area, under the deployment set to which to add assets, click the 
Broker, ProcessModel, MWS, or Optimize folder. In the right‐hand pane, Deployer lists the 
source servers of the type you selected.
2 In the right‐hand pane, open the tree to show the assets on the source servers, then 
select the check box next to each asset to add to the deployment set. Keep in mind the 
following:

For... Note
Broker Do not add any client groups with a queue type of persistent 
and a lifecycle set to explicit destroy. Deployer cannot deploy 
such client groups.
ProcessModel The process models displayed are those that were  ʺBuilt for 
executionʺ on the Integration Server.
MWS The My webMethods Server folder is listed twice within its 
directory, as a container preceded by   and as an asset 
preceded by  . If you want to add a folder with all the assets it 
contains to the deployment set, select the folder where it 
appears next to the square icon. If you want to add individual 
assets in the folder without adding the folder itself, open the 
folder where it appears as a container and click the assets to add.

webMethods Deployer User’s Guide Version 7.1.1 35


4 Defining a Broker, ProcessModel, MWS, or Optimize Deployment Set

3  Click Save. Deployer shows your choices in the left‐hand pane under the Broker,
ProcessModel, MWS, or Optimize folder for the deployment set.

Resolving Dependencies
For any project, Deployer can determine when assets that are in a deployment set require 
other assets that are not in the deployment set. The assets that require other assets are 
called dependent assets, while the assets that are required are called referenced assets. 
Deployer identifies missing referenced assets as unresolved dependencies.  
Deployment Set Example
Broker 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 Deployer identifies the documents as unresolved 
dependencies. 
ProcessModel 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, 
Deployer identifies the flow services as unresolved dependencies.
MWS If you add a page to an MWS deployment set, but do not add the 
portlets that are referenced by that page, Deployer identifies the 
portlets as unresolved dependencies.
Optimize If you add a rule to a deployment set, but do not add the dimensions 
used by that rule, Deployer identifies the dimensions as unresolved 
dependencies.

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

To resolve dependencies:

1 In the Unresolved Dependencies column for the deployment set, click Check. Deployer 
shows all unresolved dependencies on the Unresolved Dependencies page. The 
Referenced Item column lists the missing referenced assets. The next column offers the 

36 webMethods Deployer User’s Guide Version 7.1.1


4 Defining a Broker, ProcessModel, MWS, or Optimize Deployment Set

possible ways you can resolve the unresolved dependency. The Project Item column 
shows the dependent assets.
2 Tell Deployer how to resolve each unresolved dependency as described below. If you 
want to resolve all assets in a folder the same way, you can set the resolution at the 
folder level rather than at the level of the individual assets.

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

3 Click Save. 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. To un‐resolve 
a dependency, go to the Resolved Dependencies page, select the check box in the Delete 
column for the resolved dependency, and click Delete. 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.1.1 37


4 Defining a Broker, ProcessModel, MWS, or Optimize Deployment Set

Removing Process Models


When you add a process model to a deployment set and then add referenced assets that 
reside on the logical servers, Deployer shows the referenced assets as children of the 
process model. If you want to remove a process model from a deployment set, clear the 
check box next to the process model under the tree. This removes the process model from 
the deployment set; however, the dependencies must be removed manually.

38 webMethods Deployer User’s Guide Version 7.1.1


5 Defining an IS & TN Deployment Set

„ Creating the IS & TN Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40


„ Identifying Source Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
„ Adding Integration Server Administration Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
„ Adding Integration Server Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
„ Adding webMethods Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
„ Adding Trading Networks Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
„ Resolving Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
„ Manually Adding Dependencies to a Package Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

webMethods Deployer User’s Guide Version 7.1.1 39


5 Defining an IS & TN Deployment Set

Creating the IS & TN Deployment Set

To create the IS & TN deployment set:

1 In 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‐hand 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 Servers, Deployer will 
display all packages on those servers. You can use the Packages 
field to narrow the display. Type a regular expression that 
specifies the text that the package names must contain in order 
to be listed.
All other items After you choose the source Integration Servers, Deployer will 
display all assets on those Integration Servers. You can use this 
field to narrow the display. Specify a regular expression that 
specifies the text that the asset names must contain in order to be 
listed.

5 Click Create.

40 webMethods Deployer User’s Guide Version 7.1.1


5 Defining an IS & TN Deployment Set

Identifying Source Integration Servers

To identify source Integration Servers:

1 On the Deployer Projects project Define page, in the left‐hand pane in the Name 


column, click the deployment set for which to identify source Integration Servers. In 
the right‐hand pane, in the Select Source Servers area, Deployer lists all remote servers 
defined to the Integration Server that hosts 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 Deployer to update the list of 
servers. 

2 In the Select column, select the check box next to each Integration Server that contains 
assets 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 Servers IS & TN page and click   in 
the Test column. If the left‐hand pane shows the message ʺSuccessfully connected to 
Integration Server host...,ʺ the Deployer resource package is installed. If the pane 
shows the message “Error connecting to Integration Server...,ʺ 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.

Adding Integration Server Administration Assets

To add Integration Server administration assets:

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

webMethods Deployer User’s Guide Version 7.1.1 41


5 Defining an IS & TN Deployment Set

5 If you added JMS triggers to the deployment set, create the same JMS connection 
aliases on the target Integration Servers that exist on the source Integration Servers. 
For instructions, see the webMethods Integration Server JMS Client Developer’s Guide.   
Important! If the JMS connection aliases on the target Integration Servers do not 
have the same names as on the source Integration Servers, the JMS triggers will 
not be enabled after deployment.

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

Adding an Entire Package

To add an entire package:

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

3 Click Save. Deployer shows the entire package icon ( ) in the left‐hand pane under 
the Packages folder for the deployment set. Deployer also shows the entire package 
icon for selected packages in the package list in the right‐hand 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 “Setting the Package 
Properties” on page 45.

42 webMethods Deployer User’s Guide Version 7.1.1


5 Defining an IS & TN Deployment Set

Adding 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, and then select files, Deployer only allows you to 
add files from the package file list.
„ If you first select files, and then select components, 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 to add package 
components, click the Packages folder. In the right‐hand pane, Deployer lists the 
source Integration Servers you identified.
2 In the right‐hand pane, open the tree to show the packages on the source Integration 
Servers, then click the name of a package that contains components 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. Deployer shows the partial package icon ( ) in the left‐


hand pane under the Packages folder for the deployment set. Deployer also shows the 
partial package icon for the selected package in the package list in the right‐hand 
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 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 “Adding an Entire 
Package” on page 42.

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

webMethods Deployer User’s Guide Version 7.1.1 43


5 Defining an IS & TN Deployment Set

Adding 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, and then select components, Deployer might overwrite 
certain file selections to ensure consistency.
„ If you first select components, and then select files, 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‐hand pane, Deployer lists the source Integration 
Servers you identified.
2 In the right‐hand pane, open the tree to show the packages on the source Integration 
Servers, then click the name of a package that contains files to add to the deployment 
set.
3 Click Select Files. Deployer lists all files in the package.
Do one of the following:

To add... Do this...
All the files in the list Click All files.
Only files you select in  Click Selected Files, then press the CTRL key and click 
the list each file to include in the deployment set.
Note: The Select Files option is a link near the top of the 
right‐hand pane.
Only files other than those  Click All except selected files, then press the CTRL key 
you select in the list and click each file to exclude from the deployment set.
All files in the list whose  Click Files specified by filter, then type the string on 
name contains a  which to match the files to include in the deployment 
specified string set. You can use an asterisk (*) as a wild card (for 
example, *.java or *.class).
All files in the list whose  Click All except files specified by filter, then type the string 
name does not contain a  on which to match the files to exclude from the 
specified string deployment set. You can use an asterisk (*) as 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 to 
delete after deployment, type the fully qualified names of the files to delete in the Files

44 webMethods Deployer User’s Guide Version 7.1.1


5 Defining an IS & TN Deployment Set

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. Deployer shows the partial package icon ( ) in the left‐


hand pane under the Packages folder for the deployment set. Deployer also shows the 
partial package icon for the selected package in the package list in the right‐hand 
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 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 “Adding an Entire Package” on page 42.

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

Setting 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 properties listed below.

Property Entry
Package Use this property when the source package already exists on the 
Type target Integration Servers. You can use the options below for entire 
packages and for partial packages.
If you want 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.
Deploy the components and files in the source package over  Patch
the corresponding components and files in the existing 
package. When you choose to deploy package components, 
package files, or both, this is the default.

webMethods Deployer User’s Guide Version 7.1.1 45


5 Defining an IS & TN Deployment Set

Property Entry

Note: Before you deploy a project, you can find out which assets  
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 Deployer actually deploys the package 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, Deployer deploys. If the source 
package’s version number is lower than the existing package’s 
version number, 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, 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 Deployer should use the package 
version and build numbers that exist in the source Integration Server each time the 
user creates a build instead of the package version and build numbers specified in the 
package_name Properties area.

46 webMethods Deployer User’s Guide Version 7.1.1


5 Defining an IS & TN Deployment Set

5 In the Package Deployment Options area, specify the following:

Option Entry
Activate After How Deployer should deploy the package. If you want Deployer to 
Deployment deploy the package to the Integration Server_directory\replicate\ 
inbound directory on the target Integration Servers, and then do the 
following:
Action Click

Enable the package. Activate
Install the package but not enable it. Install Only
Not install or enable the package. Inbound
Only
Sync Whether Deployer should synchronize the publishable IS document 
Document types in the source package with documents types on the Brokers 
Types that are connected to the target Integration Servers.

Note: 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. Deployer writes a message to that 
effect to the deployment report. 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.
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 Deployer 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 Deployer 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.

webMethods Deployer User’s Guide Version 7.1.1 47


5 Defining an IS & TN Deployment Set

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. You can 
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 assets to the deployment set, go to “Resolving 
Dependencies” on page 50.

Adding webMethods Files


When 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 to add webMethods 
files, click the webMethods Files folder. In the right‐hand pane, Deployer lists the source 
Integration Servers you identified.
2 In the right‐hand 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. Deployer shows your choices in the left‐hand pane under the webMethods
Files folder for the deployment set.
4 If you are not going to add any more assets to the deployment set, go to “Resolving 
Dependencies” on page 50.

48 webMethods Deployer User’s Guide Version 7.1.1


5 Defining an IS & TN Deployment Set

Adding Trading Networks Assets


When you deploy Trading Networks assets to an Integration Server, Deployer updates 
the Trading Networks database that is connected to the Integration Server with the 
deployed assets. When defining a project that includes deploying Trading Networks 
assets to a clustered environment, you can deploy the assets to only one Trading 
Networks‐equipped Integration Server in the cluster.

Important! Do not deploy to multiple Integration Servers in the network, or you will 
experience unpredictable results.

To add Trading Networks assets:

1 In the Deployment Sets area, under the deployment set to which to add Trading 
Networks assets, click the Trading Networks folder. In the right‐hand pane, Deployer 
lists the source Integration Servers you identified.
2 In the right‐hand pane, open the tree to show the Trading Networks assets on the 
source Integration Servers, then select the check box next to each asset 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, 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, 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, Deployer will log an error to the 
deployment report and will not deploy the TN document type.

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

webMethods Deployer User’s Guide Version 7.1.1 49


5 Defining an IS & TN Deployment Set

Resolving Dependencies
For any project, Deployer can determine when assets that are in a deployment set require 
other assets that are not in the deployment set. The assets that require other assets are 
called dependent assets, while the assets that are required are called referenced assets. 
Deployer identifies missing referenced assets 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, Deployer identifies the service as an unresolved dependency. 

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

To resolve dependencies:

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

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

50 webMethods Deployer User’s Guide Version 7.1.1


5 Defining an IS & TN Deployment Set

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

3 Click Save. 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. To un‐resolve 
a dependency, go to the Resolved Dependencies page, select the check box in the Delete 
column for the resolved dependency, and click Delete. Deployer returns the 
dependency to the Unresolved Dependencies page. Go to that page and re‐resolve the 
dependency.

Manually Adding Dependencies to a Package Component


Deployer cannot always detect all dependencies. If you are aware that an asset has a 
dependency on a package component, and Deployer has not detected this dependency, 
you can manually add that dependency. For example, when you add Trading Networks 
Profile objects to the deployment set, 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.
Deployer will check for the referenced asset when you map the project to target 
Integration Servers, as it does when you use the Exists option to resolve an unresolved 
dependency. If Deployer does not find the asset, an icon alerts you during the mapping 
task. If you do not resolve the dependency at that time, Deployer will write a message 
about it to the simulation report and, if you do not resolve it at that time, to the 
deployment report.

webMethods Deployer User’s Guide Version 7.1.1 51


5 Defining an IS & TN Deployment Set

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 
Projects project Define page, open the folder that contains the asset, navigate to the 
asset in the tree in the right‐hand pane, cancel the selection of the asset by clearing the 
appropriate check box, and save the deployment set.

52 webMethods Deployer User’s Guide Version 7.1.1


6 Building, Mapping, and Deploying a Project

„ Building a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
„ Mapping a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
„ Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

webMethods Deployer User’s Guide Version 7.1.1 53


6 Building, Mapping, and Deploying a Project

Building a Project
This section explains how to do the following:
„ Create a build
„ Rebuild a build
„ List the builds for a project
„ Export a build from one project and into another.

Create a Build

To create a build:

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

4 Click   Build. Deployer displays the Projects project Build page and lists all builds 


that exist for the selected project.

Note: The Status column on the Projects project Build 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 “Rebuilding a Build” on 
page 55.

5 In the left‐hand 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.
7 Click Create.

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 displaying and resolving unresolved 
dependencies, see “Resolving Dependencies” in a chapter on defining projects.

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


display the build report. The build report lists the assets that were successfully 

54 webMethods Deployer User’s Guide Version 7.1.1


6 Building, Mapping, and Deploying a Project

included in the build, describes any errors that occurred during the build process, 
and informs you if the project contains unresolved dependencies.

Rebuilding a Build
The Status column on the Projects project Build 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 assets that 
you know have changed on the source servers, and you want to re‐create the build to 
bring it up to date, click   in the Rebuild column for the build.

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 displaying and resolving unresolved 
dependencies, see “Resolving Dependencies” in a chapter on defining projects.

Exporting and Importing a Build

To export and import a build:

1 Export a build as follows:
a In the source Deployer, go to the Projects project Build page.

b Locate the build to export and click  in the build’s Export column. 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 
directory. 
2 Import the build as follows:
a Copy the project_build file to the Integration Server_directory\packages\ 
WmDeployer\replicate\inbound directory on the machine that hosts the target 
Deployer.
b In the target Deployer, go to the Tools Import Build page.
c In the Project Build list, click the project_build file you just copied to the inbound 
directory.
d Click Import.

webMethods Deployer User’s Guide Version 7.1.1 55


6 Building, Mapping, and Deploying a Project

Mapping a Project
This section explains how to do the following:
„ Map a project (that is, deployment sets) to target servers.
„ Export a deployment map from one project and into another.
„ Specify configuration values to substitute for Integration Server assets.
„ Export substitute configuration values from one deployment map and import them 
into another.

Mapping a Project to Target Servers


You can map a project to target servers by mapping to individual target servers, target 
groups, or both.

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

To map a project to target servers:

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

2 In the right‐hand pane, click   Map. Deployer displays the Projects   project   Map 


page and lists all maps that exist for the selected project.
3 In the left‐hand pane, click Create Deployment Map.
4 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.
5 In the Description box, type a description for the map. The description length has no 
limit and can include any characters.
6 Click Create.
7 Under the Deployment Map Topology area, in the Deployment Set Mapping column for a 
deployment set, do the following:
„ To add a target group, click Add Target Group. Select the check box next to each 
target group to which to deploy the assets in the deployment set and then click 
Add.
„ To add an individual target server, click Add Target Server.
For a Broker, ProcessModel, MWS, or Optimize deployment set, Deployer lists all 
servers of the appropriate type (for example, ProcessModel servers for a 

56 webMethods Deployer User’s Guide Version 7.1.1


6 Building, Mapping, and Deploying a Project

ProcessModel deployment set) that are configured to work with Deployer. Select 
the check box next to each server to which to deploy the assets in the deployment 
set, and then click Add.
For an IS & TN deployment set, Deployer lists all remote Integration Servers that 
are defined in Integration Server Administrator. Select the check box next to each 
Integration Server to which to deploy the assets in the deployment set, and 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 Deployer to update the list of servers.

8 When 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 Deployer has found that the 
referenced asset does not exist on target servers. Click   to see the missing referenced 
asset. You can then place the referenced asset on the target servers, or you can return 
to the project definition stage and re‐resolve the dependency in a different way (see 
“Resolving Dependencies” in a chapter on defining projects).

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

Exporting and Importing a Map

To export and import a map:

1 Export a map as follows:
a In the source Deployer, go to the Projects project Map page.

b Locate the map to export and click  in the map’s Export column. Deployer 
creates a file that contains the deployment map. The file is named 
project_map.map and is stored in the Integration Server_directory\packages\ 
WmDeployer\replicate\outbound directory.
2 After you export a map, you can edit any of the attributes before importing it into the 
target environment. For example, you might want to map a deployment set to a new 
target server. For instructions, see “Editing a Deployment Map or Substitute 
Configuration Values” on page 90.

webMethods Deployer User’s Guide Version 7.1.1 57


6 Building, Mapping, and Deploying a Project

3 Import the map as follows:
a Copy the project_map.map file to the Integration Server_directory\packages\ 
WmDeployer\replicate\inbound directory on the machine that hosts the target 
Deployer.
b In the target Deployer, go to the Projects project Map page.
c Click Import Map.
d Select the project_map.map file you just copied to the inbound directory.

Substituting Configuration Values for Integration Server Assets


You can tell Deployer to substitute different configuration values for Integration Server 
assets during deployment so the assets will run properly on the target Integration 
Servers. You can substitute configuration values by asset or by target server.

To substitute configuration values by asset:

1 Under the Deployment Map Properties area, click Configure Builds by Assets. If assets in the 


deployment set have configuration values, Deployer displays those assets in the left‐
hand pane. You can substitute different configuration values for these assets as 
follows:
a In the left‐hand pane, click the asset whose configuration values to substitute. 
Deployer displays the configuration values for the asset as it exists on the source 
Integration Server.
b In the right‐hand pane, enter the configuration values to substitute for the asset 
when it is deployed on the target Integration Server.
c In the bottom right‐hand pane, select the target servers and target groups on 
which to substitute the configuration values.
d Click Save Substitutions.
e Repeat the previous steps for each asset on the selected target Integration Server 
whose configuration values to substitute.
2 Repeat these steps for other IS & TN deployment sets in the project as needed.

To substitute configuration values by target server:

1 Under the Deployment Map Properties area, click Configure Builds by Server to display the 


mapped target servers that belong to the deployment set. Select a target server to 
display its source configuration. Deployer displays the source configuration assets in 

58 webMethods Deployer User’s Guide Version 7.1.1


6 Building, Mapping, and Deploying a Project

the right‐hand pane. You can substitute the configuration values for these assets on 
the target Integration Server as follows:
a In the right‐hand pane, click the asset whose configuration values to substitute. 
Deployer displays the configuration values for the asset as it exists on the source 
Integration Server.
b In the bottom right‐hand pane, type the configuration values to substitute for the 
asset when it is deployed on the target Integration Server.
c Click Save Substitutions.
d Repeat the previous steps for each asset on the selected target Integration Server 
whose configuration values to substitute.
2 If needed, repeat the previous step for every Integration Server you added as a target 
for the IS & TN deployment set.
3 Repeat these steps for other IS & TN deployment sets in the project as needed.

Exporting and Importing Substitute Configuration Values

To export and import substitute configuration values:

1 Export the substitute configuration values from a deployment map as follows:
a In the source Deployer, go to the Projects project Map page.
b Click the deployment map that contains the substitute configuration values to 
export. Deployer displays the deployment map properties in the right‐hand pane.
c Click Export Variable Substitution. Deployer creates a file that contains the substitute 
configuration values for the assets in the project. The file is named project_map.vs 
and is stored in the Integration Server_directory\packages\WmDeployer\ 
replicate\outbound directory.
2 Import the substitute configuration values into a deployment map as follows:
a Copy the project_map.vs file to the Integration Server_directory\packages\ 
WmDeployer\replicate\inbound directory on the machine that hosts the target 
Deployer.
b In the target Deployer, go to the Projects project Map page.
c Click the deployment map into which to import the substitute configuration 
values. Deployer displays the deployment map properties in the right‐hand pane.
d Click Import Variable Substitution.
e Select the project_map.vs file you just copied to the inbound directory.

webMethods Deployer User’s Guide Version 7.1.1 59


6 Building, Mapping, and Deploying a Project

Deploying a Project
This section explains how to do the following:
„ Generate a checkpoint
„ Simulate deployment of a project
„ Deloy a project
„ Roll back the target servers

Generating a Checkpoint
You set up the checkpoint feature in the project properties (see “Setting the Default 
Properties for Deployment” on page 26). If you chose automatic checkpoint, Deployer 
automatically generates a checkpoint as the first step when you actually deploy a project. 
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.  
Important! 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‐hand 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 roll back.

Simulating Deployment of or Deploying a Project


You can simulate a deployment before you actually deploy. A simulation report contains 
information such as the following:
„ Assets that will be suspended during deployment.
„ Assets that will be enabled after deployment.
„ Changes that will occur on the target servers, such as the assets that will be added or 
overwritten, and configuration values that will be substituted for Integration Server 
assets.
„ Messages about problems, such as unresolved dependencies.

60 webMethods Deployer User’s Guide Version 7.1.1


6 Building, Mapping, and Deploying a Project

To simulate deployment of or deploy a project:

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

3 In the right‐hand pane, click   Deploy. Deployer displays the Projects project Deploy 


page and lists all deployment candidates that exist for the selected project.
4 In the left‐hand 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 candidate. 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 assets 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 Deployer found during the mapping task that the referenced asset in fact does 
not exist on the target server. You can place the referenced asset on the target 
servers, or you can return to the project definition stage and re‐resolve the 
dependency in a different way (see “Resolving Dependencies” in a chapter on 
defining projects).

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

8 Click Create. In the candidate list in the left‐hand 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 “Building a Project” 
on page 54.

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‐hand pane in the 
Deployment History area. Click   next to Simulation in the Report Type column to display 
the report. Read the report and address all problems.

webMethods Deployer User’s Guide Version 7.1.1 61


6 Building, Mapping, and Deploying a Project

Important! If you do not address all problems at this time, you will probably 
experience errors during the deployment. For instructions on resolving 
unresolved dependencies, see the“Resolving Dependencies” section in a chapter 
on defining projects.

10 To deploy the project, click   in the Deploy column for the deployment candidate. 
Deployer does the following:
„ If you chose automatic checkpointing or automatic roll back in the project 
properties, automatically generates a checkpoint at this time.
„ Deploys the assets 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.
11 If the deployment candidate included JMS triggers, do the following:
a If the JMS alias connection for the deployed JMS trigger does not yet exist on the 
target server, create the same JMS connection aliases on the target Integration 
Servers that exist on the source Integration Servers. Then reload the packages that 
contain the JMS triggers.
b Enable the JMS triggers.
c Configure the queue or topic for each JMS trigger on the message provider for the 
target Integration Servers.
For instructions, see the webMethods Integration Server JMS Client Developer’s Guide.

Rolling Back the Target Servers


You set up the roll back feature in the project properties (see “Setting the Default 
Properties for Deployment” on page 26). If you chose automatic roll back and the 
deployment fails, Deployer automatically rolls back the target servers to the checkpoint. 
If you chose manual roll back, you can roll back the target servers to the check point 
manually at any time after a deployment.

To roll back the target servers:

In the Deployment Candidates list, click   in the Roll Back column. The roll back report 


appears in the right‐hand pane in the Deployment History area.

Click   next to Roll Back in the Report Type column to display the report.

62 webMethods Deployer User’s Guide Version 7.1.1


6 Building, Mapping, and Deploying a Project

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.1.1 63


6 Building, Mapping, and Deploying a Project

64 webMethods Deployer User’s Guide Version 7.1.1


7 Deploying to Clustered Integration Servers

„ Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
„ Configuring Cluster Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
„ Deploying Scheduled Tasks in a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

webMethods Deployer User’s Guide Version 7.1.1 65


7 Deploying to Clustered Integration Servers

Overview
Deployer can deploy to clustered Integration Servers. Deployer can deploy all Integration 
Server assets in a clustered environment except existing scheduled tasks (see “Deploying 
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 (“Setting the Default Properties for 
Deployment” on page 26), you chose the method to use to deploy Integration Server 
assets to clustered Integration Servers.
If you chose manual cluster deployment, you chose to deploy the assets to each 
Integration Server in the cluster yourself.
If you chose automatic cluster support, you chose to deploy the assets 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 “Configuring Cluster Synchronization” on page 67. 

Important! For automatic cluster support, all Integration Servers in the cluster must be 
running when you deploy to the primary node, or the deployment will fail.

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

Deploying to Clustered Trading Networks Servers


The Trading Networks assets you can deploy using 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, Deployer deploys the assets 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.

66 webMethods Deployer User’s Guide Version 7.1.1


7 Deploying to Clustered Integration Servers

Deploying to Clustered ProcessModel Servers


Process models consist of Integration Server assets 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, Deployer deploys the Integration Server 
assets and database objects to the primary node. The primary node propagates the 
deployed Integration Server assets 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 assets. The 
Process Audit Log database component will be updated multiple times, but this will not 
cause a problem.

Configuring 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.
2 Install the WmDeployerResource package to the primary node only. For instructions, 
see “Configuring Communication with Integration Servers” on page 22.
3 Map projects for the cluster to the primary cluster node only. For instructions, see 
Chapter , “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.1.1 67


7 Deploying to Clustered Integration Servers

Deploying Scheduled Tasks in a Cluster


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

68 webMethods Deployer User’s Guide Version 7.1.1


II Using the Deployer Command Line Interface

„ Scripts, Configuration Files, and Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71


„ General and Project Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
„ Build Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
„ Map Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
„ Deployment Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Full Book Title Version x.x 69


II Using the Deployer Command Line Interface

70 Full Book Title Version x.x


8 Scripts, Configuration Files, and Log Files

„ Creating and Running Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72


„ Specifying Log On Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
„ Error Handling and Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

webMethods Deployer User’s Guide Version 7.1.1 71


8 Scripts, Configuration Files, and Log Files

Creating and Running Scripts


You can enter Deployer commands at a command prompt or you can create scripts that 
execute commands automatically. If you create a script, Deployer runs the commands in 
the order in which they appear in the script.
To invoke Deployer from the command line and execute a script, use the command 
indicated below.   
System Command
Windows or UNIX Deployer.{bat|sh} path_to_file
Mac deployerMac.sh path_to_file

You can also call scripts from other automated procedures, such as other scripts.
The sample script below automates these tasks on a Windows system:
„ Imports a build that was exported from a test environment. Deployer automatically 
creates the deployment project and deployment sets.
„ Displays the build contents on the console.
„ Imports the deployment map.
„ Imports substitute configuration values for Integration Server assets into the 
deployment map.
„ Creates a deployment candidate.
„ Generates a checkpoint, simulates the deployment, and deploys the build.

72 webMethods Deployer User’s Guide Version 7.1.1


8 Scripts, Configuration Files, and Log Files

:environment
set host=%1
set port=%2
set user=%3
set pwd=%4
set project=testProject
set build=DemoBuild
set depCandidate=DemoDC
set depMap=DemoMap

rem ----clear the ERRORLEVEL system variable to avoid any sideeffects of previous
executions cases
set ERRORLEVEL=

:importBuild
set importB=%project%_ExportedBuild_%build%
IF "%ERRORLEVEL%" == "8" GOTO FINISH
ECHO ---------------------------------------------------------------------------
ECHO Importing Build %ImportB%
ECHO ---------------------------------------------------------------------------
call Deployer.bat --import -buildFile %importB% -host %host% -port %port% -user
%user% -pwd %pwd%
@echo off
echo.
echo.
echo.
set importB=
set nextAction=describeBuild
GOTO verifyStatus

:describeBuild
IF "%ERRORLEVEL%" == "8" GOTO FINISH
ECHO ---------------------------------------------------------------------------
ECHO Describing %build%
ECHO ---------------------------------------------------------------------------
call Deployer.bat --describe -build %build% -project %project% -host %host% -port
%port% -user %user% -pwd %pwd%
@echo off
echo.
echo.
echo.
set nextAction=buildit
GOTO verifyStatus

:importMap
set importM=%project%_%depMap%.map
IF "%ERRORLEVEL%" == "8" GOTO FINISH
ECHO ---------------------------------------------------------------------------
ECHO Importing Map %ImportM%
ECHO ---------------------------------------------------------------------------
call Deployer.bat --import -mapFile %importM% -project %project% -host %host% -port
%port% -user %user% -pwd %pwd%
@echo off
echo.
echo.
echo.
set importM=
set nextAction=importVarSub
GOTO verifyStatus

webMethods Deployer User’s Guide Version 7.1.1 73


8 Scripts, Configuration Files, and Log Files

:importVarSub
set importV=%project%_%depMap%.vs
IF "%ERRORLEVEL%" == "8" GOTO FINISH
ECHO ---------------------------------------------------------------------------
ECHO Importing Varsub %ImportV%
ECHO ---------------------------------------------------------------------------
call Deployer.bat --import -varsub -vsFile %importV% -map %depMap% -project
%project% -host %host% -port %port% -user %user% -pwd %pwd%
@echo off
echo.
echo.
echo.
set importV=
set nextAction=createDC
GOTO verifyStatus

:createDC
IF "%ERRORLEVEL%" == "8" GOTO FINISH
ECHO ---------------------------------------------------------------------------
ECHO Creating Deployment Candidate %depCandidate%
ECHO ---------------------------------------------------------------------------
call Deployer.bat --create -dc %depCandidate% -build %build% -map %depMap% -project
%project% -host %host% -port %port% -user %user% -pwd %pwd%
@echo off
echo.
echo.
echo.
set nextAction=simulate
GOTO verifyStatus
:simulate
IF "%ERRORLEVEL%" == "8" GOTO FINISH
ECHO ---------------------------------------------------------------------------
ECHO Performaing deployment simulation on deployment candidate %depCandidate%
ECHO ---------------------------------------------------------------------------
call Deployer.bat -host %host% -port %port% -user %user% -pwd %pwd% --simulate -
project %project% -dc %depCandidate%
@echo off
echo.
echo.
echo.
set nextAction=checkpoint
GOTO verifyStatus

:checkpoint
IF "%ERRORLEVEL%" == "8" GOTO FINISH
ECHO ---------------------------------------------------------------------------
ECHO Performing CHECKPOINT operation of %depCandidate%
ECHO ---------------------------------------------------------------------------
echo %project%
echo %depCandidate%
call Deployer.bat --checkpoint -project %project% -dc %depCandidate% -host %host% -
port %port% -user %user% -pwd %pwd%
@echo off
echo .
echo .
echo .
set nextAction=deploy
GOTO verifyStatus

74 webMethods Deployer User’s Guide Version 7.1.1


8 Scripts, Configuration Files, and Log Files

:deploy
IF "%ERRORLEVEL%" == "8" GOTO FINISH
ECHO ---------------------------------------------------------------------------
ECHO DEPLOYING %depCandidate%

:VerifyStatus
IF "%ERRORLEVEL%" == "8" ECHO "<<<ERROR>>>"
IF "%ERRORLEVEL%" == "4" ECHO "<<<WARNING>>>"
IF "%ERRORLEVEL%" == "0" ECHO "<<<SUCCESS>>>"
echo.
echo.
goto %nextAction%
:FINISH
echo.
echo.
echo Completed.

set host=
set port=
set user=
set pwd=
set project=
set build=
set depCandidate=
set ERRORLEVEL=

@echo on

Specifying Log On Parameters


All Deployer commands require parameters for logging onto the Integration Server that 
hosts the Deployer. You can have Deployer commands connect to the Integration Server 
using HTTP or HTTPS.
If you want the Deployer commands to log on using HTTP, you can use an existing HTTP 
port on the Integration Server or configure a new one. If you want the Deployer 
commands to log on using HTTPS, you must do the following:
„ Use an existing HTTPS port on the Integration Server or configure a new one.
„ Place the command line interface’s client certificate, private key, and signing 
authority’s certificate on the Integration Server host machine.
„ Map the command line interface’s client certificate to an Integration Server user that 
has Administrator or Developer privileges.
For instructions on these tasks, see the webMethods Integration Server Administrator’s Guide.
When you run Deployer commands, the log on parameters you provide depend on 
whether you want to use HTTP or HTTPS, as follows:
„ The log on parameters for logging onto an HTTP port are as follows:

Deployer.{sh|bat} --command -host host -port port -user user -pwd password

webMethods Deployer User’s Guide Version 7.1.1 75


8 Scripts, Configuration Files, and Log Files

„ The logon parameters for logging onto an HTTPS port are as follows:

Deployer.{sh|bat} --command -host host -port port -user user -pwd password
-useSSL -senderCert path_to_cert -privKey path_to_key -caCert path_to_cert

Parameter Description
-host host -port port Host machine and port for the Integration Server 
to log on to.
-user user -pwd password User name and password to use to log on to the 
Integration Server.
-useSSL Tells the Deployer command to log on to an 
HTTPS port.
-senderCert path_to_cert Command line interface’s client certificate.
-privKey path_to_key Command line interface’s private key.
-caCert path_to_cert Command line interface’s signing authority’s 
certificate.

Important! If the certificates and private key do not exactly match the ones in the  
Integration Server installation for the command line interface, the command will 
fail.

Creating a Configuration File for Log On Parameters


You can save time by creating a configuration file that specifies the values to use for the 
log on parameters and then pointing commands to the configuration file. Create the 
configuration file using a text editor and specify the appropriate parameter values, as 
specified above. For example:        
host=idcauto1
port=5555
user=Administrator
pwd=1xcfdg55

host=idcauto1
port=5555
useSSL=true
senderCert=C:\files\SenderCert.der
privKey=C:\files\SenderPrivKey.der
caCert=C:\files\SenderCACert.der

Save the file with the extension .cnf and store it in the Integration Server_directory\ 
packages\WmDeployer\bin directory.

76 webMethods Deployer User’s Guide Version 7.1.1


8 Scripts, Configuration Files, and Log Files

To point a command to the configuration file, specify the following on the command 
instead of the log on parameters:

Deployer.{sh|bat} --command -configFile file

Parameter Description
command Command to run.
-configFile file Full path to the configuration file.

Error Handling and Logging


Deployer logs errors that occur during command line operations in the Deployer 
command line log file. The log file is named CLI.log and is located in the Integration 
Server_directory\packages\WmDeployer\logs directory.
Typical command line errors include required options that were not specified and invalid 
parameter values. Execution errors can include connectivity and authentication errors.
The maximum size for the CLI.log file is 100 KB. When it reaches the maximum size, it 
archives the log by renaming the file CLI.log.old and creating a new CLI.log file. 

webMethods Deployer User’s Guide Version 7.1.1 77


8 Scripts, Configuration Files, and Log Files

78 webMethods Deployer User’s Guide Version 7.1.1


9 General and Project Commands

„ Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
„ About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
„ Listing Builds, Maps, or Deployment Candidates for a Project . . . . . . . . . . . . . . . . . . . . . . . . . . 80
„ Displaying Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
„ Exporting Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
„ Importing Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
„ Deleting a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

webMethods Deployer User’s Guide Version 7.1.1 79


9 General and Project Commands

Help
Displays usage information for Deployer commands.

Deployer.{sh|bat} --help -command command_string

Parameter Description
-command command_string Command for which you want usage information.

About
Deployer.{sh|bat} --about

Listing Builds, Maps, or Deployment Candidates for a Project


Important! To list builds, you must have Build ACL authorization. To list maps, you 
must have Map ACL authorization. To list deployment candidates, you must have 
Deploy ACL authorization.

Deployer.{sh|bat} --list -candidate {Build|Map|DC} -project project


-host host -port port -user user_name -pwd password

Parameter Description
-candidate Whether to list builds, maps, or deployment candidates.
{Build|Map|DC}
-project project Project that contains the builds, maps, or deployment 
candidates to list.

Displaying Project Properties


Important! You must have Administrator ACL authorization to run this command.

Deployer.{sh|bat} --getProjectProperties -project project


-host host -port port -user user_name -pwd password

Parameter Description
-project project Project whose properties to display.

80 webMethods Deployer User’s Guide Version 7.1.1


9 General and Project Commands

Exporting Project Properties


Important! You must have Administrator ACL authorization to run this command.

Deployer.{sh|bat} -–export -project project


-host host -port port -user user_name -pwd password

Parameter Description
-project project Project from which to export properties.

When you export, Deployer creates a file that contains the project property settings. The 
file is named project_properties and is stored in the Integration Server_directory\replicate\ 
outbound directory.

Importing Project Properties


Importing properties into a project overwrites the existing properties for that project.
Before you can import project properties, you must copy the exported project_properties 
file to the Integration Server_directory\packages\WmDeployer\replicate\inbound 
directory on the machine that hosts the target Deployer.  
Important! You must have Administrator ACL authorization to  run this command.

Deployer.{sh|bat} --setProjectProperties -project project


-projectFile properties_file
-host host -port port -user user_name -pwd password

Parameter Description
-project project Project into which to import the properties.
-projectFile Full path to the file that contains the properties to 
properties_file import. These files are named project_properties and are 
located in the Integration Server_directory\ packages\ 
WmDeployer\replicate\inbound directory.

webMethods Deployer User’s Guide Version 7.1.1 81


9 General and Project Commands

Deleting a Project
Important! You must have Administrator ACL authorization to run this command.

Deployer.{sh|bat} --delete -project project


-host host -port port -user user_name -pwd password

Parameter Description
-project project Project to delete.

82 webMethods Deployer User’s Guide Version 7.1.1


10 Build Commands

„ Creating a Project Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84


„ Listing the Builds for a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
„ Displaying the Contents of a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
„ Displaying the Substitute Configuration Values for Integration Server Assets in a Build . . . . . . . 85
„ Displaying the Contents of a Build File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
„ Displaying the Substitute Configuration Values for Integration Server Assets in a Build File . . . 86
„ Exporting a Build from a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
„ Importing a Build into a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
„ Listing Build Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
„ Displaying a Build Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

webMethods Deployer User’s Guide Version 7.1.1 83


10 Build Commands

Creating a Project Build


If there are any unresolved dependencies, build creation will fail. For instructions on 
resolving unresolved dependencies, see “Resolving Dependencies” in a chapter on 
defining projects.    
Important! You must have Build ACL authorization to run this command.

Deployer[.sh | .bat] --create -build build -project project


-host host -port port -user user_name -pwd password

Parameter Description
-build build Name of the build to create. The build name can be up to 
32 characters long and can include any characters that 
are valid for a file name in your operating system.
-project project Project from which to create the build.

Listing the Builds for a Project


Important! You must have View ACL authorization to run this command.

Deployer[.sh | .bat] --list -candidate build -project project


-host host -port port -user user_name -pwd password

Parameter Description
-project project Project whose builds to list.

84 webMethods Deployer User’s Guide Version 7.1.1


10 Build Commands

Displaying the Contents of a Build


Important! You must have Administrator ACL authorization to run this command.

Deployer.{sh|bat} --describe -build build -project project


-host host -port port -user user_name -pwd password

Parameter Description
-build build Build whose contents to display.
-project project Project to which the build belongs.

Displaying the Substitute Configuration Values for Integration


Server Assets in a Build
Important! You must have Administrator ACL authorization to run this command.

Deployer.{sh|bat} --describe -build build -project project -varsub


-host host -port port -user user_name -pwd password

Parameter Description
-build build Build whose substitute configuration values to display.
-project project Project to which the build belongs.
-varsub Displays the substitute configuration values.

webMethods Deployer User’s Guide Version 7.1.1 85


10 Build Commands

Displaying the Contents of a Build File


Important! You must have Administrator ACL authorization to run this command.

Deployer.{sh|bat} --describe -buildFile build_file -project project


-host host -port port -user user_name -pwd password

Parameter Description
-buildFile build_file Full path to the build file whose contents to display. 
Build files are named project_build and are located in 
the Integration Server_directory\packages\ 
WmDeployer\ replicate\outbound directory.
-project project Project to which the build belongs.

Displaying the Substitute Configuration Values for Integration


Server Assets in a Build File
Important! You must have Administrator ACL authorization to run this command.

Deployer.{sh|bat} --describe -buildFile build_file -project project -varsub


-host host -port port -user user_name -pwd password

Parameter Description
-buildFile build_file Full path to the build file whose substitute 
configuration values to display. Build files are named 
project_build and are located in the Integration 
Server_directory\packages\ 
WmDeployer\replicate\outbound directory.
-project project Project to which the build belongs.
-varsub Displays the substitute configuration values.

86 webMethods Deployer User’s Guide Version 7.1.1


10 Build Commands

Exporting a Build from a Project


Important! You must have Build ACL authorization to run this command.

Deployer[.sh | .bat] --export -build build -project project


-overwrite {true|false} -host host -port port -user user_name -pwd password

Parameter Description
-build build Build to export.
-project project Project to which the build belongs.
-overwrite {true|false} If the project already contains a build with the same 
name, whether the Deployer should overwrite it. If you 
specify false (do not overwrite), and a build with the 
same name exists, Deployer issues an error and ends the 
command.

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

Importing a Build into a Project


Before you can import a build, you must copy the exported project_build file to the 
Integration Server_directory\packages\WmDeployer\replicate\inbound directory on the 
machine that hosts the target Deployer.  
Important! You must have Build ACL authorization to run this command.

Deployer[.sh | .bat] --import -buildFile build_file -project project


-overwrite {true|false} -host host -port port -user user_name -pwd password

Parameter Description
-buildFile build_file Full path to the build file that contains the deployment 
map to import. Build files are named project_build and 
are located in the Integration Server_directory\ pack‐
ages\WmDeployer\replicate\inbound directory.

webMethods Deployer User’s Guide Version 7.1.1 87


10 Build Commands

Parameter Description
-project project Project into which to import the build.
-overwrite {true|false} If the project already contains a build with the same 
name, whether Deployer should overwrite it. If you 
specify false (do not overwrite), and a build with the 
same name exists, the Deployer issues an error and 
ends the command.

Listing Build Reports


Important! You must have Build ACL authorization to run this command.

Deployer.{sh|bat} --list -candidate buildReport -build build -project project


-host host -port port -user user_name -pwd password

Parameter Description
-build build Build for which to list build reports. 
-project project Project to which the build belongs.

Displaying a Build Report


Important! You must have Build ACL authorization to run this command.

Deployer.{sh|bat} --showReport -candidate buildReport -build build


-id integerId -project project -host host -port port
-user user_name -pwd password

Parameter Description
{-build build Build whose build report to display.
id report_identifier Identifier for the report to display. Use the --list 
command (see “Listing Build Reports” on page 88) to 
display report identifiers, as well as the date and time 
each report was generated.
-project project Project to which the build belongs.

88 webMethods Deployer User’s Guide Version 7.1.1


11 Map Commands

„ Command Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
„ Listing All Deployment Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
„ Exporting a Deployment Map from a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
„ Editing a Deployment Map or Substitute Configuration Values . . . . . . . . . . . . . . . . . . . . . . . . . . 90
„ Importing a Deployment Map Into a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
„ Exporting Substitute Configuration Values for Integration Server Assets from a Deployment Map 92
„ Importing Substitute Configuration Variables for Integration Server Assets into a Deployment Map 92
„ Deleting a Deployment Map from a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

webMethods Deployer User’s Guide Version 7.1.1 89


11 Map Commands

Command Authorization
Important! You must have Map ACL authorization to run these commands .

Listing All Deployment Maps


Deployer.{sh|bat} --list -candidate mapFile
-host host -port port -user user_name -pwd password

Exporting a Deployment Map from a Project


Deployer[.sh | .bat] --export -map map -project project
-host host -port port -user user_name -pwd password

Parameter Description
-map map Deployment map to export.
-project project Project to which the map belongs.

Deployer creates a file that contains the deployment map. The file is named 
project_map.map and is stored in the Integration Server_directory\replicate\outbound 
directory.

Editing a Deployment Map or Substitute Configuration Values


After you export a deployment map or substitute configuration values, you can edit the 
resulting file before importing it into the other environment. For example, if you want to 
map a deployment set to a different target server, you could change the targetServer
alias attribute to reflect the new target server name.

You can open a deployment map or substitute configuration value file using any XML 
editor. A deployment map file has the following format:
<?xml version="1.0" encoding="UTF-8"?>

<DeploymentMap description="<description of map>" mapName="<mapSetName>"


xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<DeploymentSets>
<DeploymentSet name="<deploymentSetName>" pluginType="<pluginType>">
<targetGroups>
<targetGroup alias="<targetGroupName>"/>
</targetGroups>

90 webMethods Deployer User’s Guide Version 7.1.1


11 Map Commands

<targetServers>
<targetServer alias="<targetServerAlias>"/>
</targetServers>
</DeploymentSet>
</DeploymentSets>
</DeploymentMap>

To specify an additional target server, target group, or deployment set in the same 
deployment map, repeat the attribute for each addition. For example, a deployment set 
that is mapped to multiple target servers is defined as follows:
  <DeploymentSets>
<DeploymentSet name="deploymentsetA" pluginType="MWS">
<targetGroups>
<targetGroup alias="<targetGroupName>"/>
</targetGroups>
<targetServers>
<targetServer alias="server1"/>
<targetServer alias="server2"/>
<targetServer alias="server3"/>
</targetServers>
</DeploymentSet>
</DeploymentSets>
</DeploymentMap>

Importing a Deployment Map Into a Project


Before you can import a deployment map, you must copy the exported project_map.map 
file to the Integration Server_directory\packages\WmDeployer\replicate\inbound 
directory on the machine that hosts the target Deployer. You can edit the map before you 
import it (see “Editing a Deployment Map or Substitute Configuration Values” on 
page 90).

Deployer[.sh | .bat] --import -map map_file -project project


-overwrite {true|false} -host host -port port -user user_name -pwd password

Parameter Description
-map map_file Full path to the map file that contains the deployment 
map to import. Map files are named project_map.map and 
are located in the Integration Server_directory\ 
packages\WmDeployer\replicate\inbound directory.
-project project Project into which to import the map.
-overwrite {true|false} If the project already contains a map with the same 
name, whether the Deployer should overwrite it. If you 
specify false (do not overwrite), and a map with the 
same name exists, the Deployer issues an error and ends 
the command.

webMethods Deployer User’s Guide Version 7.1.1 91


11 Map Commands

Exporting Substitute Configuration Values for Integration


Server Assets from a Deployment Map
Deployer[.sh | .bat] --export -map map -project project -varsub
-host host -port port -user user_name -pwd password

Parameter Description
-map map Deployment map from which to export substitute 
configuration values.
-project project Project to which the map belongs.
-varsub Exports the substitute configuration values.

Deployer creates a file that contains the substitute configuration values. The file is named 
project_map.vs and is stored in the Integration Server_directory\packages\WmDeployer\ 
replicate\outbound directory.

Note: If no substitute configuration values are specified in the deployment map, the 
Deployer creates a file with the complete structure but does not export any values.

Importing Substitute Configuration Variables for Integration


Server Assets into a Deployment Map
Before you can import substitute configuration values into a deployment map, you must 
copy the exported project_map.vs file to the Integration Server_directory\packages\ 
WmDeployer\replicate\inbound directory on the machine that hosts the target 
Deployer. You can edit the values before you import them (see “Editing a Deployment 
Map or Substitute Configuration Values” on page 90).

Deployer[.sh | .bat] --import -varsubFile config_values_file -map map


-project project -validate {true|false}
-host host -port port -user user_name -pwd password

Parameter Description
-varsubFile Full path to the file that contains the substitute 
config_values_file configuration values to import. These files are named 
project_map.vs and are located in the Integration 
Server_directory\ packages\WmDeployer\replicate\ 
inbound directory.
-map map Deployment map into which to import the values.

92 webMethods Deployer User’s Guide Version 7.1.1


11 Map Commands

Parameter Description
-project project Project that contains the map into which to import the 
values.
-validate {true|false} Whether Deployer should check the values to make sure 
they are valid for the target servers. If you specify true 
(validate), Deployer lists any servers that are not running 
on the console.

Deleting a Deployment Map from a Project


Deployer.{sh|bat} --delete -map map -project project
-host host -port port -user user_name -pwd password

Parameter Description
-map map Deployment map to delete.
-project project Project that contains the map to delete.

webMethods Deployer User’s Guide Version 7.1.1 93


11 Map Commands

94 webMethods Deployer User’s Guide Version 7.1.1


12 Deployment Commands

„ Command Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
„ Creating a Deployment Candidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
„ Displaying Information About a Deployment Candidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
„ Deleting a Deployment Candidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
„ Generating a Checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
„ Simulating a Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
„ Deploying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
„ Rolling Back Target Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
„ Listing Simulation, Rollback, and Deployment Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
„ Displaying a Simulation, Rollback, or Deployment Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

webMethods Deployer User’s Guide Version 7.1.1 95


12 Deployment Commands

Command Authorization
Important! You must have Deploy ACL authorization to run these commands .

Creating a Deployment Candidate


Deployer[.sh | .bat] --create -dc deployment_candidate -build build -map map
-project project -host host -port port -user user_name -pwd password

Parameter Description
-dc deployment_candidate Deployment candidate to create.
-build build Project build to use in the deployment candidate.
-map map Deployment map to use in the deployment candidate.
-project project Project to which the build and map belong.

Displaying Information About a Deployment Candidate


Deployer.{sh|bat} --describe -dc deployment_candidate -project project
-host host -port port -user user_name -pwd password

Parameter Description
-dc deployment_candidate Deployment candidate for which to obtain information, 
such as:
„ Name of the build and deployment map in the 
candidate.
„ Date the candidate was created.
„ All existing deployment reports for the candidate.
-project project Project to which the deployment candidate belongs.

96 webMethods Deployer User’s Guide Version 7.1.1


12 Deployment Commands

Deleting a Deployment Candidate


Deployer.{sh|bat} --delete -dc deployment_candidate -project project
-host host -port port -user user_name -pwd password

Parameter Description
-dc deployment_candidate Deployment candidate to delete.
-project project Project to which the deployment candidate belongs.

Generating a Checkpoint
Important! The target servers must be available for the checkpoint generation to be 
successful.

Deployer.{sh|bat} --checkpoint -dc deployment_candidate -project project


-host host -port port -user user_name -pwd password

Parameter Description
-dc deployment_candidate Deployment candidate you plan to deploy.
-project project Project to which the deployment candidate belongs.

Simulating a Deployment
Deployer.{sh|bat} --simulate -dc deployment_candidate -project project
-host host -port port -user user_name -pwd password

Parameter Description
-dc deployment_candidate Deployment candidate for which to simulate a 
deployment.
-project project Project to which the deployment candidate belongs.

Deployer generates a simulation report. Display the simulation report as instructed in 
“Displaying a Simulation, Rollback, or Deployment Report” on page 99 and address all 
problems.

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

webMethods Deployer User’s Guide Version 7.1.1 97


12 Deployment Commands

Deploying
Deployer.{sh|bat} --deploy -dc deployment_candidate -project project
-host host -port port -user user_name -pwd password

Parameter Description
-dc deployment_candidate Deployment candidate to deploy.
-project project Project to which the deployment candidate belongs.

The Deployer deploys the assets in the candidate’s project build to the target servers in 
the candidate’s deployment map. In addition, Deployer generates a deployment report. 
Display the deployment report as instructed in “Displaying a Simulation, Rollback, or 
Deployment Report” on page 99.

Rolling Back Target Servers


Deployer.{sh|bat} --rollback -dc deployment_candidate
-project project -host host -port port -user user_name -pwd password

Parameter Description
-dc deployment_candidate Deployment candidate whose deployed assets to remove 
from the target servers.
-project project Project to which the deployment candidate belongs.

Deployer generates a rollback report. Display the rollback report as instructed in 
“Displaying a Simulation, Rollback, or Deployment Report” on page 99 and address all 
problems.

Listing Simulation, Rollback, and Deployment Reports


Deployer.{sh|bat} --list -candidate buildReport -dc deployment_candidate
-project project -host host -port port -user user_name -pwd password

Parameter Description
-dc deployment_candidate Deployment candidate whose simulation, deployment, 
and rollback reports to list.
-project project Project to which the deployment candidate belongs.

98 webMethods Deployer User’s Guide Version 7.1.1


12 Deployment Commands

Displaying a Simulation, Rollback, or Deployment Report


Deployer.{sh|bat} --showReport -candidate buildReport
-dc deployment_candidate -id integerId -project project
-host host -port port -user user_name -pwd password

Parameter Description
-dc deployment_candidate Deployment candidate whose simulation, deployment, 
or rollback report to display.
id report_identifier Identifier for the report to display. Use the --list 
command (see “Listing Simulation, Rollback, and 
Deployment Reports” on page 98) to display report 
identifiers, as well as the date and time each report was 
generated.
-project project Project to which the deployment candidate belongs.

webMethods Deployer User’s Guide Version 7.1.1 99


12 Deployment Commands

100 webMethods Deployer User’s Guide Version 7.1.1