webmethods deployer installation and users guide

webMethods, Inc.3930 Pender DriveFairfax, VA 22030USA703.460.2500http://www.webmethods.com

webMethods DeployerInstallation and User’s Guide

VERSION 6.1

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

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

Chapter 2. Installing the Deployer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Implementation and Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Supported Platforms and Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Required webMethods Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

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

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

Chapter 4. Defining a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Identify Source Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Create a Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Add Administration Items to the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Add Packages to the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Add an Entire Package to the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Add Package Components to the Deployment Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

webMethods Deployer Installation and User’s Guide Version 6.1 3

C o n t e n t s

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

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

Chapter 5. Building a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Create a Project Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Create a Build Using the Deployer Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Create a Build Using a Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

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

Export and Import a Build Using the Deployer Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Export and Import a Build Using Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Chapter 6. Mapping a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Identify Target Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Map the Project to the Target Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Change Configuration Parameters for Deployed Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Chapter 7. Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Deploy Using the Deployer Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Deploy 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 Convent ions

Convention Description

Bold Identifies elements on a screen.

Italic Identifies variable information that you must supply or change based on your specific situation or environment. Identifies terms the first time they are defined in text. Also identifies service input and output variables.

Narrow font Identifies storage locations for services on the webMethods Integration Server using the convention folder.subfolder:service.

Typewriter font

Identifies characters and values that you must type exactly or messages that the system displays on the console.

UPPERCASE Identifies keyboard keys. Keys that you must press simultaneously are joined with the “+” symbol.

\ Directory paths use the “\” directory delimiter unless the subject is UNIX-specific.

[ ] Optional keywords or values are enclosed in [ ]. Do not type the [ ] symbols in your own code.


A b o u t T h i s G u i d e

Addit ional InformationThe 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.


http://advantage.webmethods.com

http://advantage.webmethods.com/troubleshooting

http://advantage.webmethods.com/docfeedback

http://advantage.webmethods.com/Bookshelf

http://advantage.webmethods.com/Bookshelf

C H A P T E R1
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


C H A P T E R 1 C o n c e p t s

OverviewThe 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 StepsThe 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 ProjectA 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.


Define the Project

Define the ProjectTo 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.

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.

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

define one deployment set

project

to deploy to one set of Integration Servers

to deploy to two sets of Integration Serversdefine two deployment sets

project



Build the ProjectYou 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 ProjectYou 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 ProjectTo 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


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.


C H A P T E R2
Instal l ing the Deployer
Implementation and Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

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

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

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


C H A P T E R 2 I n s t a l l i n g t h e D e p l o y e r

Implementat ion and DependenciesThe 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 SystemsThe Deployer supports the same platforms as Integration Server and uses the JRE you install for Integration Server.

Required webMethods ComponentsYou install the Deployer on a 6.0.1 or 6.1 Integration Server.

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


Install the Deployer and the Resource Packages

Instal l the Deployer and the Resource Packages

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.

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.

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:

To install the resource packages:


http://advantage.webmethods.com

C H A P T E R 2 I n s t a l l i n g t h e D e p l o y e r

Uninstal l the Deployer and the Resource Packages

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.

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

2 Delete the WmDeployerResource package.

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:

To uninstall the resource package:


C H A P T E R3
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


C H A P T E R 3 G e t S t a r t e d w i t h t h e D e p l o y e r

Start the DeployerThe 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.

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

Create the ProjectYou 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.

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.

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.

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

To create a new project:

To copy an existing project:


Set the Project Properties

Set the Project Propert iesThe 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.

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

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.

To set the project properties:

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 tasks

Prevents scheduled tasks on the target Integration Servers that match scheduled tasks you are trying to deploy from running. (Tasks that are already running at deployment time are not affected by deployment.)

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.



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

4 Click Save.

Authorize Groups to Perform Tasks on a ProjectAfter 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.

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

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

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.

To authorize groups to perform tasks:


Add and View Instructions or Notes About a Project

Add and View Instruct ions or Notes About a ProjectWhen 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.


C H A P T E R4
Defining a Project
Identify Source Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

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


C H A P T E R 4 D e f i n i n g a P r o j e c t

Ident i fy Source Integrat ion Servers


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.

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

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.

To identify source Integration Servers:

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.

To create a deployment set:


Create a Deployment Set

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.

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

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

To add administration items 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.

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.



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

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.

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

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.


3 Click the name of a package that contains components you want to add to the deployment set.

To add an entire package to 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.

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:



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


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.


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:

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.

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:

If you want to add... Action

All the files in the list Click All files.

Only files you select in the list

Click Selected Files, then press the CTRL button and click each file to add to the deployment set.



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


Only files other than those you select in the list

Click All except selected files, then press the CTRL button and click each file to not add to the deployment set.

All files in the list whose name contains a specified string

Click Files specified by filter, then type the string on which to match. You can use an asterisk (*) as a wild card (for example, *.java or *.class).

All files in the list whose name does not contain a specified string

Click All except files specified by filter, then type the string on which to match. You can use an asterisk (*) as a wild card (for example, *.java or *.class).

If you want to add... Action

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.



Set the Package PropertiesYou must set the package properties for each package you added to the deployment set.

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.

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

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.

To set properties for a package:

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 corresponding components and files in the existing package

Upgrade

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



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.

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.

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

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.

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.

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

Box Entry

Build You can supply the build number to assign to the deployed package on the target Integration Servers.

Patches Included

You can 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).

Brief Description

You can supply a description to use for the deployed package on the target Integration Servers (for example, “December 2003 release with patches to correct OrderProcess problem.”)



Add Trading Networks Items to the Deployment SetWhen 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.

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.

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

To add Trading Networks items 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.



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.

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.

To resolve unresolved dependencies:

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.



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.

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.

Option Description



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.

To manually add a dependency on a package component:


C H A P T E R5
Building a Project
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

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

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

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


C H A P T E R 5 B u i l d i n g a P r o j e c t

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

Create a Project Bui ld

Create a Build Using the Deployer Interface


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.

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.

To create a project build using the Deployer interface:


Create a Project Build

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

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.

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 CommandThe syntax for the CreateBuild command is as follows:

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.

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.

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.



Rebui ld a Bui ldThe 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 Bui ld

Export and Import a Build Using 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.

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


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


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 CommandsThe syntax for the ExportBuild command is as follows:

The syntax for the ImportBuild command is as follows:

ExportBuild -h host -p port -u user -x password -f project-r build -o {true|false} [-d]




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


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




-r project_build Name of the file to import (project_build).



C H A P T E R6
Mapping a Project
Identify Target Integration Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

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

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


C H A P T E R 6 M a p p i n g a P r o j e c t

Ident i fy Target Integrat ion ServersIn 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 Integrat ion Servers


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

To map a project to target Integration Servers:

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.


Change Configuration Parameters for Deployed Items

Change Configurat ion Parameters for Deployed I tems

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.

To change configuration parameters for a deployed item:


C H A P T E R 6 M a p p i n g a P r o j e c t


C H A P T E R7
Deploying a Project
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

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

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


C H A P T E R 7 D e p l o y i n g a P r o j e c t

OverviewYou can deploy a project using the Deployer interface or using a command.

Deploy Using the Deployer Interface

1 If you chose to suspend triggers, ports, and scheduled tasks, but a service is triggered by one of these items before the Deployer suspends them, and the service is a long-running service, the Deployer might overwrite the service during deployment. Make sure long-running services have completed before you deploy.


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.

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.

To deploy a project using the Deployer interface:

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.

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.


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.

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

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

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]



If you are deploying an existing deployment candidate, the syntax for the Deploy command is as follows:




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


Deploy -h host -p port -u user -x password -e candidate -r project -l {true|false} [-d]




-e candidate Name of an existing deployment candidate to deploy.


Deploy Using a Command

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




Index

Index

Aactivate packages after deployment 29add to deployment sets

administration items 25dependencies 33entire packages 26package components 26package files 27Trading Networks items 31

administration items, add to deployment sets 25

authorize security groups to perform tasks 20

BBrokers, synchronize deployed document types

with 29build file name and location 37build projects, overview 10builds

create using a command 37create using the Deployer interface 36export and import using the Deployer

interface 38export using a command 39import using a command 39

Cchange configuration parameters for deployed

items 43change configuration parameters for deployed

items, overview 10commands

CreateBuild 37Deploy 47ExportBuild 39ImportBuild 39

conventions used in this document 5create deployment sets 24

create projectsby copying an existing project 18by creating a new project 18overview 8

CreateBuild command 37

Ddefine projects, overview 9delete files from existing packages on target

Integration Servers 28dependencies

add manually 33overview 31resolve 32unresolve 33

Deploy command 47deploy projects

generate pre-deployment report 47overview 11to target Integration Server not accessible to

the local Integration Server 38using a command 47using the Deployer interface 46

Deployerhardware requirements 14install 15log off 18log on to 18overview 8required webMethods components 14start 18supported operating systems 14supported platforms 14uninstall 16

deployment process overview 8deployment sets

add administration items to 25add dependencies to 33add entire packages to 26


I n d e x

add package components to 26add package files to 27add Trading Networks items to 31create 24overview 9resolve dependencies in 32unresolve dependencies in 33

document types, synchronize with Brokers 29documentation

additional 6conventions used 5feedback 6

Eenable deployed ports and scheduled tasks 20export builds

using a command 39using the Deployer interface 38

ExportBuild command 39

Hhardware requirements for the Deployer 14home page, create and view 21

Iidentify

source Integration Servers 24target Integration Servers 42

import buildsusing a command 39using the Deployer interface 38

ImportBuild command 39install the deployer 15Integration Servers

deploy to targets not accessible to local Integration Server 38

identify sources 15, 24identify targets 15, 42

itemsadd administration items to deployment sets

25add entire packages to deployment sets 26

add package components to deployment sets 26

add package files to deployment sets 27add Trading Networks items to deployment

sets 31change configuration parameters for items

on target Integration Servers 43

Llog off the Deployer 18log on to the Deployer 18

Mmap projects 42map projects, overview 10

Ooperating systems supported by the Deployer

14overwrite existing project items on target

Integration Servers 19

Ppackages

activate after deployment 29add entire packages to deployment sets 26add package components to deployment

sets 26add package files to deployment sets 27delete files from existing packages on targets

Integration Server 28set properties for 29

parameters, change for deployed items 43platforms supported by the Deployer 14pre-deployment report, generate 47program code conventions in this document 5project build file name and location 37projects

authorize security groups to perform tasks 20

build using a command 37build using the Deployer interface 36build, overview 10


Index

create by copying an existing project 18create by creating a new project 18create home page for 21create, overview 8define, overview 9deploy on target Integration Server not

accessible to the local Integration Server 38

deploy using a command 47deploy using the Deployer interface 46deploy, overview 11enable deployed ports and scheduled tasks

20generate pre-deployment report 47map 42map, overview 10overwrite existing project items on target

Integration Servers 19rebuild 38set properties for 19suspend operationg of existing items on

target Integration Servers during deployment 19

view home page for 21properties

set for packages 29set for projects 19

Rrebuild projects 38remote servers, identify 24resolve dependencies 32resolved dependencies

overview 31unresolve 33

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

suspend operation of existing items on target Integration Servers during deployment 19

synchronize deployed document types with Brokers 29

Ttarget Integration Servers, identify 15, 42Trading Networks items, add to deployment

sets 31troubleshooting information 6typographical conventions in this document 5

Uuninstall the Deployer 16unresolved dependencies

overview 31resolve 32

WwebMethods components required by Deployer

14

XXML file, project definition 9


I n d e x
