webMethods Deployer

Installation and User’s Guide

VERSION 6.1

webMethods, Inc.
3930 Pender Drive
Fairfax, VA 22030
USA
703.460.2500
http://www.webmethods.com
webMethods Administrator, webMethods Broker, webMethods Developer, webMethods Installer, webMethods Integration Server, webMethods Mainframe,
webMethods Manager, webMethods Modeler, webMethods Monitor, webMethods Workflow, webMethods Trading Networks, and the webMethods logo are
trademarks of webMethods, Inc. “webMethods” is a registered trademark of webMethods, Inc.
Acrobat, Adobe, and Reader are registered trademarks of Adobe Systems Incorporated. Amdocs and ClarifyCRM are registered trademarks of Amdocs Ltd.
Ariba is a registered trademark of Ariba Inc. Baan is a registered trademark of Baan Development NV. BEA is a registered trademark, and WebLogic Platform
and WebLogic Server are trademarks of BEA Systems, Inc. BMC Software and PATROL are registered trademarks of BMC Software, Inc. BroadVision is a
registered trademark of BroadVision, Inc. Chem eStandards and CIDX are trademarks of Chemical Industry Data Exchange. Unicenter is a registered
trademark of Computer Associates International, Inc. Kenan and Arbor are registered trademarks of CSG Systems, Incorporated. SNAP-IX is a registered
trademark, and Data Connection is a trademark of Data Connection Ltd. DataDirect, DataDirect Connect, and SequeLink are registered trademarks of
DataDirect Technologies. D&B and D-U-N-S are registered trademarks of D&B, Inc. Entrust is a registered trademark of Entrust. Hewlett-Packard, HP, HP-
UX, and OpenView are trademarks of Hewlett-Packard Company. i2 is a registered trademark of i2 Technologies, Inc. AIX, AS/400, CICS, DB2, IBM, Infoprint,
Informix, MQSeries, OS/390, OS/400, RACF, RS/6000, SQL/400, S/390, System/390, VTAM, and WebSphere are registered trademarks; and Communications
System for Windows NT, IMS, MVS, SQL/DS, Universal Database, and z/OS are trademarks of IBM Corporation. JBoss and JBoss Group are trademarks of
Marc Fleury under operation by JBoss Group, LLC. J.D. Edwards and OneWorld are registered trademarks, and WorldSoftware is a trademark of J.D.
Edwards. Linux is a registered trademark of Linus Torvalds and others. X Window System is a trademark of Massachusetts Institute of Technology. Merant is
a registered trademark of Merant, Inc. MetaSolv is a registered trademark of Metasolv Software, Inc. ActiveX, Microsoft, Outlook, Visual Basic, Windows, and
Windows NT are registered trademarks; and SQL Server is a trademark of Microsoft Corporation. Netscape is a registered trademark of Netscape
Communications Corporation. New Atlanta and ServletExec are trademarks of New Atlanta Communications, LLC. CORBA is a registered trademark of
Object Management Group, Inc. UNIX is a registered trademark of Open Group. Oracle is a registered trademark of Oracle Corporation. PeopleSoft and
Vantive are registered trademarks, and PeopleSoft Pure Internet Architecture is a trademark of PeopleSoft, Inc. Infranet and Portal are trademarks of Portal
Software, Inc. RosettaNet is a trademark of “RosettaNet,” a non-profit organization. SAP and R/3 are trademarks or registered trademarks of SAP AG. Siebel
is a trademark of Siebel Systems, Inc. EJB, Enterprise JavaBeans, Java, Java Naming and Directory Interface, JavaServer Pages, JDBC, JSP, J2EE, Solaris,
SPARC, SPARCStation, Sun, Sun Microsystems, and SunSoft are trademarks of Sun Microsystems, Inc. SWIFT and SWIFTNet are trademarks of S.W.I.F.T.
SCRL. Sybase is a registered trademark of Sybase, Inc. UCCnet is a trademark of UCCnet. Verisign is a registered trademark of Verisign. VERITAS, VERITAS
SOFTWARE, and VERITAS Cluster Server are trademarks of VERITAS Software. W3C is a registered trademark of World Wide Web Consortium.
All other marks are the property of their respective owners.

Copyright © 2004 by webMethods, Inc. All rights reserved, including the right of reproduction in whole or in part in any form.

Document ID: DEP-IUG-61-20040322

 Contents

Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 1. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Deployment Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Create the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Define the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Build the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Map the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Deploy the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 2. Installing the Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Implementation and Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Supported Platforms and Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Required webMethods Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Install the Deployer and the Resource Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Uninstall the Deployer and the Resource Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Chapter 3. Get Started with the Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Start the Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Create the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Set the Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Authorize Groups to Perform Tasks on a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Add and View Instructions or Notes About a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Chapter 4. Defining a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Identify Source Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Create a Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Add Administration Items to the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Add Packages to the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Add an Entire Package to the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Add Package Components to the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

webMethods Deployer Installation and User’s Guide Version 6.1 3

Contents

Add Package Files to the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Set the Package Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Add Trading Networks Items to the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Resolve Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Chapter 5. Building a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Create a Project Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Create a Build Using the Deployer Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Create a Build Using a Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Rebuild a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Export and Import a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Export and Import a Build Using the Deployer Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Export and Import a Build Using Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Chapter 6. Mapping a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Identify Target Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Map the Project to the Target Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Change Configuration Parameters for Deployed Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Chapter 7. Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Deploy Using the Deployer Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Deploy Using a Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

4 webMethods Deployer Installation and User’s Guide Version 6.1

 About This Guide

About This Guide

This guide explains how to use webMethods Deployer. The Deployer is a tool you use to
deploy items that reside on source Integration Servers to target Integration Servers.
Items you can deploy include the following:
Administration items, such as ports, users, ACLs, groups, and user-created scheduled
tasks
Entire packages, selected package files, or selected package components (for example,
document types, services, triggers, adapter notifications, flat file schemas, and
mainframe host pools)
Trading Networks items, such as processing rules, document types, agreements, and
partner data

Document Conventions

Convention Description
Bold Identifies elements on a screen.
Italic Identifies variable information that you must supply or
change based on your specific situation or environment.
Identifies terms the first time they are defined in text. Also
identifies service input and output variables.
Narrow font Identifies storage locations for services on the webMethods
Integration Server using the convention folder.subfolder:service.
Typewriter Identifies characters and values that you must type exactly or
font messages that the system displays on the console.
UPPERCASE Identifies keyboard keys. Keys that you must press
simultaneously are joined with the “+” symbol.
\ Directory paths use the “\” directory delimiter unless the
subject is UNIX-specific.
[] Optional keywords or values are enclosed in [ ]. Do not type
the [ ] symbols in your own code.

webMethods Deployer Installation and User’s Guide Version 6.1 5

About This Guide

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

6 webMethods Deployer Installation and User’s Guide Version 6.1

 CHAPTER 1
Concepts

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Deployment Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Create the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Define the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Build the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Map the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Deploy the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

webMethods Deployer Installation and User’s Guide Version 6.1 7

CHAPTER 1 Concepts

Overview
The webMethods Deployer is a tool you use to deploy items that reside on source
Integration Servers to target Integration Servers. Items you can deploy include the
following:
Administration items, such as ports, users, ACLs, groups, and user-created scheduled
tasks
Packages, including entire packages, selected package files, or selected package
components, where “components” are items such as document types, services,
triggers, adapter notifications, flat file schemas, and mainframe host pools
Trading Networks items, such as processing rules, document types, agreements, and
partner data

Deployment Steps
The deployment process requires these steps:
Create a deployment project by giving it a name, setting its properties, and authorizing
users to work on it
Define the project by identifying its contents (that is, administration items, packages,
and Trading Networks items)
Build the project

Map the contents of the project to target Integration Servers

Deploy the project

Create the Project

A deployment project identifies the items from source Integration Servers that you want to
deploy to target Integration Servers. To create a project, you give the project a name and
set its properties, then authorize users to perform project tasks. These tasks are defining,
building, mapping, and deploying the project. You authorize users to perform the tasks
by selecting a task and assigning Integration Server security groups to it.
When you create a project, the Deployer automatically creates an HTML home page for
the project. You can modify this page to contain instructions or notes about the project
that you want users to view. For example, you might want to list the target Integration
Servers for the users who will perform the mapping task, or you might want to provide
instructions for testing the deployed solution.

8 webMethods Deployer Installation and User’s Guide Version 6.1

 Define the Project

Define the Project

To define a project, you identify the source Integration Servers that contain the items you
want to deploy in that project, then create project deployment sets. Each deployment set
identifies items from source Integration Servers to deploy as a set to target Integration
Servers. For example, if you wanted to deploy the same administration items to two target
Integration Servers, you could define one deployment set that identifies those items. If
you also wanted to deploy packages on the same two target Integration Servers, you could
include them with the administration items in the same deployment set.

project

define one deployment set to deploy to one set of Integration Servers

If you wanted to deploy the administration items and the packages to different target
Integration Servers, you would have to define two different deployment sets, one that
identifies the administration items and one that identifies the packages.

project
to deploy to two sets of Integration Servers
define two deployment sets

The Deployer stores each project definition as an XML file that contains pointers to the
items in the project’s deployment sets.

webMethods Deployer Installation and User’s Guide Version 6.1 9

CHAPTER 1 Concepts

Build the Project

You build a project to transform a project definition from a file that contains pointers to
the items in the project’s deployment sets into a file that contains the actual items
themselves. A build is a snapshot of a project definition at a particular point in time; you
can make a build, change the project definition, make another build, and so on.
If you define and test deployment projects in a development environment, when you are
ready to actually deploy the projects in your production environment, you will have to
move the appropriate project builds to your production environment. You do this by
exporting the builds from the development Deployer, copying them to the production
environment, and importing them into the production Deployer. You then map and
deploy the builds from the production Deployer.
You can build projects using the Deployer interface or using a command you enter on the
command line.

Map the Project

You map a project to identify the target Integration Servers for each deployment set in a
particular build of a project. You can create any number of deployment maps for each
project build.
As part of the mapping task, you can tell the Deployer to change configuration parameters
for project items so the items will run properly on target Integration Servers. Suppose a
development Integration Server has a file polling port configured to monitor the
C:\TEMP directory. You want to deploy this port to a production Integration Server on a
Solaris system and have the port poll the /tmp directory instead. You would change the
port's configuration parameters so that the port will poll the /tmp directory.
You can change configuration parameters for ports, scheduled tasks, adapter connections,
and adapter notifications. You can specify different configuration parameters for different
target Integration Servers.

Deploy the Project

To deploy a project, you first create a deployment candidate, which is the combination of a
project build and a deployment map. You then generate a pre-deployment report that
scans the source and target Integration Servers and alerts you to any problems before you
deploy. You then address any problems and deploy the project. The Deployer creates a
deployment report that informs you of all actions that occurred during deployment.
You can deploy from the Deployer interface or you can deploy using a command you
enter on the command line. The Deployer copies the contents of each deployment set in
the specified project build to the target Integration Servers identified in the specified
deployment map. If you specified changes to configuration parameters for certain

10 webMethods Deployer Installation and User’s Guide Version 6.1

 Deploy the Project

deployed items on target Integration Servers, the Deployer changes those parameters
during deployment. If you deploy Trading Networks items, the Deployer updates the
Trading Networks database that is connected to the target Integration Server.

webMethods Deployer Installation and User’s Guide Version 6.1 11

CHAPTER 1 Concepts

12 webMethods Deployer Installation and User’s Guide Version 6.1

 CHAPTER 2
Installing the Deployer

Implementation and Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Install the Deployer and the Resource Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Uninstall the Deployer and the Resource Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

webMethods Deployer Installation and User’s Guide Version 6.1 13

CHAPTER 2 Installing the Deployer

Implementation and Dependencies

The Deployer installation consists of two pieces, the Deployer and a resource package.
You install the Deployer on a central Integration Server that has access to the following:
The source Integration Servers that contain the administration items, packages, and
Trading Networks items to deploy
The target Integration Servers to which the items will be deployed
You install the resource package on each of the source Integration Servers, so the Deployer
can extract items from them.
If you define and test deployment projects in a development environment, when you are
ready to actually deploy the projects in your production environment, you will have to
move the appropriate project builds to your production environment. You do this by
exporting the builds from the development Deployer, copying them to the production
environment, importing them into the production Deployer. You then map and deploy
the builds from the production Deployer. If you have a development environment and a
production environment, then, you must install the Deployer and the resource package on
the appropriate machines in each environment.

Requirements

Supported Platforms and Operating Systems

The Deployer supports the same platforms as Integration Server and uses the JRE you
install for Integration Server.

Required webMethods Components

You install the Deployer on a 6.0.1 or 6.1 Integration Server.

Hardware Requirements
The Deployer requires 20MB of hard drive space. The Deployer also requires hard drive
space for the projects you create. The amount of space you allocate should allow for the
number of projects to increase over time.
For RAM, virtual/swap, and CPUs, the Deployer requires nothing beyond its host
Integration Server.

14 webMethods Deployer Installation and User’s Guide Version 6.1

 Install the Deployer and the Resource Packages

Install the Deployer and the Resource Packages

Important! This section provides only instructions that are specific to installing the
Deployer installation. For complete instructions on using the webMethods Installer, and
on installing other webMethods components such as Integration Server, see the
webMethods Integration Platform Installation Guide.

To install the Deployer:

1 If you are installing the Deployer on an existing Integration Server, shut down the
Integration Server.
2 Download webMethods Installer 6.1 from the webMethods Advantage Web site at
http://advantage.webmethods.com and start the installer.
3 Specify the installation directory as the webMethods 6.0.1 or 6.1 installation directory
(by default, webMethods6).
4 In the component selection list, navigate to Administration > webMethods Deployer.
Choose to install the Deployer Program Files. The installer automatically installs the
Deployer in the Integration Server installation directory and activates the Deployer
package.
5 Start the host Integration Server.

To install the resource packages:

1 Open the Integration Server Administrator for the Integration Server that hosts the
Deployer. In Integration Server Administrator, define the source Integration Servers
as remote servers. If you will use the host Integration Server as a source, define it as a
remote server to itself. For instructions on defining remote servers, see the webMethods
Integration Server Administrator’s Guide.
2 Type this URL in the browser:
http://Integration Server_host:Integration Server_port/WmDeployer

3 Go to the Tools > Servers page. The page lists all Integration Servers that are defined as
remote servers on the host Integration Server.
4 In the Install column, select the check box next to each Integration Server you want to
use as a source.
5 Click Install. The Deployer installs the resource package on each of the selected
Integration Servers.

webMethods Deployer Installation and User’s Guide Version 6.1 15

CHAPTER 2 Installing the Deployer

Uninstall the Deployer and the Resource Packages

Important! This section provides only instructions that are specific to uninstalling the
Deployer installation. For complete instructions on using the webMethods Uninstaller, see
the webMethods Integration Platform Installation Guide.

To uninstall the Deployer:

1 Shut down the Integration Server on which you installed the Deployer.
2 Start the webMethods Uninstaller.
3 Select the Deployer as the program to uninstall.
The uninstaller removes all Deployer-related files that were installed into the
Integration Server_directory\packages\WmDeployer directory. The uninstaller does
not delete files created after you installed the Deployer (for example, user-created or
configuration files), nor does it delete the directory structure that contains the files.
4 If you do not want to save the files the uninstaller did not delete, navigate to the
Integration Server_directory\packages directory and delete the WmDeployer directory.
5 Restart Integration Server.

To uninstall the resource package:

1 In Integration Server Administrator, go to the Packages > Management page.

2 Delete the WmDeployerResource package.

16 webMethods Deployer Installation and User’s Guide Version 6.1

 CHAPTER 3
Get Started with the Deployer

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

Create the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Set the Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

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

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

webMethods Deployer Installation and User’s Guide Version 6.1 17

CHAPTER 3 Get Started with the Deployer

Start the Deployer

The Deployer starts automatically when you start the Integration Server on which the
Deployer is installed.
Open the Deployer interface by entering this URL in an Internet browser:
http://Integration Server_host:Integration Server_port/WmDeployer

If you just installed the Deployer, you can use the default values to log on. In the User Name
box, type Administrator. In the Password box, type manage.

Note: The Deployer and Integration Server Administrator use the same user name and
password.

To log out of the Deployer, click Log Off on the top right corner of any Deployer page.

Create the Project

You can create a project by creating a new project or by copying an existing project and
modifying it. In either case, you must set the project properties.

To create a new project:

1 On the Projects page, click Create Project.

2 In the Name and Description boxes, type the name to use for the project and a brief
description of the project. The name can be up to 32-characters long; the description
length has no limit. Both name and description can include any character that is valid
for a file name in your operating system.
3 Click Create.
4 Set the project properties using the instructions in “Set the Project Properties” on
page 19.

To copy an existing project:

1 On the Projects page, click Copy Project.

2 In the Project to Copy box, click the project to copy.
3 In the New Project Name box, type the name to use for the new project. The name can be
up to 32-characters long and can include any character that is valid for a file name in
your operating system.
4 Click Copy.
5 Set the project properties using the instructions in “Set the Project Properties” on
page 19.

18 webMethods Deployer Installation and User’s Guide Version 6.1

 Set the Project Properties

Set the Project Properties

The project properties apply to all items except packages. You specify package properties
for each package individually, as described in “Set the Package Properties” on page 29.

To set the project properties:

1 Under the Suspend During Deployment area, indicate whether the Deployer should
suspend trigger, port, and scheduled task activity while deployment is going on.

If you choose
to suspend... The Deployer does this...
Triggers Allows all running trigger operations to complete, then suspends
all trigger execution and document retrieval on the target
Integration Servers.
Ports Disables ports on the target Integration Servers that match ports
you are trying to deploy.
Scheduled Prevents scheduled tasks on the target Integration Servers that
tasks match scheduled tasks you are trying to deploy from running.
(Tasks that are already running at deployment time are not
affected by deployment.)

Typically, if the targets are production Integration Servers, you would suspend all
three types of items.
2 Under the Overwrite Existing area, indicate how the Deployer should proceed when it
finds that items you are trying to deploy already exist on target Integration Servers.

For this
option... Indicate whether the Deployer should...
TN Rules Overwrite existing Trading Networks rules or append the rules
you are trying to deploy to the ones that already exist.
ACL Maps Deploy the mapping of ACLs to services for any services you
choose to deploy. You would choose to deploy ACL maps if you
want to assign the same ACLs to the deployed services on the
target Integration Server that you assigned to the source services
on the source Integration Servers.
Other Items Overwrite existing items. This option applies to all items except
Trading Networks rules, ACL maps, and packages. You specify the
overwrite option for packages on a package-by-package basis, as
described in “Set the Package Properties” on page 29.

webMethods Deployer Installation and User’s Guide Version 6.1 19

CHAPTER 3 Get Started with the Deployer

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

3 Under Activate After Deployment, indicate whether the Deployer should activate newly
deployed ports and scheduled tasks on the target Integration Servers.

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

4 Click Save.

Authorize Groups to Perform Tasks on a Project

After you authorize certain Integration Server groups to perform tasks on projects, the
users in those groups will see only those projects to which they are authorized when the
users display the Projects page.

To authorize groups to perform tasks:

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

20 webMethods Deployer Installation and User’s Guide Version 6.1

 Add and View Instructions or Notes About a Project

Add and View Instructions or Notes About a Project

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

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

webMethods Deployer Installation and User’s Guide Version 6.1 21

CHAPTER 3 Get Started with the Deployer

22 webMethods Deployer Installation and User’s Guide Version 6.1

 CHAPTER 4
Defining a Project

Identify Source Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Create a Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

webMethods Deployer Installation and User’s Guide Version 6.1 23

CHAPTER 4 Defining a Project

Identify Source Integration Servers

To identify source Integration Servers:

1 In the Deployer, go to the Projects page.

2 In the Name column, click the name of the project you want to define.

3 In the right pane, click .

4 Click Source Servers. In the right pane, the Deployer lists all remote servers defined to
the Integration Server that hosts the Deployer.

Note: If Integration Servers you want to use as sources do not appear in the list, you
must define them as remote servers to the host Integration Server. This includes the
host Integration Server; if you want to use the host Integration Server as a source, you
must define it as a remote server to itself. For instructions, see the webMethods
Integration Server Administrator’s Guide.

5 In the Select column, select the check box next to each Integration Server that contains
items you want to add to the project.
6 Click Save.
7 Make sure every Integration Server you identified as a source is equipped with the
Deployer resource package. To do so, go to the Tools > Servers page and check whether
the Resource Package column displays the word Installed for those Integration Servers.
If the column does not show that word, you must install the resource package on the
Integration Servers. In the Install column, select the check box next to each Integration
Server you identified as a source, then click Install.

Create a Deployment Set

You can add administration items, packages, and Trading Networks items to a
deployment set. As you add items to a set, the Deployer might find that some items
require other items that you have not added to the deployment set, and you will have to
resolve these dependencies.

To create a deployment set:

1 On the Deployer Projects > project > Define page, click Create Deployment Set.
2 In the Name and Description boxes, type the name to use for the deployment set and a
brief description of the set. The name can be up to 32-characters long; the description
length has no limit. Both name and description can include any character that is valid
for a file name in your operating system.
3 Click Create.

24 webMethods Deployer Installation and User’s Guide Version 6.1

 Create a Deployment Set

Add Administration Items to the Deployment Set

To add administration items to the deployment set:

1 In the Deployment Sets area, under the deployment set to which to add administration
items, click the Administration folder. The Deployer lists all Integration Servers you
identified as source Integration Servers in the right pane.
2 In the right pane, open the tree to show the administration items on the source
Integration Servers.
3 Select the check box next to each item to add to the deployment set.

Important! If you add a scheduled task to the deployment set, the task requires the user
that is specified on the scheduled task on the runAsUser parameter. If the user does
not already exist on the target Integration Servers, you must add it to the deployment
set. If you do not, the Deployer will deploy the task but will not activate it, even if you
chose to activate scheduled tasks on the Activate After Deployment project property.

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

Important! If you add a port to the deployment set, the port requires the package that
contains the port’s configuration. If the package does not already exist on the target
Integration Servers, you must add it to the deployment set. If you do not, the target
Integration Servers will throw exceptions during deployment and the Deployer will
not deploy the port.

5 If you are not going to add any more items to the deployment set, go to “Resolve
Dependencies” on page 31.

Add Packages to the Deployment Set

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

Add selected package components only

Add selected package files only

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

webMethods Deployer Installation and User’s Guide Version 6.1 25

CHAPTER 4 Defining a Project

you would deploy the files that make up the new service and delete the files that make up
the old service.

Add an Entire Package to the Deployment Set

To add an entire package to the deployment set:

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

Important! If you add a port to the deployment set, the port requires the package that
contains the port’s configuration. If the package does not already exist on the target
Integration Servers, you must add it to the deployment set. If you do not, the target
Integration Servers will throw exceptions during deployment and the Deployer will
not deploy the port.

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

Add Package Components to the Deployment Set

Important! You can select package components to add to the deployment set, or you can
select package files to add to a deployment set, but you cannot select both. If you select
components, then later select files, the Deployer will add the file selections to the
deployment set and remove the component selections.

To add package components to the deployment set:

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

26 webMethods Deployer Installation and User’s Guide Version 6.1

 Create a Deployment Set

4 In the Select Components area, open the tree to show the components in the package.
5 Select the check box next to each component to add to the deployment set.
6 Click Save.

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

Note: If you later decide you want to include the entire package (as opposed to
selected components only), cancel the selection of the components by clearing the
appropriate check boxes, then save the deployment set, and then select the entire
package as explained in “Add an Entire Package to the Deployment Set” on page 26.

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

Add Package Files to the Deployment Set

Important! You can select package files to add to the deployment set, or you can select
package components to add to a deployment set, but you cannot select both. If you select
files, then later select components, the Deployer will add the component selections to the
deployment set and remove the file selections.

To add package files to the deployment set:

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

If you want to add... Action

All the files in the list Click All files.
Only files you select in Click Selected Files, then press the CTRL button and
the list click each file to add to the deployment set.

webMethods Deployer Installation and User’s Guide Version 6.1 27

CHAPTER 4 Defining a Project

If you want to add... Action

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

6 If a package of the same name as this partial package already exists on one of the
deployment set’s target Integration Servers, and the existing package contains files
you want to delete after deployment, type the fully qualified names of the files to
delete in the Files to Delete from Target Package 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/

7 Click Save.

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

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

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

28 webMethods Deployer Installation and User’s Guide Version 6.1

 Create a Deployment Set

Set the Package Properties

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

To set properties for a package:

1 In the Deployment Sets area, under the deployment set to which you added entire or
partial packages, click a package name.
2 In the Package Type area, indicate how the Deployer should proceed if it finds that the
source package already exists on target Integration Servers. You can use either option
below for both entire and partial packages.

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

Deploy the source package over the entire existing package Full
Deploy the components and files in the source package over the Upgrade
corresponding components and files in the existing package

Whether the Deployer actually deploys depends on the version numbers of the source
package and the existing package. If the source package’s version number is the same
or higher than the existing package’s version number, the Deployer deploys. If the
source package’s version number is lower than the existing package’s version
number, the Deployer does not deploy. The version number the Deployer uses for the
source package in the comparison is the number in the Version box in the Package
Information area (see step 6).

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

3 In the Recommendations for Target area, you can recommend the minimum version of
Integration Server and Java Virtual Machine (JVM) to run the source package. If the
JVM version on the target Integration Server is lower than you specify here, the
Deployer will deploy the source package but will not activate it, regardless of the
setting of the Activate After Deployment option, and the target Integration Server will
display a warning about the JVM version. The defaults shown in this area reflect the
Integration Server and JVM that host the source package.
4 For the Activate After Deployment option, indicate whether the Deployer should enable
the package on the target Integration Servers after deploying it. You might choose to
not enable a package automatically after deployment if the deployed package is
intended to replace another package of a different name, but not immediately.
5 In the Sync Documents option, indicate whether to synchronize the document types in
the source package with documents types on Brokers that are connected to target
Integration Servers. The Brokers must be available at the time of deployment for the
synchronization to occur.

webMethods Deployer Installation and User’s Guide Version 6.1 29

CHAPTER 4 Defining a Project

If you set this option to Yes, and a Broker that is connected to a target Integration
Server is not available, the Deployer deploys the document types on the target
Integration Server but cannot synchronize them with the Broker. The Deployer also
writes a message to this effect to the deployment report.

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

If you set this option to No, the Deployer deploys the document types on the target
Integration Servers but does not synchronize them with connected Brokers. You will
have to synchronize document types with the Brokers manually after deployment.
6 The Package Information area shows values as they have been recorded (if they have
been recorded) in Integration Server Administrator and Developer for the source
package. You can assign different values.
In the Version box, you can supply the version number to use for the source package in
comparisons with existing packages on target Integration Servers, as described in
step 2. The Deployer stores this version number in project builds and assigns it to the
deployed package on the target Integration Servers.

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

If you chose the Full option in the Package Type area (see step 2), you can complete the
boxes listed below as follows:

Box Entry
Build You can supply the build number to assign to the deployed
package on the target Integration Servers.
Patches You can supply the list of patches that have been applied to the
Included deployed package on the target Integration Servers. Specify the
patch numbers, separated by commas (for example, 44, 45, 55).
Brief You can supply a description to use for the deployed package on
Description the target Integration Servers (for example, “December 2003
release with patches to correct OrderProcess problem.”)

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

30 webMethods Deployer Installation and User’s Guide Version 6.1

 Create a Deployment Set

Add Trading Networks Items to the Deployment Set

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

To add Trading Networks items to the deployment set:

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

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

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

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

Resolve Dependencies
Administration items, packages, and Trading Networks items often require other items.
For example, a user-defined ACL requires all user-defined groups associated with the
ACL. Items that require other items are called dependent items, while the required items
are called referenced items.
Each time you add an item to a deployment set, the Deployer scans the item’s source
Integration Server for referenced items. If there are no referenced items, or if there are

webMethods Deployer Installation and User’s Guide Version 6.1 31

CHAPTER 4 Defining a Project

referenced items but they are all included in the deployment set, the Deployer shows a
in the Dependencies column for the deployment set in the left pane. If there are referenced
items and some of them are not included in the deployment set, the Deployer shows in
the Dependencies column for the set and considers the deployment set to have unresolved
dependencies. You must resolve all unresolved dependencies before you can continue to
the next task (that is, the project build task).
If necessary, you can later un-resolve a dependency you have resolved and re-resolve it a
different way.
The Deployer cannot always detect all dependencies. If you are aware that an item has a
dependency on a package component, and the Deployer has not detected this
dependency, you can manually add that dependency.

To resolve unresolved dependencies:

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

Option Description
Add If the referenced item does not exist on target Integration Servers and
you want to deploy it to them, use this option. The Deployer adds the
referenced item to the deployment set.

32 webMethods Deployer Installation and User’s Guide Version 6.1

 Create a Deployment Set

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

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

webMethods Deployer Installation and User’s Guide Version 6.1 33

CHAPTER 4 Defining a Project

To manually add a dependency on a package component:

When you manually add a dependency, the Deployer will check for the referenced item
when you map the project to target Integration Servers, as it does when you use the Exists
option to resolve an unresolved dependency. If the Deployer does not find the item, an
icon alerts you during the mapping task. If you do not resolve the dependency at that
time, the Deployer will write a message about it to the pre-deployment report and, if you
do not resolve it at that time, to the deployment report.
1 Go to the Resolved Dependencies page as explained in the previous section.
2 In the Referenced Package box, type the name of the package that contains the
referenced component.
3 In the Referenced Component box, type the name of the referenced component.
4 Click Add.
You can remove a dependency you added manually. To do so, return to the Projects >
project > Define page, open the folder that contains the item, navigate to the item in the
tree in the right pane, cancel the selection of the item by clearing the appropriate
check box, and save the deployment set.

34 webMethods Deployer Installation and User’s Guide Version 6.1

 CHAPTER 5
Building a Project

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Create a Project Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Rebuild a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Export and Import a Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

webMethods Deployer Installation and User’s Guide Version 6.1 35

CHAPTER 5 Building a Project

Overview
You can create a project build using the Deployer interface or a command.
If a project build you create becomes out of sync with the current project definition, or if
the build contains items that you know have changed on the source Integration Servers,
you can rebuild the project build to bring it up to date. You can rebuild a project build
using the Deployer interface or a command.
If you define and test deployment projects in a development environment, when you are
ready to actually deploy the projects in your production environment, you will have to
move the appropriate project builds to your production environment. You do this by
exporting the builds from the development Deployer, copying them to the production
environment, and importing them into the production Deployer. You can export and
import a project build using the Deployer interface or a command.

Important! You must resolve all unresolved dependencies in a project before you can create
a build for that project. If you try to create a build for a project that contains unresolved
dependencies, the build process will fail. For instructions on viewing and resolving
unresolved dependencies, see “Resolve Dependencies” on page 31.

Create a Project Build

Create a Build Using the Deployer Interface

To create a project build using the Deployer interface:

1 In the Deployer, go to the Projects page.

2 In the Name column, click the name of the project for which you want to create a build.
3 The project definition contains items that existed on source Integration Server at the
time you created the definition. To make sure the project does not contain items that
have since been removed from source Integration Servers, synchronize the project
definition with the source Integration Servers as follows:

a In the right pane, click .

b In the Deployment Sets area, under each deployment set, do the following:
1 If you added administration items to the set, click the Administration folder,
then click Save.
2 If you added packages to the set, click the Packages folder, then click Save.
3 If you added Trading Networks items to the set, click the Trading Networks
folder, then click Save.

36 webMethods Deployer Installation and User’s Guide Version 6.1

 Create a Project Build

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

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

5 In the left pane, click Create Build.

6 In the Name box, type the name to use for the build. The name can be up to 32-
characters long and can include any character that is valid for a file name in your
operating system.
7 Click Create. The Deployer creates the build and stores it as a file in the Integration
Server_directory/packages/WmDeployer/persist/projects/project_name/builds directory.

Important! If the project for which you are trying to create the build contains
unresolved dependencies, you will receive a message to that effect and the build
process will fail. For instructions on viewing and resolving unresolved dependencies,
see “Resolve Dependencies” on page 31.

8 Click in the Build Report column in the right pane to view the build report. The build
report tells you which items were successfully included in the build, describes any
errors that occurred during the build process, and informs you if the project contains
unresolved dependencies.

Create a Build Using a Command

The syntax for the CreateBuild command is as follows:
CreateBuild -h host -p port -u user -x password -r build_name -f project [-d]

Parameter Description
-h host -p port Host name or IP address and port for the Deployer host
machine.
-u user -x password User name and password to use to log onto the Deployer.
-r build_name Name to use for the build. The name can be up to 32-
characters long and can include any character that is valid
for a file name in your operating system.

webMethods Deployer Installation and User’s Guide Version 6.1 37

CHAPTER 5 Building a Project

Parameter Description
-f project Name of the project from which to create the build.
[-d] Optional. Tells the Deployer to write debug information to
standard output. By default, standard output echoes to
your console.

Rebuild 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 items that
you know have changed on the source Integration Servers, and you want to recreate the
build to bring it up to date, click in the Rebuild column for the build.
If you want to rebuild a build using a command, use the CreateBuild command as
described in “Create a Build Using a Command”, above, and specify the name of the
existing build on the -r build_name parameter.

Export and Import a Build

Export and Import a Build Using the Deployer Interface

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

1 Export the build from the development environment as follows:

a In the development Deployer, go to the Projects > project > Build page.

b Locate the build to export and click in the build’s Export column. The Deployer
creates a file that contains the build. The file is named project_build and is stored in
the Integration Server_directory\packages\WmDeployer\replicate\outbound
folder.
2 Move the build into the production environment as follows:
a Copy the project_build file to the Integration Server_directory\packages\
WmDeployer\replicate\inbound directory on the machine that hosts the
production Deployer.
b In the production Deployer, go to the Tools > Import Build page.

38 webMethods Deployer Installation and User’s Guide Version 6.1

 Export and Import a Build

c In the Project Build list, click the project_build file you just copied to the inbound
directory.
d Click Import.
3 Use the production Deployer to map and deploy the build as described in the
appropriate chapters in this guide.

Export and Import a Build Using Commands

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

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

The syntax for the ImportBuild command is as follows:

ImportBuild -h host -p port -u user -x password -r project_build [-d]

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

webMethods Deployer Installation and User’s Guide Version 6.1 39

CHAPTER 5 Building a Project

40 webMethods Deployer Installation and User’s Guide Version 6.1

 CHAPTER 6
Mapping a Project

Identify Target Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Map the Project to the Target Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Change Configuration Parameters for Deployed Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

webMethods Deployer Installation and User’s Guide Version 6.1 41

CHAPTER 6 Mapping a Project

Identify Target Integration Servers

In the Integration Server Administrator for the Integration Server that hosts the Deployer,
define the Integration Servers to which you want to deploy the items in this project as
remote servers. This includes the host Integration Server; if you want to deploy items to
the host Integration Server, you must define it as a remote server to itself. For instructions
on defining remote servers, see the webMethods Integration Server Administrator’s Guide.

Map the Project to the Target Integration Servers

To map a project to target Integration Servers:

1 In the Deployer, go to the Projects page.

2 In the Name column, click the name of the project you want to map.

3 In the right pane, click . The Deployer displays the Projects > project > Map page and
lists all maps that exist for the selected project.
4 In the left pane, click Create Deployment Map.
5 In the Name and Description boxes, type the name to use for the map and a brief
description of the map. The name can be up to 32-characters long; the description
length has no limit. Both name and description can include any character that is valid
for a file name in your operating system.
6 Click Create.
7 In the Deployment Map Topology area, in the Deployment Set Mapping area for a
deployment set, click Add Target Server. The Deployer lists all remote servers defined in
Integration Server Administrator.
8 Select the check box next to each Integration Server to which you want to deploy the
items in the selected deployment set.
9 Click Add.
When the Deployer returns to the map > Properties page, the Reference Items column in
the Deployment Map Topology area might show . This icon indicates that you resolved
an unresolved dependency using the Exists option, but the Deployer has found that
the referenced item in fact does not exist on target Integration Servers. Click to see
the missing referenced item. You can then place the referenced item on the target
Integration Servers, or you can return to the project definition stage and re-resolve the
dependency in a different way (see “Resolve Dependencies” on page 31, step 4).

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

42 webMethods Deployer Installation and User’s Guide Version 6.1

 Change Configuration Parameters for Deployed Items

Change Configuration Parameters for Deployed Items

To change configuration parameters for a deployed item:

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

webMethods Deployer Installation and User’s Guide Version 6.1 43

CHAPTER 6 Mapping a Project

44 webMethods Deployer Installation and User’s Guide Version 6.1

 CHAPTER 7
Deploying a Project

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Deploy Using the Deployer Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Deploy Using a Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

webMethods Deployer Installation and User’s Guide Version 6.1 45

CHAPTER 7 Deploying a Project

Overview
You can deploy a project using the Deployer interface or using a command.

Deploy Using the Deployer Interface

To deploy a project using the Deployer interface:

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

4 In the right pane, click . The Deployer displays the Projects > project > Deploy page
and lists all deployment candidates that exist for the selected project.

Note: If the icon is not enabled, you have not successfully completed one or more of
the preceding steps (that is, define, build, and map). You must complete those steps
successfully before you can deploy the project. For instructions, see the chapters on
those topics in this book.

5 In the left pane, click Create Deployment Candidate.

6 In the Name and Description boxes, type the name to use for the deployment candidate
and a brief description of the candidate. The name can be up to 32-characters long; the
description length has no limit. Both name and description can include any character
that is valid for a file name in your operating system.
7 In the Project Build list, click the project build to deploy.
8 In the Deployment Map list, click the deployment map that identifies the target
Integration Servers to which to deploy the items in the selected project build.

Important! If the words Missing referenced items appears next to the map name in the list,
it means that you resolved an unresolved dependency using the Exists option, but the
Deployer found during the mapping task that the referenced item in fact does not
exist on the target Integration Server. You can place the referenced item on the target
Integration Servers, or you can return to the project definition stage and re-resolve the
dependency in a different way (see “Resolve Dependencies” on page 31, step 4).

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

46 webMethods Deployer Installation and User’s Guide Version 6.1

 Deploy Using a Command

9 Click Create.
In the candidate list in the left pane, if the selected build and the current project
definition are in sync, the Status column shows . If the project definition has
changed since the build was created, the column shows . You can rebuild the
project build before proceeding. For instructions, see “Rebuild a Build” on page 38.
10 Generate the pre-deployment report. To do so, in the Deployment Candidates list, click
. The pre-deployment report appears in the right pane in the Pre-Deployment History
area. Click in the Pre-Deployment Report column to display the report. The pre-
deployment report contains information such as the following:
Items that will be suspended during deployment
Items that will be enabled after deployment
Changes that will occur on the target Integration Servers, such as the items that
will be added or overwritten, and configuration parameters that will be changed
Messages about problems, such as unresolved dependencies
Read the report and address all problems.

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

11 Deploy the project. To do so, click in the Deploy column for the deployment
candidate. The Deployer deploys the items in the selected project build to the target
Integration Servers you identified in the selected deployment map.
The Deployer creates a deployment report and lists the report in the Deployment History
area. Click in the Deployment Report column to display the report. The report
contains similar information to the pre-deployment report, except that the events
have actually occurred at this point.

Deploy Using a Command

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

webMethods Deployer Installation and User’s Guide Version 6.1 47

CHAPTER 7 Deploying a Project

Parameter Description
-h host -p port Host name or IP address and port for the
Deployer host machine.
-u user -x password User name and password to use to log onto the
Deployer.
-r project Name of the project from which the build you are
deploying was created.
-n new_candidate_name Name to use for a new deployment candidate.
The name can be up to 32-characters long and can
include any character that is valid for a file name
in your operating system.
-s new_candidate_description Brief description of the new deployment
candidate. The description length has no limit
and can include any character that is valid for a
file name in your operating system.
-b build Name of the project build to deploy.
-m map Name of the deployment map that identifies the
target Integration Servers to which to deploy the
items in the selected project build.
-l {true|false} Tells the Deployer to either generate the pre-
deployment report (true) or to deploy the
deployment candidate (false).
[-d] Optional. Tells the Deployer to write debug
information to standard output. By default,
standard output echoes to your console.

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

Parameter Description
-h host -p port Host name or IP address and port for the
Deployer host machine.
-u user -x password User name and password to use to log onto the
Deployer.
-e candidate Name of an existing deployment candidate to
deploy.

48 webMethods Deployer Installation and User’s Guide Version 6.1

 Deploy Using a Command

Parameter Description
-r project Name of the project from which the build you are
deploying was created.
-l {true|false} Tells the Deployer to either generate the pre-
deployment report (true) or to deploy the
deployment candidate (false).
[-d] Optional. Tells the Deployer to write debug
information to standard output. By default,
standard output echoes to your console.

webMethods Deployer Installation and User’s Guide Version 6.1 49

CHAPTER 7 Deploying a Project

50 webMethods Deployer Installation and User’s Guide Version 6.1

 Index

Index

A create projects
activate packages after deployment 29 by copying an existing project 18
add to deployment sets by creating a new project 18
administration items 25 overview 8
dependencies 33 CreateBuild command 37
entire packages 26
package components 26 D
package files 27 define projects, overview 9
Trading Networks items 31 delete files from existing packages on target
administration items, add to deployment sets Integration Servers 28
25 dependencies
authorize security groups to perform tasks 20 add manually 33
overview 31
B resolve 32
Brokers, synchronize deployed document types unresolve 33
with 29 Deploy command 47
build file name and location 37 deploy projects
build projects, overview 10 generate pre-deployment report 47
builds overview 11
create using a command 37 to target Integration Server not accessible to
create using the Deployer interface 36 the local Integration Server 38
export and import using the Deployer using a command 47
interface 38 using the Deployer interface 46
export using a command 39 Deployer
import using a command 39 hardware requirements 14
install 15
C log off 18
log on to 18
change configuration parameters for deployed
overview 8
items 43
required webMethods components 14
change configuration parameters for deployed
start 18
items, overview 10
supported operating systems 14
commands
supported platforms 14
CreateBuild 37
uninstall 16
Deploy 47
deployment process overview 8
ExportBuild 39
deployment sets
ImportBuild 39
add administration items to 25
conventions used in this document 5
add dependencies to 33
create deployment sets 24
add entire packages to 26

webMethods Deployer Installation and User’s Guide Version 6.1 51

Index

add package components to 26 add package components to deployment

add package files to 27 sets 26
add Trading Networks items to 31 add package files to deployment sets 27
create 24 add Trading Networks items to deployment
overview 9 sets 31
resolve dependencies in 32 change configuration parameters for items
unresolve dependencies in 33 on target Integration Servers 43
document types, synchronize with Brokers 29
documentation L
additional 6 log off the Deployer 18
conventions used 5 log on to the Deployer 18
feedback 6
M
E map projects 42
enable deployed ports and scheduled tasks 20 map projects, overview 10
export builds
using a command 39 O
using the Deployer interface 38
operating systems supported by the Deployer
ExportBuild command 39 14
overwrite existing project items on target
H Integration Servers 19
hardware requirements for the Deployer 14
home page, create and view 21 P
packages
I activate after deployment 29
identify add entire packages to deployment sets 26
source Integration Servers 24 add package components to deployment
target Integration Servers 42 sets 26
import builds add package files to deployment sets 27
using a command 39 delete files from existing packages on targets
using the Deployer interface 38 Integration Server 28
ImportBuild command 39 set properties for 29
install the deployer 15 parameters, change for deployed items 43
Integration Servers platforms supported by the Deployer 14
deploy to targets not accessible to local pre-deployment report, generate 47
Integration Server 38 program code conventions in this document 5
identify sources 15, 24 project build file name and location 37
identify targets 15, 42 projects
items authorize security groups to perform tasks
add administration items to deployment sets 20
25 build using a command 37
add entire packages to deployment sets 26 build using the Deployer interface 36
build, overview 10

52 webMethods Deployer Installation and User’s Guide Version 6.1

 Index

create by copying an existing project 18 suspend operation of existing items on target

create by creating a new project 18 Integration Servers during deployment 19
create home page for 21 synchronize deployed document types with
create, overview 8 Brokers 29
define, overview 9
deploy on target Integration Server not T
accessible to the local Integration Server target Integration Servers, identify 15, 42
38 Trading Networks items, add to deployment
deploy using a command 47 sets 31
deploy using the Deployer interface 46 troubleshooting information 6
deploy, overview 11 typographical conventions in this document 5
enable deployed ports and scheduled tasks
20
U
generate pre-deployment report 47
map 42 uninstall the Deployer 16
map, overview 10 unresolved dependencies
overview 31
overwrite existing project items on target
Integration Servers 19 resolve 32
rebuild 38
set properties for 19 W
suspend operationg of existing items on webMethods components required by Deployer
target Integration Servers during 14
deployment 19
view home page for 21 X
properties
XML file, project definition 9
set for packages 29
set for projects 19

R
rebuild projects 38
remote servers, identify 24
resolve dependencies 32
resolved dependencies
overview 31
unresolve 33

S
security groups, authorize to perform tasks 20
source Integration Servers, identify 15, 24
start the Deployer 18

webMethods Deployer Installation and User’s Guide Version 6.1 53

Index

54 webMethods Deployer Installation and User’s Guide Version 6.1