webMethods Deployer User’s Guide

Version 9.6

April 2014
   

This document applies to webMethods Product Suite Version 9.6 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 © 2004-2014 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or
its affiliates and/or their licensors.
The name Software AG and all Software AG product names are either trademarks or registered trademarks of Software AG and/or
Software AG USA Inc. and/or its subsidiaries and/or its affiliates and/or their licensors. Other company and product names mentioned
herein may be trademarks of their respective owners.
Detailed information on trademarks and patents owned by Software AG and/or its subsidiaries is located at
hp://documentation.softwareag.com/legal/.
Use of this software is subject to adherence to Software AG's licensing conditions and terms. These terms are part of the product
documentation, located at hp://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).
This software may include portions of third-party products. For third-party copyright notices and license terms, please refer to "License
Texts, Copyright Notices and Disclaimers of Third Party Products”. This document is part of the product documentation, located at
hp://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).

Document ID: DEP-UG-96-20140610

 M  
Table of Contents

Table of Contents

About this Guide............................................................................................................................11

Document Conventions............................................................................................................ 11
Documentation Installation........................................................................................................12
Online Information.................................................................................................................... 12

Concepts......................................................................................................................................... 15
About webMethods Deployer................................................................................................... 16
Runtime-Based Deployment.....................................................................................................16
Overview of Runtime-Based Deployment......................................................................... 16
Repository-Based Deployment................................................................................................. 17
Composites........................................................................................................................ 18
Build Script........................................................................................................................ 18
Overview of Repository-Based Deployment......................................................................18
Creating Projects...................................................................................................................... 19
Deployment Sets............................................................................................................... 19
Unresolved Dependencies.................................................................................................20
Target Servers................................................................................................................... 20
Deletion Sets..................................................................................................................... 21
Mapping Projects...................................................................................................................... 21
Deploying Projects....................................................................................................................21
Checkpoint and Roll Back.................................................................................................22
Transactional Deployment................................................................................................. 22
Concurrent and Sequential Deployment........................................................................... 22
Deployer Interfaces...................................................................................................................23
Automating Project Creation.....................................................................................................24
Logging..................................................................................................................................... 25

Getting Started............................................................................................................................... 27
Getting Started with Runtime-Based Deployment....................................................................28
Getting Started with Repository-Based Deployment................................................................ 29

Building Composites for Repository-Based Deployment..........................................................31

Overview................................................................................................................................... 32
Before Building Composites..................................................................................................... 32
Adding Assets to the Source Directory............................................................................. 33
Installing the Asset Build Environment..............................................................................33
Setting the Properties for the Build.......................................................................................... 34
Setting Build Properties.....................................................................................................34
Setting VCS Checkout Properties..................................................................................... 40
Changing JVM Memory Settings.......................................................................................41
Running the Build Script and Rebuilding the Index................................................................. 42
Running the Build Script................................................................................................... 46

webMethods Deployer User’s Guide Version 9.6 3

 M  
Table of Contents

Rebuilding the Index..........................................................................................................46

Preparing BPM Assets for Repository-Based Deployment...................................................... 47
Differences Between Manual Process Generation and Deployed Processes................... 47
About the Deployment of Generation Receipts......................................................... 47
About the Redeployment of Processes......................................................................47
About the Deployment of Process Images................................................................ 48
Preparing the BPM Process Development Asset Deployment Environment.....................48
About build.xml Files.................................................................................................. 48
Configuring the Process Project build.xml File.......................................................... 49
Running the Build Script in a Process Project Directory...................................................51
Next Steps................................................................................................................................ 51

Starting Deployer and Connecting to Servers............................................................................53

Starting Deployer...................................................................................................................... 54
Connecting to webMethods Servers........................................................................................ 54
Connecting to Integration Servers and Trading Networks Servers................................... 56
Connecting to Optimize Servers....................................................................................... 57
Connecting to My webMethods Servers........................................................................... 58
Connecting to Event Servers............................................................................................ 60
Connect to Broker Servers................................................................................................61
Connect to BPM Process Model Servers......................................................................... 63
Connecting to EDA Deployment Endpoints...................................................................... 65
Connect to Business Rules Runtimes...............................................................................66
Connect to Universal Messaging Servers................................................................................ 67
Connecting to a Repository for Repository-Based Deployment............................................... 68
Editing Properties for Source and Target Servers....................................................................69
Creating Target Groups............................................................................................................ 70
Next Steps................................................................................................................................ 73

Creating and Managing Projects..................................................................................................75

Enabling or Disabling Deployer GUI Audit Logging................................................................. 76
Setting Default Properties for All Projects................................................................................77
Setting the Dependency Checking Default....................................................................... 77
Setting the Project Locking Default...................................................................................77
Setting General Deployment Defaults...............................................................................77
Setting the Defaults for Integration Server and Trading Networks Projects............................. 80
Creating a Project.....................................................................................................................83
Exporting and Importing Project Properties............................................................................. 87
Permissions for Performing Tasks in Projects..........................................................................88
Adding and Viewing Instructions or Notes About a Project......................................................90
Editing Settings for an Individual Project................................................................................. 90
Deleting a Project..................................................................................................................... 90
Next Steps................................................................................................................................ 91

Defining a Deployment Set...........................................................................................................93

Creating a Deployment Set...................................................................................................... 94

webMethods Deployer User’s Guide Version 9.6 4

 M  
Table of Contents

Identify Source Servers for the Deployment Set......................................................................95

Identifying Source Servers for Runtime-Based Deployment............................................. 95
Identifying Source Repository for Repository-Based Deployment.....................................96
Next Steps................................................................................................................................ 97

Adding Assets for Runtime-Based Deployment.........................................................................99

Before Adding Assets for Runtime-Based Deployment..........................................................100
Adding Assets to Broker, ProcessModel, MWS, or Optimize Deployment Sets..................... 100
About MWS Deployment Sets.........................................................................................100
About ProcessModel Deployment Sets...........................................................................101
Adding Assets to a Broker, ProcessModel, MWS, or Optimize Deployment Set.............101
Adding Assets to an IS & TN Deployment Set...................................................................... 102
Deploying ACLs...............................................................................................................102
Deploying ACLs Associated with My webMethods Server Groups.......................... 102
Deploying ACLs Associated with LDAP Groups...................................................... 103
Adding Integration Server Administration Assets............................................................103
Adding Integration Server Packages...............................................................................103
Adding an Entire Package....................................................................................... 104
Adding Package Components..................................................................................104
Adding Package Files.............................................................................................. 105
Setting Package Properties......................................................................................106
Adding webMethods Files............................................................................................... 109
Adding Trading Networks Assets.................................................................................... 110
Excluding Common Assets............................................................................................. 110
Resolving Dependencies........................................................................................................ 111
Manually Adding Dependencies to a Package Component in an IS & TN Deployment Set... 113
Removing Process Models from a Deployment Set.............................................................. 113
Next Steps.............................................................................................................................. 114

Adding Assets for Repository-Based Deployment.................................................................. 115

Overview................................................................................................................................. 116
Selecting Composites............................................................................................................. 116
Selecting Individual Assets from Composites........................................................................ 117
Resolving Dependencies........................................................................................................ 117
Resolving Dependencies Automatically.......................................................................... 118
Resolving Dependencies Manually................................................................................. 119
Resolving Conflicts................................................................................................................. 121
Deploying ACLs...................................................................................................................... 122
Deploying ACLs Associated with My webMethods Server Groups................................. 122
Deploying ACLs Associated with LDAP Groups............................................................. 122
Next Steps.............................................................................................................................. 122

Defining a Deletion Set............................................................................................................... 125

About Deletion Sets................................................................................................................126
Creating a Deletion Set.......................................................................................................... 126
Identifying Servers.................................................................................................................. 128

webMethods Deployer User’s Guide Version 9.6 5

 M  
Table of Contents

Identifying Servers for a Runtime-Based Deletion Set....................................................128

Identifying Servers for a Repository-Based Deletion Set................................................ 129
Adding Assets to a Deletion Set............................................................................................ 129
Adding Assets to a Runtime-Based Deletion Set............................................................129
Adding Assets to a Repository-Based Deletion Set........................................................130
Adding Packages to Deletion Sets..................................................................................130
Resolving Dependencies in Repository-Based Deletion Sets................................................ 132
Exporting and Importing Deletion Set Definitions...................................................................132
Next Steps.............................................................................................................................. 133

Building a Runtime-Based Deployment Project....................................................................... 135

Creating a Build......................................................................................................................136
Rebuilding a Build.................................................................................................................. 137
Exporting and Importing a Build.............................................................................................137
Next Steps.............................................................................................................................. 138

Mapping a Project........................................................................................................................139
About Mapping a Project........................................................................................................140
Mapping a Project to Target Servers and Target Groups.......................................................140
Exporting and Importing a Map..............................................................................................143
Substituting Configuration Values...........................................................................................144
Substituting Configuration Values by Asset.................................................................... 145
Substituting Configuration Values by Target Server (Runtime-Based)............................ 145
Substituting Configuration Values by Target Server (Repository-Based)........................ 146
Exporting and Importing Substitute Configuration Values...................................................... 146

Deploying a Project..................................................................................................................... 149

Overview................................................................................................................................. 150
Preparing Integration Server to Stream Large Repository-Based Projects............................ 150
Generating a Checkpoint........................................................................................................151
Generating an Automatic Checkpoint............................................................................. 151
Generating a Checkpoint Manually................................................................................. 151
Deploying a Project................................................................................................................ 152
Post-Deployment Tasks.......................................................................................................... 155
Rolling Back Target Servers...................................................................................................155
Rolling Back Target Servers Automatically..................................................................... 155
Rolling Back Target Servers Manually............................................................................ 156

Using Deployer Commands........................................................................................................159

Overview................................................................................................................................. 160
Installing Command Line Interface Only................................................................................ 160
Creating and Running Scripts................................................................................................ 160
Specifying Log On Parameters.............................................................................................. 163
Creating a Configuration File for Log On Parameters.....................................................165
Error Handling and Logging................................................................................................... 165
General and Project Commands............................................................................................ 166

webMethods Deployer User’s Guide Version 9.6 6

 M  
Table of Contents

About................................................................................................................................166
Deleting a Project............................................................................................................166
Displaying Project Properties.......................................................................................... 166
Exporting Deletion Sets from a Project...........................................................................166
Importing Deletion Set Definitions into a Project............................................................ 167
Exporting Project Properties............................................................................................168
Importing Project Properties............................................................................................168
Help..................................................................................................................................169
Listing Builds, Maps, or Deployment Candidates for a Project....................................... 169
Locking Projects.............................................................................................................. 170
Unlocking Projects...........................................................................................................170
Build Commands.................................................................................................................... 170
Creating a Project Build.................................................................................................. 170
Listing Builds for a Project.............................................................................................. 171
Displaying Contents of a Build........................................................................................171
Displaying Substitute Configuration Values for Integration Server Assets in a Build....... 171
Displaying Contents of a Build File.................................................................................172
Displaying Substitute Configuration Values for Integration Server Assets in a Build
File................................................................................................................................... 172
Exporting a Build from a Project..................................................................................... 173
Importing a Build File into a Project................................................................................173
Listing Build Reports....................................................................................................... 174
Displaying a Build Report................................................................................................174
Commands for Repository-Based Deployment...................................................................... 175
Rebuilding the Index with the Build Script...................................................................... 175
Map Commands..................................................................................................................... 176
Listing All Deployment Maps...........................................................................................176
Exporting a Deployment Map from a Project.................................................................. 176
Editing a Deployment Map, Project Properties, or Substitute Configuration Values........176
Importing a Deployment Map Into a Project................................................................... 177
Exporting Substitute Configuration Values for Integration Server Assets from a
Deployment Map............................................................................................................. 178
Importing Substitute Configuration Variables for Integration Server Assets into a
Deployment Map............................................................................................................. 178
Deleting a Deployment Map from a Project....................................................................179
Deployment Commands......................................................................................................... 180
Creating a Deployment Candidate.................................................................................. 180
Displaying Information About a Deployment Candidate..................................................180
Deleting a Deployment Candidate.................................................................................. 181
Generating a Checkpoint.................................................................................................181
Simulating a Deployment................................................................................................ 182
Deploying......................................................................................................................... 182
Rolling Back Target Servers............................................................................................183
Listing Simulation, Rollback, and Deployment Reports.................................................. 183
Displaying a Simulation, Rollback, or Deployment Report..............................................184

webMethods Deployer User’s Guide Version 9.6 7

 M  
Table of Contents

Automating Project Creation...................................................................................................... 185

Overview................................................................................................................................. 186
Exporting Projects for Use in Project Automator....................................................................186
Using Handles Instead of Passwords.................................................................................... 187
Creating Password Handles............................................................................................187
Modifying Password Handle Associations.......................................................................188
Deleting Password Handles............................................................................................ 188
Error Handling and Logging................................................................................................... 189
Root Tag................................................................................................................................. 189
Identifying Deployer................................................................................................................ 190
Setting Up Aliases for Source and Target Servers................................................................ 190
Setting Up Aliases for Source Repositories.................................................................... 191
Setting Up Aliases for Source and Target webMethods Brokers.................................... 192
Setting Up Aliases for Source and Target Process Model Servers................................. 197
Setting Up Aliases for Source and Target Integration Servers........................................198
Setting Up Aliases for Source and Target My webMethods Servers...............................200
Setting Up Aliases for Source and Target Optimize Servers.......................................... 203
Setting Up Aliases for Target Event Servers...................................................................204
Setting Up Aliases for Target EDA Deployment Endpoints.............................................206
Setting Up Aliases for Target Business Rules Runtimes................................................ 207
Setting Up Aliases for Target Universal Messaging Servers...........................................209
Setting Up Aliases for Target Groups............................................................................. 210
Creating Projects.................................................................................................................... 212
Defining Deployment and Deletion Sets for Runtime-Based Deployment.......................213
Defining a Deployment Set for Repository-Based Deployment.......................................216
Defining a Deletion Set for Repository-Based Deployment............................................ 220
Building a Project for Runtime-Based Deployment......................................................... 220
Mapping a Project........................................................................................................... 221
Mapping a Runtime-Based Project................................................................................. 221
Mapping a Repository-Based Project..............................................................................223
Creating a Deployment Candidate for Runtime-Based Deployment............................... 224
Creating a Deployment Candidate for Repository-Based Deployment........................... 225
Running Project Automator.................................................................................................... 226

Deploying Process Models with E-Forms.................................................................................227

Deploying Process Models with E-Forms.............................................................................. 228

Deploying Optimize Assets........................................................................................................ 229

Overview................................................................................................................................. 230
Disabling Automatic Execution of DDL Statements............................................................... 230
Deploying Optimize Assets in Static DB Schema Mode........................................................ 231
Optimize Deployment Usage Notes....................................................................................... 232
Potential Problems...........................................................................................................233
Deployer Batch Size.................................................................................................233
Removing Assets from a Deployment Set............................................................... 233

webMethods Deployer User’s Guide Version 9.6 8

 M  
Table of Contents

Two or More Deployment Sets for the Same Analytic Engine Using One Deployment
Map...........................................................................................................................233
Executing DDL Statements for Two or More Analytic Engines......................... 234

Deploying to Clustered Integration Servers............................................................................. 235

Overview................................................................................................................................. 236
Setting Up Connections to Integration Servers in the Cluster................................................236
Creating the Target Group......................................................................................................237

Deployable Assets....................................................................................................................... 239

BPM Process Development Assets........................................................................................240
Broker Assets......................................................................................................................... 241
Business Rules Assets........................................................................................................... 242
EDA Assets.............................................................................................................................243
Event Server Assets...............................................................................................................244
Integration Server Assets....................................................................................................... 245
Integration Server Administrative Assets........................................................................ 246
Adding Administrative Assets to the Source Directory.............................................246
Global Values for Integration Server Administrative Assets.....................................251
Integration Server Administrative Assets and Substitution Values...........................253
ACLs..................................................................................................................253
Broker Settings..................................................................................................253
Cache Manager.................................................................................................255
Certificate Settings............................................................................................ 256
Client Certificates.............................................................................................. 256
CSRF Guard Configuration............................................................................... 256
webMethods Enterprise Gateway Configuration...............................................257
Extended Settings............................................................................................. 258
File Access Control Configuration.....................................................................258
Global Variables................................................................................................ 259
Groups...............................................................................................................259
JDBC Driver Alias............................................................................................. 259
JDBC Pool Alias Configuration......................................................................... 259
JDBC Functional Alias...................................................................................... 260
JMS Connection Alias.......................................................................................260
JNDI Alias..........................................................................................................261
Keystore Alias................................................................................................... 262
LDAP Configuration...........................................................................................263
Metadata............................................................................................................264
Enhanced Parser...............................................................................................264
Ports.................................................................................................................. 265
Proxy server alias............................................................................................. 269
Proxy Server Bypass........................................................................................ 270
Reliable Messaging Configuration.................................................................... 270
Remote Server Alias......................................................................................... 273
SAML Token Issuer...........................................................................................273

webMethods Deployer User’s Guide Version 9.6 9

 M  
Table of Contents

Scheduled Tasks............................................................................................... 274

SFTP Server Alias............................................................................................ 275
SFTP User Alias............................................................................................... 275
Truststore Alias................................................................................................. 277
Users................................................................................................................. 278
Web Service Endpoint Alias..............................................................................278
Web Service Policy........................................................................................... 280
Integration Server Administrative Asset Dependencies........................................... 280
Integration Server Package Assets.................................................................................281
About Integration Server Packages......................................................................... 281
Adding Package Assets to the Source Directory..................................................... 282
Global Values for Integration Server Package Assets and Composites...................283
Individual Values for Integration Server Package Assets.........................................286
Adapter Runtime and .NET Service Assets.................................................................... 288
Adding Adapter Runtime and .NET Service Assets to the Source Directory............288
Adapter Runtime Assets.......................................................................................... 288
Adapter Runtime Asset Dependencies.................................................................... 291
.NET Asset............................................................................................................... 291
My webMethods Server Assets..............................................................................................292
Optimize Assets......................................................................................................................297
Trading Networks Assets........................................................................................................298
Universal Messaging Assets.................................................................................................. 299
Other Assets........................................................................................................................... 301

webMethods Deployer User’s Guide Version 9.6 10

 M  
Odd Header

About this Guide

This guide explains how to use webMethods Deployer to deploy assets from source
webMethods servers or development environments to target webMethods servers.

Document Conventions

Convention Description

Bold Identifies elements on a screen.

Narrowfont Identifies storage locations for services on webMethods

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

UPPERCASE Identifies keyboard keys. Keys you must press simultaneously

are joined with a plus sign (+).

Italic Identifies variables for which you must supply values specific to
your own situation or environment. Identifies new terms the first
time they occur in the text.

Monospace Identifies text you must type or messages displayed by the

font system.

{} Indicates a set of choices from which you must choose one. Type
only the information inside the curly braces. Do not type the { }
symbols.

| Separates two mutually exclusive choices in a syntax line. Type

one of these choices. Do not type the | symbol.

[] Indicates one or more options. Type only the information inside

the square brackets. Do not type the [ ] symbols.

... Indicates that you can type multiple options of the same type.
Type only the information. Do not type the ellipsis (...).

webMethods Deployer User’s Guide Version 9.6 11

 M  
Even Header

Documentation Installation
You can download the product documentation using the Software AG Installer. The
documentation is downloaded to a central directory named _documentation in the main
installation directory (SoftwareAG by default).

Online Information
You can find additional information about Software AG products at the locations listed
below.

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

Access the latest version of product Software AG Documentation website

documentation.
hp://
documentation.softwareag.com

Find information about product releases Empower Product Support website

and tools that you can use to resolve
hps://empower.softwareag.com
problems.
See the Knowledge Center to:
Read technical articles and papers.
Download fixes and service packs (9.0
SP1 and earlier).
Learn about critical alerts.
See the Products area to:
Download products.
Download certified samples.
Get information about product
availability.
Access older versions of product
documentation.
Submit feature/enhancement requests.

Access additional articles, demos, and Software AG Developer Community for

tutorials. webMethods

webMethods Deployer User’s Guide Version 9.6 12

 M  
Odd Header

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

Obtain technical information, useful hp://

resources, and online discussion forums, communities.softwareag.com/
moderated by Software AG professionals,
to help you do more with Software AG
technology.
Use the online discussion forums to
exchange best practices and chat with
other experts.
Expand your knowledge about product
documentation, code samples, articles,
online seminars, and tutorials.
Link to external websites that discuss
open standards and many web
technology topics.
See how other customers are streamlining
their operations with technology from
Software AG.

webMethods Deployer User’s Guide Version 9.6 13

 M  
Even Header

webMethods Deployer User’s Guide Version 9.6 14

 M  
Odd Header

1   Concepts
■ About webMethods Deployer ....................................................................................................... 16
■ Runtime-Based Deployment ........................................................................................................ 16
■ Repository-Based Deployment ..................................................................................................... 17
■ Creating Projects .......................................................................................................................... 19
■ Mapping Projects ......................................................................................................................... 21
■ Deploying Projects ....................................................................................................................... 21
■ Deployer Interfaces ...................................................................................................................... 23
■ Automating Project Creation ........................................................................................................ 24
■ Logging ......................................................................................................................................... 25

webMethods Deployer User’s Guide Version 9.6 15

 M  
Even Header

About webMethods Deployer

webMethods Deployer is a tool you use to deploy user-created assets that reside on
sourcewebMethods runtimes or repositories to target webMethods runtime components
(runtimes). For example, you might want to deploy assets you have developed on
servers in a development environment (the source) to servers in a test or production
environment (the target).

Important: You can deploy user-created assets using Deployer. You cannot deploy
webMethods components that have been installed by the Software AG Installer as part
of a product. For example, you can deploy Integration Server packages that have been
created by users, but you cannot deploy Integration Server packages that were installed,
such as WmPRT. If you want such components to reside on target runtimes, you must
install them using the Software AG Installer.

Deployer supports two scenarios for deploying assets:

In a runtime-based deployment scenario, Deployer deploys assets from webMethods
runtimes to which Deployer is connected.
In a repository-based deployment scenario, Deployer deploys assets built from sources
in a development environment or VCS and stored on a repository.

Runtime-Based Deployment
In runtime-based deployment, you deploy assets directly from webMethods source
runtimes to target runtimes.
You can deploy assets from and to these webMethods runtimes:
webMethods Brokers.
BPM (ProcessModel) runtimes. A ProcessModel runtime is an Integration Server that
hosts the webMethods Process Engine and executes business processes.
Integration Servers, including hosts for Trading Networks Servers.
My webMethods Server.
Optimize runtimes. An Optimize runtime is an Optimize Analytic Engine.

Overview of Runtime-Based Deployment

The runtime-based deployment process involves the following basic stages:

Stage 1 Define a deployment project.

webMethods Deployer User’s Guide Version 9.6 16

 M  
Odd Header

You use Deployer to create connections to target and source

webMethods runtimes. You then define a deployment set, for which
you select user-created assets to include in the project directly from
source webMethods runtimes.
For more information about projects and deployment sets, see "Creating
Projects" on page 19.

Stage 2 Build the project.

You build your project for deployment to the target runtimes. When
you build a project, Deployer creates 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 runtimes,
you can re-create the build to bring it up to date.

Stage 3 Map the contents of the project build to target runtimes.

For more information, see "Mapping Projects" on page 21.

Stage 4 Deploy the assets in the project build to the target runtimes.
For more information, see "Deploying Projects" on page 21.

For a more specific list of tasks involved in the runtime-based deployment process, see
"Geing Started with Runtime-Based Deployment" on page 28.

Repository-Based Deployment
In repository-based deployment, you build the assets from your development
environment or version control system (VCS) and store them on a repository. The
repository is a specific directory structure to which you map Deployer. Deployer
deploys the assets contained in the repository to target servers, target groups, or both.
You can use repository-based deployment to deploy assets from the following kinds of
webMethods runtimes to target servers:
BPM Process Development
Broker
Business Rules
EDA
Event Server

Note: Deployer supports deployment of assets to Event Servers of version 9.5 or

earlier only.

webMethods Deployer User’s Guide Version 9.6 17

 M  
Even Header

Integration Server
My webMethods Server
Optimize
Trading Networks
Universal Messaging

Composites
Composites are compressed files that contain the definitions of the assets and their
dependencies you build in a development environment. Each composite defines assets
from one webMethods runtime type. You build the assets into the composite file during
the build process and store them in a repository for deployment.
Deployer can use the assets from several different composites (and webMethods runtime
types) to construct a deployment set. The assets in each composite file retain the same
relationships they share in the development environment.
The build process that creates the composites for your assets also creates an Asset
Composite Definition Language (ACDL) descriptor (descriptor) for each composite.
The descriptor is an XML schema that serves as a manifest for each composite and
describes all of the assets included in the composite file. Deployer reads the descriptor to
determine which assets are present in each composite.

Build Script
In repository-based deployment, you use a build script (build.xml) to build composites
and their associated descriptors from the development environment. The build
properties file (build.properties) contains the seings the build script uses to build the
assets.
For more information about seing build seings and running the build script, see
"Building Composites for Repository-Based Deployment" on page 31.

Overview of Repository-Based Deployment

The following graphic illustrates the asset deployment process in repository-based
deployment:

The repository-based deployment process involves the following basic stages:

webMethods Deployer User’s Guide Version 9.6 18

 M  
Odd Header

Stage 1 Create assets on your development environment.

Developers create assets in the development environment and save
them on a server, or check them into a version control system (VCS).

Stage 2 Build the composites and descriptors.

You use the master build script to build the composite and descriptor
files from the assets. You store these files in the repository.

Stage 3 You use Deployer to do the following:

1. Define a deployment project and deployment sets. You select user-created
assets from the ACDL composite stored on the repository to identify
the assets to include in the project. For more information about
deployment projects, see "Creating Projects" on page 19. For more
information about deployment sets, see "Deployment Sets" on page
19.
2. Map the contents of the deployment project to target servers. For more
information, see "Mapping Projects" on page 21.
3. Deploy the assets in the project build to the target servers. For more
information, see "Deploying Projects" on page 21.

For a more specific list of tasks you perform in the repository-based deployment process,
see "Geing Started with Repository-Based Deployment" on page 29.

Creating Projects
A deployment project identifies the user-created assets on source servers (for runtime-
based deployment) or a repository (for repository-based deployment) 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.
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.

Deployment Sets
You identify the assets to include in the project using deployment sets. Each deployment
set identifies the user-created assets you want to deploy from one type of source server
or repository to a target server.

webMethods Deployer User’s Guide Version 9.6 19

 M  
Even Header

A single project can include deployment sets with assets from different types of
webMethods applications. For example, a single project can include Integration Server
deployment sets and ProcessModel deployment sets.

Note: A project can contain deployment sets whose assets were selected from only one of
the following:
Source webMethods runtime types (for runtime-based deployment)
A composite in a repository (for repository-based deployment)
A project cannot contain both types of deployment sets.

Unresolved Dependencies
If assets in your deployment set depend on assets that are not part of the deployment
set, Deployer identifies these missing assets as unresolved dependencies. For example, if
you add a trigger to an Integration Server deployment set, but do not add the service
that is invoked by the trigger, Deployer identifies the missing service as an unresolved
dependency. Deployer enables you to resolve unresolved dependencies.

Target Servers
To control to which targets assets are deployed, you define target servers. You define
target servers according to the kind of assets you want to deploy. For example, if you
wanted to deploy Integration Server assets to one set of target Integration Servers, you
could define a single deployment set that identifies those assets.

To deploy some Integration Server assets to one set of target Integration Servers and
other Integration Server assets to a second set of target Integration Servers, you must
define two different deployment sets.

webMethods Deployer User’s Guide Version 9.6 20

 M  
Odd Header

Deletion Sets
Deployment projects that contain deployment sets whose assets were selected from
source webMethods servers or repositories can also contain a deletion set for each target
server. A deletion set lets you specify user-created assets to delete from the target
server before you deploy the assets in the project's deployment sets. You can also export
deletion set definitions from one project and import them into another.

Mapping Projects
In a deployment map, you identify target servers and target groups for each deployment
set in a project. You can create multiple deployment maps for each project build (for
example, if you are deploying to multiple environments).

Deploying Projects
To deploy a project, you first create a deployment candidate, which is a combination of a
deployment set and a deployment map. For runtime-based deployment projects, the
deployment candidate also includes the project build. Deployer does the following when
you deploy the project:

webMethods Deployer User’s Guide Version 9.6 21

 M  
Even Header

For projects that include deletion sets, Deployer deletes the identified assets from the
target servers.
Copies the contents of each deployment set in the deployment candidate's project to
the target servers identified in the deployment candidate's deployment map.
Creates a deployment report that lists all actions that occurred during deployment.
For an IS & TN deployment set for which you specified substitute configuration
values, Deployer substitutes those values during deployment.

Checkpoint and Roll Back

If a deployment to a target server 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.
For deployment sets, you create a checkpoint to which you want to roll back the target
server before you deploy. The checkpoint contains a copy of the assets on the target
server that will be replaced by the assets in the deployment sets.
The roll back feature rolls back the target server to the checkpoint. If the deployment sets
added assets to the target servers, the roll back removes them.
You can set Deployer to automatically create a checkpoint and roll back deployment sets
when deployment fails. For deletion sets, Deployer automatically creates the checkpoint
for the target server. If deployment fails, Deployer automatically rolls back the target
server.
For more information about seing project checkpoints and roll back seings, see "
Seing General Deployment Defaults" on page 77.

Transactional Deployment
For repository-based deployment, you can deploy assets and composites using
transactional deployment. When transactional deployment is enabled, Deployer
automatically creates the checkpoint for the target server when you deploy the
deployment set. If deployment fails, Deployer automatically rolls back all of the target
servers to the state they were in when Deployer created the checkpoint. For more
information about seing transactional deployment, see " Creating a Project" on page
83.

Concurrent and Sequential Deployment

Deployer supports both sequential and concurrent asset deployment.
In a concurrent deployment, Deployer uses the host Integration Server thread pool to
create a separate thread in order to deploy the assets to all target servers simultaneously.
This is the default seing. You should configure the minimum and maximum threads in
the pool to accommodate your system. For more information about seing the minimum

webMethods Deployer User’s Guide Version 9.6 22

 M  
Odd Header

and maximum thread pools, see webMethods Integration Server Administrator’s Guide.
Deployer writes records to the Audit Log to indicate that the main deployment thread
has created new deployment threads for the specific target server. This allows you to
track which thread belongs to each deployment request.
In a sequential deployment, Deployer deploys the assets to all target servers one by one
in the order that the targets were added to the deployment map. If the project is not set
to use concurrent deployment, Deployer deploys assets sequentially.
You can set concurrent deployment for all projects in the system when you set the
default seings for Deployer as described in " Seing General Deployment Defaults"
on page 77. If the default seing is set to sequential deployment and you want to
use concurrent deployment for a specific project (or vice versa), you can override the
default seing for that project during creation. For more information about overriding
the default seings for a project, see " Creating a Project" on page 83.

Deployer Interfaces
Deployer offers a graphical user interface (GUI), a command line interface, and a
Project Automator tool. Using the command line interface you can enter commands at
a command prompt or you can create scripts that execute commands automatically.
The Project Automator allows you to specify project information in an XML file for
automated project creation.
The table below shows which tasks you can perform from each type of Deployer
interface.

Task GUI Command Project

Line Automator

Add and view instructions or notes about X

projects.

Authorize groups to work on projects. X

Configure communication between Deployer X X

and the source servers or repositories and
target servers.

Create project builds. X X X

Create projects. X X

Define deployment and deletion sets. X X

webMethods Deployer User’s Guide Version 9.6 23

 M  
Even Header

Task GUI Command Project

Line Automator

Delete projects and set default properties for X X

projects

Export and import project properties and X X

deletion set definitions.

Generate a checkpoint or roll back target X X

servers, list and display rollback reports.

Generate progress reports. X

List, create, display, or delete deployment X X

candidates; simulate deployments; deploy;
list and display simulation and deployment
reports.

List, display, export, import, and delete X X

deployment maps.

List, export, and import builds; display build X X

contents; list and display build reports.

Map deployment and deletion sets to target X X

servers.

Select assets from an ACDL descriptor file X X X

Automating Project Creation

Deployer enables you to automate the following:
Creation of projects.
Definition of aliases for source servers and repositories and target servers.
Creation of deployment and deletion sets.
Creation of builds, maps, and deployment candidates.
You provide the necessary specifications in an XML file, then run Deployer's Project
Automator tool. Optionally, you can export projects created in the GUI to an XML

webMethods Deployer User’s Guide Version 9.6 24

 M  
Odd Header

file. For more information about the Project Automator tool, see "Automating Project
Creation" on page 185.

Logging
Deployer writes audit log entries to these logs:
The Deployer GUI audit log. This log contains information about actions that users
perform through the Deployer GUI, such as creating builds and deploying.
The Deployer command line audit log. This log contains error messages wrien by
Deployer commands executed by users.
The Deployer Project Automator audit log. This log contains information and error
messages wrien by the Project Automator during execution of an XML file.
Deployer writes journal 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. For complete information about the Integration Server
server log, see webMethods Integration Server Administrator’s Guide.

webMethods Deployer User’s Guide Version 9.6 25

 M  
Even Header

webMethods Deployer User’s Guide Version 9.6 26

 M  
Odd Header

2   Getting Started
■ Getting Started with Runtime-Based Deployment ....................................................................... 28
■ Getting Started with Repository-Based Deployment .................................................................... 29

webMethods Deployer User’s Guide Version 9.6 27

 M  
Even Header

Getting Started with Runtime-Based Deployment

You will perform the following general tasks to deploy assets in a runtime-based
deployment scenario:

Task See...

Start Deployer. "Starting Deployer " on page 54

Set up connections to source and "Connecting to Integration Servers and

target servers. Trading Networks Servers" on page 56
"Connecting to Optimize Servers" on page
57
"Connecting to My webMethods Servers" on
page 58
"Connecting to Event Servers" on page 60
"Connect to Broker Servers" on page 61
"Connect to BPM Process Model Servers" on
page 63
"Connect to Business Rules Runtimes" on page
66
" Creating Target Groups" on page 70

Create a project. "Creating and Managing Projects" on page

75

Define deployment set. "Defining a Deployment Set" on page 93

Add assets to the deployment "Adding Assets for Runtime-Based

set. Deployment" on page 99

Define deletion set (optional). "Defining a Deletion Set" on page 125

Build the project. "Building a Runtime-Based Deployment

Project" on page 135

Map assets to target servers and "Mapping a Project" on page 139

target groups.

webMethods Deployer User’s Guide Version 9.6 28

 M  
Odd Header

Task See...

Deploy the project. "Deploying a Project" on page 149

Getting Started with Repository-Based Deployment

You will perform the following general tasks to deploy assets in a repository-based
deployment scenario:

Task See...

Build composites on your "Building Composites for Repository-Based

repository. Deployment" on page 31

Start Deployer. "Starting Deployer " on page 54

Set up connections to the source "Connecting to a Repository for Repository-

repository and target servers. Based Deployment" on page 68
"Connecting to Integration Servers and
Trading Networks Servers" on page 56
"Connecting to Optimize Servers" on page
57
"Connecting to My webMethods Servers" on
page 58
"Connecting to Event Servers" on page 60
"Connect to Broker Servers" on page 61
"Connect to BPM Process Model Servers" on
page 63
"Connect to Business Rules Runtimes" on page
66

Create a project. "Creating and Managing Projects" on page

75

Define a deployment and "Defining a Deployment Set" on page 93

deletion sets.
"Defining a Deletion Set" on page 125

Add assets to the deployment "Adding Assets for Repository-Based

set. Deployment" on page 115

webMethods Deployer User’s Guide Version 9.6 29

 M  
Even Header

Task See...

Map assets to target servers or "Mapping a Project" on page 139

target groups.

Deploy the project. "Deploying a Project" on page 149

webMethods Deployer User’s Guide Version 9.6 30

 M  
Odd Header

3   Building Composites for Repository-Based

Deployment

■ Overview ....................................................................................................................................... 32
■ Before Building Composites ......................................................................................................... 32
■ Setting the Properties for the Build ............................................................................................. 34
■ Running the Build Script and Rebuilding the Index ..................................................................... 42
■ Preparing BPM Assets for Repository-Based Deployment .......................................................... 47
■ Next Steps .................................................................................................................................... 51

webMethods Deployer User’s Guide Version 9.6 31

 M  
Even Header

Overview
The build process for repository-based deployment involves the following basic stages:

Stage 1 Create the assets and export or copy them from the source development
platform to the source directory.
Developers create the assets on the development environment and
export or copy them to a file system or version control system (VCS)
from which the build process can obtain them. This guide assumes
that the assets have already been created. For more information about
creating and exporting assets, see the documentation for the applicable
webMethods runtime. For more information about adding assets to the
source directory, see "Adding Assets to the Source Directory" on page
33.

Stage 2 Install the webMethods Asset Build Environment on the build machine.
The Asset Build Environment supplies the scripts and libraries
necessary to build assets into composites that Deployer then deploys to
target servers and groups. For more information about the Asset Build
Environment, see "Installing the Asset Build Environment" on page
33. For information about installing the Asset Build Environment,
see Installing webMethods and Intelligent Business Operations Products.

Stage 3 Specify the parameters of the build.

Modify the build.properties file to define the parameters used by the
master build script to build composites. For more information, see
"Seing the Properties for the Build" on page 34.

Stage 4 Run the master build script.

You run the master build script to package your assets into composites
for deployment. For more information, see "Running the Build Script
and Rebuilding the Index" on page 42.

Important: If you are building a single BPM process project folder, follow
the procedure described in "Preparing the BPM Process Development
Asset Deployment Environment" on page 48.

Before Building Composites

Building composites for repository-based deployment requires that you do the
following:

webMethods Deployer User’s Guide Version 9.6 32

 M  
Odd Header

Create the assets you want to deploy and add them to a file system or VCS that is
accessible to build scripts.
Install the webMethods Asset Build Environment version 8.2 SP1 or greater.

Adding Assets to the Source Directory

In repository-based deployment scenarios, you create assets with a webMethods
runtime and store them in a file system or version control system (VCS). The directory of
the file system or VCS in which you store the assets is the source directory.
Most webMethods runtimes supply a means of exporting or saving the assets you
create to the source directory. Other runtimes require you to manually copy the assets
from one directory to another. For example, you can use My webMethods Server to
export Broker assets to the source directory. However, to add mostIntegration Server
administrative assets to the source directory, you must manually copy or check in the
Integration Server_directory/config folder to the source directory. For a complete list of
files and directories to copy or check in to the source directory for Integration Server
administrative assets, see "Adding Administrative Assets to the Source Directory" on
page 246.
When specifying the properties for the build.properties file, you use the build.source.dir
parameter to specify the full path of each source directory. Then, when you run the
build script, it packages the contents of the source directories into the correct composite
file format for deploying those assets to target servers. For more information about
specifying parameters for the build.properties file, see "Seing the Properties for the
Build" on page 34. For more information about the composite files created the build
script, see "Running the Build Script and Rebuilding the Index" on page 42.
Keep the following points in mind while adding assets to the source directory:
The source directory must be accessible to the build script.
If the source directory is a file system on a VCS, you must supply the proper
credentials for accessing and checking out the composite files from the source
directory. For more information about supplying the VCS checkout properties, see
"Seing VCS Checkout Properties" on page 40.

Installing the Asset Build Environment

To build composites for deployment, you must first install the webMethods Asset Build
Environment. The Asset Build Environment installs the build script and build properties
file that you use to build deployment composites for webMethods runtimes.
For testing purposes, you can install the Asset Build Environment on the computer that
you use to create assets in the development environment. For daily or continuous builds,
you should install the Asset Build Environment on a separate computer, known as a
build machine. The build machine is the computer on which you build the assets into
components that Deployer can deploy to target servers.

webMethods Deployer User’s Guide Version 9.6 33

 M  
Even Header

For information about installing the Asset Build Environment, see Installing webMethods
and Intelligent Business Operations Products.

Setting the Properties for the Build

The Asset Build Environment installs the following files that you can customize to
provide the build script the properties it needs to build composites for repository-based
deployment:
build.properties. Set the properties in this file before running the build script. For
more information about seing the properties in build.properties, see "Seing Build
Properties" on page 34.
build-number.xml. The build script uses this file to automatically version the assets
included in the build incrementally. You can customize the file to generate the build
number as needed (example, to match the VCS revision number).
build-source-checkout.xml. If the build source directory is a version control system, you
can use this file as a template to create an Ant task that checks out sources from a
version control system (VCS). For information about seing the properties in build-
source-checkout.xml, see "Seing VCS Checkout Properties" on page 40.
build.bat or build.sh. When building assets that are large in number or size, you should
increase the Java memory available to the build process. For more information about
adjusting Java memory seings, see "Changing JVM Memory Seings" on page
41.

Important: When you overinstall later releases of the Asset Build Environment, your
changes to these files are retained. You do not need to move the files unless you
uninstall and reinstall the Asset Build Environment.

The Software AG Installer installs all three files in the following location as part of the
Asset Build Environment:
Software AG_directory\common\AssetBuildEnvironment\master_build

Setting Build Properties

The master properties file, build.properties, controls the build seings for the repository-
based build process. It contains a set of switches that enable and disable the build tasks
for the corresponding runtime types in the build.

To set the build properties

1. Open the following file in a text editor:
Software AG_directory\common\AssetBuildEnvironment\master_build
\build.properties
2. Set the following properties:

webMethods Deployer User’s Guide Version 9.6 34

 M  
Odd Header

Property Definition

sag.install.dir Path of the directory where Software AG products

are installed.

build.output.dir Root directory where the build script will place the
output (composites and descriptors) of the build.
Use a forward slash "/" as path separator.
The build script creates a subdirectory with the
current build number in this directory, as well as a
subdirectory for the composites and descriptors for
each runtime type included in the build as follows:

If your build contains assets The build script

from... creates the following
subdirectory...

BPM Process BPM

Development

Broker Broker

Business Rules Rules

EDA EDA

Integration Server IS

My webMethods Server MWS

Optimize Optimize

Trading Networks TN

Universal Messaging UniversalMessaging

build.source.dir Separated list of the full paths of the source

directories that contain assets to build. All
directories in the list must contain project
directories (IS packages, CAF projects, TN exports,
etc.) as direct children. Use “;” as the delimiter for
more than one folder. Use a forward slash “/” as
path separator.

webMethods Deployer User’s Guide Version 9.6 35

 M  
Even Header

Property Definition

For example, if you want to include Integration

Server and Trading Networks assets, you would
enter the following:
/root_path /project_name /IS;/root_path /project_name /
TN
Where root_path is the root directory of the source,
project_name /IS is the directory holding Integration
Server assets, and project_name /TN is the directory
holding Trading Networks assets.

build.source.project.dir Separated list of project folders containing the

assets that the build script will build. All folders
in the list must contain project folders only. This
property is different from the build.source.dir as
it defines individual project directories
Use “;” as delimiter for more than one folder. Use a
forward slash “/” as path separator.

Note: If you are building an Integration Server project

and specify a value for this property, you must also
specify a value for is.acdl.config.dir.

enable.archive Specifies whether the build script archives the

output directory. If you set this field to true, you
must provide a value for build.archive.dir.

build.archive.dir Required if enable.archive is set to true. Location

of the archive directory for the output. The build
script creates a new subdirectory with the name of
the build number. It then moves the contents of the
output directory (set in build.output.dir) to this
newly created directory.

build.version Version number of the current build. The build

script appends an automatically-generated
incremental build number to this property to get the
final build number.
For example, if you set this property to 8.2, the
generated build number for the first build is 8.2.1
and the build number for the next build is 8.2.2.

webMethods Deployer User’s Guide Version 9.6 36

 M  
Odd Header

Property Definition

enable.checkout Specifies whether the build script should check out

the source files from a VCS.
To enable the check out task, set to true. The build
script invokes the default target you set in build-
source-checkout.xml.
To disable check out task, set to false.

Note: If this property is set to true, you must configure

the properties in build-source-checkout.xml to
synchronize with your VCS system. For more
information, see "Seing VCS Checkout Properties"
on page 40.

enable.build Specifies the runtime types for which the build

script should build composites. Each runtime type
has a separate property. Set to:
true to build composites for the specified runtime
type.
false to exclude the specified runtime type.

Set this property... To build composites for

assets of this type...

enable.build.IS Integration Server

enable.build.MWS My webMethods
Server

enable.build.BPM BPM Process

Development

enable.build.TN Trading Networks

enable.build.Optimize Optimize

enable.build.Broker Broker

enable.build.EDA EDA

enable.build.RULES Business rules

webMethods Deployer User’s Guide Version 9.6 37

 M  
Even Header

Property Definition

enable.build. Universal Messaging

UniversalMessaging

build.log.enable Specifies whether to enable logging for the build.

Set to:
true to enable logging.
false to disable logging.

build.log.fileName Name of the log file. The default file name is

build.log. The build script creates the log file in the
following directory:
Software AG_directory\common
\AssetBuildEnvironment\master_build

build.logLevel Logging level to include in the log. Possible values

are:

Specify... To record...

debug Debug, informational,

warning, error, and
fatal messages.

error Error and fatal

messages.

info (default) Informational,

warning, error, and
fatal messages.

verbose No possible values

defined for log level.

warn Warning, error, and

fatal messages.

3. If you are building BPM Process Development assets, set the following BPM-specific
properties:

Note: See "Preparing BPM Assets for Repository-Based Deployment" on page 47

for BPM project-level behaviors and instructions.

webMethods Deployer User’s Guide Version 9.6 38

 M  
Odd Header

Property Definition

bpm.acdl.model.ids Optional. Semicolon-separated list of process IDs

(that is, a concatenation of process project name
and process model file name).
If the process does not exist in the source directory
or one of its subdirectories, the value is ignored.
If left empty, all process model IDs are included.
This property can be used with or without the
bpm.acdl.model.version property.

bpm.acdl.bam.model.ids Optional. Semicolon-separated list of BAM process

model IDs to add to the composite. BAM process
models are tracking only and do not declare any
dependencies. For example: testProcessProject/
testProcessModel;testProcessProject2/
testProcessModel2. If the process does not exist in
the source directory or a child directory of it, the
value is ignored. If left empty, no process model
IDs are included. All process models are assumed
to be BPM processes and will generate the
standard process dependencies. This property can
be used with or without the bpm.acdl.model.ids or
bpm.acdl.model.version properties.

bpm.acdl.model.version Optional. Version number of the process models

to include in the build. Enter a single integer value
(example, 1 ).
If this value is set, the build script includes only
those process models in the source directory or
one of its subdirectories that match the version
number. If left empty, the build script includes
process models of all versions. You can use this
property with or without the bpm.acdl.model.ids
property.

4. If you are building Optimize assets, set the following Optimize-specific property:

Property Definition

optimize.acdl.validation Specifies whether to switch the XSD validation of

the generated composite and descriptor files. Set
to:
On to use XSD validation.

webMethods Deployer User’s Guide Version 9.6 39

 M  
Even Header

Property Definition

Off to turn off XSD validation. This is the default.

5. If you are building business rules assets, set the following business rules-specific property:

Property Definition

RULES.skip.on.validation.warning Specifies whether the build script should

create a rule project archive and composite
when the rule project issues validation
warnings. Set to:
true to create a project archive and
composite.
to turn off project archive and
false
composite creation. This is the default.

6. If you are building Integration Server assets, set the following Integration Server- specific
property:

Property Definition

is.acdl.config.dir Specifies the full path of the Integration Server

config directory. For example:
Software AG_directory\IntegrationServer\config

Important: If you set this property, you must also

specify a value for build.source.project.dir. If you do
not specify a value for build.source.project.dir, the
build script ignores this value.

7. Save and close the file.

Setting VCS Checkout Properties

If you set enable.checkout in build.properties to true, configure the properties in build-
source-checkout.xml to check out the assets from a VCS.

To set VCS checkout properties

1. Open the following file in a text editor:
Software AG_directory\common\AssetBuildEnvironment\master_build\build-
source-checkout.xml

webMethods Deployer User’s Guide Version 9.6 40

 M  
Odd Header

2. Set the following properties to correspond to your VCS as follows:

Note: The build-source-checkout.xml template is specific to an SVN version control

system. You might have to add more properties to make the file work with other
VCS types.

Property Definition

svn.jars.dir Location of the open source SvnAnt libraries (hp://

subclipse.tigris.org/svnant.html). These libraries are
required by the checkout Ant task.
To use a VCS other than SVN, modify this parameter
accordingly.

svn.user User name of the SVN.

svn.password Password of the SVN.

svn.url URL of the SVN from where the build script checks out
the assets.

build.checkout.dir The root directory from which the build script will
check out the asset sources. This property can point
to only one directory; therefore, it should be the root
directory containing all projects that will be built.
For example, if your solution contains an Integration
Server project, your full project directory might be /root/
project/builds/webM/IS. In this case, you would not
include /IS in the path. Instead, you would enter /root/
project/src/webM/.

3. Save and close the file.

Important: Do not rename or remove the file from the master_build directory.

Changing JVM Memory Settings

You can adjust the JVM memory seings available to the build. This is helpful when
building a large number of assets or assets that contain a large amount of data.

To change the JVM memory settings

1. Using a text editor, open the following file:

webMethods Deployer User’s Guide Version 9.6 41

 M  
Even Header

For this platform... Open the following file...

Windows Software AG_directory

\common\AssetBuildEnvironment\
bin\build.bat

UNIX Software AG_directory/common/AssetBuildEnvironment/

bin/build.sh

2. Change the values of the following parameters as necessary:

JAVA_MAX_MEM

JAVA_MAX_PERM_SIZE

3. Save and close the file.

Running the Build Script and Rebuilding the Index

The build script uses the properties you specified for the build.properties file in
"Seing the Properties for the Build" on page 34 to build the assets created in the
development environment into composites. Specifically, the build script:
Checks out the asset sources. The build script can use a VCS to obtain the asset sources
to build into composites. If you use a VCS to store your assets, you must set the
enable.checkout property in build.properties to true and set the properties in build-
source-checkout.xml to access the VCS. For more information, see "Seing Build
Properties" on page 34 and "Seing VCS Checkout Properties" on page 40.
Creates and indexes the repository. The build script creates the repository in the
specified structure. This is the source from which Deployer selects the assets for
deployment. For more information about defining a repository in Deployer, see
"Connecting to a Repository for Repository-Based Deployment" on page 68.
Versions the assets. The build script uses the build-number.xml file to automatically
version the assets included in the build in the format version_number .build_number .
Builds the composites and descriptors in the repository. The build script generates the
following files for each runtime type in the build:
ACDL descriptor file in the format project_name .acdl
This is the descriptor file that contains the metadata that lists the assets and
dependencies contained in the composite.
A compressed composite file that contains the definitions of the assets and
their dependencies for deployment. The composite file is in the format
project_name .composite_file_type where:

webMethods Deployer User’s Guide Version 9.6 42

 M  
Odd Header

For this runtime project_name is the... composite_file_type

type... is...

BPM process Process ID with “/” replaced .process

model by “_”. For more information
about process models, see
webMethods BPM Process
Development Help.

Broker Name of the file you .adl (Broker assets)

exported using My
.xml (JNDI assets)
webMethods Server
prefixed with “Broker_”
or “Provider_” depending
on whether you exported
Broker assets or JNDI assets,
respectively.
When you export Broker
assets (document, client, or
client group), Broker creates
an ADL file for the Broker
assets.

Note: If you export assets

from webMethods Broker
8.2 SP2 or earlier, you must
migrate the assets from XML
format to ADL format for
use in Deployer. For more
information about migrating
Broker assets from XML to
ADL format, see Upgrading
webMethods and Intelligent
Business Operations Products.

When you export JMS

destinations (JMS queues
and JMS topics) created by a
webMethods JNDI provider,
Broker creates a separate
XML file for a JNDI context.
For more information about
exporting Broker assets, see
Administering webMethods
Broker.

webMethods Deployer User’s Guide Version 9.6 43

 M  
Even Header

For this runtime project_name is the... composite_file_type

type... is...

Business Rules Name of the rules project. .jar

EDA Name of the Event Types .zip (Event Type

project. assets)

Integration For package, adapter .zip

Server runtime, and .Net assets,
this is the name of the
Integration Server package.
For more information about
adding package assets to
the source directory for
inclusion in the build, see
"Adding Package Assets
to the Source Directory"
on page 282. For
more information about
adding adapter runtime
or .Net assets to the source
directory for inclusion in
the build, see "Adding
Adapter Runtime and .NET
Service Assets to the Source
Directory" on page 288.
For administrative assets,
this is isconfiguration. For
more information about
adding administrative
assets to the source
directory for inclusion in
the build, see "Adding
Administrative Assets to
the Source Directory" on
page 246.

My webMethods Name of the project .skin, .war, .cdp

Server you exported. For more
information about exporting
My webMethods Server
assets, see Administering My
webMethods Server.

webMethods Deployer User’s Guide Version 9.6 44

 M  
Odd Header

For this runtime project_name is the... composite_file_type

type... is...

Optimize Name of the file you .zip

exported using My
webMethods Server. For
more information about
exporting Optimize assets,
see Administering webMethods
Optimize.

Trading Name of the file you .bin

Networks exported using My
webMethods Server.
For more information
about exporting Trading
Networks assets, see
webMethods Trading Networks
Administrator’s Guide.

Universal Name of the file you .xml

Messaging exported using Universal
Messaging Enterprise
Manager.

For example:
The composite for a Broker project containing Broker assets would be named
Broker_file_name .adl, where file_name is the name of the file you exported
from Broker using My webMethods Server.
The composite for a Broker project containing JNDI assets would be named
Provider_file_name .xml, where file_name is the name of the file you exported
from Broker using My webMethods Server.
The composite for a project containing Integration Server administrative
assets would be named isconfiguration.zip.
Deployer uses the composite and descriptor files to deploy the assets to a target
server. For more information about deploying assets, see "Adding Assets for
Repository-Based Deployment" on page 115.

Important: Do not customize this file. When you overinstall later releases of the Asset
Build Environment, your changes will be lost.

webMethods Deployer User’s Guide Version 9.6 45

 M  
Even Header

Running the Build Script

Before you run the build script, make sure you have set the properties in the build
properties file. For more information, see "Seing the Properties for the Build" on page
34.

To run the build script

1. Run one of the following commands from the Software AG_directory\common
\AssetBuildEnvironment\bin directory:

For this platform... Run the following command...

Windows build.bat

UNIX build.sh

The build script builds the composite files and places them in the location specified
by the build.output.dir property you specified in "Seing the Properties for the
Build" on page 34.

Rebuilding the Index

If the index you created becomes corrupted or the repository index is accidentally
deleted from the repository, you can recreate the index without rebuilding the entire
repository. By default, when you use this procedure, Deployer rebuilds the index
specified in the File Directory box. For more information about the File Directory box, see
"Connecting to a Repository for Repository-Based Deployment" on page 68.
When you follow this procedure to rebuild the index, Deployer rebuilds only the
index. To build the index, check out the asset sources, version the assets, and build the
composites and descriptors in the repository, you must run the build script as described
in "Running the Build Script" on page 46.

To rebuild the index

1. In Deployer, go to the Deployer > Repository page.
2. If you want to change the repository directory, perform the following:
a. In the Name column, click the name of the repository to edit.
Deployer opens the repository properties in the right-hand pane.
b. In the File Directory box, type the full path of the repository for which to rebuild
the index.
c. Click Save Changes.

webMethods Deployer User’s Guide Version 9.6 46

 M  
Odd Header

3. In the Create Index column for the repository, click .

Preparing BPM Assets for Repository-Based Deployment

This section describes how to configure and run a build script that creates a composite
and ACDL descriptor for specified process models. Deployer uses the resulting
composite and descriptor files to deploy the process development assets as part of a
deployment project.

Differences Between Manual Process Generation and Deployed

Processes
There are distinct differences in the results when you generate a process model
manually in Software AG Designer and when you deploy a process model with
Deployer.

About the Deployment of Generation Receipts

Deployer does not deploy generation receipts when deploying Designer process models.
The primary reason for this is that the generation receipt stores a logical-to-physical
server mapping and the only information available to Deployer is in the composite file,
which does not contain any mapping information.
When you regenerate a process, the regeneration process uses the mapping information
to determine whether a logical server mapping has changed from the previous
generation. If the mapping has changed, the regeneration process connects to the
previous logical server and cleans up the process-related assets there (for example,
deleting associated triggers and services), in addition to creating the new assets on the
new logical server. With no generation receipt, this mapping information is not available
and the clean-up procedure cannot occur.

Important: If a user connects Designer to a target environment and regenerates a

deployed process to servers other than those deployed to the original process, the
wrapper services and triggers on the original servers are not deleted. Wrapper services
and triggers are still generated on the new logical servers, and existing services and
triggers on unchanged logical servers remain unchanged. You must perform a manual
cleanup on old logical servers. If you do not, multiple triggers and services could run in
the process.
If you regenerate a previously deployed process to the same logical servers, Designer
creates a new generation receipt so that future regeneration processes are handled
correctly.

About the Redeployment of Processes

Because repository-based deployment does not generate a generation receipt, when
you deploy a process to a target environment using repository-based deployment,

webMethods Deployer User’s Guide Version 9.6 47

 M  
Even Header

you cannot then redeploy that process using that target environment as a source for a
runtime-based deployment project. In runtime-based deployment Deployer requires the
generation receipt to determine dependencies. If you want to redeploy the process, you
must first rebuild the process in the target environment.

About the Deployment of Process Images

When you deploy a process model, the associated process model image and icon images
are not deployed with the model. As a result, any webMethods Monitor APIs that use
the process or icon images will not perform as expected with the deployed process.

Preparing the BPM Process Development Asset Deployment

Environment
You prepare process development assets for deployment by creating a composite and
descriptor file for each .process file to be deployed. You create these files by configuring
and running the one of two build scripts as follows:
The master-level build script you run in the \bin directory of your installed Asset
Build Environment environment as described in "Running the Build Script and
Rebuilding the Index" on page 42. Use this build script for standard use in a
defined deployment environment.
The build.properties file must be configured prior to running the build script. For
information about configuring the build.properties file, see "Seing the Properties for
the Build" on page 34.
The project-level build script, in which the build script is run in a process project
directory. Running this build script is useful because process project directories
can be located anywhere in a user’s file system (that is, outside the deployment
environment). This approach enables you to create the composite and descriptor
files in any process project directory, regardless of location. After the composites
and descriptors are built, they can be moved or copied into a deployment repository
and indexed by the build script in order to make them available to Deployer. Project-
level build script behavior is governed by the build.xml file in the process project
directory. For information about configuring the build.xml file, see "Configuring the
Process Project build.xml File" on page 49.

About build.xml Files

Be aware that in either mode, the build script processes only those process projects that
contain a build.xml file. Process projects without a build.xml file are ignored, even if a
process model is explicitly named.
Software AG Designer adds a build.xml file to a process project automatically for
projects created with Process Development version 8.2 SP1 and later. If a process project
has no build.xml file, you can copy the build.xml file from any other project. If the
build.xml was not modified in the originating project, you do not have to modify the
build.xml file to copy it from one project to another.

webMethods Deployer User’s Guide Version 9.6 48

 M  
Odd Header

Configuring the Process Project build.xml File

Note: There is no need to configure the build.xml file if the build script is being run in
the master_build directory. Configuration of the build.xml file is an option only when
you want to run the build script in a process project directory. For information about
running the build script in the master_build directory, see "Running the Build Script
and Rebuilding the Index" on page 42.

A BPM build.xml file must be included in each process project (see "About build.xml
Files" on page 48). The file contains the default properties that are used when the
build script is run in the process project directory (that is, no properties are being passed
into the project build from a script running in the master_build directory).

Note: A BPM build.xml file is included by default if the Designer process project is
created in Designer 8.2 or later. If the process project is imported from previous versions
of Designer, you must add it manually to the process project folder.

When the script is run in the process project directory, the build script assumes that the
source directory and the output directory are the same as the current directory.

Note: The property seings described below are used only when the build script
is running in the process project directory. If the build script is running in the
master_build directory, the build.xml properties described below are overridden by the
properties in the build.properties file.

To configure the BPM build.xml file

1. In the process project you want to work with, open the build.xml file in a text editor.
2. Define the following properties as needed:

Property Definition

default.sag.install.dir=path/to/ Required. The location of the Software AG

directory suite installation directory. The specified
directory must contain the common/lib
directory.

sag.master.build.dir=path/to/ Required. The location of the Deployer

directory environment you installed with
Software AG Installer. The specified
directory must contain the master_build
directory.

default.bpm.acdl.model.ids= Optional. A semicolon-separated list of

processID1;processID2 process IDs (that is, a concatenation of
process project name and process model file
name). For example: testProcessProject/

webMethods Deployer User’s Guide Version 9.6 49

 M  
Even Header

Property Definition
testProcessModel;testProcessProject2/
testProcessModel2. If the process does
not exist in the source directory or a
child directory of it, the build script
ignores the value. If left empty, all
process model IDs are included. This
property can be used with or without the
default.bpm.acdl.model.version property.

default.bpm.acdl.model.version=n Optional. A single integer value that is

matched to the version number of process
models in the source directory or a child
directory of it. The build script includes only
models with a version number equal to this
value in the build. If left empty, the build
script includes all process model versions.
You can use this property with or without
the model.ids property.

default.bpm.acdl.bam.model.ids Optional. A semicolon-separated

list of BAM process model IDs.
For example: testProcessProject/
testProcessModel;testProcessProject2/
testProcessModel2.

You must specify all BAM process models

because they are for tracking purposes
only and do not need to declare any
dependencies. If the process does not exist in
the source directory or a child directory of it,
the build script ignores the property.
If left empty, all process models are
assumed to be BPM processes. The
build script treats any process models
it builds but that are not included in
this list as BPM processes and generates
the standard process dependencies for
them. You can use this property with
or without the bpm.acdl.model.ids or
bpm.acdl.model.version properties.

3. Save the file.

webMethods Deployer User’s Guide Version 9.6 50

 M  
Odd Header

Running the Build Script in a Process Project Directory

Use this procedure if you want to run the build script on a single process project. In this
case, the build script creates composite and descriptor files within the process project
directory. The build script considers all process files in the process project directory and
its sub-directories, as specified by the properties in build.xml.

To run the build script in a process project directory

1. Define any of the available build.xml properties as described in "Configuring the Process
Project build.xml File" on page 49.
2. Open a command prompt window.
3. Change to the process project directory where you want to run the build script.
4. Run this command: ant

Note: Be sure you have modified your system variables to contain the path name of
the build script. Otherwise, you must type the full path name.

The build script processes the specified process model files and creates
corresponding composite and descriptor files in the current directory. After
the composite and descriptor files are built, you can move or copy the files to a
deployment repository and index them for use with Deployer.
5. If you want to use the composite and descriptor files for use with Deployer, perform the
following additional steps:
a. Move or copy the files to the BPM subdirectory of the repository.
b. Run the following command from the Software AG_directory\common
\AssetBuildEnvironment\bin directory:

For this platform... Run the following command...

Windows build.bat createIndex

UNIX build.sh createIndex

The createIndex script indexes the files you moved or copied to the repository.

Next Steps
Once you have built your composites, you can connect to the repository and target
servers, create a project, and create a deployment set that includes the composites for
deployment.

webMethods Deployer User’s Guide Version 9.6 51

 M  
Even Header

To... See...

Connect to the repository and target "Starting Deployer and Connecting to

servers Servers" on page 53

Create a project "Creating and Managing Projects" on

page 75

To create a deployment set "Defining a Deployment Set" on page

93.

webMethods Deployer User’s Guide Version 9.6 52

 M  
Odd Header

4   Starting Deployer and Connecting to Servers

■ Starting Deployer .......................................................................................................................... 54
■ Connecting to webMethods Servers ............................................................................................ 54
■ Connect to Universal Messaging Servers .................................................................................... 67
■ Connecting to a Repository for Repository-Based Deployment .................................................. 68
■ Editing Properties for Source and Target Servers ....................................................................... 69
■ Creating Target Groups ................................................................................................................ 70
■ Next Steps .................................................................................................................................... 73

webMethods Deployer User’s Guide Version 9.6 53

 M  
Even Header

Starting Deployer
Deployer starts automatically when you start its host Integration Server.
Open the Deployer interface by entering this URL in an Internet browser, where
Integration Server_port is the host name and port of the Integration Server that hosts
Deployer:
hp://Integration Server_host :Integration Server_port /WmDeployer
Deployer and Integration Server 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.

Connecting to webMethods Servers

You can perform the tasks in this section to connect to the source and target
webMethods servers.
For runtime-based deployment projects, the source servers are those servers from
which you select assets for deployment. For repository-based deployment you do not
connect to source servers. The source for repository-based deployment is always the
repository on which the composites are built. For more information about adding a
source repository, see "Connecting to a Repository for Repository-Based Deployment"
on page 68.
For both runtime- and repository-based deployment, you can perform the tasks in this
section to map the assets from the source servers or repository to target servers. You
define target servers to define the location to which Deployer deploys assets from the
source server or repository.
For every source and target server you add, you select the version of the webMethods
runtime for that server. For example, if you are adding a target Integration Server that
is running version 8.2 SP1, you would select 8.2 for the version. The version you select
affects the source and target servers you can include in the project as follows:
For runtime-based deployment projects, after you select the source servers, Deployer
displays only servers running compatible versions for selection as target servers. For
example, if you select source servers of version 8.0, Deployer displays only target
servers and target groups with a version of 8.0 or 8.2 for mapping.
The following table lists all version compatibilities:

Source Version Compatible Target Versions

7.1 7.1

webMethods Deployer User’s Guide Version 9.6 54

 M  
Odd Header

Source Version Compatible Target Versions

8.0 8.0, 8.2

Note: 8.2 targets support only the

following runtimes from 8.0 sources:
Integration Server
Trading Networks
BPM process models

8.2 8.2

9.0 9.0

9.5 9.5

Additionally, you can import builds from projects created with Deployer version 8.2
or earlier to Deployer 9.0 or later for deployment. For example, you could import a
build from a version 8.0 project into Deployer 9.0.
For repository-based deployment projects, each project includes sources and targets
of only one version. You cannot include source repositories or target servers of
different versions.
For repository-based deployment projects, Deployer deploys only target servers and
target groups of version 8.2 SP1 and later. Because repository-based deployment
does not use source servers, Deployer limits the version of the targets in your project
according to the first target server or target group you select for mapping. For
example, if you select a target server of version 8.2, Deployer displays only target
servers and target groups of version 8.2 for mapping.
You can connect to the following source and target webMethods servers:

To connect to... See...

Integration Servers or Trading "Connecting to Integration Servers and Trading

Networks servers Networks Servers" on page 56

Optimize servers "Connecting to Optimize Servers" on page

57

My webMethods Servers "Connecting to My webMethods Servers" on

page 58

Event Servers "Connecting to Event Servers" on page 60

webMethods Deployer User’s Guide Version 9.6 55

 M  
Even Header

To connect to... See...

Broker servers "Connect to Broker Servers" on page 61

BPM process models "Connect to BPM Process Model Servers" on

page 63

EDA deployment endpoints "Connecting to EDA Deployment Endpoints"

on page 65

Business Rules servers "Connect to Business Rules Runtimes" on page

66

Universal Messaging servers "Connect to Universal Messaging Servers" on

page 67

Connecting to Integration Servers and Trading Networks Servers

All connections you create for Integration Servers and Trading Networks servers
are remote server aliases. A remote server alias contains the connection information
required to connect to a remote Integration Server or Trading Networks server. For more
information about remote servers, and instructions on defining them, see webMethods
Integration Server Administrator’s Guide.

To connect to source and target Integration Servers and Trading Networks servers
1. In Deployer, go to the Servers > IS & TN page.
2. Click Add Remote Server Alias.
Deployer opens the Integration Server Administrator to the Settings > Remote Servers
> Create Alias page of the Integration Server that hosts Deployer.
3. In Integration Server Administrator, define the remote servers by completing the fields in
the Remote Server Alias Properties area as described in webMethods Integration Server
Administrator’s Guide. You should define the following as remote servers:
All source Integration Servers and Trading Networks servers.
All target Integration Servers and Trading Networks 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).
4. In Deployer, go to the Servers > IS & TN and click Refresh this Page.
Deployer displays the new server alias to the Remote Servers List area of the Servers >
IS & TN page.
5. Select the version of the Integration Server hosting the source or target from the Version box.

webMethods Deployer User’s Guide Version 9.6 56

 M  
Odd Header

For example, if the host Integration Server is running version 8.2 SP1, you
would select 8.2. For information about selecting the version, see "Connecting to
webMethods Servers" on page 54.
6. Install the WmDeployerResource package on each Integration Server.
The WmDeployerResource package is the implementation of the operation
endpoints for Integration Server and Trading Networks. Install the package as
follows:
a. In Deployer, go to the Servers > IS & TN page.
The page lists all Integration Servers you defined as remote servers.
b. In the Install column, select the check box next to each Integration Server on
which you want to install the WmDeployerResource package.
c. Click Install.
7. Click Save.

Connecting to Optimize Servers

Use the following procedure to set up connections to Optimize servers.

To connect to source and target Optimize servers

1. In Deployer, go to the Servers >Optimize page.
2. For every source and target Optimize server, click Configure Optimize Server. In the
Configure Optimize Server area, complete the following fields:

Field Entry

Name Name to assign to the server. The name can be up to 32

characters long and cannot contain spaces or the following
illegal characters:
$~/\#&@^!%*:;,+=><‘’"

Host Host name or IP address of the server.

Note: You cannot use "localhost" for Optimize servers.

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.

webMethods Deployer User’s Guide Version 9.6 57

 M  
Even Header

Field Entry

Version Version of the Optimize server. For information about

selecting the version, see "Connecting to webMethods
Servers" on page 54.

Use SSL Whether Deployer should use SSL to connect to the server.

3. Click Configure. To test the connection, click .

Connecting to My webMethods Servers

Use the following procedure to set up connections to My webMethods Servers.

To connect to source and target My webMethods Servers

1. In Deployer, go to the Servers > MWS page.
2. For every source and target My webMethods Server, click Configure MWS Server and
complete these fields:

Field Entry

Name Name to assign to the server. The name can be up to 32

characters long and cannot contain spaces or the following
illegal characters:
$~/\#&@^!%*:;,+=><‘’"

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.

Version Version of the My webMethods Server. For information

about selecting the version, see "Connecting to webMethods
Servers" on page 54.

Root folder My webMethods Server aliases to use as root folders

aliases when selecting pages to deploy. Separate the folders using
commas.

webMethods Deployer User’s Guide Version 9.6 58

 M  
Odd Header

Field Entry

Include security Whether to include the following in the dependencies list

dependencies for My webMethods Server assets when creating an MWS
deployment set:
Security realms that contain the assets.
User/group/role references in the assets' security ACLs.
If the dependencies do not exist on the target My
webMethods Servers, include them in the list. You will
have to include them in the deployment set. Exclude the
dependencies if they do exist on the target My webMethods
Servers. For information about resolving dependencies,
see "Resolving Dependencies" on page 111 (for runtime-
based deployment), or "Resolving Dependencies" on page
117 (for repository-based deployment).

Maximum Folder Maximum number of assets to display within My

Object Count webMethods Server folders when you are defining and
choosing assets to include in an MWS deployment set.

Maximum Folder Maximum number of My webMethods Server folder levels

Depth to display when you are defining and choosing assets to
include in an MWS deployment set.

Enable Whether to log debug information about selected assets

additional MWS to source My webMethods Server logs, and assets that
logging Deployer deploys to target My webMethods Server logs.

Exclude Core Whether to exclude Task Engine portlets from the

Task Engine dependencies list for task application assets. Exclude the
Dependencies portlets from the list if the target My webMethods Servers
host the Task Engine; the portlets are installed with the Task
Engine. Include the portlets if the target My webMethods
Servers do not host the Task Engine; you will have to
include the portlets in the deployment set. For information
about dependencies, see "Resolving Dependencies" on
page 111 (for runtime-based deployment) or "Resolving
Dependencies" on page 117 (for repository-based
deployment).

Cache Timeout Length of time queries should remain in the cache unless
the cache capacity is exceeded.

webMethods Deployer User’s Guide Version 9.6 59

 M  
Even Header

Field Entry

Use SSL Whether Deployer should use SSL to connect to the My

webMethods Server.

Note: You can only use SSL if the My webMethods Server

is configured to use SSL. Configure the My webMethods
Server's HTTPS port to not request client certificates. For
instructions on defining the HTTPS port, see Administering
My webMethods Server.

3. Click Configure. To test the connection, click .

Connecting to Event Servers

Use the following procedure to set up connections to target Event Servers. You cannot
configure connections to source Event Servers.

Note: Deployer supports deployment of assets to Event Servers of version 9.5 or earlier
only.

Note: You can set up connections to target Event Servers only when using repository-
based deployment.

To connect to target Event Servers

1. In Deployer, go to the Servers > Event Server page.
2. Click Configure Event Server and complete these fields:

Field Entry

Name Name to assign to the server. The name can be up to

32 characters long and cannot contain spaces or the
following illegal characters:
$~/\#&@^!%*:;,+=><‘’"

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.

webMethods Deployer User’s Guide Version 9.6 60

 M  
Odd Header

Field Entry

Version Version of the Event Server. For information about

selecting the version, see "Connecting to webMethods
Servers" on page 54.

Use SSL Whether Deployer should use SSL to connect to the Event
Server.

Note: You can only use SSL if the Event Server is configured
to use SSL. Configure the server's HTTPS port to not request
client certificates. For instructions on defining the HTTPS
port, see webMethods Integration Server Administrator’s Guide.

3. Click Configure. To test the connection, click .

Connect to Broker Servers

For each source and target Broker, Deployer must connect to the Broker Server that
controls that Broker.

To connect to source and target Broker Servers

1. In Deployer, go to the Servers > Broker page.
2. For every source or target Broker, click Configure Broker Server and complete these fields:

Field Entry

Name Name to assign to the Broker Server. The name can be up to

32 characters long and cannot contain spaces or the following
illegal characters:
$~/\#&@^!%*:;,+=><‘’"

Host Host name or IP address of the Broker Server.

Port Port for the Broker Server.

Version Version of the Broker Server that matches the version of the
project as defined by the host server alias. For information
about selecting the version, see "Connecting to webMethods
Servers" on page 54.

Broker Name Name of the source or target webMethods Broker.

webMethods Deployer User’s Guide Version 9.6 61

 M  
Even Header

Field Entry

Client Group Client group for Deployer to use to access the source or target
Broker Server. For target Broker Servers, type admin.

Note: To connect, Deployer must belong to the specified Broker

client group and have access permission.

Context JNDI context to use when the Broker Server serves as a JNDI
provider.

Client Whether Deployer should use client authentication to connect

Authentication to the Broker Server. Select:
None to connect to the Broker Server without any client
authentication.
SSL to connect to the Broker Server using SSL
authentication. If you select this option, you must complete
the Deployer Keystore, Keystore Type, Keystore Password,
DeployerTruststore, and Truststore Type fields.

Note: You can only use SSL if the Broker Server is configured
to use SSL authentication.

Username/Password to connect to the Broker Server using

basic authentication. If you select this option, you must
complete the Username and Password fields.

Note: You can only use Username/Password if the Broker

Server is configured to use basic authentication.

Deployer Keystore Full path to Deployer's keystore file. The keystore contains

the SSL credentials (private key and signed certificate) that
the Broker Server uses to authenticate Deployer's identity and
establish an SSL connection. Required if you specify SSL for
Client Authentication.

Keystore Type File type of Deployer's keystore file. Required if you specify
SSL for Client Authentication.

Keystore Password that Deployer uses to access its keystore file.

Password Required if you specify SSL for Client Authentication.

DeployerTruststore Full path to Deployer's truststore file. The truststore contains

the trusted roots for Deployer's SSL certificates. Required if
you specify SSL for Client Authentication.

webMethods Deployer User’s Guide Version 9.6 62

 M  
Odd Header

Field Entry

Truststore File type of Deployer's truststore file. Required if you specify

Type SSL for Client Authentication.

Username Basic authentication user name. Required if you specify

Username/Password for Client Authentication.

Password Basic authentication password. Required if you specify

Username/Password for Client Authentication.

3. Click Configure. To test the connection, click .

Connect to BPM Process Model Servers

A process model server is an Integration Server that hosts the webMethods Process
Engine and executes business processes.

To connect to source and target BPM (ProcessModel) servers

1. Make sure the Process Audit Log database component is installed and Integration Server
is configured to write to it. For instructions, see Installing webMethods and Intelligent
Business Operations Products.
2. In Deployer, go to the Servers > BPM(ProcessModel) page.
3. For every source or target ProcessModel server, click Configure BPM(ProcessModel) Server
and complete these fields:

Field Entry

Name Name to assign to the server. The name can be up to 32

characters long and cannot contain spaces or the following
illegal characters:
$~/\#&@^!%*:;,+=><‘’"

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.

webMethods Deployer User’s Guide Version 9.6 63

 M  
Even Header

Field Entry

Version Version of the server. For information about selecting the

version, see "Connecting to webMethods Servers" on page
54.

Use SSL Whether Deployer should use SSL to connect to the server.

4. Click Configure. To test the connection, click .

5. In Designer, a logical-to-physical server mapping is defined for each ProcessModel server.
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
webMethods Integration Server Administrator’s Guide.

Note: Each Integration Server hosting a process model in a cluster must be

configured to use the same alias name and port number as the remote alias
defined for the cluster. For more information about deploying to clustered
Integration Servers, see "Deploying to Clustered Integration Servers" on page
235.

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

Field Entry

Name Name of a logical server in the mapping for the

ProcessModel server. The name can be up to 32 characters
long and cannot contain spaces or the following illegal
characters:
$~/\#&@^!%*:;,+=><‘’"

Note: In clusters, both the source and target ProcessModel

servers must use the same logical server name.

Physical Physical server to which the logical server is mapped.

Server This should be the same value as the remote server alias
name you defined in step 5a.

d. Click Add Logical Server.

e. Repeat these steps to duplicate the rest of the mapping.
f. Repeat these steps for every process model you want to deploy.

webMethods Deployer User’s Guide Version 9.6 64

 M  
Odd Header

6. 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 and click Install.
7. 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.

Connecting to EDA Deployment Endpoints

Every Software AG installation contains suite-wide EDA assets (event type schema
definitions and NERV bundles). These assets are common for all OSGi-enabled products
running within a particular installation. The webMethods Platform Manager runtime
exposes an EDA deployment endpoint that enables users to deploy EDA assets.
Use the following procedure to set up connections to EDA deployment endpoints.

Note: You can set up connections to target EDA deployment endpoints only when using
repository-based deployment.

To connect to target EDA deployment endpoints

1. In Deployer, go to the Servers > EDA page.
2. For every target EDA endpoint, click Configure EDA Server. In the Configure EDA Server
area, complete the following fields:

Field Entry

Name Name to assign to the EDA deployment endpoint. The name

can be up to 32 characters long and cannot contain spaces or
the following illegal characters:
$~/\#&@^!%*:;,+=><‘’"

Host Host name or IP address of the webMethods Platform

Manager runtime.

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.

webMethods Deployer User’s Guide Version 9.6 65

 M  
Even Header

Field Entry

Version Version of the webMethods Platform Manager runtime. For

information about selecting the version, see "Connecting to
My webMethods Servers" on page 58.

Use SSL Whether Deployer should use SSL to connect to the server.
Configure the server's HTTPS port to not request client
certificates.

3. Click Configure. To test the connection, click .

Connect to Business Rules Runtimes

Use the following procedure to set up connections to target business rules runtimes.

Note: You can set up connections to target business rules servers only when using
repository-based deployment.

To connect to target business rule runtimes

1. In Deployer, go to the Servers > Business Rules page.
2. For every source and target business rule server, click Configure Business Rules Server. In
the Configure Business Rules Server area, complete the following fields:

Field Entry

Name Name to assign to the runtime. The name can be up

to 32 characters long and cannot contain spaces or the
following illegal characters:
$~/\#&@^!%*:;,+=><‘’"

Host Host name or IP address of the Integration Server running

business rules.

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.

webMethods Deployer User’s Guide Version 9.6 66

 M  
Odd Header

Field Entry

Version Version of the business rules runtime. For information

about selecting the version, see "Connecting to
webMethods Servers" on page 54.

Use SSL Whether Deployer should use SSL to connect to the

server. Configure the server's HTTPS port to not request
client certificates. For instructions on defining the HTTPS
port, see webMethods Integration Server Administrator’s
Guide.

3. Click Configure. To test the connection, click .

Connect to Universal Messaging Servers

Use the following procedure to set up connections to target Universal Messaging
servers.

Note: You can set up connections to target Universal Messaging servers only when using
repository-based deployment.

To connect to target Universal Messaging servers

1. In Deployer, go to the Servers > UniversalMessaging page.
2. Click Configure UniversalMessaging Server. In the Configure UniversalMessaging Server area,
complete the following fields:

Field Entry

Name Name to assign to the server. The name can be up to

32 characters long and cannot contain spaces or the
following illegal characters:
$~/\#&@^!%*:;,+=><‘’"

Realm URL The URL of the Universal Messaging realm server in the
following format:
protocol ://host :port
Where:
protocol is one of the following:
nsp specifies Universal Messaging Socket Protocol.
nhp specifies Universal Messaging HTTP Protocol.

webMethods Deployer User’s Guide Version 9.6 67

 M  
Even Header

Field Entry

nsps specifies Universal Messaging Socket Protocol

Secure (using SSL/TLS).
nhps specifies Universal Messaging HTTP Protocol
Secure (using SSL/TLS).

Note: If you the protocol is nsps or nhps, you must

specify values for Deployer Keystore, Keystore Password,
Deployer Truststore, and Truststore Password.

host specifies the host on which the server is running.

port specifies the port number of the server.

Version Version of the Universal Messaging server. For

information about selecting the version, see "Connecting
to webMethods Servers" on page 54.

Deployer Keystore Full path to the keystore file. Required if the protocol of
Realm URL is nsps or nhps.

Keystore Password used to access the keystore file. Required if the

Password protocol of Realm URL is nsps or nhps.

Deployer Truststore Full path to the truststore file. Required if the protocol of

Realm URL is nsps or nhps.

Truststore Password used to access its truststore file. Required if the

Password protocol of Realm URL is nsps or nhps.

3. Click Configure. To test the connection, click .

Connecting to a Repository for Repository-Based

Deployment
For repository-based deployment, you define the repository as the source server.
This location identifies the repository directory from which the assets should be
deployed. Perform the following tasks to define a source repository for repository-based
deployment.

To define the source repository

1. In Deployer, go to the Deployer > Repository page.

webMethods Deployer User’s Guide Version 9.6 68

 M  
Odd Header

2. Click Add Repository.

Deployer displays the repository properties in the right-hand pane.
3. In the Name field, type the name to use for the repository alias. The name can be up to 32
characters long and cannot contain spaces or the following illegal characters:
$~/\#&@^!%*:;,+=><‘’"
4. In the File Directory field, type the full path of the repository directory in which the
composites are located.

Important: The repository directory must be accessible to Deployer.

5. Click Configure.
Deployer displays the repository in the table on in the Repositories pane.
6. To test the connection, click in the Test column of the Repositories pane.
7. To rebuild the index, see "Rebuilding the Index" on page 46.

Editing Properties for Source and Target Servers

Use the following procedure to edit the properties for webMethods source and target
servers.

Note: For Integration Server and Trading Networks remote server aliases, you can
edit only the Version property using Deployer. You can edit all other properties for
Integration Server and Trading Networks remote server aliases using Integration
Server Administrator. For more information about editing remote server aliases, see
webMethods Integration Server Administrator’s Guide. For information about refreshing
Integration Server and Trading Networks remote server aliases in Deployer, see step 4
in "Connecting to Integration Servers and Trading Networks Servers" on page 56.

Editing source and target server properties

1. In Deployer, go to the Servers > server page.
2. To edit the version of the server, select the version of the server hosting the source or target
from the Version box and click Save. You can edit the version for more than one server at a
time.
For information about selecting the version of the server, see "Connecting to
webMethods Servers" on page 54.
3. To edit additional server properties, click the name of the server to edit.
Deployer displays the server properties in the right-hand pane.
4. Edit the fields for the server as necessary.
5. Click Save.

webMethods Deployer User’s Guide Version 9.6 69

 M  
Even Header

Creating Target Groups

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.
Keep in mind that not all runtime types support the use of target groups when
deploying to a clustered environment. The following table describes which runtimes do
and do not support the use of target groups when deploying to a clustered environment:

Runtime Use target groups when deploying to a clustered environment?

BAM process No.

models

BPM process Yes. For instructions on creating target groups for use in a
models clustered environment, see "Deploying to Clustered Integration
Servers" on page 235.

Broker Yes. To copy Broker clients to all of the cluster nodes, you must
use a target group to deploy the Broker clients to each node in
the cluster. When you deploy Broker assets to one of the nodes in
a Broker cluster, all Broker assets except clients are copied to all
of the cluster nodes.

Business Yes. To deploy business rules to a clustered environment, you

rules should set up connections to the cluster and create a target group
that includes all of the servers in the cluster.

EDA Yes. To deploy EDA assets to a clustered environment, you must

set up connections to the cluster and create a target group that
includes all of the servers in the cluster.

Event Yes. You must use target groups to deploy to event servers in an
Servers HA cluster. You can also use a target group when deploying to
multiple independent event servers.

Note: Deployer supports deployment of assets to Event Servers of

version 9.5 or earlier only.

Integration Yes. For instructions on creating target groups for use in a

Server clustered environment, see "Deploying to Clustered Integration
Servers" on page 235.

webMethods Deployer User’s Guide Version 9.6 70

 M  
Odd Header

Runtime Use target groups when deploying to a clustered environment?

My Yes. To deploy My webMethods assets to a clustered

webMethods environment, you should set up connections to the cluster and
create a target group that includes all of the servers in the cluster.

Optimize No. When deploying Optimize assets to an Optimize cluster, you

should deploy to a single node of that cluster. Do not deploy to a
target group.

Trading Yes. For instructions on creating target groups for use in a

Networks clustered environment, see "Deploying to Clustered Integration
Servers" on page 235.

Universal Yes. You must use target groups to deploy cluster wide assets.
Messaging For all other assets, you can use target groups if you want to sync
the asset properties on each node.

To create a target group

1. In Deployer, go to the Target Groups > server page.
2. Click Create server Groups.
3. In the Name field, type the name to use for the target group. The name can be up to 32
characters long and cannot contain spaces or the following illegal characters:
$~/\#&@^!%*:;,+=><‘’"
4. In the Description field, type a description for the target group. The description length has no
limit and can include any characters.
5. In the Version box, enter the version of the target group.

Note: Deployer limits the servers you can select for inclusion in the target group to
those with the version you specify in the Version box. You cannot add servers of
different versions to a target group. For information about selecting the version, see
"Connecting to webMethods Servers" on page 54.

6. Click Create.
7. You can specify that deployment must either succeed on all servers in the target group or
be automatically rolled back. In other words, if deployment fails on any server in the target
group, you can specify that Deployer must automatically roll back the deployment on all
servers in the group. To do so, set Rollback All on Failure to Yes; Deployer will ignore the
Rollback on Error project setting (see " Seing General Deployment Defaults" on page
77).

Note: Rollback All on Failure is valid for runtime-based deployment only. Deployer
ignores this seing for repository-based deployment.

webMethods Deployer User’s Guide Version 9.6 71

 M  
Even Header

8. The Available Servers list shows the servers of the specified type for which you have set up
connections to Deployer and that match the version you specified in the Version field. Select
the servers to add to the target group, and then click Add. The servers move to the Selected
Servers list.
9. Click Save.
10. To test the connection between Deployer and the target group, click in the Test column in
the left pane.

If the test fails, Deployer displays Resolve in the Test column. You must resolve
the servers to continue. Perform the following task to resolve the servers within the
target group:
a. Click Resolve in the Test column.
Deployer displays the unresolved servers in the Check Inconsistencies page in
the right pane.
b. Click the server to resolve and click Resolve Inconsistencies.
Deployer removes the server from the target group and returns you to the
Configure Target Group page.
c. Make any additional changes to the target group and click Save.
d. Click in the Test column in the left pane to test the connection between Deployer and
the target group.
11. If you want to rebuild the index, perform the following procedure:

Note: For more information about rebuilding the index, see "Rebuilding the Index"
on page 46.

a. If you want to change the repository directory, perform the following:

i. In the Name column, click the name of the repository to edit.
Deployeropens the repository properties in the right-hand pane.
ii. In the File Directory box, type the full path of the repository for which to
rebuild the index.
iii. Click Save Changes.
b. In the Create Index column for the repository, click .
For more information about rebuilding the index, see "Rebuilding the Index" on page
46.

click in the Create Index column on the left pane.

webMethods Deployer User’s Guide Version 9.6 72

 M  
Odd Header

Next Steps
After you have connected to the source and target servers, you can create a project. For
more information on creating a project, see "Creating and Managing Projects" on page
75.

webMethods Deployer User’s Guide Version 9.6 73

 M  
Even Header

webMethods Deployer User’s Guide Version 9.6 74

 M  
Odd Header

5   Creating and Managing Projects

■ Enabling or Disabling Deployer GUI Audit Logging ..................................................................... 76
■ Setting Default Properties for All Projects ................................................................................... 77
■ Setting the Defaults for Integration Server and Trading Networks Projects ................................. 80
■ Creating a Project ........................................................................................................................ 83
■ Exporting and Importing Project Properties ................................................................................. 87
■ Permissions for Performing Tasks in Projects ............................................................................. 88
■ Adding and Viewing Instructions or Notes About a Project ......................................................... 90
■ Editing Settings for an Individual Project ..................................................................................... 90
■ Deleting a Project ......................................................................................................................... 90
■ Next Steps .................................................................................................................................... 91

webMethods Deployer User’s Guide Version 9.6 75

 M  
Even Header

Enabling or Disabling Deployer GUI Audit Logging

Under the Audit Logging Settings area on the Settings page, specify whether to enable or
disable audit logging for user actions taken through the Deployer GUI.
To view the audit log, from the Integration Server Administrator go to the Logs > Audit
page. The columns in the audit log are described below.

Column Description

Time Stamp Date and time the entry was wrien to the log.

Request Type Type of action Deployer performed (for example, Create, Build,
or Deploy).

Message Message that describes the action.

Status Outcome of the action (for example, Success or Failed).

User Id User name under which Deployer performed the action.

Server Details about the server. See Type, Alias, and Host IP:Port.

Type Type of server on which the action was

performed; can include the Integration
Server that hosts Deployer and source and
target servers.

Alias Name assigned to the server in Deployer

(see "Starting Deployer and Connecting to
Servers" on page 53).

Host IP:Port IP address and port for the server on

which the action was performed.

Thread ID Unique identification for each Deployer action. If an action

fails, the thread ID helps you identify the failed action through
the Audit Log page in Deployer. Using this, the user can
identify the failed activity.

To change this display, use the Log display controls area at the top of the page and then
click Refresh. The changes remain until you change them again, or until you shut down
the Integration Server that hosts Deployer, whichever comes first.

webMethods Deployer User’s Guide Version 9.6 76

 M  
Odd Header

Setting Default Properties for All Projects

Deployer uses default properties for all projects. To set the properties, go to the
Deployer > Settings page. When you are done, click Save.
You can override many of these properties for individual projects. For instructions, see "
Creating a Project" on page 83.

Setting the Dependency Checking Default

Under the Dependency Checking Default area on the Settings page, indicate the default for
dependency checking for all projects.

Note: Dependency checking seings apply only to runtime-based deployment.

Option Description

Always 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 will trigger dependency checking at different steps yourself.

Setting the Project Locking Default

Deployer offers project locking. If locking is enabled for a project, a user who wants to
modify the project or perform an action such as deployment must lock the project. Other
users will be able to view the project and run display commands. If necessary, users
with administrative privileges can unlock a locked project.

To set project locking

Under the Project Locking Default area on the Settings page, indicate whether locking
should be enabled or disabled by default for all projects.

Setting General Deployment Defaults

Under the General Deployment Defaults area on the Settings page, indicate the defaults for
the following options for all projects.

webMethods Deployer User’s Guide Version 9.6 77

 M  
Even Header

Option Entry

Large File For Integration Server packages and webMethods files, indicate
Support whether you want Deployer to stream from the source server to
Deployer and from Deployer to the target server by default for all
projects.
If you choose not to stream, the build size of a project containing
Integration Server packages and webMethods files cannot exceed
the amount of RAM configured for the source or target Integration
Server or Deployer. If it does, you will have to distribute the
Integration Server packages and webMethods files across multiple
projects (and thus multiple project builds) instead.
If you choose to stream, the build size of a project containing
Integration Server packages and webMethods files can be up
to 4GB. For streaming to work, you must set certain extended
seings on every source and target Integration Server, and on the
Integration Server that hosts Deployer.
In Integration Server Administrator, go to the Settings > Extended >
Edit Extended Settings page. Type the following server configuration
parameters and values in the box. For complete information
about these server configuration parameters, see the webMethods
Integration Server Administrator’s Guide.
wa.server.tspace.timeToLive=time
wa.server.tspace.location=full_path_on_local_machine
wa.server.tspace.max=maximum
If your project contains BPM process models or Integration
Server packages, set the following additional server configuration
parameters:
wa.server.SOAP.MTOMStreaming.enable=true
wa.server.SOAP.MTOMStreaming.cachedFiles.location=directory_path
wa.server.SOAP.MTOMStreaming.threshold=number_of_bytes
Click Save Changes and restart the Integration Server.

Important: Streaming is available only over HTTP. If your source or

target environment uses HTTPS, you cannot choose to stream.

Note: This option is available for runtime-based deployment only.

webMethods Deployer User’s Guide Version 9.6 78

 M  
Odd Header

Option Entry

Optimize (Runtime-based deployment only) Click Yes to increase the Deployer

UI GUI responsiveness for large projects. This seing causes Deployer
Response to bypass the ping requests from the GUI that Deployer usually
performs during the map and define dependency checks. The
default seing is No.

Checkpoint (Runtime-based deployment only) To have Deployer automatically

Creation create a checkpoint for target servers before deploying, click
Automatic. If you want to generate checkpoints when you choose,
click Manual.

Note: If deployment sets in a project include deletion sets, Deployer

ignores these seings. Instead, Deployer automatically creates
checkpoints for target servers.

Rollback (Runtime-based deployment only) To have Deployer automatically

on Error create checkpoints before deploying and roll back deployments if
they fail, click Automatic. If you want to roll back deployments when
you choose, click Manual.

Note: If deployment sets in a project include deletion sets, Deployer

ignores these seings. Instead, Deployer automatically rolls back the
target servers.

Enable To set Deployer to deploy assets concurrently, click Yes (the

Concurrent default). If you want to deploy assets sequentially, click No. For
Deployment more information about concurrent and sequential deployment, see
"Concurrent and Sequential Deployment" on page 22.

DeployerServiceThe amount of time (in milliseconds) to wait before Deployer

Timeout services time out waiting for a response.
This seing overrides the watt.net.timeout and
watt.server.SOAP.request.timeout server configuration properties for
Deployer.

Note: When using the Integration Server or BPM server ping

operations, Deployer calls a service that returns cluster information. If
the target Integration Server or BPM server is down, this service can
take a long time to time out. To reduce the amount of time to wait,
set the clusterServiceInvokeTimeout property in the WmDeployer/
config/deployer.cnf file. The default value is 2000 milliseconds. Change
this value according to your system’s requirements and reload the
Deployer package for the changes to take effect.

webMethods Deployer User’s Guide Version 9.6 79

 M  
Even Header

Option Entry

Batch Sets the number of assets that Deployer deploys at one time for
Size for runtime-based deployment. Enter the maximum number of assets
Runtime to build and deploy as a batch at one time. This limits the number of
Deployment assets in each deployment to only the number indicated. The default
value is 10.
By batching deployments, you break the transportation of large
assets into smaller batches, which decreases the memory utilization.
If you set this property to 0, then Deployer does not limit the number
of assets during build, checkpoint, rollback, and deploy operations.

Batch Sets the number of assets that Deployer deploys at one time for
Size for repository-based deployment. Enter the maximum number of assets
Repository to build and deploy as a batch at one time. This limits the number of
Deployment assets in each deployment to only the number indicated. The default
value is 1.

Note: If you are deploying BPM or Optimize assets, set this parameter
to 0.

Maximum Sets the maximum number of assets Deployer displays in the tree for
Plugin deployment and deletion sets. The default is 2500.
Objects
Displayed

Setting the Defaults for Integration Server and Trading

Networks Projects
Note: IS & TN Deployment Defaults seings apply only to runtime-based deployment.

In addition to the default properties for all projects, Deployer uses default properties for
all Integration Server and Trading Networks projects. To set these properties, go to the
Deployer > Settings page. When you are done, click Save.
You can override many of these properties for individual projects; see " Creating a
Project" on page 83.
These default properties apply to all assets except Integration Server packages. You
specify package properties for Integration Server packages on a package-by-package
basis. For instructions, see "Seing Package Properties" on page 106.

webMethods Deployer User’s Guide Version 9.6 80

 M  
Odd Header

To set default properties for Integration Server and Trading Networks projects
1. In the Suspend During Deployment area on the Settings page, 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 enables the disabled ports and resumes
the suspended triggers, adapter listeners, polling notifications, and scheduled tasks.

Asset Description Click...

Triggers Allow all running trigger operations to complete, All

then 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

Suspend individual triggers. You choose the Selected

triggers to suspend when you set package
properties (see "Seing Package Properties" on
page 106).

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

Tasks Integration 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 Do not suspend adapter listeners or polling None

notifications.

Suspend individual adapter listeners and polling Selected

notifications. You choose the notifications to
suspend when you set package properties (see
"Seing Package Properties" on page 106).

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

webMethods Deployer User’s Guide Version 9.6 81

 M  
Even Header

For this Indicate whether Deployer should... Click

option...

TN Rules Replace the entire rule list. Replace All

Overwrite existing rules and deploy new rules Merge

into the rule set.

ACL Deploy the mapping of ACLs to services for

Maps any services you choose to deploy. 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 Overwrite existing assets. This option applies to

Non- all assets except the following:
Package
Trading Networks processing rules (see the
Assets
previous step).
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
"Seing Package Properties" on page 106.

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

3. In the Activate After Deployment area on the Settings page, indicate whether Deployer should
activate the assets below on the target Integration Servers. Activate After Deployment is used
only if Suspend During Deployment is set to Yes.

For this Indicate whether Deployer should...

option...

Ports Activate newly deployed ports.

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.

webMethods Deployer User’s Guide Version 9.6 82

 M  
Odd Header

For this Indicate whether Deployer should...

option...

Scheduled Activate newly deployed scheduled tasks.

Tasks

Adapters Activate newly deployed adapter connections, notifications, and

listeners.

Note: If you choose to not activate, the deployed adapter

connections, notifications, and listeners will be in the same state
they are in on the source server.

4. Click Save.

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. Go to the Deployer > Projects page.
2. Create a project using one of these methods:
To create a new project:
i. Click Create Project.
ii. In the Name box, type the name to use for the new project. The name can be
up to 32 characters long and cannot contain spaces or the following illegal
characters:
$~/\#&@^!%*:;,+=><‘’"
iii. In the Description box, type a description for the project. The description
length has no limit and can include any characters.
iv. In the Project Type area, select one of the following:

To create a... Click...

Runtime-based deployment project Runtime

Repository-based deployment Repository

project

v. Click Create.

webMethods Deployer User’s Guide Version 9.6 83

 M  
Even Header

To create a project from an existing project:

i. Click Copy Project.
ii. In the Project to Copy box, click the project to copy.
iii. 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.
iv. Click Copy Project.
3. Review the default properties for projects in the right-hand pane and override for the project
you are creating if necessary.
In the right-hand pane, Deployer displays those properties for which you can
override the seings for an individual project. By default, these properties inherit
the values set for the default as described in " Seing Default Properties for All
Projects" on page 77. For example, if the global property for the Enable Concurrent
Deployment property is set to Yes (for concurrent deployment), you can set an
individual project to use sequential deployment by seing this property to No.
4. Depending on the specific type of project you are creating, you can set the following
additional properties in the right-hand pane:

Note: For an explanation of the project properties you can set for all deployment
projects, see " Seing Default Properties for All Projects" on page 77.

If you are creating a repository-based project, you can set the following
additional properties:

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

Enable Project Locking Whether locking is enabled or disabled for

the project. Click Yes to enable locking. Click
No to disable locking.

Enable Concurrent Deployment Deploy assets concurrently. Click Yes to

deploy assets concurrently. If you want to
deploy assets sequentially, click No. For
more information about concurrent and
sequential deployment, see "Concurrent and
Sequential Deployment" on page 22.

Ignore Missing Dependencies Ignore missing dependencies. If you click

Yes, Deployer deploys the composite even
when the dependent composite is not
available on the repository.

webMethods Deployer User’s Guide Version 9.6 84

 M  
Odd Header

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

Enable Transactional Automatically create a checkpoint prior

Deployment to delivering and activating deployment
and deletion sets. If set to Yes (the default),
transactional deployment is enabled.
When transactional deployment is enabled
and activation fails, Deployer triggers a roll
back automatically and restores the target
servers to the state of the prior activation.

If the project is for IS & TN, see "Seing the Defaults for Integration Server and
Trading Networks Projects" on page 80.
If the project is for Optimize, you can set the following properties under the
OptimizeOptions area:

Note: The following properties are available only for Deployer 8.2 SP1 and
earlier.

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

Include Dimension Values Indicates whether Deployer should include

the values for dimensions you add to
deployment sets (for example, Customer
Names or Product Types).

Display Data Definition Indicates whether Deployer should display

Statements the values for data definition statements in
the binary stored in the project build.

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 webMethods Monitor User’s Guide.

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

Enable process for execution Enable webMethods-executed business

process versions for 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.

webMethods Deployer User’s Guide Version 9.6 85

 M  
Even Header

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

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 analysis Enable webMethods-executed processes

for analysis after deployment. When a
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 Subscriptions Deploy subscriptions for My webMethods

Server assets you are deploying.

Export Access Control Lists Deploy ACLs for My webMethods Server

assets you are deploying.

Export Principal Attributes Include aributes contained in aributes

providers when exporting users, groups, and
roles.

Export Content As Reference Export a reference to the page content without

deploying the content.

Alias Prefix Apply the specified prefix to every

automatically generated My webMethods
Server alias.

Export Version History Include all versions of an asset in Portal

version control. This applies to the content
within a page or folder.

Auto Generate Aliases Automatically generate an alias on the

target My webMethods Server for every My
webMethods Server asset that is deployed.
If an asset already has one or more aliases,

webMethods Deployer User’s Guide Version 9.6 86

 M  
Odd Header

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

then the aliases are retained when the auto-
generated alias is added.

Export Content (Documents) Deploy content referenced by portal pages and

folders you are deploying (for example, a PDF
document that has been published on a portal
page you are deploying).

5. Click Save.

Exporting and Importing Project Properties

You can export and import project properties for deployment projects.

Note: Deployer does not export and import deletion sets as a part of this procedure.
For more information about exporting and importing deletion sets, see "Exporting and
Importing Deletion Set Definitions" on page 132.

When you export project properties, Deployer creates a file that contains the
project property seings. The file is named project .properties and is stored in the
Integration Server_directory\packages\WmDeployer\replicate\outbound directory. You
can then import the project property seings into another Deployer project.

To export and import the project properties

1. Export project properties as follows:
a. In Deployer, go to the Deployer > Projects page.
b. In the Name column, click the project from which to export.
c. In the right-hand pane, click Export Project properties. Deployer creates a file that
contains the project property settings. The file is named project .properties and is stored
in the Integration Server_directory\packages\WmDeployer\replicate\ outbound directory.
Deployer also gives you the option to save the file to your local file system.
2. Import project properties into another project as follows:
a. Copy the project .properties file to the Integration Server_directory\packages
\WmDeployer\replicate\inbound directory on the machine that hosts the project into
which to import.
b. In Deployer, go to the Deployer > Projects page.
c. In the Name column, click the project into which to import.
d. In the right-hand pane, click Import Project properties, then select the project .properties
file you just copied to the inbound directory.

webMethods Deployer User’s Guide Version 9.6 87

 M  
Even Header

Permissions for Performing Tasks in Projects

You can authorize users to perform tasks by project. To do this you use tasks and
authorizing groups or My webMethods Server central user management. This means
that when Deployer users display the Projects page, they will see only those Deployer
projects for which they are authorized.
You can authorize groups to perform the following tasks:
View. View projects only.

Note: Users with Developer and Internal ACLs and any combination of Define,
Build, Map, or Deploy authorization automatically have the View authorization.

Define. Groups can define, export, and import deployment and deletion sets only.
Build. Groups can build projects only.
Deploy. Groups can deploy deployment or deletion sets only (that is, to actually
deploy assets to or delete assets from target servers or target groups).
Map. Groups can map projects to repositories, source servers, target servers, and
target groups.
You grant privileges to perform tasks through Access Control Lists (ACLs). When an
administrator creates ACLs, he or she identifies groups that are allowed to perform
particular tasks. The following table shows the ACLs and authorizations required to
perform each task:

All View Define Build Map Deploy

Project Project Project Project Project Project
Tasks Tasks Tasks Tasks Tasks Tasks

ACLs

Developer X X X X X X

Internal X X X X X X

DeployerAdmin X*

Administrator X*

Authorizations

View X

webMethods Deployer User’s Guide Version 9.6 88

 M  
Odd Header

All View Define Build Map Deploy

Project Project Project Project Project Project
Tasks Tasks Tasks Tasks Tasks Tasks

Define X

Build X

Map X

Deploy X

Note: The asterisk (*) indicates that only users with either one of the following ACL
combinations can perform all project tasks in Deployer:
DeployerAdmin, Developer, and Internal ACLs
Administrator ACL
Users assigned to one of these ACL combinations do not require authorization to
specific tasks.

You can authorize groups to perform more than one task. For example, if you want
to allow Group A to map and deploy projects, you would select the Map and Deploy
authorizations.

Tip: The groups you create for use with Deployer can contain unique names to
help define which tasks each group can perform. For example, you could create
groups named viewDeployerProjects, buildDeployerProjects, mapDeployerProjects,
deployDeployerProjects, and defineDeployerProjects. This means that when Deployer
users display the Projects page, they will see only those Deployer projects to which they
are authorized.

For more information about groups and ACLs, see webMethods Integration Server
Administrator’s Guide. For information on My webMethods Server central user
management groups, see Administering My webMethods Server.

To authorize groups to perform tasks

1. In Deployer, go to the Deployer> Projects page.
2. Locate the project to which to authorize groups. If locking is enabled, in the Lock Status
column for the project, click to lock the project. In the Authorize column for the project,
click .
3. In the Fetch Groups field, click the type of group to authorize.
If you select LDAP/Central user management groups, you can narrow the list of groups
that are displayed. In the Search String field, specify a string that is within the names
of the groups you want to display; you can use an asterisk (*) as a wildcard for one
or more characters (for example, Admin*). Click Go to list the specified groups.

webMethods Deployer User’s Guide Version 9.6 89

 M  
Even Header

4. In the Select Authorization list, click the task the group is authorized to perform.
5. The Not Specified box lists all groups defined in the type of group you chose. Using the arrow
buttons, move each group you want to assign to the specified task into the Allowed box. Move
each group that you do not want to assign to the specified 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).
7. In the Lock Status column for the project, click to unlock the project.

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.

Editing Settings for an Individual Project

Use the following procedure to edit the seings for an individual project.

Note: To change the project seings for all projects, see " Seing Default Properties for
All Projects" on page 77.

To edit settings for an individual project

1. In Deployer, go to the Deployer > Projects page.
2. In the Name column of the Projects area, click the name of the project for which you want to
edit the properties.
Deployer displays the properties for which you can override the seings for an
individual project in the right-hand pane.
3. Make changes to the properties and click Save.

Deleting a Project
Use the following procedure to delete a project you no longer need. When you delete
a project, Deployer also deletes the deployment and deletion sets, builds, deployment
maps, and deployment candidates associated with that project.

webMethods Deployer User’s Guide Version 9.6 90

 M  
Odd Header

Deployer does not delete source repositories or composites used for repository-based
deployment or source and target server aliases when you delete the project.

To delete a project
1. In Deployer, go to the Deployer > Projects page.
2. Click in the Delete column for the project.
Deployer displays a confirmation dialog.
3. Click OK to confirm that you want to delete the project.

Next Steps
Once you have set logging options and other project default seings and created a
project, you can do the following:

If you are creating a... You can...

Runtime-based deployment project Define a deployment set. See"Defining

a Deployment Set" on page 93.
Define a deletion set. See "Defining a
Deletion Set" on page 125.

Repository-based deployment project Define a deployment set. See"Defining a

Deployment Set" on page 93.

webMethods Deployer User’s Guide Version 9.6 91

 M  
Even Header

webMethods Deployer User’s Guide Version 9.6 92

 M  
Odd Header

6   Defining a Deployment Set

■ Creating a Deployment Set .......................................................................................................... 94
■ Identify Source Servers for the Deployment Set ......................................................................... 95
■ Next Steps .................................................................................................................................... 97

webMethods Deployer User’s Guide Version 9.6 93

 M  
Even Header

Creating a Deployment Set

You create a deployment set to define the assets Deployer deploys to target servers.
Perform the following procedure to create a deployment set for either a runtime-based
or repository-based deployment.

To create a deployment set

1. In Deployer, go to the Deployer> Projects page.
2. If locking is enabled, in the Lock Status column for the project, click to lock the project.
3. In the Name column, click the project.
4. In the right-hand pane, click Define.
5. Click Create Set.
6. If you are creating a deployment set for runtime-based deployment, perform the following:
a. From the Type box, select the type of deployment set you want to create.
b. From the Set box, select Deployment.
7. Complete the following fields:

Box Entry

Name Name to use for the deployment set. The name can be up to
32 characters long and cannot contain spaces or the following
illegal characters:
$~/\#&@^!%*:;,+=><‘’"

Description Description for the deployment set. The description length

has no limit and can include any characters.

Maximum (Runtime-based deployment only) Number of Trading

TN Assets to Networks assets Deployer should display. Depending on
Display your browser, Deployer might not be able to display more
than 1000 assets for Trading Networks. If the source server
hosts more than 1000 assets, use this field with the with the
All other assets field to reduce the number of assets displayed.

Packages(IS (Runtime-based deployment only) After you choose the

& TN source servers, Deployer will display all packages on the
deployment servers. You can use this field to narrow the display. Type
set) a regular expression that specifies the text that the package
names must contain in order to be displayed.

webMethods Deployer User’s Guide Version 9.6 94

 M  
Odd Header

Box Entry

The following are examples of regular expressions:

To narrow display to packages whose name starts with
string , use the following:
string .*
To narrow display to packages whose name ends with
string , use the following:
.*string $

All other (Runtime-based deployment only) After you choose the

assets source servers, Deployer will display all assets 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 displayed. For examples, see the
Packages field.

8. Click Create.

Identify Source Servers for the Deployment Set

You must define source servers from which Deployer obtains the assets for deployment.
Perform one of the following procedures to identify the source servers for the
deployment set:

For... See...

Runtime-based deployment "Identifying Source Servers for Runtime-Based

Deployment" on page 95

Repository-based "Identifying Source Repository for Repository-Based

deployment Deployment" on page 96

Identifying Source Servers for Runtime-Based Deployment

You can define the following as source servers for runtime-based deployment:
Integration Server & Trading Networks
Optimize
My webMethods Server

webMethods Deployer User’s Guide Version 9.6 95

 M  
Even Header

Broker
BPM (ProcessModel)

Note: You cannot configure source servers for Event Server or business rules runtimes for
runtime-based deployment.

Note: You cannot define the same server alias as both a source and target server in a
deployment set.

Perform the following procedure to identify the source servers for runtime-based
deployment.

To identify source servers for runtime-based deployment

1. On the Deployer> Projects > project > Define page, in the left-hand pane in the Name column,
click the d eployment set for which to identify source servers.
2. In the Select column of the Select Source Servers area, select the check box next to each
source server that contains assets to add to the deployment set.

Note: Deployer lists the version of each source server in the Version column. You
must select source servers with the same version for the deployment set. You cannot
include source servers with different versions in a deployment set. For information
about selecting the versions of source servers, see "Connecting to webMethods
Servers" on page 54.

Note: For a BPM (ProcessModel) deployment set, you can select only one source
server. If you want to deploy process models from more than one ProcessModel
server, you must define a deployment set for each ProcessModel server.

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 "Starting Deployer and
Connecting to Servers" on page 53. Then click Refresh this Page to update the list of
servers on this page.

3. Click Save.
Deployer refreshes the Select Source Servers list to display only source servers that
share the same version as the selected source servers. To display all of the available
source servers, deselect the source servers and click Save.

Identifying Source Repository for Repository-Based Deployment

For repository-based deployments, the source is always the repository on which the
composites are built. Perform the following procedure to identify repository for
repository-based deployment.

webMethods Deployer User’s Guide Version 9.6 96

 M  
Odd Header

To identify the source repository for repository-based deployment

1. On the Deployer > Projects > project > Define page, in the left-hand pane in the Name column,
click the deployment set from which you will select the composites to deploy.
2. In the Select column of the Select Repository area, click repository_alias that contains
composites to add to the deployment set.

Note: You can select only one repository.

Note: If a repository you want to use as a source does not appear in the list, you have
not yet created the alias for the repository. For instructions, see "Connecting to a
Repository for Repository-Based Deployment" on page 68. Then click Refresh this
Page to update the list of servers on this page.

3. Click Save.
Deployer adds the repository as a child of the deployment set in the Name column of
the Deployer > Projects > project > Define page, in the left-hand pane.
Deployer displays the icon for the repository.

Next Steps
Once you have defined a deployment set and the source servers or repository for your
project, you can add the assets to the deployment set. You perform different tasks to
add assets depending on whether you are creating a runtime-based or repository-based
deployment project. See the section specific to the type of deployment project you are
creating as follows:

If you are creating a... See...

Runtime-based deployment project See"Adding Assets for Runtime-Based

Deployment" on page 99.

Repository-based deployment project See "Adding Assets for Repository-

Based Deployment" on page 115.

webMethods Deployer User’s Guide Version 9.6 97

 M  
Even Header

webMethods Deployer User’s Guide Version 9.6 98

 M  
Odd Header

7   Adding Assets for Runtime-Based Deployment

■ Before Adding Assets for Runtime-Based Deployment ............................................................. 100
■ Adding Assets to Broker, ProcessModel, MWS, or Optimize Deployment Sets ........................ 100
■ Adding Assets to an IS & TN Deployment Set .......................................................................... 102
■ Resolving Dependencies ............................................................................................................ 111
■ Manually Adding Dependencies to a Package Component in an IS & TN Deployment Set ....... 113
■ Removing Process Models from a Deployment Set .................................................................. 113
■ Next Steps .................................................................................................................................. 114

webMethods Deployer User’s Guide Version 9.6 99

 M  
Even Header

Before Adding Assets for Runtime-Based Deployment

Before you can add assets for runtime-based deployment, you must perform the
following
1. Connect to source and target servers and optionally define target groups. For more
information, see "Starting Deployer and Connecting to Servers" on page 53.
2. Create a project. For more information, see "Creating and Managing Projects" on
page 75.
3. Define a deployment set. For more information, see "Defining a Deployment Set" on
page 93.
Keep the following points in mind when adding assets for runtime-based deployment:
You can only deploy user-created assets using Deployer. You cannot deploy system
components that were installed by the Software AG Installer as part of a product
installation. For example, you can deploy Integration Server packages that were
created by users, but you cannot deploy Integration Server system packages that
were installed, such as the WmPRT package (Process Engine). If you want such
components on target servers, you must install them using the Software AG Installer.
You cannot define the same server alias as both a source and target server in a
deployment set.

Adding Assets to Broker, ProcessModel, MWS, or Optimize

Deployment Sets
You perform similar actions to add assets to Broker, Designer ProcessModels, My
webMethods Server, or Optimize deployment sets.

About MWS Deployment Sets

If you are creating an MWS deployment set, the set you create should depend on the
number of assets you want to deploy. The Root folder aliases field in the MWS Server
configuration (see "Connecting to My webMethods Servers" on page 58) controls the
Page assets that are displayed for each My webMethods Server. By default, this field is
set to folder.public.
If your Public Folders and its subfolders contain hundreds of pages, displaying these
assets can take a long time. In addition, Deployer cannot display more than 2500 assets
at once, so it might not display all assets. Software AG recommends displaying smaller
sets of assets and creating smaller deployment sets. To do so:
1. Change the Root folder aliases field to specify a folder that is deeper within the Public
Folders hierarchy.

webMethods Deployer User’s Guide Version 9.6 100

 M  
Odd Header

2. Create the deployment set for those assets.

3. Repeat as necessary.

About ProcessModel Deployment Sets

When deploying Designer process models with Deployer in a runtime-based project,
Deployer copies the generation receipt from the source environment to the target
environment. Because the logical-to-physical server mapping might contain old data, the
regeneration process connects to the previous logical server and cleans up the process-
related assets there (for example, deleting associated triggers and services), in addition
to creating the new assets on the new logical server. With no generation receipt, this
mapping information is not available and the clean-up procedure cannot occur.

Note: If you deploy multiple versions of the same process model in a single deployment
set and configure the deployment set to enable both processes on the target, the version
that is deployed to the target last is the one that is enabled. Use webMethods Monitor to
ensure that the proper version is enabled in the target environment.

Adding Assets to a Broker, ProcessModel, MWS, or Optimize

Deployment Set
Perform the following task to add assets to webMethods Broker, ProcessModel, MWS, or
Optimize deployment sets.

To add assets to a webMethods Broker, ProcessModel, MWS, or Optimize 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

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

webMethods Deployer User’s Guide Version 9.6 101

 M  
Even Header

For... Note
itself, open the folder where it appears as a container and
click the assets to add.

3. Click Save. Deployer shows the selected assets in the left-hand pane under the Broker,
ProcessModel, MWS, Optimize, or Business Rules folder for the deployment set.

Adding Assets to an IS & TN Deployment Set

The sections below explain how to add these types of user-created assets to an IS & TN
deployment set:
Integration Server administrative assets such as ports, users, groups, and scheduled
tasks, packages, and web service descriptors.
Integration Server packages.
webMethods files.
Trading Networks assets.
Your source and target Integration Servers might have assets in common, you do not
need to deploy them from one environment to another. You can improve Deployer
performance by excluding these assets from deployment sets. For instructions, see
"Excluding Common Assets" on page 110.

Deploying ACLs
If you want to deploy ACLs, you must perform extra steps depending on whether the
ACLs are associated with My webMethods Server groups or LDAP groups.

Deploying ACLs Associated with My webMethods Server Groups

If you want to deploy ACLs that are associated with My webMethods Server groups,
you must perform the following steps.

To deploy ACLs associated with My webMethods Server groups

1. Use an MWS deployment set to deploy the My webMethods Server groups to the target
Integration Servers.
2. Create an IS & TN deployment set containing the ACLs.
3. Mark the unresolved dependencies for the My webMethods Server groups as Exists.
4. Deploy the ACLs.

webMethods Deployer User’s Guide Version 9.6 102

 M  
Odd Header

Deploying ACLs Associated with LDAP Groups

If you want to deploy ACLs that are associated with LDAP groups, perform the
following steps.

To deploy ACLs associated with LDAP groups

1. Configure the LDAP groups on the target Integration Servers.
2. Create an IS & TN deployment set containing the ACLs.
3. Mark the unresolved dependencies for the LDAP groups as Exists.
4. Deploy the ACLs.

Adding Integration Server Administration Assets

Use the following procedure to add 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, select the check box next to each asset to add to the deployment set,
and then click Save. Deployer shows the selected assets in the left-hand pane under the
Administration folder for the deployment set.
3. If you are not going to add any more assets to the deployment set, go to "Resolving
Dependencies" on page 111.
4. 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
Using webMethods Integration Server to Build a Client for JMS.

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

You can add an Integration Server package to a deployment set as follows:
Add a package in its entirety.
Add selected package components only (partial package).
Add selected package files only (partial package).

webMethods Deployer User’s Guide Version 9.6 103

 M  
Even Header

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. In
this case, 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 all source Integration Servers.
2. In the right-hand pane, open the tree to show the packages on the source Integration Servers,
select the check boxes next to the packages to add in their entirety, and then click Save.
Deployer shows the entire package icon ( ) for the selected packages in the left-hand
pane under the Packages folder and in the right-hand pane, and a black check mark for the
packages in the right-hand pane.

Important: When you add an entire package to a deployment set, Deployer

automatically also adds all ports associated with that package. Be sure to substitute
configuration values for these ports if necessary (for instructions, see "Substituting
Configuration Values by Asset" on page 145).

3. If you are done adding packages to the deployment set, go to "Seing Package Properties"
on page 106.

Adding Package Components

If you choose to add both package components and package files to a deployment set,
you must be aware of the following:
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 all source Integration
Servers.
2. In the right-hand pane, open the tree to show the packages on the source Integration Servers,
and 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, select
the check box next to each component to add to the deployment set, and then click Save.

webMethods Deployer User’s Guide Version 9.6 104

 M  
Odd Header

4. Click Return to Packages. Deployer shows the partial package icon ( ) for the package in
the left-hand pane under the Packages folder and in the right-hand pane, and a gray check
mark for the package in the right-hand pane.
5. If you are done adding packages to the deployment set, go to "Seing Package Properties"
on page 106.

Adding Package Files

If you choose to add both package components and package files to a deployment set,
you must be aware of the following:
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 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 all source Integration Servers.
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 Click All files.

list

Only files you select Click Selected Files, then press the CTRL key and click
in 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 Click All except selected files, then press the CTRL key and
those you select in click each file to exclude from the deployment set.
the list

All files in the Click Files specified by filter, then type the string on
list whose name which to match the files to include in the deployment set.
contains a specified You can use an asterisk (*) as a wildcard character (for
string example, *.java or *.class).

webMethods Deployer User’s Guide Version 9.6 105

 M  
Even Header

To add... Do this...

All files in the Click All except files specified by filter, then type the
list whose name string on which to match the files to exclude from the
does not contain a deployment set. You can use an asterisk (*) as a wildcard
specified string character (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 Server2s, and the existing package contains files to delete after
deployment, type the fully qualified names of the files to delete in the Files to Delete from
Target box. Type each file name on its own line, and end each line with a semicolon (;). For
example:
code/classes/wm/administratorResource/admin.class;
code/classes/wm/administratorResource/user.class;
ns/wm/administratorResource/

5. Click Save.
6. Click Return to Packages. Deployer shows the partial package icon ( ) for the package in
the left-hand pane under the Packages folder and in the right-hand pane, and a gray check
mark for the package in the right-hand pane.
7. If you are done adding packages to the deployment set, go to "Seing Package Properties"
on page 106.

Setting Package Properties

You must set 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 Type Use this property when the source package already exists on
the target Integration Servers. You can use the options below
for entire packages and for partial packages.

If you want Deployer to... Click...

Deploy the source package, replacing the Full

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

webMethods Deployer User’s Guide Version 9.6 106

 M  
Odd Header

Property Entry

Deploy the components and files in the source Patch

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

Note: Before you deploy a project, you can find

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

Note: To retain the patch history of a package on the target

server, you must specify a build number for the package.

Patches Included Supply the list of patches that have been applied to the
deployed 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 Description Supply a description to use for the deployed package on

the target 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. When this happens, the target Integration Server will display a warning

webMethods Deployer User’s Guide Version 9.6 107

 M  
Even Header

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.
5. In the Package Deployment Options area, specify the following:

Option Entry

Activate After Deployment How Deployer should deploy the package. Click:
Activate to enable the package.
Install Only to install the package but not enable it.
Inbound Only to neither install nor enable the
package.

Sync Document Types Whether Deployer should synchronize the

publishable IS document types in the source
package with documents types on the webMethods
Brokers that are connected to the target Integration
Servers.

Note: The connected webMethods Brokers must be

available at deployment time for synchronization
to occur. If a connected webMethods Broker is not
available, IS document types are not synchronized
for the Integration Server to which the webMethods
Broker is connected. Deployer writes a message to
that effect to the deployment report. Deployer can
detect webMethods Broker unavailability when
you generate the simulation report and will write a
message advising you of the problem to the report.

To... Select...

Synchronize all publishable IS New

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

webMethods Deployer User’s Guide Version 9.6 108

 M  
Odd Header

Option Entry

Synchronize all publishable IS All

document types in the package.

Do not synchronize any IS None

document types.

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.

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

Adding webMethods Files

When Deployer deploys a webMethods file, the file retains the read/write permissions it
had on the source server.
For large projects, you might be able to stream webMethods files from the source server
to Deployer and from Deployer to the target server. For detailed information on this
option, see " Seing General Deployment Defaults" on page 77.

To add Integration Server files

1. In the Deployment Sets area, under the deployment set to which to add webMethods
files, click the webMethodsFiles 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 the selected assets in the left-hand pane under the
webMethodsFiles 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 111.

webMethods Deployer User’s Guide Version 9.6 109

 M  
Even Header

Adding Trading Networks Assets

Note: Your source and target Integration Servers might have assets in common, and
you therefore do not need to deploy them from one environment to another. You can
improve Deployer performance by excluding these assets from deployment sets. For
instructions, see "Excluding Common Assets" on page 110.

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 TN document type that is set up in Trading Networks for
duplicate checking using custom services, 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 the selected assets 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" on page 111.

Excluding Common Assets

Your source and target Integration Servers might have assets in common, and therefore
you do not need to deploy them from one environment to another. For example, you
might have created certain packages that exist on all your source and target Integration
Servers.
Deployer lets you identify these common assets so they will not appear in the asset
list when you define deployment sets or as referenced assets when you resolve
dependencies (see "Resolving Dependencies" on page 111, below). The assets you
specify on this list will be excluded for all IS & TN deployment sets in all projects.
Excluding these common assets improves Deployer performance by reducing the
amount of processing needed to produce the asset and dependencies lists, and by
preventing you from deploying unnecessary assets.
You identify the common assets in a file named common.cnf in the
Integration Server_directory\WmDeployer\config directory. By default, the file is pre-
populated with the names of Integration Server packages you should never deploy
to other Integration Servers using Deployer, but rather should only install on other
Integration Servers using the Software AG Installer. The file also includes instructions,

webMethods Deployer User’s Guide Version 9.6 110

 M  
Odd Header

lists the asset types you can exclude, and shows examples. List the assets you want to
exclude next to the appropriate asset types.

Resolving Dependencies
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 Example of Unresolved Dependencies

Set

webMethods If you add a client group but not the documents to which
Broker the client group can publish or subscribe, the documents are
unresolved dependencies.

IS & TN If you add a trigger but not the service that is invoked by the
trigger, the service is an unresolved dependency.

MWS If you add a page but not the portlets that are referenced by the
page, the portlets are unresolved dependencies.

Optimize If you add a rule but not the dimensions used by the rule, the
dimensions are unresolved dependencies.

ProcessModel If you add a process model but not the flow services called by the
process model, the flow services are unresolved dependencies.

In the project properties ("Seing the Dependency Checking Default" on page 77), 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 Assets

webMethods Deployer User’s Guide Version 9.6 111

 M  
Even Header

column lists the missing referenced assets. The next column offers the possible ways you can
resolve the unresolved dependency. The Asset 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. For
Integration Server assets, you can choose to add the referenced
asset or the entire package that contains the referenced asset.

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.

Unset If you have set the assets in a folder to various seings and want
to start over, use this option.

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.

webMethods Deployer User’s Guide Version 9.6 112

 M  
Odd Header

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 in

an IS & TN Deployment Set
Deployer cannot always detect all dependencies. If you are aware that an asset in an IS
& TN deployment set has a dependency on a package component, and Deployer has not
detected this dependency, you can manually add that dependency.
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.

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

Removing Process Models from a Deployment Set

When you add a process model to a ProcessModel deployment set and then add
referenced assets that reside on Integration 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.

webMethods Deployer User’s Guide Version 9.6 113

 M  
Even Header

Next Steps
Once you have selected assets for runtime-based deployment, you can do either of the
following:
Create a deletion set. See "Defining a Deletion Set" on page 125.
Build your project. See "Building a Runtime-Based Deployment Project" on page
135.

webMethods Deployer User’s Guide Version 9.6 114

 M  
Odd Header

8   Adding Assets for Repository-Based Deployment

■ Overview ..................................................................................................................................... 116
■ Selecting Composites ................................................................................................................. 116
■ Selecting Individual Assets from Composites ............................................................................ 117
■ Resolving Dependencies ............................................................................................................ 117
■ Resolving Conflicts ..................................................................................................................... 121
■ Deploying ACLs ......................................................................................................................... 122
■ Next Steps .................................................................................................................................. 122

webMethods Deployer User’s Guide Version 9.6 115

 M  
Even Header

Overview
In repository-based deployment, you can add only those assets from composites that
are present in the repository. The repository can contain several composites, and you
can deploy assets from any composite in the repository, but you cannot add assets
from more than one repository to one deployment set. Assets in one composite in the
repository can have dependencies on one or more assets in other composites in the
repository.
If you are adding assets for Integration Server, Trading Networks, or Broker, you have
the option of adding individual assets from a composite to your deployment set, instead
adding the entire composite.
Before you can add assets for repository-based deployment, you must perform the
following:
1. Build the composites and add a source repository. For more information, see
"Building Composites for Repository-Based Deployment" on page 31.
2. Configure a source repository. For more information, see "Connecting to a
Repository for Repository-Based Deployment" on page 68.
3. Connect to target servers, target groups, or both. For more information, see "Starting
Deployer and Connecting to Servers" on page 53.
4. Define a deployment set. For more information, see "Defining a Deployment Set" on
page 93.

Selecting Composites
Perform the following to select entire composites from the repository.

To select composites for a deployment set

1. In the Deployment Sets area of the Deployer > Projects > project > Define page, click for
every repository for which you want to add assets.
In the right-hand pane, Deployer displays the icon for runtime types contained in
the repository you selected.
2. Click the plus sign to expand the runtime types to display the composites they contain.
Deployer displays the icon for composites.
3. Click every composite whose assets should be part of the deployment set.
To select all of the composites for the runtime type, click . To select all of the
composites available on the repository, click .
4. Click Save.

webMethods Deployer User’s Guide Version 9.6 116

 M  
Odd Header

Deployer adds the runtime type and the child composites as children of the
deployment set in the Name column of the Deployer > Projects > project > Define page, in
the left-hand pane.

Selecting Individual Assets from Composites

For Integration Server, Trading Networks, and Broker (including JNDI) assets, you
can choose to add individual assets from composites rather than the entire composite.
Adding only some of the assets to the deployment set instead of the entire composite is
referred to as partial deployment.

Note: For the partial deployment of JNDI assets, export JMS destinations into one JNDI
context at a time. Partial deployment of JMS destinations into multiple JNDI contexts is
not supported.

Perform the following to select individual assets from composites.

To select individual assets for a deployment set

1. In the Deployment Sets area of the Deployer > Projects > project > Define page, click for
every repository for which you want to add assets.
In the right-hand pane, Deployer displays the icon for runtime types contained in
the repository you selected.
2. Click the plus sign to expand the runtime types to display the composites they contain.
Deployer displays the icon for composites.
3. Click the name of the composite from which you want to select individual assets.
Deployer displays the composite in the Select Components area of the right hand
pane.
4. Click the plus sign to expand the composite to reveal the assets it contains.
5. Click the assets that should be included in the deployment set.
6. Click Save.
Deployer displays the icon for a partial composite with the assets you selected as
its children in the Name column of the Deployer > Projects > project > Define page, in the
left-hand pane.

Resolving Dependencies
Deployer can determine when assets that are in a composite require other assets. The
assets that require assets from other composites are called dependent assets, while the
assets that are required are called referenced assets.

webMethods Deployer User’s Guide Version 9.6 117

 M  
Even Header

Deployer identifies missing referenced assets as follows:

Unresolved dependencies are those dependencies that are present in the repository, but
not in the deployment set. Deployer enables you to add, ignore, or automatically
resolve those dependencies. Deployer checks dependencies automatically and shows
one of the following in the Unresolved Dependencies column for the deployment set:

Deployer shows... When an asset in a composite contains...

Unresolved dependencies. You can resolve dependencies

automatically or manually.
For information about resolving dependencies
automatically, see "Resolving Dependencies
Automatically" on page 118.
For information about resolving dependencies manually,
see "Resolving Dependencies Manually" on page 119.

No unresolved dependencies.

Missing dependencies are those dependencies that are not available in the repository,
so you cannot add them to your deployment set. You can set Deployer to ignore
missing dependencies when you create the project (see " Creating a Project" on
page 83) or when you check unresolved dependencies. For more information about
seing missing dependency options while checking for unresolved dependencies,
see "Resolving Dependencies Manually" on page 119.

Resolving Dependencies Automatically

Perform the following procedure to set Deployer to resolve dependencies automatically.

To set Deployer to resolve dependencies automatically

1. In the Unresolved Dependencies column for the deployment set, click Check.
Deployer displays the Unresolved Dependencies page.
2. Click one of the following:

Option Description

Auto resolve by Composite Deployer automatically resolves all the

unresolved dependencies for the composite
in the deployment set. Deployer checks for
the dependencies in the repository. If the
dependent composites are available in the

webMethods Deployer User’s Guide Version 9.6 118

 M  
Odd Header

Option Description
repository, Deployer adds the composites to the
deployment set.
If the referenced composites are not available
in the repository, Deployer cannot add the
composites to the deployment set. You can then
choose to ignore the missing dependencies.

Auto resolve by Asset Deployer automatically resolves the partial

addition of composite at the asset level. For
example, if AssetA is dependent on AssetB in
CompositeB, then Deployer adds only AssetB,
instead of the entire composite (CompositeB).
If the referenced assets are not available in the
repository, Deployer cannot add the composites
to the deployment set. You can then choose to
ignore the missing dependencies.

Deployer lists the missing dependencies on the Missing Dependencies page when
you click Check in the Unresolved Dependencies column. You cannot add missing
dependencies to the deployment set.
3. To set Deployer to ignore the missing dependencies perform the following:
a. Click Ignore Missing Dependencies (Project Level).
b. Click Apply.
4. Click Save.

Resolving Dependencies Manually

Perform the following procedure to resolve dependencies manually.

To manually resolve dependencies

1. In the Unresolved Dependencies column for the deployment set, click Check.
Deployer shows all unresolved dependencies on the Unresolved Dependencies page as
follows:
The Referenced Asset Composites column lists the missing referenced assets.
The Unset/Add/Ignore column offers the possible ways you can resolve the
unresolved dependency.
The Assets column shows the dependent assets.

webMethods Deployer User’s Guide Version 9.6 119

 M  
Even Header

2. Click one of the following options to set how Deployer should resolve each unresolved
dependency. If you want to resolve all assets in a composite the same way, you can set the
resolution at the composite level rather than at the level of the individual assets.

Option Description

Unset This is the default status. If you click Unset after you have
made another selection (Add or Ignore) Deployer resets the
assets to an unresolved status. Use this option if you set the
assets in a composite to either Add or Ignore and want to start
over.

Add Adds the referenced asset to the deployment set. Use this
option if the referenced asset does not exist on the target
server and you want to deploy the referenced asset to it.
For Integration Server, Trading Networks, or Broker
(including JNDI) assets, you can choose to add the referenced
asset or the entire composite that contains the referenced
asset. Adding only the referenced asset to the deployment
set instead of the entire composite is referred to as partial
deployment.

Note: For the partial deployment of JNDI assets, export

JMS destinations into one JNDI context at a time for partial
deployment. Partial deployment of JMS destinations into
multiple JNDI contexts is not supported.

Ignore Ignores the asset. Use this option if you want to bypass
dependency checking for the referenced asset so you can
continue working.

Important: Before deploying, make sure that either 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 deploy correctly; if it can deploy,
the deployed assets will not run correctly.

3. Click Save.
Deployer moves dependencies you resolved using the Add option to the
Name column of the Deployer > Projects > project > Define page, in the left-hand
pane. If you added only a subset of Integration Server, Trading Networks, or
Broker (including JNDI assets) assets rather than an entire composite (partial
deployment), Deployer displays as a sibling of .

webMethods Deployer User’s Guide Version 9.6 120

 M  
Odd Header

Deployer adds dependencies you resolved using the Ignore option to the Name
column of the Deployer > Projects > project > Define page, but the dependency
remains listed on the Unresolved Dependencies page.

Resolving Conflicts
A conflict occurs when a dependent asset is available in multiple composites or when
different assets in one composite share the same asset name. Deployer displays conflicts
on the same page as unresolved assets.

To resolve conflicts
1. In the Unresolved Dependencies column for the deployment set, click Check.
Deployer shows all conflicted assets on the Unresolved Dependencies page as follows:
The Referenced Conflict Asset Composites column lists the assets in conflict.
The Unset/Add/Ignore column offers the possible ways you can resolve the conflict.
The Assets column shows the dependent assets.
2. Click one of the following options to set how Deployer should resolve each conflict.

Option Description

Unset This is the default status. If you click Unset after you have
made another selection (Add or Ignore) Deployer resets the
assets to an conflicted status. Use this option if you set the
assets in a composite to either Add or Ignore and want to start
over.

Note: After you use Unset to clear your previous selection, you
must set the asset to either Add or Ignore.

Add Adds the referenced assets to the deployment set. Use this
option to deploy the referenced assets.

Ignore Ignores the conflict. Use this option to ignore the referenced
assets.

3. Click Save.
Deployer moves dependencies for which conflicts were resolved using the Add
option to the Name column of the Deployer > Projects > project > Define page, in the
left-hand pane.
Deployer ignores the conflicts for those assets which you set to Ignore.

webMethods Deployer User’s Guide Version 9.6 121

 M  
Even Header

Deploying ACLs
If you want to deploy ACLs, you must perform extra steps depending on whether the
ACLs are associated with My webMethods Server groups or LDAP groups.

Deploying ACLs Associated with My webMethods Server Groups

If you want to deploy ACLs that are associated with My webMethods Server groups,
you must perform the following steps.

To deploy ACLs associated with My webMethods Server groups

1. Use an MWS deployment set to deploy the My webMethods Server groups to the target
Integration Servers.
2. Create an IS & TN deployment set containing the ACLs.
3. Mark the unresolved dependencies for the My webMethods Server groups as Ignore.
4. Deploy the ACLs.

Deploying ACLs Associated with LDAP Groups

If you want to deploy ACLs that are associated with LDAP groups, perform the
following steps.

To deploy ACLs associated with LDAP groups

1. Configure the LDAP groups on the target Integration Servers.
2. Create an IS & TN deployment set containing the ACLs.
3. Mark the unresolved dependencies for the LDAP groups as Ignore.
4. Deploy the ACLs.

Next Steps
Once you have selected assets for repository-based deployment, you can perform the
following.

To... See...

Add deletion sets to the project "Defining a Deletion Set" on page 125

Map the project "Mapping a Project" on page 139

webMethods Deployer User’s Guide Version 9.6 122

 M  
Odd Header

To... See...

Deploy the project "Deploying a Project" on page 149

webMethods Deployer User’s Guide Version 9.6 123

 M  
Even Header

webMethods Deployer User’s Guide Version 9.6 124

 M  
Odd Header

9   Defining a Deletion Set

■ About Deletion Sets ................................................................................................................... 126
■ Creating a Deletion Set ............................................................................................................. 126
■ Identifying Servers ...................................................................................................................... 128
■ Adding Assets to a Deletion Set ................................................................................................ 129
■ Resolving Dependencies in Repository-Based Deletion Sets ................................................... 132
■ Exporting and Importing Deletion Set Definitions ...................................................................... 132
■ Next Steps .................................................................................................................................. 133

webMethods Deployer User’s Guide Version 9.6 125

 M  
Even Header

About Deletion Sets

You use deletion sets to identify those assets you want to delete from the target server
during deployment. When you deploy the project, Deployer deletes the assets defined
in the deletion set from the target server and then deploys assets defined for the
deployment set from the source server to the target server.
Keep the following points in mind when working with deletion sets:
Deployer supports deletion sets for both runtime and repository-based projects.
If Deployer does not display a server you want to use as a target, you have not yet
set it up to work with Deployer. For more information about defining target servers,
see "Starting Deployer and Connecting to Servers" on page 53.
For runtime-based deployment, Deployer supports deletion sets for Broker,
Integration Server, and Trading Networks assets only. For repository-based
deployment, Deployer supports deletion sets for all runtimes.
Defining deletion sets involves the following stages:

Stage Procedure

Stage 1 Create a deletion set. See "Creating a Deletion Set" on page 126.

Stage 2 Identify target servers from which to delete the assets. See
"Identifying Servers" on page 128.

Stage 3 Add the assets to the deletion set. See "Adding Assets to a
Deletion Set" on page 129.

Stage 4 For repository-based deployment sets only, resolve dependencies.

See "Resolving Dependencies in Repository-Based Deletion Sets"
on page 132.

Stage 5 For runtime-based projects, you can export deletion set definitions
from one project and import them into another. See "Exporting
and Importing Deletion Set Definitions" on page 132.

Creating a Deletion Set

To create a deletion set, perform the following.

webMethods Deployer User’s Guide Version 9.6 126

 M  
Odd Header

To create a deletion set

1. In Deployer, go to the Deployer> Projects page.
2. If locking is enabled, in the Lock Status column for the project, click to lock the project.
3. In the Name column, click the project.
4. In the right-hand pane, click Define.
5. Click Create Set.
Deployer displays the Create Set properties in the right-hand pane.
6. Complete the following fields:

Box Entry

Type (Runtime-based deployment only.) Runtime type of the server

that contains the assets to delete.

Set Deletion

Name Name to use for the deletion set. The name can be up to 32
characters long and cannot contain spaces or the following
illegal characters:
$~/\#&@^!%*:;,+=><‘’"

Description Description for the deletion set. The description length has no
limit and can include any characters.

Maximum (Runtime-based deployment only.) Number of Trading

TN Assets to Networks assets Deployer should display. Depending on your
Display browser, Deployer might not be able to display more than 1000
assets for Trading Networks. If the source server hosts more
than 1000 assets, use this field with the with the All other assets
field to reduce the number of assets displayed.

Packages (Runtime-based deployment only.) After you choose the

servers from which to define deletion sets, Deployer displays
(IS & TN
all packages on the servers. You can use this field to narrow the
deletion
display. Type a regular expression that specifies the text that
set)
the package names must contain in order to be listed.

All other (Runtime-based deployment only.) After you choose the

assets servers from which to define deletion sets, Deployer will
display all assets on those servers. You can use this field to

webMethods Deployer User’s Guide Version 9.6 127

 M  
Even Header

Box Entry
narrow the display. Specify a regular expression that specifies
the text that the asset names must contain in order to be listed.

Important: Deployer can display up to 10,000 assets. If the source server hosts more
than 10,000 assets, use the Packages and All other Assets fields to reduce the number
of assets to be displayed.

7. Click Create.
Deployer displays the deletion set in the left-hand pane in the Deletion Sets area.
8. Perform the tasks in "Identifying Servers" on page 128 to identify the servers that
contain the assets to add to the deletion set.

Identifying Servers
To select the assets to add to the deletion set, you must first identify the servers that
contain those assets.
Deployer lists the version of each target server in the Version column. You must select
target servers with the same version for the deletion set. You cannot include target
servers with different versions in a deletion set. For information about selecting the
versions of target servers, see "Connecting to webMethods Servers" on page 54.
To identify servers for a deletion set in a runtime-based project, see "Identifying Servers
for a Runtime-Based Deletion Set" on page 128. To identify servers for a deletion set
in a repository-based project, see "Identifying Servers for a Repository-Based Deletion
Set" on page 129.

Identifying Servers for a Runtime-Based Deletion Set

Perform the following procedure to identify the servers for a deletion set in a runtime-
based project.

To identify servers for a runtime-based project

1. On the Deployer > Projects > project > Define page, in the left-hand pane in the Name column,
click the deletion set for which to identify servers.
2. In the Select Servers column in the right-hand pane, select the check box next to each server
that contains assets to add to the deletion set.
3. Click Save.
4. Perform the tasks in "Adding Assets to a Deletion Set" on page 129 to add assets to
the deletion set.

webMethods Deployer User’s Guide Version 9.6 128

 M  
Odd Header

Identifying Servers for a Repository-Based Deletion Set

Perform the following procedure to identify the servers for a repository-based project.

To identify servers for a repository-based project

1. On the Deployer > Projects > project > Define page, in the left-hand pane in the Name column
of the Deletion Sets Repository area, click the deletion set for which to identify servers.
2. In the deletion_set > Select Server area in the right-hand pane, select the runtime type of the
server to include in the deletion set from the Select Server Type list.
Deployer displays a list of all servers of the specified type that are set up to work
with your system.
3. Select the check box next to each target server that contains assets to add to the deletion set.
4. Click Add.
Deployer displays the server you added to Deletion Sets area in the left-hand pane.
5. Perform the tasks in "Adding Assets to a Deletion Set" on page 129 to add assets to
the deletion set.

Adding Assets to a Deletion Set

You can choose assets to add to a deletion set from any server that is similar to the target
server from which you want to actually delete the assets. Keep the following points in
mind when adding assets to a deletion set:
For Trading Networks, you cannot delete document aributes, field definitions,
binary types, or profile security data.
When you map a deletion set to target servers, Deployer identifies assets that
depend on the assets you want to delete and lets you resolve those dependencies
(see "Mapping a Project to Target Servers and Target Groups" on page 140).
However, Deployer can only detect dependencies among assets from the same type
of product (for example, among Integration Servers). It cannot detect dependencies
among assets from different products (for example, among Integration Servers and
ProcessModel servers). Make sure that assets you want to delete for one type of
product are not required by assets of other types of product.

Adding Assets to a Runtime-Based Deletion Set

Perform the following procedure to add assets to a runtime-based deletion set.

webMethods Deployer User’s Guide Version 9.6 129

 M  
Even Header

To add assets to a runtime-based deletion set

1. In the Deletion Sets area, under the deletion set to which to add assets, click the folder that
contains assets you want to add to the deletion set.
In the right-hand pane, Deployer lists the servers you identified in "Identify Source
Servers for the Deployment Set" on page 95.

Note: For information about adding full or partial packages to a deletion set, see
"Adding Packages to Deletion Sets" on page 130.

2. In the Select column of the Select Servers area, select the check box next to each source
server that contains assets to add to the deployment set.
Deployer lists the version of each source server in the Version column. You must
select servers with the same version for the deletion set. You cannot include servers
with different versions in a deletion set. For information about selecting the versions
of source servers, see "Connecting to webMethods Servers" on page 54.
3. In the right-hand pane, open the tree to show the assets on the servers, select the check box
next to each asset to add to the deletion set, and then click Save.
Deployer shows the selected assets in the left-hand pane under the folder you clicked
in the previous step.

Adding Assets to a Repository-Based Deletion Set

Perform the following procedure to add assets to a repository-based deletion set.

To add assets to a repository-based deletion set

1. In the Deletion Sets area, under the deletion set to which to add assets, click the server ( )
that contains assets you want to add to the deletion set.
2. In the Select Assets or Asset Components area in the right-hand pane, expand the tree to
display the assets on the servers and select the check box next to each asset to add to the
deletion set.
3. Click Save.
Deployer displays the assets you selected in the left-hand pane in the Deletion Sets
area. The assets are grouped by asset categories. For example, Integration Server
assets are grouped by isfile, ispackages, and so on.

Adding Packages to Deletion Sets

If you are creating an IS & TN deletion set, you can add Integration Server packages in
their entirety, or you can add selected package components only (called partial packages).
You can add full or partial packages to either runtime or repository-based projects.

webMethods Deployer User’s Guide Version 9.6 130

 M  
Odd Header

To add full or partial packages to deletion sets

1. Perform one of the following:

If your project is... Do this...

Runtime-based In the Deletion Sets Runtime area, under the deletion set to
which to add packages or partial packages, click the Packages
folder.

Repository- In the Deletion Sets area, under the deletion set to which to
based add the packages, click the server ( ) that contains packages
or partial packages.

In the right-hand pane, Deployer lists the Integration Servers you identified in
"Identify Source Servers for the Deployment Set" on page 95.
2. In the right-hand pane, expand the tree to display the packages on the Integration Servers,
then do one of the following:

To add... Do this...

Full packages Select the check boxes next to the packages to add in their
entirety to the deletion set and click Save. Deployer shows
the entire package icon ( ) for the selected packages in the
left-hand pane under the Packages folder (for runtime-based
deployment) or under the server (for repository-based
deployment).

Partial packages a. Click the package name.

b. In the Select Components area, open the tree to show the
package components, then select the check box next to each
component to add to the deletion set.
c. Click Save.
d. Click Return to Packages. Deployer shows the partial package
icon ( ) for the package in the left-hand pane under the
Packages folder (for runtime-based deployment) or under
the server (for repository-based deployment).

Note: If you add a partial package and later want to include the entire package
instead, cancel the selection of the components by clicking the name of the partial
package, clearing all checked boxes, and clicking Save. Then save the deletion set
and add the entire package as explained above.

webMethods Deployer User’s Guide Version 9.6 131

 M  
Even Header

Resolving Dependencies in Repository-Based Deletion Sets

For repository-based projects, Deployer checks dependencies in deletion sets
automatically and shows one of the following in the Unresolved Dependencies column for
the deployment set:

Deployer shows... When a deletion set contains...

Unresolved dependencies.

Important: You must resolve unresolved dependencies or

deployment will fail.

No unresolved dependencies.

Note: Deployer does not check dependencies in deletion sets for runtime-based projects.
For a full explanation of unresolved dependencies for a repository-based project, see
"Resolving Dependencies" on page 117.

Perform the following procedure to set Deployer to resolve dependencies for repository-
based deletion sets.

To resolve dependencies for a repository-based deletion set

1. In the Unresolved Dependencies column for the deployment set, click Check.
Deployer displays the Unresolved Asset References page.
2. Perform one of the following:
a. To automatically resolve all unresolved dependencies for the composite, click Auto
resolve all missing references.
b. To manually resolve unresolved dependencies, select the check box in the Add column
for each referenced asset to add to the deletion set and click Add.

Exporting and Importing Deletion Set Definitions

For runtime-based projects, Deployer exports and imports deletion set definitions
separately from the rest of the project properties exported and imported in "Exporting
and Importing Project Properties" on page 87.

Note: You cannot export and import deletion set definitions for repository-based
projects.

webMethods Deployer User’s Guide Version 9.6 132

 M  
Odd Header

When you export deletion set definitions, Deployer creates a file called
project _deleteSets.xml that contains the deletion set definitions. This file is stored in the
Integration Server_directory\instances\instance_name \packages\WmDeployer\replicate
\outbound directory. Deployer also gives you the option to save the file to your local
file system. You can then use this file to import the deletion set definitions into another
Deployer project.

To export and import deletion set definitions

1. Export deletion set definitions from a project as follows:
a. In Deployer, go to the Deployer > Projects page.
b. In the Name column, click the project from which to export.
c. In the right-hand pane, click Define.
d. Click Export Deletion Set Definitions.
2. Import deletion set definitions into a project as follows:
a. Copy the project _deleteSets.xml file to the Integration Server_directory\instances
\instance_name \packages\ WmDeployer\replicate\inbound directory on the machine that
hosts the project.
b. In Deployer, go to the Deployer > Projects page.
c. In the Name column, click the project into which to import.
d. In the right-hand pane, click Define.
e. Click Import Deletion Set Definitions, then select the project _deleteSets.xml file you just
copied to the inbound directory.

Next Steps
Once you have created a deletion set you can perform the following:

For... See...

Runtime-based projects, you can build "Building a Runtime-Based Deployment

your project. Project" on page 135

Repository-based projects, you can map "Mapping a Project" on page 139

your project.

webMethods Deployer User’s Guide Version 9.6 133

 M  
Even Header

webMethods Deployer User’s Guide Version 9.6 134

 M  
Odd Header

10   Building a Runtime-Based Deployment Project

■ Creating a Build ......................................................................................................................... 136
■ Rebuilding a Build ...................................................................................................................... 137
■ Exporting and Importing a Build ................................................................................................ 137
■ Next Steps .................................................................................................................................. 138

webMethods Deployer User’s Guide Version 9.6 135

 M  
Even Header

Creating a Build
To create a build
1. In Deployer, go to the Deployer > Projects page.
2. If locking is enabled, in the Lock Status column for the project, click to lock the project.
3. In the Name column, click the project.
4. Click Build. Deployer displays the Projects > project > Build page and lists all builds that
exist for the selected project.
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 137.
To see the progress report of the current or last action, click in the Progress Report
column. The progress report displays the updates for build requests as they occur.
This is useful in the case where the deployment build takes a long time to finish.
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 cannot contain spaces or the following illegal
characters:
$~/\#&@^!%*:;,+=><‘’"
7. In the Description box, you can type a description for the build. The description can be of any
length and can include any characters.
8. 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" on page 111.

9. To view the progress of the build, click the View Progress Report link. The progress report
displays the updates for build requests as they occur. This is useful in the case where the
deployment build takes a long time to finish.
10. Under Build History in the right-hand pane, click in the Report column to display the build
report in HTML or XML.
The build report lists the assets that were successfully included in the build,
describes any errors that occurred during the build process, and informs you if
the project contains unresolved dependencies. The report is also available under

webMethods Deployer User’s Guide Version 9.6 136

 M  
Odd Header

the name BuildReport_reportID .xml in the Integration Server_directory\instances

\instance_name \ packages\WmDeployer\pub\projects\project_name \builds
\build_name \reports folder, where project_name is the name of the project and
build_name is the name of the build.

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.

If you want to see the progress report, click in the Progress Report column. The
progress report displays the updates for build and rebuild requests as they occur. This is
useful in the case where the deployment build is large and it takes a long time to finish.

Important: Deployer does not take dependencies into account while rebuilding project
builds.
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.
When asset dependencies are changed on the source server, you must first remove
the dependent asset from the deployment set and save the deployment set. Then, add
the asset back and save the deployment set. When Deployer displays the changed
dependencies, resolve the dependencies and rebuild the project. For instructions on
displaying and resolving unresolved dependencies, see "Resolving Dependencies" on
page 111.

Exporting and Importing a Build

You can export the build you want to deploy from the Deployer in one environment and
import the build into the Deployer in another environment. The Deployer into which
you import the build 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 environment and import
it into the target project. For more information about importing and exporting maps, see
"Exporting and Importing a Map" on page 143.

To export and import a build

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

webMethods Deployer User’s Guide Version 9.6 137

 M  
Even Header

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 projectName _ExportedBuild_buildName
and is stored in the Integration Server_directory\instances\instance_name \packages
\WmDeployer\replicate\outbound directory. Deployer also allows you to save the file to
your local file system.
c. If you have previously exported a build of the same name, Deployer displays a dialog
box confirming that you want to overwrite the existing build. Click OK to overwrite the
existing build.
2. Import the build as follows:
a. Copy the projectName _ExportedBuild_buildName file to the
Integration Server_directory\instances\instance_name \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 projectName _ExportedBuild_buildName file you just
copied to the inbound directory.
d. Click Import.

Next Steps
Once you have created a build, you can map and deploy the project.

To... See...

Map the project "Mapping a Project" on page 139

Deploy the project "Deploying a Project" on page 149

webMethods Deployer User’s Guide Version 9.6 138

 M  
Odd Header

11   Mapping a Project
■ About Mapping a Project ........................................................................................................... 140
■ Mapping a Project to Target Servers and Target Groups .......................................................... 140
■ Exporting and Importing a Map ................................................................................................. 143
■ Substituting Configuration Values .............................................................................................. 144
■ Exporting and Importing Substitute Configuration Values .......................................................... 146

webMethods Deployer User’s Guide Version 9.6 139

 M  
Even Header

About Mapping a Project

Mapping a project involves the following tasks. Unless otherwise noted, you can
perform all tasks for both runtime-based and repository-based deployment projects.
Map a project to target servers and target groups. For more information, see
"Mapping a Project to Target Servers and Target Groups" on page 140.
Export a deployment map from one project and import it into another. For more
information, see "Exporting and Importing a Map" on page 143.
Specify configuration values to substitute for assets. For more information, see
"Substituting Configuration Values" on page 144.
Export substitute configuration values from one deployment map and import
them into another. For more information, see "Exporting and Importing Substitute
Configuration Values" on page 146.

Mapping a Project to Target Servers and Target Groups

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

To map a project to target servers

1. In Deployer, go to the Deployer > Projects page.
2. If locking is enabled, in the Lock Status column for the project, click to lock the project.
3. In the Name column, click the project.
4. In the right-hand pane, click Map. Deployer displays the Projects > project > Mappage
and lists all maps that exist for the selected project.
5. In the left-hand pane, click Create Deployment Map.
6. 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 cannot contain spaces or the following
illegal characters:
$~/\#&@^!%*:;,+=><‘’"
7. In the Description box, type a description for the map. The description length has no limit and
can include any characters.
8. Click Create.
9. Under the Deployment Map Topology area, in the Set Mapping column for a deployment set,
map to the target servers to which to deploy the assets, as follows:

webMethods Deployer User’s Guide Version 9.6 140

 M  
Odd Header

To add a... Do this...

Individual Click Add Target Server and then perform one of the
target server following:
For runtime-based projects, select the check box next to
each target server to which to deploy the assets in the
deployment set and then click Add.
For repository-based projects:
i. In the Select Server list, click the runtime type of the
target server.
ii. Select the check box next to each target group to
which to deploy the assets in the deployment set and
then click Add.
Notes:
For runtime-based projects, Deployer lists only those
servers running compatible versions for selection as
target servers. Repository-based deployment does not
support mapping to target servers of versions that are
different than the source repository. For information
about selecting the versions of source servers, see
"Connecting to webMethods Servers" on page 54.
If you are mapping a repository-based project that
contains BPM ProcessModels, you must also select the
physical Integration Server servers or My webMethods
Servers for each logical server in the deployment set from
the Map Logical Servers area of the Add Targets pane.
If a server you want to map to does not appear in the list,
you have not yet set it up to work with Deployer. For
instructions, see "Starting Deployer and Connecting to
Servers" on page 53. Then click Refresh this Page to update
the list of servers on this page.

Important: When you deploy Trading Networks assets,

Deployer updates the Trading Networks database with the
deployed assets. If Trading Networks is installed on multiple
Integration Servers, map deployment sets that contain
Trading Networks assets to only one of the Integration
Servers. Do not map to multiple Integration Servers or you
will experience unpredictable results when you deploy.

Target group Click Add Target Group and then perform one of the
following:

webMethods Deployer User’s Guide Version 9.6 141

 M  
Even Header

To add a... Do this...

For runtime-based projects, select the check box next to

each target group to which to deploy the assets in the
deployment set and then click Add.
For repository-based projects:
i. In the Select Server list, click the runtime type of the
target server.
ii. Select the check box next to each target group to
which to deploy the assets in the deployment set and
then click Add.
Notes:
For runtime-based projects, Deployer lists only those
target groups whose version is compatible with the
source servers in the deployment set. Repository-based
deployment does not support mapping to target servers
of versions that are different than the source repository.
For information about selecting the versions of source
servers, see "Connecting to webMethods Servers" on page
54.
If you are mapping a repository-based project that
contains BPM ProcessModels, you must also select the
physical Integration Server servers or My webMethods
Server target groups for each logical server in the
deployment set from the Map Logical Servers area of the
Add Targets Groups pane.

10. If you are mapping a runtime-based deployment deletion set, under the Deployment Map
Topology area, in the Set Mapping column, follow the instructions in the previous step, but
map to the target servers from which to delete the assets. The Important! note is also true for
deletion sets.
11. When Deployer returns to the map > Properties page, the Deployment Map Topology area
might show or .
For repository-based deployment projects, Deployer verifies whether the target
servers or target groups are available for deployment when you add them to
the deployment map. The Status column shows if the server is available for
deployment and if it is not.
For runtime-based deployment sets, appears in the Referenced Assets column
and 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

webMethods Deployer User’s Guide Version 9.6 142

 M  
Odd Header

stage and re-resolve the dependency in a different way. For more information,
see "Resolving Dependencies" on page 111 (for runtime-based deployment).
For deletion sets, dependencies work in the opposite direction from deployment
sets. Deployer finds all assets on the target servers that depend on assets in
the deletion set. If you were to delete the assets in the deletion set from the
target servers, the dependent assets would no longer work properly. On the
map >Properties page, in the Deployment Map Topology area, therefore, the icon
appears in the Dependent Assets column, and indicates that dependent assets
exist. Click to see the dependent assets, then choose whether to Add the
dependent assets to the deletion set or to Remove the assets they depend on from
the deletion set.

Important: Keep the following points in mind when working with dependencies:
Deployer cannot detect dependencies across products. Make sure assets you
want to delete are not required by assets of other products.
If you do not address problems at this time, Deployer will write messages
about them to the simulation report. If you deploy without addressing
problems, Deployer will not deploy the assets identified in the deployment
set or delete the assets identified in the deletion set.

12. If you are mapping a runtime-based deployment or deletion set and you resolved
dependencies in the previous step, the contents of the deletion set have changed. As a result,
you must rebuild the project (see "Rebuilding a Build" on page 137). If you exported
the deletion set definition or the project build, you must also re-export the definition (see
"Exporting and Importing Deletion Set Definitions" on page 132) and the build (see
"Exporting and Importing a Build" on page 137).

Exporting and Importing a Map

You can export the deployment map from one Deployer environment and import to
another Deployer environment. For example, you can export a map from the Deployer
in your development environment to the Deployer in your testing environment. You
must ensure that all target aliases in the test Deployer are the same as those in the
development Deployer.
Before you import a map, you can edit any of the aributes (for example, you could map
a deployment set to a different target server).

To export and import a map

1. Export a map as follows:
a. In the source Deployer, go to the Deployer > 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\instances\instance_name \packages\

webMethods Deployer User’s Guide Version 9.6 143

 M  
Even Header

WmDeployer\replicate\outbound directory. Deployer also allows you to save the file to

your local file system.
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
or target group. For instructions, see "Editing a Deployment Map, Project Properties, or
Substitute Configuration Values" on page 176.
3. Import the map as follows:
a. Copy the project_map .map file to the Integration Server_directory\instances
\instance_name \packages\WmDeployer\replicate\inbound directory on the machine that
hosts the target Deployer.
b. In the target Deployer, go to the Deployer > Projects >project > Map page.
c. Click Import Map, then select the project_map .map file you just copied to the inbound
directory.

Substituting Configuration Values

Some assets might be configured differently on the source server (for runtime-based
deployment) or repository (for repository-based deployment) than on the target
server. You use Deployer to substitute different configuration values for assets during
deployment so the assets will run properly on the target servers.
For example, 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
scheduled tasks, ports, adapter connections, adapter notifications, and extended seings.
You can substitute different configuration values for different target servers.
You can substitute configuration values as follows:

If you are creating a... You can substitute configuration values by...

Runtime-based deployment Asset or target server. See "Substituting

project Configuration Values by Asset" on page 145
and "Substituting Configuration Values by Target
Server (Runtime-Based)" on page 145.

Repository-based deployment Target server. See "Substituting Configuration

project Values by Target Server (Repository-Based)" on
page 146.

webMethods Deployer User’s Guide Version 9.6 144

 M  
Odd Header

Substituting Configuration Values by Asset

Note: You can substitute configuration values by asset only in runtime-based
deployment.

Perform the following steps to substitute configuration values by asset for runtime-
based deployment projects.

To substitute configuration values by asset

1. Under the Deployment Map Properties area, click Configure Builds by Assets. Deployer lists
assets that have configuration values in the left-hand pane.
2. Substitute different configuration values for an asset as follows:
a. In the left-hand pane, click the asset. Deployer displays the asset's configuration values as
they exist on the source server.
b. In the right-hand pane, type the configuration values to substitute.
c. In the bottom right-hand pane, select the target servers or target groups on which to make
the substitutions.
d. Click Save Substitutions.

Substituting Configuration Values by Target Server (Runtime-Based)

Perform the following steps to substitute configuration values by target server for
runtime-based deployment projects.

To substitute configuration values by target server for a runtime-based project

1. Under the Deployment Map Properties area click Configure Builds by Server. Deployer lists
the target servers that are mapped to the deployment set.
2. Select a target server. Deployer lists assets that have configuration values in the right-hand
pane.
3. Substitute different configuration values for an asset as follows:
a. In the right-hand pane, click the asset. Deployer displays the asset's configuration values
as they exist on the source server.
b. In the bottom right-hand pane, type the configuration values to substitute.
c. Click Save Substitutions.

webMethods Deployer User’s Guide Version 9.6 145

 M  
Even Header

Substituting Configuration Values by Target Server (Repository-

Based)
Perform the following steps to substitute configuration values by target server for
repository-based deployment projects.

To substitute configuration values by target server for a repository-based project

1. On the project > Map page, in the Configured column, click .
Deployer opens a new page that displays target servers and target groups that are
mapped to the deployment set.
2. In the project > deployment map > Target Servers pane, select the target servers for which you
want to substitute values.
Deployer lists the composites that have configuration values in the center
Configurable Composites pane.
3. Click the composite for which you want to substitute asset values.
Deployer displays the assets in the right-hand Configurable Components pane.
4. Click the assets in the Name (Implementation Type) column of the Configurable Components
pane.

Note: You can select more than one asset at a time.

Deployer displays the configuration values as they exist on the repository in the
Target Substitutions and Source Values pane. If you selected multiple assets, Deployer
displays the common properties but not source values.
5. In the bottom Target Substitutions and Source Values pane type the configuration values to
substitute.
6. Click Save Substitutions to save the substitutions, or Restore Defaults to clear the changes
you made.

Exporting and Importing Substitute Configuration Values

You can export and import substitute configuration values for both runtime-based and
repository-based deployment projects.

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 Deployer > Projects > project > Mappage.
b. Click the deployment map that contains the substitute configuration values to export.
Deployer displays the deployment map properties in the right-hand pane.

webMethods Deployer User’s Guide Version 9.6 146

 M  
Odd Header

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\instances\instance_name \packages
\WmDeployer\ replicate\outbound directory. Deployer also allows you to save the file to
your local file system.
d. If you exported substitute configuration values for scheduled tasks, open the
project_map .vs file in an XML editor and set the task ID for each scheduled task to the
task ID used on the target Integration Server.
2. Import the substitute configuration values into a deployment map as follows:
a. Copy the project_map .vs file to the Integration Server_directory\instances
\instance_name \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.
If you receive the error message "Input XML map information is not valid" while
importing a variable substitution .vs file, open the file and do the following:
i. Make sure the project contains all deployment sets specified on the
DeploymentSet nodes.
ii. For DeploymentSet nodes, make sure the PluginGroup value is set to either
true or false, and the PluginType value is correct.
iii. Make sure each DeploymentSet node is mapped to the correct TargetSystem
name as specified in the exported project_map .vs file
iv. Try to import again.

webMethods Deployer User’s Guide Version 9.6 147

 M  
Even Header

webMethods Deployer User’s Guide Version 9.6 148

 M  
Odd Header

12   Deploying a Project
■ Overview ..................................................................................................................................... 150
■ Preparing Integration Server to Stream Large Repository-Based Projects ................................ 150
■ Generating a Checkpoint ........................................................................................................... 151
■ Deploying a Project .................................................................................................................... 152
■ Post-Deployment Tasks .............................................................................................................. 155
■ Rolling Back Target Servers ...................................................................................................... 155

webMethods Deployer User’s Guide Version 9.6 149

 M  
Even Header

Overview
Deploying a project involves the following tasks:
Prepare Deployer to stream large repository-based projects (optional).
Generate a checkpoint. See " Generating a Checkpoint" on page 151.
Deploy or simulate the deployment of a project. See " Deploying a Project" on page
152.
Post-deployment tasks. See " Post-Deployment Tasks" on page 155.
Roll back the target servers. See " Rolling Back Target Servers" on page 155.

Preparing Integration Server to Stream Large Repository-

Based Projects
Note: For information about streaming large runtime-based projects, see the description
of the Large File Support option in " Seing General Deployment Defaults" on page 77.

OverviewIf you choose to stream repository-based projects from Deployer to the target
server, you must set certain server configuration seings on every target Integration
Server hosting the runtime and Deployer. The build size of a project containing
Integration Server packages and webMethods files can be up to 4GB.
You can stream assets from Deployer to target servers for the following runtime types:
Integration Server
Trading Networks
BPM process models
EDA
Event Server

Note: Deployer supports deployment of assets to Event Servers of version 9.5 or

earlier only.

To set server configuration parameters

1. For every target Integration Server hosting the runtime type and Deployer, open the
Integration Server Administrator and go to the Settings > Extended > Edit Extended Settings
page.

webMethods Deployer User’s Guide Version 9.6 150

 M  
Odd Header

2. Type the following server configuration parameters and values in the box. For complete
information about these server configuration parameters, see the webMethods Integration
Server Administrator’s Guide.
wa.server.SOAP.MTOMStreaming.enable=true
wa.server.SOAP.MTOMStreaming.cachedFiles.location=directory_path
wa.server.SOAP.MTOMStreaming.threshold=number_of_bytes
3. Click Save Changes and restart Integration Server.

Generating a Checkpoint
You generate a checkpoint for a project when you want the option of rolling back the
target server to the state it was in prior to deploying your project. The checkpoint
contains a copy of the assets on the target server that will be replaced by the assets in the
deployment sets. You can set Deployer to generate checkpoints automatically or you can
generate checkpoints manually for both runtime-based and repository-based projects.
Keep the following points in mind when working with checkpoints:
If you take multiple checkpoints for a deployment candidate, only the latest is
retained.
The target servers must be available for the checkpoint generation to be successful.

Generating an Automatic Checkpoint

When Deployer generates checkpoints automatically, it does so as the first step of the
deployment process when you deploy a project. You set Deployer to create automatic
checkpoints as part of creating the project.

To set automatic checkpoint generation

For runtime-based projects, you set the project to generate checkpoints automatically through
the Checkpoint Creation parameter. For more information, see " Seing Default Properties
for All Projects" on page 77.
For repository-based projects, Deployer generates automatic checkpoints when you enable
transactional deployment through the Enable Transactional Deployment parameter. For more
information, see " Creating a Project" on page 83.

Generating a Checkpoint Manually

You can generate a checkpoint manually for both runtime-based and repository-based
projects.

webMethods Deployer User’s Guide Version 9.6 151

 M  
Even Header

To generate a checkpoint manually

1. In the Deployment Candidates list, click in the Checkpoint column. The checkpoint
report appears in the right-hand pane in the Deployment History area.
2. 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.
The report is also available under the name CheckpointReport_reportID .xml in the
Integration Server_directory\instances\instance_name \packages\WmDeployer\pub
\projects\project_name \checkpoints\deployment_map \project_name Checkpoint
\reports folder, where project_name is the name of the project and deployment_map is
the name of the deployment map.

Deploying a Project
When you deploy a project, Deployer deploys the assets in the project to the target
servers.
You can simulate a deployment before you actually deploy. When you simulate a
deployment, Deployer generates a simulation report that scans the 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. 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
overwrien, and configuration values that will be substituted for Integration Server
assets.
Messages about problems, such as unresolved dependencies.

To 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 Deployer > Projects page.
3. If locking is enabled, in the Lock Status column for the project, click to lock the project.
4. In the Name column, click the project.
5. 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.

webMethods Deployer User’s Guide Version 9.6 152

 M  
Odd Header

6. In the left-hand pane, click Create Deployment Candidate.

7. Set the Create Deployment Candidate parameters as follows:

Parameter Description

Name 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 cannot contain spaces or the following
illegal characters:
$~/\#&@^!%*:;,+=><‘’"

Description Type a description for the deployment candidate. The

description length has no limit and can include any
characters.

Project Build (Run-time based deployment only.) Click the project build
to deploy.

Deployment Map Click the deployment map that identifies the target servers
to which to deploy the assets.
If the words Missing referenced assets appear next to the map
name in the list, it means that you resolved an unresolved
dependency using the Exists option, but the referenced
asset 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. For more information, see
"Resolving Dependencies" on page 111 (for runtime-based
deployment) or "Resolving Dependencies" on page 117 (for
repository-based deployment).
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 .
9. If you want to see the progress report, click in the Progress Report column.

webMethods Deployer User’s Guide Version 9.6 153

 M  
Even Header

The progress report displays the updates for simulate, deploy, checkpoint and
rollback requests as they occur. This is useful in the case where the deployment build
is large and it takes a long time to complete the action.

Note: If you are deploying a runtime-based project, you can rebuild the project build
before proceeding. For instructions, see "Rebuilding a Build" on page 137.

10. 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. The report is also
available under the name project_name _previewReport_reportID .xml in the
Integration Server_directory\instances\instance_name \packages\WmDeployer\pub
\projects\project_name \targets\deployment_map \reports folder, where project_name
is the name of the project and deployment_map is the name of the deployment map.

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 "Resolving Dependencies" on page 111 (for runtime-based
deployment) or "Resolving Dependencies" on page 117 (for repository-based
deployment).

11. Click in the Deploy column for the deployment candidate. Deployer does the following:
Deploys the assets in the project to the target servers.
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. The report is
also available under the name project_name _auditReport_reportID .xml
in the Integration Server_directory \instances\instance_name \packages
\WmDeployer\pub\projects\project_name \targets\deployment_map \reports
folder, where project_name is the name of the project and deployment_map is the
name of the deployment map.
If you are creating a runtime-based deployment project, Deployer performs the
following additional tasks:
If you chose automatic checkpointing or automatic rollback in the project
properties, Deployer automatically generates a checkpoint at this time. If
you chose manual checkpointing and no checkpoint exists, Deployer asks
whether you want to deploy anyway. If you deploy without a checkpoint,
you will not be able to roll back the target servers.
If the project build contains deletion set definitions, Deployer deletes
the specified assets from the target servers you identified in the selected
deployment map.

webMethods Deployer User’s Guide Version 9.6 154

 M  
Odd Header

If you are creating a repository-based deployment project and you set the Enable
Transactional Deployment property to Yes, Deployer creates the checkpoint for the
target server. For more information about the Enable Transactional Deployment
property, see " Creating a Project" on page 83.

Post-Deployment Tasks
If you deployed JMS triggers, do the following:
1. Create the same JMS alias connections on the target Integration Servers that exist
on the source Integration Servers. Then reload the packages that contain the
triggers.
2. Enable the JMS triggers.
3. Configure the queue or topic for each JMS trigger on the message provider for
the target Integration Servers.
For instructions, see Using webMethods Integration Server to Build a Client for JMS.
If you deployed My webMethods Server rules, the order in which the deployed rules
are resolved with the existing rules on the target servers might need modification.
Review the rule order and modify as necessary.
If you deployed a process that uses e-forms with the project property Enable process
for execution set to No (see " Creating a Project" on page 83), the e-form listener
associated with the process cannot be enabled on the target server and therefore the
process cannot be triggered on the target server. To make the process triggerable on
the target server, enable it for execution and then enable the e-form listener.

Rolling Back Target Servers

If deployment to a target server 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. When you roll back
a deployment, Deployer rolls back the target server to the last checkpoint generated
for the project. For more information about generating checkpoints, see " Generating a
Checkpoint" on page 151.
You can set Deployer to roll back target servers automatically or you can roll back target
servers manually after deployment.

Rolling Back Target Servers Automatically

Deployer automatically rolls back target servers for runtime-based projects in these
cases:

webMethods Deployer User’s Guide Version 9.6 155

 M  
Even Header

You set the Rollback on Error project seing to Automatic (see " Seing General
Deployment Defaults" on page 77). If the deployment fails on a target server,
Deployer automatically rolls back that target server.
Deployment failed to a target group whose Rollback All on Failure seing is Yes (see
" Creating Target Groups" on page 70). If deployment to any server in such a target
group fails, Deployer automatically rolls back all servers in the target group.
Deployer automatically rolls back the target servers for repository-based projects when
transactional deployment is enabled for the project and deployment fails. For more
information about enabling transactional deployment, see " Creating a Project" on page
83.

Rolling Back Target Servers Manually

For runtime-based projects, you can roll back target servers manually at any time after
deployment if you performed both of the following:
You set the Rollback on Error project seing to Manual. For more information about this
seing, see " Seing Default Properties for All Projects" on page 77.
You did not deploy to a target group whose Rollback All on Failure seing is Yes. For
more information about this seing, see " Creating Target Groups" on page 70.
For repository-based projects, you can roll back target servers manually if you
performed either of the following:
You enabled transactional deployment to create an automatic checkpoint through the
Enable Transactional Deployment parameter. For more information about transactional
deployment, see " Creating a Project" on page 83.
You generated a manual checkpoint for the project. For more information about
generating a manual checkpoint, see "Generating a Checkpoint Manually" on page
151.

To roll back target servers manually

1. In the Deployment Candidates list, click in the Rollback column.
Deployer displays the rollback report in the right-hand pane in the Deployment History
area.
2. To display the rollback report, click next to Rollback in the Report Type column. The
report is also available under the name project_name _auditReport_reportID .xml in the
Integration Server_directory\instances\instance_name \packages\ WmDeployer\pub
\projects\project_name \targets\deployment_map \reports folder, where project_name is
the name of the project and deployment_map is the name of the deployment map.
If you rolled back an IS & TN deployment set, the following apply:
If the Activate After Deployment option for a package was set to Inbound Only, the report
will warn that the package is not present on the target Integration Servers. You can
ignore this warning.

webMethods Deployer User’s Guide Version 9.6 156

 M  
Odd Header

If the deployment set included webMethods files, the directory structure for those
files remains in the webMethods installation directory on the target servers. You can
delete the directories manually.
If you deployed Trading Networks document aributes, field definitions, binary
types, or profile security data, Deployer does not roll them back.
If you rolled back a ProcessModel deployment set, the rollback behavior varies, as
follows:
For process models you deployed that were versions of existing process models
on the target servers, Deployer rolled back the deployed versions from the target
servers.
For deployed process models that were new on the target servers, Deployer disables
the deployed process models but does not remove them from the target servers.
If you rolled back Universal Messaging assets, the rollback behavior is as follows:
Deployer will not roll back the assets if the port is already being used by another
existing interface.
Deployer does not roll back nested security groups. For example, if group1 contains
group2, the rollback will not restore the nested group2.

webMethods Deployer User’s Guide Version 9.6 157

 M  
Even Header

webMethods Deployer User’s Guide Version 9.6 158

 M  
Odd Header

13   Using Deployer Commands

■ Overview ..................................................................................................................................... 160
■ Installing Command Line Interface Only .................................................................................... 160
■ Creating and Running Scripts .................................................................................................... 160
■ Specifying Log On Parameters .................................................................................................. 163
■ Error Handling and Logging ....................................................................................................... 165
■ General and Project Commands ............................................................................................... 166
■ Build Commands ........................................................................................................................ 170
■ Commands for Repository-Based Deployment .......................................................................... 175
■ Map Commands ......................................................................................................................... 176
■ Deployment Commands ............................................................................................................. 180

webMethods Deployer User’s Guide Version 9.6 159

 M  
Even Header

Overview
You can use the command line interface to enter commands at a command prompt. The
command line interface allows you to use many of the same features that are available in
the Deployer GUI.

Installing Command Line Interface Only

You can install the Deployer command line interface on a machine, without installing
the rest of Deployer or a host Integration Server. You might do this if you are using an
automated deployment procedure that spans multiple machines.
To install only the Deployer command line interface on a machine, copy the files listed
below from the indicated location on an existing remote Deployer host machine to the
same location on the local machine.

File Location

CLI.jar Integration Server_directory/instances/instance_name /

packages/WmDeployer/lib

log4j.properties Deployer. Integration Server_directory/instances/instance_name /

{bat|sh} packages/WmDeployer/bin

wm-isclient.jar Software AG_directory/common/lib

jargs.jar mail.jar log4j.jar Software AG_directory/common/lib/ext

Edit the Deployer.{bat|sh} file you copied to the local machine to point to the jar files
you copied and to a JDK or JRE 1.6 on the local machine.

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 for
your operating system as follows:

webMethods Deployer User’s Guide Version 9.6 160

 M  
Odd Header

For... Command

Windows or Deployer.{bat|sh} path_to_file

UNIX

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.
: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 side effects of
previous executions cases
set ERRORLEVEL=
:importBuild
set importB=%proj ect%_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 "%ERROR LEVEL%" == "8" GOTO FINISH
ECHO ---------------------------------------------------------------------------
ECHO Describing %build%
ECHO ---------------------------------------------------------------------------
call Deployer. bat --describe -build %build% -project %project% -host %host% -port

webMethods Deployer User’s Guide Version 9.6 161

 M  
Even Header

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

webMethods Deployer User’s Guide Version 9.6 162

 M  
Odd Header

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

webMethods Deployer User’s Guide Version 9.6 163

 M  
Even Header

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

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 Host machine and port for the Integration Server to
port log on to.

-user user-pwd User name and password to use to log on to the

password Integration Server.

Note: If you do not provide a password, Deployer will

prompt you for it.

-useSSL Tells the Deployer command to log on to an HTTPS

port.

-senderCert Command line

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

webMethods Deployer User’s Guide Version 9.6 164

 M  
Odd Header

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\instances\instance_name \packages\WmDeployer\bin
directory.
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 a directory
inside the current working directory. For example, if your working directory is
Integration Server_directory\instances\instance_name \packages\WmDeployer, CLI.log
is located in the Integration Server_directory\instances\instance_name \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 9.6 165

 M  
Even Header

General and Project Commands

This section describes the commands to display Deployer usage information and
product details and to maintain projects.

About
The --about command displays the following details about Deployer:
JVM version number
Publisher information
Build number
Package name
Copyright information
Integration Server version number
Run the following command to see the project details:
Deployer.{sh|bat} --about -host host -port port -user user_name -pwd password

Deleting a Project
Run the following command to delete 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

For more information about deleting projects, see "Deleting a Project" on page 90.

Displaying Project Properties

Run the following command to display 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

Exporting Deletion Sets from a Project

When you run the --export command, Deployer creates a file that contains
the definitions. The file is named project _deleteSets.xml and is stored in the

webMethods Deployer User’s Guide Version 9.6 166

 M  
Odd Header

Integration Server_directory\instances\instance_name \packages\WmDeployer\replicate

\outbound directory.
Run the following command to export a deletion set:

Important: You must have Define ACL authorization to run this command.
Deployer.[sh|bat] --export -deleteSpec -project project
-overwrite -host host -port port -user user_name -pwd password

Parameter Description

-project project Project whose deletion set definitions to export.

-overwrite If the project already contains a file with the same name,
this options tells Deployer to overwrite it. If you do not
overwrite, and a file with the same name exists, Deployer
issues an error and ends the command.

Importing Deletion Set Definitions into a Project

Before you can import deletion set definitions, you must copy the exported
project _deleteSets.xml file to the Integration Server_directory\instances
\instance_name \packages\WmDeployer\replicate\inbound directory.
If the project already contains a deletion set with the same name as one you are
importing, Deployer issues an error and ends the command.
Run the following command to import a deletion set into a project:

Important: You must have Define ACL authorization to run this command.
Deployer.{sh|bat} --import -deleteSpec definitions_
file -project project
-host host -port port -user user_name -pwd password

Parameter Description

-deleteSpec Full path to the file that contains the definitions

definitions_file to import. Definition files are named
project _deleteSets.xml and are located in
the Integration Server_directory\instances
\instance_name \packages
\WmDeployer\replicate\inbound directory.

-project project Project into which to import the definitions.

webMethods Deployer User’s Guide Version 9.6 167

 M  
Even Header

Exporting Project Properties

When you export a project’s properties, Deployer creates a file that contains the
project property seings. The file is named project .properties and is stored in the
Integration Server_directory\instances\instance_name \packages\WmDeployer\replicate
\outbound directory. For more information about exporting project properties, see
"Exporting and Importing Project Properties" on page 87.
Run the following command to export project properties:

Important: You must have Administrator ACL authorization to run this command.
Deployer.{sh|bat} --export -projectProperties project
-host host -port port -user user_name -pwd password

Parameter Description

projectProperties Project from which to export properties.

project

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\instances\instance_name \packages
\WmDeployer\replicate\inbound directory on the machine that hosts the target
Deployer.
You can edit the properties before you import them (see "Editing a Deployment Map,
Project Properties, or Substitute Configuration Values" on page 176). If you do, keep
in mind the following:
You can specify ALWAYS or NEVER for the overwrite property.
You can specify REPLACE OR MERGE for the deployTNRules property.
You can specify true, false, or selected for the stopTriggers property.
You can specify true or false for all other properties.
If you specify a value for a property that is not allowed, Deployer resets the property to
the default value when it imports the project properties.
Run the following command to import a project’s properties:

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

webMethods Deployer User’s Guide Version 9.6 168

 M  
Odd Header

Parameter Description

-project Project into which to import the properties.

project

-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\instances
\instance_name \packages\WmDeployer\replicate\inbound
directory.

Help
Run the following command to view a list of Deployer commands you can use in the
command line interface:
Deployer.{sh|bat} --help -command command_string

Parameter Description

-command command_string Command for which you want usage information.

Listing Builds, Maps, or Deployment Candidates for a Project

Run the following command to list builds, maps, or deployment candidates for a build:

Important: You must have the correct authorizations to run this command depending on
whether you want to list builds, maps, or deployment candidates.
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 {Build|Map| Whether to list builds, maps, or deployment

DC} candidates.

-project project Project that contains the builds, maps, or

deployment candidates to list.

webMethods Deployer User’s Guide Version 9.6 169

 M  
Even Header

Locking Projects
Run the following command to lock a project:
Deployer.{sh|bat} --lockProject -project project
-host host -port port -user user_name -pwd password

Unlocking Projects
Run the following command to unlock a project:
Deployer.{sh|bat} --unlockProject -project project
-host host -port port -user user_name -pwd password

Build Commands
This section describes the commands to create, export, import, and display details about
a build.

Creating a Project Build

When creating a project build, the build creation will fail if there are any unresolved
dependencies. For instructions on resolving unresolved dependencies, see "Resolving
Dependencies" on page 111.
Run the following command to create a project build:

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 -reportFilePath report_path

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 from which to create the build.

project

- Full path to the local directory where Deployer stores the

reportFilePath generated build report.
report_path

webMethods Deployer User’s Guide Version 9.6 170

 M  
Odd Header

Listing Builds for a Project

Run the following command to list the builds in 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

Displaying Contents of a Build

Run the following command to display the contents of a specific 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 to which the build belongs.

project

Displaying Substitute Configuration Values for Integration Server

Assets in a Build
Use the following command to display 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 to which the build belongs.

project

-varsub Displays the substitute configuration values.

webMethods Deployer User’s Guide Version 9.6 171

 M  
Even Header

Displaying Contents of a Build File

Use the following command to display 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 Full path to the build file whose contents to display.

build_file Build files are named project _build and are located in the
Integration Server_directory\instances\instance_name \packages
\WmDeployer\replicate\outbound directory.

-project Project to which the build belongs.

project

Displaying Substitute Configuration Values for Integration Server

Assets in a Build File
Use the following command to display 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 Full path to the build file whose substitute configuration

build_file values to display. Build files are named project _build and
are located in the Integration Server_directory\instances
\instance_name \packages\WmDeployer\replicate\outbound
directory.

-project Project to which the build belongs.

project

-varsub Displays the substitute configuration values.

webMethods Deployer User’s Guide Version 9.6 172

 M  
Odd Header

Exporting a Build from a Project

Use the following command to export 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 -host host -port port -user user_name -pwd password

Parameter Description

-build build Build to export.

-project Project to which the build belongs.

project

-overwrite If the project already contains a build with the same name, this
options tells Deployer to overwrite it. If you 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\instances\instance_name \packages
\WmDeployer\replicate\outbound directory.

Importing a Build File into a Project

Before you can import a build, you must copy the exported project _build file to the
Integration Server_directory\instances\instance_name \packages\WmDeployer\replicate
\inbound directory on the machine that hosts the target Deployer.
Run the following command to import a build file into a project.

Important: You must have Build ACL authorization to run this command.
Deployer.{sh|bat} --import -buildFile build_file -project project
-overwrite -host host -port port -user user_name -pwd password

Parameter Description

-buildFile Full path to the build file that contains the deployment map
build_file to import. Build files are named project _build and are located
in the Integration Server_directory\instances\instance_name \
packages\WmDeployer\replicate\inbound directory.

webMethods Deployer User’s Guide Version 9.6 173

 M  
Even Header

Parameter Description

-project Project into which to import the build.

project

-overwrite If the project already contains a build with the same name, this
options tells Deployer to overwrite it. If you do not overwrite,
and a build with the same name exists, Deployer issues an
error and ends the command.

Listing Build Reports

Run the following command to list the build reports for a project.

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 to which the build belongs.

project

Displaying a Build Report

Run the following command to display 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 for the report to display. Use the --list command
identifier (see "Listing Build Reports" on page 174) to display report
identifiers, as well as the date and time each report was
generated.

webMethods Deployer User’s Guide Version 9.6 174

 M  
Odd Header

Parameter Description

-project Project to which the build belongs.

project

Commands for Repository-Based Deployment

This section describes commands you can run specific to building indexes for repository-
based deployment.

Rebuilding the Index with the Build Script

If the index you created becomes corrupted or the repository index is accidentally
deleted from the repository, you can use the createIndex command to recreate the
index.
By default, the createIndex command rebuilds the index in the location specified by the
build.output.dir property you specified in "Seing the Properties for the Build" on page
34. You can override the default repository path by specifying the path of the repository
with the -Drepo.dir command.

Note: When you follow this procedure to rebuild the index, the build script creates
only the index. To build the index, check out the asset sources, version the assets, and
build the composites and descriptors in the repository, you must run the build script as
described in "Running the Build Script and Rebuilding the Index" on page 42.

Run one of the following commands from the Software AG_directory\common

\AssetBuildEnvironment\bin directory:

For this platform... Run the following command...

Windows build.bat -Drepo.dir=repository_path createIndex

UNIX build.sh -Drepo.dir= repository_path createIndex

Where repository_path is the full path of the repository directory.

Note: If you do not specify a path for -Drepo.dir, the build script indexes the
repository specified by the build.output.dir property. For more information about the
build.output.dir property, see "Seing the Properties for the Build" on page 34.

webMethods Deployer User’s Guide Version 9.6 175

 M  
Even Header

Map Commands
This section describes the commands to list, import, export, edit, and delete deployment
maps.

Important: You must have Map ACL authorization to run the commands in this section.

Listing All Deployment Maps

Run the following command to list the deployment maps for a candidate.
Deployer.{sh|bat} --list -candidate mapFile
-host host -port port -user user_name -pwd password

Exporting a Deployment Map from a Project

When you export a deployment map from a project, Deployer creates a file that
contains the deployment map. The file is named project_map .map and is stored in the
Integration Server_directory\instances\instance_name \packages\WmDeployer\replicate
\outbound directory.
Run the following command to export a deployment map:
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 to which the map belongs.

project

Editing a Deployment Map, Project Properties, 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 aribute 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">

webMethods Deployer User’s Guide Version 9.6 176

 M  
Odd Header

<DeploymentSets>
<DeploymentSet name="deploymentSetName " pluginType="pluginType ">
<targetGroups>
<targetGroup alias="targetGroupName "/>
</targetGroups>
<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 aribute for each addition. For example, a deployment set
that is mapped to multiple target servers is defined as follows:
<DeploymentMap>
<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\instances\instance_name \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,
Project Properties, or Substitute Configuration Values" on page 176).
Run the following command to import a deployment map into a project:
Deployer.{sh|bat} --import -mapFile map_file -project project
-overwrite -host host -port port -user user_name -pwd password

Parameter Description

-mapFile Full path to the map file that contains the deployment map to
map_file import. Map files are named project_map .map and are located
in the Integration Server_directory\instances\instance_name \
packages\WmDeployer\replicate\inbound directory.

-project Project into which to import the map.

project

webMethods Deployer User’s Guide Version 9.6 177

 M  
Even Header

Parameter Description

-overwrite If the project already contains a map with the same name, this
options tells Deployer to overwrite it. If you do not overwrite,
and a map with the same name exists, Deployer issues an
error and ends the command.

Exporting Substitute Configuration Values for Integration Server

Assets from a Deployment Map
Run the following command to 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 to which the map belongs.

project

-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\instances
\instance_name \packages\WmDeployer\ replicate\outbound directory.
If you exported substitute configuration values for scheduled tasks, open the
project_map .vs file in an XML editor and set the task ID for each scheduled task to the
task ID used on the target Integration Server.

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\instances
\instance_name \packages\WmDeployer\replicate\inbound directory on the machine
that hosts the target Deployer.

webMethods Deployer User’s Guide Version 9.6 178

 M  
Odd Header

You can open the project_map .vs file in an XML editor and edit the values before
importing. For example, if you exported substitute configuration values for scheduled
tasks, you must edit the file for each target Integration Server so that the task ID for each
scheduled task is set to the task ID used on the target Integration Server.
Run the following command to import substituted configuration variables for
Integration Server assets into a deployment map:
Deployer.{sh|bat} --import -varsub -vsFile project_map .vs -map map
-project project -validate {true|false}
-host host -port port -user user_name -pwd password

Parameter Description

-varsub Imports the variable substitution values.

-vsFile File that contains the substitute configuration values to import.

project_map.vs These files are named project_map .vs and are located in the
following directory:
Integration Server_directory\instances\instance_name \packages
\WmDeployer\replicate\inbound

-map map Deployment map into which to import the values.

-project Project that contains the map into which to import the values.
project

-validate Whether Deployer should check the values to make sure they
{true|false} 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

Run the following command to delete 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 that contains the map to delete.

project

webMethods Deployer User’s Guide Version 9.6 179

 M  
Even Header

Deployment Commands
This section describes the commands to create, display information about, deploy, and
delete deployment candidates and to generate checkpoints, simulate a deployment, roll
back a target server, and generate reports.

Important: You must have Deploy ACL authorization to run the commands in this
section.

Creating a Deployment Candidate

Run the following command to create 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_ Deployment candidate to create.

candidate

-build build Project build to use in the deployment candidate.

-map map Deployment map to use in the deployment candidate.

-project Project to which the build and map belong.

project

Displaying Information About a Deployment Candidate

Run the following command to display 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 for which to obtain

deployment_candidate information, such as:
Name of the build and deployment map in the
candidate.
Date the candidate was created.

webMethods Deployer User’s Guide Version 9.6 180

 M  
Odd Header

Parameter Description

All existing deployment reports for the candidate.

-project project Project to which the deployment candidate belongs.

Deleting a Deployment Candidate

Run the following command to delete 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. For more information about checkpoints, see "Checkpoint and Roll Back" on
page 22.

Run the following command to generate a checkpoint:

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

Parameter Description

-dc Deployment candidate you plan to deploy.

deployment_candidate

-project project Project to which the deployment candidate belongs.

-reportFilePath Full path to the local directory where Deployer

report_path stores the generated checkpoint report.

webMethods Deployer User’s Guide Version 9.6 181

 M  
Even Header

Simulating a Deployment
When you run this command and simulate a deployment, Deployer generates a
simulation report. Display the simulation report as instructed in "Displaying a
Simulation, Rollback, or Deployment Report" on page 184 and address all problems.

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

Run the following command to simulate a deployment:

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

Parameter Description

-dc Deployment candidate for which to simulate a

deployment_candidate deployment.

-project project Project to which the deployment candidate belongs.

-reportFilePath Full path to the local directory where Deployer stores

report_path the generated simulation report.

Deploying
When you run this command, 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 184.
Run the following command to deploy a deployment candidate:
Deployer.{sh|bat} --deploy -dc deployment_candidate -project project
-host host -port port -user user_name -pwd password -force
-reportFilePath report_path

Parameter Description

-dc deployment_candidate Deployment candidate to deploy.

-project project Project to which the deployment candidate

belongs.

-force If no checkpoint exists for the deployment

candidate (for example, because you chose to
generate checkpoints manually, but did not do so),

webMethods Deployer User’s Guide Version 9.6 182

 M  
Odd Header

Parameter Description
Deployer will not deploy unless you specify this
parameter.

Important: If you deploy without a checkpoint, you

will not be able to roll back target servers.

-reportFilePath Full path to the local directory where Deployer

report_path stores the generated deployment report.

Rolling Back Target Servers

When you roll back target servers, Deployer generates a rollback report. For information
about displaying the rollback report, see "Displaying a Simulation, Rollback, or
Deployment Report" on page 184.
Run the following command to roll back target servers:
Deployer.{sh|bat} --rollback -dc deployment_candidate -project project
-host host -port port -user user_name -pwd password -reportFilePath report_path

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.

-reportFilePath Full path to the local directory where Deployer

report_path stores the generated rollback report.

Listing Simulation, Rollback, and Deployment Reports

Run the following command to list simulation, rollback, and deployment reports for a
deployment candidate:
Deployer.{sh|bat} --list -candidate deploymentReport -dc deployment_candidate
-project project -host host -port port -user user_name -pwd password

Parameter Description

-dc Deployment candidate whose simulation,

deployment_candidate deployment, and rollback reports to list.

-project project Project to which the deployment candidate belongs.

webMethods Deployer User’s Guide Version 9.6 183

 M  
Even Header

Displaying a Simulation, Rollback, or Deployment Report

Run the following command to display a simulation, rollback, or deployment report for
a deployment candidate:
Deployer.{sh|bat} --showReport -candidate deploymentReport
-dc deployment_candidate -id integerId -project project
-host host -port port -user user_name -pwd password -

Parameter Description

-dc Deployment candidate whose simulation,

deployment_candidate 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 183) 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 9.6 184

 M  
Odd Header

14   Automating Project Creation

■ Overview ..................................................................................................................................... 186
■ Exporting Projects for Use in Project Automator ....................................................................... 186
■ Using Handles Instead of Passwords ........................................................................................ 187
■ Error Handling and Logging ....................................................................................................... 189
■ Root Tag ..................................................................................................................................... 189
■ Identifying Deployer .................................................................................................................... 190
■ Setting Up Aliases for Source and Target Servers .................................................................... 190
■ Creating Projects ........................................................................................................................ 212
■ Running Project Automator ........................................................................................................ 226

webMethods Deployer User’s Guide Version 9.6 185

 M  
Even Header

Overview
To configure automatic projects, you provide the necessary specifications for automated
project creation in an XML file. This chapter describes the tags you can specify in the file.
Only the root tag and the tag that identifies Deployer are required in the XML file.
Sample XML files are provided in the Integration Server_directory/
instances/instance_name /packages/WmDeployer/config directory. There are two files:
ProjectAutomatorSampleForRepository.xml provides an example of a repository-based
automated project, and ProjectAutomatorSampleForRuntime.xml shows a sample
runtime-based automated project. You can also export a project you created in the GUI
for use in Project Automator. For more information about exporting a project from the
GUI, see "Exporting Projects for Use in Project Automator" on page 186.
For complete contextual information about the features that each tag relates to, see the
GUI chapters in this guide.

Exporting Projects for Use in Project Automator

After you create a project in the GUI, you can export the project to a specification XML
file that you can then use to automate your project. You specify the data to include in
the specification XML file. You can export the alias, deployment set, build, map, and
deployment candidate definitions associated with the project.

Exporting projects from the GUI

1. Go to the Tools > Export to Project Automator page.
2. Complete the fields as follows:

Field Entry

Project Select the project to export.

Export Alias Definition Optional. Click to export all of the alias definitions
for the source and targets associated with the project.

Export Deployment and Optional. Click to export all of the deployment and
Deletion Set Definition deletion set definitions associated with the project.
Exported deployment and deletion sets include the
definition set and all of the associated assets.

Export Build Definition Optional. Click to export all of the build definitions
associated with the project.

webMethods Deployer User’s Guide Version 9.6 186

 M  
Odd Header

Field Entry

Export Map Definition Optional. Click to export all of the map definitions
associated with the project. The map definition
includes all target servers, target groups, and clusters
that are part of the deployment map.

Export Deployment Optional. Click to export all of the deployment

Candidate Definition candidate definitions associated with the project.

3. Click Export to Project Automator.

Deployer exports the project specification XML file to the following location:
Integration Server_directory/instances/instance_name /packages/WmDeployer/replicate/
outbound/projectName _ProjectAutomator.xml
Where projectName is the name of the project.

Using Handles Instead of Passwords

Project Automator uses the pwd aribute to store server passwords in projects. This
aribute is encrypted the first time you run Project Automator. In order to avoid passing
passwords in clear text the first time you run Project Automator, you can use a password
handle. Password handles allow you to create a password on the host Integration Server
along with a corresponding key (or handle) which you then store in clear text in the
pwdHandle aribute. The handle is encrypted as an outbound password using the
Password-Based Encryption (PBE) technology installed with Integration Server. For
more information about how Integration Server manages outbound passwords, see
webMethods Integration Server Administrator’s Guide.
Project Automator gets the password associated to the password handle specified in the
pwdHandle element. You create and manage password handles in the Deployer GUI. You
can also delete and modify password handles as needed.
Keep the following points in mind when using password handles:
Password handles are valid only when Project Automator is running on the same
host Integration Server on which the password handles are created.
When using password handles, Project Automator can connect only to a Deployer
installed in same directory as Project Automator itself.

Creating Password Handles

Perform the following steps to create password handles.

webMethods Deployer User’s Guide Version 9.6 187

 M  
Even Header

To create password handles

1. From the Deployer GUI running on the same server as Project Automator, click Deployer >
Password Store.
2. Click Create Password Store Entry.
3. In the right-hand pane, under Create Password Store Entry, complete the following fields:

Field Entry

Password The name of the password handle. This is the value you will
Handle specify in the pwdHandle aribute in Project Automator.
Password handles cannot contain the following illegal
characters:
$~/\#&@^!%*:;,+=><‘’"

Password The password to associate with the password handle.

4. Click Create.

Modifying Password Handle Associations

Perform the following steps to modify the password associated with a password handle.

To modify the password associated with the password handle

1. Click Deployer > Password Store.
2. Click the password handle you want to modify from the Password Store Entries list.
3. In the right-hand pane, in the New Password field, enter the new password to associate with
the password handle.
4. Click Update.

Deleting Password Handles

Perform the following steps to delete password handles.

To delete password handles

1. Click Deployer > Password Store.
2. Click in the Delete column for the password handle.
Deployer displays a confirmation dialog.
3. Click OK to confirm that you want to delete the password handle.

webMethods Deployer User’s Guide Version 9.6 188

 M  
Odd Header

Error Handling and Logging

Project Automator produces a log file (ProjectAutomatorReport.xml) that is controlled
by a log4j property file stored in the Integration Server_directory/instances/instance_name /
packages/WmDeployer/bin directory. You can change the properties.
<Report>
<Messages type="info ">
<message>message
text </message>
<message>message
text </message>
</Messages type="info ">
<Messages type="error ">
<message category="category " errorCode="code " deploymentSet="set name "
deploymentProject="project
name ">message
text </message>
</Messages type="error ">
</Report>

Below is an example of an error message:

<message category="projectError" errorCode="-41" deploymentSet="myDeploymentSet"
deploymentProject="TestProject">Error adding ACLs TestACL1, TestACL2 to
Deployment Set for project TestProject</message>

For error messages, you can write a program to parse the aribute values and take
specified actions.

Root Tag
The root tag for Project Automator consists of the <DeployerSpec> tag and the
exitOnError aribute, as follows:
<DeployerSpec exitOnError="true or false"></DeployerSpec>

The following table describes the aribute you can specify in the <DeployerSpec> tag.

Attribute Description

exitOnError Optional. Indicates how Project Automator should handle errors.

Set to:
true to set Project Automator to report the error and terminate
the first time it encounters an error.
false to set Project Automator to report errors as they occur,
but continue processing. This is the default.

webMethods Deployer User’s Guide Version 9.6 189

 M  
Even Header

Identifying Deployer
You identify the Deployer on which you will perform the project tasks in the
<DeployerServer> tag. The <DeployerServer> tag enables you to specify the values
required to log on to the Integration Server that hosts the Deployer.
The following example shows how to use this tag:
<DeployerServer>
<host>Integration
Server host name or IP address :port </host>
<user>user
name </user>
<pwd>password </pwd> OR <pwdHandle>handle </pwdHandle>
</DeployerServer>

The following table describes the aributes you can specify in the <DeployerServer> tag.

Attribute Description

host Host name or IP address of the server.

user User name of the server.

pwd Password of the server. You must specify either pwd or pwdHandle.

Note: Project Automator encrypts passwords the first time it

runs. If you must change the passwords in the future, change the
passwords in the XML file and run Project Automator to encrypt
the passwords again.

pwdHandle The password handle. You must specify either pwd or pwdHandle.
For more information about creating a password handle, see
"Using Handles Instead of Passwords" on page 187.

Setting Up Aliases for Source and Target Servers

You set up aliases for source and target servers, target groups, and source repositories in
the <Environment> tag. For example:
<Environment>
<{webMethods
Broker|ProcessModel|IS|MWS|Optimize|EventServer|RulesServer|EDA|
UniversalMessaging|TargetGroup|Repository}>
<{broker|pm|is|mws|optimize|eventserver|rulesserver|edaserver|
universalmessaging|rep}alias>
tags
</{broker|pm|is|mws|optimize|eventserver|rulesserver|edaserver|
universalmessaging|rep}alias>

webMethods Deployer User’s Guide Version 9.6 190

 M  
Odd Header

</{webMethods Broker|ProcessModel|IS|MWS|Optimize|EventServer|RulesServer|EDA|
UniversalMessaging|TargetGroup|Repository}>
</Environment>

The sections below describe each tag within the <Environment> tag in detail.
If Deployer already contains an alias with the same name as one you define, Deployer
overwrites the alias.

Note: The credentials for <user>, <pwd>, and <pwdHandle> asset tags must be those for a
user with Administrator ACL authorization or for a user that belongs to a group that
has Internal, Developer, and DeployerAdmin ACLs to create Deployer runtime aliases
and projects.

Setting Up Aliases for Source Repositories

For repository-based deployment, you define the repository as the source server. This
location identifies the repository directory from which the assets should be deployed.

Note: You can set up aliases for source repositories for repository-based deployment
only.
<Repository>
<repalias name="name ">
<type>FlatFile</type>
<urlOrDirectory>directory_location </urlOrDirectory>
<Test>true or false </Test>
</repalias>
</Repository>

For more information about the values to supply for the following aributes, see
"Connecting to a Repository for Repository-Based Deployment" on page 68.

Attribute Description

repalias The name to use for the repository alias. This aribute
name corresponds to the Name field.

type The type of repository file. Set to FlatFile.

urlOrDirectory The full path of the repository directory in which the composites
are located. This aribute corresponds to the File Directory field.

test Whether Deployer should test the connection to the source

repository. Set to:
true to test the connection to the target server. If Project
Automator cannot ping the target server, it registers an error
and handles the error according to the exitOnError aribute of
the <DeployerSpec> tag. For more information, see "Root Tag"
on page 189.

webMethods Deployer User’s Guide Version 9.6 191

 M  
Even Header

Attribute Description

false to create the source alias without testing the connection to

the target server.

Setting Up Aliases for Source and Target webMethods Brokers

You can set up aliases for source and target Broker Servers for either basic
authentication, SSL authentication, or neither.

Basic Authentication
The following example illustrates how to set up a Broker alias that uses basic
authentication.
<Broker>
<brokeralias name="alias
name ">
<brokerName>Broker
name </brokerName>
<clientGroup>client
group </clientGroup>
<host>Broker
server host </host>
<port>Broker
Server port </port>
<useBasicAuth>true </useBasicAuth>
<user>basic
authorization user name </user>
<pwd>basic
authorization password </pwd> OR <pwdHandle>handle </pwdHandle>
<version>version_number </version>
<context>JNDI
context </context>
<Test>true/false </Test>
</brokeralias>
</Broker>

For detailed information on the values to supply for the following aributes, see
"Connect to Broker Servers" on page 61.

Attribute Description

brokeralias Name to assign to the Broker Server. This aribute corresponds

name to the Name field.

brokerName Name of the source or target webMethods Broker. This aribute

corresponds to the BrokerName field.

clientGroup Client group Deployer should use to access the source or target
Broker Server. For target Broker Servers, specify admin .

webMethods Deployer User’s Guide Version 9.6 192

 M  
Odd Header

Attribute Description

This aribute corresponds with the Client Group field.

host Host name or IP address of the Broker Server. This aribute

corresponds to the Host field.

port Port for the Broker Server. This aribute corresponds to the Port
field.

useBasicAuth Set to true to connect to the Broker Server using basic

authentication. This aribute corresponds to the Client
Authentication > Username/Password check box.

user Basic authentication user name. This aribute corresponds to the

Username field.

pwd Basic authentication password. This aribute corresponds to the

Password field. You must specify either pwd or pwdHandle.

Note: Project Automator encrypts passwords the first time it

runs. If you must change the passwords in the future, change the
passwords in the XML file and run Project Automator to encrypt
the passwords again.

pwdHandle The password handle. You must specify either pwd or pwdHandle.
For more information about creating a password handle, see
"Using Handles Instead of Passwords" on page 187.

version Version of the Broker Server. This aribute corresponds to the

Version field.

context JNDI context. Required if the Broker Server serves as a JNDI

provider. This aribute corresponds to the Context field.

Test Whether Deployer should test the connection to the source

repository. Set to:
true to test the connection to the target server. If Project
Automator cannot ping the target server, it registers an error
and handles the error according to the exitOnError aribute of
the <DeployerSpec> tag. For more information, see "Root Tag"
on page 189.
false to create the source alias without testing the connection to
the target server.

webMethods Deployer User’s Guide Version 9.6 193

 M  
Even Header

SSL Authentication
The following example illustrates how to set up a Broker alias that uses SSL
authentication.
<Broker>
<brokeralias name="alias name">
<brokerName>Broker name</brokerName>
<clientGroup>client group</clientGroup>
<host>Broker server host</host>
<port>Broker Server port</port>
<useSSL>true</useSSL>
<version>version_number</version>
<keyStoreType>Deployer keystore type</keyStoreType>
<keyStorePath>Deployer keystore path</keyStorePath>
<keyStorepassword>Deployer keystore password</keyStorepassword>
<trustStoreType>Deployer trust store type</trustStoreType>
<trustStorePath>Deployer truststore path</trustStorePath>
<context>JNDI context</context>
<Test>true/false</Test>
</brokeralias>
</Broker>

For detailed information on the values to supply for the following aributes, see
"Connect to Broker Servers" on page 61.

Attribute Description

brokeralias Name to assign to the Broker Server. This aribute corresponds

name to the Name field.

brokerName Name of the source or target webMethods Broker. This aribute

corresponds to the BrokerName field.

clientGroup Client group Deployer should use to access the source or target
Broker Server. For target Broker Servers, specify admin .
This aribute corresponds with the Client Group field.

host Host name or IP address of the Broker Server. This aribute

corresponds to the Host field.

port Port for the Broker Server. This aribute corresponds to the Port
field.

useSSL Set to true to connect to the Broker Server using SSL

authentication. This aribute corresponds to the Client
Authentication > SSL check box.

webMethods Deployer User’s Guide Version 9.6 194

 M  
Odd Header

Attribute Description

version Version of the Broker Server. This aribute corresponds to the

Version field.

keyStoreType File type of Deployer's keystore file. This aribute corresponds to

the Keystore Type field.

keyStorePath Full path to Deployer's keystore file. This aribute corresponds

to the DeployerKeystore field.

keyStore Password that Deployer uses to access its keystore file. This
password aribute corresponds to the Keystore Password field.

trustStoreType File type of Deployer's truststore file. This aribute corresponds

to the Truststore Type field.

trustStorePath Full path to Deployer's truststore file. This aribute corresponds

to the DeployerTruststore field.

context JNDI context. Required if the Broker Server serves as a JNDI

provider. This aribute corresponds to the Context field.

Test Whether Deployer should test the connection to the source

repository. Set to:
true to test the connection to the target server. If Project
Automator cannot ping the target server, it registers an error
and handles the error according to the exitOnError aribute of
the <DeployerSpec> tag. For more information, see "Root Tag"
on page 189.
false to create the source alias without testing the connection to
the target server.

No Authentication
The following example illustrates how to set up a Broker alias that does not use client
authentication.
<Broker>
<brokeralias name="alias
name ">
<brokerName>Broker
name </brokerName>
<clientGroup>client
group </clientGroup>
<host>Broker
server host </host>

webMethods Deployer User’s Guide Version 9.6 195

 M  
Even Header

<port>Broker
Server port </port>
<useSSL>false </useSSL>
<version>version
number </version>
<context>JNDI
context </context>
<Test>true/false </Test>
</brokeralias>
</Broker>

For detailed information about the values to supply for the following aributes, see
"Connect to Broker Servers" on page 61.

Attribute Description

brokeralias Name to assign to the Broker Server. This aribute corresponds

name to the Name field.

brokerName Name of the source or target webMethods Broker. This aribute

corresponds to the BrokerName field.

clientGroup Client group Deployer should use to access the source or target
Broker Server. For target Broker Servers, type admin .
This aribute corresponds to the Client Group field.

host Host name or IP address of the Broker Server. This aribute

corresponds to the Host field.

port Port for the Broker Server. This aribute corresponds to the Port
field.

useSSL Set to false to connect to the Broker Server without any

client authentication. This aribute corresponds to the Client
Authentication > None check box.

version Version of the Broker Server. This aribute corresponds to the

Version field.

context JNDI context. Required if the Broker Server serves as a JNDI

provider. This aribute corresponds to the Context field.

Test Whether Deployer should test the connection to the source

repository. Set to:
true to test the connection to the target server. If Project
Automator cannot ping the target server, it registers an error
and handles the error according to the exitOnError aribute of

webMethods Deployer User’s Guide Version 9.6 196

 M  
Odd Header

Attribute Description
the <DeployerSpec> tag. For more information, see "Root Tag"
on page 189.
false to create the source alias without testing the connection to
the target server.

Setting Up Aliases for Source and Target Process Model Servers

The following example illustrates how to set up aliases for source and target process
model servers.
<ProcessModel>
<pmalias name="alias name">
<host>ProcessModel Server host</host>
<port>ProcessModel Server port</port>
<user>user name</user>
<pwd>password</pwd> OR <pwdHandle>handle</pwdHandle>
<useSSL>true/false</useSSL>
<version>version_number</version>
<Test>true/false</Test>
</pmalias>
</ProcessModel>

For detailed information about the values to supply for the following aributes, see
"Connect to BPM Process Model Servers" on page 63.

Attribute Description

pmalias name Name to assign to the server. This aribute corresponds to the
Name field.

host Host name or IP address of the server. This aribute corresponds

to the Host field.

port Port for the server. This aribute corresponds to the Port field.

user Optional. User name for a user account with Administrator

authority that Deployer can use to access the server. This
aribute corresponds to the User field.

pwd Password associated with the user name. This aribute

corresponds to the Password field. You must specify either pwd or
pwdHandle.

Note: Project Automator encrypts passwords the first time it

runs. If you must change the passwords in the future, change the

webMethods Deployer User’s Guide Version 9.6 197

 M  
Even Header

Attribute Description
passwords in the XML file and run Project Automator to encrypt
the passwords again.

pwdHandle The password handle. You must specify either pwd or pwdHandle.
For more information about creating a password handle, see
"Using Handles Instead of Passwords" on page 187.

useSSL Whether Deployer should use SSL to connect to the server. Set to:
true to use SSL to connect to the server.
false to connect to the without any client authentication.
This aribute corresponds to the Use SSL field.

version Version of the server. This aribute corresponds to the Version

field.

Test Whether Deployer should test the connection to the source

repository. Set to:
true to test the connection to the target server. If Project
Automator cannot ping the target server, it registers an error
and handles the error according to the exitOnError aribute of
the <DeployerSpec> tag. For more information, see "Root Tag"
on page 189.
false to create the source alias without testing the connection to
the target server.

Setting Up Aliases for Source and Target Integration Servers

The following example illustrates how to set up aliases for source and target Integration
Servers.
<IS>
<isalias name="alias
name >">
<host>Integration
Server host </host>
<port>Integration
Server port </port>
<user>user
name </user>
<pwd>password </pwd> OR <pwdHandle>handle </pwdHandle>
<useSSL>true/false </useSSL>
<version>version_number </version>
<installDeployerResource>true/false </installDeployerResource>
<Test>true/false </Test>
<executeACL>acl </executeACL>
</isalias>

webMethods Deployer User’s Guide Version 9.6 198

 M  
Odd Header

</IS>

For information on the values to supply for the tags below, see "Connecting to
Integration Servers and Trading Networks Servers" on page 56.

Attribute Description

isalias name Name to assign to the server.

host Host name or IP address of the server.

port Port for the server.

user Optional. User name for a user account with Administrator

authority that Deployer can use to access the server.

pwd Password associated with the user name. You must specify either
pwd or pwdHandle.

Note: Project Automator encrypts passwords the first time it

runs. If you must change the passwords in the future, change the
passwords in the XML file and run Project Automator to encrypt
the passwords again.

pwdHandle The password handle. You must specify either pwd or pwdHandle.
For more information about creating a password handle, see
"Using Handles Instead of Passwords" on page 187.

useSSL Whether Deployer should use SSL to connect to the server. Set to:
true to use SSL to connect to the server.
false to connect to the without any client authentication.

version Version of the server.

install Whether Deployer should install the WmDeployerResource

Deployer package on each Integration Server server that will run the
Resource process steps. Set to:
true to install the package.
false to avoid installing the package.

Test Whether Deployer should test the connection to the source

repository. Set to:

webMethods Deployer User’s Guide Version 9.6 199

 M  
Even Header

Attribute Description

true to test the connection to the target server. If Project

Automator cannot ping the target server, it registers an error
and handles the error according to the exitOnError aribute of
the <DeployerSpec> tag. For more information, see "Root Tag"
on page 189.
false to create the source alias without testing the connection to
the target server.

executeACL Optional. Specifies the ACL for the alias. If no value is specified,
Deployer assigns the alias to the Administrators ACL by default.

Setting Up Aliases for Source and Target My webMethods Servers

The following example illustrates how to set up aliases for source and target My
webMethods Servers.
<MWS>
<mwsalias name="alias
name ">
<host>My
webMethods Server host </host>
<port>My
webMethods Server port </port>
<user>user
name </user>
<pwd>password </pwd> OR <pwdHandle>handle </pwdHandle>
<excludeCoreTaskEngineDependencies>true/false
</excludeCoreTaskEngineDependencies>
<cacheTimeOut>time </cacheTimeOut>
<includeSecurityDependencies>true/false </includeSecurityDependencies>
<rootFolderAliases>folder,folder,folder... </rootFolderAliases>
<maximumFolderObjectCount>count </maximumFolderObjectCount>
<enableAddtionalLogging>true/false </enableAddtionalLogging>
<maxFolderDepth>number_of_assets </maxFolderDepth>
<useSSL>true/false </useSSL>
<version>version_number </version>
<Test>true/false </Test>
</mwsalias>
</MWS>

For information on the values to supply for the tags below, see "Connecting to My
webMethods Servers" on page 58.

Attribute Description

mwsalias Name to assign to the server. This aribute corresponds to the

name Name field.

webMethods Deployer User’s Guide Version 9.6 200

 M  
Odd Header

Attribute Description

host Host name or IP address of the server. This aribute corresponds

to the Host field.

port Port for the server. This aribute corresponds to the Port field.

user Optional. User name for a user account with Administrator

authority that Deployer can use to access the server. This
aribute corresponds to the User field.

pwd Password associated with the user name. This aribute

corresponds to the Password field. You must specify either pwd or
pwdHandle.

Note: Project Automator encrypts passwords the first time it

runs. If you must change the passwords in the future, change the
passwords in the XML file and run Project Automator to encrypt
the passwords again.

pwdHandle The password handle. You must specify either pwd or pwdHandle.
For more information about creating a password handle, see
"Using Handles Instead of Passwords" on page 187.

excludeCore Whether to exclude Task Engine portlets from the dependencies

TaskEngine list for task application assets. Set to:
Dependencies
true to exclude the portlets.
false to include the portlets.
This aribute corresponds to the Exclude Core Task Engine
Dependencies field.

cacheTimeOut Length of time queries should remain in the cache unless the
cache capacity is exceeded. This aribute corresponds to the
Cache Timeout field.

include Whether to include the following in the dependencies list for My

Security webMethods Server assets when creating an MWS deployment
Dependencies set:
Security realms that contain the assets.
User/group/role references in the assets' security ACLs.
Set to:
true to include the assets.

webMethods Deployer User’s Guide Version 9.6 201

 M  
Even Header

Attribute Description

false to exclude the assets.

This aribute corresponds to the Include security dependencies
field.

rootFolder My webMethods Server aliases to use as root folders when

Aliases selecting pages to deploy. Separate the folders using commas.
This aribute corresponds to the Root folder aliases field.

maximumFolder Maximum number of assets to display within My webMethods

ObjectCount Server folders when you are defining and choosing assets to
include in an MWS deployment set. This aribute corresponds to
the Maximum Folder Object Count field.

enable Whether to log debug information about selected assets to source

Addtional My webMethods Server logs, and assets that Deployer deploys to
Logging target My webMethods Server logs. Set to:
true to use SSL to connect to the server.
false to connect to the without any client authentication.
This aribute corresponds to the Enable additional MWS logging
field.

maxFolderDepth Maximum number of assets to display within My webMethods

Server folders when you are defining and choosing assets to
include in an MWS deployment set. This aribute corresponds to
the Maximum Folder Depth field.

useSSL Whether Deployer should use SSL to connect to the server. Set to:
true to use SSL to connect to the server.
false to connect to the without any client authentication.
This aribute corresponds to the Use SSL field.

version Version of the server. This aribute corresponds to the Version

field.

Test Whether Deployer should test the connection to the source

repository. Set to:
true to test the connection to the target server. If Project
Automator cannot ping the target server, it registers an error
and handles the error according to the exitOnError aribute of

webMethods Deployer User’s Guide Version 9.6 202

 M  
Odd Header

Attribute Description
the <DeployerSpec> tag. For more information, see "Root Tag"
on page 189.
false to create the source alias without testing the connection to
the target server.

Setting Up Aliases for Source and Target Optimize Servers

The following example illustrates how to set up aliases for source and target Optimize
servers.
<Optimize>
<optimizealias name="alias name ">
<host>Integration
Server host </host>
<port>Integration
Server port </port>
<user>user
name </user>
<pwd>password </pwd> OR <pwdHandle>handle </pwdHandle>
<useSSL>true/false </useSSL>
<version>version_number </version>
<Test>true/false </Test>
</optimizealias>
</Optimize>

For information on the values to supply for the tags below, see "Connecting to Optimize
Servers" on page 57.

Attribute Description

optimizealias Name to assign to the server. This aribute corresponds to the

name Name field.

host Host name or IP address of the server. This aribute corresponds

to the Host field.

port Port for the server. This aribute corresponds to the Port field.

user Optional. User name for a user account with Administrator

authority that Deployer can use to access the server. This
aribute corresponds to the User field.

pwd Password associated with the user name. This aribute

corresponds to the Password field. You must specify either pwd or
pwdHandle.

webMethods Deployer User’s Guide Version 9.6 203

 M  
Even Header

Attribute Description

Note: Project Automator encrypts passwords the first time it

runs. If you must change the passwords in the future, change the
passwords in the XML file and run Project Automator to encrypt
the passwords again.

pwdHandle The password handle. You must specify either pwd or pwdHandle.
For more information about creating a password handle, see
"Using Handles Instead of Passwords" on page 187.

useSSL Whether Deployer should use SSL to connect to the server. Set to:
true to use SSL to connect to the server.
false to connect to the without any client authentication.
This aribute corresponds to the Use SSL field.

version Version of the server. This aribute corresponds to the Version

field.

Test Whether Deployer should test the connection to the source

repository. Set to:
true to test the connection to the target server. If Project
Automator cannot ping the target server, it registers an error
and handles the error according to the exitOnError aribute of
the <DeployerSpec> tag. For more information, see "Root Tag"
on page 189.
false to create the source alias without testing the connection to
the target server.

Setting Up Aliases for Target Event Servers

The following example illustrates how to set up aliases for target Event Servers.

Note: Deployer supports deployment of assets to Event Servers of version 9.5 or earlier
only.
<EventServer>
<eventserveralias name="event_server_target ">
<host>host_name </host>
<port>port_number </port>
<user>user_name </user>
<pwd>password </pwd> OR <pwdHandle>handle </pwdHandle>
<useSSL>true/false </useSSL>
<version>version_number </version>
<Test>true/false </Test>
</eventserveralias>

webMethods Deployer User’s Guide Version 9.6 204

 M  
Odd Header

</EventServer>

For information on the values to supply for the tags below, see "Connecting to Event
Servers" on page 60.

Attribute Description

eventserver Name to assign to the server. This aribute corresponds to the

alias Name field.
name

host Host name or IP address of the server. This aribute corresponds

to the Host field.

port Port for the server. This aribute corresponds to the Port field.

user Optional. User name for a user account with Administrator

authority that Deployer can use to access the server. This
aribute corresponds to the User field.

pwd Password associated with the user name. This aribute

corresponds to the Password field. You must specify either pwd or
pwdHandle.

Note: Project Automator encrypts passwords the first time it

runs. If you must change the passwords in the future, change the
passwords in the XML file and run Project Automator to encrypt
the passwords again.

pwdHandle The password handle. You must specify either pwd or pwdHandle.
For more information about creating a password handle, see
"Using Handles Instead of Passwords" on page 187.

useSSL Whether Deployer should use SSL to connect to the server. Set to:
true to use SSL to connect to the server.
false to connect to the without any client authentication.
This aribute corresponds to the Use SSL field.

version Version of the server. This aribute corresponds to the Version

field.

Test Whether Deployer should test the connection to the source

repository. Set to:

webMethods Deployer User’s Guide Version 9.6 205

 M  
Even Header

Attribute Description

true to test the connection to the target server. If Project

Automator cannot ping the target server, it registers an error
and handles the error according to the exitOnError aribute of
the <DeployerSpec> tag. For more information, see "Root Tag"
on page 189.
false to create the source alias without testing the connection to
the target server.

Setting Up Aliases for Target EDA Deployment Endpoints

The following example illustrates how to set up aliases for target EDA deployment
endpoints.
<EDA>
<edaserveralias name="EDA_target ">
<host>host_name </host>
<port>port_number </port>
<user>user_name </user>
<pwd>password </pwd> OR <pwdHandle>handle </pwdHandle>
<useSSL>true/false </useSSL>
<version>version_number </version>
<Test>true/false </Test>
</edaserveralias>
</EDA>

For information on the values to supply for the tags below, see "Connecting to EDA
Deployment Endpoints" on page 65.

Attribute Description

edaserveralias Name to assign to the EDA deployment endpoint. This aribute

name corresponds to the Name field.

host Host name or IP address of the webMethods Platform Manager

runtime. This aribute corresponds to the Host field.

port Port for the server. This aribute corresponds to the Port field.

user Optional. User name for a user account with Administrator

authority that Deployer can use to access the server. This
aribute corresponds to the User field.

pwd Password associated with the user name. This aribute

corresponds to the Password field. You must specify either pwd or
pwdHandle.

webMethods Deployer User’s Guide Version 9.6 206

 M  
Odd Header

Attribute Description

Note: Project Automator encrypts passwords the first time it

runs. If you must change the passwords in the future, change the
passwords in the XML file and run Project Automator to encrypt
the passwords again.

pwdHandle The password handle. You must specify either pwd or pwdHandle.
For more information about creating a password handle, see
"Using Handles Instead of Passwords" on page 187.

useSSL Whether Deployer should use SSL to connect to the server. Set to:
true to use SSL to connect to the server.
false to connect to the without any client authentication.
This aribute corresponds to the Use SSL field.

version Version of the server. This aribute corresponds to the Version

field.

Test Whether Deployer should test the connection to the source

repository. Set to:
true to test the connection to the target server. If Project
Automator cannot ping the target server, it registers an error
and handles the error according to the exitOnError aribute of
the <DeployerSpec> tag. For more information, see "Root Tag"
on page 189.
false to create the target alias without testing the connection to
the target server.

Setting Up Aliases for Target Business Rules Runtimes

The following example illustrates how to set up aliases for source and target business
rules servers.
<RulesServer>
<rulesserveralias name="rules_target ">
<host>host_name </host>
<port>port_number </port>
<user>user_name </user>
<pwd>password </pwd> OR <pwdHandle>handle </pwdHandle>
<useSSL>true/false </useSSL>
<version>version_number </version>
<Test>true/false </Test>
</rulesserveralias>
</RulesServer>

webMethods Deployer User’s Guide Version 9.6 207

 M  
Even Header

For information on the values to supply for the tags below, see "Connect to Business
Rules Runtimes" on page 66.

Attribute Description

rulesserver Name to assign to the server. This aribute corresponds to the

alias Name field.
name

host Host name or IP address of the server. This aribute corresponds

to the Host field.

port Port for the server. This aribute corresponds to the Port field.

user Optional. User name for a user account with Administrator

authority that Deployer can use to access the server. This
aribute corresponds to the User field.

pwd Password associated with the user name. This aribute

corresponds to the Password field. You must specify either pwd or
pwdHandle.

Note: Project Automator encrypts passwords the first time it

runs. If you must change the passwords in the future, change the
passwords in the XML file and run Project Automator to encrypt
the passwords again.

pwdHandle The password handle. You must specify either pwd or pwdHandle.
For more information about creating a password handle, see
"Using Handles Instead of Passwords" on page 187.

useSSL Whether Deployer should use SSL to connect to the server. Set to:
true to use SSL to connect to the server.
false to connect to the without any client authentication.
This aribute corresponds to the Use SSL field.

version Version of the server. This aribute corresponds to the Version

field.

Test Whether Deployer should test the connection to the source

repository. Set to:
true to test the connection to the target server. If Project
Automator cannot ping the target server, it registers an error

webMethods Deployer User’s Guide Version 9.6 208

 M  
Odd Header

Attribute Description
and handles the error according to the exitOnError aribute of
the <DeployerSpec> tag. For more information, see "Root Tag"
on page 189.
false to create the source alias without testing the connection to
the target server.

Setting Up Aliases for Target Universal Messaging Servers

The following example illustrates how to set up aliases for source and target Universal
Messaging servers.
<UniversalMessaging>
<universalmessagingalias name="server_target">
<realmURL>URL</realmURL>
<version>version</version>
<keyStorePath>path</keyStorePath>
<keyStorepassword>password</keyStorepassword>
<trustStorePath>path</trustStorePath>
<trustStorepassword>password</trustStorepassword>
<Test>true/false</Test>
</universalmessagingalias>
</UniversalMessaging>

For information on the values to supply for the tags below, see "Connect to Universal
Messaging Servers" on page 67.

Attribute Description

universal Name to assign to the server. This aribute corresponds to the

messagingalias Name field.
name

realmURL The URL of the Universal Messaging realm server. This aribute
corresponds to the Realm URL field.

version Version of the server. This aribute corresponds to the Version

field.

keyStorePath Full path to the keystore file. Required if the protocol of

realmURL is nsps or nhps. This aribute corresponds to the
Deployer Keystore field.

keyStore Password used to access the keystore file. Required if the

password protocol of realmURL is nsps or nhps. This aribute corresponds
to the Keystore Password field.

webMethods Deployer User’s Guide Version 9.6 209

 M  
Even Header

Attribute Description

trustStorePath Full path to the truststore file. Required if the protocol of

realmURL is nsps or nhps. This aribute corresponds to the
Deployer Truststorefield.

trustStore Password used to access its truststore file. Required if the

password protocol of realmURL is nsps or nhps. This aribute corresponds
to the Truststore Password field.

Test Whether Deployer should test the connection to the source

repository. Set to:
true to test the connection to the target server. If Project
Automator cannot ping the target server, it registers an error
and handles the error according to the exitOnError aribute of
the <DeployerSpec> tag. For more information, see "Root Tag"
on page 189.
false to create the source alias without testing the connection to
the target server.

Setting Up Aliases for Target Groups

Use the <TargetGroup> tag to define the aliases to include in target groups as follows:
<TargetGroup description="target group description " isLogicalCluster="true or
false" name="alias name" type="runtime_type " version="version_number ">
<alias>server
alias </alias>
<alias>server
alias </alias>
<cluster name="cluster name">server ,server ,server ...</cluster>
<cluster name="cluster name">server ,server ,server ...</cluster>
</TargetGroup>

For information on the values to supply for the aributes below, see " Creating Target
Groups" on page 70.

Attribute Description

description Description of the target group. This aribute corresponds to the

Description field.

isLogical (Runtime-based deployment only.) Whether Deployer should

Cluster automatically roll back the deployment on all servers in the
group if deployment fails on any of the servers in the target
group. This aribute corresponds to the Rollback All on Failure
field. Set to:

webMethods Deployer User’s Guide Version 9.6 210

 M  
Odd Header

Attribute Description

true to roll back all of the servers in the target group if

deployment fails on one of the servers in the target group.
false to keep Deployer from rolling back all of the servers in the
target group if deployment to one of the servers encounters a
failure.

Note: The isLogicalCluster aribute is valid for runtime-based

deployment only. Deployer ignores this aribute for repository-
based deployment.

name Name to use for the target group. This aribute corresponds to
the Name field.

type The runtime type of the target group. Set to:

Broker
IS
MWS
Optimize
ProcessModel
RULES
EventServer

Note: Deployer supports deployment of assets to Event Servers

of version 9.5 or earlier only.

EDA
UniversalMessaging

version Version of the server. This aribute corresponds to the Version

field.

alias The aliases of the servers to include in the target group. Each
alias should have its own alias aribute.

cluster name A list of Integration Server or process model clusters.

webMethods Deployer User’s Guide Version 9.6 211

 M  
Even Header

Creating Projects
You create projects in the <Projects> tag as follows:
<Projects projectPrefix="string">
<Project overwrite="true" name="project_name"
description=project_description">
<ProjectProperties>
<Property name= "projectLocking">true/false </Property>
<Property name= "concurrentDeployment">true/false </Property>
<Property name= "ignoreMissingDependencies">true/false </Property>
<Property name= "isTransactionalDeployment">true/false </Property>
</ProjectProperties>
<{DeploymentSet|DeletionSet}>tags</{DeploymentSet|DeletionSet}>
<{Component|Composite}>tags</{Component|Composite}>
</Project>
</Projects>

Note: You can specify aributes in the <DeletionSet> tag for repository-based
deployment only.

Note: The <Component> and <Composite> tags define the components and composites
for repository-based deployment projects only. They are not used for runtime-based
deployment projects.

The <Projects> tag can contain the following aribute:

Attribute Description

projectPrefix Optional. Specify a prefix for projects created using Project

Automator. For example, if you specified <Projects
projectPrefix="Auto_">, the names of projects created using
Project Automator would be prefixed by “Auto_”.

The <Projects> tag can contain several <Project> tags, one for each project you want
Project Automator to create. You can specify the following aributes for the <Project>
tag:

Attribute Description

overwrite Determines how Project Automator proceeds if Deployer already

contains a project with the same name as one you define. Set to:
true to overwrite the project.
false keep the project, write an error, and continue to the next
<Project> tag.

webMethods Deployer User’s Guide Version 9.6 212

 M  
Odd Header

Attribute Description

name Name of the project.

description Description of the project.

For repository-based projects, the <ProjectProperties> tag contains the individual project
properties that you can edit for the project. If no project properties are specified, the
project adopts the seings specified for all projects. For more information about seing
project seings for all projects, see " Seing Default Properties for All Projects" on page
77.

Attribute Description

projectLocking Indicates whether locking is enabled or disabled for the project.

When set to true , locking is enabled for the project.

concurrent Indicates whether Deployer deploys assets concurrently. When

Deployment set to true concurrent deployment is enabled.

ignoreMissing Indicates whether Deployer ignores missing dependencies.

Dependencies When set to true , Deployer ignores missing dependencies for
the project. If this aribute is set to false and the project contains
missing dependencies, deployment fails.

isTransactional Indicates whether Deployer automatically creates a checkpoint

Deployment prior to delivering and activating deployment and deletion
sets. When set to true , transactional deployment is enabled.
When transactional deployment is enabled and activation fails,
Deployer triggers a roll back automatically and restores the
target servers to the state of the prior activation.

The following sections describe the tasks you can perform using tags of the parent
<Project> tag.

Defining Deployment and Deletion Sets for Runtime-Based

Deployment
You define the deployment and deletion sets for a runtime-based project using the
<DeploymentSet> tag. Each tag can include these aributes:
<DeploymentSet name="set name " description="set description " type="runtime_type "
mode="{Deploy|Delete}" srcAlias="{source server } alias "
defaultDependencyAction="{Add|Fulladd|Exists|Ignore}"></DeploymentSet>

The following table describes the aributes in the <DeploymentSet> tag:

webMethods Deployer User’s Guide Version 9.6 213

 M  
Even Header

Attribute Description

name Name of the deployment or deletion set. For more information,

see the description of the Name field in "Creating a Deployment
Set" on page 94 or "Creating a Deletion Set" on page 126.

description Optional. Description for the deployment or deletion set. For

more information, see the description of the Description field in
"Creating a Deployment Set" on page 94 or "Creating a Deletion
Set" on page 126.

type Runtime type of the server that contains the assets to deploy or
delete. Set to:
Broker
IS (For Integration Server and Trading Networks servers.)
MWS (Deployment sets only.)
Optimize (Deployment sets only.)
ProcessModel (Deployment sets only.)
RULES (Deployment sets only.)
EventServer (Deployment sets only.)

Note: Deployer supports deployment of assets to Event Servers

of version 9.5 or earlier only.

EDA (Deployment sets only.)

For more information, see the description of the Type field in
"Creating a Deployment Set" on page 94 or "Creating a Deletion
Set" on page 126.

packageRegExp (Optional.) Text that the package names must contain in order
to be listed. For more information, see the description of the
Packages field in "Creating a Deployment Set" on page 94 or
"Creating a Deletion Set" on page 126.

otherRegExp (Optional.) The number of assets to display in the list. See the All
other assets field in the "Defining a Deployment Set" on page 93
or "Defining a Deletion Set" on page 125 chapters.

mode Specifies whether Deployer should create a deployment or

deletion set for the project. Set to:
deploy to define a deployment set.

webMethods Deployer User’s Guide Version 9.6 214

 M  
Odd Header

Attribute Description

delete to define a deletion set.

For example, to define a deployment set, specify deploy for mode
as follows:
<DeploymentSet name="depSet1" description="depAssets"
packageRegExp="" otherRegExp="" type="IS"
mode="deploy or delete " srcAlias="ISserver31,ISserver41"
defaultDependencyAction="Add"
tnTreeNodeCount="1000"></DeploymentSet>

srcAlias The server alias for the source server (for deployment sets) or
target server (for deletion sets). This aribute corresponds with
the Name field described for the runtime server type in "Starting
Deployer and Connecting to Servers" on page 53.

default (Optional.) Specifies how Deployer should handle unresolved

Dependency dependencies. Set to:
Action
add to add the referenced asset.
fulladd to add the entire package that contains the referenced
asset. This value is valid for Integration Server assets only.
exists to specify that the referenced asset exists on the target
server.

Note: If the dependent asset does not exist on the target server,
deployment will fail.

ignore to ignore unresolved dependencies.

The tags for each type of asset vary. See the sample XML file
ProjectAutomatorSample.xml in the Integration Server_directory/instances/instance_name /
packages/WmDeployer/config directory for examples for each type of asset. Additional
notes are provided below.

Assets Notes

All If an asset is located in a folder, the asset tag must include the
folder aribute.

Integration On <Port> asset tags, set the protocol aribute to one of the
Server following:
HTTP
FTP
HTTPS

webMethods Deployer User’s Guide Version 9.6 215

 M  
Even Header

Assets Notes

FTPS
Email
FilePolling
Package asset tags require the aribute package="name ".
Scheduled task assets require the aribute filterBy="name ".

Trading Sets that include Trading Networks assets must also include the
Networks tnTreeNodeCount="number" aribute. This aribute specifies the
number of Trading Networks assets Deployer should display.
For more information, see the description of the Maximum TN
Assets to Display field in "Creating a Deployment Set" on page 94
or "Creating a Deletion Set" on page 126.

My <Rule> asset tags require the aribute folder set to:

webMethods
Shell Rules
Server
Skin Rules
Start Page Rules
Rendering Rules
Login Page Rules
Task Rules\Global Task Rules\Schedule Rules
Task Rules\Global Task Rules\Trigger Rules

Defining a Deployment Set for Repository-Based Deployment

You define deployment sets for repository-based deployment as follows:
<DeploymentSet autoResolve="full|partial|ignore" description="description "
name="deployment_set " srcAlias="repository "> <Composite name="name "
srcAlias="repository_alias " type="type "/> <Component
componentType="component_type " compositeName="name " name="name "
srcAlias="repository_alias " type="runtime_type "/>

The <DeploymentSet> tag must include the autoResolve, description, name, and
srcAlias aributes. The following table describes each of these aributes.

Attribute Description

autoResolve Specifies how Deployer should resolve unresolved dependencies

in the deployment set. Set to:

webMethods Deployer User’s Guide Version 9.6 216

 M  
Odd Header

Attribute Description

full to resolve the unresolved dependencies for the deployment

set by adding the entire referenced composite. This seing
corresponds to the Auto resolve by Composite field in the GUI. For
more information, see "Resolving Dependencies Automatically"
on page 118.
partial to resolve the unresolved dependencies for the
deployment set by adding only the referenced assets. Adding
only the referenced assets, instead of the entire referenced
composite, is referred to as partial deployment. You can use
partial deployment for only Integration Server, Trading
Networks, or Broker (including JNDI) assets. This seing
corresponds to the Auto resolve by Asset field in the GUI. For
more information, see "Resolving Dependencies Automatically"
on page 118.
ignore to ignore unresolved dependencies. This corresponds
to manually resolving dependencies by seing the Unset/Add/
Ignore column to Ignore for an asset. For more information, see
"Resolving Dependencies Manually" on page 119.

description This aribute corresponds with the Description field described in

"Creating a Deployment Set" on page 94.

name Name of the deployment set. This aribute corresponds with the
Name field described in "Creating a Deployment Set" on page 94.

srcAlias The repository alias for the component. This aribute

corresponds with the Name field described in "Connecting to a
Repository for Repository-Based Deployment" on page 68.

The <Composite> tag describes composites that are part of the deployment set. You can
set the following aributes for the <Composite> tag.

Attribute Description

name Name of composite from the ACDL. You can use an asterisk
(*) as a wildcard character. For example, if you set name to
“Deploy*”, Project Automator adds all composites with a name
beginning with “Deploy” to the deployment set.
To use a wildcard character to return composites that contain
an asterisk (*) in the name, you must add an escape character
(\) before the asterisk in name (example, \*). For example, to add
all composites with the name “project*”, you would set name to

webMethods Deployer User’s Guide Version 9.6 217

 M  
Even Header

Attribute Description
“project\**”. To add all composites with the name “*project”,
you would set name to “\*project*”.

srcAlias Alias name of the server on which the component is located.

This aribute corresponds with the Name field described in
"Connecting to a Repository for Repository-Based Deployment"
on page 68.

type Runtime type of the asset. Set to:

BPM
Broker
EDA
EventServer

Note: Deployer supports deployment of assets to Event Servers

of version 9.5 or earlier only.

IS
MWS
Optimize
RULES
TN
UniversalMessaging
You can use an asterisk (*) as a wildcard character. For example,
if you set type to “*”, Project Automator adds composites from all
runtimes to the deployment set.

The <Component> tag describes the assets that are part of the deployment set. You can
set the following aributes for the <Component> tag.

Attribute Description

componentType Type of asset. For example, isdocumenype.

You can use an asterisk (*) as a wildcard character. For example,
if the componentType aribute is set to “*”, Project Automator
adds all asset types to the deployment set.

compositeName Name of composite in which the asset is located. You can use
an asterisk (*) as a wildcard character. For example, if the

webMethods Deployer User’s Guide Version 9.6 218

 M  
Odd Header

Attribute Description
compositeName aribute is set to “is*”, Project Automator adds
all assets with a composite name beginning with “is” to the
deployment set.
To use a wildcard character to return all composites that contain
an asterisk (*) in the name, you must add an escape character (\)
before the asterisk in compositeName (example, \*). For example,
to add assets from composites with the name “project*”, you
would set compositeName to “project\**”. To add all composites
with the name “*project”, you would set compositeName to
“\*project*”.

name Name of the asset. You can use an asterisk (*) as a wildcard
character. For example, if the name aribute is set to “is*”, Project
Automator adds all assets with a name beginning with “is” to the
deployment set.
To use a wildcard character to return all assets that contain an
asterisk (*) in the name, you must add an escape character (\)
before the asterisk in name (example, \*). For example, to add all
assets with the name “project*”, you would set name to “project
\**”. To add all assets with the name “*project”, you would set
name to “\*project*”.

srcAlias Alias name of the host server.

type Runtime type of the asset. Set to:

BPM
Broker
EDA
EventServer

Note: Deployer supports deployment of assets to Event Servers

of version 9.5 or earlier only.

IS
MWS
Optimize
RULES
TN
UniversalMessaging

webMethods Deployer User’s Guide Version 9.6 219

 M  
Even Header

Attribute Description

You can use an asterisk (*) as a wildcard character. For example,

if you set type to “*”, Project Automator adds assets from all
runtimes to the deployment set.

Defining a Deletion Set for Repository-Based Deployment

You define deletion sets for repository-based deployment as follows:
<DeletionSet autoResolve="full" description="description " name="deletion_set ">
<Component componentType="component_type " compositeName="composite_name "
name="name " srcAlias="repository_alias " type="runtime_type "/>
</DeletionSet>

The following table describes the aributes in the <DeletionSet> tag:

Note: For a description of the aributes for the <Component> tag, see "Defining a
Deployment Set for Repository-Based Deployment" on page 216.

Attribute Description

autoResolve The autoResolve aribute is optional, but if you supply a value,

set it to full . If autoResolve is set to full , Deployer automatically
finds dependent assets and adds them to the deletion set. If
autoResolve is not supplied and Deployer finds dependent
assets, Deployer creates the deletion set with unresolved
dependencies and deployment will fail. For more information
about the autoResolve aribute, see "Defining a Deployment Set
for Repository-Based Deployment" on page 216.

description Description for the deletion set. This aribute corresponds with
the Description field described in "Creating a Deletion Set" on
page 126.

name Name to use for the deletion set. This aribute corresponds with
the Name field described in "Creating a Deletion Set" on page 126.

Building a Project for Runtime-Based Deployment

You define a build for a runtime-based deployment project as follows:
<DeploymentBuild name="build name " description="build description "</DeploymentBuild>

Note: If the project already has a build with the same name, Deployer overwrites it.

The following table describes the aributes in the <DeploymentBuild> tag:

webMethods Deployer User’s Guide Version 9.6 220

 M  
Odd Header

Attribute Description

name Name of the build. This aribute corresponds to the Name field
described in "Creating a Build" on page 136.

description Description of the build. This aribute corresponds to the

Description field described in "Creating a Build" on page 136.

Mapping a Project
You define a map to create for a project as follows:
<DeploymentMap name="map name " description="map description "></DeploymentMap>
<MapSetMapping mapname="map name " setName="name of deployment or
deletion set ">
<alias>target
server alias </alias>
<alias>target
server alias </alias>
<group>target
group </group>
<group>target
group </group>
</MapSetMapping>

Note: If the project already has a map with the same name, Deployer overwrites it.

The following table describes the aributes in the <DeploymentMap> tag:

Attribute Description

name Name of the deployment map. This aribute corresponds to the

Name field described in "Mapping a Project to Target Servers and
Target Groups" on page 140.

description Description of the deployment map. This aribute corresponds

to the Description field described in "Mapping a Project to Target
Servers and Target Groups" on page 140.

Mapping a Runtime-Based Project

You define a deployment map for a runtime-based project with the <DeploymentMap>
and <MapSetMapping> tags as follows:
<DeploymentMap name="map name " description="map description "></DeploymentMap>
<MapSetMapping mapname="map name " setName="name of deployment or
deletion set ">
<alias>target_server_alias </alias>
<group>target_group </group>

webMethods Deployer User’s Guide Version 9.6 221

 M  
Even Header

<group>target_group </group>
</MapSetMapping>

Note: If the project already has a map with the same name, Deployer overwrites it.

The following table describes the aributes in the <DeploymentMap> tag. Each aribute
corresponds to a field in the GUI as described in "Mapping a Project to Target Servers
and Target Groups" on page 140.

Attribute Description

name Name of the deployment map. This aribute corresponds to the

Name field.

description Description of the deployment map. This aribute corresponds

to the Description field.

The <MapSetMapping> tag uses the following aributes to define the aliases contained
in each deployment map:

Attribute Description

mapname Name of the deployment map. This aribute should match the
name aribute of the <DeploymentMap> tag.

setName Name of the deployment or deletion set.

For deployment sets, this aribute should match the name
aribute of the <DeploymentSet> tag as described in "Defining
Deployment and Deletion Sets for Runtime-Based Deployment"
on page 213 or "Defining a Deployment Set for Repository-
Based Deployment" on page 216.
For deletion sets, this aribute should match the name aribute
of the <DeletionSet> tag as described in "Defining Deployment
and Deletion Sets for Runtime-Based Deployment" on page
213 or "Defining a Deletion Set for Repository-Based
Deployment" on page 220.

alias The server alias of the target server. This aribute corresponds
to the target server you select when you click Add Target Server
as described in "Mapping a Project to Target Servers and Target
Groups" on page 140.

group The alias of the target group. This aribute corresponds to

the target group you select when you click Add Target Group as

webMethods Deployer User’s Guide Version 9.6 222

 M  
Odd Header

Attribute Description
described in "Mapping a Project to Target Servers and Target
Groups" on page 140.

Mapping a Repository-Based Project

You define a deployment map for a repository-based project with the
<DeploymentMap> and <MapSetMapping> tags as follows:
<DeploymentMap name="map name " description="map description "></DeploymentMap>
<MapSetMapping mapname="map name " setName="name of deployment or
deletion set ">
<alias type="alias_type ">target_server_alias </alias>
<alias logicalServer="logical_server " type="alias_type ">target server alias </alias>
</MapSetMapping>

Note: If the project already has a map with the same name, Deployer overwrites it.

The following table describes the aributes in the <DeploymentMap> tag. Each aribute
corresponds to a field in the GUI as described in "Mapping a Project to Target Servers
and Target Groups" on page 140.

Attribute Description

name Name of the deployment map. This aribute corresponds to the

Name field.

description Description of the deployment map. This aribute corresponds

to the Description field.

The <MapSetMapping> tag uses the following aributes to define the aliases contained
in each deployment map:

Attribute Description

mapname Name of the deployment map. This aribute should match the
name aribute of the <DeploymentMap> tag.

setName Name of the deployment or deletion set.

For deployment sets, this aribute should match the name
aribute of the <DeploymentSet> tag as described in "Defining
Deployment and Deletion Sets for Runtime-Based Deployment"
on page 213 or "Defining a Deployment Set for Repository-
Based Deployment" on page 216.
For deletion sets, this aribute should match the name aribute
of the <DeletionSet> tag as described in "Defining Deployment

webMethods Deployer User’s Guide Version 9.6 223

 M  
Even Header

Attribute Description
and Deletion Sets for Runtime-Based Deployment" on page
213 or "Defining a Deletion Set for Repository-Based
Deployment" on page 220.

alias type The runtime type of the target server alias. This aribute
corresponds to the Select Server list described in "Mapping a
Project to Target Servers and Target Groups" on page 140.

alias (BPM assets only.) The logical server alias of the target server.
logicalServer This aribute corresponds to the Physical Server field as described
in "Connect to BPM Process Model Servers" on page 63.

alias The server alias of the target server. This aribute corresponds
to the target server you select when you click Add Target Server
as described in "Mapping a Project to Target Servers and Target
Groups" on page 140.

group type The runtime type of the target group. This aribute corresponds
to the Select Server list described in "Mapping a Project to Target
Servers and Target Groups" on page 140.

group (BPM assets only.) The logical server to which the target group is
logicalServer mapped. This aribute corresponds to the target server or target
group you select after you click Add Target Group as described in
"Mapping a Project to Target Servers and Target Groups" on page
140.

group The group mapping for assets that are not targeted to a logical
server. This aribute corresponds to the target group you select
when you click Add Target Group as described in "Mapping a
Project to Target Servers and Target Groups" on page 140.

Creating a Deployment Candidate for Runtime-Based Deployment

You define a deployment candidate for a runtime-based project with the
<DeploymentCandidate> tag as follows:
<DeploymentCandidate name="candidate name " description="candidate description "
buildName="build
to use " mapName="map to use "</DeploymentCandidate>

Note: If the project already has a deployment candidate with the same name, Deployer
overwrites it.

webMethods Deployer User’s Guide Version 9.6 224

 M  
Odd Header

The following table describes the aributes in the <DeploymentCandidate> tag when
creating a deployment candidate for runtime-based deployment. Each aribute
corresponds to a field in the GUI as described in " Deploying a Project" on page 152.

Attribute Description

name Name of the deployment candidate. This aribute corresponds to

the Name field.

description Description of the deployment candidate. This aribute

corresponds to the Description field.

buildName (Runtime-based deployment only.) Name of the project build to

deploy. This aribute corresponds to the Project Build field.

mapName Name of the deployment map that identifies the target servers
to which to deploy the assets. This aribute corresponds to the
Deployment Map field.

Creating a Deployment Candidate for Repository-Based Deployment

You define a deployment candidate for a repository-based project with the
<DeploymentCandidate> tag as follows:
<DeploymentCandidate name="candidate name " description="candidate description "
mapName="map to
use "</DeploymentCandidate>

Note: If the project already has a deployment candidate with the same name, Deployer
overwrites it.

The following table describes the aributes in the <DeploymentCandidate> tag when
creating a deployment candidate for repository-based deployment. Each aribute
corresponds to a field in the GUI as described in " Deploying a Project" on page 152.

Attribute Description

name Name of the deployment candidate. This aribute corresponds to

the Name field.

description Description of the deployment candidate. This aribute

corresponds to the Description field.

webMethods Deployer User’s Guide Version 9.6 225

 M  
Even Header

Attribute Description

mapName Name of the deployment map that identifies the target servers
to which to deploy the assets. This aribute corresponds to the
Deployment Map field.

Running Project Automator

Go to the Integration Server_directory/instances/instance_name /packages/WmDeployer/bin
directory and run this command:
{projectAutomator.bat|projectAutomatorUnix.sh|projectAutomatorMac.sh} full_path_to_XML_file

Before executing the specified XML file, Project Automator validates the XML
using the schema named ProjectAutomator.xsd in the Integration Server_directory/
instances/instance_name /packages/ WmDeployer/config directory.

webMethods Deployer User’s Guide Version 9.6 226

 M  
Odd Header

A   Deploying Process Models with E-Forms

■ Deploying Process Models with E-Forms .................................................................................. 228

webMethods Deployer User’s Guide Version 9.6 227

 M  
Even Header

Deploying Process Models with E-Forms

Note: These instructions apply to runtime-based deployment only. For repository-based
deployment, if you want to deploy ProcessModels with e-forms, you must configure
the e-form listener manually in the target environment. For more information about
configuring the e-form listener manually, see Implementing webMethods Content Service
Platform for BPM (for Content Service Platform) or Implementing E-form Support for BPM
(for My webMethods Server).

If you are creating a ProcessModel deployment set, the e-forms might trigger process
steps in the process models. In this case, follow these instructions:
1. When you define the ProcessModel deployment set, JCR or CSP files will appear as
dependencies. You must include them in the ProcessModel deployment set unless they
already exist on the target server and they already specify the correct paths to the e-form
templates and e-form instances folders. For instructions on resolving dependencies, see
"Resolving Dependencies" on page 111.

Note: My webMethods Server assets (that is, the e-form templates and e-form
instances folders) do not appear as dependencies.

2. When you map the ProcessModel deployment set to the target servers, substitute the
password configuration values for the JCR or CSP files. These passwords, which Process
Engines use to connect to the My webMethods Server or Content Service Platform that hosts
e-forms, must be correct for the target environment. Also change other JCR or CSP file
configuration values to be correct for the target environment if necessary.

Note: Configure the CSP in the target server with the same structure and content as
the source server.

3. If you are using e-forms with My webMethods Server, perform the following additional
tasks:
a. Define an MWS deployment set that contains the e-form templates and e-form
instances folders from the My webMethods Server that hosts e-forms in the
source environment. In the project seings for the project that contains this
deployment set, set the Export Content (Documents) property to Yes (see the Export
Content (Documents) property as described in " Creating a Project" on page 83).

Important: This seing is set to No by default. Since project seings affect all
deployment sets in the project, make sure that other MWS deployment sets
you include in the project can share this seing, or do not include other MWS
deployment sets in the project.

b. Before deploying, go to the My webMethods Server that hosts e-forms in the

source environment and delete the contents of the e-form instances folder.

webMethods Deployer User’s Guide Version 9.6 228

 M  
Odd Header

B   Deploying Optimize Assets

■ Overview ..................................................................................................................................... 230
■ Disabling Automatic Execution of DDL Statements ................................................................... 230
■ Deploying Optimize Assets in Static DB Schema Mode ............................................................ 231
■ Optimize Deployment Usage Notes ........................................................................................... 232

webMethods Deployer User’s Guide Version 9.6 229

 M  
Even Header

Overview
When you use Deployer to deploy Optimize assets, the process often requires
modifications to the Analytic Engine DB schema on the target server. The modifications
result from the automatic execution of Data Definition Language (DDL) statements on
the database. You can configure the Analytic Engine to run in Static DB Schema mode,
where the automatic execution of DDL statements is disabled. For more information, see
"Disabling Automatic Execution of DDL Statements" on page 230.
When the Analytic Engine runs in Static DB Schema mode, the deployment process
for Optimize assets runs through two stages. This ensures that no unauthorized
modification of the database schema is allowed.
First stage (DDL Recording) - during this stage, the deployment process carries out the
following actions:
1. Old versions of the Optimize assets are removed from the Analytic Engine cache.
2. Data Manipulation Language (DML) statements are executed.
3. DDL statements are collected but not executed.
After these procedures finish, you manually execute the Analytic Engine SQL scripts.
Second stage (Actual Deployment) - during this stage, the deployment process carries
out the following actions:
1. Determines if the database has been updated with the SQL scripts as described in
the first stage.
2. Creates the deployed Optimize assets.

Important: In practice, these stages are part of a single procedure, as described in

"Deploying Optimize Assets in Static DB Schema Mode" on page 231. However, be
aware that you must complete both deployment stages for each Optimize deployment
set before you start deploying another set. Otherwise you will create orphaned objects
in your database.

Disabling Automatic Execution of DDL Statements

You must disable the automatic execution of DDL statements to be able to safely deploy
Optimize deployment sets as described in "Deploying Optimize Assets in Static DB
Schema Mode" on page 231.

To disable the automatic execution of DDL statements

1. In My webMethods: Navigate > Applications > Administration > System-Wide >
Environments > Define Environments.

webMethods Deployer User’s Guide Version 9.6 230

 M  
Odd Header

2. On the Define Environments page, click the name of the environment with which you want to
work.
3. On the Edit Environment page, click the Configure Servers tab.
4. Under the appropriate Analytic Engine logical server node in the configuration tree, click
Database Settings.
5. In the Database Settings for Analytic Engine area, click Disable DDL Statements to disable the
automatic execution of DDL statements.
6. Click Save to save changes.

Note: If you click Finish without first clicking Save, any changes made to these
seings will be lost.

7. Click Deploy All to deploy all configuration files to all logical servers in an environment, or
click Deploy Updates to deploy only the modified configuration files to the affected logical
servers in the environment.
The status of the deployment operation appears after the operation is completed. The
status includes a list of the files that were deployed to the environment and also lists
any errors that occurred.

Note: If you edit a configuration and deploy only the updates, the logical servers in
the environment must be restarted for the new configuration seings to take effect.

Deploying Optimize Assets in Static DB Schema Mode

You deploy Optimize assets following the procedure below only when Analytic Engine
runs in Static DB Schema mode. For deploying Optimize assets when Static DB Schema
mode is not activated, see "Deploying a Project" on page 149.

To deploy Optimize assets when Analytic Engine runs in Static DB Schema mode
1. Make sure you have deployed an environment with Analytic Engine running in Static DB
Schema mode as described in "Disabling Automatic Execution of DDL Statements" on
page 230.
2. In Integration Server: Solutions > Deployer.
3. On the Deployer > Settingspage, in the General Deployment Defaults area, make sure the
Batch Size property is set to 0 to avoid batching of the deployment set.
4. Go to the Deployer > Projectspage and configure an Optimize deployment candidate as
described in " Creating a Project" on page 83.
5. Click Deploy. Deployer displays the Projects > project > Deploy page and lists all
deployment candidates that exist for the selected project.
6. To deploy the project, click in the Deploy column for the deployment candidate.

webMethods Deployer User’s Guide Version 9.6 231

 M  
Even Header

Deployer does the following:

Removes older versions of the assets in the project build from the target servers
to prepare the servers for deployment.
Creates a deployment report and lists the report in the Deployment History area.
The deployment report contains the location of the .sql file that you need to
execute manually before continuing with the second deployment phase.
7. Locate and execute the SQL scripts.
You must have database administrator privileges on the database to be able to
execute the scripts. You will find the script(s) that must be executed in a .sql file
on the Analytic Engine host file system. The exact location is specified in the
deployment report in the Deployment History area.
8. Click in the Deploy column to complete the deployment.

Optimize Deployment Usage Notes

The purpose of this topic is to help you understand various important points concerning
the deployment of Optimize assets in Static DB Schema mode.
There are two prerequisites critical to the successful deployment of Optimize assets to a
target Analytic Engine running in Static DB Schema mode:
1. For each deployment set you want to deploy, you must always execute the following
operations in this order:
a. Execute the DDL recording stage.
b. Execute all generated SQL statements.
c. Execute the actual deployment stage.
2. Ensure that each asset included in the process is removed or deployed, instead of
updated.
The Analytic Engine aempts to remove all assets within each deployment set in reverse
order and then aempts to deploy them in the specified order. An asset cannot be
removed if there are other assets depending on it.
Here is the Optimize assets dependency graph:
/ Hierarchy \
ILink - Dimension { } KPI - Rule
\ EventMap / / \ DataFilter /

If the Analytic Engine does not run in Static DB Schema mode and some assets cannot
be removed, Deployer aempts to update these assets at deployment time. This is not
supported by the Static DB Schema mode.

webMethods Deployer User’s Guide Version 9.6 232

 M  
Odd Header

Potential Problems
When you deploy Optimize assets, it is possible to overlook seings, configure various
seings incorrectly, or aempt unsupported actions. As a result, the deployment fails or
other issues occur. This topic covers commonly encountered problems.

Deployer Batch Size

DeployerBatch Size must always be 0 (zero). If the batch size is set to any other value,
Deployer will try to split your deployment set into smaller chunks, which will violate
both prerequisites described above.
For more information about seing up the Batch Size property, see " Seing General
Deployment Defaults" on page 77.

Removing Assets from a Deployment Set

If you decide that you no longer need an asset that has been previously deployed, you
cannot simply remove the asset from your previously deployed deployment set and
re-deploy it. If you do so, the existing asset on the target Analytic Engine (which is no
longer in the deployment set) will prevent the removal of any assets it depends on.
To address this, you must first remove all assets from the target Analytic Engine that are
depended on by the asset you want to remove from your deployment set. To do so:
1. Set up your target host as a source and create a new project with a deployment set
containing all the assets you want to remove.
2. Set up your target host as a target again and map the deployment set created in step
1 to it.

Note: For example, you might have two Optimize servers configured with different
names and the same host and port.

3. After you create a deployment candidate, click Create Checkpoint to activate the
Rollback buon.
4. Click Rollback to remove all assets in the deployment set created in step 1 from the
target Analytic Engine.
After all depended-on assets are removed, you can deploy the modified deployment set
from your original source.

Two or More Deployment Sets for the Same Analytic Engine Using One
Deployment Map
This is not supported. You can carry out either of the following supported methods as an
alternative:

webMethods Deployer User’s Guide Version 9.6 233

 M  
Even Header

Split the Optimize deployment sets into separate projects and complete both stages
consecutively for each project.
or
Remove the target Analytic Engine for all deployment sets. For each deployment set
with no target specified in the deployment map, do the following:
1. Add a target Analytic Engine in the deployment map.
2. Execute both deployment sets and the generated DDLs in the correct order, as
described in Step 1 in " Optimize Deployment Usage Notes" on page 232.
3. Remove the target Analytic Engine from the deployment map.

Executing DDL Statements for Two or More Analytic Engines

This situation applies when you have executed the DDL recording stage for one
deployment set, and then aempt to execute the DDL recording stage for a second
deployment set, with both deployment sets targeting the same Analytic Engine.
This is not supported. You must execute both deployment stages and the generated
DDLs for each deployment set in the correct order, as described in Step 1 in " Optimize
Deployment Usage Notes" on page 232.

webMethods Deployer User’s Guide Version 9.6 234

 M  
Odd Header

C   Deploying to Clustered Integration Servers

■ Overview ..................................................................................................................................... 236
■ Setting Up Connections to Integration Servers in the Cluster ................................................... 236
■ Creating the Target Group ......................................................................................................... 237

webMethods Deployer User’s Guide Version 9.6 235

 M  
Even Header

Overview
Deployer can deploy assets to clustered Integration Servers and to Trading Networks
and process models running on Integration Servers. Keep the following points in mind
when deploying to clustered Integration Servers:
Before you can deploy to a cluster, you must define the connections to the
Integration Servers in the cluster as remote servers and identify the Integration
Servers as part of a target group in Deployer. You can then map and deploy to the
target group as you would to any other target group. Since Trading Networks and
process models run on clustered Integration Servers, to deploy Trading Networks
assets and process models to a cluster, you must set up connections to the cluster
and create a target group that includes the servers in the cluster in the same way.
Before deploying Trading Networks assets to Trading Networks running on
clustered Integration Servers, make sure the tn.cluster.sync.remoteAliases property
is set for each Trading Networks server in the cluster. For instructions, see
webMethods Trading Networks Administrator’s Guide.
To deploy process models to Process Engines running on clustered Integration
Servers, you must configure each Integration Server hosting a process model in a
cluster to use the same alias name and port number as the remote alias defined for
the cluster.

Setting Up Connections to Integration Servers in the Cluster

To set up connections to the Integration Servers in the cluster
1. Make sure all Integration Servers in the cluster are up and running.
2. In the Integration Server Administrator for the Integration Server that hosts Deployer,
define every Integration Server in the Integration Server cluster as a remote server. For more
information about remote servers, and instructions on defining them, see webMethods
Integration Server Administrator’s Guide.

Note: All remote servers should have the same port number as the remote alias of the
primary port of the cluster.

3. In Deployer, install the WmDeployerResource package on each Integration Server in the

Integration Server cluster as follows:
a. Go to the Servers > IS & TN page; the page lists all Integration Servers you defined
as remote servers.
b. In the Install column, select the check box next to each Integration Server.
c. Click Install.

webMethods Deployer User’s Guide Version 9.6 236

 M  
Odd Header

Creating the Target Group

In a clustered environment, the only nodes from which you can select servers for the
target group are those that are part of the primary configured port. To ensure that the
servers are available for the target group, configure all servers in the target group to use
the remote alias of the primary port.
Perform the following procedure to create a target group for a clustered environment.

To create a target group in a clustered environment

1. In Deployer, perform one of the following:

For... Perform the following...

Integration Server or Go to Target Groups > IS & TN and click Create IS & TN
Trading Networks Target Groups.

process models Go to Create BPM(ProcessModel) Target Group and click

Create BPM(ProcessModel) Target Group.

Note: You should not use concurrent deployment when

deploying BPM process models to BPM target groups.
For more information about concurrent deployment, see
"Concurrent and Sequential Deployment" on page 22.

2. In the Name box, type the name to use for the target group. The name can be up to 32
characters long and cannot contain spaces or the following illegal characters:
$~/\#&@^!%*:;,+=><‘’"
3. In the Description box, type a description for the target group. The description length has no
limit and can include any characters.
4. In the Version box, enter the version of the target group.
5. Click Create.
6. In the left-hand pane, click the name of the target group from the Group Name column.
7. On the Configure Target Group pane, set Roll Back All on Failure to Yes.

Note: Roll Back All on Failure is valid for runtime-based deployment only. Deployer
ignores this seing for repository-based deployment.

8. The Available Servers list shows the cluster name as a top-level node in the tree, and then all
the servers in that cluster as child nodes under the cluster name. Select the cluster name node,
and then click Add. The entire cluster tree moves to the Selected Servers list. Click Save.

webMethods Deployer User’s Guide Version 9.6 237

 M  
Even Header

If a server in the cluster is... Then...

Defined as a remote The child node for that server shows the remote
server alias server alias, and you can select it.

Not defined as a remote The child node shows the server host and port, but
server you cannot select it.

Not running That server does not appear in the list at all. Make
sure every server in the cluster is defined as a remote
server and is up and running. For instructions
on defining remote servers, see "Connecting to
Integration Servers and Trading Networks Servers"
on page 56 and webMethods Integration Server
Administrator’s Guide.

Important: If you select individual nodes of the cluster and not the entire cluster,
when you deploy, the nodes in the cluster will no longer be identical. Tasks will not
run equally well on all servers in the cluster, which could cause errors and failures.

9. You can add other clusters or individual servers to the target group.
10. Map the project to the target group.
11. Checkpoint, deploy, and, if necessary, roll back the project as you would in an unclustered
environment.

webMethods Deployer User’s Guide Version 9.6 238

 M  
Odd Header

D   Deployable Assets
■ BPM Process Development Assets ........................................................................................... 240
■ Broker Assets ............................................................................................................................. 241
■ Business Rules Assets .............................................................................................................. 242
■ EDA Assets ................................................................................................................................ 243
■ Event Server Assets .................................................................................................................. 244
■ Integration Server Assets ........................................................................................................... 245
■ My webMethods Server Assets ................................................................................................. 292
■ Optimize Assets ......................................................................................................................... 297
■ Trading Networks Assets ........................................................................................................... 298
■ Universal Messaging Assets ...................................................................................................... 299
■ Other Assets .............................................................................................................................. 301

webMethods Deployer User’s Guide Version 9.6 239

 M  
Even Header

Note: The assets listed in this appendix are supported by repository-based deployment.

BPM Process Development Assets

You can prepare BPM Process Development process models (.process files) created with
Software AG Designer for deployment with Deployer. The build process enables you to
filter the deployable assets by process ID, process version, or a combination of the two.
The following table lists:
The asset that you can export
The asset type ID
Asset dependencies

Asset Asset Type ID Description

Process bpmprocess A typical business process model contains

model references to and dependencies on a number
of other runtime assets. For successful
deployment, each of these other assets must be
checked in to your version control repository.
Before you aempt to deploy a business
process model, ensure that you have all process
elements and dependent assets checked into
your repository, including:

Note: Deployer cannot determine dependencies

for dynamically referenced processes. You should
manually deploy such dependencies.

The entire process project, including the

project directory, the build.xml file, and
all .process files.
The generated process package in Integration
Server.
Any Integration Server packages that
contain Integration Server assets (such as IS
documents or services, including Blaze rule
services) that are invoked from the process.
Any Composite Application Framework
(CAF) assets (especially tasks), any rule assets,
Trading Networks assets, referenced process

webMethods Deployer User’s Guide Version 9.6 240

 M  
Odd Header

Asset Asset Type ID Description

assets from other process projects, or other
assets that are invoked from the process.

Broker Assets
Using Deployer, you can deploy your Broker assets and JNDI assets to another Broker,
and share the assets that you created in Broker with other applications.
webMethods Broker enables you to export the following assets to Deployer:
Broker assets such as clients, client groups, and document types.
JNDI assets such as JMS queues and JMS topics created by webMethods JNDI
providers.
Some Broker assets have dependencies on other Broker components. When you export
assets that have dependencies on other assets, the corresponding dependent assets
are also exported. For example, when you export a client group, the document types
belonging to that client group are also exported.
The following table lists:
The assets that you can export
The asset type ID for each asset
Asset dependencies

Asset Asset Type ID Dependencies

Client group ClientGroup Document Type

Client Client Client Group

Document DocumentType None

type

JMS JMSDestination None

destination
(JMS queues
and JMS
topics
created by
webMethods
JNDI
providers)

webMethods Deployer User’s Guide Version 9.6 241

 M  
Even Header

Business Rules Assets

The following table describes the user-created assets that you can include when using
webMethods Business Rules in deployment projects.

Note: You can deploy business rules assets in repository-based deployment only.

The following table lists:

The assets that you can export
The asset type ID for each asset
Asset dependencies

Asset Asset Type ID Dependencies

Action ruleaction Actions have dependencies based on the

type of action as follows:

For this type of The dependency is...

action...

Service Integration Server

service

Process BPM process

New Data Business rules data

model

Data model ruledatamodel Optionally dependent on a nested data

model.

Decision table ruledecisiontable Always depends on at least one data model.

Optionally dependent on one or more
action.

Event rule ruleeventrule Always dependent on at least one data

model.
Optionally dependent on one or more
action.

webMethods Deployer User’s Guide Version 9.6 242

 M  
Odd Header

Asset Asset Type ID Dependencies

Rule sets ruleset Always dependent on one of the following:

Decision table
Event rule

EDA Assets
This section identifies the assets that you can deploy to EDA deployment endpoints
using Deployer.

Note: You can deploy EDA assets in repository-based deployment only.

The following table lists:

The assets that you can export
The asset type ID for each asset
Asset dependencies

Asset Asset Type ID Dependencies

Event type XSD None.

schema
definitions

NERV NERVComponent None.

component

NERV emit NERVEmitRoute None.

route
Note: A NERV emit route asset might have
a dependency to a NERV component asset
if the logic described in the asset points to
a NERV component defined by a separate
component bundle.

NERV NERVConsumeRoute None.

consume
route Note: A NERV consume route asset
might have a dependency on a NERV
component asset if the logic described in
the asset points to a NERV component
defined by a separate component bundle.

webMethods Deployer User’s Guide Version 9.6 243

 M  
Even Header

Event Server Assets

This section identifies the assets that you can deploy to Event Server using Deployer.

Note: Deployer supports deployment of assets to Event Servers of version 9.5 or earlier
only.

You can deploy the following Event Server assets:

Continuous query projects
Event type projects

Note: You can deploy Event Server assets in repository-based deployment only. You
cannot deploy Event Server assets in runtime-based deployment.

The following table lists the dependencies and properties that you can substitute when
using Deployer to deploy assets to an Event Server.

Asset Asset Type Dependencies, Substitution Values, and Other Considerations

ID

Continuous XML Dependencies:

query
None.
projects
Substitution values:
For each database source defined in the project, you
can substitute the following properties:

Property Description

JdbcConnectionUrl The URL to be used to connect

to the database.

Username The user name to be used to

connect to the database.

Password The password for the user

specified in Username.

A database source in the composite file has the same

URL and user name values that it did at design
time. These values become the default values for
the JdbcConnectionUrl and Username properties at
deployment time. If you leave the JdbcConnectionUrl

webMethods Deployer User’s Guide Version 9.6 244

 M  
Odd Header

Asset Asset Type Dependencies, Substitution Values, and Other Considerations

ID
and Username property fields empty at deployment
time, the default values (those that were assigned to
the database source at design-time) are assigned to the
database source when it is deployed. The password
for a database source, however, is never included in
the composite file. Therefore, the Password property
does not have an associated default value that can be
used for deployment. Because it has no default value,
you must explicitly assign a value to the Password
property for each database source in the composite
file.

Note: If multiple database sources use the same Password

value, select all of them in the Configurable Components
panel, specify the password value and then click
Save Substitutions. Doing this will assign the specified
password to all of the selected data sources in one step.

Integration Server Assets

This section identifies the assets that you can export from Integration Server and deploy
using Deployer.
The assets Integration Server supports for exporting belong to the following asset group
types.
Integration Server administrative assets such as ACLs, extended seings, groups,
JMS alias, JNDI aliases, ports, scheduled tasks and users.

Note: Integration Server does not generate any assets for the Native Users, ACLs, or
Groups. This includes the following:
Native Users. Administrator, Default, Replicator, and Developer.
Native Groups. Everybody, Administrators, Anonymous, Developers, and
Replicators.
Native ACLs. Administrators, Anonymous, Replicators, Developers, Default, and
Internal.

Integration Server packages.

Adapter runtime assets, used by all WmART based adapters and .NET asset, used by
webMethods Package for Microsoft .NET.

webMethods Deployer User’s Guide Version 9.6 245

 M  
Even Header

Integration Server Administrative Assets

This section describes the following:
Adding Administrative Assets to the Source Directory
Global Values for Integration Server Administrative Assets
Integration Server Administrative Assets and Substitution Values

Adding Administrative Assets to the Source Directory

To include administrative assets in the composite for deployment, you must manually
copy or check in the Integration Server_directory\instances\instance_name \config folder
to the source directory. Software AG recommends that you structure your source
directory to contain all of the administrative assets to be included in the composite as
shown in the following example:

In this example, you would define SRC_ROOT as the value of the build.source.dir
property in the build.properties file. For more information about the build.properties
file, see "Seing Build Properties" on page 34.
When run, the build script creates the following:
A composite named package_name .zip for each package included in the source
directory, where package_name is the name of the package (with a composite type
ID of ispackage). For this example, the files would be named packageA.zip and
packageB.zip.
A composite named isconfiguration.zip (with a composite type ID of isconfiguration)
that contains the administrative assets contained in the config directory.
For more information about building composites for repository-based deployment, see
"Building Composites for Repository-Based Deployment" on page 31.
The following table lists the files and directories that you must manually copy or check
in to the source directory in order to build Integration Server administrative assets for
deployment.

webMethods Deployer User’s Guide Version 9.6 246

 M  
Odd Header

Asset Files to copy or check into the source directory

ACLs Integration Server_directory\instances\instance_name \config

\users.cnf
Integration Server_directory\instances\instance_name \config
\acls.cnf

Broker Integration Server_directory\instances\instance_name \config

seings \dispatch.cnf

Cache All Ehcache configuration files located in the

manager Integration Server_directory\instances\instance_name \config
\Caching directory.

Note: Do not include system cache managers. For example, do not

include cache managers whose names start with “SoftwareAG”.

Certificate Integration Server_directory\instances\instance_name \config

seings \server.cnf

Client The Asset Build Environment extracts this asset from the
certificate database.
If you are using the embedded database, the
Asset Build Environment must have access to
Integration Server_directory\instances\instance_name \db
\embedded directory.
If you are using an external database, the Asset Build
Environment requires access to the JDBC configuration files.

CSRF guard Integration Server_directory\instances\instance_name \config

configuration \security\csrf\csrfguard.cnf

Note: Integration Server creates this file only when the CSRF guard
option is enabled in Integration Server Administrator. For more
information, see webMethods Integration Server Administrator’s Guide.

Enhanced Integration Server_directory\instances\instance_name \config

parser \parsing.cnf

Enterprise Integration Server_directory\instances\instance_name \config

Gateway \security\enterprisegateway\enterpriseGatewayRules.cnf
configuration

webMethods Deployer User’s Guide Version 9.6 247

 M  
Even Header

Asset Files to copy or check into the source directory

Extended Integration Server_directory\instances\instance_name \config

seings \server.cnf

Global Integration Server_directory\instances\instance_name \config

variables \globalVariables.cnf

Groups Integration Server_directory\instances\instance_name \config

\users.cnf

IS Packages For all the assets contained in the IS package ACDL file,
you must check in the Integration Server_directory\instances
\instance_name \packages\package_name directory (where
package_name is the package for which the ACDL is required) to
the source directory.
The following files are required to retain ACL information for the
different assets in a package:
Integration Server_directory\instances\instance_name \config
\acls.cnf
Integration Server_directory\instances\instance_name \config
\aclmap_sm.cnf
Integration Server_directory\instances\instance_name \config
\acllist.cnf
Integration Server_directory\instances\instance_name \config
\aclread.cnf
Integration Server_directory\instances\instance_name \config
\aclwrite.cnf

JDBC driver Integration Server_directory\instances\instance_name \config\jdbc

alias \driver\*.xml

Note: The Asset Build Environment does not extract default driver
aliases that are installed with Integration Server.

JDBC Integration Server_directory\instances\instance_name \config\jdbc

functional \function\*.xml
alias

JDBC pool Integration Server_directory\instances\instance_name \config\jdbc

alias \pool\*.xml

webMethods Deployer User’s Guide Version 9.6 248

 M  
Odd Header

Asset Files to copy or check into the source directory

Note: The Asset Build Environment does not extract the embedded
database pool alias.

JMS aliases Integration Server_directory\instances\instance_name \config

\jms.cnf

JNDI aliases Integration Server_directory\instances\instance_name \config\jndi

\jndi_*.properties

Keystore The Asset Build Environment extracts keystore

alias alias details from the *_config.xml files stored in the
Integration Server_directory\instances\instance_name \config
\security\keystore directory and then reads the actual keystore
binary file (the .jks or .p12) from the value found in the "location"
field of the keystore alias definition.

LDAP Integration Server_directory\instances\instance_name \config

configuration \ldap.cnf

Metadata Integration Server_directory\instances\instance_name \packages

\WmAssetPublisher\config\assetpublisher.cnf

Ports Integration Server_directory\instances\instance_name \packages

\package_name\config\listeners.cnf

Proxy server Integration Server_directory\instances\instance_name \config

alias \proxy.cnf

Proxy server Integration Server_directory\instances\instance_name \config

bypass \server.cnf

Note: The Asset Build Environment does not extract this file if
wa.net.proxySkipList is set to localhost. For more information
about wa.net.proxySkipList, see webMethods Integration Server
Administrator’s Guide.

Quiesce Integration Server_directory\instances\instance_name \config

mode \quiesce.cnf
configuration

webMethods Deployer User’s Guide Version 9.6 249

 M  
Even Header

Asset Files to copy or check into the source directory

Reliable Integration Server_directory\instances\instance_name \config

messaging \reliableMessaging.cnf
configuration

Remote Integration Server_directory\instances\instance_name \config

server alias \remote.cnf

Note: The Asset Build Environment does not extract remote server
aliases named "local".

SAML token Integration Server_directory\instances\instance_name \config

issuer \security\saml\trusted_saml_issuers.cnf

Scheduled The Asset Build Environment extracts this asset from a database,
tasks and requires either of the following:
If you are using the embedded database, the
Asset Build Environment must have access to
Integration Server_directory\instances\instance_name \db
\embedded directory.
If you are using an external database, the Asset Build
Environment requires access to the JDBC configuration files.

SFTP server Integration Server_directory\instances\instance_name \config\sftp

alias \sftpServerAliases.cnf

SFTP user Integration Server_directory\instances\instance_name \config

alias \sftp\sftpUserAliases.cnf
Integration Server_directory\instances\instance_name \config
\sftp\identities directory and its contents

Truststore The Asset Build Environment extracts truststore

alias alias details from the *_config.xml files stored in the
Integration Server_directory\instances\instance_name \config
\security\keystore directory and reads the actual truststore
binary file (.jks or .p12) from the value found in the "location"
field of the truststore alias definition.

URL alias Integration Server_directory\instances\instance_name \packages

\package_name \config\urlalias.cnf

webMethods Deployer User’s Guide Version 9.6 250

 M  
Odd Header

Asset Files to copy or check into the source directory

Users Integration Server_directory\instances\instance_name \config

\users.cnf

Web service Integration Server_directory\instances\instance_name \config

endpoint \endpoints\*.cnf
alias

Web service All .policy files in the Integration Server_directory\instances

policy \instance_name \config\wss\policies directory.

Global Values for Integration Server Administrative Assets

The following table lists the global administrative assets and substitution values for each
that Integration Server supports for deployment. The assets presented in the table are
deployed as assets within the isconfiguration composite.

Asset Asset Type ID Substitution Values

Cache iscachemanager Reload Cache Managers After Deployment

manager (reloadCacheManagersAfterDeployment)
Specifies whether the cache managers
on the target servers are started after
deployment.
True starts the cache manager on the
target servers after deployment. If the
cache manager is already in the start state
on the target Integration Server, a value
of True will restart the cache manager
with the new configuration.
False does not start the cache manager
on the target servers after deployment. If
the cache manager is already in the start
state on the target Integration Server, a
value of False will not restart the cache
manager.
None uses the value specified at the cache
manager level Reload property. If the
Reload property of the cache manager
has the value None, cache manager is not
started after deployment.
If the cache manager is in a start state on
the target Integration Server, a value of

webMethods Deployer User’s Guide Version 9.6 251

 M  
Even Header

Asset Asset Type ID Substitution Values

None will not restart the cache manager.
If the cache manager is in a shutdown
state on target Integration Server, the
cache manager will not be started.
The default is None.

Note: Integration Server deploys a cache manager that uses BigMemory or Terracoa
Server Array only if you have the appropriate Terracoa and Integration Server
licenses. For more information about licenses, see webMethods Integration Server
Administrator’s Guide.

Ports isport Enable Ports After Deployment

(enablePortsAfterDeploy)
Specifies whether the ports on the target
servers are enabled after deployment.
True enables the port on the target servers
after deployment.
False disables the port on the target
servers after deployment.
None uses the value specified at the port
level Enable property. The default is None.

Scheduled istask Suspend tasks during deployment

task (suspendTasksDuringDeploy)
Specifies whether you want to suspend all
scheduled tasks during deployment.
True indicates that you want to suspend
all tasks during deployment.
False indicates that you want all tasks to
run as scheduled during deployment.
None indicates that you want use the
value specified by the Suspend During
Deployment value of each scheduled task
asset. If the task has the value of None, no
action is taken during deployment. The
default value is None.

Activate tasks after deployment

(activateTasksAfterDeploy)

webMethods Deployer User’s Guide Version 9.6 252

 M  
Odd Header

Asset Asset Type ID Substitution Values

Specifies whether you want to activate all

scheduled tasks after deployment.
True indicates that you want all tasks to
activate after deployment.
False indicates that you want all tasks to
suspend after deployment.
None indicates that you want use the
value specified by the Activate After
Deployment value from each scheduled
task asset. If the task has the value of
None, no action will be taken during
deployment.

Integration Server Administrative Assets and Substitution Values

The following sections describe the Integration Server administrative assets and their
corresponding substitution values.

ACLs
The following table lists the asset type ID and substitution values for ACL assets.

Asset Type ID isacl

Substitution Values

None.

Broker Settings
The following table lists the asset type ID and substitution values for Broker seings
assets.

Asset Type ID isbrokerseings

Substitution Values

Broker Configuration Settings:

Broker Host Name (DNSname:port or ipaddress:port ) of the machine on which

the Broker Server resides.

webMethods Deployer User’s Guide Version 9.6 253

 M  
Even Header

brokerHost

Broker Name Name of the Broker to which the Integration Server connects.
brokerName

Client Group Client group to which the Integration Server belongs.

clientGroup

Client Prefix A string that identifies the Integration Server to the Broker.
CLIENTPREFIX

Client Authentication Settings:

Username User name required to connect to the Broker.

brokerUser

Password Password required to connect to the Broker.

brokerPassword

Keystore The full path to the keystore file for the target Integration Server.
certFile

Keystore Password required to access the SSL certificate in the Integration

Password Server’s keystore file.
password

Use Source Specifies whether the target Integration Server uses the keystore
Keystore file from the source Integration Server.
True
useSourceBrokerKeystore indicates that the target Integration Server uses the
keystore file from the source Integration Server. This is the
default.
False indicates that the target Integration Server will use a
different keystore file than the source Integration Server.

Note: This configuration value does not correspond to a field or

property in Integration Server.

Encryption Settings:

Truststore Full path to the Integration Server’s client truststore file.

webMethods Deployer User’s Guide Version 9.6 254

 M  
Odd Header

truststore

Use Source Specifies whether the target Integration Server uses the truststore
Truststore file from the source Integration Server.
useSource True indicates that the target Integration Server uses the
Broker truststore file from the source Integration Server. This is the
Truststore default.
False indicates that the target Integration Server will use a
different truststore file than the source Integration Server.

Note: This configuration value does not correspond to a field or

property in Integration Server.

Cache Manager

Note: Integration Server deploys a cache manager that uses BigMemory or Terracoa
Server Array only if you have the appropriate Terracoa and Integration Server licenses.
For more information about licenses, see webMethods Integration Server Administrator’s
Guide.

Asset Type ID iscachemanager

Substitution Values

cacheManagerName Name. The name of the cache manager.

Note: If a cache manager with the same name exists in both the
source and target servers and if the cache manager name is
modified while deploying to the target server, the target server will
contain both the cache managers, one with the old name as well as
the one with the name used while deploying.

urls Terracotta Server Array URLs. (Optional.) Comma-separated list

of host names and port numbers, one for each server in the
Terracoa Server Array. You can add multiple URLs by using
this format: host1:port,host2:port...

Note: You must specify the Terracoa Server Array URLs only if
you have distributed caches in the cache manager.

reload Reload. Specifies whether the cache manager on the target servers
is started after deployment.
True starts the cache manager on the target servers after
deployment.

webMethods Deployer User’s Guide Version 9.6 255

 M  
Even Header

False does not start the cache manager on the target servers
after deployment.
None indicates that you want to use the global value specified
by the deployment options on the Deployment Map Properties
> Configure Builds by Assets screen and by the Reload Cache
Managers After Deployment value in the project map file.
If the cache manager is in a start state on the target Integration
Server, a value of None will not restart the cache manager. If
the cache manager is in a shutdown state on target Integration
Server, the cache manager will not be started.
The default is None.

Certificate Settings

Asset Type ID iscertificates

Substitution Values

None.

Client Certificates

Asset Type ID isclientcerts

Substitution Values

Certificate The name of the file containing the certificate that you want to
Path import. You may specify the file name using an absolute path or
using a path that is relative to Integration Server_directory. The file
certificate
must contain an X.509 certificate in DER file format.
Path

CSRF Guard Configuration

Asset Type ID iscsrfguardconfig

Substitution Values

Enabled Specifies whether CSRF guard is enabled in Integration Server.

isEnabled True specifies that CSRF guard is enabled.

webMethods Deployer User’s Guide Version 9.6 256

 M  
Odd Header

False specifies that CSRF is not enabled. This is the default.

Excluded User A list of user agents for which Integration Server is not to apply
Agents CSRF guard. If CSRF guard is enabled, Integration Server
requires that HTTP requests coming from user agents that are
excludedUser
not specified as excluded must contain CSRF secure tokens.
Agents

Landing Pages A list of landing pages for the packages in your Integration
Server. A landing page is the home page for a package.
landingPages
Integration Server does not check for CSRF secure tokens in
the landing pages, but inserts a token for that page. Integration
Server guards all further requests from these landing pages with
CSRF secure tokens.

Unprotected The URLs for which Integration Server is not to check for CSRF
URLs secure tokens. If CSRF guard is enabled, Integration Server
requires that the requests coming from all URLs that are not
unprotected
specified as unprotected must contain CSRF secure tokens.
URLs

Denial Action Action that you want Integration Server to perform when it
detects that a request does not contain a CSRF secure token or
denialAction
contains an invalid CSRF secure token.
Error specifies that you want Integration Server to throw an
access denied error and terminate the request. This is the
default.
Redirect specifies that Integration Server is to redirect the user
to a confirmation page or the home page of Integration Server
Administrator.

webMethods Enterprise Gateway Configuration

Asset Type ID isenterprisegatewayrules

Substitution Values

Email To One or more email addresses to which the Integration Server

acting as the Enterprise Gateway Server sends an alert when a
emailTo
request violates an Enterprise Gateway rule. This is the global
value associated with the default alert option. The server uses
this seing when a rule does not specify a custom alert seing.

User Name Integration Server user ID to run the flow service that executes
when a request violates an Enterprise Gateway rule. This is the

webMethods Deployer User’s Guide Version 9.6 257

 M  
Even Header

global value associated with the default alert option. Enterprise

userName
Gateway Server uses this seing when a rule does not specify a
custom alert seing.

Email To One or more email addresses to which Enterprise Gateway

Server sends an alert when a request violates an Enterprise
rule_name
Gateway rule. This value is part of the custom alert options
_ emailTo
defined for an individual rule.

User Name Integration Server user ID to run the flow service that executes
when a request violates an Enterprise Gateway rule. This value is
rule_name
part of the custom alert options defined for an individual rule.
_user Name

Extended Settings

Asset Type ID isproperty

Substitution Values

Server configuration parameters that are set as visible. Allows users to specify
values for wa properties that are set as visible in the source Integration Server.

File Access Control Configuration

Asset Type isfileaccesscontrol

ID

Substitution Values

Allowed Read Semicolon-delimited list of directories to which the services in

Paths the pub.file folder in the WmPublic package have read permission.
allowedRead
Paths

Allowed Write Semicolon-delimited list of directories to which the services

Paths in the pub.file folder in the WmPublic package have write
permission.
allowedWrite
Paths

Allowed Delete Semicolon-delimited list of directories that the services in the

Paths pub.file folder in the WmPublic package have permission to
delete.

webMethods Deployer User’s Guide Version 9.6 258

 M  
Odd Header

allowedDelete
Paths Note: After making changes and deploying fileAccessControl.cnf,
you must reload the WmPublic package or restart Integration
Server for the changes to take effect.

Global Variables

Asset Type isglobalvariable

ID

Substitution Values

Value Values for global variables.

Value

Groups

Asset Type ID isgroup

Substitution Values

None.

JDBC Driver Alias

Asset Type isjdbcdriveralias

ID

Substitution Values

None.

JDBC Pool Alias Configuration

Asset Type isjdbcpoolalias

ID

Substitution Values

Database URL The URL to use to connect to the database.

webMethods Deployer User’s Guide Version 9.6 259

 M  
Even Header

databaseURL

User ID Database user for the target Integration Server to use to

communicate with the database.
userID

Password Password for the specified database user.

password

JDBC Functional Alias

Asset Type isjdbcfunctionalalias

ID

Substitution Values

None.

JMS Connection Alias

Asset Type isjmsalias

ID

Substitution Values

General Settings:

Connection The JMS client identifier associated with the connections

Client ID established by this JMS connection alias.
clientID

User User name required to acquire a connection from the connection

factory.
user

Password Password required to acquire a connection from the connection

factory.
password

JNDI Connection Protocol Settings:

webMethods Deployer User’s Guide Version 9.6 260

 M  
Odd Header

JNDI Provider Alias name of the JNDI provider.

Alias Name
jndi_jndiAlias
Name

JNDI Lookup name that the connection factory uses to create a

Connection connection to the JNDI provider.
Factory
Lookup Name
jndi_
connection
FactoryLookup
Name

Native webMethods Connection Protocol Settings:

Broker Host Name (DNSname:port or ipaddress:port ) of the machine on which

the Broker Server resides.
nwm_brokerHost

Broker Name Name of the Broker as defined on the Broker Server.

nwm_brokerName

Client Group Name of the client group that you want the target Integration
Server to use when it acts as a JMS client.
nwm_client
Group

Broker List Comma delimited list of Broker Servers on which the connection
between the target Integration Server (acting as the JMS client)
nwm_brokerList
and the webMethods Broker (acting as a JMS provider) can exist.

Keystore The full path to the target Integration Server’s keystore file.
nwm_keystore

Truststore Full path to target Integration Server client's truststore file.

nwm_truststore

JNDI Alias

Asset Type isjndialias

ID

webMethods Deployer User’s Guide Version 9.6 261

 M  
Even Header

Substitution Values

Provider URL The primary URL of the initial context for sessions with the JNDI
provider. The URL specifies the JNDI directory in which the
providerURL
JNDI provider stores JMS administered objects.

Provider URL A list of URLs to which the target Integration Server can
Failover List connect if the connection to the primary JNDI provider becomes
unavailable. Separate the URLs with an ampersand, new line,
providerURL
carriage return, or horizontal tab.
FailoverList

Security The principal name, or user name supplied by the target

Principal Integration Server to the JNDI provider, if the provider requires
one for accessing the JNDI directory. For information about
security
whether or not the JNDI provider requires security principal
Principal
information, consult the product documentation for the JNDI
provider.

Security The credentials, or password, that the target Integration Server

Credentials provides to the JNDI provider, if the provider requires security
credentials to access the JNDI directory.For information about
security
whether or not the JNDI provider requires security credentials,
Credentials
consult the product documentation for the JNDI provider.

Keystore Alias

Asset Type iskeystorealias

ID

Substitution Values

Location The full path to the keystore file for the target Integration Server.
ksLocation

Password Password associated with this alias that is used to protect the
contents of the keystore.
ksPassword

Key Alias Password for each key alias residing in the keystore.
Password
keyAlias.
keyAliasName

webMethods Deployer User’s Guide Version 9.6 262

 M  
Odd Header

Use Source Specifies whether the target Integration Server uses the keystore
Keystore file from the source Integration Server.
useSource True indicates that the target Integration Server uses the
Keystore keystore file from the source Integration Server. This is the
default.
False indicates that the target Integration Server will use a
different keystore file than the source Integration Server.

Note: This configuration value does not correspond to a field or

property in Integration Server.

LDAP Configuration

Asset Type isldapdirectory

ID

Substitution Values

Directory URL The complete URL of the LDAP server. The URL has the format
protocol:\\hostname:portnumber\DistinguishedName , where:
directoryURL
protocol is ldap for standard connections or ldaps for secure
connections
host is the host name or IP address of the LDAP server
portnumber is the port on which the server is running. The port
is optional. If omied, the port defaults to 389 for LDAP, or 636
for LDAPS.
DistinguishedName is optional, and is in the form of an LDAP
distinguished name (DN), for example "dc=webMethods,
dc=com", or "o=webMethods.com", depending on how your
directory is set up.
The default value for directoryURL is ldap:\\localhost:389\.

Principal The user ID the Integration Server should supply to connect to

the LDAP server, for example, o=webm.com or dc=webm,dc=com.
principal

Credentials The password the Integration Server should supply to connect to

the LDAP server, that is, the Principal's password.
credentials

webMethods Deployer User’s Guide Version 9.6 263

 M  
Even Header

Metadata

Note: Deployer extracts the metadata asset from the WmAssetPublisher package. Make
sure this package resides in the source folder before extracting the asset.

Asset Type ismetadata

ID

Substitution Values

CentraSiteURL The CentraSite URL to which to publish metadata about

Integration Server assets.
centraSiteURL
For example: hp:\\localhost:port \CentraSite\CentraSite

User Name The name of the user account on CentraSite that will be used for
publishing and retracting metadata.
centraSiteUser
name

Password Password associated with User Name.

centraSite
Password

Enhanced Parser

Asset Type isparsing

ID

Substitution Values

Default Specifies the size, measured in bytes, of the partitions on the

Partition Bytes heap where the enhanced XML parser stores parsed document
information. Specify a suffix of “k” to indicate kilobytes or “m”
default
to indicate megabytes. For example, 10k or 10m.
PartitionBytes
Note: This value is used only when the enhanced parser is invoked
and no partition size is specified.

Use Cache Indicates if caching used with the enhanced XML parser.
useCache True indicates that during parsing of an XML document,
Integration Server moves partitions to an off-heap area on disk

webMethods Deployer User’s Guide Version 9.6 264

 M  
Odd Header

when the on-heap partition space becomes full and retrieves the
partitions as needed during processing.
False indicates that Integration Server does not cache partitions
when parsing an XML document.

Maximum Maximum amount of heap space that the parser can allocate
Heap Bytes to process documents concurrently. Specify a suffix of “k” to
indicate kilobytes, “m” to indicate megabytes, “g” to indicate
maximumHeap
gigabytes, and “%” to indicate a percentage of the heap space.
Bytes
For example, 10k, 10m, 10g, or 10%.

Maximum Maximum amount of heap space that the parser can allocate to
Document process a single document. Specify a suffix of “k” to indicate
Bytes kilobytes, “m” to indicate megabytes, “g” to indicate gigabytes,
and “%” to indicate a percentage of the heap space. For example,
maximumDoc
10k, 10m, 10g, or 10%.
Bytes

UseBigMemory Indicates if BigMemory is used with the enhanced XML parser.

useBigMemory True indicates that when parsing an XML document using the
enhanced XML parser Integration Server moves partitions to
BigMemory once the on-heap cache is full. When BigMemory
becomes full partitions are move to disk. Integration Server
retrieves partitions from disk or BigMemory as needed.
False indicates that when parsing an XML document using
the enhanced XML parser Integration Server does not use
BigMemory to store cached partitions.

MaximumBig Maximum amount of non-heap memory, measured in bytes,

MemoryBytes to allocate to BigMemory. Specify a suffix of “k” to indicate
kilobytes, “m” to indicate megabytes, or “g” to indicate
maximumBig
gigabytes. For example, 10k, 10m, or 10g.
MemoryBytes

Ports

Asset Type isport

ID

Substitution Values

General values for all ports (email, file polling, FTP, FTPS, HTTP, HTTPS, and quiesce):

webMethods Deployer User’s Guide Version 9.6 265

 M  
Even Header

Note: Deployer extracts the Ports asset from the package in which the port is
configured. Make sure this package resides in the source folder before extracting the
asset.

Package Name The package name you want to associate with the port on the
target servers.
pkg
If the port is used as the quiesce port, the port alias should be
associated with either the WmRoot or WmPublic package.

Enable Specifies whether the port on the target servers are enabled or
(enable disabled after deployment.
True enables the port on the target servers after deployment.
False indicates that you do not want the port enabled on the
target servers after deployment.
None indicates that you want to use the global value specified
by the deployment options on the Deployment Map Properties >
Configure Builds by Assets screen and by the Enable Ports After
Deployment value in the project map file.

Hosts A comma delimited list that specifies the hosts allowed or not
allowed to connect to the target servers through this port.
hostList

Note: If the Access Mode is Global, the host list is ignored. If the
Access Mode is Allow, the host list represents the hosts that are
denied access to the port. If the Access Mode is Deny, the host list
represents the hosts that are allowed access to the port.

IP access type Specify the access type of host that is allowed to connect to the
target servers through this port.
hostAccessMode
Allow indicates that you want Integration Server to allow access
by default and to deny the hosts specified in the hosts list.
Deny indicates that you want Integration Server to deny access
by default and allow only hosts specified in the host list.
Global indicates that you want to use the global access seings
specified on Integration Server.
For detailed information about IP access types and controlling IP
access, see webMethods Integration Server Administrator’s Guide.

Email port:

webMethods Deployer User’s Guide Version 9.6 266

 M  
Odd Header

Host Name The name of the machine on which the POP3 or IMAP server
runs.
host

Port (Optional.) The port on the e-mail server to which the target
servers can connect.
server_port

User Name A user name that identifies the target servers to the e-mail server.
user

Password The password associated with the user name that identifies the
target servers to the e-mail server.
password

Run services The user name you want the target servers to use when running
as user the service.
runUser The target servers run the service as if the user you specify is
the authenticated user that invoked the service. If the service is
governed by an ACL, be sure to specify a user that is allowed to
invoke the service.

File polling port:

Monitor The directory on the target servers that you want to monitor for
Directory files.
monitorDir

Working (Optional.) The directory on the target servers to which the

Directory servers should move files for processing after they have been
identified in the Monitoring Directory. Files must meet age and
workDir
file name requirements before being moved to the Working
Directory.

Completion (Optional.) The directory on the target servers to which you want
Directory files moved when processing is completed in the Monitoring
Directory or Working Directory.
completionDir

Error Directory The directory on the target servers to which you want files
moved when processing fails.
errorDir

Enable Specifies whether the target servers should allow clustering in

Clustering the Monitoring Directory.

webMethods Deployer User’s Guide Version 9.6 267

 M  
Even Header

clusterEnabled Yes indicates that you want the target servers to allow
clustering in the Monitoring Directory.
No indicates that you do not want the target servers to allow
clustering in the Monitoring Directory.

Run Services The user name you want the target servers to use when running
as User the service.
runUser The target servers run the service as if the user you specify is
the authenticated user that invoked the service. If the service is
governed by an ACL, be sure to specify a user that is allowed to
invoke the service.

Directories are For use on a UNIX system where the monitoring directory,
NFS mounted working directory, completion directory, and/or error directory
file system are network drives mounted on the local file system.
NFSDirectories No indicates that you want the listener to call the Java
File.renameTo() method and move the files from the
monitoring directory to the working directory, and from the
working directory to the completion and/or error directory.
This is the default.
Yes indicates that you want the listener to first call the Java
File.renameTo() method to move the files from the monitoring
directory. If this method fails, the listener will copy the files
from the monitoring directory to the working directory and
delete the files from the monitoring directory. This operation
will fail if either the copy action or the delete action fails. The
same behavior applies when moving files from the working
directory to the completion and/or error directory.

FTP port:

Port The port number you want to use for the FTP port on the target
servers. Select a number that is not already in use on the target
port
servers.

Bind address (Optional.) IP address to which to bind this port. Specify the
substitute bind address if the target servers have multiple IP
bindAddress
addresses and you want the port to use this specific address.

FTPS port:

webMethods Deployer User’s Guide Version 9.6 268

 M  
Odd Header

Port The port number you want to use for the FTPS port on the target
servers. Select a number that is not already in use on the target
port
servers.

Bind address (Optional.) IP address to which to bind this port. Specify the
substitute bind address if the target servers have multiple IP
bindAddress
addresses and you want the port to use this specific address.

Secure Clients Specify whether you want to prevent the FTPS listener from
Only operating with non-secure clients.
secureclients True prevents the FTPS listener from operating with non-secure
clients.
False allows the FTPS listener to operate with non-secure
clients.

HTTP port and HTTPS port:

Port The port number you want to use for the HTTP port or HTTPS
port on the target servers. Select a number that is not already in
port
use on the target servers.

Bind address (Optional.) IP address to which to bind this port. Specify the
substitute bind address if the target servers have multiple IP
bindAddress
addresses and you want the port to use this specific address.

Quiesce port:

Quiesce Port The Integration Server port to use as the quiesce port on the
target servers.
quiesceport

Note: Ensure that the port alias is associated with either the
WmRoot or the WmPublic package and is of type HTTP or HTTPS.

Proxy server alias

Asset Type ID isproxyserveralias

Substitution Values

Host Name or The host name or IP address of the proxy server.

IP Address
host

webMethods Deployer User’s Guide Version 9.6 269

 M  
Even Header

Port Number The port on which this proxy server listens for requests.
port

User Name The user name Integration Server must use when accessing this
proxy server.
username

Password The password Integration Server must use to access this proxy
server.
password

Proxy Server Bypass

Asset Type ID isproxyserverbypass

Substitution Values

Addresses The fully qualified host and domain name of each server to
which you want the Integration Server to issue requests directly.
addresses
Type the host name and the domain name exactly as they appear
in the URLs the server uses. To enter multiple names, separate
each with commas.You can use the asterisk (*) to identify several
servers with similar names. The asterisk matches any number of
characters. For example, if you want to bypass requests made to
localhost, www.yahoo.com, home.microsoft.com, and all hosts
whose names begin with NYC, you would type:
localhost,www.yahoo.com,home.microsoft.com, NYC*.*

Reliable Messaging Configuration

Asset Type ID isreliablemessaging

Substitution Values

Retransmission The time interval (in milliseconds) for which a reliable

Interval messaging source waits for an acknowledgement from the
reliable messaging destination before the source retransmits the
retransmission
SOAP message.
Interval

Acknowledgement The time interval (in milliseconds) for which the

Interval reliable messaging destination waits before sending an
acknowledgement for a message sequence. Messages of the

webMethods Deployer User’s Guide Version 9.6 270

 M  
Odd Header

acknowledgement same sequence received within the specified acknowledgement

Interval interval are acknowledged in one batch. If there are no other
messages to be sent to the acknowledgement endpoint within
the time specified as the acknowledgement interval, the
acknowledgement is sent as a stand alone message.

Exponential Whether to use the exponential backoff algorithm to adjust the

Backoff retransmission interval of unacknowledged messages. Adjusting
the time interval between retransmission aempts ensures that a
exponential
reliable messaging destination does not get flooded with a large
Backoff
number of retransmied messages.
True specifies that the successive retransmission intervals
must be increased exponentially, based on the specified
retransmission interval. For example, if the specified
retransmission interval is 2 seconds, and the exponential
backoff value is set to true, successive retransmission intervals
will be 2, 4, 8, 16, 32, and so on if messages continue to be
unacknowledged.
False specifies that the retransmission interval is not to be
adjusted.

Inactivity The length of time for which a reliable messaging source waits
Timeout for an acknowledgement from a reliable messaging destination
before the source stops retransmiing the SOAP message.
inactivity
Timeout If the reliable messaging source does not receive an
acknowledgement within the inactivity timeout specified, it
marks the sequence as timed out. You cannot use a sequence if it
is timed out. To indicate that there is no inactivity timeout limit,
set the value of Inactivity Timeout as -1.

Inactivity The unit of measure for the inactivity Timeout property. You
Timeout can specify the unit of measurement as seconds, minutes, hours,
Interval or days. The default is 60 seconds.
inactivity
TimeoutMeasure

Sequence The length of time for which a reliable messaging source waits
Removal for an acknowledgement from a reliable messaging destination
Timeout before it terminates the sequence and removes the sequence
from the memory.
sequenceRemoval
Timeout

webMethods Deployer User’s Guide Version 9.6 271

 M  
Even Header

Sequence The unit of measure for the sequenceRemovalTimeout property.

Removal You can specify the unit of measurement as seconds, minutes,
Timeout hours or days. The default is 60 seconds.
Interval
Measure
sequenceRemoval
TimeoutMeasure

In-Order Whether the messages in a sequence must be delivered to a

Delivery reliable messaging destination in the same order in which they
Assurance have been sent by the reliable messaging source.
invokeInOrder True specifies that the messages in a sequence must be
delivered to the destination in the same order in which they
have been sent. The order in which the messages are sent is
indicated by the sequence key of each message. This is the
default.
False specifies that the delivery of messages in the same order
in which they have been sent is not to be enforced.

Maximum The number of times a reliable messaging source must

Retransmission retransmit a message if an acknowledgement is not received
Count from the reliable messaging destination. The value must
be an integer within the range of 1 and 256 (inclusive). The
maximum
default is 10. To indicate that there is no limit to the number of
Retransmission
retransmission aempts, set the value of Maximum Retransmission
Count
Count as -1.

Storage Type Specifies whether Integration Server uses the persistent or

non-persistent mode to store the reliable messaging sequence
storageType
information.
Non-Persistent specifies that the reliable messaging sequence
information is stored in a non-persistent storage mode.
When the Non-Persistent mode of storage is used, Integration
Server relies on the on-heap memory for reliable messaging
data storage. When Integration Server restarts, the reliable
messaging information will be removed from memory. This is
the default.
Database specifies that the reliable messaging sequence
information is stored in a persistent storage mode. When the
Database mode of storage is used, Integration Server uses
a database to store the reliable messaging information. All
information related to reliable messaging sequences, including
the essential routing and delivery information, is preserved
across Integration Server restarts.

webMethods Deployer User’s Guide Version 9.6 272

 M  
Odd Header

Housekeeping Specifies the time interval (in seconds) in which Integration

Interval Server sweeps the database to check for timed-out or terminated
(Seconds) sequences.
houseKeeping The messages are timed out or terminated depending on the
Interval specified Inactivity Timeout and Sequence Removal Timeout values.
Integration Server sweeps the database periodically based on
the Housekeeping Interval and identifies and marks the messages
that are timed out and removes the terminated messages if the
sequenceRemovalTimeout interval is completed for the sequence.

The default is 20 seconds.

Remote Server Alias

Note: Deployer does not export remote server aliases that use the alias name “local”.

Asset Type ID isremoteserveralias

Substitution Values

Host Name The host name or IP address of the remote server represented by
the alias.
host

Retry Server Host name or IP address of the remote server you want the target
Integration Server to connect to if the primary remote server is
retryServer
unavailable.

Port The port number that is used by the remote server specified by
the alias.
server_port

User Name User name the target server will use to access and invoke
services on the remote server.
user

Password Password identified in the user account for User Name.

pass

SAML Token Issuer

Asset Type ID issamlissuer

webMethods Deployer User’s Guide Version 9.6 273

 M  
Even Header

Substitution Values

None.

Scheduled Tasks

Asset Type ID istask

Substitution Values

Run as User User name the target servers will use when running the service.
runAsUser The target servers run the service as if the user you specify is
the authenticated user that invoked the service. If the service is
governed by an ACL, be sure to specify a user that is allowed to
invoke the service.

Cluster Target Specifies whether you want the task to run on other target
Node servers in the cluster.
Target Any server indicates that you want the task to run on only one
server in the cluster, and it does not maer which one.
All servers indicates that you want the task to run on all servers
in the cluster.
Enter a specific server name in the cluster if the task needs to
run on only a specific server.

Note: To use this parameter, the source server must be enabled for
clustering and the target servers must belong to a cluster.

Suspend Specifies whether you want to suspend the existing task during
During deployment.
Deployment
True indicates that you want to suspend the task during
suspendDuring deployment.
Deploy
False indicates that you want the task to run as scheduled
during deployment.
None indicates that you want to use the global value specified
on the Deployment Map Properties > Configure Builds by Assets
screen and by the Suspend tasks during deployment value in the
project map file. The default value is None.

Activate after Specifies whether you want to activate the existing task after
deployment deployment.

webMethods Deployer User’s Guide Version 9.6 274

 M  
Odd Header

activateAfter
True indicates that you want the task to activate after
Deploy
deployment.
False indicates that you want the task to suspend after
deployment.
None indicates that you want to use the global value specified
on the Deployment Map Properties > Configure Builds by Assets
screen and by the Activate tasks after deployment value in the
project map file.
The default value is True if the scheduled task is active (not
suspended) on the source server. The default is False if the
scheduled task is suspended on the source server.

SFTP Server Alias

Asset Type ID issftpserveralias

Substitution Values

Host Name or Host name or IP address of the SFTP server.

IP Address
hostName

Port Number Port number of the SFTP server. The port number must be within
the range of 0 and 65535 (inclusive).
port

Host Key Location of the public key file of the SFTP server. Integration
Location Server populates this field with the host key file of the source
Integration Server. You can change the value of this field to
hostKey
specify a different host key file for deployment.
Location
Important: The public key file must be present on the same machine
in which you have installed Integration Server.

SFTP User Alias

Asset Type ID issftpuseralias

Substitution Values

User Name User name for the SFTP user account.

webMethods Deployer User’s Guide Version 9.6 275

 M  
Even Header

userName

Authentication The type of authentication that Integration Server uses to

Type authenticate itself to the SFTP server. Client authentication type
can be either password or publicKey.
authentication
Type

Password Password for the specified user to connect to the SFTP server if
you are using password authentication.
password

PassPhrase Passphrase for the private key file of the specified user if you
are using public key authentication and if the private key you
passPhrase
specified requires a passphrase.

Private Key The location of the private key file of the specified SFTP user
Location if you are using public key authentication. Integration Server
populates this field with the private key file of the source
privateKeyFile
Integration Server. You can change the value of this field to
Location
specify a different private key file for deployment.

Maximum The number of times Integration Server aempts to connect to

Retries the SFTP server. The maximum allowed value is 6. The minimum
allowed value is 1. The default is 6 retries.
maximumRetries

Connection The amount of time (measured in seconds) Integration Server

Timeout waits for a response from the SFTP server before timing out and
terminating the request. The default is 0, which indicates that the
connection
session will never time out.
Timeout

Session The number of minutes you want Integration Server to wait

Timeout before terminating an idle session. The default is 10 minutes.
sessionTimeout

Proxy Alias Proxy alias through which the request is to be routed.

proxyAlias

Compression Specifies whether or not to compress the data to reduce the

amount of data that is transmied. Integration Server supports
compression
compression using the compression algorithm zlib.
zlib indicates that you want to compress the data that is
transmied between the SFTP server and Integration Server.

webMethods Deployer User’s Guide Version 9.6 276

 M  
Odd Header

none indicates that you do not want to compress the data.

Note: You can use compression only if the SFTP server that you are
connecting to supports compression.

Compression The compression level to use if you specified the compression

Level algorithm zlib for the Compression property. The minimum
allowed value is 1 (fast, less compression). The maximum
compression
allowed value is 6 (slow, most compression). The default is 6.
Level

SFTP Server The alias of the SFTP server to which you want the user specified
Alias using the User Name property to connect.
sftpServer
Alias

Truststore Alias

Asset Type ID istruststorealias

Substitution Values

Location Full path to the Integration Server’s client truststore file.

ksLocation

Password Password associated with this alias that is used to protect the
contents of the truststore.
ksPassword

Use Source Specifies whether the target Integration Server uses the truststore
Truststore file from the source Integration Server.
useSource True indicates that the target Integration Server uses the
Truststore truststore file from the source Integration Server. This is the
default.
False indicates that the target Integration Server will use a
different truststore file than the source Integration Server.

Note: This configuration value does not correspond to a field or

property in Integration Server.

webMethods Deployer User’s Guide Version 9.6 277

 M  
Even Header

Users

Asset Type ID isuser

Substitution Values

None.

Web Service Endpoint Alias

Asset Type ID iswebserviceendpointalias

Substitution Values

Transport Properties:

Host Name Host name or IP address of the server on which the web service
resides. (Provider and consumer web service endpoint alias
host
only.)

Port Number Active HTTP or HTTPS type listener port defined on the host
server or proxy server. (Provider and consumer web service
port
endpoint alias only.)

User Name User name used to authenticate the consumer at the HTTP
or HTTPS transport level on the host server. (Consumer and
transportUser
message addressing web service endpoint alias only.)

Password The password used to authenticate the consumer on the host

server. (Consumer and message addressing web service endpoint
transport
alias only.)
Password

Authentication The type of authentication to authenticate the consumer at the

Type HTTP or HTTPS transport level on the host server. (Consumer
and message addressing web service endpoint alias only.)
transportAuth
Type Basic indicates that basic authentication (user name and
password) is used to authenticate the consumer.
Digest indicates that password digest is used to authenticate the
consumer.

webMethods Deployer User’s Guide Version 9.6 278

 M  
Odd Header

Message Properties:

User Name The user name to include with the UsernameToken. (Consumer
web service endpoint alias only.)
messageUser

Password The password to include with the UsernameToken (must be

plain text). (Consumer web service endpoint alias only.)
message
Password

Partner's Path and file name of the file containing the provider's certificate.
Certificate (Consumer and message addressing web service endpoint alias
only)
partner
Certificate
FileName

Use Source Specifies whether the target Integration Server uses the partner
Partner's certificate file from the source.
Certificate
True indicates that the target server uses the partner certificate
useSource file from the source. During deployment, Deployer copies the
Partner partner’s certificate from the source machine to the location on
Certificate the destination machine specified in Partner’s Certificate. This is
the default value.
False indicates that the target server will use a different partner
certificate file than the source the source partner.

Note: This configuration value does not correspond to a field or

property in Integration Server.

Message Addressing Properties:

To Endpoint reference to which the SOAP message is sent.

(Consumer web service endpoint alias only.)
toMsgAddr

From Endpoint reference containing the source of the SOAP message.

(Consumer and message addressing web service endpoint aliases
fromMsgAddr
only.)

ReplyTo Endpoint reference containing the destination address of the

response (reply) message. (Consumer and message addressing
replyToMsgAddr
web service endpoint aliases only.)

webMethods Deployer User’s Guide Version 9.6 279

 M  
Even Header

FaultTo Endpoint reference containing the address to which the SOAP

fault messages are routed. (Consumer and message addressing
faultToMsgAddr
web service endpoint aliases only.)

Reliable Messaging Properties

Note: The reliable messaging properties apply only to consumer and provider web
service endpoint aliases of transport type HTTP and HTTPS.

Enable Whether Integration Server uses the reliable messaging

properties specific to the web service endpoint alias or the server-
enable
level reliable messaging properties that applies to all web service
endpoints in the server.
True specifies that Integration Server uses the reliable messaging
properties specific to the web service endpoint alias.
False specifies that Integration Server uses the server-level
reliable messaging properties.

Note: Rest of the reliable messaging properties specific to a web

service endpoint alias are the same as the server-level reliable
messaging properties. For more information about reliable
messaging properties, see Reliable Messaging Configuration under
" Integration Server Assets" on page 245.

Web Service Policy

Asset Type ID iswspolicy

Substitution Values

None.

Integration Server Administrative Asset Dependencies

The following table lists the dependent assets and the reference assets that you must
include in a deployment set before you can deploy the dependent asset:

Asset Dependencies

JDBC pool JDBC driver alias

alias

webMethods Deployer User’s Guide Version 9.6 280

 M  
Odd Header

Asset Dependencies

JDBC JDBC driver alias

functional
alias

Client User
certificate
Note: Default users (for example, Administrator) are not listed as
dependencies.

LDAP Group
configuration
Note: Default groups are not listed as dependencies.

Remote Keystore alias, ACL

server alias
Note: Default ACLs (for example, Anonymous) are not listed, and
the local remote server alias is not extracted.

SAML token Truststore alias

issuer

URL alias IS package

Web service Keystore alias, truststore alias, JMS trigger name (provider
endpoint JMS), proxy alias (consumer HTTP and HTTPS), keystore alias
alias (consumer HTTPS), JNDI alias (consumer JMS), JMS alias
(consumer JMS), web service endpoint alias (provider HTTP,
HTTPS, and JMS)

Integration Server Package Assets

This section describes the following:
Adding Package Assets to the Source Directory
Global Values for Integration Server Package Assets and Composites
Individual Values for Integration Server Package Assets

About Integration Server Packages

Integration Server packages can be deployed as either composites or assets with a type
ID of ispackage.

webMethods Deployer User’s Guide Version 9.6 281

 M  
Even Header

Adding Package Assets to the Source Directory

To include package assets in the composite for deployment, you must manually copy or
check in the Integration Server_directory\instances\instance_name \packages folder to the
source directory. There are two ways to add package assets to the source directory:
Build package composites along with other administrative assets. If you want to
generate composites for all packages in the source directory and package-specific
administrative assets, Software AG recommends that you structure the source
directory as either:

Or:

Note: In order to retain ACL information for the package assets, you must add ACL
configuration files to the config folder.

In the above example, you would define SRC_ROOT as the value of the
build.source.dir property in the build.properties file. For more information about the
build.properties file, see "Seing Build Properties" on page 34.
When run, the build script creates the following:
A composite named package_name .zip for each package included in the source
directory, where package_name is the name of the package (with a composite type
ID of ispackage). For this example, the files would be named packageA.zip and
packageB.zip.
A composite named isconfiguration.zip (with a composite type ID of
isconfiguration) that contains the administrative assets contained in the config
directory.
Build package composites separate from other administrative assets. If your source
directory contains several packages and you want to generate composites from only
a select number of those packages, you can use the build.source.project.dir property

webMethods Deployer User’s Guide Version 9.6 282

 M  
Odd Header

to specify only those packages you want to include. For example, in the following
source directory there are three packages: packageA, packageB, and packageC:

You can generate a composite that contains only packageA and packageB by seing
the value of the build.source.project.dir property to:
SRC_ROOT/packageA;SRC_ROOT/packageB

In this example, since the config directory is not located in SRC_ROOT, you must
specify the location of config directory in the is.acdl.config.dir property of the
build.properties file.
When run, the build script creates a composite named package_name .zip for each
package defined for build.source.project.dir, where package_name is the name of the
package (with a composite type ID of ispackage).
Using the above example, build.source.project.dir is set to “SRC_ROOT/
packageA;SRC_ROOT/packageB”. When the build script runs, it will generate
composites for packageA and packageB. Since packageC is not defined for
build.source.project.dir, the build script ignores it. Since the packages are named
“packageA” and “packageB” in the source directory, the build script names the
composites packageA.zip and packageB.zip.
For more information about seing properties in the build.properties file, see
"Seing Build Properties" on page 34. For more information about building
composites for repository-based deployment, see "Building Composites for
Repository-Based Deployment" on page 31.

Global Values for Integration Server Package Assets and Composites

The following table lists the global values you can export for Integration Server
packages.

Value Description

Activate Specifies whether you want the Integration Server to activate the
Package on package immediately upon installation.
Install
True indicates that you want the server to activate the package
(activatePkgOn after it is installed.
Install)
False indicates that you do not want the server to activate the
package after it is installed.
The default value is True.

webMethods Deployer User’s Guide Version 9.6 283

 M  
Even Header

Value Description

Archive Specifies whether you want Integration Server to archive the

Package on package automatically after installation.
Install
True indicates that you want the server to archive the package
(archivePkgOn automatically after it is installed.
Install)
False indicates that you do not want the server to archive the
package after it is installed.
The default value is True.

Compile Specifies whether you want Integration Server to compile the

Package package automatically after installation.
on Install
True indicates that you want the server to compile the package
(compilePackage)
automatically after it is installed.
False indicates that you do not want the server to compile the
package after it is installed.
The default value is True.

Disallow Active Specifies whether you want to prevent deployment if the

Package Install package being deployed is in an active state on the target
Integration Server.
(disallowActive
PackageInstall) True indicates that you want to prevent the server from
continuing deployment when the package being deployed is in
an active state on the target Integration Server.
False indicates that you want the server to continue
deployment regardless of whether the package is active on the
target Integration Server.
The default value is False.

Package Specifies the length of time (in milliseconds) Deployer should

Execution wait if a service contained in the package being deployed is
Check being executed on the target Integration Server. If this time
expires and a service is still being executed, Deployer terminates
(package
the deployment job. The default value for this parameter is 0,
ExecutionCheck)
which disables this feature.

Note: In some cases, this parameter can override

disallowActivePackageInstall. For example, if
disallowActivePackageInstall is set to False and
packageExecutionCheck is set to a value other than 0, Integration
Server can terminate the deployment job even though

webMethods Deployer User’s Guide Version 9.6 284

 M  
Odd Header

Value Description
disallowActivePackageInstall would otherwise allow
deployment to succeed.

Suspend Specifies whether you want Integration Server to suspend

Triggers During existing triggers before updating them with the deployment.
Deployment
True indicates that you want the server to suspend existing
(suspend triggers before deployment.
TriggersDuring
False indicates that you do not want the server to suspend the
Deploy)
triggers.
The default value is False.

Synchronize Specifies whether Integration Server should synchronize

Document the publishable document types in the source package with
Types To document types on the Brokers that are connected to the target
Broker During Integration Server.
Deployment
True indicates that you want Integration Server to synchronize
(syncDocTypesTo publishable document types in the target server with the
Broker) connected Brokers during deployment.
False indicates that you do not want Integration Server to
synchronize publishable document types in the target server
with the connected Brokers during deployment.
The default value is True.

Note: The target Integration Server must be connected to a Broker

at deployment time for synchronization to occur. If the connected
Broker is not available, publishable 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.

Clear Specifies whether to reset ACLs on the assets during

ACLs after deployment.
deployment(clearACL)
True indicates that Integration Server will remove any ACLs
that are set for the assets.
False (the default) indicates that Integration Server should not
remove any existing ACLs for the assets.

webMethods Deployer User’s Guide Version 9.6 285

 M  
Even Header

Individual Values for Integration Server Package Assets

Integration Server supports the following Integration Server package assets for
deployment on a project-by-project basis. The values presented in the table are deployed
as assets within the ispackage composite. None of the assets support substitutions.

Asset Asset Type ID Notes

BlazeRule blazeruleservice, Blaze rules consist of an Integration Server

services isfile Java service and two files in the config
directory. Integration Server handles the
Integration Server Java service as a normal
Integration Server Java service, and handles
the configuration files as package files.
The Integration Server service does not
state a dependency on the config files, so
assets that depend on a Blaze rule service
will need to have dependencies on both
the Integration Server service and the
configuration files.

webMethods istrigger None.

messaging
triggers

C services iscservice None.

Document isdocumenype None.

types

E-forms isdocumenype, E-forms consist of an IS document and

isfile a configuration file. The IS document is
handled as a normal IS document asset.
Integration Server handles the configuration
file as a package file. The IS document
does not state a dependency on the config
files (they are not associated in Integration
Server), so assets that depend on an e-form
will need to have dependencies on both the
IS document and the configuration file.

Flat file ffdictionary None.

dictionaries

webMethods Deployer User’s Guide Version 9.6 286

 M  
Odd Header

Asset Asset Type ID Notes

Flat file ffschema None.

schemas

Flow isflowservice None.

services

IS schemas isschema None.

Java services isjavaservice None.

JMS triggers isjmstrigger None.

Mobile mobileAppSeing Ensure that the mobile sync components

applications associated with the mobile applications are
used by present on the target server.
webMethods
Mobile
Support

Mobile sync MSCConfigSeing Ensure that the business document type and
components the download and upload services specified
for Mobile for the mobile sync components are present
Support on the target server.

Package files isfile None.

Package isfolder None.

folders

PRT isfile Handled as a package file.

fragments

Specifications isspecification None.

URL aliases isurlalias The URL Alias asset refers to the URL
aliases created for the server or a package.
The URL Alias asset does not refer to the
URL aliases created for services in Designer
or Developer. URL aliases for services are
deployed along with the service when a
package is deployed.

webMethods Deployer User’s Guide Version 9.6 287

 M  
Even Header

Asset Asset Type ID Notes

The URL aliases for a server are deployed to

the WmRoot package.

Web service iswsconnector None.

connectors

Web service iswsdconsumer None.

descriptor
consumers

Web service iswsdprovider None.

descriptor
providers

XSLT isxsltservice None.

services

Adapter Runtime and .NET Service Assets

This section describes the adapter runtime (ART) assets and the .NET asset that
Integration Server supports for exporting, and their dependencies.

Adding Adapter Runtime and .NET Service Assets to the Source Directory
To include adapter runtime and .NET service assets in the composite for deployment,
you must manually copy or check in the Integration Server_directory\instances
\instance_name \packages folder to the source directory.
The build script creates a composite named package_name .zip, where package_name is
the name of the package. For example, if the package name is “adapter_service”, the
composite name is adapter_service.zip. For more information about building composites
for repository-based deployment, see "Building Composites for Repository-Based
Deployment" on page 31.

Adapter Runtime Assets

The following table lists the adapter runtime assets and values for all WmART based
adapters that you export and deploy using Integration Server:

Asset Asset Type ID Substitution Values

Adapter artconnection A list of connection properties based on

connections the adapter. The connection properties are

webMethods Deployer User’s Guide Version 9.6 288

 M  
Odd Header

Asset Asset Type ID Substitution Values

a dynamic set and depend on the adapter
implementation.

Important: Before you deploy an adapter

connection, you must set the password for
the connection. For more information, see the
installation and user’s guide for that adapter.

State After Deployment (art.deployment.state).

The state of the asset after deployment. Valid
values:
disable indicates that the asset will be in a
disabled state after deployment.
enable indicates that the asset will be in an
enabled state after deployment. Any value
other than enable sets the state to disable.
The default is disable.

Adapter artservice None.

services

Adapter artlistener Retry Limit (retryLimit). The number of times

listeners that the system aempts to start the listener
if the initial aempt fails. In particular, this
field specifies how many times to retry the
listenerStartup method before issuing an
adapter connection exception. The default is
5. A value of 0 indicates that the system will
make a single aempt.

Retry Backoff Timeout (retryBackoffTimeout).

The number of seconds the system waits
between each aempt to start the listener. The
default is 10. The value of this field is ignored
if Retry Limit is set to 0.

State After Deployment (art.deployment.state).

The state of the asset after deployment. Valid
values:
disable indicates that the asset will be in a
disabled state after deployment.

webMethods Deployer User’s Guide Version 9.6 289

 M  
Even Header

Asset Asset Type ID Substitution Values

enable indicates that the asset will be in an

enabled state after deployment. Any value
other than enable sets the state to disable.
The default is disable.

Adapter artlistener State After Deployment (art.deployment.state).

listener noification The state of the asset after deployment. Valid
notifications values:
disable indicates that the asset will be in a
disabled state after deployment.
enable indicates that the asset will be in an
enabled state after deployment. Any value
other than enable sets the state to disable.
The default is disable.

Adapter artpolling Interval (notificationInterval). The time of

polling notification the polling interval in seconds.
notifications
Overlap (notificationOverlap). The time the
scheduled interval time you set in the Interval
field will begin.
True indicates that the next execution of a
scheduled notification does not wait for the
current execution to end and they overlap.
False indicates that the executions of a
scheduled notification do not overlap.

Immediate (notificationImmediate). Whether

to enable or disable polling immediately.
True enables polling immediately.
False disables polling immediately.

State After Deployment (art.deployment.state).

The state of the asset after deployment.
disable indicates that the asset will be in a
disabled state after deployment.
enable indicates that the asset will be in an
enabled state after deployment. Any value
other than enable sets the state to disable.

webMethods Deployer User’s Guide Version 9.6 290

 M  
Odd Header

Asset Asset Type ID Substitution Values

The default is disable.

Adapter Runtime Asset Dependencies

The following table lists the dependent assets and the reference assets that you must
include in a deployment set before you can deploy the dependent asset:

Asset Dependency

Adapter None
Connections

Adapter Adapter Connection

Services

Adapter Adapter Connection

Listeners

Adapter Adapter Connection, IS Document Type

Polling
Notifications

Adapter Adapter Listener, IS Document Type

Listener
Notifications

.NET Asset
The following table lists the .NET asset that you export and deploy using Integration
Server and its values:

Note: The .NET service asset is not a dependent asset. However, ensure that the values
in the Assembly Path and Assembly Name fields that you provide for the target Integration
Server during variable substitution are valid.

Asset Asset Type ID Substitution Values

.NET dotnetservice Assembly Path

Services (assemblyPath). The location
of the directory that holds
the .NET assembly in

webMethods Deployer User’s Guide Version 9.6 291

 M  
Even Header

Asset Asset Type ID Substitution Values

which the method called by
the .NET services resides.

Assembly Name
(assemblyName). The name
of the .NET assembly in
which the method called by
the .NET services resides.

My webMethods Server Assets

This section lists the My webMethods Server (including Task Engine) asset types and
their dependencies.
The following table lists the dependencies and properties that you can substitute when
using Deployer to deploy assets to a My webMethods Server.

Asset Asset Type ID Dependencies, Substitution Values, and Other

Considerations

Access AccessPrivilege The rights of a user, group, or role to view

privilege applications and features in the Navigation
panel and to access pages associated with
them. See Functional privileges.
Dependencies: The user, group, or role
specified by the access privilege.

Business Calendar A global calendar used in My webMethods

calendar Server (for example, a US holidays calendar).

CAF CAFApp A Composite Application Framework

application application.
Substitution variables: Any env-properties
or configuration properties from the
application’s web.xml file (for example,
properties dynamically added when you
create a web connector for your portlet).

CAF runtime RuntimeConfig The runtime configuration for a Composite

configuration Application Framework application, as
modified in the CAF Runtime Administration
page.

webMethods Deployer User’s Guide Version 9.6 292

 M  
Odd Header

Asset Asset Type ID Dependencies, Substitution Values, and Other

Considerations

Substitution variables: Any env-properties

or configuration properties from the
application’s web.xml file (for example,
properties dynamically added when you
create a web connector for your portlet).

Certificate Certificate A digital certificate associated with an My

webMethods Server user.

Component Component A legacy portlet or Dynamic Business Object

(DBO).
Dependencies: Any portlets or DBOs
referenced by the xmlImport.xml file of the
Component.

Data source Datasource An external data source configuration (for

example, a connection to an external Oracle
database).
Substitution variables: The user name,
password, and URL for the data source.

Data-level DLSSecurity Field (or record) read, write, or delete

security security permissions to a resource used
by Monitoring portlets to control access
processes, documents, and KPIs.
Dependencies: The role associated with the
data-level security.

Directory Directory Configuration of LDAP or Database directory

service service from My webMethods Server.
Dependencies:
LDAP directory service - None
Database directory service - Data Source
Substitution variables: The user name,
password, and LDAP URL for the LDAP
directory service only. There are no
substitution variables for the database
directory service.

webMethods Deployer User’s Guide Version 9.6 293

 M  
Even Header

Asset Asset Type ID Dependencies, Substitution Values, and Other

Considerations

Functional FuncPrivilege The rights of a user, group, or role to make

privilege changes within an application or feature,
such as to create and modify a workspace.
You can export all of the functional privileges
associated with a specific user, group, or role.
See Access Privileges.
Dependencies: Users, groups, or roles to which
functional privileges are granted.

Group Group A collection of users and other groups.

Groups are defined and stored in an internal
system or external directory service.
Dependencies: The external directory service
where the groups are defined. Only groups
from internal "System" directory service
can be deployed. Groups from LDAP and
Database directory come implicitly from the
directory itself.

Locale rule Rule.locale A rule configuration that defines the locale

(language and country code) to use when
locale information is not specified in the user
profile.
Dependencies: Any users, groups, or roles
referenced by the rule logic.

Login page Rule.login A login page rule configuration that defines

rule the login page to be used.
Dependencies: Any users, groups, or roles
referenced by the rule logic of the login page
that is the target of the rule.

Page/Folder Folder The layout and content of a folder or page.

Dependencies: The users, groups, and roles
referenced in the folder access control.
In addition, folders and pages have a
dependency on the portlets and Composite
Application Framework applications included
in the page.

webMethods Deployer User’s Guide Version 9.6 294

 M  
Odd Header

Asset Asset Type ID Dependencies, Substitution Values, and Other

Considerations

Portlet Portlet A portlet is a mini-application or a piece of

functionality that can be part of a Composite
Application Framework application or can
reside independently on a page on the server.

Rendering Rule.render The user interface formaing capabilities

rule assigned to specific server objects by defining
rendering rules. Renderer rules determine the
specific renderer to use.

Role Role A collection of users assigned to a specific role

defined for any directory service.
Dependencies: Users, groups, or roles
contained within the role.

Saved search Search A saved query associated with a particular

search page within My webMethods Server
(for example, Task List Management or My
Inbox). A Saved Search asset includes all
saved searches for a particular search page
(not individual searches).

Security realm Realm A way to apply an access control list to a list

of objects. You can organize Security Realms
into containers.
Dependencies: Users, groups, or roles, and the
pages and folders controlled by the security
realm.

Shell Shell An installable component used to display the

header, footer, and title bars for pages.
Dependencies: Any custom portlets referenced
by the shell section pages.

Shell rule Rule.shell A rule configuration that determines what

shell should be displayed for each page.
Dependencies: Any users, groups, or roles
referenced by the rule logic of the shell that is
the target of the shell rule.

webMethods Deployer User’s Guide Version 9.6 295

 M  
Even Header

Asset Asset Type ID Dependencies, Substitution Values, and Other

Considerations

Skin Skin An installable component that defines the

look and feel of the rendered page. A skin
modifies the images, fonts, colors, and other
subtle style aspects of HTML content, without
functionally modifying the HTML content.

Skin rule Rule.skin A rule configuration that determines what

skin should be displayed.
Dependencies: Any users, groups, or roles
referenced by the rule logic of the skin that is
the target of the skin rule.

Start page Rule.startpage A rule that determines which page is

rule displayed after a user logs into the server.
Dependencies: Any users, groups, or roles
referenced by the rule logic of the page or
folder that is the target of the rule.

Task Task Represents human activity for a BPM

ProcessModel. Tasks are composed of Task
Rules and portlets that implement UIs of the
task.
Dependencies:
Task Rule
Portlets
Business Rules (for assignments)

Task rule Rule.task A rule within a task type to specify task

assignments and behaviors.
Dependencies: Any users, groups, or roles
referenced by the rule logic.

User User An individual listed in the internal “system”

directory service and all profile and
preference aributes.

webMethods Deployer User’s Guide Version 9.6 296

 M  
Odd Header

Optimize Assets
webMethods Optimize enables you to export assets such as dimensions, event
maps, dimension hierarchies, data filters, process configurations, intelligent links, or
rules to Deployer. Using Deployer, you can deploy your Optimize assets to another
Optimize Analytic Engine and share the assets that you created in Optimize with other
applications.
This section lists the following:
Asset types that Optimize supports for exporting
Asset dependencies

Asset Asset Type ID Dependencies

Custom trees OptimizeCustomTree KPIs, Process models

Data filters OptimizeDataFilter Dimensions

Dimensions OptimizeDimension Intelligent links

Dimension OptimizeHierarchy Dimensions

hierarchies

Event maps OptimizeEventMap Dimensions, Intelligent links

Intelligent OptimizeILink None

links

KPIs OptimizeKpi Dimension hierarchies, event maps

Note: You cannot deploy individual KPIs.

Instead, Deployer deploys all KPIs for a
selected event map.

Process OptimizeProcessConfig Process models

configurations

Rules OptimizeRule Event maps, Data filters, KPIs

webMethods Deployer User’s Guide Version 9.6 297

 M  
Even Header

Trading Networks Assets

This section lists the following:
Trading Networks asset types you can deploy
Asset dependencies

Asset Asset Type ID Dependencies

Archive archiveschedule Partner profiles, BizDocType

schedules

Binary types binarytype None

Contact types contacype None

Data dls Partner profiles, Document types,

permissions Processing rules, My webMethods roles
(DLSs)

Document documentaribute None

aributes

Document documenype Document aributes, ESB services

types

External ID externalidtype None

types

Field fielddefinition Field groups

definitions

Field groups fieldgroup None

General functionalpermission My webMethods roles

functional
permissions

Partner partner Contact types, External ID types, Profile

profiles groups, Field definitions, ESB services

webMethods Deployer User’s Guide Version 9.6 298

 M  
Odd Header

Asset Asset Type ID Dependencies

Processing processingrule ESB services, Partner profiles,

rules Document aributes, Document types,
Profile groups

Profile groups profilegroup None

Queues queue ESB services

Trading tpa Partner profiles, IS document types, ESB

partner services
agreements
(TPAs)

Universal Messaging Assets

There are some assets which can be modified if they already exists and some which
cannot. User will then have to use the Deployer's deletion set feature to delete the asset if
it already exists before deploy operation.
This section lists the following:
Universal Messaging assets you can deploy
Dependencies and substitution variables (if applicable) of each asset
Considerations when deploying Universal Messaging.

Asset Asset Type ID Dependencies, Substitution Values, and Other

Considerations

Realm ACLs RealmAcl Realm ACL assets can consist of either

ACLs in user @host format or groups that
contain sets of ACLs.
Deployer always replaces target assets.
Dependencies: Security groups

Security RealmSecurityGroup If a security group asset of the same

groups name exists on the target server, you
must delete the security group from the
target server before deploying. For more
information about deleting assets from

webMethods Deployer User’s Guide Version 9.6 299

 M  
Even Header

Asset Asset Type ID Dependencies, Substitution Values, and Other

Considerations
target servers, see "Defining a Deletion
Set" on page 125.

Realm RealmSchedule If a realm schedule asset of the same

schedules name exists on the target server, you
must delete the realm schedule from the
target server before deploying. For more
information about deleting assets from
target servers, see "Defining a Deletion
Set" on page 125.

Realm RealmConfig Deployer always replaces target assets.

configurations

Channels Channel If the asset exists on the target server,

only the ACL can be modified during
deployment. If you want to modify
additional properties, you must delete
the channel asset on the target server
before deploying. For more information
about deleting assets from target servers,
see "Defining a Deletion Set" on page
125.

Channel joins ChannelJoin Deployer always replaces target assets.

Dependencies: Source channel and target
queue/target channel

Queues UMQueue If the asset exists on the target server,

only the ACL can be modified during
deployment. If you want to modify
additional properties, you must delete
the queue asset on the target server
before deploying. For more information
about deleting assets from target servers,
see "Defining a Deletion Set" on page
125.

Interfaces Interface The interface asset can contain four

types of interfaces: nsp, nsps, nhp, and
nhps. For all of the interfaces, Deployer
will modify the VIA list on the target
server. The nhp and nhps interfaces

webMethods Deployer User’s Guide Version 9.6 300

 M  
Odd Header

Asset Asset Type ID Dependencies, Substitution Values, and Other

Considerations
can contain plugins, which can also be
modified.
If an interface asset of the same name
exists on the target server, you must
delete the interface from the target
server before deploying. For more
information about deleting assets from
target servers, see "Defining a Deletion
Set" on page 125.
Substitution values: Available for nsps and
nhps interfaces only:
Keystore
Keystore Password
Truststore
Truststore Password
Private Key Password

Data groups DataGroup Deployer modifies publishers and

nested groups on the target server.
If a data group asset of the same name
exists on the target server, you must
delete the data group from the target
server before deploying. For more
information about deleting assets from
target servers, see "Defining a Deletion
Set" on page 125.
Dependencies: Nested groups

Clusters Cluster Deployer always replaces target assets.

Other Assets
The following table describes additional user-created assets that you can include in
deployment projects. It includes:
Assets you can deploy
Asset dependencies

webMethods Deployer User’s Guide Version 9.6 301

 M  
Even Header

Asset Asset Type ID Dependencies

BAM process bamprocess None.

models

webMethods Deployer User’s Guide Version 9.6 302